ed966ad5e4c1e0d76d766de44f4b247d5a61d3be
[exim.git] / doc / doc-docbook / spec.xfpt
1 . $Cambridge: exim/doc/doc-docbook/spec.xfpt,v 1.88 2010/06/14 18:51:09 pdp Exp $
2 .
3 . /////////////////////////////////////////////////////////////////////////////
4 . This is the primary source of the Exim Manual. It is an xfpt document that is
5 . converted into DocBook XML for subsequent conversion into printing and online
6 . formats. The markup used herein is "standard" xfpt markup, with some extras.
7 . The markup is summarized in a file called Markup.txt.
8 .
9 . WARNING: When you use the .new macro, make sure it appears *before* any
10 . adjacent index items; otherwise you get an empty "paragraph" which causes
11 . unwanted vertical space.
12 . /////////////////////////////////////////////////////////////////////////////
13
14 .include stdflags
15 .include stdmacs
16
17 . /////////////////////////////////////////////////////////////////////////////
18 . This outputs the standard DocBook boilerplate.
19 . /////////////////////////////////////////////////////////////////////////////
20
21 .docbook
22
23 . /////////////////////////////////////////////////////////////////////////////
24 . These lines are processing instructions for the Simple DocBook Processor that
25 . Philip Hazel has developed as a less cumbersome way of making PostScript and
26 . PDFs than using xmlto and fop. They will be ignored by all other XML
27 . processors.
28 . /////////////////////////////////////////////////////////////////////////////
29
30 .literal xml
31 <?sdop
32   foot_right_recto="&chaptertitle; (&chapternumber;)"
33   foot_right_verso="&chaptertitle; (&chapternumber;)"
34   toc_chapter_blanks="yes,yes"
35   table_warn_overflow="overprint"
36 ?>
37 .literal off
38
39 . /////////////////////////////////////////////////////////////////////////////
40 . This generate the outermost <book> element that wraps then entire document.
41 . /////////////////////////////////////////////////////////////////////////////
42
43 .book
44
45 . /////////////////////////////////////////////////////////////////////////////
46 . These definitions set some parameters and save some typing. Remember that
47 . the <bookinfo> element must also be updated for each new edition.
48 . /////////////////////////////////////////////////////////////////////////////
49
50 .set previousversion "4.72"
51 .set version "4.73"
52
53 .set ACL "access control lists (ACLs)"
54 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
55
56
57 . /////////////////////////////////////////////////////////////////////////////
58 . Additional xfpt markup used by this document, over and above the default
59 . provided in the xfpt library.
60 . /////////////////////////////////////////////////////////////////////////////
61
62 . --- Override the &$ flag to automatically insert a $ with the variable name
63
64 .flag &$  $&   "<varname>$"  "</varname>"
65
66 . --- Short flags for daggers in option headings. They will always be inside
67 . --- an italic string, but we want the daggers to be roman.
68
69 .flag &!!      "</emphasis>&dagger;<emphasis>"
70 .flag &!?      "</emphasis>&Dagger;<emphasis>"
71
72 . --- A macro for an Exim option definition heading, generating a one-line
73 . --- table with four columns. For cases when the option name is given with
74 . --- a space, so that it can be split, a fifth argument is used for the
75 . --- index entry.
76
77 .macro option
78 .arg 5
79 .oindex "&%$5%&"
80 .endarg
81 .arg -5
82 .oindex "&%$1%&"
83 .endarg
84 .itable all 0 0 4 8* left 6* center 6* center 6* right
85 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
86 .endtable
87 .endmacro
88
89 . --- A macro for the common 2-column tables. The width of the first column
90 . --- is suitable for the many tables at the start of the main options chapter;
91 . --- the small number of other 2-column tables override it.
92
93 .macro table2 196pt 254pt
94 .itable none 0 0 2 $1 left $2 left
95 .endmacro
96
97 . --- A macro that generates .row, but puts &I; at the start of the first
98 . --- argument, thus indenting it. Assume a minimum of two arguments, and
99 . --- allow up to four arguments, which is as many as we'll ever need.
100
101 .macro irow
102 .arg 4
103 .row "&I;$1" "$2" "$3" "$4"
104 .endarg
105 .arg -4
106 .arg 3
107 .row "&I;$1" "$2" "$3"
108 .endarg
109 .arg -3
110 .row "&I;$1" "$2"
111 .endarg
112 .endarg
113 .endmacro
114
115 . --- Macros for option, variable, and concept index entries. For a "range"
116 . --- style of entry, use .scindex for the start and .ecindex for the end. The
117 . --- first argument of .scindex and the only argument of .ecindex must be the
118 . --- ID that ties them together.
119
120 .macro cindex
121 &<indexterm role="concept">&
122 &<primary>&$1&</primary>&
123 .arg 2
124 &<secondary>&$2&</secondary>&
125 .endarg
126 &</indexterm>&
127 .endmacro
128
129 .macro scindex
130 &<indexterm role="concept" id="$1" class="startofrange">&
131 &<primary>&$2&</primary>&
132 .arg 3
133 &<secondary>&$3&</secondary>&
134 .endarg
135 &</indexterm>&
136 .endmacro
137
138 .macro ecindex
139 &<indexterm role="concept" startref="$1" class="endofrange"/>&
140 .endmacro
141
142 .macro oindex
143 &<indexterm role="option">&
144 &<primary>&$1&</primary>&
145 .arg 2
146 &<secondary>&$2&</secondary>&
147 .endarg
148 &</indexterm>&
149 .endmacro
150
151 .macro vindex
152 &<indexterm role="variable">&
153 &<primary>&$1&</primary>&
154 .arg 2
155 &<secondary>&$2&</secondary>&
156 .endarg
157 &</indexterm>&
158 .endmacro
159
160 .macro index
161 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
162 .endmacro
163 . ////////////////////////////////////////////////////////////////////////////
164
165
166 . ////////////////////////////////////////////////////////////////////////////
167 . The <bookinfo> element is removed from the XML before processing for Ascii
168 . output formats.
169 . ////////////////////////////////////////////////////////////////////////////
170
171 .literal xml
172 <bookinfo>
173 <title>Specification of the Exim Mail Transfer Agent</title>
174 <titleabbrev>The Exim MTA</titleabbrev>
175 <date>29 May 2010</date>
176 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
177 <authorinitials>EM</authorinitials>
178 <revhistory><revision>
179   <revnumber>4.73</revnumber>
180   <date>19 Nov 2010</date>
181   <authorinitials>EM</authorinitials>
182 </revision></revhistory>
183 <copyright><year>2009</year><holder>University of Cambridge</holder></copyright>
184 </bookinfo>
185 .literal off
186
187
188 . /////////////////////////////////////////////////////////////////////////////
189 . This chunk of literal XML implements index entries of the form "x, see y" and
190 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
191 . at the top level, so we have to put the .chapter directive first.
192 . /////////////////////////////////////////////////////////////////////////////
193
194 .chapter "Introduction" "CHID1"
195 .literal xml
196
197 <indexterm role="variable">
198   <primary>$1, $2, etc.</primary>
199   <see><emphasis>numerical variables</emphasis></see>
200 </indexterm>
201 <indexterm role="concept">
202   <primary>address</primary>
203   <secondary>rewriting</secondary>
204   <see><emphasis>rewriting</emphasis></see>
205 </indexterm>
206 <indexterm role="concept">
207   <primary>Bounce Address Tag Validation</primary>
208   <see><emphasis>BATV</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Client SMTP Authorization</primary>
212   <see><emphasis>CSA</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>CR character</primary>
216   <see><emphasis>carriage return</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CRL</primary>
220   <see><emphasis>certificate revocation list</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>delivery</primary>
224   <secondary>failure report</secondary>
225   <see><emphasis>bounce message</emphasis></see>
226 </indexterm>
227 <indexterm role="concept">
228   <primary>dialup</primary>
229   <see><emphasis>intermittently connected hosts</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>exiscan</primary>
233   <see><emphasis>content scanning</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>failover</primary>
237   <see><emphasis>fallback</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>fallover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>filter</primary>
245   <secondary>Sieve</secondary>
246   <see><emphasis>Sieve filter</emphasis></see>
247 </indexterm>
248 <indexterm role="concept">
249   <primary>ident</primary>
250   <see><emphasis>RFC 1413</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>LF character</primary>
254   <see><emphasis>linefeed</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>maximum</primary>
258   <seealso><emphasis>limit</emphasis></seealso>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>monitor</primary>
262   <see><emphasis>Exim monitor</emphasis></see>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>no_<emphasis>xxx</emphasis></primary>
266   <see>entry for xxx</see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>NUL</primary>
270   <see><emphasis>binary zero</emphasis></see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>passwd file</primary>
274   <see><emphasis>/etc/passwd</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>process id</primary>
278   <see><emphasis>pid</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>RBL</primary>
282   <see><emphasis>DNS list</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>redirection</primary>
286   <see><emphasis>address redirection</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>return path</primary>
290   <seealso><emphasis>envelope sender</emphasis></seealso>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>scanning</primary>
294   <see><emphasis>content scanning</emphasis></see>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>SSL</primary>
298   <see><emphasis>TLS</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>string</primary>
302   <secondary>expansion</secondary>
303   <see><emphasis>expansion</emphasis></see>
304 </indexterm>
305 <indexterm role="concept">
306   <primary>top bit</primary>
307   <see><emphasis>8-bit characters</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>variables</primary>
311   <see><emphasis>expansion, variables</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>zero, binary</primary>
315   <see><emphasis>binary zero</emphasis></see>
316 </indexterm>
317
318 .literal off
319
320
321 . /////////////////////////////////////////////////////////////////////////////
322 . This is the real start of the first chapter. See the comment above as to why
323 . we can't have the .chapter line here.
324 . chapter "Introduction"
325 . /////////////////////////////////////////////////////////////////////////////
326
327 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
328 Unix-like operating systems. It was designed on the assumption that it would be
329 run on hosts that are permanently connected to the Internet. However, it can be
330 used on intermittently connected hosts with suitable configuration adjustments.
331
332 Configuration files currently exist for the following operating systems: AIX,
333 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
334 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
335 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
336 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
337 Some of these operating systems are no longer current and cannot easily be
338 tested, so the configuration files may no longer work in practice.
339
340 There are also configuration files for compiling Exim in the Cygwin environment
341 that can be installed on systems running Windows. However, this document does
342 not contain any information about running Exim in the Cygwin environment.
343
344 The terms and conditions for the use and distribution of Exim are contained in
345 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
346 Public Licence, a copy of which may be found in the file &_LICENCE_&.
347
348 The use, supply or promotion of Exim for the purpose of sending bulk,
349 unsolicited electronic mail is incompatible with the basic aims of the program,
350 which revolve around the free provision of a service that enhances the quality
351 of personal communications. The author of Exim regards indiscriminate
352 mass-mailing as an antisocial, irresponsible abuse of the Internet.
353
354 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
355 experience of running and working on the Smail 3 code, I could never have
356 contemplated starting to write a new MTA. Many of the ideas and user interfaces
357 were originally taken from Smail 3, though the actual code of Exim is entirely
358 new, and has developed far beyond the initial concept.
359
360 Many people, both in Cambridge and around the world, have contributed to the
361 development and the testing of Exim, and to porting it to various operating
362 systems. I am grateful to them all. The distribution now contains a file called
363 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
364 contributors.
365
366
367 .section "Exim documentation" "SECID1"
368 . Keep this example change bar when updating the documentation!
369 .new
370 .cindex "documentation"
371 This edition of the Exim specification applies to version &version; of Exim.
372 Substantive changes from the &previousversion; edition are marked in some
373 renditions of the document; this paragraph is so marked if the rendition is
374 capable of showing a change indicator.
375 .wen
376
377 This document is very much a reference manual; it is not a tutorial. The reader
378 is expected to have some familiarity with the SMTP mail transfer protocol and
379 with general Unix system administration. Although there are some discussions
380 and examples in places, the information is mostly organized in a way that makes
381 it easy to look up, rather than in a natural order for sequential reading.
382 Furthermore, the manual aims to cover every aspect of Exim in detail, including
383 a number of rarely-used, special-purpose features that are unlikely to be of
384 very wide interest.
385
386 .cindex "books about Exim"
387 An &"easier"& discussion of Exim which provides more in-depth explanatory,
388 introductory, and tutorial material can be found in a book entitled &'The Exim
389 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
390 (&url(http://www.uit.co.uk/exim-book/)).
391
392 This book also contains a chapter that gives a general introduction to SMTP and
393 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
394 with the latest release of Exim. (Note that the earlier book about Exim,
395 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
396
397 .cindex "Debian" "information sources"
398 If you are using a Debian distribution of Exim, you will find information about
399 Debian-specific features in the file
400 &_/usr/share/doc/exim4-base/README.Debian_&.
401 The command &(man update-exim.conf)& is another source of Debian-specific
402 information.
403
404 .cindex "&_doc/NewStuff_&"
405 .cindex "&_doc/ChangeLog_&"
406 .cindex "change log"
407 As the program develops, there may be features in newer versions that have not
408 yet made it into this document, which is updated only when the most significant
409 digit of the fractional part of the version number changes. Specifications of
410 new features that are not yet in this manual are placed in the file
411 &_doc/NewStuff_& in the Exim distribution.
412
413 Some features may be classified as &"experimental"&. These may change
414 incompatibly while they are developing, or even be withdrawn. For this reason,
415 they are not documented in this manual. Information about experimental features
416 can be found in the file &_doc/experimental.txt_&.
417
418 All changes to the program (whether new features, bug fixes, or other kinds of
419 change) are noted briefly in the file called &_doc/ChangeLog_&.
420
421 .cindex "&_doc/spec.txt_&"
422 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
423 that it can easily be searched with a text editor. Other files in the &_doc_&
424 directory are:
425
426 .table2 100pt
427 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
428 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
429 .row &_exim.8_&              "a man page of Exim's command line options"
430 .row &_experimental.txt_&    "documentation of experimental features"
431 .row &_filter.txt_&          "specification of the filter language"
432 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
433 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
434 .endtable
435
436 The main specification and the specification of the filtering language are also
437 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
438 &<<SECTavail>>& below tells you how to get hold of these.
439
440
441
442 .section "FTP and web sites" "SECID2"
443 .cindex "web site"
444 .cindex "FTP site"
445 The primary site for Exim source distributions is currently the University of
446 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
447 distribution'& below. In addition, there is a web site and an FTP site at
448 &%exim.org%&. These are now also hosted at the University of Cambridge. The
449 &%exim.org%& site was previously hosted for a number of years by Energis
450 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
451
452 .cindex "wiki"
453 .cindex "FAQ"
454 As well as Exim distribution tar files, the Exim web site contains a number of
455 differently formatted versions of the documentation. A recent addition to the
456 online information is the Exim wiki (&url(http://wiki.exim.org)),
457 which contains what used to be a separate FAQ, as well as various other
458 examples, tips, and know-how that have been contributed by Exim users.
459
460 .cindex Bugzilla
461 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
462 this to report bugs, and also to add items to the wish list. Please search
463 first to check that you are not duplicating a previous entry.
464
465
466
467 .section "Mailing lists" "SECID3"
468 .cindex "mailing lists" "for Exim users"
469 The following Exim mailing lists exist:
470
471 .table2 140pt
472 .row &'exim-users@exim.org'&      "General discussion list"
473 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
474 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
475 .row &'exim-future@exim.org'&     "Discussion of long-term development"
476 .endtable
477
478 You can subscribe to these lists, change your existing subscriptions, and view
479 or search the archives via the mailing lists link on the Exim home page.
480 .cindex "Debian" "mailing list for"
481 If you are using a Debian distribution of Exim, you may wish to subscribe to
482 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
483 via this web page:
484 .display
485 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
486 .endd
487 Please ask Debian-specific questions on this list and not on the general Exim
488 lists.
489
490 .section "Exim training" "SECID4"
491 .cindex "training courses"
492 Training courses in Cambridge (UK) used to be run annually by the author of
493 Exim, before he retired. At the time of writing, there are no plans to run
494 further Exim courses in Cambridge. However, if that changes, relevant
495 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
496
497 .section "Bug reports" "SECID5"
498 .cindex "bug reports"
499 .cindex "reporting bugs"
500 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
501 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
502 whether some behaviour is a bug or not, the best thing to do is to post a
503 message to the &'exim-dev'& mailing list and have it discussed.
504
505
506
507 .section "Where to find the Exim distribution" "SECTavail"
508 .cindex "FTP site"
509 .cindex "distribution" "ftp site"
510 The master ftp site for the Exim distribution is
511 .display
512 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
513 .endd
514 This is mirrored by
515 .display
516 &*ftp://ftp.exim.org/pub/exim*&
517 .endd
518 The file references that follow are relative to the &_exim_& directories at
519 these sites. There are now quite a number of independent mirror sites around
520 the world. Those that I know about are listed in the file called &_Mirrors_&.
521
522 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
523 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
524 distributions), and &_Testing_& for testing versions. In the &_exim4_&
525 subdirectory, the current release can always be found in files called
526 .display
527 &_exim-n.nn.tar.gz_&
528 &_exim-n.nn.tar.bz2_&
529 .endd
530 where &'n.nn'& is the highest such version number in the directory. The two
531 files contain identical data; the only difference is the type of compression.
532 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
533
534 .cindex "distribution" "signing details"
535 .cindex "distribution" "public key"
536 .cindex "public key for signed distribution"
537 The distributions are currently signed with Nigel Metheringham's GPG key. The
538 corresponding public key is available from a number of keyservers, and there is
539 also a copy in the file &_nigel-pubkey.asc_&. The signatures for the tar bundles are
540 in:
541 .display
542 &_exim-n.nn.tar.gz.asc_&
543 &_exim-n.nn.tar.bz2.asc_&
544 .endd
545 For each released version, the log of changes is made separately available in a
546 separate file in the directory &_ChangeLogs_& so that it is possible to
547 find out what has changed without having to download the entire distribution.
548
549 .cindex "documentation" "available formats"
550 The main distribution contains ASCII versions of this specification and other
551 documentation; other formats of the documents are available in separate files
552 inside the &_exim4_& directory of the FTP site:
553 .display
554 &_exim-html-n.nn.tar.gz_&
555 &_exim-pdf-n.nn.tar.gz_&
556 &_exim-postscript-n.nn.tar.gz_&
557 &_exim-texinfo-n.nn.tar.gz_&
558 .endd
559 These tar files contain only the &_doc_& directory, not the complete
560 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
561
562
563 .section "Limitations" "SECID6"
564 .ilist
565 .cindex "limitations of Exim"
566 .cindex "bang paths" "not handled by Exim"
567 Exim is designed for use as an Internet MTA, and therefore handles addresses in
568 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
569 simple two-component bang paths can be converted by a straightforward rewriting
570 configuration. This restriction does not prevent Exim from being interfaced to
571 UUCP as a transport mechanism, provided that domain addresses are used.
572 .next
573 .cindex "domainless addresses"
574 .cindex "address" "without domain"
575 Exim insists that every address it handles has a domain attached. For incoming
576 local messages, domainless addresses are automatically qualified with a
577 configured domain value. Configuration options specify from which remote
578 systems unqualified addresses are acceptable. These are then qualified on
579 arrival.
580 .next
581 .cindex "transport" "external"
582 .cindex "external transports"
583 The only external transport mechanisms that are currently implemented are SMTP
584 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
585 transport is available, and there are facilities for writing messages to files
586 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
587 to send messages to other transport mechanisms such as UUCP, provided they can
588 handle domain-style addresses. Batched SMTP input is also catered for.
589 .next
590 Exim is not designed for storing mail for dial-in hosts. When the volumes of
591 such mail are large, it is better to get the messages &"delivered"& into files
592 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
593 other means.
594 .next
595 Although Exim does have basic facilities for scanning incoming messages, these
596 are not comprehensive enough to do full virus or spam scanning. Such operations
597 are best carried out using additional specialized software packages. If you
598 compile Exim with the content-scanning extension, straightforward interfaces to
599 a number of common scanners are provided.
600 .endlist
601
602
603 .section "Run time configuration" "SECID7"
604 Exim's run time configuration is held in a single text file that is divided
605 into a number of sections. The entries in this file consist of keywords and
606 values, in the style of Smail 3 configuration files. A default configuration
607 file which is suitable for simple online installations is provided in the
608 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
609
610
611 .section "Calling interface" "SECID8"
612 .cindex "Sendmail compatibility" "command line interface"
613 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
614 can be a straight replacement for &_/usr/lib/sendmail_& or
615 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
616 about Sendmail in order to run Exim. For actions other than sending messages,
617 Sendmail-compatible options also exist, but those that produce output (for
618 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
619 format. There are also some additional options that are compatible with Smail
620 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
621 documents all Exim's command line options. This information is automatically
622 made into the man page that forms part of the Exim distribution.
623
624 Control of messages on the queue can be done via certain privileged command
625 line options. There is also an optional monitor program called &'eximon'&,
626 which displays current information in an X window, and which contains a menu
627 interface to Exim's command line administration options.
628
629
630
631 .section "Terminology" "SECID9"
632 .cindex "terminology definitions"
633 .cindex "body of message" "definition of"
634 The &'body'& of a message is the actual data that the sender wants to transmit.
635 It is the last part of a message, and is separated from the &'header'& (see
636 below) by a blank line.
637
638 .cindex "bounce message" "definition of"
639 When a message cannot be delivered, it is normally returned to the sender in a
640 delivery failure message or a &"non-delivery report"& (NDR). The term
641 &'bounce'& is commonly used for this action, and the error reports are often
642 called &'bounce messages'&. This is a convenient shorthand for &"delivery
643 failure error report"&. Such messages have an empty sender address in the
644 message's &'envelope'& (see below) to ensure that they cannot themselves give
645 rise to further bounce messages.
646
647 The term &'default'& appears frequently in this manual. It is used to qualify a
648 value which is used in the absence of any setting in the configuration. It may
649 also qualify an action which is taken unless a configuration setting specifies
650 otherwise.
651
652 The term &'defer'& is used when the delivery of a message to a specific
653 destination cannot immediately take place for some reason (a remote host may be
654 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
655 until a later time.
656
657 The word &'domain'& is sometimes used to mean all but the first component of a
658 host's name. It is &'not'& used in that sense here, where it normally refers to
659 the part of an email address following the @ sign.
660
661 .cindex "envelope, definition of"
662 .cindex "sender" "definition of"
663 A message in transit has an associated &'envelope'&, as well as a header and a
664 body. The envelope contains a sender address (to which bounce messages should
665 be delivered), and any number of recipient addresses. References to the
666 sender or the recipients of a message usually mean the addresses in the
667 envelope. An MTA uses these addresses for delivery, and for returning bounce
668 messages, not the addresses that appear in the header lines.
669
670 .cindex "message" "header, definition of"
671 .cindex "header section" "definition of"
672 The &'header'& of a message is the first part of a message's text, consisting
673 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
674 &'Subject:'&, etc. Long header lines can be split over several text lines by
675 indenting the continuations. The header is separated from the body by a blank
676 line.
677
678 .cindex "local part" "definition of"
679 .cindex "domain" "definition of"
680 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
681 part of an email address that precedes the @ sign. The part that follows the
682 @ sign is called the &'domain'& or &'mail domain'&.
683
684 .cindex "local delivery" "definition of"
685 .cindex "remote delivery, definition of"
686 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
687 delivery to a file or a pipe on the local host from delivery by SMTP over
688 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
689 host it is running on are &'remote'&.
690
691 .cindex "return path" "definition of"
692 &'Return path'& is another name that is used for the sender address in a
693 message's envelope.
694
695 .cindex "queue" "definition of"
696 The term &'queue'& is used to refer to the set of messages awaiting delivery,
697 because this term is in widespread use in the context of MTAs. However, in
698 Exim's case the reality is more like a pool than a queue, because there is
699 normally no ordering of waiting messages.
700
701 .cindex "queue runner" "definition of"
702 The term &'queue runner'& is used to describe a process that scans the queue
703 and attempts to deliver those messages whose retry times have come. This term
704 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
705 the waiting messages are normally processed in an unpredictable order.
706
707 .cindex "spool directory" "definition of"
708 The term &'spool directory'& is used for a directory in which Exim keeps the
709 messages on its queue &-- that is, those that it is in the process of
710 delivering. This should not be confused with the directory in which local
711 mailboxes are stored, which is called a &"spool directory"& by some people. In
712 the Exim documentation, &"spool"& is always used in the first sense.
713
714
715
716
717
718
719 . ////////////////////////////////////////////////////////////////////////////
720 . ////////////////////////////////////////////////////////////////////////////
721
722 .chapter "Incorporated code" "CHID2"
723 .cindex "incorporated code"
724 .cindex "regular expressions" "library"
725 .cindex "PCRE"
726 A number of pieces of external code are included in the Exim distribution.
727
728 .ilist
729 Regular expressions are supported in the main Exim program and in the
730 Exim monitor using the freely-distributable PCRE library, copyright
731 &copy; University of Cambridge. The source to PCRE is no longer shipped with
732 Exim, so you will need to use the version of PCRE shipped with your system,
733 or obtain and install the full version of the library from
734 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
735 .next
736 .cindex "cdb" "acknowledgment"
737 Support for the cdb (Constant DataBase) lookup method is provided by code
738 contributed by Nigel Metheringham of (at the time he contributed it) Planet
739 Online Ltd. The implementation is completely contained within the code of Exim.
740 It does not link against an external cdb library. The code contains the
741 following statements:
742
743 .blockquote
744 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
745
746 This program is free software; you can redistribute it and/or modify it under
747 the terms of the GNU General Public License as published by the Free Software
748 Foundation; either version 2 of the License, or (at your option) any later
749 version.
750 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
751 the spec and sample code for cdb can be obtained from
752 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
753 some code from Dan Bernstein's implementation (which has no license
754 restrictions applied to it).
755 .endblockquote
756 .next
757 .cindex "SPA authentication"
758 .cindex "Samba project"
759 .cindex "Microsoft Secure Password Authentication"
760 Client support for Microsoft's &'Secure Password Authentication'& is provided
761 by code contributed by Marc Prud'hommeaux. Server support was contributed by
762 Tom Kistner. This includes code taken from the Samba project, which is released
763 under the Gnu GPL.
764 .next
765 .cindex "Cyrus"
766 .cindex "&'pwcheck'& daemon"
767 .cindex "&'pwauthd'& daemon"
768 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
769 by code taken from the Cyrus-SASL library and adapted by Alexander S.
770 Sabourenkov. The permission notice appears below, in accordance with the
771 conditions expressed therein.
772
773 .blockquote
774 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
775
776 Redistribution and use in source and binary forms, with or without
777 modification, are permitted provided that the following conditions
778 are met:
779
780 .olist
781 Redistributions of source code must retain the above copyright
782 notice, this list of conditions and the following disclaimer.
783 .next
784 Redistributions in binary form must reproduce the above copyright
785 notice, this list of conditions and the following disclaimer in
786 the documentation and/or other materials provided with the
787 distribution.
788 .next
789 The name &"Carnegie Mellon University"& must not be used to
790 endorse or promote products derived from this software without
791 prior written permission. For permission or any other legal
792 details, please contact
793 .display
794               Office of Technology Transfer
795               Carnegie Mellon University
796               5000 Forbes Avenue
797               Pittsburgh, PA  15213-3890
798               (412) 268-4387, fax: (412) 268-7395
799               tech-transfer@andrew.cmu.edu
800 .endd
801 .next
802 Redistributions of any form whatsoever must retain the following
803 acknowledgment:
804
805 &"This product includes software developed by Computing Services
806 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
807
808 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
809 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
810 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
811 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
812 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
813 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
814 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
815 .endlist
816 .endblockquote
817
818 .next
819 .cindex "Exim monitor" "acknowledgment"
820 .cindex "X-windows"
821 .cindex "Athena"
822 The Exim Monitor program, which is an X-Window application, includes
823 modified versions of the Athena StripChart and TextPop widgets.
824 This code is copyright by DEC and MIT, and their permission notice appears
825 below, in accordance with the conditions expressed therein.
826
827 .blockquote
828 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
829 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
830
831 All Rights Reserved
832
833 Permission to use, copy, modify, and distribute this software and its
834 documentation for any purpose and without fee is hereby granted,
835 provided that the above copyright notice appear in all copies and that
836 both that copyright notice and this permission notice appear in
837 supporting documentation, and that the names of Digital or MIT not be
838 used in advertising or publicity pertaining to distribution of the
839 software without specific, written prior permission.
840
841 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
842 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
843 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
844 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
845 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
846 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
847 SOFTWARE.
848 .endblockquote
849
850 .next
851 Many people have contributed code fragments, some large, some small, that were
852 not covered by any specific licence requirements. It is assumed that the
853 contributors are happy to see their code incorporated into Exim under the GPL.
854 .endlist
855
856
857
858
859
860 . ////////////////////////////////////////////////////////////////////////////
861 . ////////////////////////////////////////////////////////////////////////////
862
863 .chapter "How Exim receives and delivers mail" "CHID11" &&&
864          "Receiving and delivering mail"
865
866
867 .section "Overall philosophy" "SECID10"
868 .cindex "design philosophy"
869 Exim is designed to work efficiently on systems that are permanently connected
870 to the Internet and are handling a general mix of mail. In such circumstances,
871 most messages can be delivered immediately. Consequently, Exim does not
872 maintain independent queues of messages for specific domains or hosts, though
873 it does try to send several messages in a single SMTP connection after a host
874 has been down, and it also maintains per-host retry information.
875
876
877 .section "Policy control" "SECID11"
878 .cindex "policy control" "overview"
879 Policy controls are now an important feature of MTAs that are connected to the
880 Internet. Perhaps their most important job is to stop MTAs being abused as
881 &"open relays"& by misguided individuals who send out vast amounts of
882 unsolicited junk, and want to disguise its source. Exim provides flexible
883 facilities for specifying policy controls on incoming mail:
884
885 .ilist
886 .cindex "&ACL;" "introduction"
887 Exim 4 (unlike previous versions of Exim) implements policy controls on
888 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
889 series of statements that may either grant or deny access. ACLs can be used at
890 several places in the SMTP dialogue while receiving a message from a remote
891 host. However, the most common places are after each RCPT command, and at the
892 very end of the message. The sysadmin can specify conditions for accepting or
893 rejecting individual recipients or the entire message, respectively, at these
894 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
895 error code.
896 .next
897 An ACL is also available for locally generated, non-SMTP messages. In this
898 case, the only available actions are to accept or deny the entire message.
899 .next
900 When Exim is compiled with the content-scanning extension, facilities are
901 provided in the ACL mechanism for passing the message to external virus and/or
902 spam scanning software. The result of such a scan is passed back to the ACL,
903 which can then use it to decide what to do with the message.
904 .next
905 When a message has been received, either from a remote host or from the local
906 host, but before the final acknowledgment has been sent, a locally supplied C
907 function called &[local_scan()]& can be run to inspect the message and decide
908 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
909 is accepted, the list of recipients can be modified by the function.
910 .next
911 Using the &[local_scan()]& mechanism is another way of calling external scanner
912 software. The &%SA-Exim%& add-on package works this way. It does not require
913 Exim to be compiled with the content-scanning extension.
914 .next
915 After a message has been accepted, a further checking mechanism is available in
916 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
917 runs at the start of every delivery process.
918 .endlist
919
920
921
922 .section "User filters" "SECID12"
923 .cindex "filter" "introduction"
924 .cindex "Sieve filter"
925 In a conventional Exim configuration, users are able to run private filters by
926 setting up appropriate &_.forward_& files in their home directories. See
927 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
928 configuration needed to support this, and the separate document entitled
929 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
930 of filtering are available:
931
932 .ilist
933 Sieve filters are written in the standard filtering language that is defined
934 by RFC 3028.
935 .next
936 Exim filters are written in a syntax that is unique to Exim, but which is more
937 powerful than Sieve, which it pre-dates.
938 .endlist
939
940 User filters are run as part of the routing process, described below.
941
942
943
944 .section "Message identification" "SECTmessiden"
945 .cindex "message ids" "details of format"
946 .cindex "format" "of message id"
947 .cindex "id of message"
948 .cindex "base62"
949 .cindex "base36"
950 .cindex "Darwin"
951 .cindex "Cygwin"
952 Every message handled by Exim is given a &'message id'& which is sixteen
953 characters long. It is divided into three parts, separated by hyphens, for
954 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
955 normally encoding numbers in base 62. However, in the Darwin operating
956 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
957 (avoiding the use of lower case letters) is used instead, because the message
958 id is used to construct file names, and the names of files in those systems are
959 not always case-sensitive.
960
961 .cindex "pid (process id)" "re-use of"
962 The detail of the contents of the message id have changed as Exim has evolved.
963 Earlier versions relied on the operating system not re-using a process id (pid)
964 within one second. On modern operating systems, this assumption can no longer
965 be made, so the algorithm had to be changed. To retain backward compatibility,
966 the format of the message id was retained, which is why the following rules are
967 somewhat eccentric:
968
969 .ilist
970 The first six characters of the message id are the time at which the message
971 started to be received, to a granularity of one second. That is, this field
972 contains the number of seconds since the start of the epoch (the normal Unix
973 way of representing the date and time of day).
974 .next
975 After the first hyphen, the next six characters are the id of the process that
976 received the message.
977 .next
978 There are two different possibilities for the final two characters:
979 .olist
980 .oindex "&%localhost_number%&"
981 If &%localhost_number%& is not set, this value is the fractional part of the
982 time of reception, normally in units of 1/2000 of a second, but for systems
983 that must use base 36 instead of base 62 (because of case-insensitive file
984 systems), the units are 1/1000 of a second.
985 .next
986 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
987 the fractional part of the time, which in this case is in units of 1/200
988 (1/100) of a second.
989 .endlist
990 .endlist
991
992 After a message has been received, Exim waits for the clock to tick at the
993 appropriate resolution before proceeding, so that if another message is
994 received by the same process, or by another process with the same (re-used)
995 pid, it is guaranteed that the time will be different. In most cases, the clock
996 will already have ticked while the message was being received.
997
998
999 .section "Receiving mail" "SECID13"
1000 .cindex "receiving mail"
1001 .cindex "message" "reception"
1002 The only way Exim can receive mail from another host is using SMTP over
1003 TCP/IP, in which case the sender and recipient addresses are transferred using
1004 SMTP commands. However, from a locally running process (such as a user's MUA),
1005 there are several possibilities:
1006
1007 .ilist
1008 If the process runs Exim with the &%-bm%& option, the message is read
1009 non-interactively (usually via a pipe), with the recipients taken from the
1010 command line, or from the body of the message if &%-t%& is also used.
1011 .next
1012 If the process runs Exim with the &%-bS%& option, the message is also read
1013 non-interactively, but in this case the recipients are listed at the start of
1014 the message in a series of SMTP RCPT commands, terminated by a DATA
1015 command. This is so-called &"batch SMTP"& format,
1016 but it isn't really SMTP. The SMTP commands are just another way of passing
1017 envelope addresses in a non-interactive submission.
1018 .next
1019 If the process runs Exim with the &%-bs%& option, the message is read
1020 interactively, using the SMTP protocol. A two-way pipe is normally used for
1021 passing data between the local process and the Exim process.
1022 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1023 example, the ACLs for SMTP commands are used for this form of submission.
1024 .next
1025 A local process may also make a TCP/IP call to the host's loopback address
1026 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1027 does not treat the loopback address specially. It treats all such connections
1028 in the same way as connections from other hosts.
1029 .endlist
1030
1031
1032 .cindex "message sender, constructed by Exim"
1033 .cindex "sender" "constructed by Exim"
1034 In the three cases that do not involve TCP/IP, the sender address is
1035 constructed from the login name of the user that called Exim and a default
1036 qualification domain (which can be set by the &%qualify_domain%& configuration
1037 option). For local or batch SMTP, a sender address that is passed using the
1038 SMTP MAIL command is ignored. However, the system administrator may allow
1039 certain users (&"trusted users"&) to specify a different sender address
1040 unconditionally, or all users to specify certain forms of different sender
1041 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1042 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1043 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1044 users to change sender addresses.
1045
1046 Messages received by either of the non-interactive mechanisms are subject to
1047 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1048 (either over TCP/IP, or interacting with a local process) can be checked by a
1049 number of ACLs that operate at different times during the SMTP session. Either
1050 individual recipients, or the entire message, can be rejected if local policy
1051 requirements are not met. The &[local_scan()]& function (see chapter
1052 &<<CHAPlocalscan>>&) is run for all incoming messages.
1053
1054 Exim can be configured not to start a delivery process when a message is
1055 received; this can be unconditional, or depend on the number of incoming SMTP
1056 connections or the system load. In these situations, new messages wait on the
1057 queue until a queue runner process picks them up. However, in standard
1058 configurations under normal conditions, delivery is started as soon as a
1059 message is received.
1060
1061
1062
1063
1064
1065 .section "Handling an incoming message" "SECID14"
1066 .cindex "spool directory" "files that hold a message"
1067 .cindex "file" "how a message is held"
1068 When Exim accepts a message, it writes two files in its spool directory. The
1069 first contains the envelope information, the current status of the message, and
1070 the header lines, and the second contains the body of the message. The names of
1071 the two spool files consist of the message id, followed by &`-H`& for the
1072 file containing the envelope and header, and &`-D`& for the data file.
1073
1074 .cindex "spool directory" "&_input_& sub-directory"
1075 By default all these message files are held in a single directory called
1076 &_input_& inside the general Exim spool directory. Some operating systems do
1077 not perform very well if the number of files in a directory gets large; to
1078 improve performance in such cases, the &%split_spool_directory%& option can be
1079 used. This causes Exim to split up the input files into 62 sub-directories
1080 whose names are single letters or digits. When this is done, the queue is
1081 processed one sub-directory at a time instead of all at once, which can improve
1082 overall performance even when there are not enough files in each directory to
1083 affect file system performance.
1084
1085 The envelope information consists of the address of the message's sender and
1086 the addresses of the recipients. This information is entirely separate from
1087 any addresses contained in the header lines. The status of the message includes
1088 a list of recipients who have already received the message. The format of the
1089 first spool file is described in chapter &<<CHAPspool>>&.
1090
1091 .cindex "rewriting" "addresses"
1092 Address rewriting that is specified in the rewrite section of the configuration
1093 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1094 both in the header lines and the envelope, at the time the message is accepted.
1095 If during the course of delivery additional addresses are generated (for
1096 example, via aliasing), these new addresses are rewritten as soon as they are
1097 generated. At the time a message is actually delivered (transported) further
1098 rewriting can take place; because this is a transport option, it can be
1099 different for different forms of delivery. It is also possible to specify the
1100 addition or removal of certain header lines at the time the message is
1101 delivered (see chapters &<<CHAProutergeneric>>& and
1102 &<<CHAPtransportgeneric>>&).
1103
1104
1105
1106 .section "Life of a message" "SECID15"
1107 .cindex "message" "life of"
1108 .cindex "message" "frozen"
1109 A message remains in the spool directory until it is completely delivered to
1110 its recipients or to an error address, or until it is deleted by an
1111 administrator or by the user who originally created it. In cases when delivery
1112 cannot proceed &-- for example, when a message can neither be delivered to its
1113 recipients nor returned to its sender, the message is marked &"frozen"& on the
1114 spool, and no more deliveries are attempted.
1115
1116 .cindex "frozen messages" "thawing"
1117 .cindex "message" "thawing frozen"
1118 An administrator can &"thaw"& such messages when the problem has been
1119 corrected, and can also freeze individual messages by hand if necessary. In
1120 addition, an administrator can force a delivery error, causing a bounce message
1121 to be sent.
1122
1123 .oindex "&%timeout_frozen_after%&"
1124 .oindex "&%ignore_bounce_errors_after%&"
1125 There are options called &%ignore_bounce_errors_after%& and
1126 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1127 The first applies only to frozen bounces, the second to any frozen messages.
1128
1129 .cindex "message" "log file for"
1130 .cindex "log" "file for each message"
1131 While Exim is working on a message, it writes information about each delivery
1132 attempt to its main log file. This includes successful, unsuccessful, and
1133 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1134 lines are also written to a separate &'message log'& file for each message.
1135 These logs are solely for the benefit of the administrator, and are normally
1136 deleted along with the spool files when processing of a message is complete.
1137 The use of individual message logs can be disabled by setting
1138 &%no_message_logs%&; this might give an improvement in performance on very busy
1139 systems.
1140
1141 .cindex "journal file"
1142 .cindex "file" "journal"
1143 All the information Exim itself needs to set up a delivery is kept in the first
1144 spool file, along with the header lines. When a successful delivery occurs, the
1145 address is immediately written at the end of a journal file, whose name is the
1146 message id followed by &`-J`&. At the end of a delivery run, if there are some
1147 addresses left to be tried again later, the first spool file (the &`-H`& file)
1148 is updated to indicate which these are, and the journal file is then deleted.
1149 Updating the spool file is done by writing a new file and renaming it, to
1150 minimize the possibility of data loss.
1151
1152 Should the system or the program crash after a successful delivery but before
1153 the spool file has been updated, the journal is left lying around. The next
1154 time Exim attempts to deliver the message, it reads the journal file and
1155 updates the spool file before proceeding. This minimizes the chances of double
1156 deliveries caused by crashes.
1157
1158
1159
1160 .section "Processing an address for delivery" "SECTprocaddress"
1161 .cindex "drivers" "definition of"
1162 .cindex "router" "definition of"
1163 .cindex "transport" "definition of"
1164 The main delivery processing elements of Exim are called &'routers'& and
1165 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1166 number of them is provided in the source distribution, and compile-time options
1167 specify which ones are included in the binary. Run time options specify which
1168 ones are actually used for delivering messages.
1169
1170 .cindex "drivers" "instance definition"
1171 Each driver that is specified in the run time configuration is an &'instance'&
1172 of that particular driver type. Multiple instances are allowed; for example,
1173 you can set up several different &(smtp)& transports, each with different
1174 option values that might specify different ports or different timeouts. Each
1175 instance has its own identifying name. In what follows we will normally use the
1176 instance name when discussing one particular instance (that is, one specific
1177 configuration of the driver), and the generic driver name when discussing
1178 the driver's features in general.
1179
1180 A &'router'& is a driver that operates on an address, either determining how
1181 its delivery should happen, by assigning it to a specific transport, or
1182 converting the address into one or more new addresses (for example, via an
1183 alias file). A router may also explicitly choose to fail an address, causing it
1184 to be bounced.
1185
1186 A &'transport'& is a driver that transmits a copy of the message from Exim's
1187 spool to some destination. There are two kinds of transport: for a &'local'&
1188 transport, the destination is a file or a pipe on the local host, whereas for a
1189 &'remote'& transport the destination is some other host. A message is passed
1190 to a specific transport as a result of successful routing. If a message has
1191 several recipients, it may be passed to a number of different transports.
1192
1193 .cindex "preconditions" "definition of"
1194 An address is processed by passing it to each configured router instance in
1195 turn, subject to certain preconditions, until a router accepts the address or
1196 specifies that it should be bounced. We will describe this process in more
1197 detail shortly. First, as a simple example, we consider how each recipient
1198 address in a message is processed in a small configuration of three routers.
1199
1200 To make this a more concrete example, it is described in terms of some actual
1201 routers, but remember, this is only an example. You can configure Exim's
1202 routers in many different ways, and there may be any number of routers in a
1203 configuration.
1204
1205 The first router that is specified in a configuration is often one that handles
1206 addresses in domains that are not recognized specially by the local host. These
1207 are typically addresses for arbitrary domains on the Internet. A precondition
1208 is set up which looks for the special domains known to the host (for example,
1209 its own domain name), and the router is run for addresses that do &'not'&
1210 match. Typically, this is a router that looks up domains in the DNS in order to
1211 find the hosts to which this address routes. If it succeeds, the address is
1212 assigned to a suitable SMTP transport; if it does not succeed, the router is
1213 configured to fail the address.
1214
1215 The second router is reached only when the domain is recognized as one that
1216 &"belongs"& to the local host. This router does redirection &-- also known as
1217 aliasing and forwarding. When it generates one or more new addresses from the
1218 original, each of them is routed independently from the start. Otherwise, the
1219 router may cause an address to fail, or it may simply decline to handle the
1220 address, in which case the address is passed to the next router.
1221
1222 The final router in many configurations is one that checks to see if the
1223 address belongs to a local mailbox. The precondition may involve a check to
1224 see if the local part is the name of a login account, or it may look up the
1225 local part in a file or a database. If its preconditions are not met, or if
1226 the router declines, we have reached the end of the routers. When this happens,
1227 the address is bounced.
1228
1229
1230
1231 .section "Processing an address for verification" "SECID16"
1232 .cindex "router" "for verification"
1233 .cindex "verifying address" "overview"
1234 As well as being used to decide how to deliver to an address, Exim's routers
1235 are also used for &'address verification'&. Verification can be requested as
1236 one of the checks to be performed in an ACL for incoming messages, on both
1237 sender and recipient addresses, and it can be tested using the &%-bv%& and
1238 &%-bvs%& command line options.
1239
1240 When an address is being verified, the routers are run in &"verify mode"&. This
1241 does not affect the way the routers work, but it is a state that can be
1242 detected. By this means, a router can be skipped or made to behave differently
1243 when verifying. A common example is a configuration in which the first router
1244 sends all messages to a message-scanning program, unless they have been
1245 previously scanned. Thus, the first router accepts all addresses without any
1246 checking, making it useless for verifying. Normally, the &%no_verify%& option
1247 would be set for such a router, causing it to be skipped in verify mode.
1248
1249
1250
1251
1252 .section "Running an individual router" "SECTrunindrou"
1253 .cindex "router" "running details"
1254 .cindex "preconditions" "checking"
1255 .cindex "router" "result of running"
1256 As explained in the example above, a number of preconditions are checked before
1257 running a router. If any are not met, the router is skipped, and the address is
1258 passed to the next router. When all the preconditions on a router &'are'& met,
1259 the router is run. What happens next depends on the outcome, which is one of
1260 the following:
1261
1262 .ilist
1263 &'accept'&: The router accepts the address, and either assigns it to a
1264 transport, or generates one or more &"child"& addresses. Processing the
1265 original address ceases,
1266 .oindex "&%unseen%&"
1267 unless the &%unseen%& option is set on the router. This option
1268 can be used to set up multiple deliveries with different routing (for example,
1269 for keeping archive copies of messages). When &%unseen%& is set, the address is
1270 passed to the next router. Normally, however, an &'accept'& return marks the
1271 end of routing.
1272
1273 Any child addresses generated by the router are processed independently,
1274 starting with the first router by default. It is possible to change this by
1275 setting the &%redirect_router%& option to specify which router to start at for
1276 child addresses. Unlike &%pass_router%& (see below) the router specified by
1277 &%redirect_router%& may be anywhere in the router configuration.
1278 .next
1279 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1280 requests that the address be passed to another router. By default the address
1281 is passed to the next router, but this can be changed by setting the
1282 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1283 must be below the current router (to avoid loops).
1284 .next
1285 &'decline'&: The router declines to accept the address because it does not
1286 recognize it at all. By default, the address is passed to the next router, but
1287 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1288 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1289 &'decline'& into &'fail'&.
1290 .next
1291 &'fail'&: The router determines that the address should fail, and queues it for
1292 the generation of a bounce message. There is no further processing of the
1293 original address unless &%unseen%& is set on the router.
1294 .next
1295 &'defer'&: The router cannot handle the address at the present time. (A
1296 database may be offline, or a DNS lookup may have timed out.) No further
1297 processing of the address happens in this delivery attempt. It is tried again
1298 next time the message is considered for delivery.
1299 .next
1300 &'error'&: There is some error in the router (for example, a syntax error in
1301 its configuration). The action is as for defer.
1302 .endlist
1303
1304 If an address reaches the end of the routers without having been accepted by
1305 any of them, it is bounced as unrouteable. The default error message in this
1306 situation is &"unrouteable address"&, but you can set your own message by
1307 making use of the &%cannot_route_message%& option. This can be set for any
1308 router; the value from the last router that &"saw"& the address is used.
1309
1310 Sometimes while routing you want to fail a delivery when some conditions are
1311 met but others are not, instead of passing the address on for further routing.
1312 You can do this by having a second router that explicitly fails the delivery
1313 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1314 facility for this purpose.
1315
1316
1317 .section "Duplicate addresses" "SECID17"
1318 .cindex "case of local parts"
1319 .cindex "address duplicate, discarding"
1320 .cindex "duplicate addresses"
1321 Once routing is complete, Exim scans the addresses that are assigned to local
1322 and remote transports, and discards any duplicates that it finds. During this
1323 check, local parts are treated as case-sensitive. This happens only when
1324 actually delivering a message; when testing routers with &%-bt%&, all the
1325 routed addresses are shown.
1326
1327
1328
1329 .section "Router preconditions" "SECTrouprecon"
1330 .cindex "router" "preconditions, order of processing"
1331 .cindex "preconditions" "order of processing"
1332 The preconditions that are tested for each router are listed below, in the
1333 order in which they are tested. The individual configuration options are
1334 described in more detail in chapter &<<CHAProutergeneric>>&.
1335
1336 .ilist
1337 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1338 the local parts handled by the router may or must have certain prefixes and/or
1339 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1340 skipped. These conditions are tested first. When an affix is present, it is
1341 removed from the local part before further processing, including the evaluation
1342 of any other conditions.
1343 .next
1344 Routers can be designated for use only when not verifying an address, that is,
1345 only when routing it for delivery (or testing its delivery routing). If the
1346 &%verify%& option is set false, the router is skipped when Exim is verifying an
1347 address.
1348 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1349 &%verify_recipient%&, which independently control the use of the router for
1350 sender and recipient verification. You can set these options directly if
1351 you want a router to be used for only one type of verification.
1352 .next
1353 If the &%address_test%& option is set false, the router is skipped when Exim is
1354 run with the &%-bt%& option to test an address routing. This can be helpful
1355 when the first router sends all new messages to a scanner of some sort; it
1356 makes it possible to use &%-bt%& to test subsequent delivery routing without
1357 having to simulate the effect of the scanner.
1358 .next
1359 Routers can be designated for use only when verifying an address, as
1360 opposed to routing it for delivery. The &%verify_only%& option controls this.
1361 .next
1362 Individual routers can be explicitly skipped when running the routers to
1363 check an address given in the SMTP EXPN command (see the &%expn%& option).
1364 .next
1365 If the &%domains%& option is set, the domain of the address must be in the set
1366 of domains that it defines.
1367 .next
1368 .vindex "&$local_part_prefix$&"
1369 .vindex "&$local_part$&"
1370 .vindex "&$local_part_suffix$&"
1371 If the &%local_parts%& option is set, the local part of the address must be in
1372 the set of local parts that it defines. If &%local_part_prefix%& or
1373 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1374 part before this check. If you want to do precondition tests on local parts
1375 that include affixes, you can do so by using a &%condition%& option (see below)
1376 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1377 &$local_part_suffix$& as necessary.
1378 .next
1379 .vindex "&$local_user_uid$&"
1380 .vindex "&$local_user_gid$&"
1381 .vindex "&$home$&"
1382 If the &%check_local_user%& option is set, the local part must be the name of
1383 an account on the local host. If this check succeeds, the uid and gid of the
1384 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1385 user's home directory is placed in &$home$&; these values can be used in the
1386 remaining preconditions.
1387 .next
1388 If the &%router_home_directory%& option is set, it is expanded at this point,
1389 because it overrides the value of &$home$&. If this expansion were left till
1390 later, the value of &$home$& as set by &%check_local_user%& would be used in
1391 subsequent tests. Having two different values of &$home$& in the same router
1392 could lead to confusion.
1393 .next
1394 If the &%senders%& option is set, the envelope sender address must be in the
1395 set of addresses that it defines.
1396 .next
1397 If the &%require_files%& option is set, the existence or non-existence of
1398 specified files is tested.
1399 .next
1400 .cindex "customizing" "precondition"
1401 If the &%condition%& option is set, it is evaluated and tested. This option
1402 uses an expanded string to allow you to set up your own custom preconditions.
1403 Expanded strings are described in chapter &<<CHAPexpand>>&.
1404 .endlist
1405
1406
1407 Note that &%require_files%& comes near the end of the list, so you cannot use
1408 it to check for the existence of a file in which to lookup up a domain, local
1409 part, or sender. However, as these options are all expanded, you can use the
1410 &%exists%& expansion condition to make such tests within each condition. The
1411 &%require_files%& option is intended for checking files that the router may be
1412 going to use internally, or which are needed by a specific transport (for
1413 example, &_.procmailrc_&).
1414
1415
1416
1417 .section "Delivery in detail" "SECID18"
1418 .cindex "delivery" "in detail"
1419 When a message is to be delivered, the sequence of events is as follows:
1420
1421 .ilist
1422 If a system-wide filter file is specified, the message is passed to it. The
1423 filter may add recipients to the message, replace the recipients, discard the
1424 message, cause a new message to be generated, or cause the message delivery to
1425 fail. The format of the system filter file is the same as for Exim user filter
1426 files, described in the separate document entitled &'Exim's interfaces to mail
1427 filtering'&.
1428 .cindex "Sieve filter" "not available for system filter"
1429 (&*Note*&: Sieve cannot be used for system filter files.)
1430
1431 Some additional features are available in system filters &-- see chapter
1432 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1433 filter only once per delivery attempt, however many recipients it has. However,
1434 if there are several delivery attempts because one or more addresses could not
1435 be immediately delivered, the system filter is run each time. The filter
1436 condition &%first_delivery%& can be used to detect the first run of the system
1437 filter.
1438 .next
1439 Each recipient address is offered to each configured router in turn, subject to
1440 its preconditions, until one is able to handle it. If no router can handle the
1441 address, that is, if they all decline, the address is failed. Because routers
1442 can be targeted at particular domains, several locally handled domains can be
1443 processed entirely independently of each other.
1444 .next
1445 .cindex "routing" "loops in"
1446 .cindex "loop" "while routing"
1447 A router that accepts an address may assign it to a local or a remote
1448 transport. However, the transport is not run at this time. Instead, the address
1449 is placed on a list for the particular transport, which will be run later.
1450 Alternatively, the router may generate one or more new addresses (typically
1451 from alias, forward, or filter files). New addresses are fed back into this
1452 process from the top, but in order to avoid loops, a router ignores any address
1453 which has an identically-named ancestor that was processed by itself.
1454 .next
1455 When all the routing has been done, addresses that have been successfully
1456 handled are passed to their assigned transports. When local transports are
1457 doing real local deliveries, they handle only one address at a time, but if a
1458 local transport is being used as a pseudo-remote transport (for example, to
1459 collect batched SMTP messages for transmission by some other means) multiple
1460 addresses can be handled. Remote transports can always handle more than one
1461 address at a time, but can be configured not to do so, or to restrict multiple
1462 addresses to the same domain.
1463 .next
1464 Each local delivery to a file or a pipe runs in a separate process under a
1465 non-privileged uid, and these deliveries are run one at a time. Remote
1466 deliveries also run in separate processes, normally under a uid that is private
1467 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1468 run in parallel. The maximum number of simultaneous remote deliveries for any
1469 one message is set by the &%remote_max_parallel%& option.
1470 The order in which deliveries are done is not defined, except that all local
1471 deliveries happen before any remote deliveries.
1472 .next
1473 .cindex "queue runner"
1474 When it encounters a local delivery during a queue run, Exim checks its retry
1475 database to see if there has been a previous temporary delivery failure for the
1476 address before running the local transport. If there was a previous failure,
1477 Exim does not attempt a new delivery until the retry time for the address is
1478 reached. However, this happens only for delivery attempts that are part of a
1479 queue run. Local deliveries are always attempted when delivery immediately
1480 follows message reception, even if retry times are set for them. This makes for
1481 better behaviour if one particular message is causing problems (for example,
1482 causing quota overflow, or provoking an error in a filter file).
1483 .next
1484 .cindex "delivery" "retry in remote transports"
1485 Remote transports do their own retry handling, since an address may be
1486 deliverable to one of a number of hosts, each of which may have a different
1487 retry time. If there have been previous temporary failures and no host has
1488 reached its retry time, no delivery is attempted, whether in a queue run or
1489 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1490 .next
1491 If there were any permanent errors, a bounce message is returned to an
1492 appropriate address (the sender in the common case), with details of the error
1493 for each failing address. Exim can be configured to send copies of bounce
1494 messages to other addresses.
1495 .next
1496 .cindex "delivery" "deferral"
1497 If one or more addresses suffered a temporary failure, the message is left on
1498 the queue, to be tried again later. Delivery of these addresses is said to be
1499 &'deferred'&.
1500 .next
1501 When all the recipient addresses have either been delivered or bounced,
1502 handling of the message is complete. The spool files and message log are
1503 deleted, though the message log can optionally be preserved if required.
1504 .endlist
1505
1506
1507
1508
1509 .section "Retry mechanism" "SECID19"
1510 .cindex "delivery" "retry mechanism"
1511 .cindex "retry" "description of mechanism"
1512 .cindex "queue runner"
1513 Exim's mechanism for retrying messages that fail to get delivered at the first
1514 attempt is the queue runner process. You must either run an Exim daemon that
1515 uses the &%-q%& option with a time interval to start queue runners at regular
1516 intervals, or use some other means (such as &'cron'&) to start them. If you do
1517 not arrange for queue runners to be run, messages that fail temporarily at the
1518 first attempt will remain on your queue for ever. A queue runner process works
1519 its way through the queue, one message at a time, trying each delivery that has
1520 passed its retry time.
1521 You can run several queue runners at once.
1522
1523 Exim uses a set of configured rules to determine when next to retry the failing
1524 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1525 should give up trying to deliver to the address, at which point it generates a
1526 bounce message. If no retry rules are set for a particular host, address, and
1527 error combination, no retries are attempted, and temporary errors are treated
1528 as permanent.
1529
1530
1531
1532 .section "Temporary delivery failure" "SECID20"
1533 .cindex "delivery" "temporary failure"
1534 There are many reasons why a message may not be immediately deliverable to a
1535 particular address. Failure to connect to a remote machine (because it, or the
1536 connection to it, is down) is one of the most common. Temporary failures may be
1537 detected during routing as well as during the transport stage of delivery.
1538 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1539 is on a file system where the user is over quota. Exim can be configured to
1540 impose its own quotas on local mailboxes; where system quotas are set they will
1541 also apply.
1542
1543 If a host is unreachable for a period of time, a number of messages may be
1544 waiting for it by the time it recovers, and sending them in a single SMTP
1545 connection is clearly beneficial. Whenever a delivery to a remote host is
1546 deferred,
1547
1548 .cindex "hints database"
1549 Exim makes a note in its hints database, and whenever a successful
1550 SMTP delivery has happened, it looks to see if any other messages are waiting
1551 for the same host. If any are found, they are sent over the same SMTP
1552 connection, subject to a configuration limit as to the maximum number in any
1553 one connection.
1554
1555
1556
1557
1558 .section "Permanent delivery failure" "SECID21"
1559 .cindex "delivery" "permanent failure"
1560 .cindex "bounce message" "when generated"
1561 When a message cannot be delivered to some or all of its intended recipients, a
1562 bounce message is generated. Temporary delivery failures turn into permanent
1563 errors when their timeout expires. All the addresses that fail in a given
1564 delivery attempt are listed in a single message. If the original message has
1565 many recipients, it is possible for some addresses to fail in one delivery
1566 attempt and others to fail subsequently, giving rise to more than one bounce
1567 message. The wording of bounce messages can be customized by the administrator.
1568 See chapter &<<CHAPemsgcust>>& for details.
1569
1570 .cindex "&'X-Failed-Recipients:'& header line"
1571 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1572 failed addresses, for the benefit of programs that try to analyse such messages
1573 automatically.
1574
1575 .cindex "bounce message" "recipient of"
1576 A bounce message is normally sent to the sender of the original message, as
1577 obtained from the message's envelope. For incoming SMTP messages, this is the
1578 address given in the MAIL command. However, when an address is expanded via a
1579 forward or alias file, an alternative address can be specified for delivery
1580 failures of the generated addresses. For a mailing list expansion (see section
1581 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1582 of the list.
1583
1584
1585
1586 .section "Failures to deliver bounce messages" "SECID22"
1587 .cindex "bounce message" "failure to deliver"
1588 If a bounce message (either locally generated or received from a remote host)
1589 itself suffers a permanent delivery failure, the message is left on the queue,
1590 but it is frozen, awaiting the attention of an administrator. There are options
1591 that can be used to make Exim discard such failed messages, or to keep them
1592 for only a short time (see &%timeout_frozen_after%& and
1593 &%ignore_bounce_errors_after%&).
1594
1595
1596
1597
1598
1599 . ////////////////////////////////////////////////////////////////////////////
1600 . ////////////////////////////////////////////////////////////////////////////
1601
1602 .chapter "Building and installing Exim" "CHID3"
1603 .scindex IIDbuex "building Exim"
1604
1605 .section "Unpacking" "SECID23"
1606 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1607 creates a directory with the name of the current release (for example,
1608 &_exim-&version;_&) into which the following files are placed:
1609
1610 .table2 140pt
1611 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1612 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1613   documented"
1614 .irow &_LICENCE_&         "the GNU General Public Licence"
1615 .irow &_Makefile_&        "top-level make file"
1616 .irow &_NOTICE_&          "conditions for the use of Exim"
1617 .irow &_README_&          "list of files, directories and simple build &&&
1618   instructions"
1619 .endtable
1620
1621 Other files whose names begin with &_README_& may also be present. The
1622 following subdirectories are created:
1623
1624 .table2 140pt
1625 .irow &_Local_&           "an empty directory for local configuration files"
1626 .irow &_OS_&              "OS-specific files"
1627 .irow &_doc_&             "documentation files"
1628 .irow &_exim_monitor_&    "source files for the Exim monitor"
1629 .irow &_scripts_&         "scripts used in the build process"
1630 .irow &_src_&             "remaining source files"
1631 .irow &_util_&            "independent utilities"
1632 .endtable
1633
1634 The main utility programs are contained in the &_src_& directory, and are built
1635 with the Exim binary. The &_util_& directory contains a few optional scripts
1636 that may be useful to some sites.
1637
1638
1639 .section "Multiple machine architectures and operating systems" "SECID24"
1640 .cindex "building Exim" "multiple OS/architectures"
1641 The building process for Exim is arranged to make it easy to build binaries for
1642 a number of different architectures and operating systems from the same set of
1643 source files. Compilation does not take place in the &_src_& directory.
1644 Instead, a &'build directory'& is created for each architecture and operating
1645 system.
1646 .cindex "symbolic link" "to build directory"
1647 Symbolic links to the sources are installed in this directory, which is where
1648 the actual building takes place. In most cases, Exim can discover the machine
1649 architecture and operating system for itself, but the defaults can be
1650 overridden if necessary.
1651
1652
1653 .section "PCRE library" "SECTpcre"
1654 .cindex "PCRE library"
1655 Exim no longer has an embedded PCRE library as the vast majority of
1656 modern systems include PCRE as a system library, although you may need
1657 to install the PCRE or PCRE development package for your operating
1658 system. If your system has a normal PCRE installation the Exim build
1659 process will need no further configuration. If the library or the
1660 headers are in an unusual location you will need to set the PCRE_LIBS
1661 and INCLUDE directives appropriately. If your operating system has no
1662 PCRE support then you will need to obtain and build the current PCRE
1663 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1664
1665 .section "DBM libraries" "SECTdb"
1666 .cindex "DBM libraries" "discussion of"
1667 .cindex "hints database" "DBM files used for"
1668 Even if you do not use any DBM files in your configuration, Exim still needs a
1669 DBM library in order to operate, because it uses indexed files for its hints
1670 databases. Unfortunately, there are a number of DBM libraries in existence, and
1671 different operating systems often have different ones installed.
1672
1673 .cindex "Solaris" "DBM library for"
1674 .cindex "IRIX, DBM library for"
1675 .cindex "BSD, DBM library for"
1676 .cindex "Linux, DBM library for"
1677 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1678 Linux distribution, the DBM configuration should happen automatically, and you
1679 may be able to ignore this section. Otherwise, you may have to learn more than
1680 you would like about DBM libraries from what follows.
1681
1682 .cindex "&'ndbm'& DBM library"
1683 Licensed versions of Unix normally contain a library of DBM functions operating
1684 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1685 versions of Unix seem to vary in what they contain as standard. In particular,
1686 some early versions of Linux have no default DBM library, and different
1687 distributors have chosen to bundle different libraries with their packaged
1688 versions. However, the more recent releases seem to have standardized on the
1689 Berkeley DB library.
1690
1691 Different DBM libraries have different conventions for naming the files they
1692 use. When a program opens a file called &_dbmfile_&, there are several
1693 possibilities:
1694
1695 .olist
1696 A traditional &'ndbm'& implementation, such as that supplied as part of
1697 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1698 .next
1699 .cindex "&'gdbm'& DBM library"
1700 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1701 compatibility interface it makes two different hard links to it with names
1702 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1703 file name is used unmodified.
1704 .next
1705 .cindex "Berkeley DB library"
1706 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1707 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1708 programmer exactly the same as the traditional &'ndbm'& implementation.
1709 .next
1710 If the Berkeley package is used in its native mode, it operates on a single
1711 file called &_dbmfile_&; the programmer's interface is somewhat different to
1712 the traditional &'ndbm'& interface.
1713 .next
1714 To complicate things further, there are several very different versions of the
1715 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1716 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1717 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1718 versions of Berkeley DB can be obtained from
1719 &url(http://www.sleepycat.com/).
1720 .next
1721 .cindex "&'tdb'& DBM library"
1722 Yet another DBM library, called &'tdb'&, is available from
1723 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1724 operates on a single file.
1725 .endlist
1726
1727 .cindex "USE_DB"
1728 .cindex "DBM libraries" "configuration for building"
1729 Exim and its utilities can be compiled to use any of these interfaces. In order
1730 to use any version of the Berkeley DB package in native mode, you must set
1731 USE_DB in an appropriate configuration file (typically
1732 &_Local/Makefile_&). For example:
1733 .code
1734 USE_DB=yes
1735 .endd
1736 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1737 error is diagnosed if you set more than one of these.
1738
1739 At the lowest level, the build-time configuration sets none of these options,
1740 thereby assuming an interface of type (1). However, some operating system
1741 configuration files (for example, those for the BSD operating systems and
1742 Linux) assume type (4) by setting USE_DB as their default, and the
1743 configuration files for Cygwin set USE_GDBM. Anything you set in
1744 &_Local/Makefile_&, however, overrides these system defaults.
1745
1746 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1747 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1748 in one of these lines:
1749 .code
1750 DBMLIB = -ldb
1751 DBMLIB = -ltdb
1752 .endd
1753 Settings like that will work if the DBM library is installed in the standard
1754 place. Sometimes it is not, and the library's header file may also not be in
1755 the default path. You may need to set INCLUDE to specify where the header
1756 file is, and to specify the path to the library more fully in DBMLIB, as in
1757 this example:
1758 .code
1759 INCLUDE=-I/usr/local/include/db-4.1
1760 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1761 .endd
1762 There is further detailed discussion about the various DBM libraries in the
1763 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1764
1765
1766
1767 .section "Pre-building configuration" "SECID25"
1768 .cindex "building Exim" "pre-building configuration"
1769 .cindex "configuration for building Exim"
1770 .cindex "&_Local/Makefile_&"
1771 .cindex "&_src/EDITME_&"
1772 Before building Exim, a local configuration file that specifies options
1773 independent of any operating system has to be created with the name
1774 &_Local/Makefile_&. A template for this file is supplied as the file
1775 &_src/EDITME_&, and it contains full descriptions of all the option settings
1776 therein. These descriptions are therefore not repeated here. If you are
1777 building Exim for the first time, the simplest thing to do is to copy
1778 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1779
1780 There are three settings that you must supply, because Exim will not build
1781 without them. They are the location of the run time configuration file
1782 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1783 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1784 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1785 a colon-separated list of file names; Exim uses the first of them that exists.
1786
1787 There are a few other parameters that can be specified either at build time or
1788 at run time, to enable the same binary to be used on a number of different
1789 machines. However, if the locations of Exim's spool directory and log file
1790 directory (if not within the spool directory) are fixed, it is recommended that
1791 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1792 detected early in Exim's execution (such as a malformed configuration file) can
1793 be logged.
1794
1795 .cindex "content scanning" "specifying at build time"
1796 Exim's interfaces for calling virus and spam scanning software directly from
1797 access control lists are not compiled by default. If you want to include these
1798 facilities, you need to set
1799 .code
1800 WITH_CONTENT_SCAN=yes
1801 .endd
1802 in your &_Local/Makefile_&. For details of the facilities themselves, see
1803 chapter &<<CHAPexiscan>>&.
1804
1805
1806 .cindex "&_Local/eximon.conf_&"
1807 .cindex "&_exim_monitor/EDITME_&"
1808 If you are going to build the Exim monitor, a similar configuration process is
1809 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1810 your installation and saved under the name &_Local/eximon.conf_&. If you are
1811 happy with the default settings described in &_exim_monitor/EDITME_&,
1812 &_Local/eximon.conf_& can be empty, but it must exist.
1813
1814 This is all the configuration that is needed in straightforward cases for known
1815 operating systems. However, the building process is set up so that it is easy
1816 to override options that are set by default or by operating-system-specific
1817 configuration files, for example to change the name of the C compiler, which
1818 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1819 do this.
1820
1821
1822
1823 .section "Support for iconv()" "SECID26"
1824 .cindex "&[iconv()]& support"
1825 .cindex "RFC 2047"
1826 The contents of header lines in messages may be encoded according to the rules
1827 described RFC 2047. This makes it possible to transmit characters that are not
1828 in the ASCII character set, and to label them as being in a particular
1829 character set. When Exim is inspecting header lines by means of the &%$h_%&
1830 mechanism, it decodes them, and translates them into a specified character set
1831 (default ISO-8859-1). The translation is possible only if the operating system
1832 supports the &[iconv()]& function.
1833
1834 However, some of the operating systems that supply &[iconv()]& do not support
1835 very many conversions. The GNU &%libiconv%& library (available from
1836 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1837 systems to remedy this deficiency, as well as on systems that do not supply
1838 &[iconv()]& at all. After installing &%libiconv%&, you should add
1839 .code
1840 HAVE_ICONV=yes
1841 .endd
1842 to your &_Local/Makefile_& and rebuild Exim.
1843
1844
1845
1846 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1847 .cindex "TLS" "including support for TLS"
1848 .cindex "encryption" "including support for"
1849 .cindex "SUPPORT_TLS"
1850 .cindex "OpenSSL" "building Exim with"
1851 .cindex "GnuTLS" "building Exim with"
1852 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1853 command as per RFC 2487. It can also support legacy clients that expect to
1854 start a TLS session immediately on connection to a non-standard port (see the
1855 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1856 line option).
1857
1858 If you want to build Exim with TLS support, you must first install either the
1859 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1860 implementing SSL.
1861
1862 If OpenSSL is installed, you should set
1863 .code
1864 SUPPORT_TLS=yes
1865 TLS_LIBS=-lssl -lcrypto
1866 .endd
1867 in &_Local/Makefile_&. You may also need to specify the locations of the
1868 OpenSSL library and include files. For example:
1869 .code
1870 SUPPORT_TLS=yes
1871 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1872 TLS_INCLUDE=-I/usr/local/openssl/include/
1873 .endd
1874 .cindex "USE_GNUTLS"
1875 If GnuTLS is installed, you should set
1876 .code
1877 SUPPORT_TLS=yes
1878 USE_GNUTLS=yes
1879 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1880 .endd
1881 in &_Local/Makefile_&, and again you may need to specify the locations of the
1882 library and include files. For example:
1883 .code
1884 SUPPORT_TLS=yes
1885 USE_GNUTLS=yes
1886 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1887 TLS_INCLUDE=-I/usr/gnu/include
1888 .endd
1889 You do not need to set TLS_INCLUDE if the relevant directory is already
1890 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1891 given in chapter &<<CHAPTLS>>&.
1892
1893
1894
1895
1896 .section "Use of tcpwrappers" "SECID27"
1897 .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 .cindex "TXT record" "in &(dnsdb)& lookup"
6683 For TXT records with multiple items of data, only the first item is returned,
6684 unless a separator for them is specified using a comma after the separator
6685 character followed immediately by the TXT record item separator. To concatenate
6686 items without a separator, use a semicolon instead.
6687 .code
6688 ${lookup dnsdb{>\n,: txt=a.b.example}}
6689 ${lookup dnsdb{>\n; txt=a.b.example}}
6690 .endd
6691 It is permitted to specify a space as the separator character. Further
6692 white space is ignored.
6693
6694 .section "Pseudo dnsdb record types" "SECID66"
6695 .cindex "MX record" "in &(dnsdb)& lookup"
6696 By default, both the preference value and the host name are returned for
6697 each MX record, separated by a space. If you want only host names, you can use
6698 the pseudo-type MXH:
6699 .code
6700 ${lookup dnsdb{mxh=a.b.example}}
6701 .endd
6702 In this case, the preference values are omitted, and just the host names are
6703 returned.
6704
6705 .cindex "name server for enclosing domain"
6706 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6707 records on the given domain, but if none are found, it removes the first
6708 component of the domain name, and tries again. This process continues until NS
6709 records are found or there are no more components left (or there is a DNS
6710 error). In other words, it may return the name servers for a top-level domain,
6711 but it never returns the root name servers. If there are no NS records for the
6712 top-level domain, the lookup fails. Consider these examples:
6713 .code
6714 ${lookup dnsdb{zns=xxx.quercite.com}}
6715 ${lookup dnsdb{zns=xxx.edu}}
6716 .endd
6717 Assuming that in each case there are no NS records for the full domain name,
6718 the first returns the name servers for &%quercite.com%&, and the second returns
6719 the name servers for &%edu%&.
6720
6721 You should be careful about how you use this lookup because, unless the
6722 top-level domain does not exist, the lookup always returns some host names. The
6723 sort of use to which this might be put is for seeing if the name servers for a
6724 given domain are on a blacklist. You can probably assume that the name servers
6725 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6726 such a list.
6727
6728 .cindex "CSA" "in &(dnsdb)& lookup"
6729 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6730 records according to the CSA rules, which are described in section
6731 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6732 not sufficient because of the extra parent domain search behaviour of CSA. The
6733 result of a successful lookup such as:
6734 .code
6735 ${lookup dnsdb {csa=$sender_helo_name}}
6736 .endd
6737 has two space-separated fields: an authorization code and a target host name.
6738 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6739 authorization required but absent, or &"?"& for unknown.
6740
6741
6742 .section "Multiple dnsdb lookups" "SECID67"
6743 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6744 However, you can specify a list of domains or IP addresses in a single
6745 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6746 the default separator, but with the ability to change this. For example:
6747 .code
6748 ${lookup dnsdb{one.domain.com:two.domain.com}}
6749 ${lookup dnsdb{a=one.host.com:two.host.com}}
6750 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6751 .endd
6752 In order to retain backwards compatibility, there is one special case: if
6753 the lookup type is PTR and no change of separator is specified, Exim looks
6754 to see if the rest of the string is precisely one IPv6 address. In this
6755 case, it does not treat it as a list.
6756
6757 The data from each lookup is concatenated, with newline separators by default,
6758 in the same way that multiple DNS records for a single item are handled. A
6759 different separator can be specified, as described above.
6760
6761 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6762 temporary DNS error for any of them, the behaviour is controlled by
6763 an optional keyword followed by a comma that may appear before the record
6764 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6765 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6766 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6767 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6768 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6769 error causes the whole lookup to defer only if none of the other lookups
6770 succeed. The default is &"lax"&, so the following lookups are equivalent:
6771 .code
6772 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6773 ${lookup dnsdb{a=one.host.com:two.host.com}}
6774 .endd
6775 Thus, in the default case, as long as at least one of the DNS lookups
6776 yields some data, the lookup succeeds.
6777
6778
6779
6780
6781 .section "More about LDAP" "SECTldap"
6782 .cindex "LDAP" "lookup, more about"
6783 .cindex "lookup" "LDAP"
6784 .cindex "Solaris" "LDAP"
6785 The original LDAP implementation came from the University of Michigan; this has
6786 become &"Open LDAP"&, and there are now two different releases. Another
6787 implementation comes from Netscape, and Solaris 7 and subsequent releases
6788 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
6789 the lookup function level, their error handling is different. For this reason
6790 it is necessary to set a compile-time variable when building Exim with LDAP, to
6791 indicate which LDAP library is in use. One of the following should appear in
6792 your &_Local/Makefile_&:
6793 .code
6794 LDAP_LIB_TYPE=UMICHIGAN
6795 LDAP_LIB_TYPE=OPENLDAP1
6796 LDAP_LIB_TYPE=OPENLDAP2
6797 LDAP_LIB_TYPE=NETSCAPE
6798 LDAP_LIB_TYPE=SOLARIS
6799 .endd
6800 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
6801 same interface as the University of Michigan version.
6802
6803 There are three LDAP lookup types in Exim. These behave slightly differently in
6804 the way they handle the results of a query:
6805
6806 .ilist
6807 &(ldap)& requires the result to contain just one entry; if there are more, it
6808 gives an error.
6809 .next
6810 &(ldapdn)& also requires the result to contain just one entry, but it is the
6811 Distinguished Name that is returned rather than any attribute values.
6812 .next
6813 &(ldapm)& permits the result to contain more than one entry; the attributes
6814 from all of them are returned.
6815 .endlist
6816
6817
6818 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
6819 Exim behaves as if the entry did not exist, and the lookup fails. The format of
6820 the data returned by a successful lookup is described in the next section.
6821 First we explain how LDAP queries are coded.
6822
6823
6824 .section "Format of LDAP queries" "SECTforldaque"
6825 .cindex "LDAP" "query format"
6826 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
6827 the configuration of a &(redirect)& router one might have this setting:
6828 .code
6829 data = ${lookup ldap \
6830   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
6831   c=UK?mailbox?base?}}
6832 .endd
6833 .cindex "LDAP" "with TLS"
6834 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
6835 secure (encrypted) LDAP connections. The second of these ensures that an
6836 encrypted TLS connection is used.
6837
6838
6839 .section "LDAP quoting" "SECID68"
6840 .cindex "LDAP" "quoting"
6841 Two levels of quoting are required in LDAP queries, the first for LDAP itself
6842 and the second because the LDAP query is represented as a URL. Furthermore,
6843 within an LDAP query, two different kinds of quoting are required. For this
6844 reason, there are two different LDAP-specific quoting operators.
6845
6846 The &%quote_ldap%& operator is designed for use on strings that are part of
6847 filter specifications. Conceptually, it first does the following conversions on
6848 the string:
6849 .code
6850 *   =>   \2A
6851 (   =>   \28
6852 )   =>   \29
6853 \   =>   \5C
6854 .endd
6855 in accordance with RFC 2254. The resulting string is then quoted according
6856 to the rules for URLs, that is, all non-alphanumeric characters except
6857 .code
6858 ! $ ' - . _ ( ) * +
6859 .endd
6860 are converted to their hex values, preceded by a percent sign. For example:
6861 .code
6862 ${quote_ldap: a(bc)*, a<yz>; }
6863 .endd
6864 yields
6865 .code
6866 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
6867 .endd
6868 Removing the URL quoting, this is (with a leading and a trailing space):
6869 .code
6870 a\28bc\29\2A, a<yz>;
6871 .endd
6872 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
6873 base DN specifications in queries. Conceptually, it first converts the string
6874 by inserting a backslash in front of any of the following characters:
6875 .code
6876 , + " \ < > ;
6877 .endd
6878 It also inserts a backslash before any leading spaces or # characters, and
6879 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
6880 is then quoted according to the rules for URLs. For example:
6881 .code
6882 ${quote_ldap_dn: a(bc)*, a<yz>; }
6883 .endd
6884 yields
6885 .code
6886 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
6887 .endd
6888 Removing the URL quoting, this is (with a trailing space):
6889 .code
6890 \ a(bc)*\, a\<yz\>\;\
6891 .endd
6892 There are some further comments about quoting in the section on LDAP
6893 authentication below.
6894
6895
6896 .section "LDAP connections" "SECID69"
6897 .cindex "LDAP" "connections"
6898 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
6899 is in use, via a Unix domain socket. The example given above does not specify
6900 an LDAP server. A server that is reached by TCP/IP can be specified in a query
6901 by starting it with
6902 .code
6903 ldap://<hostname>:<port>/...
6904 .endd
6905 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
6906 used. When no server is specified in a query, a list of default servers is
6907 taken from the &%ldap_default_servers%& configuration option. This supplies a
6908 colon-separated list of servers which are tried in turn until one successfully
6909 handles a query, or there is a serious error. Successful handling either
6910 returns the requested data, or indicates that it does not exist. Serious errors
6911 are syntactical, or multiple values when only a single value is expected.
6912 Errors which cause the next server to be tried are connection failures, bind
6913 failures, and timeouts.
6914
6915 For each server name in the list, a port number can be given. The standard way
6916 of specifying a host and port is to use a colon separator (RFC 1738). Because
6917 &%ldap_default_servers%& is a colon-separated list, such colons have to be
6918 doubled. For example
6919 .code
6920 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
6921 .endd
6922 If &%ldap_default_servers%& is unset, a URL with no server name is passed
6923 to the LDAP library with no server name, and the library's default (normally
6924 the local host) is used.
6925
6926 If you are using the OpenLDAP library, you can connect to an LDAP server using
6927 a Unix domain socket instead of a TCP/IP connection. This is specified by using
6928 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
6929 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
6930 not available.
6931
6932 For this type of connection, instead of a host name for the server, a pathname
6933 for the socket is required, and the port number is not relevant. The pathname
6934 can be specified either as an item in &%ldap_default_servers%&, or inline in
6935 the query. In the former case, you can have settings such as
6936 .code
6937 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
6938 .endd
6939 When the pathname is given in the query, you have to escape the slashes as
6940 &`%2F`& to fit in with the LDAP URL syntax. For example:
6941 .code
6942 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
6943 .endd
6944 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
6945 a pathname, it uses the Unix domain socket code, even if the query actually
6946 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
6947 socket connection. This behaviour means that you can use a setting of
6948 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
6949 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
6950 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
6951 backup host.
6952
6953 If an explicit &`ldapi`& type is given in a query when a host name is
6954 specified, an error is diagnosed. However, if there are more items in
6955 &%ldap_default_servers%&, they are tried. In other words:
6956
6957 .ilist
6958 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
6959 interface.
6960 .next
6961 Using &`ldapi`& with a host name causes an error.
6962 .endlist
6963
6964
6965 Using &`ldapi`& with no host or path in the query, and no setting of
6966 &%ldap_default_servers%&, does whatever the library does by default.
6967
6968
6969
6970 .section "LDAP authentication and control information" "SECID70"
6971 .cindex "LDAP" "authentication"
6972 The LDAP URL syntax provides no way of passing authentication and other control
6973 information to the server. To make this possible, the URL in an LDAP query may
6974 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
6975 spaces. If a value contains spaces it must be enclosed in double quotes, and
6976 when double quotes are used, backslash is interpreted in the usual way inside
6977 them. The following names are recognized:
6978 .display
6979 &`DEREFERENCE`&  set the dereferencing parameter
6980 &`NETTIME    `&  set a timeout for a network operation
6981 &`USER       `&  set the DN, for authenticating the LDAP bind
6982 &`PASS       `&  set the password, likewise
6983 &`REFERRALS  `&  set the referrals parameter
6984 &`SIZE       `&  set the limit for the number of entries returned
6985 &`TIME       `&  set the maximum waiting time for a query
6986 .endd
6987 The value of the DEREFERENCE parameter must be one of the words &"never"&,
6988 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
6989 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
6990 library from trying to follow referrals issued by the LDAP server.
6991
6992 The name CONNECT is an obsolete name for NETTIME, retained for
6993 backwards compatibility. This timeout (specified as a number of seconds) is
6994 enforced from the client end for operations that can be carried out over a
6995 network. Specifically, it applies to network connections and calls to the
6996 &'ldap_result()'& function. If the value is greater than zero, it is used if
6997 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
6998 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
6999 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7000 Netscape SDK; for OpenLDAP no action is taken.
7001
7002 The TIME parameter (also a number of seconds) is passed to the server to
7003 set a server-side limit on the time taken to complete a search.
7004
7005
7006 Here is an example of an LDAP query in an Exim lookup that uses some of these
7007 values. This is a single line, folded to fit on the page:
7008 .code
7009 ${lookup ldap
7010   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7011   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7012   {$value}fail}
7013 .endd
7014 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7015 any of the auxiliary data. Exim configuration settings that include lookups
7016 which contain password information should be preceded by &"hide"& to prevent
7017 non-admin users from using the &%-bP%& option to see their values.
7018
7019 The auxiliary data items may be given in any order. The default is no
7020 connection timeout (the system timeout is used), no user or password, no limit
7021 on the number of entries returned, and no time limit on queries.
7022
7023 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7024 removes any URL quoting that it may contain before passing it LDAP. Apparently
7025 some libraries do this for themselves, but some do not. Removing the URL
7026 quoting has two advantages:
7027
7028 .ilist
7029 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7030 DNs as with DNs inside actual queries.
7031 .next
7032 It permits spaces inside USER= DNs.
7033 .endlist
7034
7035 For example, a setting such as
7036 .code
7037 USER=cn=${quote_ldap_dn:$1}
7038 .endd
7039 should work even if &$1$& contains spaces.
7040
7041 Expanded data for the PASS= value should be quoted using the &%quote%&
7042 expansion operator, rather than the LDAP quote operators. The only reason this
7043 field needs quoting is to ensure that it conforms to the Exim syntax, which
7044 does not allow unquoted spaces. For example:
7045 .code
7046 PASS=${quote:$3}
7047 .endd
7048 The LDAP authentication mechanism can be used to check passwords as part of
7049 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7050 &<<CHAPexpand>>&.
7051
7052
7053
7054 .section "Format of data returned by LDAP" "SECID71"
7055 .cindex "LDAP" "returned data formats"
7056 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7057 as a sequence of values, for example
7058 .code
7059 cn=manager, o=University of Cambridge, c=UK
7060 .endd
7061 The &(ldap)& lookup type generates an error if more than one entry matches the
7062 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7063 the result between the data from different entries. It is possible for multiple
7064 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7065 you know that whatever values are returned all came from a single entry in the
7066 directory.
7067
7068 In the common case where you specify a single attribute in your LDAP query, the
7069 result is not quoted, and does not contain the attribute name. If the attribute
7070 has multiple values, they are separated by commas.
7071
7072 If you specify multiple attributes, the result contains space-separated, quoted
7073 strings, each preceded by the attribute name and an equals sign. Within the
7074 quotes, the quote character, backslash, and newline are escaped with
7075 backslashes, and commas are used to separate multiple values for the attribute.
7076 Apart from the escaping, the string within quotes takes the same form as the
7077 output when a single attribute is requested. Specifying no attributes is the
7078 same as specifying all of an entry's attributes.
7079
7080 Here are some examples of the output format. The first line of each pair is an
7081 LDAP query, and the second is the data that is returned. The attribute called
7082 &%attr1%& has two values, whereas &%attr2%& has only one value:
7083 .code
7084 ldap:///o=base?attr1?sub?(uid=fred)
7085 value1.1, value1.2
7086
7087 ldap:///o=base?attr2?sub?(uid=fred)
7088 value two
7089
7090 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7091 attr1="value1.1, value1.2" attr2="value two"
7092
7093 ldap:///o=base??sub?(uid=fred)
7094 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7095 .endd
7096 The &%extract%& operator in string expansions can be used to pick out
7097 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7098 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7099 results of LDAP lookups.
7100
7101
7102
7103
7104 .section "More about NIS+" "SECTnisplus"
7105 .cindex "NIS+ lookup type"
7106 .cindex "lookup" "NIS+"
7107 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7108 and field name. If this is given, the result of a successful query is the
7109 contents of the named field; otherwise the result consists of a concatenation
7110 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7111 values containing spaces are quoted. For example, the query
7112 .code
7113 [name=mg1456],passwd.org_dir
7114 .endd
7115 might return the string
7116 .code
7117 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7118 home=/home/mg1456 shell=/bin/bash shadow=""
7119 .endd
7120 (split over two lines here to fit on the page), whereas
7121 .code
7122 [name=mg1456],passwd.org_dir:gcos
7123 .endd
7124 would just return
7125 .code
7126 Martin Guerre
7127 .endd
7128 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7129 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7130 operator is to double any quote characters within the text.
7131
7132
7133
7134 .section "SQL lookups" "SECTsql"
7135 .cindex "SQL lookup types"
7136 .cindex "MySQL" "lookup type"
7137 .cindex "PostgreSQL lookup type"
7138 .cindex "lookup" "MySQL"
7139 .cindex "lookup" "PostgreSQL"
7140 .cindex "Oracle" "lookup type"
7141 .cindex "lookup" "Oracle"
7142 .cindex "InterBase lookup type"
7143 .cindex "lookup" "InterBase"
7144 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7145 databases. Queries for these databases contain SQL statements, so an example
7146 might be
7147 .code
7148 ${lookup mysql{select mailbox from users where id='userx'}\
7149   {$value}fail}
7150 .endd
7151 If the result of the query contains more than one field, the data for each
7152 field in the row is returned, preceded by its name, so the result of
7153 .code
7154 ${lookup pgsql{select home,name from users where id='userx'}\
7155   {$value}}
7156 .endd
7157 might be
7158 .code
7159 home=/home/userx name="Mister X"
7160 .endd
7161 Empty values and values containing spaces are double quoted, with embedded
7162 quotes escaped by a backslash. If the result of the query contains just one
7163 field, the value is passed back verbatim, without a field name, for example:
7164 .code
7165 Mister X
7166 .endd
7167 If the result of the query yields more than one row, it is all concatenated,
7168 with a newline between the data for each row.
7169
7170
7171 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7172 .cindex "MySQL" "lookup type"
7173 .cindex "PostgreSQL lookup type"
7174 .cindex "lookup" "MySQL"
7175 .cindex "lookup" "PostgreSQL"
7176 .cindex "Oracle" "lookup type"
7177 .cindex "lookup" "Oracle"
7178 .cindex "InterBase lookup type"
7179 .cindex "lookup" "InterBase"
7180 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7181 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7182 option (as appropriate) must be set to a colon-separated list of server
7183 information.
7184 (For MySQL and PostgreSQL only, the global option need not be set if all
7185 queries contain their own server information &-- see section
7186 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7187 items: host name, database name, user name, and password. In the case of
7188 Oracle, the host name field is used for the &"service name"&, and the database
7189 name field is not used and should be empty. For example:
7190 .code
7191 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7192 .endd
7193 Because password data is sensitive, you should always precede the setting with
7194 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7195 option. Here is an example where two MySQL servers are listed:
7196 .code
7197 hide mysql_servers = localhost/users/root/secret:\
7198                      otherhost/users/root/othersecret
7199 .endd
7200 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7201 because this is a colon-separated list, the colon has to be doubled. For each
7202 query, these parameter groups are tried in order until a connection is made and
7203 a query is successfully processed. The result of a query may be that no data is
7204 found, but that is still a successful query. In other words, the list of
7205 servers provides a backup facility, not a list of different places to look.
7206
7207 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7208 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7209 respectively, and the characters single-quote, double-quote, and backslash
7210 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7211 addition, escapes the percent and underscore characters. This cannot be done
7212 for MySQL because these escapes are not recognized in contexts where these
7213 characters are not special.
7214
7215 .section "Specifying the server in the query" "SECTspeserque"
7216 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7217 it is possible to specify a list of servers with an individual query. This is
7218 done by starting the query with
7219 .display
7220 &`servers=`&&'server1:server2:server3:...'&&`;`&
7221 .endd
7222 Each item in the list may take one of two forms:
7223 .olist
7224 If it contains no slashes it is assumed to be just a host name. The appropriate
7225 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7226 of the same name, and the remaining parameters (database, user, password) are
7227 taken from there.
7228 .next
7229 If it contains any slashes, it is taken as a complete parameter set.
7230 .endlist
7231 The list of servers is used in exactly the same way as the global list.
7232 Once a connection to a server has happened and a query has been
7233 successfully executed, processing of the lookup ceases.
7234
7235 This feature is intended for use in master/slave situations where updates
7236 are occurring and you want to update the master rather than a slave. If the
7237 master is in the list as a backup for reading, you might have a global setting
7238 like this:
7239 .code
7240 mysql_servers = slave1/db/name/pw:\
7241                 slave2/db/name/pw:\
7242                 master/db/name/pw
7243 .endd
7244 In an updating lookup, you could then write:
7245 .code
7246 ${lookup mysql{servers=master; UPDATE ...} }
7247 .endd
7248 That query would then be sent only to the master server. If, on the other hand,
7249 the master is not to be used for reading, and so is not present in the global
7250 option, you can still update it by a query of this form:
7251 .code
7252 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7253 .endd
7254
7255
7256 .section "Special MySQL features" "SECID73"
7257 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7258 causes a connection to the server on the local host by means of a Unix domain
7259 socket. An alternate socket can be specified in parentheses. The full syntax of
7260 each item in &%mysql_servers%& is:
7261 .display
7262 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7263   <&'user'&>/<&'password'&>
7264 .endd
7265 Any of the three sub-parts of the first field can be omitted. For normal use on
7266 the local host it can be left blank or set to just &"localhost"&.
7267
7268 No database need be supplied &-- but if it is absent here, it must be given in
7269 the queries.
7270
7271 If a MySQL query is issued that does not request any data (an insert, update,
7272 or delete command), the result of the lookup is the number of rows affected.
7273
7274 &*Warning*&: This can be misleading. If an update does not actually change
7275 anything (for example, setting a field to the value it already has), the result
7276 is zero because no rows are affected.
7277
7278
7279 .section "Special PostgreSQL features" "SECID74"
7280 PostgreSQL lookups can also use Unix domain socket connections to the database.
7281 This is usually faster and costs less CPU time than a TCP/IP connection.
7282 However it can be used only if the mail server runs on the same machine as the
7283 database server. A configuration line for PostgreSQL via Unix domain sockets
7284 looks like this:
7285 .code
7286 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7287 .endd
7288 In other words, instead of supplying a host name, a path to the socket is
7289 given. The path name is enclosed in parentheses so that its slashes aren't
7290 visually confused with the delimiters for the other server parameters.
7291
7292 If a PostgreSQL query is issued that does not request any data (an insert,
7293 update, or delete command), the result of the lookup is the number of rows
7294 affected.
7295
7296 .section "More about SQLite" "SECTsqlite"
7297 .cindex "lookup" "SQLite"
7298 .cindex "sqlite lookup type"
7299 SQLite is different to the other SQL lookups because a file name is required in
7300 addition to the SQL query. An SQLite database is a single file, and there is no
7301 daemon as in the other SQL databases. The interface to Exim requires the name
7302 of the file, as an absolute path, to be given at the start of the query. It is
7303 separated from the query by white space. This means that the path name cannot
7304 contain white space. Here is a lookup expansion example:
7305 .code
7306 ${lookup sqlite {/some/thing/sqlitedb \
7307   select name from aliases where id='userx';}}
7308 .endd
7309 In a list, the syntax is similar. For example:
7310 .code
7311 domainlist relay_domains = sqlite;/some/thing/sqlitedb \
7312    select * from relays where ip='$sender_host_address';
7313 .endd
7314 The only character affected by the &%quote_sqlite%& operator is a single
7315 quote, which it doubles.
7316
7317 The SQLite library handles multiple simultaneous accesses to the database
7318 internally. Multiple readers are permitted, but only one process can
7319 update at once. Attempts to access the database while it is being updated
7320 are rejected after a timeout period, during which the SQLite library
7321 waits for the lock to be released. In Exim, the default timeout is set
7322 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7323 option.
7324 .ecindex IIDfidalo1
7325 .ecindex IIDfidalo2
7326
7327
7328 . ////////////////////////////////////////////////////////////////////////////
7329 . ////////////////////////////////////////////////////////////////////////////
7330
7331 .chapter "Domain, host, address, and local part lists" &&&
7332          "CHAPdomhosaddlists" &&&
7333          "Domain, host, and address lists"
7334 .scindex IIDdohoadli "lists of domains; hosts; etc."
7335 A number of Exim configuration options contain lists of domains, hosts,
7336 email addresses, or local parts. For example, the &%hold_domains%& option
7337 contains a list of domains whose delivery is currently suspended. These lists
7338 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7339 arguments to expansion conditions such as &%match_domain%&.
7340
7341 Each item in one of these lists is a pattern to be matched against a domain,
7342 host, email address, or local part, respectively. In the sections below, the
7343 different types of pattern for each case are described, but first we cover some
7344 general facilities that apply to all four kinds of list.
7345
7346
7347
7348 .section "Expansion of lists" "SECID75"
7349 .cindex "expansion" "of lists"
7350 Each list is expanded as a single string before it is used. The result of
7351 expansion must be a list, possibly containing empty items, which is split up
7352 into separate items for matching. By default, colon is the separator character,
7353 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7354 &<<SECTempitelis>>& for details of the list syntax; the second of these
7355 discusses the way to specify empty list items.
7356
7357
7358 If the string expansion is forced to fail, Exim behaves as if the item it is
7359 testing (domain, host, address, or local part) is not in the list. Other
7360 expansion failures cause temporary errors.
7361
7362 If an item in a list is a regular expression, backslashes, dollars and possibly
7363 other special characters in the expression must be protected against
7364 misinterpretation by the string expander. The easiest way to do this is to use
7365 the &`\N`& expansion feature to indicate that the contents of the regular
7366 expression should not be expanded. For example, in an ACL you might have:
7367 .code
7368 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7369                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7370 .endd
7371 The first item is a regular expression that is protected from expansion by
7372 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7373 senders based on the receiving domain.
7374
7375
7376
7377
7378 .section "Negated items in lists" "SECID76"
7379 .cindex "list" "negation"
7380 .cindex "negation" "in lists"
7381 Items in a list may be positive or negative. Negative items are indicated by a
7382 leading exclamation mark, which may be followed by optional white space. A list
7383 defines a set of items (domains, etc). When Exim processes one of these lists,
7384 it is trying to find out whether a domain, host, address, or local part
7385 (respectively) is in the set that is defined by the list. It works like this:
7386
7387 The list is scanned from left to right. If a positive item is matched, the
7388 subject that is being checked is in the set; if a negative item is matched, the
7389 subject is not in the set. If the end of the list is reached without the
7390 subject having matched any of the patterns, it is in the set if the last item
7391 was a negative one, but not if it was a positive one. For example, the list in
7392 .code
7393 domainlist relay_domains = !a.b.c : *.b.c
7394 .endd
7395 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7396 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7397 list is positive. However, if the setting were
7398 .code
7399 domainlist relay_domains = !a.b.c
7400 .endd
7401 then all domains other than &'a.b.c'& would match because the last item in the
7402 list is negative. In other words, a list that ends with a negative item behaves
7403 as if it had an extra item &`:*`& on the end.
7404
7405 Another way of thinking about positive and negative items in lists is to read
7406 the connector as &"or"& after a positive item and as &"and"& after a negative
7407 item.
7408
7409
7410
7411 .section "File names in lists" "SECTfilnamlis"
7412 .cindex "list" "file name in"
7413 If an item in a domain, host, address, or local part list is an absolute file
7414 name (beginning with a slash character), each line of the file is read and
7415 processed as if it were an independent item in the list, except that further
7416 file names are not allowed,
7417 and no expansion of the data from the file takes place.
7418 Empty lines in the file are ignored, and the file may also contain comment
7419 lines:
7420
7421 .ilist
7422 For domain and host lists, if a # character appears anywhere in a line of the
7423 file, it and all following characters are ignored.
7424 .next
7425 Because local parts may legitimately contain # characters, a comment in an
7426 address list or local part list file is recognized only if # is preceded by
7427 white space or the start of the line. For example:
7428 .code
7429 not#comment@x.y.z   # but this is a comment
7430 .endd
7431 .endlist
7432
7433 Putting a file name in a list has the same effect as inserting each line of the
7434 file as an item in the list (blank lines and comments excepted). However, there
7435 is one important difference: the file is read each time the list is processed,
7436 so if its contents vary over time, Exim's behaviour changes.
7437
7438 If a file name is preceded by an exclamation mark, the sense of any match
7439 within the file is inverted. For example, if
7440 .code
7441 hold_domains = !/etc/nohold-domains
7442 .endd
7443 and the file contains the lines
7444 .code
7445 !a.b.c
7446 *.b.c
7447 .endd
7448 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7449 any domain matching &`*.b.c`& is not.
7450
7451
7452
7453 .section "An lsearch file is not an out-of-line list" "SECID77"
7454 As will be described in the sections that follow, lookups can be used in lists
7455 to provide indexed methods of checking list membership. There has been some
7456 confusion about the way &(lsearch)& lookups work in lists. Because
7457 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7458 sometimes thought that it is allowed to contain wild cards and other kinds of
7459 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7460 always fixed strings, just as for any other single-key lookup type.
7461
7462 If you want to use a file to contain wild-card patterns that form part of a
7463 list, just give the file name on its own, without a search type, as described
7464 in the previous section. You could also use the &(wildlsearch)& or
7465 &(nwildlsearch)&, but there is no advantage in doing this.
7466
7467
7468
7469
7470 .section "Named lists" "SECTnamedlists"
7471 .cindex "named lists"
7472 .cindex "list" "named"
7473 A list of domains, hosts, email addresses, or local parts can be given a name
7474 which is then used to refer to the list elsewhere in the configuration. This is
7475 particularly convenient if the same list is required in several different
7476 places. It also allows lists to be given meaningful names, which can improve
7477 the readability of the configuration. For example, it is conventional to define
7478 a domain list called &'local_domains'& for all the domains that are handled
7479 locally on a host, using a configuration line such as
7480 .code
7481 domainlist local_domains = localhost:my.dom.example
7482 .endd
7483 Named lists are referenced by giving their name preceded by a plus sign, so,
7484 for example, a router that is intended to handle local domains would be
7485 configured with the line
7486 .code
7487 domains = +local_domains
7488 .endd
7489 The first router in a configuration is often one that handles all domains
7490 except the local ones, using a configuration with a negated item like this:
7491 .code
7492 dnslookup:
7493   driver = dnslookup
7494   domains = ! +local_domains
7495   transport = remote_smtp
7496   no_more
7497 .endd
7498 The four kinds of named list are created by configuration lines starting with
7499 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7500 respectively. Then there follows the name that you are defining, followed by an
7501 equals sign and the list itself. For example:
7502 .code
7503 hostlist    relay_hosts = 192.168.23.0/24 : my.friend.example
7504 addresslist bad_senders = cdb;/etc/badsenders
7505 .endd
7506 A named list may refer to other named lists:
7507 .code
7508 domainlist  dom1 = first.example : second.example
7509 domainlist  dom2 = +dom1 : third.example
7510 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7511 .endd
7512 &*Warning*&: If the last item in a referenced list is a negative one, the
7513 effect may not be what you intended, because the negation does not propagate
7514 out to the higher level. For example, consider:
7515 .code
7516 domainlist  dom1 = !a.b
7517 domainlist  dom2 = +dom1 : *.b
7518 .endd
7519 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7520 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7521 means it matches the second list as well. The effect is not the same as
7522 .code
7523 domainlist  dom2 = !a.b : *.b
7524 .endd
7525 where &'x.y'& does not match. It's best to avoid negation altogether in
7526 referenced lists if you can.
7527
7528 Named lists may have a performance advantage. When Exim is routing an
7529 address or checking an incoming message, it caches the result of tests on named
7530 lists. So, if you have a setting such as
7531 .code
7532 domains = +local_domains
7533 .endd
7534 on several of your routers
7535 or in several ACL statements,
7536 the actual test is done only for the first one. However, the caching works only
7537 if there are no expansions within the list itself or any sublists that it
7538 references. In other words, caching happens only for lists that are known to be
7539 the same each time they are referenced.
7540
7541 By default, there may be up to 16 named lists of each type. This limit can be
7542 extended by changing a compile-time variable. The use of domain and host lists
7543 is recommended for concepts such as local domains, relay domains, and relay
7544 hosts. The default configuration is set up like this.
7545
7546
7547
7548 .section "Named lists compared with macros" "SECID78"
7549 .cindex "list" "named compared with macro"
7550 .cindex "macro" "compared with named list"
7551 At first sight, named lists might seem to be no different from macros in the
7552 configuration file. However, macros are just textual substitutions. If you
7553 write
7554 .code
7555 ALIST = host1 : host2
7556 auth_advertise_hosts = !ALIST
7557 .endd
7558 it probably won't do what you want, because that is exactly the same as
7559 .code
7560 auth_advertise_hosts = !host1 : host2
7561 .endd
7562 Notice that the second host name is not negated. However, if you use a host
7563 list, and write
7564 .code
7565 hostlist alist = host1 : host2
7566 auth_advertise_hosts = ! +alist
7567 .endd
7568 the negation applies to the whole list, and so that is equivalent to
7569 .code
7570 auth_advertise_hosts = !host1 : !host2
7571 .endd
7572
7573
7574 .section "Named list caching" "SECID79"
7575 .cindex "list" "caching of named"
7576 .cindex "caching" "named lists"
7577 While processing a message, Exim caches the result of checking a named list if
7578 it is sure that the list is the same each time. In practice, this means that
7579 the cache operates only if the list contains no $ characters, which guarantees
7580 that it will not change when it is expanded. Sometimes, however, you may have
7581 an expanded list that you know will be the same each time within a given
7582 message. For example:
7583 .code
7584 domainlist special_domains = \
7585            ${lookup{$sender_host_address}cdb{/some/file}}
7586 .endd
7587 This provides a list of domains that depends only on the sending host's IP
7588 address. If this domain list is referenced a number of times (for example,
7589 in several ACL lines, or in several routers) the result of the check is not
7590 cached by default, because Exim does not know that it is going to be the
7591 same list each time.
7592
7593 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7594 cache the result anyway. For example:
7595 .code
7596 domainlist_cache special_domains = ${lookup{...
7597 .endd
7598 If you do this, you should be absolutely sure that caching is going to do
7599 the right thing in all cases. When in doubt, leave it out.
7600
7601
7602
7603 .section "Domain lists" "SECTdomainlist"
7604 .cindex "domain list" "patterns for"
7605 .cindex "list" "domain list"
7606 Domain lists contain patterns that are to be matched against a mail domain.
7607 The following types of item may appear in domain lists:
7608
7609 .ilist
7610 .cindex "primary host name"
7611 .cindex "host name" "matched in domain list"
7612 .oindex "&%primary_hostname%&"
7613 .cindex "domain list" "matching primary host name"
7614 .cindex "@ in a domain list"
7615 If a pattern consists of a single @ character, it matches the local host name,
7616 as set by the &%primary_hostname%& option (or defaulted). This makes it
7617 possible to use the same configuration file on several different hosts that
7618 differ only in their names.
7619 .next
7620 .cindex "@[] in a domain list"
7621 .cindex "domain list" "matching local IP interfaces"
7622 .cindex "domain literal"
7623 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7624 in square brackets (as in an email address that contains a domain literal), but
7625 only if that IP address is recognized as local for email routing purposes. The
7626 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7627 control which of a host's several IP addresses are treated as local.
7628 In today's Internet, the use of domain literals is controversial.
7629 .next
7630 .cindex "@mx_any"
7631 .cindex "@mx_primary"
7632 .cindex "@mx_secondary"
7633 .cindex "domain list" "matching MX pointers to local host"
7634 If a pattern consists of the string &`@mx_any`& it matches any domain that
7635 has an MX record pointing to the local host or to any host that is listed in
7636 .oindex "&%hosts_treat_as_local%&"
7637 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7638 are similar, except that the first matches only when a primary MX target is the
7639 local host, and the second only when no primary MX target is the local host,
7640 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7641 preference value &-- there may of course be more than one of them.
7642
7643 The MX lookup that takes place when matching a pattern of this type is
7644 performed with the resolver options for widening names turned off. Thus, for
7645 example, a single-component domain will &'not'& be expanded by adding the
7646 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7647 options of the &(dnslookup)& router for a discussion of domain widening.
7648
7649 Sometimes you may want to ignore certain IP addresses when using one of these
7650 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7651 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7652 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7653 on a router). For example:
7654 .code
7655 domains = @mx_any/ignore=127.0.0.1
7656 .endd
7657 This example matches any domain that has an MX record pointing to one of
7658 the local host's IP addresses other than 127.0.0.1.
7659
7660 The list of IP addresses is in fact processed by the same code that processes
7661 host lists, so it may contain CIDR-coded network specifications and it may also
7662 contain negative items.
7663
7664 Because the list of IP addresses is a sublist within a domain list, you have to
7665 be careful about delimiters if there is more than one address. Like any other
7666 list, the default delimiter can be changed. Thus, you might have:
7667 .code
7668 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7669           an.other.domain : ...
7670 .endd
7671 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7672 involved, it is easiest to change the delimiter for the main list as well:
7673 .code
7674 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7675           an.other.domain ? ...
7676 .endd
7677 .next
7678 .cindex "asterisk" "in domain list"
7679 .cindex "domain list" "asterisk in"
7680 .cindex "domain list" "matching &""ends with""&"
7681 If a pattern starts with an asterisk, the remaining characters of the pattern
7682 are compared with the terminating characters of the domain. The use of &"*"& in
7683 domain lists differs from its use in partial matching lookups. In a domain
7684 list, the character following the asterisk need not be a dot, whereas partial
7685 matching works only in terms of dot-separated components. For example, a domain
7686 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7687 &'cipher.key.ex'&.
7688
7689 .next
7690 .cindex "regular expressions" "in domain list"
7691 .cindex "domain list" "matching regular expression"
7692 If a pattern starts with a circumflex character, it is treated as a regular
7693 expression, and matched against the domain using a regular expression matching
7694 function. The circumflex is treated as part of the regular expression.
7695 Email domains are case-independent, so this regular expression match is by
7696 default case-independent, but you can make it case-dependent by starting it
7697 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7698 are given in chapter &<<CHAPregexp>>&.
7699
7700 &*Warning*&: Because domain lists are expanded before being processed, you
7701 must escape any backslash and dollar characters in the regular expression, or
7702 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7703 it is not to be expanded (unless you really do want to build a regular
7704 expression by expansion, of course).
7705 .next
7706 .cindex "lookup" "in domain list"
7707 .cindex "domain list" "matching by lookup"
7708 If a pattern starts with the name of a single-key lookup type followed by a
7709 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7710 must be a file name in a suitable format for the lookup type. For example, for
7711 &"cdb;"& it must be an absolute path:
7712 .code
7713 domains = cdb;/etc/mail/local_domains.cdb
7714 .endd
7715 The appropriate type of lookup is done on the file using the domain name as the
7716 key. In most cases, the data that is looked up is not used; Exim is interested
7717 only in whether or not the key is present in the file. However, when a lookup
7718 is used for the &%domains%& option on a router
7719 or a &%domains%& condition in an ACL statement, the data is preserved in the
7720 &$domain_data$& variable and can be referred to in other router options or
7721 other statements in the same ACL.
7722
7723 .next
7724 Any of the single-key lookup type names may be preceded by
7725 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7726 .code
7727 domains = partial-dbm;/partial/domains
7728 .endd
7729 This causes partial matching logic to be invoked; a description of how this
7730 works is given in section &<<SECTpartiallookup>>&.
7731
7732 .next
7733 .cindex "asterisk" "in lookup type"
7734 Any of the single-key lookup types may be followed by an asterisk. This causes
7735 a default lookup for a key consisting of a single asterisk to be done if the
7736 original lookup fails. This is not a useful feature when using a domain list to
7737 select particular domains (because any domain would match), but it might have
7738 value if the result of the lookup is being used via the &$domain_data$&
7739 expansion variable.
7740 .next
7741 If the pattern starts with the name of a query-style lookup type followed by a
7742 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7743 pattern must be an appropriate query for the lookup type, as described in
7744 chapter &<<CHAPfdlookup>>&. For example:
7745 .code
7746 hold_domains = mysql;select domain from holdlist \
7747   where domain = '$domain';
7748 .endd
7749 In most cases, the data that is looked up is not used (so for an SQL query, for
7750 example, it doesn't matter what field you select). Exim is interested only in
7751 whether or not the query succeeds. However, when a lookup is used for the
7752 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7753 variable and can be referred to in other options.
7754 .next
7755 .cindex "domain list" "matching literal domain name"
7756 If none of the above cases apply, a caseless textual comparison is made
7757 between the pattern and the domain.
7758 .endlist
7759
7760 Here is an example that uses several different kinds of pattern:
7761 .code
7762 domainlist funny_domains = \
7763   @ : \
7764   lib.unseen.edu : \
7765   *.foundation.fict.example : \
7766   \N^[1-2]\d{3}\.fict\.example$\N : \
7767   partial-dbm;/opt/data/penguin/book : \
7768   nis;domains.byname : \
7769   nisplus;[name=$domain,status=local],domains.org_dir
7770 .endd
7771 There are obvious processing trade-offs among the various matching modes. Using
7772 an asterisk is faster than a regular expression, and listing a few names
7773 explicitly probably is too. The use of a file or database lookup is expensive,
7774 but may be the only option if hundreds of names are required. Because the
7775 patterns are tested in order, it makes sense to put the most commonly matched
7776 patterns earlier.
7777
7778
7779
7780 .section "Host lists" "SECThostlist"
7781 .cindex "host list" "patterns in"
7782 .cindex "list" "host list"
7783 Host lists are used to control what remote hosts are allowed to do. For
7784 example, some hosts may be allowed to use the local host as a relay, and some
7785 may be permitted to use the SMTP ETRN command. Hosts can be identified in
7786 two different ways, by name or by IP address. In a host list, some types of
7787 pattern are matched to a host name, and some are matched to an IP address.
7788 You need to be particularly careful with this when single-key lookups are
7789 involved, to ensure that the right value is being used as the key.
7790
7791
7792 .section "Special host list patterns" "SECID80"
7793 .cindex "empty item in hosts list"
7794 .cindex "host list" "empty string in"
7795 If a host list item is the empty string, it matches only when no remote host is
7796 involved. This is the case when a message is being received from a local
7797 process using SMTP on the standard input, that is, when a TCP/IP connection is
7798 not used.
7799
7800 .cindex "asterisk" "in host list"
7801 The special pattern &"*"& in a host list matches any host or no host. Neither
7802 the IP address nor the name is actually inspected.
7803
7804
7805
7806 .section "Host list patterns that match by IP address" "SECThoslispatip"
7807 .cindex "host list" "matching IP addresses"
7808 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
7809 the incoming address actually appears in the IPv6 host as
7810 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
7811 list, it is converted into a traditional IPv4 address first. (Not all operating
7812 systems accept IPv4 calls on IPv6 sockets, as there have been some security
7813 concerns.)
7814
7815 The following types of pattern in a host list check the remote host by
7816 inspecting its IP address:
7817
7818 .ilist
7819 If the pattern is a plain domain name (not a regular expression, not starting
7820 with *, not a lookup of any kind), Exim calls the operating system function
7821 to find the associated IP address(es). Exim uses the newer
7822 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
7823 This typically causes a forward DNS lookup of the name. The result is compared
7824 with the IP address of the subject host.
7825
7826 If there is a temporary problem (such as a DNS timeout) with the host name
7827 lookup, a temporary error occurs. For example, if the list is being used in an
7828 ACL condition, the ACL gives a &"defer"& response, usually leading to a
7829 temporary SMTP error code. If no IP address can be found for the host name,
7830 what happens is described in section &<<SECTbehipnot>>& below.
7831
7832 .next
7833 .cindex "@ in a host list"
7834 If the pattern is &"@"&, the primary host name is substituted and used as a
7835 domain name, as just described.
7836
7837 .next
7838 If the pattern is an IP address, it is matched against the IP address of the
7839 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
7840 IPv6 addresses can be given in colon-separated format, but the colons have to
7841 be doubled so as not to be taken as item separators when the default list
7842 separator is used. IPv6 addresses are recognized even when Exim is compiled
7843 without IPv6 support. This means that if they appear in a host list on an
7844 IPv4-only host, Exim will not treat them as host names. They are just addresses
7845 that can never match a client host.
7846
7847 .next
7848 .cindex "@[] in a host list"
7849 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
7850 the local host. For example, if the local host is an IPv4 host with one
7851 interface address 10.45.23.56, these two ACL statements have the same effect:
7852 .code
7853 accept hosts = 127.0.0.1 : 10.45.23.56
7854 accept hosts = @[]
7855 .endd
7856 .next
7857 .cindex "CIDR notation"
7858 If the pattern is an IP address followed by a slash and a mask length (for
7859 example 10.11.42.0/24), it is matched against the IP address of the subject
7860 host under the given mask. This allows, an entire network of hosts to be
7861 included (or excluded) by a single item. The mask uses CIDR notation; it
7862 specifies the number of address bits that must match, starting from the most
7863 significant end of the address.
7864
7865 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
7866 of a range of addresses. It is the number of bits in the network portion of the
7867 address. The above example specifies a 24-bit netmask, so it matches all 256
7868 addresses in the 10.11.42.0 network. An item such as
7869 .code
7870 192.168.23.236/31
7871 .endd
7872 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
7873 32 for an IPv4 address is the same as no mask at all; just a single address
7874 matches.
7875
7876 Here is another example which shows an IPv4 and an IPv6 network:
7877 .code
7878 recipient_unqualified_hosts = 192.168.0.0/16: \
7879                               3ffe::ffff::836f::::/48
7880 .endd
7881 The doubling of list separator characters applies only when these items
7882 appear inline in a host list. It is not required when indirecting via a file.
7883 For example:
7884 .code
7885 recipient_unqualified_hosts = /opt/exim/unqualnets
7886 .endd
7887 could make use of a file containing
7888 .code
7889 172.16.0.0/12
7890 3ffe:ffff:836f::/48
7891 .endd
7892 to have exactly the same effect as the previous example. When listing IPv6
7893 addresses inline, it is usually more convenient to use the facility for
7894 changing separator characters. This list contains the same two networks:
7895 .code
7896 recipient_unqualified_hosts = <; 172.16.0.0/12; \
7897                                  3ffe:ffff:836f::/48
7898 .endd
7899 The separator is changed to semicolon by the leading &"<;"& at the start of the
7900 list.
7901 .endlist
7902
7903
7904
7905 .section "Host list patterns for single-key lookups by host address" &&&
7906          "SECThoslispatsikey"
7907 .cindex "host list" "lookup of IP address"
7908 When a host is to be identified by a single-key lookup of its complete IP
7909 address, the pattern takes this form:
7910 .display
7911 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
7912 .endd
7913 For example:
7914 .code
7915 hosts_lookup = net-cdb;/hosts-by-ip.db
7916 .endd
7917 The text form of the IP address of the subject host is used as the lookup key.
7918 IPv6 addresses are converted to an unabbreviated form, using lower case
7919 letters, with dots as separators because colon is the key terminator in
7920 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
7921 quoting the keys, but this is a facility that was added later.] The data
7922 returned by the lookup is not used.
7923
7924 .cindex "IP address" "masking"
7925 .cindex "host list" "masked IP address"
7926 Single-key lookups can also be performed using masked IP addresses, using
7927 patterns of this form:
7928 .display
7929 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
7930 .endd
7931 For example:
7932 .code
7933 net24-dbm;/networks.db
7934 .endd
7935 The IP address of the subject host is masked using <&'number'&> as the mask
7936 length. A textual string is constructed from the masked value, followed by the
7937 mask, and this is used as the lookup key. For example, if the host's IP address
7938 is 192.168.34.6, the key that is looked up for the above example is
7939 &"192.168.34.0/24"&.
7940
7941 When an IPv6 address is converted to a string, dots are normally used instead
7942 of colons, so that keys in &(lsearch)& files need not contain colons (which
7943 terminate &(lsearch)& keys). This was implemented some time before the ability
7944 to quote keys was made available in &(lsearch)& files. However, the more
7945 recently implemented &(iplsearch)& files do require colons in IPv6 keys
7946 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
7947 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
7948 converted using colons and not dots. In all cases, full, unabbreviated IPv6
7949 addresses are always used.
7950
7951 Ideally, it would be nice to tidy up this anomalous situation by changing to
7952 colons in all cases, given that quoting is now available for &(lsearch)&.
7953 However, this would be an incompatible change that might break some existing
7954 configurations.
7955
7956 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
7957 IPv6 address) is not the same as specifying just &%net-%& without a number. In
7958 the former case the key strings include the mask value, whereas in the latter
7959 case the IP address is used on its own.
7960
7961
7962
7963 .section "Host list patterns that match by host name" "SECThoslispatnam"
7964 .cindex "host" "lookup failures"
7965 .cindex "unknown host name"
7966 .cindex "host list" "matching host name"
7967 There are several types of pattern that require Exim to know the name of the
7968 remote host. These are either wildcard patterns or lookups by name. (If a
7969 complete hostname is given without any wildcarding, it is used to find an IP
7970 address to match against, as described in the section &<<SECThoslispatip>>&
7971 above.)
7972
7973 If the remote host name is not already known when Exim encounters one of these
7974 patterns, it has to be found from the IP address.
7975 Although many sites on the Internet are conscientious about maintaining reverse
7976 DNS data for their hosts, there are also many that do not do this.
7977 Consequently, a name cannot always be found, and this may lead to unwanted
7978 effects. Take care when configuring host lists with wildcarded name patterns.
7979 Consider what will happen if a name cannot be found.
7980
7981 Because of the problems of determining host names from IP addresses, matching
7982 against host names is not as common as matching against IP addresses.
7983
7984 By default, in order to find a host name, Exim first does a reverse DNS lookup;
7985 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
7986 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
7987 are done can be changed by setting the &%host_lookup_order%& option. For
7988 security, once Exim has found one or more names, it looks up the IP addresses
7989 for these names and compares them with the IP address that it started with.
7990 Only those names whose IP addresses match are accepted. Any other names are
7991 discarded. If no names are left, Exim behaves as if the host name cannot be
7992 found. In the most common case there is only one name and one IP address.
7993
7994 There are some options that control what happens if a host name cannot be
7995 found. These are described in section &<<SECTbehipnot>>& below.
7996
7997 .cindex "host" "alias for"
7998 .cindex "alias for host"
7999 As a result of aliasing, hosts may have more than one name. When processing any
8000 of the following types of pattern, all the host's names are checked:
8001
8002 .ilist
8003 .cindex "asterisk" "in host list"
8004 If a pattern starts with &"*"& the remainder of the item must match the end of
8005 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8006 &'.b.c'&. This special simple form is provided because this is a very common
8007 requirement. Other kinds of wildcarding require the use of a regular
8008 expression.
8009 .next
8010 .cindex "regular expressions" "in host list"
8011 .cindex "host list" "regular expression in"
8012 If the item starts with &"^"& it is taken to be a regular expression which is
8013 matched against the host name. Host names are case-independent, so this regular
8014 expression match is by default case-independent, but you can make it
8015 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8016 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8017 example,
8018 .code
8019 ^(a|b)\.c\.d$
8020 .endd
8021 is a regular expression that matches either of the two hosts &'a.c.d'& or
8022 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8023 that backslash and dollar characters are not misinterpreted as part of the
8024 string expansion. The simplest way to do this is to use &`\N`& to mark that
8025 part of the string as non-expandable. For example:
8026 .code
8027 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8028 .endd
8029 &*Warning*&: If you want to match a complete host name, you must include the
8030 &`$`& terminating metacharacter in the regular expression, as in the above
8031 example. Without it, a match at the start of the host name is all that is
8032 required.
8033 .endlist
8034
8035
8036
8037
8038 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8039 .cindex "host" "lookup failures, permanent"
8040 While processing a host list, Exim may need to look up an IP address from a
8041 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8042 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8043 behaviour when it fails to find the information it is seeking is the same.
8044
8045 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8046 apply to temporary DNS errors, whose handling is described in the next section.
8047
8048 .cindex "&`+include_unknown`&"
8049 .cindex "&`+ignore_unknown`&"
8050 By default, Exim behaves as if the host does not match the list. This may not
8051 always be what you want to happen. To change Exim's behaviour, the special
8052 items &`+include_unknown`& or &`+ignore_unknown`& may appear in the list (at
8053 top level &-- they are not recognized in an indirected file).
8054
8055 .ilist
8056 If any item that follows &`+include_unknown`& requires information that
8057 cannot found, Exim behaves as if the host does match the list. For example,
8058 .code
8059 host_reject_connection = +include_unknown:*.enemy.ex
8060 .endd
8061 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8062 any hosts whose name it cannot find.
8063
8064 .next
8065 If any item that follows &`+ignore_unknown`& requires information that cannot
8066 be found, Exim ignores that item and proceeds to the rest of the list. For
8067 example:
8068 .code
8069 accept hosts = +ignore_unknown : friend.example : \
8070                192.168.4.5
8071 .endd
8072 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8073 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8074 name can be found for 192.168.4.5, it is rejected.
8075 .endlist
8076
8077 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8078 list. The effect of each one lasts until the next, or until the end of the
8079 list.
8080
8081
8082 .section "Temporary DNS errors when looking up host information" &&&
8083          "SECTtemdnserr"
8084 .cindex "host" "lookup failures, temporary"
8085 .cindex "&`+include_defer`&"
8086 .cindex "&`+ignore_defer`&"
8087 A temporary DNS lookup failure normally causes a defer action (except when
8088 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8089 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8090 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8091 section. These options should be used with care, probably only in non-critical
8092 host lists such as whitelists.
8093
8094
8095
8096 .section "Host list patterns for single-key lookups by host name" &&&
8097          "SECThoslispatnamsk"
8098 .cindex "unknown host name"
8099 .cindex "host list" "matching host name"
8100 If a pattern is of the form
8101 .display
8102 <&'single-key-search-type'&>;<&'search-data'&>
8103 .endd
8104 for example
8105 .code
8106 dbm;/host/accept/list
8107 .endd
8108 a single-key lookup is performed, using the host name as its key. If the
8109 lookup succeeds, the host matches the item. The actual data that is looked up
8110 is not used.
8111
8112 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8113 keys in the file, not IP addresses. If you want to do lookups based on IP
8114 addresses, you must precede the search type with &"net-"& (see section
8115 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8116 two items in the same list, one doing an address lookup and one doing a name
8117 lookup, both using the same file.
8118
8119
8120
8121 .section "Host list patterns for query-style lookups" "SECID81"
8122 If a pattern is of the form
8123 .display
8124 <&'query-style-search-type'&>;<&'query'&>
8125 .endd
8126 the query is obeyed, and if it succeeds, the host matches the item. The actual
8127 data that is looked up is not used. The variables &$sender_host_address$& and
8128 &$sender_host_name$& can be used in the query. For example:
8129 .code
8130 hosts_lookup = pgsql;\
8131   select ip from hostlist where ip='$sender_host_address'
8132 .endd
8133 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8134 can use the &%sg%& expansion item to change this if you need to. If you want to
8135 use masked IP addresses in database queries, you can use the &%mask%& expansion
8136 operator.
8137
8138 If the query contains a reference to &$sender_host_name$&, Exim automatically
8139 looks up the host name if has not already done so. (See section
8140 &<<SECThoslispatnam>>& for comments on finding host names.)
8141
8142 Historical note: prior to release 4.30, Exim would always attempt to find a
8143 host name before running the query, unless the search type was preceded by
8144 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8145 still recognized for query-style lookups, but its presence or absence has no
8146 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8147 See section &<<SECThoslispatsikey>>&.)
8148
8149
8150
8151 .section "Mixing wildcarded host names and addresses in host lists" &&&
8152          "SECTmixwilhos"
8153 .cindex "host list" "mixing names and addresses in"
8154 If you have name lookups or wildcarded host names and IP addresses in the same
8155 host list, you should normally put the IP addresses first. For example, in an
8156 ACL you could have:
8157 .code
8158 accept hosts = 10.9.8.7 : *.friend.example
8159 .endd
8160 The reason for this lies in the left-to-right way that Exim processes lists.
8161 It can test IP addresses without doing any DNS lookups, but when it reaches an
8162 item that requires a host name, it fails if it cannot find a host name to
8163 compare with the pattern. If the above list is given in the opposite order, the
8164 &%accept%& statement fails for a host whose name cannot be found, even if its
8165 IP address is 10.9.8.7.
8166
8167 If you really do want to do the name check first, and still recognize the IP
8168 address, you can rewrite the ACL like this:
8169 .code
8170 accept hosts = *.friend.example
8171 accept hosts = 10.9.8.7
8172 .endd
8173 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8174 &<<CHAPACL>>& for details of ACLs.
8175
8176
8177
8178
8179
8180 .section "Address lists" "SECTaddresslist"
8181 .cindex "list" "address list"
8182 .cindex "address list" "empty item"
8183 .cindex "address list" "patterns"
8184 Address lists contain patterns that are matched against mail addresses. There
8185 is one special case to be considered: the sender address of a bounce message is
8186 always empty. You can test for this by providing an empty item in an address
8187 list. For example, you can set up a router to process bounce messages by
8188 using this option setting:
8189 .code
8190 senders = :
8191 .endd
8192 The presence of the colon creates an empty item. If you do not provide any
8193 data, the list is empty and matches nothing. The empty sender can also be
8194 detected by a regular expression that matches an empty string,
8195 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8196
8197 Non-empty items in an address list can be straightforward email addresses. For
8198 example:
8199 .code
8200 senders = jbc@askone.example : hs@anacreon.example
8201 .endd
8202 A certain amount of wildcarding is permitted. If a pattern contains an @
8203 character, but is not a regular expression and does not begin with a
8204 semicolon-terminated lookup type (described below), the local part of the
8205 subject address is compared with the local part of the pattern, which may start
8206 with an asterisk. If the local parts match, the domain is checked in exactly
8207 the same way as for a pattern in a domain list. For example, the domain can be
8208 wildcarded, refer to a named list, or be a lookup:
8209 .code
8210 deny senders = *@*.spamming.site:\
8211                *@+hostile_domains:\
8212                bozo@partial-lsearch;/list/of/dodgy/sites:\
8213                *@dbm;/bad/domains.db
8214 .endd
8215 .cindex "local part" "starting with !"
8216 .cindex "address list" "local part starting with !"
8217 If a local part that begins with an exclamation mark is required, it has to be
8218 specified using a regular expression, because otherwise the exclamation mark is
8219 treated as a sign of negation, as is standard in lists.
8220
8221 If a non-empty pattern that is not a regular expression or a lookup does not
8222 contain an @ character, it is matched against the domain part of the subject
8223 address. The only two formats that are recognized this way are a literal
8224 domain, or a domain pattern that starts with *. In both these cases, the effect
8225 is the same as if &`*@`& preceded the pattern. For example:
8226 .code
8227 deny senders = enemy.domain : *.enemy.domain
8228 .endd
8229
8230 The following kinds of more complicated address list pattern can match any
8231 address, including the empty address that is characteristic of bounce message
8232 senders:
8233
8234 .ilist
8235 .cindex "regular expressions" "in address list"
8236 .cindex "address list" "regular expression in"
8237 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8238 done against the complete address, with the pattern as the regular expression.
8239 You must take care that backslash and dollar characters are not misinterpreted
8240 as part of the string expansion. The simplest way to do this is to use &`\N`&
8241 to mark that part of the string as non-expandable. For example:
8242 .code
8243 deny senders = \N^.*this.*@example\.com$\N : \
8244                \N^\d{8}.+@spamhaus.example$\N : ...
8245 .endd
8246 The &`\N`& sequences are removed by the expansion, so these items do indeed
8247 start with &"^"& by the time they are being interpreted as address patterns.
8248
8249 .next
8250 .cindex "address list" "lookup for complete address"
8251 Complete addresses can be looked up by using a pattern that starts with a
8252 lookup type terminated by a semicolon, followed by the data for the lookup. For
8253 example:
8254 .code
8255 deny senders = cdb;/etc/blocked.senders : \
8256   mysql;select address from blocked where \
8257   address='${quote_mysql:$sender_address}'
8258 .endd
8259 Both query-style and single-key lookup types can be used. For a single-key
8260 lookup type, Exim uses the complete address as the key. However, empty keys are
8261 not supported for single-key lookups, so a match against the empty address
8262 always fails. This restriction does not apply to query-style lookups.
8263
8264 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8265 cannot be used, and is ignored if specified, with an entry being written to the
8266 panic log.
8267 .cindex "*@ with single-key lookup"
8268 However, you can configure lookup defaults, as described in section
8269 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8270 default. For example, with this lookup:
8271 .code
8272 accept senders = lsearch*@;/some/file
8273 .endd
8274 the file could contains lines like this:
8275 .code
8276 user1@domain1.example
8277 *@domain2.example
8278 .endd
8279 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8280 that are tried is:
8281 .code
8282 nimrod@jaeger.example
8283 *@jaeger.example
8284 *
8285 .endd
8286 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8287 would mean that every address matches, thus rendering the test useless.
8288
8289 &*Warning 2*&: Do not confuse these two kinds of item:
8290 .code
8291 deny recipients = dbm*@;/some/file
8292 deny recipients = *@dbm;/some/file
8293 .endd
8294 The first does a whole address lookup, with defaulting, as just described,
8295 because it starts with a lookup type. The second matches the local part and
8296 domain independently, as described in a bullet point below.
8297 .endlist
8298
8299
8300 The following kinds of address list pattern can match only non-empty addresses.
8301 If the subject address is empty, a match against any of these pattern types
8302 always fails.
8303
8304
8305 .ilist
8306 .cindex "@@ with single-key lookup"
8307 .cindex "address list" "@@ lookup type"
8308 .cindex "address list" "split local part and domain"
8309 If a pattern starts with &"@@"& followed by a single-key lookup item
8310 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8311 split into a local part and a domain. The domain is looked up in the file. If
8312 it is not found, there is no match. If it is found, the data that is looked up
8313 from the file is treated as a colon-separated list of local part patterns, each
8314 of which is matched against the subject local part in turn.
8315
8316 .cindex "asterisk" "in address list"
8317 The lookup may be a partial one, and/or one involving a search for a default
8318 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8319 patterns that are looked up can be regular expressions or begin with &"*"&, or
8320 even be further lookups. They may also be independently negated. For example,
8321 with
8322 .code
8323 deny senders = @@dbm;/etc/reject-by-domain
8324 .endd
8325 the data from which the DBM file is built could contain lines like
8326 .code
8327 baddomain.com:  !postmaster : *
8328 .endd
8329 to reject all senders except &%postmaster%& from that domain.
8330
8331 .cindex "local part" "starting with !"
8332 If a local part that actually begins with an exclamation mark is required, it
8333 has to be specified using a regular expression. In &(lsearch)& files, an entry
8334 may be split over several lines by indenting the second and subsequent lines,
8335 but the separating colon must still be included at line breaks. White space
8336 surrounding the colons is ignored. For example:
8337 .code
8338 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8339 spammer3 : spammer4
8340 .endd
8341 As in all colon-separated lists in Exim, a colon can be included in an item by
8342 doubling.
8343
8344 If the last item in the list starts with a right angle-bracket, the remainder
8345 of the item is taken as a new key to look up in order to obtain a continuation
8346 list of local parts. The new key can be any sequence of characters. Thus one
8347 might have entries like
8348 .code
8349 aol.com: spammer1 : spammer 2 : >*
8350 xyz.com: spammer3 : >*
8351 *:       ^\d{8}$
8352 .endd
8353 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8354 local parts for all domains, in addition to the specific local parts listed for
8355 each domain. Of course, using this feature costs another lookup each time a
8356 chain is followed, but the effort needed to maintain the data is reduced.
8357
8358 .cindex "loop" "in lookups"
8359 It is possible to construct loops using this facility, and in order to catch
8360 them, the chains may be no more than fifty items long.
8361
8362 .next
8363 The @@<&'lookup'&> style of item can also be used with a query-style
8364 lookup, but in this case, the chaining facility is not available. The lookup
8365 can only return a single list of local parts.
8366 .endlist
8367
8368 &*Warning*&: There is an important difference between the address list items
8369 in these two examples:
8370 .code
8371 senders = +my_list
8372 senders = *@+my_list
8373 .endd
8374 In the first one, &`my_list`& is a named address list, whereas in the second
8375 example it is a named domain list.
8376
8377
8378
8379
8380 .section "Case of letters in address lists" "SECTcasletadd"
8381 .cindex "case of local parts"
8382 .cindex "address list" "case forcing"
8383 .cindex "case forcing in address lists"
8384 Domains in email addresses are always handled caselessly, but for local parts
8385 case may be significant on some systems (see &%caseful_local_part%& for how
8386 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8387 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8388 blocking lists should be done in a case-independent manner. Since most address
8389 lists in Exim are used for this kind of control, Exim attempts to do this by
8390 default.
8391
8392 The domain portion of an address is always lowercased before matching it to an
8393 address list. The local part is lowercased by default, and any string
8394 comparisons that take place are done caselessly. This means that the data in
8395 the address list itself, in files included as plain file names, and in any file
8396 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8397 keys in files that are looked up by a search type other than &(lsearch)& (which
8398 works caselessly) must be in lower case, because these lookups are not
8399 case-independent.
8400
8401 .cindex "&`+caseful`&"
8402 To allow for the possibility of caseful address list matching, if an item in
8403 an address list is the string &"+caseful"&, the original case of the local
8404 part is restored for any comparisons that follow, and string comparisons are no
8405 longer case-independent. This does not affect the domain, which remains in
8406 lower case. However, although independent matches on the domain alone are still
8407 performed caselessly, regular expressions that match against an entire address
8408 become case-sensitive after &"+caseful"& has been seen.
8409
8410
8411
8412 .section "Local part lists" "SECTlocparlis"
8413 .cindex "list" "local part list"
8414 .cindex "local part" "list"
8415 Case-sensitivity in local part lists is handled in the same way as for address
8416 lists, as just described. The &"+caseful"& item can be used if required. In a
8417 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8418 set false, the subject is lowercased and the matching is initially
8419 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8420 matching in the local part list, but not elsewhere in the router. If
8421 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8422 option is case-sensitive from the start.
8423
8424 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8425 comments are handled in the same way as address lists &-- they are recognized
8426 only if the # is preceded by white space or the start of the line.
8427 Otherwise, local part lists are matched in the same way as domain lists, except
8428 that the special items that refer to the local host (&`@`&, &`@[]`&,
8429 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8430 Refer to section &<<SECTdomainlist>>& for details of the other available item
8431 types.
8432 .ecindex IIDdohoadli
8433
8434
8435
8436
8437 . ////////////////////////////////////////////////////////////////////////////
8438 . ////////////////////////////////////////////////////////////////////////////
8439
8440 .chapter "String expansions" "CHAPexpand"
8441 .scindex IIDstrexp "expansion" "of strings"
8442 Many strings in Exim's run time configuration are expanded before use. Some of
8443 them are expanded every time they are used; others are expanded only once.
8444
8445 When a string is being expanded it is copied verbatim from left to right except
8446 when a dollar or backslash character is encountered. A dollar specifies the
8447 start of a portion of the string that is interpreted and replaced as described
8448 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8449 escape character, as described in the following section.
8450
8451
8452
8453 .section "Literal text in expanded strings" "SECTlittext"
8454 .cindex "expansion" "including literal text"
8455 An uninterpreted dollar can be included in an expanded string by putting a
8456 backslash in front of it. A backslash can be used to prevent any special
8457 character being treated specially in an expansion, including backslash itself.
8458 If the string appears in quotes in the configuration file, two backslashes are
8459 required because the quotes themselves cause interpretation of backslashes when
8460 the string is read in (see section &<<SECTstrings>>&).
8461
8462 .cindex "expansion" "non-expandable substrings"
8463 A portion of the string can specified as non-expandable by placing it between
8464 two occurrences of &`\N`&. This is particularly useful for protecting regular
8465 expressions, which often contain backslashes and dollar signs. For example:
8466 .code
8467 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8468 .endd
8469 On encountering the first &`\N`&, the expander copies subsequent characters
8470 without interpretation until it reaches the next &`\N`& or the end of the
8471 string.
8472
8473
8474
8475 .section "Character escape sequences in expanded strings" "SECID82"
8476 .cindex "expansion" "escape sequences"
8477 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8478 expanded string is recognized as an escape sequence for the character newline,
8479 carriage return, or tab, respectively. A backslash followed by up to three
8480 octal digits is recognized as an octal encoding for a single character, and a
8481 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8482 encoding.
8483
8484 These escape sequences are also recognized in quoted strings when they are read
8485 in. Their interpretation in expansions as well is useful for unquoted strings,
8486 and for other cases such as looked-up strings that are then expanded.
8487
8488
8489 .section "Testing string expansions" "SECID83"
8490 .cindex "expansion" "testing"
8491 .cindex "testing" "string expansion"
8492 .oindex "&%-be%&"
8493 Many expansions can be tested by calling Exim with the &%-be%& option. This
8494 takes the command arguments, or lines from the standard input if there are no
8495 arguments, runs them through the string expansion code, and writes the results
8496 to the standard output. Variables based on configuration values are set up, but
8497 since no message is being processed, variables such as &$local_part$& have no
8498 value. Nevertheless the &%-be%& option can be useful for checking out file and
8499 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8500 and &%nhash%&.
8501
8502 Exim gives up its root privilege when it is called with the &%-be%& option, and
8503 instead runs under the uid and gid it was called with, to prevent users from
8504 using &%-be%& for reading files to which they do not have access.
8505
8506 .oindex "&%-bem%&"
8507 If you want to test expansions that include variables whose values are taken
8508 from a message, there are two other options that can be used. The &%-bem%&
8509 option is like &%-be%& except that it is followed by a file name. The file is
8510 read as a message before doing the test expansions. For example:
8511 .code
8512 exim -bem /tmp/test.message '$h_subject:'
8513 .endd
8514 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8515 Exim message identifier. For example:
8516 .code
8517 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8518 .endd
8519 This loads the message from Exim's spool before doing the test expansions, and
8520 is therefore restricted to admin users.
8521
8522
8523 .section "Forced expansion failure" "SECTforexpfai"
8524 .cindex "expansion" "forced failure"
8525 A number of expansions that are described in the following section have
8526 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8527 (which are sometimes called &"curly brackets"&). Which of the two strings is
8528 used depends on some condition that is evaluated as part of the expansion. If,
8529 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8530 the entire string expansion fails in a way that can be detected by the code
8531 that requested the expansion. This is called &"forced expansion failure"&, and
8532 its consequences depend on the circumstances. In some cases it is no different
8533 from any other expansion failure, but in others a different action may be
8534 taken. Such variations are mentioned in the documentation of the option that is
8535 being expanded.
8536
8537
8538
8539
8540 .section "Expansion items" "SECTexpansionitems"
8541 The following items are recognized in expanded strings. White space may be used
8542 between sub-items that are keywords or substrings enclosed in braces inside an
8543 outer set of braces, to improve readability. &*Warning*&: Within braces,
8544 white space is significant.
8545
8546 .vlist
8547 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8548 .cindex "expansion" "variables"
8549 Substitute the contents of the named variable, for example:
8550 .code
8551 $local_part
8552 ${domain}
8553 .endd
8554 The second form can be used to separate the name from subsequent alphanumeric
8555 characters. This form (using braces) is available only for variables; it does
8556 &'not'& apply to message headers. The names of the variables are given in
8557 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8558 given, the expansion fails.
8559
8560 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8561 .cindex "expansion" "operators"
8562 The string is first itself expanded, and then the operation specified by
8563 <&'op'&> is applied to it. For example:
8564 .code
8565 ${lc:$local_part}
8566 .endd
8567 The string starts with the first character after the colon, which may be
8568 leading white space. A list of operators is given in section &<<SECTexpop>>&
8569 below. The operator notation is used for simple expansion items that have just
8570 one argument, because it reduces the number of braces and therefore makes the
8571 string easier to understand.
8572
8573 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8574 This item inserts &"basic"& header lines. It is described with the &%header%&
8575 expansion item below.
8576
8577 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8578        {*&<&'arg'&>&*}...}*&"
8579 .cindex &%dlfunc%&
8580 This expansion dynamically loads and then calls a locally-written C function.
8581 This functionality is available only if Exim is compiled with
8582 .code
8583 EXPAND_DLFUNC=yes
8584 .endd
8585 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8586 object so that it doesn't reload the same object file in the same Exim process
8587 (but of course Exim does start new processes frequently).
8588
8589 There may be from zero to eight arguments to the function. When compiling
8590 a local function that is to be called in this way, &_local_scan.h_& should be
8591 included. The Exim variables and functions that are defined by that API
8592 are also available for dynamically loaded functions. The function itself
8593 must have the following type:
8594 .code
8595 int dlfunction(uschar **yield, int argc, uschar *argv[])
8596 .endd
8597 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8598 function should return one of the following values:
8599
8600 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8601 into the expanded string that is being built.
8602
8603 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8604 from &'yield'&, if it is set.
8605
8606 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8607 taken from &'yield'& if it is set.
8608
8609 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8610
8611 When compiling a function that is to be used in this way with gcc,
8612 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8613 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8614
8615 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8616        {*&<&'string3'&>&*}}*&"
8617 .cindex "expansion" "extracting substrings by key"
8618 .cindex "&%extract%&" "substrings by key"
8619 The key and <&'string1'&> are first expanded separately. Leading and trailing
8620 white space is removed from the key (but not from any of the strings). The key
8621 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8622 form:
8623 .display
8624 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8625 .endd
8626 .vindex "&$value$&"
8627 where the equals signs and spaces (but not both) are optional. If any of the
8628 values contain white space, they must be enclosed in double quotes, and any
8629 values that are enclosed in double quotes are subject to escape processing as
8630 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8631 for the value that corresponds to the key. The search is case-insensitive. If
8632 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8633 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8634 variable &$value$& contains the value that has been extracted. Afterwards, it
8635 is restored to any previous value it might have had.
8636
8637 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8638 key is not found. If {<&'string2'&>} is also omitted, the value that was
8639 extracted is used. Thus, for example, these two expansions are identical, and
8640 yield &"2001"&:
8641 .code
8642 ${extract{gid}{uid=1984 gid=2001}}
8643 ${extract{gid}{uid=1984 gid=2001}{$value}}
8644 .endd
8645 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8646 appear, for example:
8647 .code
8648 ${extract{Z}{A=... B=...}{$value} fail }
8649 .endd
8650 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8651 {<&'string2'&>} must be present for &"fail"& to be recognized.
8652
8653
8654 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8655         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8656 .cindex "expansion" "extracting substrings by number"
8657 .cindex "&%extract%&" "substrings by number"
8658 The <&'number'&> argument must consist entirely of decimal digits,
8659 apart from leading and trailing white space, which is ignored.
8660 This is what distinguishes this form of &%extract%& from the previous kind. It
8661 behaves in the same way, except that, instead of extracting a named field, it
8662 extracts from <&'string1'&> the field whose number is given as the first
8663 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8664 <&'string3'&> as before.
8665
8666 The fields in the string are separated by any one of the characters in the
8667 separator string. These may include space or tab characters.
8668 The first field is numbered one. If the number is negative, the fields are
8669 counted from the end of the string, with the rightmost one numbered -1. If the
8670 number given is zero, the entire string is returned. If the modulus of the
8671 number is greater than the number of fields in the string, the result is the
8672 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8673 provided. For example:
8674 .code
8675 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8676 .endd
8677 yields &"42"&, and
8678 .code
8679 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8680 .endd
8681 yields &"99"&. Two successive separators mean that the field between them is
8682 empty (for example, the fifth field above).
8683
8684
8685 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8686 .cindex "list" "selecting by condition"
8687 .cindex "expansion" "selecting from list by condition"
8688 .vindex "&$item$&"
8689 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8690 default, but the separator can be changed in the usual way. For each item
8691 in this list, its value is place in &$item$&, and then the condition is
8692 evaluated. If the condition is true, &$item$& is added to the output as an
8693 item in a new list; if the condition is false, the item is discarded. The
8694 separator used for the output list is the same as the one used for the
8695 input, but a separator setting is not included in the output. For example:
8696 .code
8697 ${filter{a:b:c}{!eq{$item}{b}}
8698 .endd
8699 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8700 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8701
8702
8703 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8704 .cindex "hash function" "textual"
8705 .cindex "expansion" "textual hash"
8706 This is a textual hashing function, and was the first to be implemented in
8707 early versions of Exim. In current releases, there are other hashing functions
8708 (numeric, MD5, and SHA-1), which are described below.
8709
8710 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
8711 <&'n'&>. If you are using fixed values for these numbers, that is, if
8712 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
8713 use the simpler operator notation that avoids some of the braces:
8714 .code
8715 ${hash_<n>_<m>:<string>}
8716 .endd
8717 The second number is optional (in both notations). If <&'n'&> is greater than
8718 or equal to the length of the string, the expansion item returns the string.
8719 Otherwise it computes a new string of length <&'n'&> by applying a hashing
8720 function to the string. The new string consists of characters taken from the
8721 first <&'m'&> characters of the string
8722 .code
8723 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
8724 .endd
8725 If <&'m'&> is not present the value 26 is used, so that only lower case
8726 letters appear. For example:
8727 .display
8728 &`$hash{3}{monty}}           `&   yields  &`jmg`&
8729 &`$hash{5}{monty}}           `&   yields  &`monty`&
8730 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
8731 .endd
8732
8733 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
8734         &*$h_*&<&'header&~name'&>&*:*&" &&&
8735        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8736         &*$bh_*&<&'header&~name'&>&*:*&" &&&
8737        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8738         &*$rh_*&<&'header&~name'&>&*:*&"
8739 .cindex "expansion" "header insertion"
8740 .vindex "&$header_$&"
8741 .vindex "&$bheader_$&"
8742 .vindex "&$rheader_$&"
8743 .cindex "header lines" "in expansion strings"
8744 .cindex "header lines" "character sets"
8745 .cindex "header lines" "decoding"
8746 Substitute the contents of the named message header line, for example
8747 .code
8748 $header_reply-to:
8749 .endd
8750 The newline that terminates a header line is not included in the expansion, but
8751 internal newlines (caused by splitting the header line over several physical
8752 lines) may be present.
8753
8754 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
8755 the data in the header line is interpreted.
8756
8757 .ilist
8758 .cindex "white space" "in header lines"
8759 &%rheader%& gives the original &"raw"& content of the header line, with no
8760 processing at all, and without the removal of leading and trailing white space.
8761
8762 .next
8763 .cindex "base64 encoding" "in header lines"
8764 &%bheader%& removes leading and trailing white space, and then decodes base64
8765 or quoted-printable MIME &"words"& within the header text, but does no
8766 character set translation. If decoding of what looks superficially like a MIME
8767 &"word"& fails, the raw string is returned. If decoding
8768 .cindex "binary zero" "in header line"
8769 produces a binary zero character, it is replaced by a question mark &-- this is
8770 what Exim does for binary zeros that are actually received in header lines.
8771
8772 .next
8773 &%header%& tries to translate the string as decoded by &%bheader%& to a
8774 standard character set. This is an attempt to produce the same string as would
8775 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
8776 returned. Translation is attempted only on operating systems that support the
8777 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
8778 a system Makefile or in &_Local/Makefile_&.
8779 .endlist ilist
8780
8781 In a filter file, the target character set for &%header%& can be specified by a
8782 command of the following form:
8783 .code
8784 headers charset "UTF-8"
8785 .endd
8786 This command affects all references to &$h_$& (or &$header_$&) expansions in
8787 subsequently obeyed filter commands. In the absence of this command, the target
8788 character set in a filter is taken from the setting of the &%headers_charset%&
8789 option in the runtime configuration. The value of this option defaults to the
8790 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
8791 ISO-8859-1.
8792
8793 Header names follow the syntax of RFC 2822, which states that they may contain
8794 any printing characters except space and colon. Consequently, curly brackets
8795 &'do not'& terminate header names, and should not be used to enclose them as
8796 if they were variables. Attempting to do so causes a syntax error.
8797
8798 Only header lines that are common to all copies of a message are visible to
8799 this mechanism. These are the original header lines that are received with the
8800 message, and any that are added by an ACL statement or by a system
8801 filter. Header lines that are added to a particular copy of a message by a
8802 router or transport are not accessible.
8803
8804 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
8805 before the DATA ACL, because the header structure is not set up until the
8806 message is received. Header lines that are added in a RCPT ACL (for example)
8807 are saved until the message's incoming header lines are available, at which
8808 point they are added. When a DATA ACL is running, however, header lines added
8809 by earlier ACLs are visible.
8810
8811 Upper case and lower case letters are synonymous in header names. If the
8812 following character is white space, the terminating colon may be omitted, but
8813 this is not recommended, because you may then forget it when it is needed. When
8814 white space terminates the header name, it is included in the expanded string.
8815 If the message does not contain the given header, the expansion item is
8816 replaced by an empty string. (See the &%def%& condition in section
8817 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
8818
8819 If there is more than one header with the same name, they are all concatenated
8820 to form the substitution string, up to a maximum length of 64K. Unless
8821 &%rheader%& is being used, leading and trailing white space is removed from
8822 each header before concatenation, and a completely empty header is ignored. A
8823 newline character is then inserted between non-empty headers, but there is no
8824 newline at the very end. For the &%header%& and &%bheader%& expansion, for
8825 those headers that contain lists of addresses, a comma is also inserted at the
8826 junctions between headers. This does not happen for the &%rheader%& expansion.
8827
8828
8829 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
8830 .cindex "expansion" "hmac hashing"
8831 .cindex &%hmac%&
8832 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
8833 shared secret and some text into a message authentication code, as specified in
8834 RFC 2104. This differs from &`${md5:secret_text...}`& or
8835 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
8836 cryptographic hash, allowing for authentication that is not possible with MD5
8837 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
8838 present. For example:
8839 .code
8840 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
8841 .endd
8842 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
8843 produces:
8844 .code
8845 dd97e3ba5d1a61b5006108f8c8252953
8846 .endd
8847 As an example of how this might be used, you might put in the main part of
8848 an Exim configuration:
8849 .code
8850 SPAMSCAN_SECRET=cohgheeLei2thahw
8851 .endd
8852 In a router or a transport you could then have:
8853 .code
8854 headers_add = \
8855   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
8856   ${hmac{md5}{SPAMSCAN_SECRET}\
8857   {${primary_hostname},${message_exim_id},$h_message-id:}}
8858 .endd
8859 Then given a message, you can check where it was scanned by looking at the
8860 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
8861 this header line is authentic by recomputing the authentication code from the
8862 host name, message ID and the &'Message-id:'& header line. This can be done
8863 using Exim's &%-be%& option, or by other means, for example by using the
8864 &'hmac_md5_hex()'& function in Perl.
8865
8866
8867 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8868 .cindex "expansion" "conditional"
8869 .cindex "&%if%&, expansion item"
8870 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
8871 item; otherwise <&'string2'&> is used. The available conditions are described
8872 in section &<<SECTexpcond>>& below. For example:
8873 .code
8874 ${if eq {$local_part}{postmaster} {yes}{no} }
8875 .endd
8876 The second string need not be present; if it is not and the condition is not
8877 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
8878 be present instead of the second string (without any curly brackets). In this
8879 case, the expansion is forced to fail if the condition is not true (see section
8880 &<<SECTforexpfai>>&).
8881
8882 If both strings are omitted, the result is the string &`true`& if the condition
8883 is true, and the empty string if the condition is false. This makes it less
8884 cumbersome to write custom ACL and router conditions. For example, instead of
8885 .code
8886 condition = ${if >{$acl_m4}{3}{true}{false}}
8887 .endd
8888 you can use
8889 .code
8890 condition = ${if >{$acl_m4}{3}}
8891 .endd
8892
8893 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8894 .cindex "expansion" "string truncation"
8895 .cindex "&%length%& expansion item"
8896 The &%length%& item is used to extract the initial portion of a string. Both
8897 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
8898 you are using a fixed value for the number, that is, if <&'string1'&> does not
8899 change when expanded, you can use the simpler operator notation that avoids
8900 some of the braces:
8901 .code
8902 ${length_<n>:<string>}
8903 .endd
8904 The result of this item is either the first <&'n'&> characters or the whole
8905 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
8906 &%strlen%&, which gives the length of a string.
8907
8908
8909 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
8910         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
8911 This is the first of one of two different types of lookup item, which are both
8912 described in the next item.
8913
8914 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
8915         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
8916 .cindex "expansion" "lookup in"
8917 .cindex "file" "lookups"
8918 .cindex "lookup" "in expanded string"
8919 The two forms of lookup item specify data lookups in files and databases, as
8920 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
8921 lookups, and the second is used for query-style lookups. The <&'key'&>,
8922 <&'file'&>, and <&'query'&> strings are expanded before use.
8923
8924 If there is any white space in a lookup item which is part of a filter command,
8925 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
8926 other place where white space is significant, the lookup item must be enclosed
8927 in double quotes. The use of data lookups in users' filter files may be locked
8928 out by the system administrator.
8929
8930 .vindex "&$value$&"
8931 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
8932 During its expansion, the variable &$value$& contains the data returned by the
8933 lookup. Afterwards it reverts to the value it had previously (at the outer
8934 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
8935 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
8936 string on failure. If <&'string2'&> is provided, it can itself be a nested
8937 lookup, thus providing a mechanism for looking up a default value when the
8938 original lookup fails.
8939
8940 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
8941 data for the outer lookup while the parameters of the second lookup are
8942 expanded, and also while <&'string2'&> of the second lookup is expanded, should
8943 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
8944 appear, and in this case, if the lookup fails, the entire expansion is forced
8945 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
8946 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
8947 successful lookup, and nothing in the case of failure.
8948
8949 For single-key lookups, the string &"partial"& is permitted to precede the
8950 search type in order to do partial matching, and * or *@ may follow a search
8951 type to request default lookups if the key does not match (see sections
8952 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
8953
8954 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
8955 If a partial search is used, the variables &$1$& and &$2$& contain the wild
8956 and non-wild parts of the key during the expansion of the replacement text.
8957 They return to their previous values at the end of the lookup item.
8958
8959 This example looks up the postmaster alias in the conventional alias file:
8960 .code
8961 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
8962 .endd
8963 This example uses NIS+ to look up the full name of the user corresponding to
8964 the local part of an address, forcing the expansion to fail if it is not found:
8965 .code
8966 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
8967   {$value}fail}
8968 .endd
8969
8970
8971 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8972 .cindex "expansion" "list creation"
8973 .vindex "&$item$&"
8974 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
8975 default, but the separator can be changed in the usual way. For each item
8976 in this list, its value is place in &$item$&, and then <&'string2'&> is
8977 expanded and added to the output as an item in a new list. The separator used
8978 for the output list is the same as the one used for the input, but a separator
8979 setting is not included in the output. For example:
8980 .code
8981 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
8982 .endd
8983 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
8984 value of &$item$& is restored to what it was before. See also the &*filter*&
8985 and &*reduce*& expansion items.
8986
8987 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8988 .cindex "expansion" "numeric hash"
8989 .cindex "hash function" "numeric"
8990 The three strings are expanded; the first two must yield numbers. Call them
8991 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
8992 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
8993 can use the simpler operator notation that avoids some of the braces:
8994 .code
8995 ${nhash_<n>_<m>:<string>}
8996 .endd
8997 The second number is optional (in both notations). If there is only one number,
8998 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
8999 processed by a div/mod hash function that returns two numbers, separated by a
9000 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9001 example,
9002 .code
9003 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9004 .endd
9005 returns the string &"6/33"&.
9006
9007
9008
9009 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9010 .cindex "Perl" "use in expanded string"
9011 .cindex "expansion" "calling Perl from"
9012 This item is available only if Exim has been built to include an embedded Perl
9013 interpreter. The subroutine name and the arguments are first separately
9014 expanded, and then the Perl subroutine is called with those arguments. No
9015 additional arguments need be given; the maximum number permitted, including the
9016 name of the subroutine, is nine.
9017
9018 The return value of the subroutine is inserted into the expanded string, unless
9019 the return value is &%undef%&. In that case, the expansion fails in the same
9020 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9021 Whatever you return is evaluated in a scalar context. For example, if you
9022 return the name of a Perl vector, the return value is the size of the vector,
9023 not its contents.
9024
9025 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9026 with the error message that was passed to &%die%&. More details of the embedded
9027 Perl facility are given in chapter &<<CHAPperl>>&.
9028
9029 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9030 out the use of this expansion item in filter files.
9031
9032
9033 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9034 .cindex "&%prvs%& expansion item"
9035 The first argument is a complete email address and the second is secret
9036 keystring. The third argument, specifying a key number, is optional. If absent,
9037 it defaults to 0. The result of the expansion is a prvs-signed email address,
9038 to be typically used with the &%return_path%& option on an &(smtp)& transport
9039 as part of a bounce address tag validation (BATV) scheme. For more discussion
9040 and an example, see section &<<SECTverifyPRVS>>&.
9041
9042 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9043         {*&<&'string'&>&*}}*&"
9044 .cindex "&%prvscheck%& expansion item"
9045 This expansion item is the complement of the &%prvs%& item. It is used for
9046 checking prvs-signed addresses. If the expansion of the first argument does not
9047 yield a syntactically valid prvs-signed address, the whole item expands to the
9048 empty string. When the first argument does expand to a syntactically valid
9049 prvs-signed address, the second argument is expanded, with the prvs-decoded
9050 version of the address and the key number extracted from the address in the
9051 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9052
9053 These two variables can be used in the expansion of the second argument to
9054 retrieve the secret. The validity of the prvs-signed address is then checked
9055 against the secret. The result is stored in the variable &$prvscheck_result$&,
9056 which is empty for failure or &"1"& for success.
9057
9058 The third argument is optional; if it is missing, it defaults to an empty
9059 string. This argument is now expanded. If the result is an empty string, the
9060 result of the expansion is the decoded version of the address. This is the case
9061 whether or not the signature was valid. Otherwise, the result of the expansion
9062 is the expansion of the third argument.
9063
9064 All three variables can be used in the expansion of the third argument.
9065 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9066 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9067
9068 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9069 .cindex "expansion" "inserting an entire file"
9070 .cindex "file" "inserting into expansion"
9071 .cindex "&%readfile%& expansion item"
9072 The file name and end-of-line string are first expanded separately. The file is
9073 then read, and its contents replace the entire item. All newline characters in
9074 the file are replaced by the end-of-line string if it is present. Otherwise,
9075 newlines are left in the string.
9076 String expansion is not applied to the contents of the file. If you want this,
9077 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9078 the string expansion fails.
9079
9080 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9081 locks out the use of this expansion item in filter files.
9082
9083
9084
9085 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9086         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9087 .cindex "expansion" "inserting from a socket"
9088 .cindex "socket, use of in expansion"
9089 .cindex "&%readsocket%& expansion item"
9090 This item inserts data from a Unix domain or Internet socket into the expanded
9091 string. The minimal way of using it uses just two arguments, as in these
9092 examples:
9093 .code
9094 ${readsocket{/socket/name}{request string}}
9095 ${readsocket{inet:some.host:1234}{request string}}
9096 .endd
9097 For a Unix domain socket, the first substring must be the path to the socket.
9098 For an Internet socket, the first substring must contain &`inet:`& followed by
9099 a host name or IP address, followed by a colon and a port, which can be a
9100 number or the name of a TCP port in &_/etc/services_&. An IP address may
9101 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9102 example:
9103 .code
9104 ${readsocket{inet:[::1]:1234}{request string}}
9105 .endd
9106 Only a single host name may be given, but if looking it up yields more than
9107 one IP address, they are each tried in turn until a connection is made. For
9108 both kinds of socket, Exim makes a connection, writes the request string
9109 (unless it is an empty string) and reads from the socket until an end-of-file
9110 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9111 extend what can be done. Firstly, you can vary the timeout. For example:
9112 .code
9113 ${readsocket{/socket/name}{request string}{3s}}
9114 .endd
9115 A fourth argument allows you to change any newlines that are in the data
9116 that is read, in the same way as for &%readfile%& (see above). This example
9117 turns them into spaces:
9118 .code
9119 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9120 .endd
9121 As with all expansions, the substrings are expanded before the processing
9122 happens. Errors in these sub-expansions cause the expansion to fail. In
9123 addition, the following errors can occur:
9124
9125 .ilist
9126 Failure to create a socket file descriptor;
9127 .next
9128 Failure to connect the socket;
9129 .next
9130 Failure to write the request string;
9131 .next
9132 Timeout on reading from the socket.
9133 .endlist
9134
9135 By default, any of these errors causes the expansion to fail. However, if
9136 you supply a fifth substring, it is expanded and used when any of the above
9137 errors occurs. For example:
9138 .code
9139 ${readsocket{/socket/name}{request string}{3s}{\n}\
9140   {socket failure}}
9141 .endd
9142 You can test for the existence of a Unix domain socket by wrapping this
9143 expansion in &`${if exists`&, but there is a race condition between that test
9144 and the actual opening of the socket, so it is safer to use the fifth argument
9145 if you want to be absolutely sure of avoiding an expansion error for a
9146 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9147
9148 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9149 locks out the use of this expansion item in filter files.
9150
9151
9152 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9153 .cindex "expansion" "reducing a list to a scalar"
9154 .cindex "list" "reducing to a scalar"
9155 .vindex "&$value$&"
9156 .vindex "&$item$&"
9157 This operation reduces a list to a single, scalar string. After expansion,
9158 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9159 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9160 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9161 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9162 them. The result of that expansion is assigned to &$value$& before the next
9163 iteration. When the end of the list is reached, the final value of &$value$& is
9164 added to the expansion output. The &*reduce*& expansion item can be used in a
9165 number of ways. For example, to add up a list of numbers:
9166 .code
9167 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9168 .endd
9169 The result of that expansion would be &`6`&. The maximum of a list of numbers
9170 can be found:
9171 .code
9172 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9173 .endd
9174 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9175 restored to what they were before. See also the &*filter*& and &*map*&
9176 expansion items.
9177
9178 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9179 This item inserts &"raw"& header lines. It is described with the &%header%&
9180 expansion item above.
9181
9182 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9183         {*&<&'string2'&>&*}}*&"
9184 .cindex "expansion" "running a command"
9185 .cindex "&%run%& expansion item"
9186 The command and its arguments are first expanded separately, and then the
9187 command is run in a separate process, but under the same uid and gid. As in
9188 other command executions from Exim, a shell is not used by default. If you want
9189 a shell, you must explicitly code it.
9190
9191 The standard input for the command exists, but is empty. The standard output
9192 and standard error are set to the same file descriptor.
9193 .cindex "return code" "from &%run%& expansion"
9194 .vindex "&$value$&"
9195 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9196 and replaces the entire item; during this expansion, the standard output/error
9197 from the command is in the variable &$value$&. If the command fails,
9198 <&'string2'&>, if present, is expanded and used. Once again, during the
9199 expansion, the standard output/error from the command is in the variable
9200 &$value$&.
9201
9202 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9203 can be the word &"fail"& (not in braces) to force expansion failure if the
9204 command does not succeed. If both strings are omitted, the result is contents
9205 of the standard output/error on success, and nothing on failure.
9206
9207 .vindex "&$runrc$&"
9208 The return code from the command is put in the variable &$runrc$&, and this
9209 remains set afterwards, so in a filter file you can do things like this:
9210 .code
9211 if "${run{x y z}{}}$runrc" is 1 then ...
9212   elif $runrc is 2 then ...
9213   ...
9214 endif
9215 .endd
9216 If execution of the command fails (for example, the command does not exist),
9217 the return code is 127 &-- the same code that shells use for non-existent
9218 commands.
9219
9220 &*Warning*&: In a router or transport, you cannot assume the order in which
9221 option values are expanded, except for those preconditions whose order of
9222 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9223 by the expansion of one option, and use it in another.
9224
9225 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9226 out the use of this expansion item in filter files.
9227
9228
9229 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9230 .cindex "expansion" "string substitution"
9231 .cindex "&%sg%& expansion item"
9232 This item works like Perl's substitution operator (s) with the global (/g)
9233 option; hence its name. However, unlike the Perl equivalent, Exim does not
9234 modify the subject string; instead it returns the modified string for insertion
9235 into the overall expansion. The item takes three arguments: the subject string,
9236 a regular expression, and a substitution string. For example:
9237 .code
9238 ${sg{abcdefabcdef}{abc}{xyz}}
9239 .endd
9240 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9241 if any $ or \ characters are required in the regular expression or in the
9242 substitution string, they have to be escaped. For example:
9243 .code
9244 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9245 .endd
9246 yields &"defabc"&, and
9247 .code
9248 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9249 .endd
9250 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9251 the regular expression from string expansion.
9252
9253
9254
9255 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9256 .cindex "&%substr%& expansion item"
9257 .cindex "substring extraction"
9258 .cindex "expansion" "substring extraction"
9259 The three strings are expanded; the first two must yield numbers. Call them
9260 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9261 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9262 can use the simpler operator notation that avoids some of the braces:
9263 .code
9264 ${substr_<n>_<m>:<string>}
9265 .endd
9266 The second number is optional (in both notations).
9267 If it is absent in the simpler format, the preceding underscore must also be
9268 omitted.
9269
9270 The &%substr%& item can be used to extract more general substrings than
9271 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9272 length required. For example
9273 .code
9274 ${substr{3}{2}{$local_part}}
9275 .endd
9276 If the starting offset is greater than the string length the result is the
9277 null string; if the length plus starting offset is greater than the string
9278 length, the result is the right-hand part of the string, starting from the
9279 given offset. The first character in the string has offset zero.
9280
9281 The &%substr%& expansion item can take negative offset values to count
9282 from the right-hand end of its operand. The last character is offset -1, the
9283 second-last is offset -2, and so on. Thus, for example,
9284 .code
9285 ${substr{-5}{2}{1234567}}
9286 .endd
9287 yields &"34"&. If the absolute value of a negative offset is greater than the
9288 length of the string, the substring starts at the beginning of the string, and
9289 the length is reduced by the amount of overshoot. Thus, for example,
9290 .code
9291 ${substr{-5}{2}{12}}
9292 .endd
9293 yields an empty string, but
9294 .code
9295 ${substr{-3}{2}{12}}
9296 .endd
9297 yields &"1"&.
9298
9299 When the second number is omitted from &%substr%&, the remainder of the string
9300 is taken if the offset is positive. If it is negative, all characters in the
9301 string preceding the offset point are taken. For example, an offset of -1 and
9302 no length, as in these semantically identical examples:
9303 .code
9304 ${substr_-1:abcde}
9305 ${substr{-1}{abcde}}
9306 .endd
9307 yields all but the last character of the string, that is, &"abcd"&.
9308
9309
9310
9311 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9312         {*&<&'replacements'&>&*}}*&"
9313 .cindex "expansion" "character translation"
9314 .cindex "&%tr%& expansion item"
9315 This item does single-character translation on its subject string. The second
9316 argument is a list of characters to be translated in the subject string. Each
9317 matching character is replaced by the corresponding character from the
9318 replacement list. For example
9319 .code
9320 ${tr{abcdea}{ac}{13}}
9321 .endd
9322 yields &`1b3de1`&. If there are duplicates in the second character string, the
9323 last occurrence is used. If the third string is shorter than the second, its
9324 last character is replicated. However, if it is empty, no translation takes
9325 place.
9326 .endlist
9327
9328
9329
9330 .section "Expansion operators" "SECTexpop"
9331 .cindex "expansion" "operators"
9332 For expansion items that perform transformations on a single argument string,
9333 the &"operator"& notation is used because it is simpler and uses fewer braces.
9334 The substring is first expanded before the operation is applied to it. The
9335 following operations can be performed:
9336
9337 .vlist
9338 .vitem &*${address:*&<&'string'&>&*}*&
9339 .cindex "expansion" "RFC 2822 address handling"
9340 .cindex "&%address%& expansion item"
9341 The string is interpreted as an RFC 2822 address, as it might appear in a
9342 header line, and the effective address is extracted from it. If the string does
9343 not parse successfully, the result is empty.
9344
9345
9346 .vitem &*${addresses:*&<&'string'&>&*}*&
9347 .cindex "expansion" "RFC 2822 address handling"
9348 .cindex "&%addresses%& expansion item"
9349 The string (after expansion) is interpreted as a list of addresses in RFC
9350 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9351 operative address (&'local-part@domain'&) is extracted from each item, and the
9352 result of the expansion is a colon-separated list, with appropriate
9353 doubling of colons should any happen to be present in the email addresses.
9354 Syntactically invalid RFC2822 address items are omitted from the output.
9355
9356 It is possible to specify a character other than colon for the output
9357 separator by starting the string with > followed by the new separator
9358 character. For example:
9359 .code
9360 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9361 .endd
9362 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9363 expansion item, which extracts the working address from a single RFC2822
9364 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9365 processing lists.
9366
9367
9368 .vitem &*${base62:*&<&'digits'&>&*}*&
9369 .cindex "&%base62%& expansion item"
9370 .cindex "expansion" "conversion to base 62"
9371 The string must consist entirely of decimal digits. The number is converted to
9372 base 62 and output as a string of six characters, including leading zeros. In
9373 the few operating environments where Exim uses base 36 instead of base 62 for
9374 its message identifiers (because those systems do not have case-sensitive file
9375 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9376 be absolutely clear: this is &'not'& base64 encoding.
9377
9378 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9379 .cindex "&%base62d%& expansion item"
9380 .cindex "expansion" "conversion to base 62"
9381 The string must consist entirely of base-62 digits, or, in operating
9382 environments where Exim uses base 36 instead of base 62 for its message
9383 identifiers, base-36 digits. The number is converted to decimal and output as a
9384 string.
9385
9386 .vitem &*${domain:*&<&'string'&>&*}*&
9387 .cindex "domain" "extraction"
9388 .cindex "expansion" "domain extraction"
9389 The string is interpreted as an RFC 2822 address and the domain is extracted
9390 from it. If the string does not parse successfully, the result is empty.
9391
9392
9393 .vitem &*${escape:*&<&'string'&>&*}*&
9394 .cindex "expansion" "escaping non-printing characters"
9395 .cindex "&%escape%& expansion item"
9396 If the string contains any non-printing characters, they are converted to
9397 escape sequences starting with a backslash. Whether characters with the most
9398 significant bit set (so-called &"8-bit characters"&) count as printing or not
9399 is controlled by the &%print_topbitchars%& option.
9400
9401
9402 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9403 .cindex "expansion" "expression evaluation"
9404 .cindex "expansion" "arithmetic expression"
9405 .cindex "&%eval%& expansion item"
9406 These items supports simple arithmetic and bitwise logical operations in
9407 expansion strings. The string (after expansion) must be a conventional
9408 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9409 logical operators, and parentheses. All operations are carried out using
9410 integer arithmetic. The operator priorities are as follows (the same as in the
9411 C programming language):
9412 .table2 70pt 300pt
9413 .irow &'highest:'& "not (~), negate (-)"
9414 .irow ""   "multiply (*), divide (/), remainder (%)"
9415 .irow ""   "plus (+), minus (-)"
9416 .irow ""   "shift-left (<<), shift-right (>>)"
9417 .irow ""   "and (&&)"
9418 .irow ""   "xor (^)"
9419 .irow &'lowest:'&  "or (|)"
9420 .endtable
9421 Binary operators with the same priority are evaluated from left to right. White
9422 space is permitted before or after operators.
9423
9424 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9425 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9426 decimal, even if they start with a leading zero; hexadecimal numbers are not
9427 permitted. This can be useful when processing numbers extracted from dates or
9428 times, which often do have leading zeros.
9429
9430 A number may be followed by &"K"& or &"M"& to multiply it by 1024 or 1024*1024,
9431 respectively. Negative numbers are supported. The result of the computation is
9432 a decimal representation of the answer (without &"K"& or &"M"&). For example:
9433
9434 .display
9435 &`${eval:1+1}            `&  yields 2
9436 &`${eval:1+2*3}          `&  yields 7
9437 &`${eval:(1+2)*3}        `&  yields 9
9438 &`${eval:2+42%5}         `&  yields 4
9439 &`${eval:0xc&amp;5}          `&  yields 4
9440 &`${eval:0xc|5}          `&  yields 13
9441 &`${eval:0xc^5}          `&  yields 9
9442 &`${eval:0xc>>1}         `&  yields 6
9443 &`${eval:0xc<<1}         `&  yields 24
9444 &`${eval:~255&amp;0x1234}    `&  yields 4608
9445 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9446 .endd
9447
9448 As a more realistic example, in an ACL you might have
9449 .code
9450 deny   message = Too many bad recipients
9451        condition =                    \
9452          ${if and {                   \
9453            {>{$rcpt_count}{10}}       \
9454            {                          \
9455            <                          \
9456              {$recipients_count}      \
9457              {${eval:$rcpt_count/2}}  \
9458            }                          \
9459          }{yes}{no}}
9460 .endd
9461 The condition is true if there have been more than 10 RCPT commands and
9462 fewer than half of them have resulted in a valid recipient.
9463
9464
9465 .vitem &*${expand:*&<&'string'&>&*}*&
9466 .cindex "expansion" "re-expansion of substring"
9467 The &%expand%& operator causes a string to be expanded for a second time. For
9468 example,
9469 .code
9470 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9471 .endd
9472 first looks up a string in a file while expanding the operand for &%expand%&,
9473 and then re-expands what it has found.
9474
9475
9476 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9477 .cindex "Unicode"
9478 .cindex "UTF-8" "conversion from"
9479 .cindex "expansion" "UTF-8 conversion"
9480 .cindex "&%from_utf8%& expansion item"
9481 The world is slowly moving towards Unicode, although there are no standards for
9482 email yet. However, other applications (including some databases) are starting
9483 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9484 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9485 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9486 the result is an undefined sequence of bytes.
9487
9488 Unicode code points with values less than 256 are compatible with ASCII and
9489 ISO-8859-1 (also known as Latin-1).
9490 For example, character 169 is the copyright symbol in both cases, though the
9491 way it is encoded is different. In UTF-8, more than one byte is needed for
9492 characters with code values greater than 127, whereas ISO-8859-1 is a
9493 single-byte encoding (but thereby limited to 256 characters). This makes
9494 translation from UTF-8 to ISO-8859-1 straightforward.
9495
9496
9497 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9498 .cindex "hash function" "textual"
9499 .cindex "expansion" "textual hash"
9500 The &%hash%& operator is a simpler interface to the hashing function that can
9501 be used when the two parameters are fixed numbers (as opposed to strings that
9502 change when expanded). The effect is the same as
9503 .code
9504 ${hash{<n>}{<m>}{<string>}}
9505 .endd
9506 See the description of the general &%hash%& item above for details. The
9507 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9508
9509
9510
9511 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9512 .cindex "base64 encoding" "conversion from hex"
9513 .cindex "expansion" "hex to base64"
9514 .cindex "&%hex2b64%& expansion item"
9515 This operator converts a hex string into one that is base64 encoded. This can
9516 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9517
9518
9519 .vitem &*${lc:*&<&'string'&>&*}*&
9520 .cindex "case forcing in strings"
9521 .cindex "string" "case forcing"
9522 .cindex "lower casing"
9523 .cindex "expansion" "case forcing"
9524 .cindex "&%lc%& expansion item"
9525 This forces the letters in the string into lower-case, for example:
9526 .code
9527 ${lc:$local_part}
9528 .endd
9529
9530 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9531 .cindex "expansion" "string truncation"
9532 .cindex "&%length%& expansion item"
9533 The &%length%& operator is a simpler interface to the &%length%& function that
9534 can be used when the parameter is a fixed number (as opposed to a string that
9535 changes when expanded). The effect is the same as
9536 .code
9537 ${length{<number>}{<string>}}
9538 .endd
9539 See the description of the general &%length%& item above for details. Note that
9540 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9541 when &%length%& is used as an operator.
9542
9543
9544 .vitem &*${local_part:*&<&'string'&>&*}*&
9545 .cindex "expansion" "local part extraction"
9546 .cindex "&%local_part%& expansion item"
9547 The string is interpreted as an RFC 2822 address and the local part is
9548 extracted from it. If the string does not parse successfully, the result is
9549 empty.
9550
9551
9552 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9553 .cindex "masked IP address"
9554 .cindex "IP address" "masking"
9555 .cindex "CIDR notation"
9556 .cindex "expansion" "IP address masking"
9557 .cindex "&%mask%& expansion item"
9558 If the form of the string to be operated on is not an IP address followed by a
9559 slash and an integer (that is, a network address in CIDR notation), the
9560 expansion fails. Otherwise, this operator converts the IP address to binary,
9561 masks off the least significant bits according to the bit count, and converts
9562 the result back to text, with mask appended. For example,
9563 .code
9564 ${mask:10.111.131.206/28}
9565 .endd
9566 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9567 be mostly used for looking up masked addresses in files, the result for an IPv6
9568 address uses dots to separate components instead of colons, because colon
9569 terminates a key string in lsearch files. So, for example,
9570 .code
9571 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9572 .endd
9573 returns the string
9574 .code
9575 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9576 .endd
9577 Letters in IPv6 addresses are always output in lower case.
9578
9579
9580 .vitem &*${md5:*&<&'string'&>&*}*&
9581 .cindex "MD5 hash"
9582 .cindex "expansion" "MD5 hash"
9583 .cindex "&%md5%& expansion item"
9584 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9585 as a 32-digit hexadecimal number, in which any letters are in lower case.
9586
9587
9588 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9589 .cindex "expansion" "numeric hash"
9590 .cindex "hash function" "numeric"
9591 The &%nhash%& operator is a simpler interface to the numeric hashing function
9592 that can be used when the two parameters are fixed numbers (as opposed to
9593 strings that change when expanded). The effect is the same as
9594 .code
9595 ${nhash{<n>}{<m>}{<string>}}
9596 .endd
9597 See the description of the general &%nhash%& item above for details.
9598
9599
9600 .vitem &*${quote:*&<&'string'&>&*}*&
9601 .cindex "quoting" "in string expansions"
9602 .cindex "expansion" "quoting"
9603 .cindex "&%quote%& expansion item"
9604 The &%quote%& operator puts its argument into double quotes if it
9605 is an empty string or
9606 contains anything other than letters, digits, underscores, dots, and hyphens.
9607 Any occurrences of double quotes and backslashes are escaped with a backslash.
9608 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9609 respectively For example,
9610 .code
9611 ${quote:ab"*"cd}
9612 .endd
9613 becomes
9614 .code
9615 "ab\"*\"cd"
9616 .endd
9617 The place where this is useful is when the argument is a substitution from a
9618 variable or a message header.
9619
9620 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9621 .cindex "&%quote_local_part%& expansion item"
9622 This operator is like &%quote%&, except that it quotes the string only if
9623 required to do so by the rules of RFC 2822 for quoting local parts. For
9624 example, a plus sign would not cause quoting (but it would for &%quote%&).
9625 If you are creating a new email address from the contents of &$local_part$&
9626 (or any other unknown data), you should always use this operator.
9627
9628
9629 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9630 .cindex "quoting" "lookup-specific"
9631 This operator applies lookup-specific quoting rules to the string. Each
9632 query-style lookup type has its own quoting rules which are described with
9633 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9634 .code
9635 ${quote_ldap:two * two}
9636 .endd
9637 returns
9638 .code
9639 two%20%5C2A%20two
9640 .endd
9641 For single-key lookup types, no quoting is ever necessary and this operator
9642 yields an unchanged string.
9643
9644
9645 .vitem &*${randint:*&<&'n'&>&*}*&
9646 .cindex "random number"
9647 This operator returns a somewhat random number which is less than the
9648 supplied number and is at least 0.  The quality of this randomness depends
9649 on how Exim was built; the values are not suitable for keying material.
9650 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
9651 Otherwise, the implementation may be arc4random(), random() seeded by
9652 srandomdev() or srandom(), or a custom implementation even weaker than
9653 random().
9654
9655
9656 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
9657 .cindex "expansion" "IP address"
9658 This operator reverses an IP address; for IPv4 addresses, the result is in
9659 dotted-quad decimal form, while for IPv6 addreses the result is in
9660 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
9661 for DNS.  For example,
9662 .code
9663 ${reverse_ip:192.0.2.4} and ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.3}
9664 .endd
9665 returns
9666 .code
9667 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
9668 .endd
9669
9670
9671 .vitem &*${rfc2047:*&<&'string'&>&*}*&
9672 .cindex "expansion" "RFC 2047"
9673 .cindex "RFC 2047" "expansion operator"
9674 .cindex "&%rfc2047%& expansion item"
9675 This operator encodes text according to the rules of RFC 2047. This is an
9676 encoding that is used in header lines to encode non-ASCII characters. It is
9677 assumed that the input string is in the encoding specified by the
9678 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
9679 contains only characters in the range 33&--126, and no instances of the
9680 characters
9681 .code
9682 ? = ( ) < > @ , ; : \ " . [ ] _
9683 .endd
9684 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
9685 string, using as many &"encoded words"& as necessary to encode all the
9686 characters.
9687
9688
9689 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
9690 .cindex "expansion" "RFC 2047"
9691 .cindex "RFC 2047" "decoding"
9692 .cindex "&%rfc2047d%& expansion item"
9693 This operator decodes strings that are encoded as per RFC 2047. Binary zero
9694 bytes are replaced by question marks. Characters are converted into the
9695 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
9696 not recognized unless &%check_rfc2047_length%& is set false.
9697
9698 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
9699 access a header line, RFC 2047 decoding is done automatically. You do not need
9700 to use this operator as well.
9701
9702
9703
9704 .vitem &*${rxquote:*&<&'string'&>&*}*&
9705 .cindex "quoting" "in regular expressions"
9706 .cindex "regular expressions" "quoting"
9707 .cindex "&%rxquote%& expansion item"
9708 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
9709 characters in its argument. This is useful when substituting the values of
9710 variables or headers inside regular expressions.
9711
9712
9713 .vitem &*${sha1:*&<&'string'&>&*}*&
9714 .cindex "SHA-1 hash"
9715 .cindex "expansion" "SHA-1 hashing"
9716 .cindex "&%sha2%& expansion item"
9717 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
9718 it as a 40-digit hexadecimal number, in which any letters are in upper case.
9719
9720
9721 .vitem &*${stat:*&<&'string'&>&*}*&
9722 .cindex "expansion" "statting a file"
9723 .cindex "file" "extracting characteristics"
9724 .cindex "&%stat%& expansion item"
9725 The string, after expansion, must be a file path. A call to the &[stat()]&
9726 function is made for this path. If &[stat()]& fails, an error occurs and the
9727 expansion fails. If it succeeds, the data from the stat replaces the item, as a
9728 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
9729 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
9730 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
9731 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
9732 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
9733 can extract individual fields using the &%extract%& expansion item.
9734
9735 The use of the &%stat%& expansion in users' filter files can be locked out by
9736 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
9737 systems for files larger than 2GB.
9738
9739 .vitem &*${str2b64:*&<&'string'&>&*}*&
9740 .cindex "expansion" "base64 encoding"
9741 .cindex "base64 encoding" "in string expansion"
9742 .cindex "&%str2b64%& expansion item"
9743 This operator converts a string into one that is base64 encoded.
9744
9745
9746
9747 .vitem &*${strlen:*&<&'string'&>&*}*&
9748 .cindex "expansion" "string length"
9749 .cindex "string" "length in expansion"
9750 .cindex "&%strlen%& expansion item"
9751 The item is replace by the length of the expanded string, expressed as a
9752 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
9753
9754
9755 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
9756 .cindex "&%substr%& expansion item"
9757 .cindex "substring extraction"
9758 .cindex "expansion" "substring expansion"
9759 The &%substr%& operator is a simpler interface to the &%substr%& function that
9760 can be used when the two parameters are fixed numbers (as opposed to strings
9761 that change when expanded). The effect is the same as
9762 .code
9763 ${substr{<start>}{<length>}{<string>}}
9764 .endd
9765 See the description of the general &%substr%& item above for details. The
9766 abbreviation &%s%& can be used when &%substr%& is used as an operator.
9767
9768 .vitem &*${time_eval:*&<&'string'&>&*}*&
9769 .cindex "&%time_eval%& expansion item"
9770 .cindex "time interval" "decoding"
9771 This item converts an Exim time interval such as &`2d4h5m`& into a number of
9772 seconds.
9773
9774 .vitem &*${time_interval:*&<&'string'&>&*}*&
9775 .cindex "&%time_interval%& expansion item"
9776 .cindex "time interval" "formatting"
9777 The argument (after sub-expansion) must be a sequence of decimal digits that
9778 represents an interval of time as a number of seconds. It is converted into a
9779 number of larger units and output in Exim's normal time format, for example,
9780 &`1w3d4h2m6s`&.
9781
9782 .vitem &*${uc:*&<&'string'&>&*}*&
9783 .cindex "case forcing in strings"
9784 .cindex "string" "case forcing"
9785 .cindex "upper casing"
9786 .cindex "expansion" "case forcing"
9787 .cindex "&%uc%& expansion item"
9788 This forces the letters in the string into upper-case.
9789 .endlist
9790
9791
9792
9793
9794
9795
9796 .section "Expansion conditions" "SECTexpcond"
9797 .scindex IIDexpcond "expansion" "conditions"
9798 The following conditions are available for testing by the &%${if%& construct
9799 while expanding strings:
9800
9801 .vlist
9802 .vitem &*!*&<&'condition'&>
9803 .cindex "expansion" "negating a condition"
9804 .cindex "negation" "in expansion condition"
9805 Preceding any condition with an exclamation mark negates the result of the
9806 condition.
9807
9808 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9809 .cindex "numeric comparison"
9810 .cindex "expansion" "numeric comparison"
9811 There are a number of symbolic operators for doing numeric comparisons. They
9812 are:
9813 .display
9814 &`=   `&   equal
9815 &`==  `&   equal
9816 &`>   `&   greater
9817 &`>=  `&   greater or equal
9818 &`<   `&   less
9819 &`<=  `&   less or equal
9820 .endd
9821 For example:
9822 .code
9823 ${if >{$message_size}{10M} ...
9824 .endd
9825 Note that the general negation operator provides for inequality testing. The
9826 two strings must take the form of optionally signed decimal integers,
9827 optionally followed by one of the letters &"K"& or &"M"& (in either upper or
9828 lower case), signifying multiplication by 1024 or 1024*1024, respectively.
9829 As a special case, the numerical value of an empty string is taken as
9830 zero.
9831
9832 .vitem &*bool&~{*&<&'string'&>&*}*&
9833 .cindex "expansion" "boolean parsing"
9834 .cindex "&%bool%& expansion condition"
9835 This condition turns a string holding a true or false representation into
9836 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
9837 (case-insensitively); also positive integer numbers map to true if non-zero,
9838 false if zero.  Leading and trailing whitespace is ignored.
9839 All other string values will result in expansion failure.
9840
9841 When combined with ACL variables, this expansion condition will let you
9842 make decisions in one place and act on those decisions in another place.
9843 For example:
9844 .code
9845 ${if bool{$acl_m_privileged_sender} ...
9846 .endd
9847
9848 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
9849 .cindex "expansion" "boolean parsing"
9850 .cindex "&%bool_lax%& expansion condition"
9851 Like &%bool%&, this condition turns a string into a boolean state.  But
9852 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
9853 loose definition that the Router &%condition%& option uses.  The empty string
9854 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
9855 true.  Leading and trailing whitespace is ignored.
9856
9857 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
9858
9859 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9860 .cindex "expansion" "encrypted comparison"
9861 .cindex "encrypted strings, comparing"
9862 .cindex "&%crypteq%& expansion condition"
9863 This condition is included in the Exim binary if it is built to support any
9864 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
9865 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
9866 included in the binary.
9867
9868 The &%crypteq%& condition has two arguments. The first is encrypted and
9869 compared against the second, which is already encrypted. The second string may
9870 be in the LDAP form for storing encrypted strings, which starts with the
9871 encryption type in curly brackets, followed by the data. If the second string
9872 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
9873 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
9874 Typically this will be a field from a password file. An example of an encrypted
9875 string in LDAP form is:
9876 .code
9877 {md5}CY9rzUYh03PK3k6DJie09g==
9878 .endd
9879 If such a string appears directly in an expansion, the curly brackets have to
9880 be quoted, because they are part of the expansion syntax. For example:
9881 .code
9882 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
9883 .endd
9884 The following encryption types (whose names are matched case-independently) are
9885 supported:
9886
9887 .ilist
9888 .cindex "MD5 hash"
9889 .cindex "base64 encoding" "in encrypted password"
9890 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
9891 printable characters to compare with the remainder of the second string. If the
9892 length of the comparison string is 24, Exim assumes that it is base64 encoded
9893 (as in the above example). If the length is 32, Exim assumes that it is a
9894 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
9895 comparison fails.
9896
9897 .next
9898 .cindex "SHA-1 hash"
9899 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
9900 printable characters to compare with the remainder of the second string. If the
9901 length of the comparison string is 28, Exim assumes that it is base64 encoded.
9902 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
9903 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
9904
9905 .next
9906 .cindex "&[crypt()]&"
9907 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
9908 only the first eight characters of the password. However, in modern operating
9909 systems this is no longer true, and in many cases the entire password is used,
9910 whatever its length.
9911
9912 .next
9913 .cindex "&[crypt16()]&"
9914 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
9915 use up to 16 characters of the password in some operating systems. Again, in
9916 modern operating systems, more characters may be used.
9917 .endlist
9918 Exim has its own version of &[crypt16()]&, which is just a double call to
9919 &[crypt()]&. For operating systems that have their own version, setting
9920 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
9921 operating system version instead of its own. This option is set by default in
9922 the OS-dependent &_Makefile_& for those operating systems that are known to
9923 support &[crypt16()]&.
9924
9925 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
9926 it was not using the same algorithm as some operating systems' versions. It
9927 turns out that as well as &[crypt16()]& there is a function called
9928 &[bigcrypt()]& in some operating systems. This may or may not use the same
9929 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
9930
9931 However, since there is now a move away from the traditional &[crypt()]&
9932 functions towards using SHA1 and other algorithms, tidying up this area of
9933 Exim is seen as very low priority.
9934
9935 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
9936 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
9937 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
9938 default is &`{crypt}`&. Whatever the default, you can always use either
9939 function by specifying it explicitly in curly brackets.
9940
9941 .vitem &*def:*&<&'variable&~name'&>
9942 .cindex "expansion" "checking for empty variable"
9943 .cindex "&%def%& expansion condition"
9944 The &%def%& condition must be followed by the name of one of the expansion
9945 variables defined in section &<<SECTexpvar>>&. The condition is true if the
9946 variable does not contain the empty string. For example:
9947 .code
9948 ${if def:sender_ident {from $sender_ident}}
9949 .endd
9950 Note that the variable name is given without a leading &%$%& character. If the
9951 variable does not exist, the expansion fails.
9952
9953 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
9954         &~&*def:h_*&<&'header&~name'&>&*:*&"
9955 .cindex "expansion" "checking header line existence"
9956 This condition is true if a message is being processed and the named header
9957 exists in the message. For example,
9958 .code
9959 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
9960 .endd
9961 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
9962 the header name must be terminated by a colon if white space does not follow.
9963
9964 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
9965        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9966 .cindex "string" "comparison"
9967 .cindex "expansion" "string comparison"
9968 .cindex "&%eq%& expansion condition"
9969 .cindex "&%eqi%& expansion condition"
9970 The two substrings are first expanded. The condition is true if the two
9971 resulting strings are identical. For &%eq%& the comparison includes the case of
9972 letters, whereas for &%eqi%& the comparison is case-independent.
9973
9974 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
9975 .cindex "expansion" "file existence test"
9976 .cindex "file" "existence test"
9977 .cindex "&%exists%&, expansion condition"
9978 The substring is first expanded and then interpreted as an absolute path. The
9979 condition is true if the named file (or directory) exists. The existence test
9980 is done by calling the &[stat()]& function. The use of the &%exists%& test in
9981 users' filter files may be locked out by the system administrator.
9982
9983 .vitem &*first_delivery*&
9984 .cindex "delivery" "first"
9985 .cindex "first delivery"
9986 .cindex "expansion" "first delivery test"
9987 .cindex "&%first_delivery%& expansion condition"
9988 This condition, which has no data, is true during a message's first delivery
9989 attempt. It is false during any subsequent delivery attempts.
9990
9991
9992 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
9993        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
9994 .cindex "list" "iterative conditions"
9995 .cindex "expansion" "&*forall*& condition"
9996 .cindex "expansion" "&*forany*& condition"
9997 .vindex "&$item$&"
9998 These conditions iterate over a list. The first argument is expanded to form
9999 the list. By default, the list separator is a colon, but it can be changed by
10000 the normal method. The second argument is interpreted as a condition that is to
10001 be applied to each item in the list in turn. During the interpretation of the
10002 condition, the current list item is placed in a variable called &$item$&.
10003 .ilist
10004 For &*forany*&, interpretation stops if the condition is true for any item, and
10005 the result of the whole condition is true. If the condition is false for all
10006 items in the list, the overall condition is false.
10007 .next
10008 For &*forall*&, interpretation stops if the condition is false for any item,
10009 and the result of the whole condition is false. If the condition is true for
10010 all items in the list, the overall condition is true.
10011 .endlist
10012 Note that negation of &*forany*& means that the condition must be false for all
10013 items for the overall condition to succeed, and negation of &*forall*& means
10014 that the condition must be false for at least one item. In this example, the
10015 list separator is changed to a comma:
10016 .code
10017 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10018 .endd
10019 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10020 being processed, to enable these expansion items to be nested.
10021
10022
10023 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10024        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10025 .cindex "string" "comparison"
10026 .cindex "expansion" "string comparison"
10027 .cindex "&%ge%& expansion condition"
10028 .cindex "&%gei%& expansion condition"
10029 The two substrings are first expanded. The condition is true if the first
10030 string is lexically greater than or equal to the second string. For &%ge%& the
10031 comparison includes the case of letters, whereas for &%gei%& the comparison is
10032 case-independent.
10033
10034 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10035        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10036 .cindex "string" "comparison"
10037 .cindex "expansion" "string comparison"
10038 .cindex "&%gt%& expansion condition"
10039 .cindex "&%gti%& expansion condition"
10040 The two substrings are first expanded. The condition is true if the first
10041 string is lexically greater than the second string. For &%gt%& the comparison
10042 includes the case of letters, whereas for &%gti%& the comparison is
10043 case-independent.
10044
10045 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10046        &*isip4&~{*&<&'string'&>&*}*& &&&
10047        &*isip6&~{*&<&'string'&>&*}*&
10048 .cindex "IP address" "testing string format"
10049 .cindex "string" "testing for IP address"
10050 .cindex "&%isip%& expansion condition"
10051 .cindex "&%isip4%& expansion condition"
10052 .cindex "&%isip6%& expansion condition"
10053 The substring is first expanded, and then tested to see if it has the form of
10054 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10055 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10056
10057 For an IPv4 address, the test is for four dot-separated components, each of
10058 which consists of from one to three digits. For an IPv6 address, up to eight
10059 colon-separated components are permitted, each containing from one to four
10060 hexadecimal digits. There may be fewer than eight components if an empty
10061 component (adjacent colons) is present. Only one empty component is permitted.
10062
10063 &*Note*&: The checks are just on the form of the address; actual numerical
10064 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10065 check. The main use of these tests is to distinguish between IP addresses and
10066 host names, or between IPv4 and IPv6 addresses. For example, you could use
10067 .code
10068 ${if isip4{$sender_host_address}...
10069 .endd
10070 to test which IP version an incoming SMTP connection is using.
10071
10072 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10073 .cindex "LDAP" "use for authentication"
10074 .cindex "expansion" "LDAP authentication test"
10075 .cindex "&%ldapauth%& expansion condition"
10076 This condition supports user authentication using LDAP. See section
10077 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10078 queries. For this use, the query must contain a user name and password. The
10079 query itself is not used, and can be empty. The condition is true if the
10080 password is not empty, and the user name and password are accepted by the LDAP
10081 server. An empty password is rejected without calling LDAP because LDAP binds
10082 with an empty password are considered anonymous regardless of the username, and
10083 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10084 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10085 this can be used.
10086
10087
10088 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10089        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10090 .cindex "string" "comparison"
10091 .cindex "expansion" "string comparison"
10092 .cindex "&%le%& expansion condition"
10093 .cindex "&%lei%& expansion condition"
10094 The two substrings are first expanded. The condition is true if the first
10095 string is lexically less than or equal to the second string. For &%le%& the
10096 comparison includes the case of letters, whereas for &%lei%& the comparison is
10097 case-independent.
10098
10099 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10100        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10101 .cindex "string" "comparison"
10102 .cindex "expansion" "string comparison"
10103 .cindex "&%lt%& expansion condition"
10104 .cindex "&%lti%& expansion condition"
10105 The two substrings are first expanded. The condition is true if the first
10106 string is lexically less than the second string. For &%lt%& the comparison
10107 includes the case of letters, whereas for &%lti%& the comparison is
10108 case-independent.
10109
10110
10111 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10112 .cindex "expansion" "regular expression comparison"
10113 .cindex "regular expressions" "match in expanded string"
10114 .cindex "&%match%& expansion condition"
10115 The two substrings are first expanded. The second is then treated as a regular
10116 expression and applied to the first. Because of the pre-expansion, if the
10117 regular expression contains dollar, or backslash characters, they must be
10118 escaped. Care must also be taken if the regular expression contains braces
10119 (curly brackets). A closing brace must be escaped so that it is not taken as a
10120 premature termination of <&'string2'&>. The easiest approach is to use the
10121 &`\N`& feature to disable expansion of the regular expression.
10122 For example,
10123 .code
10124 ${if match {$local_part}{\N^\d{3}\N} ...
10125 .endd
10126 If the whole expansion string is in double quotes, further escaping of
10127 backslashes is also required.
10128
10129 The condition is true if the regular expression match succeeds.
10130 The regular expression is not required to begin with a circumflex
10131 metacharacter, but if there is no circumflex, the expression is not anchored,
10132 and it may match anywhere in the subject, not just at the start. If you want
10133 the pattern to match at the end of the subject, you must include the &`$`&
10134 metacharacter at an appropriate point.
10135
10136 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10137 At the start of an &%if%& expansion the values of the numeric variable
10138 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10139 succeeds causes them to be reset to the substrings of that condition and they
10140 will have these values during the expansion of the success string. At the end
10141 of the &%if%& expansion, the previous values are restored. After testing a
10142 combination of conditions using &%or%&, the subsequent values of the numeric
10143 variables are those of the condition that succeeded.
10144
10145 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10146 .cindex "&%match_address%& expansion condition"
10147 See &*match_local_part*&.
10148
10149 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10150 .cindex "&%match_domain%& expansion condition"
10151 See &*match_local_part*&.
10152
10153 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10154 .cindex "&%match_ip%& expansion condition"
10155 This condition matches an IP address to a list of IP address patterns. It must
10156 be followed by two argument strings. The first (after expansion) must be an IP
10157 address or an empty string. The second (after expansion) is a restricted host
10158 list that can match only an IP address, not a host name. For example:
10159 .code
10160 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10161 .endd
10162 The specific types of host list item that are permitted in the list are:
10163
10164 .ilist
10165 An IP address, optionally with a CIDR mask.
10166 .next
10167 A single asterisk, which matches any IP address.
10168 .next
10169 An empty item, which matches only if the IP address is empty. This could be
10170 useful for testing for a locally submitted message or one from specific hosts
10171 in a single test such as
10172 . ==== As this is a nested list, any displays it contains must be indented
10173 . ==== as otherwise they are too far to the left. This comment applies to
10174 . ==== the use of xmlto plus fop. There's no problem when formatting with
10175 . ==== sdop, with or without the extra indent.
10176 .code
10177   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10178 .endd
10179 where the first item in the list is the empty string.
10180 .next
10181 The item @[] matches any of the local host's interface addresses.
10182 .next
10183 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10184 even if &`net-`& is not specified. There is never any attempt to turn the IP
10185 address into a host name. The most common type of linear search for
10186 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10187 masks. For example:
10188 .code
10189   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10190 .endd
10191 It is of course possible to use other kinds of lookup, and in such a case, you
10192 do need to specify the &`net-`& prefix if you want to specify a specific
10193 address mask, for example:
10194 .code
10195   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10196 .endd
10197 However, unless you are combining a &%match_ip%& condition with others, it is
10198 just as easy to use the fact that a lookup is itself a condition, and write:
10199 .code
10200   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10201 .endd
10202 .endlist ilist
10203
10204 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10205
10206 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10207 .cindex "domain list" "in expansion condition"
10208 .cindex "address list" "in expansion condition"
10209 .cindex "local part" "list, in expansion condition"
10210 .cindex "&%match_local_part%& expansion condition"
10211 This condition, together with &%match_address%& and &%match_domain%&, make it
10212 possible to test domain, address, and local part lists within expansions. Each
10213 condition requires two arguments: an item and a list to match. A trivial
10214 example is:
10215 .code
10216 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10217 .endd
10218 In each case, the second argument may contain any of the allowable items for a
10219 list of the appropriate type. Also, because the second argument (after
10220 expansion) is a standard form of list, it is possible to refer to a named list.
10221 Thus, you can use conditions like this:
10222 .code
10223 ${if match_domain{$domain}{+local_domains}{...
10224 .endd
10225 .cindex "&`+caseful`&"
10226 For address lists, the matching starts off caselessly, but the &`+caseful`&
10227 item can be used, as in all address lists, to cause subsequent items to
10228 have their local parts matched casefully. Domains are always matched
10229 caselessly.
10230
10231 &*Note*&: Host lists are &'not'& supported in this way. This is because
10232 hosts have two identities: a name and an IP address, and it is not clear
10233 how to specify cleanly how such a test would work. However, IP addresses can be
10234 matched using &%match_ip%&.
10235
10236 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10237 .cindex "PAM authentication"
10238 .cindex "AUTH" "with PAM"
10239 .cindex "Solaris" "PAM support"
10240 .cindex "expansion" "PAM authentication test"
10241 .cindex "&%pam%& expansion condition"
10242 &'Pluggable Authentication Modules'&
10243 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10244 available in the latest releases of Solaris and in some GNU/Linux
10245 distributions. The Exim support, which is intended for use in conjunction with
10246 the SMTP AUTH command, is available only if Exim is compiled with
10247 .code
10248 SUPPORT_PAM=yes
10249 .endd
10250 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10251 in some releases of GNU/Linux &%-ldl%& is also needed.
10252
10253 The argument string is first expanded, and the result must be a
10254 colon-separated list of strings. Leading and trailing white space is ignored.
10255 The PAM module is initialized with the service name &"exim"& and the user name
10256 taken from the first item in the colon-separated data string (<&'string1'&>).
10257 The remaining items in the data string are passed over in response to requests
10258 from the authentication function. In the simple case there will only be one
10259 request, for a password, so the data consists of just two strings.
10260
10261 There can be problems if any of the strings are permitted to contain colon
10262 characters. In the usual way, these have to be doubled to avoid being taken as
10263 separators. If the data is being inserted from a variable, the &%sg%& expansion
10264 item can be used to double any existing colons. For example, the configuration
10265 of a LOGIN authenticator might contain this setting:
10266 .code
10267 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10268 .endd
10269 For a PLAIN authenticator you could use:
10270 .code
10271 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10272 .endd
10273 In some operating systems, PAM authentication can be done only from a process
10274 running as root. Since Exim is running as the Exim user when receiving
10275 messages, this means that PAM cannot be used directly in those systems.
10276 A patched version of the &'pam_unix'& module that comes with the
10277 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10278 The patched module allows one special uid/gid combination, in addition to root,
10279 to authenticate. If you build the patched module to allow the Exim user and
10280 group, PAM can then be used from an Exim authenticator.
10281
10282
10283 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10284 .cindex "&'pwcheck'& daemon"
10285 .cindex "Cyrus"
10286 .cindex "expansion" "&'pwcheck'& authentication test"
10287 .cindex "&%pwcheck%& expansion condition"
10288 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10289 This is one way of making it possible for passwords to be checked by a process
10290 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10291 deprecated. Its replacement is &'saslauthd'& (see below).
10292
10293 The pwcheck support is not included in Exim by default. You need to specify
10294 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10295 building Exim. For example:
10296 .code
10297 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10298 .endd
10299 You do not need to install the full Cyrus software suite in order to use
10300 the pwcheck daemon. You can compile and install just the daemon alone
10301 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10302 access to the &_/var/pwcheck_& directory.
10303
10304 The &%pwcheck%& condition takes one argument, which must be the user name and
10305 password, separated by a colon. For example, in a LOGIN authenticator
10306 configuration, you might have this:
10307 .code
10308 server_condition = ${if pwcheck{$auth1:$auth2}}
10309 .endd
10310 Again, for a PLAIN authenticator configuration, this would be:
10311 .code
10312 server_condition = ${if pwcheck{$auth2:$auth3}}
10313 .endd
10314 .vitem &*queue_running*&
10315 .cindex "queue runner" "detecting when delivering from"
10316 .cindex "expansion" "queue runner test"
10317 .cindex "&%queue_running%& expansion condition"
10318 This condition, which has no data, is true during delivery attempts that are
10319 initiated by queue runner processes, and false otherwise.
10320
10321
10322 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10323 .cindex "Radius"
10324 .cindex "expansion" "Radius authentication"
10325 .cindex "&%radius%& expansion condition"
10326 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10327 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10328 the Radius client configuration file in order to build Exim with Radius
10329 support.
10330
10331 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10332 library, using the original API. If you are using release 0.4.0 or later of
10333 this library, you need to set
10334 .code
10335 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10336 .endd
10337 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10338 &%libradius%& library that comes with FreeBSD. To do this, set
10339 .code
10340 RADIUS_LIB_TYPE=RADLIB
10341 .endd
10342 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10343 You may also have to supply a suitable setting in EXTRALIBS so that the
10344 Radius library can be found when Exim is linked.
10345
10346 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10347 Radius client library, which calls the Radius server. The condition is true if
10348 the authentication is successful. For example:
10349 .code
10350 server_condition = ${if radius{<arguments>}}
10351 .endd
10352
10353
10354 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10355         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10356 .cindex "&'saslauthd'& daemon"
10357 .cindex "Cyrus"
10358 .cindex "expansion" "&'saslauthd'& authentication test"
10359 .cindex "&%saslauthd%& expansion condition"
10360 This condition supports user authentication using the Cyrus &'saslauthd'&
10361 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10362 Using this daemon is one way of making it possible for passwords to be checked
10363 by a process that is not running as root.
10364
10365 The saslauthd support is not included in Exim by default. You need to specify
10366 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10367 building Exim. For example:
10368 .code
10369 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10370 .endd
10371 You do not need to install the full Cyrus software suite in order to use
10372 the saslauthd daemon. You can compile and install just the daemon alone
10373 from the Cyrus SASL library.
10374
10375 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10376 two are mandatory. For example:
10377 .code
10378 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10379 .endd
10380 The service and the realm are optional (which is why the arguments are enclosed
10381 in their own set of braces). For details of the meaning of the service and
10382 realm, and how to run the daemon, consult the Cyrus documentation.
10383 .endlist vlist
10384
10385
10386
10387 .section "Combining expansion conditions" "SECID84"
10388 .cindex "expansion" "combining conditions"
10389 Several conditions can be tested at once by combining them using the &%and%&
10390 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10391 conditions on their own, and precede their lists of sub-conditions. Each
10392 sub-condition must be enclosed in braces within the overall braces that contain
10393 the list. No repetition of &%if%& is used.
10394
10395
10396 .vlist
10397 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10398 .cindex "&""or""& expansion condition"
10399 .cindex "expansion" "&""or""& of conditions"
10400 The sub-conditions are evaluated from left to right. The condition is true if
10401 any one of the sub-conditions is true.
10402 For example,
10403 .code
10404 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10405 .endd
10406 When a true sub-condition is found, the following ones are parsed but not
10407 evaluated. If there are several &"match"& sub-conditions the values of the
10408 numeric variables afterwards are taken from the first one that succeeds.
10409
10410 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10411 .cindex "&""and""& expansion condition"
10412 .cindex "expansion" "&""and""& of conditions"
10413 The sub-conditions are evaluated from left to right. The condition is true if
10414 all of the sub-conditions are true. If there are several &"match"&
10415 sub-conditions, the values of the numeric variables afterwards are taken from
10416 the last one. When a false sub-condition is found, the following ones are
10417 parsed but not evaluated.
10418 .endlist
10419 .ecindex IIDexpcond
10420
10421
10422
10423
10424 .section "Expansion variables" "SECTexpvar"
10425 .cindex "expansion" "variables, list of"
10426 This section contains an alphabetical list of all the expansion variables. Some
10427 of them are available only when Exim is compiled with specific options such as
10428 support for TLS or the content scanning extension.
10429
10430 .vlist
10431 .vitem "&$0$&, &$1$&, etc"
10432 .cindex "numerical variables (&$1$& &$2$& etc)"
10433 When a &%match%& expansion condition succeeds, these variables contain the
10434 captured substrings identified by the regular expression during subsequent
10435 processing of the success string of the containing &%if%& expansion item.
10436 However, they do not retain their values afterwards; in fact, their previous
10437 values are restored at the end of processing an &%if%& item. The numerical
10438 variables may also be set externally by some other matching process which
10439 precedes the expansion of the string. For example, the commands available in
10440 Exim filter files include an &%if%& command with its own regular expression
10441 matching condition.
10442
10443 .vitem "&$acl_c...$&"
10444 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10445 can be given any name that starts with &$acl_c$& and is at least six characters
10446 long, but the sixth character must be either a digit or an underscore. For
10447 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10448 variables persist throughout the lifetime of an SMTP connection. They can be
10449 used to pass information between ACLs and between different invocations of the
10450 same ACL. When a message is received, the values of these variables are saved
10451 with the message, and can be accessed by filters, routers, and transports
10452 during subsequent delivery.
10453
10454 .vitem "&$acl_m...$&"
10455 These variables are like the &$acl_c...$& variables, except that their values
10456 are reset after a message has been received. Thus, if several messages are
10457 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10458 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10459 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10460 message is received, the values of these variables are saved with the message,
10461 and can be accessed by filters, routers, and transports during subsequent
10462 delivery.
10463
10464 .vitem &$acl_verify_message$&
10465 .vindex "&$acl_verify_message$&"
10466 After an address verification has failed, this variable contains the failure
10467 message. It retains its value for use in subsequent modifiers. The message can
10468 be preserved by coding like this:
10469 .code
10470 warn !verify = sender
10471      set acl_m0 = $acl_verify_message
10472 .endd
10473 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10474 &%log_message%& modifiers, to include information about the verification
10475 failure.
10476
10477 .vitem &$address_data$&
10478 .vindex "&$address_data$&"
10479 This variable is set by means of the &%address_data%& option in routers. The
10480 value then remains with the address while it is processed by subsequent routers
10481 and eventually a transport. If the transport is handling multiple addresses,
10482 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10483 for more details. &*Note*&: The contents of &$address_data$& are visible in
10484 user filter files.
10485
10486 If &$address_data$& is set when the routers are called from an ACL to verify
10487 a recipient address, the final value is still in the variable for subsequent
10488 conditions and modifiers of the ACL statement. If routing the address caused it
10489 to be redirected to just one address, the child address is also routed as part
10490 of the verification, and in this case the final value of &$address_data$& is
10491 from the child's routing.
10492
10493 If &$address_data$& is set when the routers are called from an ACL to verify a
10494 sender address, the final value is also preserved, but this time in
10495 &$sender_address_data$&, to distinguish it from data from a recipient
10496 address.
10497
10498 In both cases (recipient and sender verification), the value does not persist
10499 after the end of the current ACL statement. If you want to preserve
10500 these values for longer, you can save them in ACL variables.
10501
10502 .vitem &$address_file$&
10503 .vindex "&$address_file$&"
10504 When, as a result of aliasing, forwarding, or filtering, a message is directed
10505 to a specific file, this variable holds the name of the file when the transport
10506 is running. At other times, the variable is empty. For example, using the
10507 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10508 .code
10509 /home/r2d2/savemail
10510 .endd
10511 then when the &(address_file)& transport is running, &$address_file$&
10512 contains the text string &`/home/r2d2/savemail`&.
10513 .cindex "Sieve filter" "value of &$address_file$&"
10514 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10515 then up to the transport configuration to generate an appropriate absolute path
10516 to the relevant file.
10517
10518 .vitem &$address_pipe$&
10519 .vindex "&$address_pipe$&"
10520 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10521 this variable holds the pipe command when the transport is running.
10522
10523 .vitem "&$auth1$& &-- &$auth3$&"
10524 .vindex "&$auth1$&, &$auth2$&, etc"
10525 These variables are used in SMTP authenticators (see chapters
10526 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10527
10528 .vitem &$authenticated_id$&
10529 .cindex "authentication" "id"
10530 .vindex "&$authenticated_id$&"
10531 When a server successfully authenticates a client it may be configured to
10532 preserve some of the authentication information in the variable
10533 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10534 user/password authenticator configuration might preserve the user name for use
10535 in the routers. Note that this is not the same information that is saved in
10536 &$sender_host_authenticated$&.
10537 When a message is submitted locally (that is, not over a TCP connection)
10538 the value of &$authenticated_id$& is normally the login name of the calling
10539 process. However, a trusted user can override this by means of the &%-oMai%&
10540 command line option.
10541
10542
10543
10544
10545 .vitem &$authenticated_sender$&
10546 .cindex "sender" "authenticated"
10547 .cindex "authentication" "sender"
10548 .cindex "AUTH" "on MAIL command"
10549 .vindex "&$authenticated_sender$&"
10550 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10551 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10552 described in section &<<SECTauthparamail>>&. Unless the data is the string
10553 &"<>"&, it is set as the authenticated sender of the message, and the value is
10554 available during delivery in the &$authenticated_sender$& variable. If the
10555 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10556
10557 .vindex "&$qualify_domain$&"
10558 When a message is submitted locally (that is, not over a TCP connection), the
10559 value of &$authenticated_sender$& is an address constructed from the login
10560 name of the calling process and &$qualify_domain$&, except that a trusted user
10561 can override this by means of the &%-oMas%& command line option.
10562
10563
10564 .vitem &$authentication_failed$&
10565 .cindex "authentication" "failure"
10566 .vindex "&$authentication_failed$&"
10567 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10568 command that does not succeed. Otherwise it is set to &"0"&. This makes it
10569 possible to distinguish between &"did not try to authenticate"&
10570 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
10571 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
10572 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
10573 negative response to an AUTH command, including (for example) an attempt to use
10574 an undefined mechanism.
10575
10576 .vitem &$body_linecount$&
10577 .cindex "message body" "line count"
10578 .cindex "body of message" "line count"
10579 .vindex "&$body_linecount$&"
10580 When a message is being received or delivered, this variable contains the
10581 number of lines in the message's body. See also &$message_linecount$&.
10582
10583 .vitem &$body_zerocount$&
10584 .cindex "message body" "binary zero count"
10585 .cindex "body of message" "binary zero count"
10586 .cindex "binary zero" "in message body"
10587 .vindex "&$body_zerocount$&"
10588 When a message is being received or delivered, this variable contains the
10589 number of binary zero bytes in the message's body.
10590
10591 .vitem &$bounce_recipient$&
10592 .vindex "&$bounce_recipient$&"
10593 This is set to the recipient address of a bounce message while Exim is creating
10594 it. It is useful if a customized bounce message text file is in use (see
10595 chapter &<<CHAPemsgcust>>&).
10596
10597 .vitem &$bounce_return_size_limit$&
10598 .vindex "&$bounce_return_size_limit$&"
10599 This contains the value set in the &%bounce_return_size_limit%& option, rounded
10600 up to a multiple of 1000. It is useful when a customized error message text
10601 file is in use (see chapter &<<CHAPemsgcust>>&).
10602
10603 .vitem &$caller_gid$&
10604 .cindex "gid (group id)" "caller"
10605 .vindex "&$caller_gid$&"
10606 The real group id under which the process that called Exim was running. This is
10607 not the same as the group id of the originator of a message (see
10608 &$originator_gid$&). If Exim re-execs itself, this variable in the new
10609 incarnation normally contains the Exim gid.
10610
10611 .vitem &$caller_uid$&
10612 .cindex "uid (user id)" "caller"
10613 .vindex "&$caller_uid$&"
10614 The real user id under which the process that called Exim was running. This is
10615 not the same as the user id of the originator of a message (see
10616 &$originator_uid$&). If Exim re-execs itself, this variable in the new
10617 incarnation normally contains the Exim uid.
10618
10619 .vitem &$compile_date$&
10620 .vindex "&$compile_date$&"
10621 The date on which the Exim binary was compiled.
10622
10623 .vitem &$compile_number$&
10624 .vindex "&$compile_number$&"
10625 The building process for Exim keeps a count of the number
10626 of times it has been compiled. This serves to distinguish different
10627 compilations of the same version of the program.
10628
10629 .vitem &$demime_errorlevel$&
10630 .vindex "&$demime_errorlevel$&"
10631 This variable is available when Exim is compiled with
10632 the content-scanning extension and the obsolete &%demime%& condition. For
10633 details, see section &<<SECTdemimecond>>&.
10634
10635 .vitem &$demime_reason$&
10636 .vindex "&$demime_reason$&"
10637 This variable is available when Exim is compiled with the
10638 content-scanning extension and the obsolete &%demime%& condition. For details,
10639 see section &<<SECTdemimecond>>&.
10640
10641 .vitem &$dnslist_domain$& &&&
10642        &$dnslist_matched$& &&&
10643        &$dnslist_text$& &&&
10644        &$dnslist_value$&
10645 .vindex "&$dnslist_domain$&"
10646 .vindex "&$dnslist_matched$&"
10647 .vindex "&$dnslist_text$&"
10648 .vindex "&$dnslist_value$&"
10649 .cindex "black list (DNS)"
10650 When a DNS (black) list lookup succeeds, these variables are set to contain
10651 the following data from the lookup: the list's domain name, the key that was
10652 looked up, the contents of any associated TXT record, and the value from the
10653 main A record. See section &<<SECID204>>& for more details.
10654
10655 .vitem &$domain$&
10656 .vindex "&$domain$&"
10657 When an address is being routed, or delivered on its own, this variable
10658 contains the domain. Uppercase letters in the domain are converted into lower
10659 case for &$domain$&.
10660
10661 Global address rewriting happens when a message is received, so the value of
10662 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
10663 is set during user filtering, but not during system filtering, because a
10664 message may have many recipients and the system filter is called just once.
10665
10666 When more than one address is being delivered at once (for example, several
10667 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
10668 have the same domain. Transports can be restricted to handling only one domain
10669 at a time if the value of &$domain$& is required at transport time &-- this is
10670 the default for local transports. For further details of the environment in
10671 which local transports are run, see chapter &<<CHAPenvironment>>&.
10672
10673 .oindex "&%delay_warning_condition%&"
10674 At the end of a delivery, if all deferred addresses have the same domain, it is
10675 set in &$domain$& during the expansion of &%delay_warning_condition%&.
10676
10677 The &$domain$& variable is also used in some other circumstances:
10678
10679 .ilist
10680 When an ACL is running for a RCPT command, &$domain$& contains the domain of
10681 the recipient address. The domain of the &'sender'& address is in
10682 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
10683 normally set during the running of the MAIL ACL. However, if the sender address
10684 is verified with a callout during the MAIL ACL, the sender domain is placed in
10685 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
10686 the &(smtp)& transport.
10687
10688 .next
10689 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10690 &$domain$& contains the domain portion of the address that is being rewritten;
10691 it can be used in the expansion of the replacement address, for example, to
10692 rewrite domains by file lookup.
10693
10694 .next
10695 With one important exception, whenever a domain list is being scanned,
10696 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
10697 a &%sender_domains%& condition in an ACL is being processed, the subject domain
10698 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
10699 that, in a RCPT ACL, the sender domain list can be dependent on the
10700 recipient domain (which is what is in &$domain$& at this time).
10701
10702 .next
10703 .cindex "ETRN" "value of &$domain$&"
10704 .oindex "&%smtp_etrn_command%&"
10705 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
10706 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
10707 .endlist
10708
10709
10710 .vitem &$domain_data$&
10711 .vindex "&$domain_data$&"
10712 When the &%domains%& option on a router matches a domain by
10713 means of a lookup, the data read by the lookup is available during the running
10714 of the router as &$domain_data$&. In addition, if the driver routes the
10715 address to a transport, the value is available in that transport. If the
10716 transport is handling multiple addresses, the value from the first address is
10717 used.
10718
10719 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
10720 domain by means of a lookup. The data read by the lookup is available during
10721 the rest of the ACL statement. In all other situations, this variable expands
10722 to nothing.
10723
10724 .vitem &$exim_gid$&
10725 .vindex "&$exim_gid$&"
10726 This variable contains the numerical value of the Exim group id.
10727
10728 .vitem &$exim_path$&
10729 .vindex "&$exim_path$&"
10730 This variable contains the path to the Exim binary.
10731
10732 .vitem &$exim_uid$&
10733 .vindex "&$exim_uid$&"
10734 This variable contains the numerical value of the Exim user id.
10735
10736 .vitem &$found_extension$&
10737 .vindex "&$found_extension$&"
10738 This variable is available when Exim is compiled with the
10739 content-scanning extension and the obsolete &%demime%& condition. For details,
10740 see section &<<SECTdemimecond>>&.
10741
10742 .vitem &$header_$&<&'name'&>
10743 This is not strictly an expansion variable. It is expansion syntax for
10744 inserting the message header line with the given name. Note that the name must
10745 be terminated by colon or white space, because it may contain a wide variety of
10746 characters. Note also that braces must &'not'& be used.
10747
10748 .vitem &$home$&
10749 .vindex "&$home$&"
10750 When the &%check_local_user%& option is set for a router, the user's home
10751 directory is placed in &$home$& when the check succeeds. In particular, this
10752 means it is set during the running of users' filter files. A router may also
10753 explicitly set a home directory for use by a transport; this can be overridden
10754 by a setting on the transport itself.
10755
10756 When running a filter test via the &%-bf%& option, &$home$& is set to the value
10757 of the environment variable HOME.
10758
10759 .vitem &$host$&
10760 .vindex "&$host$&"
10761 If a router assigns an address to a transport (any transport), and passes a
10762 list of hosts with the address, the value of &$host$& when the transport starts
10763 to run is the name of the first host on the list. Note that this applies both
10764 to local and remote transports.
10765
10766 .cindex "transport" "filter"
10767 .cindex "filter" "transport filter"
10768 For the &(smtp)& transport, if there is more than one host, the value of
10769 &$host$& changes as the transport works its way through the list. In
10770 particular, when the &(smtp)& transport is expanding its options for encryption
10771 using TLS, or for specifying a transport filter (see chapter
10772 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
10773 is connected.
10774
10775 When used in the client part of an authenticator configuration (see chapter
10776 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
10777 client is connected.
10778
10779
10780 .vitem &$host_address$&
10781 .vindex "&$host_address$&"
10782 This variable is set to the remote host's IP address whenever &$host$& is set
10783 for a remote connection. It is also set to the IP address that is being checked
10784 when the &%ignore_target_hosts%& option is being processed.
10785
10786 .vitem &$host_data$&
10787 .vindex "&$host_data$&"
10788 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
10789 result of the lookup is made available in the &$host_data$& variable. This
10790 allows you, for example, to do things like this:
10791 .code
10792 deny  hosts = net-lsearch;/some/file
10793 message = $host_data
10794 .endd
10795 .vitem &$host_lookup_deferred$&
10796 .cindex "host name" "lookup, failure of"
10797 .vindex "&$host_lookup_deferred$&"
10798 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
10799 message comes from a remote host and there is an attempt to look up the host's
10800 name from its IP address, and the attempt is not successful, one of these
10801 variables is set to &"1"&.
10802
10803 .ilist
10804 If the lookup receives a definite negative response (for example, a DNS lookup
10805 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
10806
10807 .next
10808 If there is any kind of problem during the lookup, such that Exim cannot
10809 tell whether or not the host name is defined (for example, a timeout for a DNS
10810 lookup), &$host_lookup_deferred$& is set to &"1"&.
10811 .endlist ilist
10812
10813 Looking up a host's name from its IP address consists of more than just a
10814 single reverse lookup. Exim checks that a forward lookup of at least one of the
10815 names it receives from a reverse lookup yields the original IP address. If this
10816 is not the case, Exim does not accept the looked up name(s), and
10817 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
10818 IP address (for example, the existence of a PTR record in the DNS) is not
10819 sufficient on its own for the success of a host name lookup. If the reverse
10820 lookup succeeds, but there is a lookup problem such as a timeout when checking
10821 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
10822 &"1"&. See also &$sender_host_name$&.
10823
10824 .vitem &$host_lookup_failed$&
10825 .vindex "&$host_lookup_failed$&"
10826 See &$host_lookup_deferred$&.
10827
10828
10829 .vitem &$inode$&
10830 .vindex "&$inode$&"
10831 The only time this variable is set is while expanding the &%directory_file%&
10832 option in the &(appendfile)& transport. The variable contains the inode number
10833 of the temporary file which is about to be renamed. It can be used to construct
10834 a unique name for the file.
10835
10836 .vitem &$interface_address$&
10837 .vindex "&$interface_address$&"
10838 This is an obsolete name for &$received_ip_address$&.
10839
10840 .vitem &$interface_port$&
10841 .vindex "&$interface_port$&"
10842 This is an obsolete name for &$received_port$&.
10843
10844 .vitem &$item$&
10845 .vindex "&$item$&"
10846 This variable is used during the expansion of &*forall*& and &*forany*&
10847 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
10848 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
10849 empty.
10850
10851 .vitem &$ldap_dn$&
10852 .vindex "&$ldap_dn$&"
10853 This variable, which is available only when Exim is compiled with LDAP support,
10854 contains the DN from the last entry in the most recently successful LDAP
10855 lookup.
10856
10857 .vitem &$load_average$&
10858 .vindex "&$load_average$&"
10859 This variable contains the system load average, multiplied by 1000 so that it
10860 is an integer. For example, if the load average is 0.21, the value of the
10861 variable is 210. The value is recomputed every time the variable is referenced.
10862
10863 .vitem &$local_part$&
10864 .vindex "&$local_part$&"
10865 When an address is being routed, or delivered on its own, this
10866 variable contains the local part. When a number of addresses are being
10867 delivered together (for example, multiple RCPT commands in an SMTP
10868 session), &$local_part$& is not set.
10869
10870 Global address rewriting happens when a message is received, so the value of
10871 &$local_part$& during routing and delivery is the value after rewriting.
10872 &$local_part$& is set during user filtering, but not during system filtering,
10873 because a message may have many recipients and the system filter is called just
10874 once.
10875
10876 .vindex "&$local_part_prefix$&"
10877 .vindex "&$local_part_suffix$&"
10878 If a local part prefix or suffix has been recognized, it is not included in the
10879 value of &$local_part$& during routing and subsequent delivery. The values of
10880 any prefix or suffix are in &$local_part_prefix$& and
10881 &$local_part_suffix$&, respectively.
10882
10883 When a message is being delivered to a file, pipe, or autoreply transport as a
10884 result of aliasing or forwarding, &$local_part$& is set to the local part of
10885 the parent address, not to the file name or command (see &$address_file$& and
10886 &$address_pipe$&).
10887
10888 When an ACL is running for a RCPT command, &$local_part$& contains the
10889 local part of the recipient address.
10890
10891 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10892 &$local_part$& contains the local part of the address that is being rewritten;
10893 it can be used in the expansion of the replacement address, for example.
10894
10895 In all cases, all quoting is removed from the local part. For example, for both
10896 the addresses
10897 .code
10898 "abc:xyz"@test.example
10899 abc\:xyz@test.example
10900 .endd
10901 the value of &$local_part$& is
10902 .code
10903 abc:xyz
10904 .endd
10905 If you use &$local_part$& to create another address, you should always wrap it
10906 inside a quoting operator. For example, in a &(redirect)& router you could
10907 have:
10908 .code
10909 data = ${quote_local_part:$local_part}@new.domain.example
10910 .endd
10911 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
10912 to process local parts in a case-dependent manner in a router, you can set the
10913 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
10914
10915 .vitem &$local_part_data$&
10916 .vindex "&$local_part_data$&"
10917 When the &%local_parts%& option on a router matches a local part by means of a
10918 lookup, the data read by the lookup is available during the running of the
10919 router as &$local_part_data$&. In addition, if the driver routes the address
10920 to a transport, the value is available in that transport. If the transport is
10921 handling multiple addresses, the value from the first address is used.
10922
10923 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
10924 matches a local part by means of a lookup. The data read by the lookup is
10925 available during the rest of the ACL statement. In all other situations, this
10926 variable expands to nothing.
10927
10928 .vitem &$local_part_prefix$&
10929 .vindex "&$local_part_prefix$&"
10930 When an address is being routed or delivered, and a
10931 specific prefix for the local part was recognized, it is available in this
10932 variable, having been removed from &$local_part$&.
10933
10934 .vitem &$local_part_suffix$&
10935 .vindex "&$local_part_suffix$&"
10936 When an address is being routed or delivered, and a
10937 specific suffix for the local part was recognized, it is available in this
10938 variable, having been removed from &$local_part$&.
10939
10940 .vitem &$local_scan_data$&
10941 .vindex "&$local_scan_data$&"
10942 This variable contains the text returned by the &[local_scan()]& function when
10943 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
10944
10945 .vitem &$local_user_gid$&
10946 .vindex "&$local_user_gid$&"
10947 See &$local_user_uid$&.
10948
10949 .vitem &$local_user_uid$&
10950 .vindex "&$local_user_uid$&"
10951 This variable and &$local_user_gid$& are set to the uid and gid after the
10952 &%check_local_user%& router precondition succeeds. This means that their values
10953 are available for the remaining preconditions (&%senders%&, &%require_files%&,
10954 and &%condition%&), for the &%address_data%& expansion, and for any
10955 router-specific expansions. At all other times, the values in these variables
10956 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
10957
10958 .vitem &$localhost_number$&
10959 .vindex "&$localhost_number$&"
10960 This contains the expanded value of the
10961 &%localhost_number%& option. The expansion happens after the main options have
10962 been read.
10963
10964 .vitem &$log_inodes$&
10965 .vindex "&$log_inodes$&"
10966 The number of free inodes in the disk partition where Exim's
10967 log files are being written. The value is recalculated whenever the variable is
10968 referenced. If the relevant file system does not have the concept of inodes,
10969 the value of is -1. See also the &%check_log_inodes%& option.
10970
10971 .vitem &$log_space$&
10972 .vindex "&$log_space$&"
10973 The amount of free space (as a number of kilobytes) in the disk
10974 partition where Exim's log files are being written. The value is recalculated
10975 whenever the variable is referenced. If the operating system does not have the
10976 ability to find the amount of free space (only true for experimental systems),
10977 the space value is -1. See also the &%check_log_space%& option.
10978
10979
10980 .vitem &$mailstore_basename$&
10981 .vindex "&$mailstore_basename$&"
10982 This variable is set only when doing deliveries in &"mailstore"& format in the
10983 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
10984 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
10985 contains the basename of the files that are being written, that is, the name
10986 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
10987 variable is empty.
10988
10989 .vitem &$malware_name$&
10990 .vindex "&$malware_name$&"
10991 This variable is available when Exim is compiled with the
10992 content-scanning extension. It is set to the name of the virus that was found
10993 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
10994
10995 .vitem &$max_received_linelength$&
10996 .vindex "&$max_received_linelength$&"
10997 .cindex "maximum" "line length"
10998 .cindex "line length" "maximum"
10999 This variable contains the number of bytes in the longest line that was
11000 received as part of the message, not counting the line termination
11001 character(s).
11002
11003 .vitem &$message_age$&
11004 .cindex "message" "age of"
11005 .vindex "&$message_age$&"
11006 This variable is set at the start of a delivery attempt to contain the number
11007 of seconds since the message was received. It does not change during a single
11008 delivery attempt.
11009
11010 .vitem &$message_body$&
11011 .cindex "body of message" "expansion variable"
11012 .cindex "message body" "in expansion"
11013 .cindex "binary zero" "in message body"
11014 .vindex "&$message_body$&"
11015 .oindex "&%message_body_visible%&"
11016 This variable contains the initial portion of a message's body while it is
11017 being delivered, and is intended mainly for use in filter files. The maximum
11018 number of characters of the body that are put into the variable is set by the
11019 &%message_body_visible%& configuration option; the default is 500.
11020
11021 .oindex "&%message_body_newlines%&"
11022 By default, newlines are converted into spaces in &$message_body$&, to make it
11023 easier to search for phrases that might be split over a line break. However,
11024 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11025 zeros are always converted into spaces.
11026
11027 .vitem &$message_body_end$&
11028 .cindex "body of message" "expansion variable"
11029 .cindex "message body" "in expansion"
11030 .vindex "&$message_body_end$&"
11031 This variable contains the final portion of a message's
11032 body while it is being delivered. The format and maximum size are as for
11033 &$message_body$&.
11034
11035 .vitem &$message_body_size$&
11036 .cindex "body of message" "size"
11037 .cindex "message body" "size"
11038 .vindex "&$message_body_size$&"
11039 When a message is being delivered, this variable contains the size of the body
11040 in bytes. The count starts from the character after the blank line that
11041 separates the body from the header. Newlines are included in the count. See
11042 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11043
11044 .vitem &$message_exim_id$&
11045 .vindex "&$message_exim_id$&"
11046 When a message is being received or delivered, this variable contains the
11047 unique message id that is generated and used by Exim to identify the message.
11048 An id is not created for a message until after its header has been successfully
11049 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11050 line; it is the local id that Exim assigns to the message, for example:
11051 &`1BXTIK-0001yO-VA`&.
11052
11053 .vitem &$message_headers$&
11054 .vindex &$message_headers$&
11055 This variable contains a concatenation of all the header lines when a message
11056 is being processed, except for lines added by routers or transports. The header
11057 lines are separated by newline characters. Their contents are decoded in the
11058 same way as a header line that is inserted by &%bheader%&.
11059
11060 .vitem &$message_headers_raw$&
11061 .vindex &$message_headers_raw$&
11062 This variable is like &$message_headers$& except that no processing of the
11063 contents of header lines is done.
11064
11065 .vitem &$message_id$&
11066 This is an old name for &$message_exim_id$&, which is now deprecated.
11067
11068 .vitem &$message_linecount$&
11069 .vindex "&$message_linecount$&"
11070 This variable contains the total number of lines in the header and body of the
11071 message. Compare &$body_linecount$&, which is the count for the body only.
11072 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11073 number of lines received. Before delivery happens (that is, before filters,
11074 routers, and transports run) the count is increased to include the
11075 &'Received:'& header line that Exim standardly adds, and also any other header
11076 lines that are added by ACLs. The blank line that separates the message header
11077 from the body is not counted. Here is an example of the use of this variable in
11078 a DATA ACL:
11079 .code
11080 deny message   = Too many lines in message header
11081      condition = \
11082       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11083 .endd
11084 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11085 message has not yet been received.
11086
11087 .vitem &$message_size$&
11088 .cindex "size" "of message"
11089 .cindex "message" "size"
11090 .vindex "&$message_size$&"
11091 When a message is being processed, this variable contains its size in bytes. In
11092 most cases, the size includes those headers that were received with the
11093 message, but not those (such as &'Envelope-to:'&) that are added to individual
11094 deliveries as they are written. However, there is one special case: during the
11095 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11096 doing a delivery in maildir format, the value of &$message_size$& is the
11097 precise size of the file that has been written. See also
11098 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11099
11100 .cindex "RCPT" "value of &$message_size$&"
11101 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11102 contains the size supplied on the MAIL command, or -1 if no size was given. The
11103 value may not, of course, be truthful.
11104
11105 .vitem &$mime_$&&'xxx'&
11106 A number of variables whose names start with &$mime$& are
11107 available when Exim is compiled with the content-scanning extension. For
11108 details, see section &<<SECTscanmimepart>>&.
11109
11110 .vitem "&$n0$& &-- &$n9$&"
11111 These variables are counters that can be incremented by means
11112 of the &%add%& command in filter files.
11113
11114 .vitem &$original_domain$&
11115 .vindex "&$domain$&"
11116 .vindex "&$original_domain$&"
11117 When a top-level address is being processed for delivery, this contains the
11118 same value as &$domain$&. However, if a &"child"& address (for example,
11119 generated by an alias, forward, or filter file) is being processed, this
11120 variable contains the domain of the original address (lower cased). This
11121 differs from &$parent_domain$& only when there is more than one level of
11122 aliasing or forwarding. When more than one address is being delivered in a
11123 single transport run, &$original_domain$& is not set.
11124
11125 If a new address is created by means of a &%deliver%& command in a system
11126 filter, it is set up with an artificial &"parent"& address. This has the local
11127 part &'system-filter'& and the default qualify domain.
11128
11129 .vitem &$original_local_part$&
11130 .vindex "&$local_part$&"
11131 .vindex "&$original_local_part$&"
11132 When a top-level address is being processed for delivery, this contains the
11133 same value as &$local_part$&, unless a prefix or suffix was removed from the
11134 local part, because &$original_local_part$& always contains the full local
11135 part. When a &"child"& address (for example, generated by an alias, forward, or
11136 filter file) is being processed, this variable contains the full local part of
11137 the original address.
11138
11139 If the router that did the redirection processed the local part
11140 case-insensitively, the value in &$original_local_part$& is in lower case.
11141 This variable differs from &$parent_local_part$& only when there is more than
11142 one level of aliasing or forwarding. When more than one address is being
11143 delivered in a single transport run, &$original_local_part$& is not set.
11144
11145 If a new address is created by means of a &%deliver%& command in a system
11146 filter, it is set up with an artificial &"parent"& address. This has the local
11147 part &'system-filter'& and the default qualify domain.
11148
11149 .vitem &$originator_gid$&
11150 .cindex "gid (group id)" "of originating user"
11151 .cindex "sender" "gid"
11152 .vindex "&$caller_gid$&"
11153 .vindex "&$originator_gid$&"
11154 This variable contains the value of &$caller_gid$& that was set when the
11155 message was received. For messages received via the command line, this is the
11156 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11157 normally the gid of the Exim user.
11158
11159 .vitem &$originator_uid$&
11160 .cindex "uid (user id)" "of originating user"
11161 .cindex "sender" "uid"
11162 .vindex "&$caller_uid$&"
11163 .vindex "&$originaltor_uid$&"
11164 The value of &$caller_uid$& that was set when the message was received. For
11165 messages received via the command line, this is the uid of the sending user.
11166 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11167 user.
11168
11169 .vitem &$parent_domain$&
11170 .vindex "&$parent_domain$&"
11171 This variable is similar to &$original_domain$& (see
11172 above), except that it refers to the immediately preceding parent address.
11173
11174 .vitem &$parent_local_part$&
11175 .vindex "&$parent_local_part$&"
11176 This variable is similar to &$original_local_part$&
11177 (see above), except that it refers to the immediately preceding parent address.
11178
11179 .vitem &$pid$&
11180 .cindex "pid (process id)" "of current process"
11181 .vindex "&$pid$&"
11182 This variable contains the current process id.
11183
11184 .vitem &$pipe_addresses$&
11185 .cindex "filter" "transport filter"
11186 .cindex "transport" "filter"
11187 .vindex "&$pipe_addresses$&"
11188 This is not an expansion variable, but is mentioned here because the string
11189 &`$pipe_addresses`& is handled specially in the command specification for the
11190 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11191 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11192 It cannot be used in general expansion strings, and provokes an &"unknown
11193 variable"& error if encountered.
11194
11195 .vitem &$primary_hostname$&
11196 .vindex "&$primary_hostname$&"
11197 This variable contains the value set by &%primary_hostname%& in the
11198 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11199 a single-component name, Exim calls &[gethostbyname()]& (or
11200 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11201 qualified host name. See also &$smtp_active_hostname$&.
11202
11203
11204 .vitem &$prvscheck_address$&
11205 This variable is used in conjunction with the &%prvscheck%& expansion item,
11206 which is described in sections &<<SECTexpansionitems>>& and
11207 &<<SECTverifyPRVS>>&.
11208
11209 .vitem &$prvscheck_keynum$&
11210 This variable is used in conjunction with the &%prvscheck%& expansion item,
11211 which is described in sections &<<SECTexpansionitems>>& and
11212 &<<SECTverifyPRVS>>&.
11213
11214 .vitem &$prvscheck_result$&
11215 This variable is used in conjunction with the &%prvscheck%& expansion item,
11216 which is described in sections &<<SECTexpansionitems>>& and
11217 &<<SECTverifyPRVS>>&.
11218
11219 .vitem &$qualify_domain$&
11220 .vindex "&$qualify_domain$&"
11221 The value set for the &%qualify_domain%& option in the configuration file.
11222
11223 .vitem &$qualify_recipient$&
11224 .vindex "&$qualify_recipient$&"
11225 The value set for the &%qualify_recipient%& option in the configuration file,
11226 or if not set, the value of &$qualify_domain$&.
11227
11228 .vitem &$rcpt_count$&
11229 .vindex "&$rcpt_count$&"
11230 When a message is being received by SMTP, this variable contains the number of
11231 RCPT commands received for the current message. If this variable is used in a
11232 RCPT ACL, its value includes the current command.
11233
11234 .vitem &$rcpt_defer_count$&
11235 .vindex "&$rcpt_defer_count$&"
11236 .cindex "4&'xx'& responses" "count of"
11237 When a message is being received by SMTP, this variable contains the number of
11238 RCPT commands in the current message that have previously been rejected with a
11239 temporary (4&'xx'&) response.
11240
11241 .vitem &$rcpt_fail_count$&
11242 .vindex "&$rcpt_fail_count$&"
11243 When a message is being received by SMTP, this variable contains the number of
11244 RCPT commands in the current message that have previously been rejected with a
11245 permanent (5&'xx'&) response.
11246
11247 .vitem &$received_count$&
11248 .vindex "&$received_count$&"
11249 This variable contains the number of &'Received:'& header lines in the message,
11250 including the one added by Exim (so its value is always greater than zero). It
11251 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11252 delivering.
11253
11254 .vitem &$received_for$&
11255 .vindex "&$received_for$&"
11256 If there is only a single recipient address in an incoming message, this
11257 variable contains that address when the &'Received:'& header line is being
11258 built. The value is copied after recipient rewriting has happened, but before
11259 the &[local_scan()]& function is run.
11260
11261 .vitem &$received_ip_address$&
11262 .vindex "&$received_ip_address$&"
11263 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11264 variable is set to the address of the local IP interface, and &$received_port$&
11265 is set to the local port number. (The remote IP address and port are in
11266 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11267 the port value is -1 unless it has been set using the &%-oMi%& command line
11268 option.
11269
11270 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11271 could be used, for example, to make the file name for a TLS certificate depend
11272 on which interface and/or port is being used for the incoming connection. The
11273 values of &$received_ip_address$& and &$received_port$& are saved with any
11274 messages that are received, thus making these variables available at delivery
11275 time.
11276
11277 &*Note:*& There are no equivalent variables for outgoing connections, because
11278 the values are unknown (unless they are explicitly set by options of the
11279 &(smtp)& transport).
11280
11281 .vitem &$received_port$&
11282 .vindex "&$received_port$&"
11283 See &$received_ip_address$&.
11284
11285 .vitem &$received_protocol$&
11286 .vindex "&$received_protocol$&"
11287 When a message is being processed, this variable contains the name of the
11288 protocol by which it was received. Most of the names used by Exim are defined
11289 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11290 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11291 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11292 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11293 connection and the client was successfully authenticated.
11294
11295 Exim uses the protocol name &"smtps"& for the case when encryption is
11296 automatically set up on connection without the use of STARTTLS (see
11297 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11298 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11299 where the client initially uses EHLO, sets up an encrypted connection using
11300 STARTTLS, and then uses HELO afterwards.
11301
11302 The &%-oMr%& option provides a way of specifying a custom protocol name for
11303 messages that are injected locally by trusted callers. This is commonly used to
11304 identify messages that are being re-injected after some kind of scanning.
11305
11306 .vitem &$received_time$&
11307 .vindex "&$received_time$&"
11308 This variable contains the date and time when the current message was received,
11309 as a number of seconds since the start of the Unix epoch.
11310
11311 .vitem &$recipient_data$&
11312 .vindex "&$recipient_data$&"
11313 This variable is set after an indexing lookup success in an ACL &%recipients%&
11314 condition. It contains the data from the lookup, and the value remains set
11315 until the next &%recipients%& test. Thus, you can do things like this:
11316 .display
11317 &`require recipients  = cdb*@;/some/file`&
11318 &`deny    `&&'some further test involving'& &`$recipient_data`&
11319 .endd
11320 &*Warning*&: This variable is set only when a lookup is used as an indexing
11321 method in the address list, using the semicolon syntax as in the example above.
11322 The variable is not set for a lookup that is used as part of the string
11323 expansion that all such lists undergo before being interpreted.
11324
11325 .vitem &$recipient_verify_failure$&
11326 .vindex "&$recipient_verify_failure$&"
11327 In an ACL, when a recipient verification fails, this variable contains
11328 information about the failure. It is set to one of the following words:
11329
11330 .ilist
11331 &"qualify"&: The address was unqualified (no domain), and the message
11332 was neither local nor came from an exempted host.
11333
11334 .next
11335 &"route"&: Routing failed.
11336
11337 .next
11338 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11339 or before the MAIL command (that is, on initial connection, HELO, or
11340 MAIL).
11341
11342 .next
11343 &"recipient"&: The RCPT command in a callout was rejected.
11344 .next
11345
11346 &"postmaster"&: The postmaster check in a callout was rejected.
11347 .endlist
11348
11349 The main use of this variable is expected to be to distinguish between
11350 rejections of MAIL and rejections of RCPT.
11351
11352 .vitem &$recipients$&
11353 .vindex "&$recipients$&"
11354 This variable contains a list of envelope recipients for a message. A comma and
11355 a space separate the addresses in the replacement text. However, the variable
11356 is not generally available, to prevent exposure of Bcc recipients in
11357 unprivileged users' filter files. You can use &$recipients$& only in these
11358 cases:
11359
11360 .olist
11361 In a system filter file.
11362 .next
11363 In the ACLs associated with the DATA command and with non-SMTP messages, that
11364 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11365 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11366 &%acl_not_smtp_mime%&.
11367 .next
11368 From within a &[local_scan()]& function.
11369 .endlist
11370
11371
11372 .vitem &$recipients_count$&
11373 .vindex "&$recipients_count$&"
11374 When a message is being processed, this variable contains the number of
11375 envelope recipients that came with the message. Duplicates are not excluded
11376 from the count. While a message is being received over SMTP, the number
11377 increases for each accepted recipient. It can be referenced in an ACL.
11378
11379
11380 .vitem &$regex_match_string$&
11381 .vindex "&$regex_match_string$&"
11382 This variable is set to contain the matching regular expression after a
11383 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11384
11385
11386 .vitem &$reply_address$&
11387 .vindex "&$reply_address$&"
11388 When a message is being processed, this variable contains the contents of the
11389 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11390 contents of the &'From:'& header line. Apart from the removal of leading
11391 white space, the value is not processed in any way. In particular, no RFC 2047
11392 decoding or character code translation takes place.
11393
11394 .vitem &$return_path$&
11395 .vindex "&$return_path$&"
11396 When a message is being delivered, this variable contains the return path &--
11397 the sender field that will be sent as part of the envelope. It is not enclosed
11398 in <> characters. At the start of routing an address, &$return_path$& has the
11399 same value as &$sender_address$&, but if, for example, an incoming message to a
11400 mailing list has been expanded by a router which specifies a different address
11401 for bounce messages, &$return_path$& subsequently contains the new bounce
11402 address, whereas &$sender_address$& always contains the original sender address
11403 that was received with the message. In other words, &$sender_address$& contains
11404 the incoming envelope sender, and &$return_path$& contains the outgoing
11405 envelope sender.
11406
11407 .vitem &$return_size_limit$&
11408 .vindex "&$return_size_limit$&"
11409 This is an obsolete name for &$bounce_return_size_limit$&.
11410
11411 .vitem &$runrc$&
11412 .cindex "return code" "from &%run%& expansion"
11413 .vindex "&$runrc$&"
11414 This variable contains the return code from a command that is run by the
11415 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11416 assume the order in which option values are expanded, except for those
11417 preconditions whose order of testing is documented. Therefore, you cannot
11418 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11419 another.
11420
11421 .vitem &$self_hostname$&
11422 .oindex "&%self%&" "value of host name"
11423 .vindex "&$self_hostname$&"
11424 When an address is routed to a supposedly remote host that turns out to be the
11425 local host, what happens is controlled by the &%self%& generic router option.
11426 One of its values causes the address to be passed to another router. When this
11427 happens, &$self_hostname$& is set to the name of the local host that the
11428 original router encountered. In other circumstances its contents are null.
11429
11430 .vitem &$sender_address$&
11431 .vindex "&$sender_address$&"
11432 When a message is being processed, this variable contains the sender's address
11433 that was received in the message's envelope. The case of letters in the address
11434 is retained, in both the local part and the domain. For bounce messages, the
11435 value of this variable is the empty string. See also &$return_path$&.
11436
11437 .vitem &$sender_address_data$&
11438 .vindex "&$address_data$&"
11439 .vindex "&$sender_address_data$&"
11440 If &$address_data$& is set when the routers are called from an ACL to verify a
11441 sender address, the final value is preserved in &$sender_address_data$&, to
11442 distinguish it from data from a recipient address. The value does not persist
11443 after the end of the current ACL statement. If you want to preserve it for
11444 longer, you can save it in an ACL variable.
11445
11446 .vitem &$sender_address_domain$&
11447 .vindex "&$sender_address_domain$&"
11448 The domain portion of &$sender_address$&.
11449
11450 .vitem &$sender_address_local_part$&
11451 .vindex "&$sender_address_local_part$&"
11452 The local part portion of &$sender_address$&.
11453
11454 .vitem &$sender_data$&
11455 .vindex "&$sender_data$&"
11456 This variable is set after a lookup success in an ACL &%senders%& condition or
11457 in a router &%senders%& option. It contains the data from the lookup, and the
11458 value remains set until the next &%senders%& test. Thus, you can do things like
11459 this:
11460 .display
11461 &`require senders      = cdb*@;/some/file`&
11462 &`deny    `&&'some further test involving'& &`$sender_data`&
11463 .endd
11464 &*Warning*&: This variable is set only when a lookup is used as an indexing
11465 method in the address list, using the semicolon syntax as in the example above.
11466 The variable is not set for a lookup that is used as part of the string
11467 expansion that all such lists undergo before being interpreted.
11468
11469 .vitem &$sender_fullhost$&
11470 .vindex "&$sender_fullhost$&"
11471 When a message is received from a remote host, this variable contains the host
11472 name and IP address in a single string. It ends with the IP address in square
11473 brackets, followed by a colon and a port number if the logging of ports is
11474 enabled. The format of the rest of the string depends on whether the host
11475 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11476 looking up its IP address. (Looking up the IP address can be forced by the
11477 &%host_lookup%& option, independent of verification.) A plain host name at the
11478 start of the string is a verified host name; if this is not present,
11479 verification either failed or was not requested. A host name in parentheses is
11480 the argument of a HELO or EHLO command. This is omitted if it is identical to
11481 the verified host name or to the host's IP address in square brackets.
11482
11483 .vitem &$sender_helo_name$&
11484 .vindex "&$sender_helo_name$&"
11485 When a message is received from a remote host that has issued a HELO or EHLO
11486 command, the argument of that command is placed in this variable. It is also
11487 set if HELO or EHLO is used when a message is received using SMTP locally via
11488 the &%-bs%& or &%-bS%& options.
11489
11490 .vitem &$sender_host_address$&
11491 .vindex "&$sender_host_address$&"
11492 When a message is received from a remote host, this variable contains that
11493 host's IP address. For locally submitted messages, it is empty.
11494
11495 .vitem &$sender_host_authenticated$&
11496 .vindex "&$sender_host_authenticated$&"
11497 This variable contains the name (not the public name) of the authenticator
11498 driver that successfully authenticated the client from which the message was
11499 received. It is empty if there was no successful authentication. See also
11500 &$authenticated_id$&.
11501
11502 .vitem &$sender_host_name$&
11503 .vindex "&$sender_host_name$&"
11504 When a message is received from a remote host, this variable contains the
11505 host's name as obtained by looking up its IP address. For messages received by
11506 other means, this variable is empty.
11507
11508 .vindex "&$host_lookup_failed$&"
11509 If the host name has not previously been looked up, a reference to
11510 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11511 A looked up name is accepted only if it leads back to the original IP address
11512 via a forward lookup. If either the reverse or the forward lookup fails to find
11513 any data, or if the forward lookup does not yield the original IP address,
11514 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11515
11516 .vindex "&$host_lookup_deferred$&"
11517 However, if either of the lookups cannot be completed (for example, there is a
11518 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11519 &$host_lookup_failed$& remains set to &"0"&.
11520
11521 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
11522 host name again if there is a subsequent reference to &$sender_host_name$&
11523 in the same Exim process, but it does try again if &$host_lookup_deferred$&
11524 is set to &"1"&.
11525
11526 Exim does not automatically look up every calling host's name. If you want
11527 maximum efficiency, you should arrange your configuration so that it avoids
11528 these lookups altogether. The lookup happens only if one or more of the
11529 following are true:
11530
11531 .ilist
11532 A string containing &$sender_host_name$& is expanded.
11533 .next
11534 The calling host matches the list in &%host_lookup%&. In the default
11535 configuration, this option is set to *, so it must be changed if lookups are
11536 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
11537 .next
11538 Exim needs the host name in order to test an item in a host list. The items
11539 that require this are described in sections &<<SECThoslispatnam>>& and
11540 &<<SECThoslispatnamsk>>&.
11541 .next
11542 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
11543 In this case, the host name is required to compare with the name quoted in any
11544 EHLO or HELO commands that the client issues.
11545 .next
11546 The remote host issues a EHLO or HELO command that quotes one of the
11547 domains in &%helo_lookup_domains%&. The default value of this option is
11548 . ==== As this is a nested list, any displays it contains must be indented
11549 . ==== as otherwise they are too far to the left.
11550 .code
11551   helo_lookup_domains = @ : @[]
11552 .endd
11553 which causes a lookup if a remote host (incorrectly) gives the server's name or
11554 IP address in an EHLO or HELO command.
11555 .endlist
11556
11557
11558 .vitem &$sender_host_port$&
11559 .vindex "&$sender_host_port$&"
11560 When a message is received from a remote host, this variable contains the port
11561 number that was used on the remote host.
11562
11563 .vitem &$sender_ident$&
11564 .vindex "&$sender_ident$&"
11565 When a message is received from a remote host, this variable contains the
11566 identification received in response to an RFC 1413 request. When a message has
11567 been received locally, this variable contains the login name of the user that
11568 called Exim.
11569
11570 .vitem &$sender_rate_$&&'xxx'&
11571 A number of variables whose names begin &$sender_rate_$& are set as part of the
11572 &%ratelimit%& ACL condition. Details are given in section
11573 &<<SECTratelimiting>>&.
11574
11575 .vitem &$sender_rcvhost$&
11576 .cindex "DNS" "reverse lookup"
11577 .cindex "reverse DNS lookup"
11578 .vindex "&$sender_rcvhost$&"
11579 This is provided specifically for use in &'Received:'& headers. It starts with
11580 either the verified host name (as obtained from a reverse DNS lookup) or, if
11581 there is no verified host name, the IP address in square brackets. After that
11582 there may be text in parentheses. When the first item is a verified host name,
11583 the first thing in the parentheses is the IP address in square brackets,
11584 followed by a colon and a port number if port logging is enabled. When the
11585 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
11586 the parentheses.
11587
11588 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
11589 was used and its argument was not identical to the real host name or IP
11590 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
11591 all three items are present in the parentheses, a newline and tab are inserted
11592 into the string, to improve the formatting of the &'Received:'& header.
11593
11594 .vitem &$sender_verify_failure$&
11595 .vindex "&$sender_verify_failure$&"
11596 In an ACL, when a sender verification fails, this variable contains information
11597 about the failure. The details are the same as for
11598 &$recipient_verify_failure$&.
11599
11600 .vitem &$sending_ip_address$&
11601 .vindex "&$sending_ip_address$&"
11602 This variable is set whenever an outgoing SMTP connection to another host has
11603 been set up. It contains the IP address of the local interface that is being
11604 used. This is useful if a host that has more than one IP address wants to take
11605 on different personalities depending on which one is being used. For incoming
11606 connections, see &$received_ip_address$&.
11607
11608 .vitem &$sending_port$&
11609 .vindex "&$sending_port$&"
11610 This variable is set whenever an outgoing SMTP connection to another host has
11611 been set up. It contains the local port that is being used. For incoming
11612 connections, see &$received_port$&.
11613
11614 .vitem &$smtp_active_hostname$&
11615 .vindex "&$smtp_active_hostname$&"
11616 During an incoming SMTP session, this variable contains the value of the active
11617 host name, as specified by the &%smtp_active_hostname%& option. The value of
11618 &$smtp_active_hostname$& is saved with any message that is received, so its
11619 value can be consulted during routing and delivery.
11620
11621 .vitem &$smtp_command$&
11622 .vindex "&$smtp_command$&"
11623 During the processing of an incoming SMTP command, this variable contains the
11624 entire command. This makes it possible to distinguish between HELO and EHLO in
11625 the HELO ACL, and also to distinguish between commands such as these:
11626 .code
11627 MAIL FROM:<>
11628 MAIL FROM: <>
11629 .endd
11630 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
11631 command, the address in &$smtp_command$& is the original address before any
11632 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
11633 the address after SMTP-time rewriting.
11634
11635 .vitem &$smtp_command_argument$&
11636 .cindex "SMTP" "command, argument for"
11637 .vindex "&$smtp_command_argument$&"
11638 While an ACL is running to check an SMTP command, this variable contains the
11639 argument, that is, the text that follows the command name, with leading white
11640 space removed. Following the introduction of &$smtp_command$&, this variable is
11641 somewhat redundant, but is retained for backwards compatibility.
11642
11643 .vitem &$smtp_count_at_connection_start$&
11644 .vindex "&$smtp_count_at_connection_start$&"
11645 This variable is set greater than zero only in processes spawned by the Exim
11646 daemon for handling incoming SMTP connections. The name is deliberately long,
11647 in order to emphasize what the contents are. When the daemon accepts a new
11648 connection, it increments this variable. A copy of the variable is passed to
11649 the child process that handles the connection, but its value is fixed, and
11650 never changes. It is only an approximation of how many incoming connections
11651 there actually are, because many other connections may come and go while a
11652 single connection is being processed. When a child process terminates, the
11653 daemon decrements its copy of the variable.
11654
11655 .vitem "&$sn0$& &-- &$sn9$&"
11656 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
11657 that were current at the end of the system filter file. This allows a system
11658 filter file to set values that can be tested in users' filter files. For
11659 example, a system filter could set a value indicating how likely it is that a
11660 message is junk mail.
11661
11662 .vitem &$spam_$&&'xxx'&
11663 A number of variables whose names start with &$spam$& are available when Exim
11664 is compiled with the content-scanning extension. For details, see section
11665 &<<SECTscanspamass>>&.
11666
11667
11668 .vitem &$spool_directory$&
11669 .vindex "&$spool_directory$&"
11670 The name of Exim's spool directory.
11671
11672 .vitem &$spool_inodes$&
11673 .vindex "&$spool_inodes$&"
11674 The number of free inodes in the disk partition where Exim's spool files are
11675 being written. The value is recalculated whenever the variable is referenced.
11676 If the relevant file system does not have the concept of inodes, the value of
11677 is -1. See also the &%check_spool_inodes%& option.
11678
11679 .vitem &$spool_space$&
11680 .vindex "&$spool_space$&"
11681 The amount of free space (as a number of kilobytes) in the disk partition where
11682 Exim's spool files are being written. The value is recalculated whenever the
11683 variable is referenced. If the operating system does not have the ability to
11684 find the amount of free space (only true for experimental systems), the space
11685 value is -1. For example, to check in an ACL that there is at least 50
11686 megabytes free on the spool, you could write:
11687 .code
11688 condition = ${if > {$spool_space}{50000}}
11689 .endd
11690 See also the &%check_spool_space%& option.
11691
11692
11693 .vitem &$thisaddress$&
11694 .vindex "&$thisaddress$&"
11695 This variable is set only during the processing of the &%foranyaddress%&
11696 command in a filter file. Its use is explained in the description of that
11697 command, which can be found in the separate document entitled &'Exim's
11698 interfaces to mail filtering'&.
11699
11700 .vitem &$tls_certificate_verified$&
11701 .vindex "&$tls_certificate_verified$&"
11702 This variable is set to &"1"& if a TLS certificate was verified when the
11703 message was received, and &"0"& otherwise.
11704
11705 .vitem &$tls_cipher$&
11706 .vindex "&$tls_cipher$&"
11707 When a message is received from a remote host over an encrypted SMTP
11708 connection, this variable is set to the cipher suite that was negotiated, for
11709 example DES-CBC3-SHA. In other circumstances, in particular, for message
11710 received over unencrypted connections, the variable is empty. Testing
11711 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
11712 non-encrypted connections during ACL processing.
11713
11714 The &$tls_cipher$& variable retains its value during message delivery, except
11715 when an outward SMTP delivery takes place via the &(smtp)& transport. In this
11716 case, &$tls_cipher$& is cleared before any outgoing SMTP connection is made,
11717 and then set to the outgoing cipher suite if one is negotiated. See chapter
11718 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
11719 details of the &(smtp)& transport.
11720
11721 .vitem &$tls_peerdn$&
11722 .vindex "&$tls_peerdn$&"
11723 When a message is received from a remote host over an encrypted SMTP
11724 connection, and Exim is configured to request a certificate from the client,
11725 the value of the Distinguished Name of the certificate is made available in the
11726 &$tls_peerdn$& during subsequent processing. Like &$tls_cipher$&, the
11727 value is retained during message delivery, except during outbound SMTP
11728 deliveries.
11729
11730 .vitem &$tod_bsdinbox$&
11731 .vindex "&$tod_bsdinbox$&"
11732 The time of day and the date, in the format required for BSD-style mailbox
11733 files, for example: Thu Oct 17 17:14:09 1995.
11734
11735 .vitem &$tod_epoch$&
11736 .vindex "&$tod_epoch$&"
11737 The time and date as a number of seconds since the start of the Unix epoch.
11738
11739 .vitem &$tod_full$&
11740 .vindex "&$tod_full$&"
11741 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
11742 +0100. The timezone is always given as a numerical offset from UTC, with
11743 positive values used for timezones that are ahead (east) of UTC, and negative
11744 values for those that are behind (west).
11745
11746 .vitem &$tod_log$&
11747 .vindex "&$tod_log$&"
11748 The time and date in the format used for writing Exim's log files, for example:
11749 1995-10-12 15:32:29, but without a timezone.
11750
11751 .vitem &$tod_logfile$&
11752 .vindex "&$tod_logfile$&"
11753 This variable contains the date in the format yyyymmdd. This is the format that
11754 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
11755 flag.
11756
11757 .vitem &$tod_zone$&
11758 .vindex "&$tod_zone$&"
11759 This variable contains the numerical value of the local timezone, for example:
11760 -0500.
11761
11762 .vitem &$tod_zulu$&
11763 .vindex "&$tod_zulu$&"
11764 This variable contains the UTC date and time in &"Zulu"& format, as specified
11765 by ISO 8601, for example: 20030221154023Z.
11766
11767 .vitem &$value$&
11768 .vindex "&$value$&"
11769 This variable contains the result of an expansion lookup, extraction operation,
11770 or external command, as described above. It is also used during a
11771 &*reduce*& expansion.
11772
11773 .vitem &$version_number$&
11774 .vindex "&$version_number$&"
11775 The version number of Exim.
11776
11777 .vitem &$warn_message_delay$&
11778 .vindex "&$warn_message_delay$&"
11779 This variable is set only during the creation of a message warning about a
11780 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11781
11782 .vitem &$warn_message_recipients$&
11783 .vindex "&$warn_message_recipients$&"
11784 This variable is set only during the creation of a message warning about a
11785 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11786 .endlist
11787 .ecindex IIDstrexp
11788
11789
11790
11791 . ////////////////////////////////////////////////////////////////////////////
11792 . ////////////////////////////////////////////////////////////////////////////
11793
11794 .chapter "Embedded Perl" "CHAPperl"
11795 .scindex IIDperl "Perl" "calling from Exim"
11796 Exim can be built to include an embedded Perl interpreter. When this is done,
11797 Perl subroutines can be called as part of the string expansion process. To make
11798 use of the Perl support, you need version 5.004 or later of Perl installed on
11799 your system. To include the embedded interpreter in the Exim binary, include
11800 the line
11801 .code
11802 EXIM_PERL = perl.o
11803 .endd
11804 in your &_Local/Makefile_& and then build Exim in the normal way.
11805
11806
11807 .section "Setting up so Perl can be used" "SECID85"
11808 .oindex "&%perl_startup%&"
11809 Access to Perl subroutines is via a global configuration option called
11810 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
11811 no &%perl_startup%& option in the Exim configuration file then no Perl
11812 interpreter is started and there is almost no overhead for Exim (since none of
11813 the Perl library will be paged in unless used). If there is a &%perl_startup%&
11814 option then the associated value is taken to be Perl code which is executed in
11815 a newly created Perl interpreter.
11816
11817 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
11818 need backslashes before any characters to escape special meanings. The option
11819 should usually be something like
11820 .code
11821 perl_startup = do '/etc/exim.pl'
11822 .endd
11823 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
11824 use from Exim. Exim can be configured either to start up a Perl interpreter as
11825 soon as it is entered, or to wait until the first time it is needed. Starting
11826 the interpreter at the beginning ensures that it is done while Exim still has
11827 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
11828 fact used in a particular run. Also, note that this does not mean that Exim is
11829 necessarily running as root when Perl is called at a later time. By default,
11830 the interpreter is started only when it is needed, but this can be changed in
11831 two ways:
11832
11833 .ilist
11834 .oindex "&%perl_at_start%&"
11835 Setting &%perl_at_start%& (a boolean option) in the configuration requests
11836 a startup when Exim is entered.
11837 .next
11838 The command line option &%-ps%& also requests a startup when Exim is entered,
11839 overriding the setting of &%perl_at_start%&.
11840 .endlist
11841
11842 There is also a command line option &%-pd%& (for delay) which suppresses the
11843 initial startup, even if &%perl_at_start%& is set.
11844
11845
11846 .section "Calling Perl subroutines" "SECID86"
11847 When the configuration file includes a &%perl_startup%& option you can make use
11848 of the string expansion item to call the Perl subroutines that are defined
11849 by the &%perl_startup%& code. The operator is used in any of the following
11850 forms:
11851 .code
11852 ${perl{foo}}
11853 ${perl{foo}{argument}}
11854 ${perl{foo}{argument1}{argument2} ... }
11855 .endd
11856 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
11857 arguments may be passed. Passing more than this results in an expansion failure
11858 with an error message of the form
11859 .code
11860 Too many arguments passed to Perl subroutine "foo" (max is 8)
11861 .endd
11862 The return value of the Perl subroutine is evaluated in a scalar context before
11863 it is passed back to Exim to be inserted into the expanded string. If the
11864 return value is &'undef'&, the expansion is forced to fail in the same way as
11865 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
11866 by obeying Perl's &%die%& function, the expansion fails with the error message
11867 that was passed to &%die%&.
11868
11869
11870 .section "Calling Exim functions from Perl" "SECID87"
11871 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
11872 is available to call back into Exim's string expansion function. For example,
11873 the Perl code
11874 .code
11875 my $lp = Exim::expand_string('$local_part');
11876 .endd
11877 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
11878 Note those are single quotes and not double quotes to protect against
11879 &$local_part$& being interpolated as a Perl variable.
11880
11881 If the string expansion is forced to fail by a &"fail"& item, the result of
11882 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
11883 expansion string, the Perl call from the original expansion string fails with
11884 an appropriate error message, in the same way as if &%die%& were used.
11885
11886 .cindex "debugging" "from embedded Perl"
11887 .cindex "log" "writing from embedded Perl"
11888 Two other Exim functions are available for use from within Perl code.
11889 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
11890 debugging is enabled. If you want a newline at the end, you must supply it.
11891 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
11892 timestamp. In this case, you should not supply a terminating newline.
11893
11894
11895 .section "Use of standard output and error by Perl" "SECID88"
11896 .cindex "Perl" "standard output and error"
11897 You should not write to the standard error or output streams from within your
11898 Perl code, as it is not defined how these are set up. In versions of Exim
11899 before 4.50, it is possible for the standard output or error to refer to the
11900 SMTP connection during message reception via the daemon. Writing to this stream
11901 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
11902 error streams are connected to &_/dev/null_& in the daemon. The chaos is
11903 avoided, but the output is lost.
11904
11905 .cindex "Perl" "use of &%warn%&"
11906 The Perl &%warn%& statement writes to the standard error stream by default.
11907 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
11908 you have no control. When Exim starts up the Perl interpreter, it arranges for
11909 output from the &%warn%& statement to be written to the Exim main log. You can
11910 change this by including appropriate Perl magic somewhere in your Perl code.
11911 For example, to discard &%warn%& output completely, you need this:
11912 .code
11913 $SIG{__WARN__} = sub { };
11914 .endd
11915 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
11916 example, the code for the subroutine is empty, so it does nothing, but you can
11917 include any Perl code that you like. The text of the &%warn%& message is passed
11918 as the first subroutine argument.
11919 .ecindex IIDperl
11920
11921
11922 . ////////////////////////////////////////////////////////////////////////////
11923 . ////////////////////////////////////////////////////////////////////////////
11924
11925 .chapter "Starting the daemon and the use of network interfaces" &&&
11926          "CHAPinterfaces" &&&
11927          "Starting the daemon"
11928 .cindex "daemon" "starting"
11929 .cindex "interface" "listening"
11930 .cindex "network interface"
11931 .cindex "interface" "network"
11932 .cindex "IP address" "for listening"
11933 .cindex "daemon" "listening IP addresses"
11934 .cindex "TCP/IP" "setting listening interfaces"
11935 .cindex "TCP/IP" "setting listening ports"
11936 A host that is connected to a TCP/IP network may have one or more physical
11937 hardware network interfaces. Each of these interfaces may be configured as one
11938 or more &"logical"& interfaces, which are the entities that a program actually
11939 works with. Each of these logical interfaces is associated with an IP address.
11940 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
11941 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
11942 knowledge about the host's interfaces for use in three different circumstances:
11943
11944 .olist
11945 When a listening daemon is started, Exim needs to know which interfaces
11946 and ports to listen on.
11947 .next
11948 When Exim is routing an address, it needs to know which IP addresses
11949 are associated with local interfaces. This is required for the correct
11950 processing of MX lists by removing the local host and others with the
11951 same or higher priority values. Also, Exim needs to detect cases
11952 when an address is routed to an IP address that in fact belongs to the
11953 local host. Unless the &%self%& router option or the &%allow_localhost%&
11954 option of the smtp transport is set (as appropriate), this is treated
11955 as an error situation.
11956 .next
11957 When Exim connects to a remote host, it may need to know which interface to use
11958 for the outgoing connection.
11959 .endlist
11960
11961
11962 Exim's default behaviour is likely to be appropriate in the vast majority
11963 of cases. If your host has only one interface, and you want all its IP
11964 addresses to be treated in the same way, and you are using only the
11965 standard SMTP port, you should not need to take any special action. The
11966 rest of this chapter does not apply to you.
11967
11968 In a more complicated situation you may want to listen only on certain
11969 interfaces, or on different ports, and for this reason there are a number of
11970 options that can be used to influence Exim's behaviour. The rest of this
11971 chapter describes how they operate.
11972
11973 When a message is received over TCP/IP, the interface and port that were
11974 actually used are set in &$received_ip_address$& and &$received_port$&.
11975
11976
11977
11978 .section "Starting a listening daemon" "SECID89"
11979 When a listening daemon is started (by means of the &%-bd%& command line
11980 option), the interfaces and ports on which it listens are controlled by the
11981 following options:
11982
11983 .ilist
11984 &%daemon_smtp_ports%& contains a list of default ports. (For backward
11985 compatibility, this option can also be specified in the singular.)
11986 .next
11987 &%local_interfaces%& contains list of interface IP addresses on which to
11988 listen. Each item may optionally also specify a port.
11989 .endlist
11990
11991 The default list separator in both cases is a colon, but this can be changed as
11992 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
11993 it is usually best to change the separator to avoid having to double all the
11994 colons. For example:
11995 .code
11996 local_interfaces = <; 127.0.0.1 ; \
11997                       192.168.23.65 ; \
11998                       ::1 ; \
11999                       3ffe:ffff:836f::fe86:a061
12000 .endd
12001 There are two different formats for specifying a port along with an IP address
12002 in &%local_interfaces%&:
12003
12004 .olist
12005 The port is added onto the address with a dot separator. For example, to listen
12006 on port 1234 on two different IP addresses:
12007 .code
12008 local_interfaces = <; 192.168.23.65.1234 ; \
12009                       3ffe:ffff:836f::fe86:a061.1234
12010 .endd
12011 .next
12012 The IP address is enclosed in square brackets, and the port is added
12013 with a colon separator, for example:
12014 .code
12015 local_interfaces = <; [192.168.23.65]:1234 ; \
12016                       [3ffe:ffff:836f::fe86:a061]:1234
12017 .endd
12018 .endlist
12019
12020 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12021 default setting contains just one port:
12022 .code
12023 daemon_smtp_ports = smtp
12024 .endd
12025 If more than one port is listed, each interface that does not have its own port
12026 specified listens on all of them. Ports that are listed in
12027 &%daemon_smtp_ports%& can be identified either by name (defined in
12028 &_/etc/services_&) or by number. However, when ports are given with individual
12029 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12030
12031
12032
12033 .section "Special IP listening addresses" "SECID90"
12034 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12035 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12036 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12037 instead of setting up separate listening sockets for each interface. The
12038 default value of &%local_interfaces%& is
12039 .code
12040 local_interfaces = 0.0.0.0
12041 .endd
12042 when Exim is built without IPv6 support; otherwise it is:
12043 .code
12044 local_interfaces = <; ::0 ; 0.0.0.0
12045 .endd
12046 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12047
12048
12049
12050 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12051 The &%-oX%& command line option can be used to override the values of
12052 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12053 instance. Another way of doing this would be to use macros and the &%-D%&
12054 option. However, &%-oX%& can be used by any admin user, whereas modification of
12055 the runtime configuration by &%-D%& is allowed only when the caller is root or
12056 exim.
12057
12058 The value of &%-oX%& is a list of items. The default colon separator can be
12059 changed in the usual way if required. If there are any items that do not
12060 contain dots or colons (that is, are not IP addresses), the value of
12061 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12062 items that do contain dots or colons, the value of &%local_interfaces%& is
12063 replaced by those items. Thus, for example,
12064 .code
12065 -oX 1225
12066 .endd
12067 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12068 whereas
12069 .code
12070 -oX 192.168.34.5.1125
12071 .endd
12072 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12073 (However, since &%local_interfaces%& now contains no items without ports, the
12074 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12075
12076
12077
12078 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12079 .cindex "ssmtp protocol"
12080 .cindex "smtps protocol"
12081 .cindex "SMTP" "ssmtp protocol"
12082 .cindex "SMTP" "smtps protocol"
12083 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12084 before the STARTTLS command was standardized for SMTP. Some legacy clients
12085 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12086 list of port numbers, connections to those ports must use SSMTP. The most
12087 common use of this option is expected to be
12088 .code
12089 tls_on_connect_ports = 465
12090 .endd
12091 because 465 is the usual port number used by the legacy clients. There is also
12092 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12093 this way when a daemon is started.
12094
12095 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12096 daemon to listen on those ports. You must still specify them in
12097 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12098 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12099 connections via the daemon.)
12100
12101
12102
12103
12104 .section "IPv6 address scopes" "SECID92"
12105 .cindex "IPv6" "address scopes"
12106 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12107 can, in principle, have the same link-local IPv6 address on different
12108 interfaces. Thus, additional information is needed, over and above the IP
12109 address, to distinguish individual interfaces. A convention of using a
12110 percent sign followed by something (often the interface name) has been
12111 adopted in some cases, leading to addresses like this:
12112 .code
12113 fe80::202:b3ff:fe03:45c1%eth0
12114 .endd
12115 To accommodate this usage, a percent sign followed by an arbitrary string is
12116 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12117 to convert a textual IPv6 address for actual use. This function recognizes the
12118 percent convention in operating systems that support it, and it processes the
12119 address appropriately. Unfortunately, some older libraries have problems with
12120 &[getaddrinfo()]&. If
12121 .code
12122 IPV6_USE_INET_PTON=yes
12123 .endd
12124 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12125 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12126 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12127 function.) Of course, this means that the additional functionality of
12128 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12129
12130 .section "Disabling IPv6" "SECID93"
12131 .cindex "IPv6" "disabling"
12132 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12133 run on a host whose kernel does not support IPv6. The binary will fall back to
12134 using IPv4, but it may waste resources looking up AAAA records, and trying to
12135 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12136 .oindex "&%disable_ipv6%&"
12137 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12138 activities take place. AAAA records are never looked up, and any IPv6 addresses
12139 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12140 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12141 to handle IPv6 literal addresses.
12142
12143 On the other hand, when IPv6 is in use, there may be times when you want to
12144 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12145 option to globally suppress the lookup of AAAA records for specified domains,
12146 and you can use the &%ignore_target_hosts%& generic router option to ignore
12147 IPv6 addresses in an individual router.
12148
12149
12150
12151 .section "Examples of starting a listening daemon" "SECID94"
12152 The default case in an IPv6 environment is
12153 .code
12154 daemon_smtp_ports = smtp
12155 local_interfaces = <; ::0 ; 0.0.0.0
12156 .endd
12157 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12158 Either one or two sockets may be used, depending on the characteristics of
12159 the TCP/IP stack. (This is complicated and messy; for more information,
12160 read the comments in the &_daemon.c_& source file.)
12161
12162 To specify listening on ports 25 and 26 on all interfaces:
12163 .code
12164 daemon_smtp_ports = 25 : 26
12165 .endd
12166 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12167 .code
12168 local_interfaces = <; ::0.25     ; ::0.26 \
12169                       0.0.0.0.25 ; 0.0.0.0.26
12170 .endd
12171 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12172 IPv4 loopback address only:
12173 .code
12174 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12175 .endd
12176 To specify listening on the default port on specific interfaces only:
12177 .code
12178 local_interfaces = 192.168.34.67 : 192.168.34.67
12179 .endd
12180 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12181
12182
12183
12184 .section "Recognizing the local host" "SECTreclocipadd"
12185 The &%local_interfaces%& option is also used when Exim needs to determine
12186 whether or not an IP address refers to the local host. That is, the IP
12187 addresses of all the interfaces on which a daemon is listening are always
12188 treated as local.
12189
12190 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12191 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12192 available interfaces from the operating system, and extracts the relevant
12193 (that is, IPv4 or IPv6) addresses to use for checking.
12194
12195 Some systems set up large numbers of virtual interfaces in order to provide
12196 many virtual web servers. In this situation, you may want to listen for
12197 email on only a few of the available interfaces, but nevertheless treat all
12198 interfaces as local when routing. You can do this by setting
12199 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12200 &"all"& wildcard values. These addresses are recognized as local, but are not
12201 used for listening. Consider this example:
12202 .code
12203 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12204                       192.168.53.235 ; \
12205                       3ffe:2101:12:1:a00:20ff:fe86:a061
12206
12207 extra_local_interfaces = <; ::0 ; 0.0.0.0
12208 .endd
12209 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12210 address, but all available interface addresses are treated as local when
12211 Exim is routing.
12212
12213 In some environments the local host name may be in an MX list, but with an IP
12214 address that is not assigned to any local interface. In other cases it may be
12215 desirable to treat other host names as if they referred to the local host. Both
12216 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12217 This contains host names rather than IP addresses. When a host is referenced
12218 during routing, either via an MX record or directly, it is treated as the local
12219 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12220 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12221
12222
12223
12224 .section "Delivering to a remote host" "SECID95"
12225 Delivery to a remote host is handled by the smtp transport. By default, it
12226 allows the system's TCP/IP functions to choose which interface to use (if
12227 there is more than one) when connecting to a remote host. However, the
12228 &%interface%& option can be set to specify which interface is used. See the
12229 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12230 details.
12231
12232
12233
12234
12235 . ////////////////////////////////////////////////////////////////////////////
12236 . ////////////////////////////////////////////////////////////////////////////
12237
12238 .chapter "Main configuration" "CHAPmainconfig"
12239 .scindex IIDconfima "configuration file" "main section"
12240 .scindex IIDmaiconf "main configuration"
12241 The first part of the run time configuration file contains three types of item:
12242
12243 .ilist
12244 Macro definitions: These lines start with an upper case letter. See section
12245 &<<SECTmacrodefs>>& for details of macro processing.
12246 .next
12247 Named list definitions: These lines start with one of the words &"domainlist"&,
12248 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12249 section &<<SECTnamedlists>>&.
12250 .next
12251 Main configuration settings: Each setting occupies one line of the file
12252 (with possible continuations). If any setting is preceded by the word
12253 &"hide"&, the &%-bP%& command line option displays its value to admin users
12254 only. See section &<<SECTcos>>& for a description of the syntax of these option
12255 settings.
12256 .endlist
12257
12258 This chapter specifies all the main configuration options, along with their
12259 types and default values. For ease of finding a particular option, they appear
12260 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12261 are now so many options, they are first listed briefly in functional groups, as
12262 an aid to finding the name of the option you are looking for. Some options are
12263 listed in more than one group.
12264
12265 .section "Miscellaneous" "SECID96"
12266 .table2
12267 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12268 .row &%disable_ipv6%&                "do no IPv6 processing"
12269 .row &%keep_malformed%&              "for broken files &-- should not happen"
12270 .row &%localhost_number%&            "for unique message ids in clusters"
12271 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12272 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12273 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12274 .row &%print_topbitchars%&           "top-bit characters are printing"
12275 .row &%timezone%&                    "force time zone"
12276 .endtable
12277
12278
12279 .section "Exim parameters" "SECID97"
12280 .table2
12281 .row &%exim_group%&                  "override compiled-in value"
12282 .row &%exim_path%&                   "override compiled-in value"
12283 .row &%exim_user%&                   "override compiled-in value"
12284 .row &%primary_hostname%&            "default from &[uname()]&"
12285 .row &%split_spool_directory%&       "use multiple directories"
12286 .row &%spool_directory%&             "override compiled-in value"
12287 .endtable
12288
12289
12290
12291 .section "Privilege controls" "SECID98"
12292 .table2
12293 .row &%admin_groups%&                "groups that are Exim admin users"
12294 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12295 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12296 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12297 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12298 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12299 .row &%never_users%&                 "do not run deliveries as these"
12300 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12301 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12302 .row &%trusted_groups%&              "groups that are trusted"
12303 .row &%trusted_users%&               "users that are trusted"
12304 .endtable
12305
12306
12307
12308 .section "Logging" "SECID99"
12309 .table2
12310 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12311 .row &%log_file_path%&               "override compiled-in value"
12312 .row &%log_selector%&                "set/unset optional logging"
12313 .row &%log_timezone%&                "add timezone to log lines"
12314 .row &%message_logs%&                "create per-message logs"
12315 .row &%preserve_message_logs%&       "after message completion"
12316 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12317 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12318 .row &%syslog_facility%&             "set syslog &""facility""& field"
12319 .row &%syslog_processname%&          "set syslog &""ident""& field"
12320 .row &%syslog_timestamp%&            "timestamp syslog lines"
12321 .row &%write_rejectlog%&             "control use of message log"
12322 .endtable
12323
12324
12325
12326 .section "Frozen messages" "SECID100"
12327 .table2
12328 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12329 .row &%freeze_tell%&                 "send message when freezing"
12330 .row &%move_frozen_messages%&        "to another directory"
12331 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12332 .endtable
12333
12334
12335
12336 .section "Data lookups" "SECID101"
12337 .table2
12338 .row &%ibase_servers%&               "InterBase servers"
12339 .row &%ldap_default_servers%&        "used if no server in query"
12340 .row &%ldap_version%&                "set protocol version"
12341 .row &%lookup_open_max%&             "lookup files held open"
12342 .row &%mysql_servers%&               "default MySQL servers"
12343 .row &%oracle_servers%&              "Oracle servers"
12344 .row &%pgsql_servers%&               "default PostgreSQL servers"
12345 .row &%sqlite_lock_timeout%&         "as it says"
12346 .endtable
12347
12348
12349
12350 .section "Message ids" "SECID102"
12351 .table2
12352 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12353 .row &%message_id_header_text%&      "ditto"
12354 .endtable
12355
12356
12357
12358 .section "Embedded Perl Startup" "SECID103"
12359 .table2
12360 .row &%perl_at_start%&               "always start the interpreter"
12361 .row &%perl_startup%&                "code to obey when starting Perl"
12362 .endtable
12363
12364
12365
12366 .section "Daemon" "SECID104"
12367 .table2
12368 .row &%daemon_smtp_ports%&           "default ports"
12369 .row &%daemon_startup_retries%&      "number of times to retry"
12370 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12371 .row &%extra_local_interfaces%&      "not necessarily listened on"
12372 .row &%local_interfaces%&            "on which to listen, with optional ports"
12373 .row &%pid_file_path%&               "override compiled-in value"
12374 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12375 .endtable
12376
12377
12378
12379 .section "Resource control" "SECID105"
12380 .table2
12381 .row &%check_log_inodes%&            "before accepting a message"
12382 .row &%check_log_space%&             "before accepting a message"
12383 .row &%check_spool_inodes%&          "before accepting a message"
12384 .row &%check_spool_space%&           "before accepting a message"
12385 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12386 .row &%queue_only_load%&             "queue incoming if load high"
12387 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12388 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12389 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12390 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12391 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12392 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12393 .row &%smtp_accept_max_per_connection%& "messages per connection"
12394 .row &%smtp_accept_max_per_host%&    "connections from one host"
12395 .row &%smtp_accept_queue%&           "queue mail if more connections"
12396 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12397                                            connection"
12398 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12399 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12400 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12401 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12402 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12403 .endtable
12404
12405
12406
12407 .section "Policy controls" "SECID106"
12408 .table2
12409 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12410 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12411 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12412 .row &%acl_smtp_auth%&               "ACL for AUTH"
12413 .row &%acl_smtp_connect%&            "ACL for connection"
12414 .row &%acl_smtp_data%&               "ACL for DATA"
12415 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12416 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12417 .row &%acl_smtp_expn%&               "ACL for EXPN"
12418 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12419 .row &%acl_smtp_mail%&               "ACL for MAIL"
12420 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12421 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12422 .row &%acl_smtp_predata%&            "ACL for start of data"
12423 .row &%acl_smtp_quit%&               "ACL for QUIT"
12424 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12425 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
12426 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
12427 .row &%av_scanner%&                  "specify virus scanner"
12428 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12429                                       words""&"
12430 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
12431 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
12432 .row &%header_maxsize%&              "total size of message header"
12433 .row &%header_line_maxsize%&         "individual header line limit"
12434 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
12435 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
12436 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
12437 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
12438 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
12439 .row &%host_lookup%&                 "host name looked up for these hosts"
12440 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12441 .row &%host_reject_connection%&      "reject connection from these hosts"
12442 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
12443 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
12444 .row &%message_size_limit%&          "for all messages"
12445 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12446 .row &%spamd_address%&               "set interface to SpamAssassin"
12447 .row &%strict_acl_vars%&             "object to unset ACL variables"
12448 .endtable
12449
12450
12451
12452 .section "Callout cache" "SECID107"
12453 .table2
12454 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
12455                                          item"
12456 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
12457                                          item"
12458 .row &%callout_negative_expire%&     "timeout for negative address cache item"
12459 .row &%callout_positive_expire%&     "timeout for positive address cache item"
12460 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
12461 .endtable
12462
12463
12464
12465 .section "TLS" "SECID108"
12466 .table2
12467 .row &%gnutls_require_kx%&           "control GnuTLS key exchanges"
12468 .row &%gnutls_require_mac%&          "control GnuTLS MAC algorithms"
12469 .row &%gnutls_require_protocols%&    "control GnuTLS protocols"
12470 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
12471 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
12472 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12473 .row &%tls_certificate%&             "location of server certificate"
12474 .row &%tls_crl%&                     "certificate revocation list"
12475 .row &%tls_dhparam%&                 "DH parameters for server"
12476 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
12477 .row &%tls_privatekey%&              "location of server private key"
12478 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
12479 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
12480 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
12481 .row &%tls_verify_certificates%&     "expected client certificates"
12482 .row &%tls_verify_hosts%&            "insist on client certificate verify"
12483 .endtable
12484
12485
12486
12487 .section "Local user handling" "SECID109"
12488 .table2
12489 .row &%finduser_retries%&            "useful in NIS environments"
12490 .row &%gecos_name%&                  "used when creating &'Sender:'&"
12491 .row &%gecos_pattern%&               "ditto"
12492 .row &%max_username_length%&         "for systems that truncate"
12493 .row &%unknown_login%&               "used when no login name found"
12494 .row &%unknown_username%&            "ditto"
12495 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
12496 .row &%uucp_from_sender%&            "ditto"
12497 .endtable
12498
12499
12500
12501 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
12502 .table2
12503 .row &%header_maxsize%&              "total size of message header"
12504 .row &%header_line_maxsize%&         "individual header line limit"
12505 .row &%message_size_limit%&          "applies to all messages"
12506 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12507 .row &%received_header_text%&        "expanded to make &'Received:'&"
12508 .row &%received_headers_max%&        "for mail loop detection"
12509 .row &%recipients_max%&              "limit per message"
12510 .row &%recipients_max_reject%&       "permanently reject excess recipients"
12511 .endtable
12512
12513
12514
12515
12516 .section "Non-SMTP incoming messages" "SECID111"
12517 .table2
12518 .row &%receive_timeout%&             "for non-SMTP messages"
12519 .endtable
12520
12521
12522
12523
12524
12525 .section "Incoming SMTP messages" "SECID112"
12526 See also the &'Policy controls'& section above.
12527
12528 .table2
12529 .row &%host_lookup%&                 "host name looked up for these hosts"
12530 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12531 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
12532 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
12533 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
12534 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
12535 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
12536 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12537 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12538 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12539 .row &%smtp_accept_max_per_connection%& "messages per connection"
12540 .row &%smtp_accept_max_per_host%&    "connections from one host"
12541 .row &%smtp_accept_queue%&           "queue mail if more connections"
12542 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12543                                            connection"
12544 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12545 .row &%smtp_active_hostname%&        "host name to use in messages"
12546 .row &%smtp_banner%&                 "text for welcome banner"
12547 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12548 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12549 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
12550 .row &%smtp_etrn_command%&           "what to run for ETRN"
12551 .row &%smtp_etrn_serialize%&         "only one at once"
12552 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
12553 .row &%smtp_max_unknown_commands%&   "before dropping connection"
12554 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
12555 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
12556 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
12557 .row &%smtp_receive_timeout%&        "per command or data line"
12558 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12559 .row &%smtp_return_error_details%&   "give detail on rejections"
12560 .endtable
12561
12562
12563
12564 .section "SMTP extensions" "SECID113"
12565 .table2
12566 .row &%accept_8bitmime%&             "advertise 8BITMIME"
12567 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
12568 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
12569 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
12570 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
12571 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12572 .endtable
12573
12574
12575
12576 .section "Processing messages" "SECID114"
12577 .table2
12578 .row &%allow_domain_literals%&       "recognize domain literal syntax"
12579 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
12580 .row &%allow_utf8_domains%&          "in addresses"
12581 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12582                                       words""&"
12583 .row &%delivery_date_remove%&        "from incoming messages"
12584 .row &%envelope_to_remove%&          "from incoming messages"
12585 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
12586 .row &%headers_charset%&             "default for translations"
12587 .row &%qualify_domain%&              "default for senders"
12588 .row &%qualify_recipient%&           "default for recipients"
12589 .row &%return_path_remove%&          "from incoming messages"
12590 .row &%strip_excess_angle_brackets%& "in addresses"
12591 .row &%strip_trailing_dot%&          "at end of addresses"
12592 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
12593 .endtable
12594
12595
12596
12597 .section "System filter" "SECID115"
12598 .table2
12599 .row &%system_filter%&               "locate system filter"
12600 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
12601                                             directory"
12602 .row &%system_filter_file_transport%& "transport for delivery to a file"
12603 .row &%system_filter_group%&         "group for filter running"
12604 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
12605 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
12606 .row &%system_filter_user%&          "user for filter running"
12607 .endtable
12608
12609
12610
12611 .section "Routing and delivery" "SECID116"
12612 .table2
12613 .row &%disable_ipv6%&                "do no IPv6 processing"
12614 .row &%dns_again_means_nonexist%&    "for broken domains"
12615 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
12616 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
12617 .row &%dns_retrans%&                 "parameter for resolver"
12618 .row &%dns_retry%&                   "parameter for resolver"
12619 .row &%hold_domains%&                "hold delivery for these domains"
12620 .row &%local_interfaces%&            "for routing checks"
12621 .row &%queue_domains%&               "no immediate delivery for these"
12622 .row &%queue_only%&                  "no immediate delivery at all"
12623 .row &%queue_only_file%&             "no immediate delivery if file exists"
12624 .row &%queue_only_load%&             "no immediate delivery if load is high"
12625 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12626 .row &%queue_only_override%&         "allow command line to override"
12627 .row &%queue_run_in_order%&          "order of arrival"
12628 .row &%queue_run_max%&               "of simultaneous queue runners"
12629 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
12630 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12631 .row &%remote_sort_domains%&         "order of remote deliveries"
12632 .row &%retry_data_expire%&           "timeout for retry data"
12633 .row &%retry_interval_max%&          "safety net for retry rules"
12634 .endtable
12635
12636
12637
12638 .section "Bounce and warning messages" "SECID117"
12639 .table2
12640 .row &%bounce_message_file%&         "content of bounce"
12641 .row &%bounce_message_text%&         "content of bounce"
12642 .row &%bounce_return_body%&          "include body if returning message"
12643 .row &%bounce_return_message%&       "include original message in bounce"
12644 .row &%bounce_return_size_limit%&    "limit on returned message"
12645 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
12646 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
12647 .row &%errors_copy%&                 "copy bounce messages"
12648 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
12649 .row &%delay_warning%&               "time schedule"
12650 .row &%delay_warning_condition%&     "condition for warning messages"
12651 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
12652 .row &%smtp_return_error_details%&   "give detail on rejections"
12653 .row &%warn_message_file%&           "content of warning message"
12654 .endtable
12655
12656
12657
12658 .section "Alphabetical list of main options" "SECTalomo"
12659 Those options that undergo string expansion before use are marked with
12660 &dagger;.
12661
12662 .option accept_8bitmime main boolean false
12663 .cindex "8BITMIME"
12664 .cindex "8-bit characters"
12665 This option causes Exim to send 8BITMIME in its response to an SMTP
12666 EHLO command, and to accept the BODY= parameter on MAIL commands.
12667 However, though Exim is 8-bit clean, it is not a protocol converter, and it
12668 takes no steps to do anything special with messages received by this route.
12669 Consequently, this option is turned off by default.
12670
12671 .option acl_not_smtp main string&!! unset
12672 .cindex "&ACL;" "for non-SMTP messages"
12673 .cindex "non-SMTP messages" "ACLs for"
12674 This option defines the ACL that is run when a non-SMTP message has been
12675 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
12676 further details.
12677
12678 .option acl_not_smtp_mime main string&!! unset
12679 This option defines the ACL that is run for individual MIME parts of non-SMTP
12680 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
12681 SMTP messages.
12682
12683 .option acl_not_smtp_start main string&!! unset
12684 .cindex "&ACL;" "at start of non-SMTP message"
12685 .cindex "non-SMTP messages" "ACLs for"
12686 This option defines the ACL that is run before Exim starts reading a
12687 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
12688
12689 .option acl_smtp_auth main string&!! unset
12690 .cindex "&ACL;" "setting up for SMTP commands"
12691 .cindex "AUTH" "ACL for"
12692 This option defines the ACL that is run when an SMTP AUTH command is
12693 received. See chapter &<<CHAPACL>>& for further details.
12694
12695 .option acl_smtp_connect main string&!! unset
12696 .cindex "&ACL;" "on SMTP connection"
12697 This option defines the ACL that is run when an SMTP connection is received.
12698 See chapter &<<CHAPACL>>& for further details.
12699
12700 .option acl_smtp_data main string&!! unset
12701 .cindex "DATA" "ACL for"
12702 This option defines the ACL that is run after an SMTP DATA command has been
12703 processed and the message itself has been received, but before the final
12704 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
12705
12706 .option acl_smtp_etrn main string&!! unset
12707 .cindex "ETRN" "ACL for"
12708 This option defines the ACL that is run when an SMTP ETRN command is
12709 received. See chapter &<<CHAPACL>>& for further details.
12710
12711 .option acl_smtp_expn main string&!! unset
12712 .cindex "EXPN" "ACL for"
12713 This option defines the ACL that is run when an SMTP EXPN command is
12714 received. See chapter &<<CHAPACL>>& for further details.
12715
12716 .option acl_smtp_helo main string&!! unset
12717 .cindex "EHLO" "ACL for"
12718 .cindex "HELO" "ACL for"
12719 This option defines the ACL that is run when an SMTP EHLO or HELO
12720 command is received. See chapter &<<CHAPACL>>& for further details.
12721
12722
12723 .option acl_smtp_mail main string&!! unset
12724 .cindex "MAIL" "ACL for"
12725 This option defines the ACL that is run when an SMTP MAIL command is
12726 received. See chapter &<<CHAPACL>>& for further details.
12727
12728 .option acl_smtp_mailauth main string&!! unset
12729 .cindex "AUTH" "on MAIL command"
12730 This option defines the ACL that is run when there is an AUTH parameter on
12731 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
12732 &<<CHAPSMTPAUTH>>& for details of authentication.
12733
12734 .option acl_smtp_mime main string&!! unset
12735 .cindex "MIME content scanning" "ACL for"
12736 This option is available when Exim is built with the content-scanning
12737 extension. It defines the ACL that is run for each MIME part in a message. See
12738 section &<<SECTscanmimepart>>& for details.
12739
12740 .option acl_smtp_predata main string&!! unset
12741 This option defines the ACL that is run when an SMTP DATA command is
12742 received, before the message itself is received. See chapter &<<CHAPACL>>& for
12743 further details.
12744
12745 .option acl_smtp_quit main string&!! unset
12746 .cindex "QUIT, ACL for"
12747 This option defines the ACL that is run when an SMTP QUIT command is
12748 received. See chapter &<<CHAPACL>>& for further details.
12749
12750 .option acl_smtp_rcpt main string&!! unset
12751 .cindex "RCPT" "ACL for"
12752 This option defines the ACL that is run when an SMTP RCPT command is
12753 received. See chapter &<<CHAPACL>>& for further details.
12754
12755 .option acl_smtp_starttls main string&!! unset
12756 .cindex "STARTTLS, ACL for"
12757 This option defines the ACL that is run when an SMTP STARTTLS command is
12758 received. See chapter &<<CHAPACL>>& for further details.
12759
12760 .option acl_smtp_vrfy main string&!! unset
12761 .cindex "VRFY" "ACL for"
12762 This option defines the ACL that is run when an SMTP VRFY command is
12763 received. See chapter &<<CHAPACL>>& for further details.
12764
12765 .option admin_groups main "string list&!!" unset
12766 .cindex "admin user"
12767 This option is expanded just once, at the start of Exim's processing. If the
12768 current group or any of the supplementary groups of an Exim caller is in this
12769 colon-separated list, the caller has admin privileges. If all your system
12770 programmers are in a specific group, for example, you can give them all Exim
12771 admin privileges by putting that group in &%admin_groups%&. However, this does
12772 not permit them to read Exim's spool files (whose group owner is the Exim gid).
12773 To permit this, you have to add individuals to the Exim group.
12774
12775 .option allow_domain_literals main boolean false
12776 .cindex "domain literal"
12777 If this option is set, the RFC 2822 domain literal format is permitted in
12778 email addresses. The option is not set by default, because the domain literal
12779 format is not normally required these days, and few people know about it. It
12780 has, however, been exploited by mail abusers.
12781
12782 Unfortunately, it seems that some DNS black list maintainers are using this
12783 format to report black listing to postmasters. If you want to accept messages
12784 addressed to your hosts by IP address, you need to set
12785 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
12786 domains (defined in the named domain list &%local_domains%& in the default
12787 configuration). This &"magic string"& matches the domain literal form of all
12788 the local host's IP addresses.
12789
12790
12791 .option allow_mx_to_ip main boolean false
12792 .cindex "MX record" "pointing to IP address"
12793 It appears that more and more DNS zone administrators are breaking the rules
12794 and putting domain names that look like IP addresses on the right hand side of
12795 MX records. Exim follows the rules and rejects this, giving an error message
12796 that explains the mis-configuration. However, some other MTAs support this
12797 practice, so to avoid &"Why can't Exim do this?"& complaints,
12798 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
12799 recommended, except when you have no other choice.
12800
12801 .option allow_utf8_domains main boolean false
12802 .cindex "domain" "UTF-8 characters in"
12803 .cindex "UTF-8" "in domain name"
12804 Lots of discussion is going on about internationalized domain names. One
12805 camp is strongly in favour of just using UTF-8 characters, and it seems
12806 that at least two other MTAs permit this. This option allows Exim users to
12807 experiment if they wish.
12808
12809 If it is set true, Exim's domain parsing function allows valid
12810 UTF-8 multicharacters to appear in domain name components, in addition to
12811 letters, digits, and hyphens. However, just setting this option is not
12812 enough; if you want to look up these domain names in the DNS, you must also
12813 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
12814 suitable setting is:
12815 .code
12816 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
12817   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
12818 .endd
12819 Alternatively, you can just disable this feature by setting
12820 .code
12821 dns_check_names_pattern =
12822 .endd
12823 That is, set the option to an empty string so that no check is done.
12824
12825
12826 .option auth_advertise_hosts main "host list&!!" *
12827 .cindex "authentication" "advertising"
12828 .cindex "AUTH" "advertising"
12829 If any server authentication mechanisms are configured, Exim advertises them in
12830 response to an EHLO command only if the calling host matches this list.
12831 Otherwise, Exim does not advertise AUTH.
12832 Exim does not accept AUTH commands from clients to which it has not
12833 advertised the availability of AUTH. The advertising of individual
12834 authentication mechanisms can be controlled by the use of the
12835 &%server_advertise_condition%& generic authenticator option on the individual
12836 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
12837
12838 Certain mail clients (for example, Netscape) require the user to provide a name
12839 and password for authentication if AUTH is advertised, even though it may
12840 not be needed (the host may accept messages from hosts on its local LAN without
12841 authentication, for example). The &%auth_advertise_hosts%& option can be used
12842 to make these clients more friendly by excluding them from the set of hosts to
12843 which Exim advertises AUTH.
12844
12845 .cindex "AUTH" "advertising when encrypted"
12846 If you want to advertise the availability of AUTH only when the connection
12847 is encrypted using TLS, you can make use of the fact that the value of this
12848 option is expanded, with a setting like this:
12849 .code
12850 auth_advertise_hosts = ${if eq{$tls_cipher}{}{}{*}}
12851 .endd
12852 .vindex "&$tls_cipher$&"
12853 If &$tls_cipher$& is empty, the session is not encrypted, and the result of
12854 the expansion is empty, thus matching no hosts. Otherwise, the result of the
12855 expansion is *, which matches all hosts.
12856
12857
12858 .option auto_thaw main time 0s
12859 .cindex "thawing messages"
12860 .cindex "unfreezing messages"
12861 If this option is set to a time greater than zero, a queue runner will try a
12862 new delivery attempt on any frozen message, other than a bounce message, if
12863 this much time has passed since it was frozen. This may result in the message
12864 being re-frozen if nothing has changed since the last attempt. It is a way of
12865 saying &"keep on trying, even though there are big problems"&.
12866
12867 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
12868 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
12869 thought to be very useful any more, and its use should probably be avoided.
12870
12871 .option av_scanner main string "see below"
12872 This option is available if Exim is built with the content-scanning extension.
12873 It specifies which anti-virus scanner to use. The default value is:
12874 .code
12875 sophie:/var/run/sophie
12876 .endd
12877 If the value of &%av_scanner%& starts with a dollar character, it is expanded
12878 before use. See section &<<SECTscanvirus>>& for further details.
12879
12880
12881
12882 .option bi_command main string unset
12883 .oindex "&%-bi%&"
12884 This option supplies the name of a command that is run when Exim is called with
12885 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
12886 just the command name, it is not a complete command line. If an argument is
12887 required, it must come from the &%-oA%& command line option.
12888
12889
12890 .option bounce_message_file main string unset
12891 .cindex "bounce message" "customizing"
12892 .cindex "customizing" "bounce message"
12893 This option defines a template file containing paragraphs of text to be used
12894 for constructing bounce messages.  Details of the file's contents are given in
12895 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
12896
12897
12898 .option bounce_message_text main string unset
12899 When this option is set, its contents are included in the default bounce
12900 message immediately after &"This message was created automatically by mail
12901 delivery software."& It is not used if &%bounce_message_file%& is set.
12902
12903 .option bounce_return_body main boolean true
12904 .cindex "bounce message" "including body"
12905 This option controls whether the body of an incoming message is included in a
12906 bounce message when &%bounce_return_message%& is true. The default setting
12907 causes the entire message, both header and body, to be returned (subject to the
12908 value of &%bounce_return_size_limit%&). If this option is false, only the
12909 message header is included. In the case of a non-SMTP message containing an
12910 error that is detected during reception, only those header lines preceding the
12911 point at which the error was detected are returned.
12912 .cindex "bounce message" "including original"
12913
12914 .option bounce_return_message main boolean true
12915 If this option is set false, none of the original message is included in
12916 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
12917 &%bounce_return_body%&.
12918
12919
12920 .option bounce_return_size_limit main integer 100K
12921 .cindex "size" "of bounce, limit"
12922 .cindex "bounce message" "size limit"
12923 .cindex "limit" "bounce message size"
12924 This option sets a limit in bytes on the size of messages that are returned to
12925 senders as part of bounce messages when &%bounce_return_message%& is true. The
12926 limit should be less than the value of the global &%message_size_limit%& and of
12927 any &%message_size_limit%& settings on transports, to allow for the bounce text
12928 that Exim generates. If this option is set to zero there is no limit.
12929
12930 When the body of any message that is to be included in a bounce message is
12931 greater than the limit, it is truncated, and a comment pointing this out is
12932 added at the top. The actual cutoff may be greater than the value given, owing
12933 to the use of buffering for transferring the message in chunks (typically 8K in
12934 size). The idea is to save bandwidth on those undeliverable 15-megabyte
12935 messages.
12936
12937 .option bounce_sender_authentication main string unset
12938 .cindex "bounce message" "sender authentication"
12939 .cindex "authentication" "bounce message"
12940 .cindex "AUTH" "on bounce message"
12941 This option provides an authenticated sender address that is sent with any
12942 bounce messages generated by Exim that are sent over an authenticated SMTP
12943 connection. A typical setting might be:
12944 .code
12945 bounce_sender_authentication = mailer-daemon@my.domain.example
12946 .endd
12947 which would cause bounce messages to be sent using the SMTP command:
12948 .code
12949 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
12950 .endd
12951 The value of &%bounce_sender_authentication%& must always be a complete email
12952 address.
12953
12954 .option callout_domain_negative_expire main time 3h
12955 .cindex "caching" "callout timeouts"
12956 .cindex "callout" "caching timeouts"
12957 This option specifies the expiry time for negative callout cache data for a
12958 domain. See section &<<SECTcallver>>& for details of callout verification, and
12959 section &<<SECTcallvercache>>& for details of the caching.
12960
12961
12962 .option callout_domain_positive_expire main time 7d
12963 This option specifies the expiry time for positive callout cache data for a
12964 domain. See section &<<SECTcallver>>& for details of callout verification, and
12965 section &<<SECTcallvercache>>& for details of the caching.
12966
12967
12968 .option callout_negative_expire main time 2h
12969 This option specifies the expiry time for negative callout cache data for an
12970 address. See section &<<SECTcallver>>& for details of callout verification, and
12971 section &<<SECTcallvercache>>& for details of the caching.
12972
12973
12974 .option callout_positive_expire main time 24h
12975 This option specifies the expiry time for positive callout cache data for an
12976 address. See section &<<SECTcallver>>& for details of callout verification, and
12977 section &<<SECTcallvercache>>& for details of the caching.
12978
12979
12980 .option callout_random_local_part main string&!! "see below"
12981 This option defines the &"random"& local part that can be used as part of
12982 callout verification. The default value is
12983 .code
12984 $primary_host_name-$tod_epoch-testing
12985 .endd
12986 See section &<<CALLaddparcall>>& for details of how this value is used.
12987
12988
12989 .option check_log_inodes main integer 0
12990 See &%check_spool_space%& below.
12991
12992
12993 .option check_log_space main integer 0
12994 See &%check_spool_space%& below.
12995
12996 .oindex "&%check_rfc2047_length%&"
12997 .cindex "RFC 2047" "disabling length check"
12998 .option check_rfc2047_length main boolean true
12999 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13000 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13001 word; strings to be encoded that exceed this length are supposed to use
13002 multiple encoded words. By default, Exim does not recognize encoded words that
13003 exceed the maximum length. However, it seems that some software, in violation
13004 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13005 set false, Exim recognizes encoded words of any length.
13006
13007
13008 .option check_spool_inodes main integer 0
13009 See &%check_spool_space%& below.
13010
13011
13012 .option check_spool_space main integer 0
13013 .cindex "checking disk space"
13014 .cindex "disk space, checking"
13015 .cindex "spool directory" "checking space"
13016 The four &%check_...%& options allow for checking of disk resources before a
13017 message is accepted.
13018
13019 .vindex "&$log_inodes$&"
13020 .vindex "&$log_space$&"
13021 .vindex "&$spool_inodes$&"
13022 .vindex "&$spool_space$&"
13023 When any of these options are set, they apply to all incoming messages. If you
13024 want to apply different checks to different kinds of message, you can do so by
13025 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13026 &$spool_space$& in an ACL with appropriate additional conditions.
13027
13028
13029 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13030 either value is greater than zero, for example:
13031 .code
13032 check_spool_space = 10M
13033 check_spool_inodes = 100
13034 .endd
13035 The spool partition is the one that contains the directory defined by
13036 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13037 transit.
13038
13039 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13040 files are written if either is greater than zero. These should be set only if
13041 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13042
13043 If there is less space or fewer inodes than requested, Exim refuses to accept
13044 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13045 error response to the MAIL command. If ESMTP is in use and there was a
13046 SIZE parameter on the MAIL command, its value is added to the
13047 &%check_spool_space%& value, and the check is performed even if
13048 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13049
13050 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13051 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13052
13053 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13054 failure a message is written to stderr and Exim exits with a non-zero code, as
13055 it obviously cannot send an error message of any kind.
13056
13057 .option daemon_smtp_ports main string &`smtp`&
13058 .cindex "port" "for daemon"
13059 .cindex "TCP/IP" "setting listening ports"
13060 This option specifies one or more default SMTP ports on which the Exim daemon
13061 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13062 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13063
13064 .option daemon_startup_retries main integer 9
13065 .cindex "daemon startup, retrying"
13066 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13067 the daemon at startup when it cannot immediately bind a listening socket
13068 (typically because the socket is already in use): &%daemon_startup_retries%&
13069 defines the number of retries after the first failure, and
13070 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13071
13072 .option daemon_startup_sleep main time 30s
13073 See &%daemon_startup_retries%&.
13074
13075 .option delay_warning main "time list" 24h
13076 .cindex "warning of delay"
13077 .cindex "delay warning, specifying"
13078 When a message is delayed, Exim sends a warning message to the sender at
13079 intervals specified by this option. The data is a colon-separated list of times
13080 after which to send warning messages. If the value of the option is an empty
13081 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13082 message has been on the queue for longer than the last time, the last interval
13083 between the times is used to compute subsequent warning times. For example,
13084 with
13085 .code
13086 delay_warning = 4h:8h:24h
13087 .endd
13088 the first message is sent after 4 hours, the second after 8 hours, and
13089 the third one after 24 hours. After that, messages are sent every 16 hours,
13090 because that is the interval between the last two times on the list. If you set
13091 just one time, it specifies the repeat interval. For example, with:
13092 .code
13093 delay_warning = 6h
13094 .endd
13095 messages are repeated every six hours. To stop warnings after a given time, set
13096 a very large time at the end of the list. For example:
13097 .code
13098 delay_warning = 2h:12h:99d
13099 .endd
13100
13101 .option delay_warning_condition main string&!! "see below"
13102 .vindex "&$domain$&"
13103 The string is expanded at the time a warning message might be sent. If all the
13104 deferred addresses have the same domain, it is set in &$domain$& during the
13105 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13106 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13107 &"false"& (the comparison being done caselessly) then the warning message is
13108 not sent. The default is:
13109 .code
13110 delay_warning_condition = ${if or {\
13111   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13112   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13113   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13114   } {no}{yes}}
13115 .endd
13116 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13117 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13118 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13119 &"auto-replied"& in an &'Auto-Submitted:'& header.
13120
13121 .option deliver_drop_privilege main boolean false
13122 .cindex "unprivileged delivery"
13123 .cindex "delivery" "unprivileged"
13124 If this option is set true, Exim drops its root privilege at the start of a
13125 delivery process, and runs as the Exim user throughout. This severely restricts
13126 the kinds of local delivery that are possible, but is viable in certain types
13127 of configuration. There is a discussion about the use of root privilege in
13128 chapter &<<CHAPsecurity>>&.
13129
13130 .option deliver_queue_load_max main fixed-point unset
13131 .cindex "load average"
13132 .cindex "queue runner" "abandoning"
13133 When this option is set, a queue run is abandoned if the system load average
13134 becomes greater than the value of the option. The option has no effect on
13135 ancient operating systems on which Exim cannot determine the load average.
13136 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13137
13138
13139 .option delivery_date_remove main boolean true
13140 .cindex "&'Delivery-date:'& header line"
13141 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13142 message when it is delivered, in exactly the same way as &'Return-path:'& is
13143 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13144 should not be present in incoming messages, and this option causes them to be
13145 removed at the time the message is received, to avoid any problems that might
13146 occur when a delivered message is subsequently sent on to some other recipient.
13147
13148 .option disable_fsync main boolean false
13149 .cindex "&[fsync()]&, disabling"
13150 This option is available only if Exim was built with the compile-time option
13151 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13152 a runtime configuration generates an &"unknown option"& error. You should not
13153 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13154 really, really, really understand what you are doing. &'No pre-compiled
13155 distributions of Exim should ever make this option available.'&
13156
13157 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13158 updated files' data to be written to disc before continuing. Unexpected events
13159 such as crashes and power outages may cause data to be lost or scrambled.
13160 Here be Dragons. &*Beware.*&
13161
13162
13163 .option disable_ipv6 main boolean false
13164 .cindex "IPv6" "disabling"
13165 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13166 activities take place. AAAA records are never looked up, and any IPv6 addresses
13167 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13168 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13169 to handle IPv6 literal addresses.
13170
13171
13172 .option dns_again_means_nonexist main "domain list&!!" unset
13173 .cindex "DNS" "&""try again""& response; overriding"
13174 DNS lookups give a &"try again"& response for the DNS errors
13175 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13176 keep trying to deliver a message, or to give repeated temporary errors to
13177 incoming mail. Sometimes the effect is caused by a badly set up name server and
13178 may persist for a long time. If a domain which exhibits this problem matches
13179 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13180 This option should be used with care. You can make it apply to reverse lookups
13181 by a setting such as this:
13182 .code
13183 dns_again_means_nonexist = *.in-addr.arpa
13184 .endd
13185 This option applies to all DNS lookups that Exim does. It also applies when the
13186 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13187 since these are most likely to be caused by DNS lookup problems. The
13188 &(dnslookup)& router has some options of its own for controlling what happens
13189 when lookups for MX or SRV records give temporary errors. These more specific
13190 options are applied after this global option.
13191
13192 .option dns_check_names_pattern main string "see below"
13193 .cindex "DNS" "pre-check of name syntax"
13194 When this option is set to a non-empty string, it causes Exim to check domain
13195 names for characters that are not allowed in host names before handing them to
13196 the DNS resolver, because some resolvers give temporary errors for names that
13197 contain unusual characters. If a domain name contains any unwanted characters,
13198 a &"not found"& result is forced, and the resolver is not called. The check is
13199 done by matching the domain name against a regular expression, which is the
13200 value of this option. The default pattern is
13201 .code
13202 dns_check_names_pattern = \
13203   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13204 .endd
13205 which permits only letters, digits, slashes, and hyphens in components, but
13206 they must start and end with a letter or digit. Slashes are not, in fact,
13207 permitted in host names, but they are found in certain NS records (which can be
13208 accessed in Exim by using a &%dnsdb%& lookup). If you set
13209 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13210 empty string.
13211
13212 .option dns_csa_search_limit main integer 5
13213 This option controls the depth of parental searching for CSA SRV records in the
13214 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13215
13216 .option dns_csa_use_reverse main boolean true
13217 This option controls whether or not an IP address, given as a CSA domain, is
13218 reversed and looked up in the reverse DNS, as described in more detail in
13219 section &<<SECTverifyCSA>>&.
13220
13221 .option dns_ipv4_lookup main "domain list&!!" unset
13222 .cindex "IPv6" "DNS lookup for AAAA records"
13223 .cindex "DNS" "IPv6 lookup for AAAA records"
13224 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13225 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13226 (A records) when trying to find IP addresses for hosts, unless the host's
13227 domain matches this list.
13228
13229 This is a fudge to help with name servers that give big delays or otherwise do
13230 not work for the AAAA record type. In due course, when the world's name
13231 servers have all been upgraded, there should be no need for this option.
13232
13233
13234 .option dns_retrans main time 0s
13235 .cindex "DNS" "resolver options"
13236 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13237 retransmission and retry parameters for DNS lookups. Values of zero (the
13238 defaults) leave the system default settings unchanged. The first value is the
13239 time between retries, and the second is the number of retries. It isn't
13240 totally clear exactly how these settings affect the total time a DNS lookup may
13241 take. I haven't found any documentation about timeouts on DNS lookups; these
13242 parameter values are available in the external resolver interface structure,
13243 but nowhere does it seem to describe how they are used or what you might want
13244 to set in them.
13245
13246
13247 .option dns_retry main integer 0
13248 See &%dns_retrans%& above.
13249
13250
13251 .option drop_cr main boolean false
13252 This is an obsolete option that is now a no-op. It used to affect the way Exim
13253 handled CR and LF characters in incoming messages. What happens now is
13254 described in section &<<SECTlineendings>>&.
13255
13256 .option dsn_from main "string&!!" "see below"
13257 .cindex "&'From:'& header line" "in bounces"
13258 .cindex "bounce messages" "&'From:'& line, specifying"
13259 This option can be used to vary the contents of &'From:'& header lines in
13260 bounces and other automatically generated messages (&"Delivery Status
13261 Notifications"& &-- hence the name of the option). The default setting is:
13262 .code
13263 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13264 .endd
13265 The value is expanded every time it is needed. If the expansion fails, a
13266 panic is logged, and the default value is used.
13267
13268 .option envelope_to_remove main boolean true
13269 .cindex "&'Envelope-to:'& header line"
13270 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13271 message when it is delivered, in exactly the same way as &'Return-path:'& is
13272 handled. &'Envelope-to:'& records the original recipient address from the
13273 messages's envelope that caused the delivery to happen. Such headers should not
13274 be present in incoming messages, and this option causes them to be removed at
13275 the time the message is received, to avoid any problems that might occur when a
13276 delivered message is subsequently sent on to some other recipient.
13277
13278
13279 .option errors_copy main "string list&!!" unset
13280 .cindex "bounce message" "copy to other address"
13281 .cindex "copy of bounce message"
13282 Setting this option causes Exim to send bcc copies of bounce messages that it
13283 generates to other addresses. &*Note*&: This does not apply to bounce messages
13284 coming from elsewhere. The value of the option is a colon-separated list of
13285 items. Each item consists of a pattern, terminated by white space, followed by
13286 a comma-separated list of email addresses. If a pattern contains spaces, it
13287 must be enclosed in double quotes.
13288
13289 Each pattern is processed in the same way as a single item in an address list
13290 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13291 the bounce message, the message is copied to the addresses on the list. The
13292 items are scanned in order, and once a matching one is found, no further items
13293 are examined. For example:
13294 .code
13295 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13296               rqps@mydomain   hostmaster@mydomain.example,\
13297                               postmaster@mydomain.example
13298 .endd
13299 .vindex "&$domain$&"
13300 .vindex "&$local_part$&"
13301 The address list is expanded before use. The expansion variables &$local_part$&
13302 and &$domain$& are set from the original recipient of the error message, and if
13303 there was any wildcard matching in the pattern, the expansion
13304 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13305 variables &$0$&, &$1$&, etc. are set in the normal way.
13306
13307
13308 .option errors_reply_to main string unset
13309 .cindex "bounce message" "&'Reply-to:'& in"
13310 By default, Exim's bounce and delivery warning messages contain the header line
13311 .display
13312 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13313 .endd
13314 .oindex &%quota_warn_message%&
13315 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13316 A warning message that is generated by the &%quota_warn_message%& option in an
13317 &(appendfile)& transport may contain its own &'From:'& header line that
13318 overrides the default.
13319
13320 Experience shows that people reply to bounce messages. If the
13321 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13322 and warning messages. For example:
13323 .code
13324 errors_reply_to = postmaster@my.domain.example
13325 .endd
13326 The value of the option is not expanded. It must specify a valid RFC 2822
13327 address. However, if a warning message that is generated by the
13328 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13329 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13330 not used.
13331
13332
13333 .option exim_group main string "compile-time configured"
13334 .cindex "gid (group id)" "Exim's own"
13335 .cindex "Exim group"
13336 This option changes the gid under which Exim runs when it gives up root
13337 privilege. The default value is compiled into the binary. The value of this
13338 option is used only when &%exim_user%& is also set. Unless it consists entirely
13339 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13340 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13341 security issues.
13342
13343
13344 .option exim_path main string "see below"
13345 .cindex "Exim binary, path name"
13346 This option specifies the path name of the Exim binary, which is used when Exim
13347 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13348 the directory configured at compile time by the BIN_DIRECTORY setting. It
13349 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13350 other place.
13351 &*Warning*&: Do not use a macro to define the value of this option, because
13352 you will break those Exim utilities that scan the configuration file to find
13353 where the binary is. (They then use the &%-bP%& option to extract option
13354 settings such as the value of &%spool_directory%&.)
13355
13356
13357 .option exim_user main string "compile-time configured"
13358 .cindex "uid (user id)" "Exim's own"
13359 .cindex "Exim user"
13360 This option changes the uid under which Exim runs when it gives up root
13361 privilege. The default value is compiled into the binary. Ownership of the run
13362 time configuration file and the use of the &%-C%& and &%-D%& command line
13363 options is checked against the values in the binary, not what is set here.
13364
13365 Unless it consists entirely of digits, the string is looked up using
13366 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13367 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13368 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13369
13370
13371 .option extra_local_interfaces main "string list" unset
13372 This option defines network interfaces that are to be considered local when
13373 routing, but which are not used for listening by the daemon. See section
13374 &<<SECTreclocipadd>>& for details.
13375
13376
13377 . Allow this long option name to split; give it unsplit as a fifth argument
13378 . for the automatic .oindex that is generated by .option.
13379
13380 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13381          extract_addresses_remove_arguments
13382 .oindex "&%-t%&"
13383 .cindex "command line" "addresses with &%-t%&"
13384 .cindex "Sendmail compatibility" "&%-t%& option"
13385 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13386 are present on the command line when the &%-t%& option is used to build an
13387 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13388 line addresses are removed from the recipients list. This is also how Smail
13389 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13390 command line addresses are added to those obtained from the header lines. When
13391 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13392 argument headers. If it is set false, Exim adds rather than removes argument
13393 addresses.
13394
13395
13396 .option finduser_retries main integer 0
13397 .cindex "NIS, retrying user lookups"
13398 On systems running NIS or other schemes in which user and group information is
13399 distributed from a remote system, there can be times when &[getpwnam()]& and
13400 related functions fail, even when given valid data, because things time out.
13401 Unfortunately these failures cannot be distinguished from genuine &"not found"&
13402 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
13403 many extra times to find a user or a group, waiting for one second between
13404 retries.
13405
13406 .cindex "&_/etc/passwd_&" "multiple reading of"
13407 You should not set this option greater than zero if your user information is in
13408 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
13409 search the file multiple times for non-existent users, and also cause delay.
13410
13411
13412
13413 .option freeze_tell main "string list, comma separated" unset
13414 .cindex "freezing messages" "sending a message when freezing"
13415 On encountering certain errors, or when configured to do so in a system filter,
13416 ACL, or special router, Exim freezes a message. This means that no further
13417 delivery attempts take place until an administrator thaws the message, or the
13418 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
13419 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
13420 warning message whenever it freezes something, unless the message it is
13421 freezing is a locally-generated bounce message. (Without this exception there
13422 is the possibility of looping.) The warning message is sent to the addresses
13423 supplied as the comma-separated value of this option. If several of the
13424 message's addresses cause freezing, only a single message is sent. If the
13425 freezing was automatic, the reason(s) for freezing can be found in the message
13426 log. If you configure freezing in a filter or ACL, you must arrange for any
13427 logging that you require.
13428
13429
13430 .option gecos_name main string&!! unset
13431 .cindex "HP-UX"
13432 .cindex "&""gecos""& field, parsing"
13433 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
13434 password file to hold other information in addition to users' real names. Exim
13435 looks up this field for use when it is creating &'Sender:'& or &'From:'&
13436 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
13437 of the field are used unchanged, except that, if an ampersand is encountered,
13438 it is replaced by the user's login name with the first character forced to
13439 upper case, since this is a convention that is observed on many systems.
13440
13441 When these options are set, &%gecos_pattern%& is treated as a regular
13442 expression that is to be applied to the field (again with && replaced by the
13443 login name), and if it matches, &%gecos_name%& is expanded and used as the
13444 user's name.
13445
13446 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
13447 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
13448 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
13449 name terminates at the first comma, the following can be used:
13450 .code
13451 gecos_pattern = ([^,]*)
13452 gecos_name = $1
13453 .endd
13454
13455 .option gecos_pattern main string unset
13456 See &%gecos_name%& above.
13457
13458
13459 .option gnutls_require_kx main string unset
13460 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
13461 server. For details, see section &<<SECTreqciphgnu>>&.
13462
13463 .option gnutls_require_mac main string unset
13464 This option controls the MAC algorithms when GnuTLS is used in an Exim
13465 server. For details, see section &<<SECTreqciphgnu>>&.
13466
13467 .option gnutls_require_protocols main string unset
13468 This option controls the protocols when GnuTLS is used in an Exim
13469 server. For details, see section &<<SECTreqciphgnu>>&.
13470
13471 .option gnutls_compat_mode main boolean unset
13472 This option controls whether GnuTLS is used in compatibility mode in an Exim
13473 server. This reduces security slightly, but improves interworking with older
13474 implementations of TLS.
13475
13476 .option headers_charset main string "see below"
13477 This option sets a default character set for translating from encoded MIME
13478 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
13479 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
13480 ultimate default is ISO-8859-1. For more details see the description of header
13481 insertions in section &<<SECTexpansionitems>>&.
13482
13483
13484
13485 .option header_maxsize main integer "see below"
13486 .cindex "header section" "maximum size of"
13487 .cindex "limit" "size of message header section"
13488 This option controls the overall maximum size of a message's header
13489 section. The default is the value of HEADER_MAXSIZE in
13490 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
13491 sections are rejected.
13492
13493
13494 .option header_line_maxsize main integer 0
13495 .cindex "header lines" "maximum size of"
13496 .cindex "limit" "size of one header line"
13497 This option limits the length of any individual header line in a message, after
13498 all the continuations have been joined together. Messages with individual
13499 header lines that are longer than the limit are rejected. The default value of
13500 zero means &"no limit"&.
13501
13502
13503
13504
13505 .option helo_accept_junk_hosts main "host list&!!" unset
13506 .cindex "HELO" "accepting junk data"
13507 .cindex "EHLO" "accepting junk data"
13508 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
13509 mail, and gives an error response for invalid data. Unfortunately, there are
13510 some SMTP clients that send syntactic junk. They can be accommodated by setting
13511 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
13512 if you want to do semantic checking.
13513 See also &%helo_allow_chars%& for a way of extending the permitted character
13514 set.
13515
13516
13517 .option helo_allow_chars main string unset
13518 .cindex "HELO" "underscores in"
13519 .cindex "EHLO" "underscores in"
13520 .cindex "underscore in EHLO/HELO"
13521 This option can be set to a string of rogue characters that are permitted in
13522 all EHLO and HELO names in addition to the standard letters, digits,
13523 hyphens, and dots. If you really must allow underscores, you can set
13524 .code
13525 helo_allow_chars = _
13526 .endd
13527 Note that the value is one string, not a list.
13528
13529
13530 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
13531 .cindex "HELO" "forcing reverse lookup"
13532 .cindex "EHLO" "forcing reverse lookup"
13533 If the domain given by a client in a HELO or EHLO command matches this
13534 list, a reverse lookup is done in order to establish the host's true name. The
13535 default forces a lookup if the client host gives the server's name or any of
13536 its IP addresses (in brackets), something that broken clients have been seen to
13537 do.
13538
13539
13540 .option helo_try_verify_hosts main "host list&!!" unset
13541 .cindex "HELO verifying" "optional"
13542 .cindex "EHLO" "verifying, optional"
13543 By default, Exim just checks the syntax of HELO and EHLO commands (see
13544 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
13545 to do more extensive checking of the data supplied by these commands. The ACL
13546 condition &`verify = helo`& is provided to make this possible.
13547 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
13548 to force the check to occur. From release 4.53 onwards, this is no longer
13549 necessary. If the check has not been done before &`verify = helo`& is
13550 encountered, it is done at that time. Consequently, this option is obsolete.
13551 Its specification is retained here for backwards compatibility.
13552
13553 When an EHLO or HELO command is received, if the calling host matches
13554 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
13555 EHLO command either:
13556
13557 .ilist
13558 is an IP literal matching the calling address of the host, or
13559 .next
13560 .cindex "DNS" "reverse lookup"
13561 .cindex "reverse DNS lookup"
13562 matches the host name that Exim obtains by doing a reverse lookup of the
13563 calling host address, or
13564 .next
13565 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
13566 available) yields the calling host address.
13567 .endlist
13568
13569 However, the EHLO or HELO command is not rejected if any of the checks
13570 fail. Processing continues, but the result of the check is remembered, and can
13571 be detected later in an ACL by the &`verify = helo`& condition.
13572
13573 .option helo_verify_hosts main "host list&!!" unset
13574 .cindex "HELO verifying" "mandatory"
13575 .cindex "EHLO" "verifying, mandatory"
13576 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
13577 backwards compatibility. For hosts that match this option, Exim checks the host
13578 name given in the HELO or EHLO in the same way as for
13579 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
13580 rejected with a 550 error, and entries are written to the main and reject logs.
13581 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
13582 error.
13583
13584 .option hold_domains main "domain list&!!" unset
13585 .cindex "domain" "delaying delivery"
13586 .cindex "delivery" "delaying certain domains"
13587 This option allows mail for particular domains to be held on the queue
13588 manually. The option is overridden if a message delivery is forced with the
13589 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
13590 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
13591 item in &%hold_domains%&, no routing or delivery for that address is done, and
13592 it is deferred every time the message is looked at.
13593
13594 This option is intended as a temporary operational measure for delaying the
13595 delivery of mail while some problem is being sorted out, or some new
13596 configuration tested. If you just want to delay the processing of some
13597 domains until a queue run occurs, you should use &%queue_domains%& or
13598 &%queue_smtp_domains%&, not &%hold_domains%&.
13599
13600 A setting of &%hold_domains%& does not override Exim's code for removing
13601 messages from the queue if they have been there longer than the longest retry
13602 time in any retry rule. If you want to hold messages for longer than the normal
13603 retry times, insert a dummy retry rule with a long retry time.
13604
13605
13606 .option host_lookup main "host list&!!" unset
13607 .cindex "host name" "lookup, forcing"
13608 Exim does not look up the name of a calling host from its IP address unless it
13609 is required to compare against some host list, or the host matches
13610 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
13611 option (which normally contains IP addresses rather than host names). The
13612 default configuration file contains
13613 .code
13614 host_lookup = *
13615 .endd
13616 which causes a lookup to happen for all hosts. If the expense of these lookups
13617 is felt to be too great, the setting can be changed or removed.
13618
13619 After a successful reverse lookup, Exim does a forward lookup on the name it
13620 has obtained, to verify that it yields the IP address that it started with. If
13621 this check fails, Exim behaves as if the name lookup failed.
13622
13623 .vindex "&$host_lookup_failed$&"
13624 .vindex "&$sender_host_name$&"
13625 After any kind of failure, the host name (in &$sender_host_name$&) remains
13626 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
13627 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
13628 &`verify = reverse_host_lookup`& in ACLs.
13629
13630
13631 .option host_lookup_order main "string list" &`bydns:byaddr`&
13632 This option specifies the order of different lookup methods when Exim is trying
13633 to find a host name from an IP address. The default is to do a DNS lookup
13634 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
13635 if that fails. You can change the order of these lookups, or omit one entirely,
13636 if you want.
13637
13638 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
13639 multiple PTR records in the DNS and the IP address is not listed in
13640 &_/etc/hosts_&. Different operating systems give different results in this
13641 case. That is why the default tries a DNS lookup first.
13642
13643
13644
13645 .option host_reject_connection main "host list&!!" unset
13646 .cindex "host" "rejecting connections from"
13647 If this option is set, incoming SMTP calls from the hosts listed are rejected
13648 as soon as the connection is made.
13649 This option is obsolete, and retained only for backward compatibility, because
13650 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
13651 connections immediately.
13652
13653 The ability to give an immediate rejection (either by this option or using an
13654 ACL) is provided for use in unusual cases. Many hosts will just try again,
13655 sometimes without much delay. Normally, it is better to use an ACL to reject
13656 incoming messages at a later stage, such as after RCPT commands. See
13657 chapter &<<CHAPACL>>&.
13658
13659
13660 .option hosts_connection_nolog main "host list&!!" unset
13661 .cindex "host" "not logging connections from"
13662 This option defines a list of hosts for which connection logging does not
13663 happen, even though the &%smtp_connection%& log selector is set. For example,
13664 you might want not to log SMTP connections from local processes, or from
13665 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
13666 the daemon; you should therefore strive to restrict its value to a short inline
13667 list of IP addresses and networks. To disable logging SMTP connections from
13668 local processes, you must create a host list with an empty item. For example:
13669 .code
13670 hosts_connection_nolog = :
13671 .endd
13672 If the &%smtp_connection%& log selector is not set, this option has no effect.
13673
13674
13675
13676 .option hosts_treat_as_local main "domain list&!!" unset
13677 .cindex "local host" "domains treated as"
13678 .cindex "host" "treated as local"
13679 If this option is set, any host names that match the domain list are treated as
13680 if they were the local host when Exim is scanning host lists obtained from MX
13681 records
13682 or other sources. Note that the value of this option is a domain list, not a
13683 host list, because it is always used to check host names, not IP addresses.
13684
13685 This option also applies when Exim is matching the special items
13686 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
13687 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
13688 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
13689 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
13690 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
13691 interfaces and recognizing the local host.
13692
13693
13694 .option ibase_servers main "string list" unset
13695 .cindex "InterBase" "server list"
13696 This option provides a list of InterBase servers and associated connection data,
13697 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
13698 The option is available only if Exim has been built with InterBase support.
13699
13700
13701
13702 .option ignore_bounce_errors_after main time 10w
13703 .cindex "bounce message" "discarding"
13704 .cindex "discarding bounce message"
13705 This option affects the processing of bounce messages that cannot be delivered,
13706 that is, those that suffer a permanent delivery failure. (Bounce messages that
13707 suffer temporary delivery failures are of course retried in the usual way.)
13708
13709 After a permanent delivery failure, bounce messages are frozen,
13710 because there is no sender to whom they can be returned. When a frozen bounce
13711 message has been on the queue for more than the given time, it is unfrozen at
13712 the next queue run, and a further delivery is attempted. If delivery fails
13713 again, the bounce message is discarded. This makes it possible to keep failed
13714 bounce messages around for a shorter time than the normal maximum retry time
13715 for frozen messages. For example,
13716 .code
13717 ignore_bounce_errors_after = 12h
13718 .endd
13719 retries failed bounce message deliveries after 12 hours, discarding any further
13720 failures. If the value of this option is set to a zero time period, bounce
13721 failures are discarded immediately. Setting a very long time (as in the default
13722 value) has the effect of disabling this option. For ways of automatically
13723 dealing with other kinds of frozen message, see &%auto_thaw%& and
13724 &%timeout_frozen_after%&.
13725
13726
13727 .option ignore_fromline_hosts main "host list&!!" unset
13728 .cindex "&""From""& line"
13729 .cindex "UUCP" "&""From""& line"
13730 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
13731 the headers of a message. By default this is treated as the start of the
13732 message's body, which means that any following headers are not recognized as
13733 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
13734 match those hosts that insist on sending it. If the sender is actually a local
13735 process rather than a remote host, and is using &%-bs%& to inject the messages,
13736 &%ignore_fromline_local%& must be set to achieve this effect.
13737
13738
13739 .option ignore_fromline_local main boolean false
13740 See &%ignore_fromline_hosts%& above.
13741
13742
13743 .option keep_malformed main time 4d
13744 This option specifies the length of time to keep messages whose spool files
13745 have been corrupted in some way. This should, of course, never happen. At the
13746 next attempt to deliver such a message, it gets removed. The incident is
13747 logged.
13748
13749
13750 .option ldap_default_servers main "string list" unset
13751 .cindex "LDAP" "default servers"
13752 This option provides a list of LDAP servers which are tried in turn when an
13753 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
13754 details of LDAP queries. This option is available only when Exim has been built
13755 with LDAP support.
13756
13757
13758 .option ldap_version main integer unset
13759 .cindex "LDAP" "protocol version, forcing"
13760 This option can be used to force Exim to set a specific protocol version for
13761 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
13762 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
13763 the LDAP headers; otherwise it is 2. This option is available only when Exim
13764 has been built with LDAP support.
13765
13766
13767
13768 .option local_from_check main boolean true
13769 .cindex "&'Sender:'& header line" "disabling addition of"
13770 .cindex "&'From:'& header line" "disabling checking of"
13771 When a message is submitted locally (that is, not over a TCP/IP connection) by
13772 an untrusted user, Exim removes any existing &'Sender:'& header line, and
13773 checks that the &'From:'& header line matches the login of the calling user and
13774 the domain specified by &%qualify_domain%&.
13775
13776 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
13777 locally submitted message is automatically qualified by Exim, unless the
13778 &%-bnq%& command line option is used.
13779
13780 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
13781 on the local part. If the &'From:'& header line does not match, Exim adds a
13782 &'Sender:'& header with an address constructed from the calling user's login
13783 and the default qualify domain.
13784
13785 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
13786 and no &'Sender:'& header is ever added. If, in addition, you want to retain
13787 &'Sender:'& header lines supplied by untrusted users, you must also set
13788 &%local_sender_retain%& to be true.
13789
13790 .cindex "envelope sender"
13791 These options affect only the header lines in the message. The envelope sender
13792 is still forced to be the login id at the qualify domain unless
13793 &%untrusted_set_sender%& permits the user to supply an envelope sender.
13794
13795 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
13796 request similar header line checking. See section &<<SECTthesenhea>>&, which
13797 has more details about &'Sender:'& processing.
13798
13799
13800
13801
13802 .option local_from_prefix main string unset
13803 When Exim checks the &'From:'& header line of locally submitted messages for
13804 matching the login id (see &%local_from_check%& above), it can be configured to
13805 ignore certain prefixes and suffixes in the local part of the address. This is
13806 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
13807 appropriate lists, in the same form as the &%local_part_prefix%& and
13808 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
13809 example, if
13810 .code
13811 local_from_prefix = *-
13812 .endd
13813 is set, a &'From:'& line containing
13814 .code
13815 From: anything-user@your.domain.example
13816 .endd
13817 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
13818 matches the actual sender address that is constructed from the login name and
13819 qualify domain.
13820
13821
13822 .option local_from_suffix main string unset
13823 See &%local_from_prefix%& above.
13824
13825
13826 .option local_interfaces main "string list" "see below"
13827 This option controls which network interfaces are used by the daemon for
13828 listening; they are also used to identify the local host when routing. Chapter
13829 &<<CHAPinterfaces>>& contains a full description of this option and the related
13830 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
13831 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
13832 &%local_interfaces%& is
13833 .code
13834 local_interfaces = 0.0.0.0
13835 .endd
13836 when Exim is built without IPv6 support; otherwise it is
13837 .code
13838 local_interfaces = <; ::0 ; 0.0.0.0
13839 .endd
13840
13841 .option local_scan_timeout main time 5m
13842 .cindex "timeout" "for &[local_scan()]& function"
13843 .cindex "&[local_scan()]& function" "timeout"
13844 This timeout applies to the &[local_scan()]& function (see chapter
13845 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
13846 the incoming message is rejected with a temporary error if it is an SMTP
13847 message. For a non-SMTP message, the message is dropped and Exim ends with a
13848 non-zero code. The incident is logged on the main and reject logs.
13849
13850
13851
13852 .option local_sender_retain main boolean false
13853 .cindex "&'Sender:'& header line" "retaining from local submission"
13854 When a message is submitted locally (that is, not over a TCP/IP connection) by
13855 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
13856 do not want this to happen, you must set &%local_sender_retain%&, and you must
13857 also set &%local_from_check%& to be false (Exim will complain if you do not).
13858 See also the ACL modifier &`control = suppress_local_fixups`&. Section
13859 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
13860
13861
13862
13863
13864 .option localhost_number main string&!! unset
13865 .cindex "host" "locally unique number for"
13866 .cindex "message ids" "with multiple hosts"
13867 .vindex "&$localhost_number$&"
13868 Exim's message ids are normally unique only within the local host. If
13869 uniqueness among a set of hosts is required, each host must set a different
13870 value for the &%localhost_number%& option. The string is expanded immediately
13871 after reading the configuration file (so that a number can be computed from the
13872 host name, for example) and the result of the expansion must be a number in the
13873 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
13874 systems). This is available in subsequent string expansions via the variable
13875 &$localhost_number$&. When &%localhost_number is set%&, the final two
13876 characters of the message id, instead of just being a fractional part of the
13877 time, are computed from the time and the local host number as described in
13878 section &<<SECTmessiden>>&.
13879
13880
13881
13882 .option log_file_path main "string list&!!" "set at compile time"
13883 .cindex "log" "file path for"
13884 This option sets the path which is used to determine the names of Exim's log
13885 files, or indicates that logging is to be to syslog, or both. It is expanded
13886 when Exim is entered, so it can, for example, contain a reference to the host
13887 name. If no specific path is set for the log files at compile or run time, they
13888 are written in a sub-directory called &_log_& in Exim's spool directory.
13889 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
13890 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
13891 used. If this string is fixed at your installation (contains no expansion
13892 variables) it is recommended that you do not set this option in the
13893 configuration file, but instead supply the path using LOG_FILE_PATH in
13894 &_Local/Makefile_& so that it is available to Exim for logging errors detected
13895 early on &-- in particular, failure to read the configuration file.
13896
13897
13898 .option log_selector main string unset
13899 .cindex "log" "selectors"
13900 This option can be used to reduce or increase the number of things that Exim
13901 writes to its log files. Its argument is made up of names preceded by plus or
13902 minus characters. For example:
13903 .code
13904 log_selector = +arguments -retry_defer
13905 .endd
13906 A list of possible names and what they control is given in the chapter on
13907 logging, in section &<<SECTlogselector>>&.
13908
13909
13910 .option log_timezone main boolean false
13911 .cindex "log" "timezone for entries"
13912 .vindex "&$tod_log$&"
13913 .vindex "&$tod_zone$&"
13914 By default, the timestamps on log lines are in local time without the
13915 timezone. This means that if your timezone changes twice a year, the timestamps
13916 in log lines are ambiguous for an hour when the clocks go back. One way of
13917 avoiding this problem is to set the timezone to UTC. An alternative is to set
13918 &%log_timezone%& true. This turns on the addition of the timezone offset to
13919 timestamps in log lines. Turning on this option can add quite a lot to the size
13920 of log files because each line is extended by 6 characters. Note that the
13921 &$tod_log$& variable contains the log timestamp without the zone, but there is
13922 another variable called &$tod_zone$& that contains just the timezone offset.
13923
13924
13925 .option lookup_open_max main integer 25
13926 .cindex "too many open files"
13927 .cindex "open files, too many"
13928 .cindex "file" "too many open"
13929 .cindex "lookup" "maximum open files"
13930 .cindex "limit" "open files for lookups"
13931 This option limits the number of simultaneously open files for single-key
13932 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
13933 Exim normally keeps these files open during routing, because often the same
13934 file is required several times. If the limit is reached, Exim closes the least
13935 recently used file. Note that if you are using the &'ndbm'& library, it
13936 actually opens two files for each logical DBM database, though it still counts
13937 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
13938 open files"& errors with NDBM, you need to reduce the value of
13939 &%lookup_open_max%&.
13940
13941
13942 .option max_username_length main integer 0
13943 .cindex "length of login name"
13944 .cindex "user name" "maximum length"
13945 .cindex "limit" "user name length"
13946 Some operating systems are broken in that they truncate long arguments to
13947 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
13948 this option is set greater than zero, any attempt to call &[getpwnam()]& with
13949 an argument that is longer behaves as if &[getpwnam()]& failed.
13950
13951
13952 .option message_body_newlines main bool false
13953 .cindex "message body" "newlines in variables"
13954 .cindex "newline" "in message body variables"
13955 .vindex "&$message_body$&"
13956 .vindex "&$message_body_end$&"
13957 By default, newlines in the message body are replaced by spaces when setting
13958 the &$message_body$& and &$message_body_end$& expansion variables. If this
13959 option is set true, this no longer happens.
13960
13961
13962 .option message_body_visible main integer 500
13963 .cindex "body of message" "visible size"
13964 .cindex "message body" "visible size"
13965 .vindex "&$message_body$&"
13966 .vindex "&$message_body_end$&"
13967 This option specifies how much of a message's body is to be included in the
13968 &$message_body$& and &$message_body_end$& expansion variables.
13969
13970
13971 .option message_id_header_domain main string&!! unset
13972 .cindex "&'Message-ID:'& header line"
13973 If this option is set, the string is expanded and used as the right hand side
13974 (domain) of the &'Message-ID:'& header that Exim creates if a
13975 locally-originated incoming message does not have one. &"Locally-originated"&
13976 means &"not received over TCP/IP."&
13977 Otherwise, the primary host name is used.
13978 Only letters, digits, dot and hyphen are accepted; any other characters are
13979 replaced by hyphens. If the expansion is forced to fail, or if the result is an
13980 empty string, the option is ignored.
13981
13982
13983 .option message_id_header_text main string&!! unset
13984 If this variable is set, the string is expanded and used to augment the text of
13985 the &'Message-id:'& header that Exim creates if a locally-originated incoming
13986 message does not have one. The text of this header is required by RFC 2822 to
13987 take the form of an address. By default, Exim uses its internal message id as
13988 the local part, and the primary host name as the domain. If this option is set,
13989 it is expanded, and provided the expansion is not forced to fail, and does not
13990 yield an empty string, the result is inserted into the header immediately
13991 before the @, separated from the internal message id by a dot. Any characters
13992 that are illegal in an address are automatically converted into hyphens. This
13993 means that variables such as &$tod_log$& can be used, because the spaces and
13994 colons will become hyphens.
13995
13996
13997 .option message_logs main boolean true
13998 .cindex "message logs" "disabling"
13999 .cindex "log" "message log; disabling"
14000 If this option is turned off, per-message log files are not created in the
14001 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14002 Exim, by reducing the number of files involved in handling a message from a
14003 minimum of four (header spool file, body spool file, delivery journal, and
14004 per-message log) to three. The other major I/O activity is Exim's main log,
14005 which is not affected by this option.
14006
14007
14008 .option message_size_limit main string&!! 50M
14009 .cindex "message" "size limit"
14010 .cindex "limit" "message size"
14011 .cindex "size" "of message, limit"
14012 This option limits the maximum size of message that Exim will process. The
14013 value is expanded for each incoming connection so, for example, it can be made
14014 to depend on the IP address of the remote host for messages arriving via
14015 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14016 optionally followed by K or M.
14017
14018 &*Note*&: This limit cannot be made to depend on a message's sender or any
14019 other properties of an individual message, because it has to be advertised in
14020 the server's response to EHLO. String expansion failure causes a temporary
14021 error. A value of zero means no limit, but its use is not recommended. See also
14022 &%bounce_return_size_limit%&.
14023
14024 Incoming SMTP messages are failed with a 552 error if the limit is
14025 exceeded; locally-generated messages either get a stderr message or a delivery
14026 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14027 an oversized message is logged in both the main and the reject logs. See also
14028 the generic transport option &%message_size_limit%&, which limits the size of
14029 message that an individual transport can process.
14030
14031 If you use a virus-scanner and set this option to to a value larger than the
14032 maximum size that your virus-scanner is configured to support, you may get
14033 failures triggered by large mails.  The right size to configure for the
14034 virus-scanner depends upon what data is passed and the options in use but it's
14035 probably safest to just set it to a little larger than this value.  Eg, with a
14036 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14037 some problems may result.
14038
14039
14040 .option move_frozen_messages main boolean false
14041 .cindex "frozen messages" "moving"
14042 This option, which is available only if Exim has been built with the setting
14043 .code
14044 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14045 .endd
14046 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14047 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14048 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14049 standard utilities for handling such moved messages, and they do not show up in
14050 lists generated by &%-bp%& or by the Exim monitor.
14051
14052
14053 .option mua_wrapper main boolean false
14054 Setting this option true causes Exim to run in a very restrictive mode in which
14055 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14056 contains a full description of this facility.
14057
14058
14059
14060 .option mysql_servers main "string list" unset
14061 .cindex "MySQL" "server list"
14062 This option provides a list of MySQL servers and associated connection data, to
14063 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14064 option is available only if Exim has been built with MySQL support.
14065
14066
14067 .option never_users main "string list&!!" unset
14068 This option is expanded just once, at the start of Exim's processing. Local
14069 message deliveries are normally run in processes that are setuid to the
14070 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14071 It is usually desirable to prevent any deliveries from running as root, as a
14072 safety precaution.
14073
14074 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14075 list of users that must not be used for local deliveries. This list is fixed in
14076 the binary and cannot be overridden by the configuration file. By default, it
14077 contains just the single user name &"root"&. The &%never_users%& runtime option
14078 can be used to add more users to the fixed list.
14079
14080 If a message is to be delivered as one of the users on the fixed list or the
14081 &%never_users%& list, an error occurs, and delivery is deferred. A common
14082 example is
14083 .code
14084 never_users = root:daemon:bin
14085 .endd
14086 Including root is redundant if it is also on the fixed list, but it does no
14087 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14088 transport driver.
14089
14090
14091 .option openssl_options main "string list" +dont_insert_empty_fragments
14092 .cindex "OpenSSL "compatibility options"
14093 This option allows an administrator to adjust the SSL options applied
14094 by OpenSSL to connections.  It is given as a space-separated list of items,
14095 each one to be +added or -subtracted from the current value.  The default
14096 value is one option which happens to have been set historically.  You can
14097 remove all options with:
14098 .code
14099 openssl_options = -all
14100 .endd
14101 This option is only available if Exim is built against OpenSSL.  The values
14102 available for this option vary according to the age of your OpenSSL install.
14103 The &"all"& value controls a subset of flags which are available, typically
14104 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14105 list the values known on your system and Exim should support all the
14106 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14107 names lose the leading &"SSL_OP_"& and are lower-cased.
14108
14109 Note that adjusting the options can have severe impact upon the security of
14110 SSL as used by Exim.  It is possible to disable safety checks and shoot
14111 yourself in the foot in various unpleasant ways.  This option should not be
14112 adjusted lightly.  An unrecognised item will be detected at by invoking Exim
14113 with the &%-bV%& flag.
14114
14115 An example:
14116 .code
14117 openssl_options = -all +microsoft_big_sslv3_buffer
14118 .endd
14119
14120
14121 .option oracle_servers main "string list" unset
14122 .cindex "Oracle" "server list"
14123 This option provides a list of Oracle servers and associated connection data,
14124 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14125 The option is available only if Exim has been built with Oracle support.
14126
14127
14128 .option percent_hack_domains main "domain list&!!" unset
14129 .cindex "&""percent hack""&"
14130 .cindex "source routing" "in email address"
14131 .cindex "address" "source-routed"
14132 The &"percent hack"& is the convention whereby a local part containing a
14133 percent sign is re-interpreted as a new email address, with the percent
14134 replaced by @. This is sometimes called &"source routing"&, though that term is
14135 also applied to RFC 2822 addresses that begin with an @ character. If this
14136 option is set, Exim implements the percent facility for those domains listed,
14137 but no others. This happens before an incoming SMTP address is tested against
14138 an ACL.
14139
14140 &*Warning*&: The &"percent hack"& has often been abused by people who are
14141 trying to get round relaying restrictions. For this reason, it is best avoided
14142 if at all possible. Unfortunately, a number of less security-conscious MTAs
14143 implement it unconditionally. If you are running Exim on a gateway host, and
14144 routing mail through to internal MTAs without processing the local parts, it is
14145 a good idea to reject recipient addresses with percent characters in their
14146 local parts. Exim's default configuration does this.
14147
14148
14149 .option perl_at_start main boolean false
14150 This option is available only when Exim is built with an embedded Perl
14151 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14152
14153
14154 .option perl_startup main string unset
14155 This option is available only when Exim is built with an embedded Perl
14156 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14157
14158
14159 .option pgsql_servers main "string list" unset
14160 .cindex "PostgreSQL lookup type" "server list"
14161 This option provides a list of PostgreSQL servers and associated connection
14162 data, to be used in conjunction with &(pgsql)& lookups (see section
14163 &<<SECID72>>&). The option is available only if Exim has been built with
14164 PostgreSQL support.
14165
14166
14167 .option pid_file_path main string&!! "set at compile time"
14168 .cindex "daemon" "pid file path"
14169 .cindex "pid file, path for"
14170 This option sets the name of the file to which the Exim daemon writes its
14171 process id. The string is expanded, so it can contain, for example, references
14172 to the host name:
14173 .code
14174 pid_file_path = /var/log/$primary_hostname/exim.pid
14175 .endd
14176 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14177 spool directory.
14178 The value set by the option can be overridden by the &%-oP%& command line
14179 option. A pid file is not written if a &"non-standard"& daemon is run by means
14180 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14181
14182
14183 .option pipelining_advertise_hosts main "host list&!!" *
14184 .cindex "PIPELINING" "suppressing advertising"
14185 This option can be used to suppress the advertisement of the SMTP
14186 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14187 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14188 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14189 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14190 that clients will use it; &"out of order"& commands that are &"expected"& do
14191 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14192
14193
14194 .option preserve_message_logs main boolean false
14195 .cindex "message logs" "preserving"
14196 If this option is set, message log files are not deleted when messages are
14197 completed. Instead, they are moved to a sub-directory of the spool directory
14198 called &_msglog.OLD_&, where they remain available for statistical or debugging
14199 purposes. This is a dangerous option to set on systems with any appreciable
14200 volume of mail. Use with care!
14201
14202
14203 .option primary_hostname main string "see below"
14204 .cindex "name" "of local host"
14205 .cindex "host" "name of local"
14206 .cindex "local host" "name of"
14207 .vindex "&$primary_hostname$&"
14208 This specifies the name of the current host. It is used in the default EHLO or
14209 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14210 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14211 The value is also used by default in some SMTP response messages from an Exim
14212 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14213
14214 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14215 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14216 contains only one component, Exim passes it to &[gethostbyname()]& (or
14217 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14218 version. The variable &$primary_hostname$& contains the host name, whether set
14219 explicitly by this option, or defaulted.
14220
14221
14222 .option print_topbitchars main boolean false
14223 .cindex "printing characters"
14224 .cindex "8-bit characters"
14225 By default, Exim considers only those characters whose codes lie in the range
14226 32&--126 to be printing characters. In a number of circumstances (for example,
14227 when writing log entries) non-printing characters are converted into escape
14228 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14229 is set, code values of 128 and above are also considered to be printing
14230 characters.
14231
14232 This option also affects the header syntax checks performed by the
14233 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14234 the user's full name when constructing From: and Sender: addresses (as
14235 described in section &<<SECTconstr>>&). Setting this option can cause
14236 Exim to generate eight bit message headers that do not conform to the
14237 standards.
14238
14239
14240 .option process_log_path main string unset
14241 .cindex "process log path"
14242 .cindex "log" "process log"
14243 .cindex "&'exiwhat'&"
14244 This option sets the name of the file to which an Exim process writes its
14245 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14246 utility script. If this option is unset, the file called &_exim-process.info_&
14247 in Exim's spool directory is used. The ability to specify the name explicitly
14248 can be useful in environments where two different Exims are running, using
14249 different spool directories.
14250
14251
14252 .option prod_requires_admin main boolean true
14253 .oindex "&%-M%&"
14254 .oindex "&%-R%&"
14255 .oindex "&%-q%&"
14256 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14257 admin user unless &%prod_requires_admin%& is set false. See also
14258 &%queue_list_requires_admin%&.
14259
14260
14261 .option qualify_domain main string "see below"
14262 .cindex "domain" "for qualifying addresses"
14263 .cindex "address" "qualification"
14264 This option specifies the domain name that is added to any envelope sender
14265 addresses that do not have a domain qualification. It also applies to
14266 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
14267 are accepted by default only for locally-generated messages. Qualification is
14268 also applied to addresses in header lines such as &'From:'& and &'To:'& for
14269 locally-generated messages, unless the &%-bnq%& command line option is used.
14270
14271 Messages from external sources must always contain fully qualified addresses,
14272 unless the sending host matches &%sender_unqualified_hosts%& or
14273 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
14274 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
14275 necessary. Internally, Exim always works with fully qualified envelope
14276 addresses. If &%qualify_domain%& is not set, it defaults to the
14277 &%primary_hostname%& value.
14278
14279
14280 .option qualify_recipient main string "see below"
14281 This option allows you to specify a different domain for qualifying recipient
14282 addresses to the one that is used for senders. See &%qualify_domain%& above.
14283
14284
14285
14286 .option queue_domains main "domain list&!!" unset
14287 .cindex "domain" "specifying non-immediate delivery"
14288 .cindex "queueing incoming messages"
14289 .cindex "message" "queueing certain domains"
14290 This option lists domains for which immediate delivery is not required.
14291 A delivery process is started whenever a message is received, but only those
14292 domains that do not match are processed. All other deliveries wait until the
14293 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
14294
14295
14296 .option queue_list_requires_admin main boolean true
14297 .oindex "&%-bp%&"
14298 The &%-bp%& command-line option, which lists the messages that are on the
14299 queue, requires the caller to be an admin user unless
14300 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
14301
14302
14303 .option queue_only main boolean false
14304 .cindex "queueing incoming messages"
14305 .cindex "message" "queueing unconditionally"
14306 If &%queue_only%& is set, a delivery process is not automatically started
14307 whenever a message is received. Instead, the message waits on the queue for the
14308 next queue run. Even if &%queue_only%& is false, incoming messages may not get
14309 delivered immediately when certain conditions (such as heavy load) occur.
14310
14311 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
14312 and &%-odi%& command line options override &%queue_only%& unless
14313 &%queue_only_override%& is set false. See also &%queue_only_file%&,
14314 &%queue_only_load%&, and &%smtp_accept_queue%&.
14315
14316
14317 .option queue_only_file main string unset
14318 .cindex "queueing incoming messages"
14319 .cindex "message" "queueing by file existence"
14320 This option can be set to a colon-separated list of absolute path names, each
14321 one optionally preceded by &"smtp"&. When Exim is receiving a message,
14322 it tests for the existence of each listed path using a call to &[stat()]&. For
14323 each path that exists, the corresponding queueing option is set.
14324 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
14325 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
14326 .code
14327 queue_only_file = smtp/some/file
14328 .endd
14329 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
14330 &_/some/file_& exists.
14331
14332
14333 .option queue_only_load main fixed-point unset
14334 .cindex "load average"
14335 .cindex "queueing incoming messages"
14336 .cindex "message" "queueing by load"
14337 If the system load average is higher than this value, incoming messages from
14338 all sources are queued, and no automatic deliveries are started. If this
14339 happens during local or remote SMTP input, all subsequent messages received on
14340 the same SMTP connection are queued by default, whatever happens to the load in
14341 the meantime, but this can be changed by setting &%queue_only_load_latch%&
14342 false.
14343
14344 Deliveries will subsequently be performed by queue runner processes. This
14345 option has no effect on ancient operating systems on which Exim cannot
14346 determine the load average. See also &%deliver_queue_load_max%& and
14347 &%smtp_load_reserve%&.
14348
14349
14350 .option queue_only_load_latch main boolean true
14351 .cindex "load average" "re-evaluating per message"
14352 When this option is true (the default), once one message has been queued
14353 because the load average is higher than the value set by &%queue_only_load%&,
14354 all subsequent messages received on the same SMTP connection are also queued.
14355 This is a deliberate choice; even though the load average may fall below the
14356 threshold, it doesn't seem right to deliver later messages on the same
14357 connection when not delivering earlier ones. However, there are special
14358 circumstances such as very long-lived connections from scanning appliances
14359 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
14360 should be set false. This causes the value of the load average to be
14361 re-evaluated for each message.
14362
14363
14364 .option queue_only_override main boolean true
14365 .cindex "queueing incoming messages"
14366 When this option is true, the &%-od%&&'x'& command line options override the
14367 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
14368 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
14369 to override; they are accepted, but ignored.
14370
14371
14372 .option queue_run_in_order main boolean false
14373 .cindex "queue runner" "processing messages in order"
14374 If this option is set, queue runs happen in order of message arrival instead of
14375 in an arbitrary order. For this to happen, a complete list of the entire queue
14376 must be set up before the deliveries start. When the queue is all held in a
14377 single directory (the default), a single list is created for both the ordered
14378 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
14379 single list is not created when &%queue_run_in_order%& is false. In this case,
14380 the sub-directories are processed one at a time (in a random order), and this
14381 avoids setting up one huge list for the whole queue. Thus, setting
14382 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
14383 when the queue is large, because of the extra work in setting up the single,
14384 large list. In most situations, &%queue_run_in_order%& should not be set.
14385
14386
14387
14388 .option queue_run_max main integer 5
14389 .cindex "queue runner" "maximum number of"
14390 This controls the maximum number of queue runner processes that an Exim daemon
14391 can run simultaneously. This does not mean that it starts them all at once,
14392 but rather that if the maximum number are still running when the time comes to
14393 start another one, it refrains from starting another one. This can happen with
14394 very large queues and/or very sluggish deliveries. This option does not,
14395 however, interlock with other processes, so additional queue runners can be
14396 started by other means, or by killing and restarting the daemon.
14397
14398 Setting this option to zero does not suppress queue runs; rather, it disables
14399 the limit, allowing any number of simultaneous queue runner processes to be
14400 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
14401 the daemon's command line.
14402
14403 .option queue_smtp_domains main "domain list&!!" unset
14404 .cindex "queueing incoming messages"
14405 .cindex "message" "queueing remote deliveries"
14406 When this option is set, a delivery process is started whenever a message is
14407 received, routing is performed, and local deliveries take place.
14408 However, if any SMTP deliveries are required for domains that match
14409 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
14410 message waits on the queue for the next queue run. Since routing of the message
14411 has taken place, Exim knows to which remote hosts it must be delivered, and so
14412 when the queue run happens, multiple messages for the same host are delivered
14413 over a single SMTP connection. The &%-odqs%& command line option causes all
14414 SMTP deliveries to be queued in this way, and is equivalent to setting
14415 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
14416 &%queue_domains%&.
14417
14418
14419 .option receive_timeout main time 0s
14420 .cindex "timeout" "for non-SMTP input"
14421 This option sets the timeout for accepting a non-SMTP message, that is, the
14422 maximum time that Exim waits when reading a message on the standard input. If
14423 the value is zero, it will wait for ever. This setting is overridden by the
14424 &%-or%& command line option. The timeout for incoming SMTP messages is
14425 controlled by &%smtp_receive_timeout%&.
14426
14427 .option received_header_text main string&!! "see below"
14428 .cindex "customizing" "&'Received:'& header"
14429 .cindex "&'Received:'& header line" "customizing"
14430 This string defines the contents of the &'Received:'& message header that is
14431 added to each message, except for the timestamp, which is automatically added
14432 on at the end (preceded by a semicolon). The string is expanded each time it is
14433 used. If the expansion yields an empty string, no &'Received:'& header line is
14434 added to the message. Otherwise, the string should start with the text
14435 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
14436 header lines. The default setting is:
14437
14438 .code
14439 received_header_text = Received: \
14440   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
14441   {${if def:sender_ident \
14442   {from ${quote_local_part:$sender_ident} }}\
14443   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
14444   by $primary_hostname \
14445   ${if def:received_protocol {with $received_protocol}} \
14446   ${if def:tls_cipher {($tls_cipher)\n\t}}\
14447   (Exim $version_number)\n\t\
14448   ${if def:sender_address \
14449   {(envelope-from <$sender_address>)\n\t}}\
14450   id $message_exim_id\
14451   ${if def:received_for {\n\tfor $received_for}}
14452 .endd
14453
14454 The reference to the TLS cipher is omitted when Exim is built without TLS
14455 support. The use of conditional expansions ensures that this works for both
14456 locally generated messages and messages received from remote hosts, giving
14457 header lines such as the following:
14458 .code
14459 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
14460 by marley.carol.example with esmtp (Exim 4.00)
14461 (envelope-from <bob@carol.example>)
14462 id 16IOWa-00019l-00
14463 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
14464 Received: by scrooge.carol.example with local (Exim 4.00)
14465 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
14466 .endd
14467 Until the body of the message has been received, the timestamp is the time when
14468 the message started to be received. Once the body has arrived, and all policy
14469 checks have taken place, the timestamp is updated to the time at which the
14470 message was accepted.
14471
14472
14473 .option received_headers_max main integer 30
14474 .cindex "loop" "prevention"
14475 .cindex "mail loop prevention"
14476 .cindex "&'Received:'& header line" "counting"
14477 When a message is to be delivered, the number of &'Received:'& headers is
14478 counted, and if it is greater than this parameter, a mail loop is assumed to
14479 have occurred, the delivery is abandoned, and an error message is generated.
14480 This applies to both local and remote deliveries.
14481
14482
14483 .option recipient_unqualified_hosts main "host list&!!" unset
14484 .cindex "unqualified addresses"
14485 .cindex "host" "unqualified addresses from"
14486 This option lists those hosts from which Exim is prepared to accept unqualified
14487 recipient addresses in message envelopes. The addresses are made fully
14488 qualified by the addition of the &%qualify_recipient%& value. This option also
14489 affects message header lines. Exim does not reject unqualified recipient
14490 addresses in headers, but it qualifies them only if the message came from a
14491 host that matches &%recipient_unqualified_hosts%&,
14492 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
14493 option was not set.
14494
14495
14496 .option recipients_max main integer 0
14497 .cindex "limit" "number of recipients"
14498 .cindex "recipient" "maximum number"
14499 If this option is set greater than zero, it specifies the maximum number of
14500 original recipients for any message. Additional recipients that are generated
14501 by aliasing or forwarding do not count. SMTP messages get a 452 response for
14502 all recipients over the limit; earlier recipients are delivered as normal.
14503 Non-SMTP messages with too many recipients are failed, and no deliveries are
14504 done.
14505
14506 .cindex "RCPT" "maximum number of incoming"
14507 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
14508 RCPT commands in a single message.
14509
14510
14511 .option recipients_max_reject main boolean false
14512 If this option is set true, Exim rejects SMTP messages containing too many
14513 recipients by giving 552 errors to the surplus RCPT commands, and a 554
14514 error to the eventual DATA command. Otherwise (the default) it gives a 452
14515 error to the surplus RCPT commands and accepts the message on behalf of the
14516 initial set of recipients. The remote server should then re-send the message
14517 for the remaining recipients at a later time.
14518
14519
14520 .option remote_max_parallel main integer 2
14521 .cindex "delivery" "parallelism for remote"
14522 This option controls parallel delivery of one message to a number of remote
14523 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
14524 does all the remote deliveries for a message one by one. Otherwise, if a single
14525 message has to be delivered to more than one remote host, or if several copies
14526 have to be sent to the same remote host, up to &%remote_max_parallel%&
14527 deliveries are done simultaneously. If more than &%remote_max_parallel%&
14528 deliveries are required, the maximum number of processes are started, and as
14529 each one finishes, another is begun. The order of starting processes is the
14530 same as if sequential delivery were being done, and can be controlled by the
14531 &%remote_sort_domains%& option. If parallel delivery takes place while running
14532 with debugging turned on, the debugging output from each delivery process is
14533 tagged with its process id.
14534
14535 This option controls only the maximum number of parallel deliveries for one
14536 message in one Exim delivery process. Because Exim has no central queue
14537 manager, there is no way of controlling the total number of simultaneous
14538 deliveries if the configuration allows a delivery attempt as soon as a message
14539 is received.
14540
14541 .cindex "number of deliveries"
14542 .cindex "delivery" "maximum number of"
14543 If you want to control the total number of deliveries on the system, you
14544 need to set the &%queue_only%& option. This ensures that all incoming messages
14545 are added to the queue without starting a delivery process. Then set up an Exim
14546 daemon to start queue runner processes at appropriate intervals (probably
14547 fairly often, for example, every minute), and limit the total number of queue
14548 runners by setting the &%queue_run_max%& parameter. Because each queue runner
14549 delivers only one message at a time, the maximum number of deliveries that can
14550 then take place at once is &%queue_run_max%& multiplied by
14551 &%remote_max_parallel%&.
14552
14553 If it is purely remote deliveries you want to control, use
14554 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
14555 doing the SMTP routing before queueing, so that several messages for the same
14556 host will eventually get delivered down the same connection.
14557
14558
14559 .option remote_sort_domains main "domain list&!!" unset
14560 .cindex "sorting remote deliveries"
14561 .cindex "delivery" "sorting remote"
14562 When there are a number of remote deliveries for a message, they are sorted by
14563 domain into the order given by this list. For example,
14564 .code
14565 remote_sort_domains = *.cam.ac.uk:*.uk
14566 .endd
14567 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
14568 then to those in the &%uk%& domain, then to any others.
14569
14570
14571 .option retry_data_expire main time 7d
14572 .cindex "hints database" "data expiry"
14573 This option sets a &"use before"& time on retry information in Exim's hints
14574 database. Any older retry data is ignored. This means that, for example, once a
14575 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
14576 past failures.
14577
14578
14579 .option retry_interval_max main time 24h
14580 .cindex "retry" "limit on interval"
14581 .cindex "limit" "on retry interval"
14582 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
14583 intervals between delivery attempts for messages that cannot be delivered
14584 straight away. This option sets an overall limit to the length of time between
14585 retries. It cannot be set greater than 24 hours; any attempt to do so forces
14586 the default value.
14587
14588
14589 .option return_path_remove main boolean true
14590 .cindex "&'Return-path:'& header line" "removing"
14591 RFC 2821, section 4.4, states that an SMTP server must insert a
14592 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
14593 The &'Return-path:'& header preserves the sender address as received in the
14594 MAIL command. This description implies that this header should not be present
14595 in an incoming message. If &%return_path_remove%& is true, any existing
14596 &'Return-path:'& headers are removed from messages at the time they are
14597 received. Exim's transports have options for adding &'Return-path:'& headers at
14598 the time of delivery. They are normally used only for final local deliveries.
14599
14600
14601 .option return_size_limit main integer 100K
14602 This option is an obsolete synonym for &%bounce_return_size_limit%&.
14603
14604
14605 .option rfc1413_hosts main "host list&!!" *
14606 .cindex "RFC 1413"
14607 .cindex "host" "for RFC 1413 calls"
14608 RFC 1413 identification calls are made to any client host which matches an item
14609 in the list.
14610
14611 .option rfc1413_query_timeout main time 5s
14612 .cindex "RFC 1413" "query timeout"
14613 .cindex "timeout" "for RFC 1413 call"
14614 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
14615 no RFC 1413 calls are ever made.
14616
14617
14618 .option sender_unqualified_hosts main "host list&!!" unset
14619 .cindex "unqualified addresses"
14620 .cindex "host" "unqualified addresses from"
14621 This option lists those hosts from which Exim is prepared to accept unqualified
14622 sender addresses. The addresses are made fully qualified by the addition of
14623 &%qualify_domain%&. This option also affects message header lines. Exim does
14624 not reject unqualified addresses in headers that contain sender addresses, but
14625 it qualifies them only if the message came from a host that matches
14626 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
14627 using TCP/IP), and the &%-bnq%& option was not set.
14628
14629
14630 .option smtp_accept_keepalive main boolean true
14631 .cindex "keepalive" "on incoming connection"
14632 This option controls the setting of the SO_KEEPALIVE option on incoming
14633 TCP/IP socket connections. When set, it causes the kernel to probe idle
14634 connections periodically, by sending packets with &"old"& sequence numbers. The
14635 other end of the connection should send an acknowledgment if the connection is
14636 still okay or a reset if the connection has been aborted. The reason for doing
14637 this is that it has the beneficial effect of freeing up certain types of
14638 connection that can get stuck when the remote host is disconnected without
14639 tidying up the TCP/IP call properly. The keepalive mechanism takes several
14640 hours to detect unreachable hosts.
14641
14642
14643
14644 .option smtp_accept_max main integer 20
14645 .cindex "limit" "incoming SMTP connections"
14646 .cindex "SMTP" "incoming connection count"
14647 .cindex "inetd"
14648 This option specifies the maximum number of simultaneous incoming SMTP calls
14649 that Exim will accept. It applies only to the listening daemon; there is no
14650 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
14651 value is set to zero, no limit is applied. However, it is required to be
14652 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
14653 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
14654
14655 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
14656 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
14657 that limit has not been reached for the client host, &%smtp_accept_reserve%&
14658 and &%smtp_load_reserve%& are then checked before accepting the connection.
14659
14660
14661 .option smtp_accept_max_nonmail main integer 10
14662 .cindex "limit" "non-mail SMTP commands"
14663 .cindex "SMTP" "limiting non-mail commands"
14664 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
14665 the connection if there are too many. This option defines &"too many"&. The
14666 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
14667 client looping sending EHLO, for example. The check is applied only if the
14668 client host matches &%smtp_accept_max_nonmail_hosts%&.
14669
14670 When a new message is expected, one occurrence of RSET is not counted. This
14671 allows a client to send one RSET between messages (this is not necessary,
14672 but some clients do it). Exim also allows one uncounted occurrence of HELO
14673 or EHLO, and one occurrence of STARTTLS between messages. After
14674 starting up a TLS session, another EHLO is expected, and so it too is not
14675 counted. The first occurrence of AUTH in a connection, or immediately
14676 following STARTTLS is not counted. Otherwise, all commands other than
14677 MAIL, RCPT, DATA, and QUIT are counted.
14678
14679
14680 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
14681 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
14682 check by setting this option. The default value makes it apply to all hosts. By
14683 changing the value, you can exclude any badly-behaved hosts that you have to
14684 live with.
14685
14686
14687 . Allow this long option name to split; give it unsplit as a fifth argument
14688 . for the automatic .oindex that is generated by .option.
14689
14690 .option "smtp_accept_max_per_ &~&~connection" main integer 1000 &&&
14691          smtp_accept_max_per_connection
14692 .cindex "SMTP" "limiting incoming message count"
14693 .cindex "limit" "messages per SMTP connection"
14694 The value of this option limits the number of MAIL commands that Exim is
14695 prepared to accept over a single SMTP connection, whether or not each command
14696 results in the transfer of a message. After the limit is reached, a 421
14697 response is given to subsequent MAIL commands. This limit is a safety
14698 precaution against a client that goes mad (incidents of this type have been
14699 seen).
14700
14701
14702 .option smtp_accept_max_per_host main string&!! unset
14703 .cindex "limit" "SMTP connections from one host"
14704 .cindex "host" "limiting SMTP connections from"
14705 This option restricts the number of simultaneous IP connections from a single
14706 host (strictly, from a single IP address) to the Exim daemon. The option is
14707 expanded, to enable different limits to be applied to different hosts by
14708 reference to &$sender_host_address$&. Once the limit is reached, additional
14709 connection attempts from the same host are rejected with error code 421. This
14710 is entirely independent of &%smtp_accept_reserve%&. The option's default value
14711 of zero imposes no limit. If this option is set greater than zero, it is
14712 required that &%smtp_accept_max%& be non-zero.
14713
14714 &*Warning*&: When setting this option you should not use any expansion
14715 constructions that take an appreciable amount of time. The expansion and test
14716 happen in the main daemon loop, in order to reject additional connections
14717 without forking additional processes (otherwise a denial-of-service attack
14718 could cause a vast number or processes to be created). While the daemon is
14719 doing this processing, it cannot accept any other incoming connections.
14720
14721
14722
14723 .option smtp_accept_queue main integer 0
14724 .cindex "SMTP" "incoming connection count"
14725 .cindex "queueing incoming messages"
14726 .cindex "message" "queueing by SMTP connection count"
14727 If the number of simultaneous incoming SMTP connections being handled via the
14728 listening daemon exceeds this value, messages received by SMTP are just placed
14729 on the queue; no delivery processes are started automatically. The count is
14730 fixed at the start of an SMTP connection. It cannot be updated in the
14731 subprocess that receives messages, and so the queueing or not queueing applies
14732 to all messages received in the same connection.
14733
14734 A value of zero implies no limit, and clearly any non-zero value is useful only
14735 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
14736 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
14737 various &%-od%&&'x'& command line options.
14738
14739
14740 . Allow this long option name to split; give it unsplit as a fifth argument
14741 . for the automatic .oindex that is generated by .option.
14742
14743 .option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&&
14744          smtp_accept_queue_per_connection
14745 .cindex "queueing incoming messages"
14746 .cindex "message" "queueing by message count"
14747 This option limits the number of delivery processes that Exim starts
14748 automatically when receiving messages via SMTP, whether via the daemon or by
14749 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
14750 and the number of messages received in a single SMTP session exceeds this
14751 number, subsequent messages are placed on the queue, but no delivery processes
14752 are started. This helps to limit the number of Exim processes when a server
14753 restarts after downtime and there is a lot of mail waiting for it on other
14754 systems. On large systems, the default should probably be increased, and on
14755 dial-in client systems it should probably be set to zero (that is, disabled).
14756
14757
14758 .option smtp_accept_reserve main integer 0
14759 .cindex "SMTP" "incoming call count"
14760 .cindex "host" "reserved"
14761 When &%smtp_accept_max%& is set greater than zero, this option specifies a
14762 number of SMTP connections that are reserved for connections from the hosts
14763 that are specified in &%smtp_reserve_hosts%&. The value set in
14764 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
14765 restricted to this number of connections; the option specifies a minimum number
14766 of connection slots for them, not a maximum. It is a guarantee that this group
14767 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
14768 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
14769 individual host.
14770
14771 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
14772 set to 5, once there are 45 active connections (from any hosts), new
14773 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
14774 provided the other criteria for acceptance are met.
14775
14776
14777 .option smtp_active_hostname main string&!! unset
14778 .cindex "host" "name in SMTP responses"
14779 .cindex "SMTP" "host name in responses"
14780 .vindex "&$primary_hostname$&"
14781 This option is provided for multi-homed servers that want to masquerade as
14782 several different hosts. At the start of an incoming SMTP connection, its value
14783 is expanded and used instead of the value of &$primary_hostname$& in SMTP
14784 responses. For example, it is used as domain name in the response to an
14785 incoming HELO or EHLO command.
14786
14787 .vindex "&$smtp_active_hostname$&"
14788 The active hostname is placed in the &$smtp_active_hostname$& variable, which
14789 is saved with any messages that are received. It is therefore available for use
14790 in routers and transports when the message is later delivered.
14791
14792 If this option is unset, or if its expansion is forced to fail, or if the
14793 expansion results in an empty string, the value of &$primary_hostname$& is
14794 used. Other expansion failures cause a message to be written to the main and
14795 panic logs, and the SMTP command receives a temporary error. Typically, the
14796 value of &%smtp_active_hostname%& depends on the incoming interface address.
14797 For example:
14798 .code
14799 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
14800   {cox.mydomain}{box.mydomain}}
14801 .endd
14802
14803 Although &$smtp_active_hostname$& is primarily concerned with incoming
14804 messages, it is also used as the default for HELO commands in callout
14805 verification if there is no remote transport from which to obtain a
14806 &%helo_data%& value.
14807
14808 .option smtp_banner main string&!! "see below"
14809 .cindex "SMTP" "welcome banner"
14810 .cindex "banner for SMTP"
14811 .cindex "welcome banner for SMTP"
14812 .cindex "customizing" "SMTP banner"
14813 This string, which is expanded every time it is used, is output as the initial
14814 positive response to an SMTP connection. The default setting is:
14815 .code
14816 smtp_banner = $smtp_active_hostname ESMTP Exim \
14817   $version_number $tod_full
14818 .endd
14819 Failure to expand the string causes a panic error. If you want to create a
14820 multiline response to the initial SMTP connection, use &"\n"& in the string at
14821 appropriate points, but not at the end. Note that the 220 code is not included
14822 in this string. Exim adds it automatically (several times in the case of a
14823 multiline response).
14824
14825
14826 .option smtp_check_spool_space main boolean true
14827 .cindex "checking disk space"
14828 .cindex "disk space, checking"
14829 .cindex "spool directory" "checking space"
14830 When this option is set, if an incoming SMTP session encounters the SIZE
14831 option on a MAIL command, it checks that there is enough space in the
14832 spool directory's partition to accept a message of that size, while still
14833 leaving free the amount specified by &%check_spool_space%& (even if that value
14834 is zero). If there isn't enough space, a temporary error code is returned.
14835
14836
14837 .option smtp_connect_backlog main integer 20
14838 .cindex "connection backlog"
14839 .cindex "SMTP" "connection backlog"
14840 .cindex "backlog of connections"
14841 This option specifies a maximum number of waiting SMTP connections. Exim passes
14842 this value to the TCP/IP system when it sets up its listener. Once this number
14843 of connections are waiting for the daemon's attention, subsequent connection
14844 attempts are refused at the TCP/IP level. At least, that is what the manuals
14845 say; in some circumstances such connection attempts have been observed to time
14846 out instead. For large systems it is probably a good idea to increase the
14847 value (to 50, say). It also gives some protection against denial-of-service
14848 attacks by SYN flooding.
14849
14850
14851 .option smtp_enforce_sync main boolean true
14852 .cindex "SMTP" "synchronization checking"
14853 .cindex "synchronization checking in SMTP"
14854 The SMTP protocol specification requires the client to wait for a response from
14855 the server at certain points in the dialogue. Without PIPELINING these
14856 synchronization points are after every command; with PIPELINING they are
14857 fewer, but they still exist.
14858
14859 Some spamming sites send out a complete set of SMTP commands without waiting
14860 for any response. Exim protects against this by rejecting a message if the
14861 client has sent further input when it should not have. The error response &"554
14862 SMTP synchronization error"& is sent, and the connection is dropped. Testing
14863 for this error cannot be perfect because of transmission delays (unexpected
14864 input may be on its way but not yet received when Exim checks). However, it
14865 does detect many instances.
14866
14867 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
14868 If you want to disable the check selectively (for example, only for certain
14869 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
14870 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
14871
14872
14873
14874 .option smtp_etrn_command main string&!! unset
14875 .cindex "ETRN" "command to be run"
14876 .vindex "&$domain$&"
14877 If this option is set, the given command is run whenever an SMTP ETRN
14878 command is received from a host that is permitted to issue such commands (see
14879 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
14880 are independently expanded. The expansion variable &$domain$& is set to the
14881 argument of the ETRN command, and no syntax checking is done on it. For
14882 example:
14883 .code
14884 smtp_etrn_command = /etc/etrn_command $domain \
14885                     $sender_host_address
14886 .endd
14887 A new process is created to run the command, but Exim does not wait for it to
14888 complete. Consequently, its status cannot be checked. If the command cannot be
14889 run, a line is written to the panic log, but the ETRN caller still receives
14890 a 250 success response. Exim is normally running under its own uid when
14891 receiving SMTP, so it is not possible for it to change the uid before running
14892 the command.
14893
14894
14895 .option smtp_etrn_serialize main boolean true
14896 .cindex "ETRN" "serializing"
14897 When this option is set, it prevents the simultaneous execution of more than
14898 one identical command as a result of ETRN in an SMTP connection. See
14899 section &<<SECTETRN>>& for details.
14900
14901
14902 .option smtp_load_reserve main fixed-point unset
14903 .cindex "load average"
14904 If the system load average ever gets higher than this, incoming SMTP calls are
14905 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
14906 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
14907 the load is over the limit. The option has no effect on ancient operating
14908 systems on which Exim cannot determine the load average. See also
14909 &%deliver_queue_load_max%& and &%queue_only_load%&.
14910
14911
14912
14913 .option smtp_max_synprot_errors main integer 3
14914 .cindex "SMTP" "limiting syntax and protocol errors"
14915 .cindex "limit" "SMTP syntax and protocol errors"
14916 Exim rejects SMTP commands that contain syntax or protocol errors. In
14917 particular, a syntactically invalid email address, as in this command:
14918 .code
14919 RCPT TO:<abc xyz@a.b.c>
14920 .endd
14921 causes immediate rejection of the command, before any other tests are done.
14922 (The ACL cannot be run if there is no valid address to set up for it.) An
14923 example of a protocol error is receiving RCPT before MAIL. If there are
14924 too many syntax or protocol errors in one SMTP session, the connection is
14925 dropped. The limit is set by this option.
14926
14927 .cindex "PIPELINING" "expected errors"
14928 When the PIPELINING extension to SMTP is in use, some protocol errors are
14929 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
14930 Exim assumes that PIPELINING will be used if it advertises it (see
14931 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
14932 not count towards the limit.
14933
14934
14935
14936 .option smtp_max_unknown_commands main integer 3
14937 .cindex "SMTP" "limiting unknown commands"
14938 .cindex "limit" "unknown SMTP commands"
14939 If there are too many unrecognized commands in an incoming SMTP session, an
14940 Exim server drops the connection. This is a defence against some kinds of abuse
14941 that subvert web
14942 clients
14943 into making connections to SMTP ports; in these circumstances, a number of
14944 non-SMTP command lines are sent first.
14945
14946
14947
14948 .option smtp_ratelimit_hosts main "host list&!!" unset
14949 .cindex "SMTP" "rate limiting"
14950 .cindex "limit" "rate of message arrival"
14951 .cindex "RCPT" "rate limiting"
14952 Some sites find it helpful to be able to limit the rate at which certain hosts
14953 can send them messages, and the rate at which an individual message can specify
14954 recipients.
14955
14956 Exim has two rate-limiting facilities. This section describes the older
14957 facility, which can limit rates within a single connection. The newer
14958 &%ratelimit%& ACL condition can limit rates across all connections. See section
14959 &<<SECTratelimiting>>& for details of the newer facility.
14960
14961 When a host matches &%smtp_ratelimit_hosts%&, the values of
14962 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
14963 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
14964 respectively. Each option, if set, must contain a set of four comma-separated
14965 values:
14966
14967 .ilist
14968 A threshold, before which there is no rate limiting.
14969 .next
14970 An initial time delay. Unlike other times in Exim, numbers with decimal
14971 fractional parts are allowed here.
14972 .next
14973 A factor by which to increase the delay each time.
14974 .next
14975 A maximum value for the delay. This should normally be less than 5 minutes,
14976 because after that time, the client is liable to timeout the SMTP command.
14977 .endlist
14978
14979 For example, these settings have been used successfully at the site which
14980 first suggested this feature, for controlling mail from their customers:
14981 .code
14982 smtp_ratelimit_mail = 2,0.5s,1.05,4m
14983 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
14984 .endd
14985 The first setting specifies delays that are applied to MAIL commands after
14986 two have been received over a single connection. The initial delay is 0.5
14987 seconds, increasing by a factor of 1.05 each time. The second setting applies
14988 delays to RCPT commands when more than four occur in a single message.
14989
14990
14991 .option smtp_ratelimit_mail main string unset
14992 See &%smtp_ratelimit_hosts%& above.
14993
14994
14995 .option smtp_ratelimit_rcpt main string unset
14996 See &%smtp_ratelimit_hosts%& above.
14997
14998
14999 .option smtp_receive_timeout main time 5m
15000 .cindex "timeout" "for SMTP input"
15001 .cindex "SMTP" "input timeout"
15002 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15003 input, including batch SMTP. If a line of input (either an SMTP command or a
15004 data line) is not received within this time, the SMTP connection is dropped and
15005 the message is abandoned.
15006 A line is written to the log containing one of the following messages:
15007 .code
15008 SMTP command timeout on connection from...
15009 SMTP data timeout on connection from...
15010 .endd
15011 The former means that Exim was expecting to read an SMTP command; the latter
15012 means that it was in the DATA phase, reading the contents of a message.
15013
15014
15015 .oindex "&%-os%&"
15016 The value set by this option can be overridden by the
15017 &%-os%& command-line option. A setting of zero time disables the timeout, but
15018 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15019 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15020 timeout is controlled by &%receive_timeout%& and &%-or%&.
15021
15022
15023 .option smtp_reserve_hosts main "host list&!!" unset
15024 This option defines hosts for which SMTP connections are reserved; see
15025 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15026
15027
15028 .option smtp_return_error_details main boolean false
15029 .cindex "SMTP" "details policy failures"
15030 .cindex "policy control" "rejection, returning details"
15031 In the default state, Exim uses bland messages such as
15032 &"Administrative prohibition"& when it rejects SMTP commands for policy
15033 reasons. Many sysadmins like this because it gives away little information
15034 to spammers. However, some other sysadmins who are applying strict checking
15035 policies want to give out much fuller information about failures. Setting
15036 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15037 example, instead of &"Administrative prohibition"&, it might give:
15038 .code
15039 550-Rejected after DATA: '>' missing at end of address:
15040 550 failing address in "From" header is: <user@dom.ain
15041 .endd
15042
15043 .option spamd_address main string "see below"
15044 This option is available when Exim is compiled with the content-scanning
15045 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15046 The default value is
15047 .code
15048 127.0.0.1 783
15049 .endd
15050 See section &<<SECTscanspamass>>& for more details.
15051
15052
15053
15054 .option split_spool_directory main boolean false
15055 .cindex "multiple spool directories"
15056 .cindex "spool directory" "split"
15057 .cindex "directories, multiple"
15058 If this option is set, it causes Exim to split its input directory into 62
15059 subdirectories, each with a single alphanumeric character as its name. The
15060 sixth character of the message id is used to allocate messages to
15061 subdirectories; this is the least significant base-62 digit of the time of
15062 arrival of the message.
15063
15064 Splitting up the spool in this way may provide better performance on systems
15065 where there are long mail queues, by reducing the number of files in any one
15066 directory. The msglog directory is also split up in a similar way to the input
15067 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15068 are still placed in the single directory &_msglog.OLD_&.
15069
15070 It is not necessary to take any special action for existing messages when
15071 changing &%split_spool_directory%&. Exim notices messages that are in the
15072 &"wrong"& place, and continues to process them. If the option is turned off
15073 after a period of being on, the subdirectories will eventually empty and be
15074 automatically deleted.
15075
15076 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15077 changes. Instead of creating a list of all messages in the queue, and then
15078 trying to deliver each one in turn, it constructs a list of those in one
15079 sub-directory and tries to deliver them, before moving on to the next
15080 sub-directory. The sub-directories are processed in a random order. This
15081 spreads out the scanning of the input directories, and uses less memory. It is
15082 particularly beneficial when there are lots of messages on the queue. However,
15083 if &%queue_run_in_order%& is set, none of this new processing happens. The
15084 entire queue has to be scanned and sorted before any deliveries can start.
15085
15086
15087 .option spool_directory main string&!! "set at compile time"
15088 .cindex "spool directory" "path to"
15089 This defines the directory in which Exim keeps its spool, that is, the messages
15090 it is waiting to deliver. The default value is taken from the compile-time
15091 configuration setting, if there is one. If not, this option must be set. The
15092 string is expanded, so it can contain, for example, a reference to
15093 &$primary_hostname$&.
15094
15095 If the spool directory name is fixed on your installation, it is recommended
15096 that you set it at build time rather than from this option, particularly if the
15097 log files are being written to the spool directory (see &%log_file_path%&).
15098 Otherwise log files cannot be used for errors that are detected early on, such
15099 as failures in the configuration file.
15100
15101 By using this option to override the compiled-in path, it is possible to run
15102 tests of Exim without using the standard spool.
15103
15104 .option sqlite_lock_timeout main time 5s
15105 .cindex "sqlite lookup type" "lock timeout"
15106 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15107 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15108
15109 .option strict_acl_vars main boolean false
15110 .cindex "&ACL;" "variables, handling unset"
15111 This option controls what happens if a syntactically valid but undefined ACL
15112 variable is referenced. If it is false (the default), an empty string
15113 is substituted; if it is true, an error is generated. See section
15114 &<<SECTaclvariables>>& for details of ACL variables.
15115
15116 .option strip_excess_angle_brackets main boolean false
15117 .cindex "angle brackets, excess"
15118 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15119 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15120 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15121 passed on to another MTA, the excess angle brackets are not passed on. If this
15122 option is not set, multiple pairs of angle brackets cause a syntax error.
15123
15124
15125 .option strip_trailing_dot main boolean false
15126 .cindex "trailing dot on domain"
15127 .cindex "dot" "trailing on domain"
15128 If this option is set, a trailing dot at the end of a domain in an address is
15129 ignored. If this is in the envelope and the message is passed on to another
15130 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15131 domain causes a syntax error.
15132 However, addresses in header lines are checked only when an ACL requests header
15133 syntax checking.
15134
15135
15136 .option syslog_duplication main boolean true
15137 .cindex "syslog" "duplicate log lines; suppressing"
15138 When Exim is logging to syslog, it writes the log lines for its three
15139 separate logs at different syslog priorities so that they can in principle
15140 be separated on the logging hosts. Some installations do not require this
15141 separation, and in those cases, the duplication of certain log lines is a
15142 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15143 particular log line is written to syslog. For lines that normally go to
15144 both the main log and the reject log, the reject log version (possibly
15145 containing message header lines) is written, at LOG_NOTICE priority.
15146 Lines that normally go to both the main and the panic log are written at
15147 the LOG_ALERT priority.
15148
15149
15150 .option syslog_facility main string unset
15151 .cindex "syslog" "facility; setting"
15152 This option sets the syslog &"facility"& name, used when Exim is logging to
15153 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15154 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15155 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15156 details of Exim's logging.
15157
15158
15159
15160 .option syslog_processname main string &`exim`&
15161 .cindex "syslog" "process name; setting"
15162 This option sets the syslog &"ident"& name, used when Exim is logging to
15163 syslog. The value must be no longer than 32 characters. See chapter
15164 &<<CHAPlog>>& for details of Exim's logging.
15165
15166
15167
15168 .option syslog_timestamp main boolean true
15169 .cindex "syslog" "timestamps"
15170 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15171 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15172 details of Exim's logging.
15173
15174
15175 .option system_filter main string&!! unset
15176 .cindex "filter" "system filter"
15177 .cindex "system filter" "specifying"
15178 .cindex "Sieve filter" "not available for system filter"
15179 This option specifies an Exim filter file that is applied to all messages at
15180 the start of each delivery attempt, before any routing is done. System filters
15181 must be Exim filters; they cannot be Sieve filters. If the system filter
15182 generates any deliveries to files or pipes, or any new mail messages, the
15183 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15184 which transports are to be used. Details of this facility are given in chapter
15185 &<<CHAPsystemfilter>>&.
15186
15187
15188 .option system_filter_directory_transport main string&!! unset
15189 .vindex "&$address_file$&"
15190 This sets the name of the transport driver that is to be used when the
15191 &%save%& command in a system message filter specifies a path ending in &"/"&,
15192 implying delivery of each message into a separate file in some directory.
15193 During the delivery, the variable &$address_file$& contains the path name.
15194
15195
15196 .option system_filter_file_transport main string&!! unset
15197 .cindex "file" "transport for system filter"
15198 This sets the name of the transport driver that is to be used when the &%save%&
15199 command in a system message filter specifies a path not ending in &"/"&. During
15200 the delivery, the variable &$address_file$& contains the path name.
15201
15202 .option system_filter_group main string unset
15203 .cindex "gid (group id)" "system filter"
15204 This option is used only when &%system_filter_user%& is also set. It sets the
15205 gid under which the system filter is run, overriding any gid that is associated
15206 with the user. The value may be numerical or symbolic.
15207
15208 .option system_filter_pipe_transport main string&!! unset
15209 .cindex "&(pipe)& transport" "for system filter"
15210 .vindex "&$address_pipe$&"
15211 This specifies the transport driver that is to be used when a &%pipe%& command
15212 is used in a system filter. During the delivery, the variable &$address_pipe$&
15213 contains the pipe command.
15214
15215
15216 .option system_filter_reply_transport main string&!! unset
15217 .cindex "&(autoreply)& transport" "for system filter"
15218 This specifies the transport driver that is to be used when a &%mail%& command
15219 is used in a system filter.
15220
15221 .option system_filter_user main string unset
15222 .cindex "uid (user id)" "system filter"
15223 If this option is set to root, the system filter is run in the main Exim
15224 delivery process, as root.  Otherwise, the system filter runs in a separate
15225 process, as the given user, defaulting to the Exim run-time user.
15226 Unless the string consists entirely of digits, it
15227 is looked up in the password data. Failure to find the named user causes a
15228 configuration error. The gid is either taken from the password data, or
15229 specified by &%system_filter_group%&. When the uid is specified numerically,
15230 &%system_filter_group%& is required to be set.
15231
15232 If the system filter generates any pipe, file, or reply deliveries, the uid
15233 under which the filter is run is used when transporting them, unless a
15234 transport option overrides.
15235
15236
15237 .option tcp_nodelay main boolean true
15238 .cindex "daemon" "TCP_NODELAY on sockets"
15239 .cindex "Nagle algorithm"
15240 .cindex "TCP_NODELAY on listening sockets"
15241 If this option is set false, it stops the Exim daemon setting the
15242 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15243 turns off the &"Nagle algorithm"&, which is a way of improving network
15244 performance in interactive (character-by-character) situations. Turning it off
15245 should improve Exim's performance a bit, so that is what happens by default.
15246 However, it appears that some broken clients cannot cope, and time out. Hence
15247 this option. It affects only those sockets that are set up for listening by the
15248 daemon. Sockets created by the smtp transport for delivering mail always set
15249 TCP_NODELAY.
15250
15251
15252 .option timeout_frozen_after main time 0s
15253 .cindex "frozen messages" "timing out"
15254 .cindex "timeout" "frozen messages"
15255 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15256 message of any kind that has been on the queue for longer than the given time
15257 is automatically cancelled at the next queue run. If the frozen message is a
15258 bounce message, it is just discarded; otherwise, a bounce is sent to the
15259 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
15260 If you want to timeout frozen bounce messages earlier than other kinds of
15261 frozen message, see &%ignore_bounce_errors_after%&.
15262
15263 &*Note:*& the default value of zero means no timeouts; with this setting,
15264 frozen messages remain on the queue forever (except for any frozen bounce
15265 messages that are released by &%ignore_bounce_errors_after%&).
15266
15267
15268 .option timezone main string unset
15269 .cindex "timezone, setting"
15270 The value of &%timezone%& is used to set the environment variable TZ while
15271 running Exim (if it is different on entry). This ensures that all timestamps
15272 created by Exim are in the required timezone. If you want all your timestamps
15273 to be in UTC (aka GMT) you should set
15274 .code
15275 timezone = UTC
15276 .endd
15277 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
15278 or, if that is not set, from the value of the TZ environment variable when Exim
15279 is built. If &%timezone%& is set to the empty string, either at build or run
15280 time, any existing TZ variable is removed from the environment when Exim
15281 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
15282 unfortunately not all, operating systems.
15283
15284
15285 .option tls_advertise_hosts main "host list&!!" unset
15286 .cindex "TLS" "advertising"
15287 .cindex "encryption" "on SMTP connection"
15288 .cindex "SMTP" "encrypted connection"
15289 When Exim is built with support for TLS encrypted connections, the availability
15290 of the STARTTLS command to set up an encrypted session is advertised in
15291 response to EHLO only to those client hosts that match this option. See
15292 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
15293
15294
15295 .option tls_certificate main string&!! unset
15296 .cindex "TLS" "server certificate; location of"
15297 .cindex "certificate" "server, location of"
15298 The value of this option is expanded, and must then be the absolute path to a
15299 file which contains the server's certificates. The server's private key is also
15300 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
15301 &<<CHAPTLS>>& for further details.
15302
15303 &*Note*&: The certificates defined by this option are used only when Exim is
15304 receiving incoming messages as a server. If you want to supply certificates for
15305 use when sending messages as a client, you must set the &%tls_certificate%&
15306 option in the relevant &(smtp)& transport.
15307
15308
15309 .option tls_crl main string&!! unset
15310 .cindex "TLS" "server certificate revocation list"
15311 .cindex "certificate" "revocation list for server"
15312 This option specifies a certificate revocation list. The expanded value must
15313 be the name of a file that contains a CRL in PEM format.
15314
15315
15316 .option tls_dhparam main string&!! unset
15317 .cindex "TLS" "D-H parameters for server"
15318 The value of this option is expanded, and must then be the absolute path to
15319 a file which contains the server's DH parameter values.
15320 This is used only for OpenSSL. When Exim is linked with GnuTLS, this option is
15321 ignored. See section &<<SECTopenvsgnu>>& for further details.
15322
15323
15324 .option tls_on_connect_ports main "string list" unset
15325 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
15326 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
15327 set up without waiting for the client to issue a STARTTLS command. For
15328 further details, see section &<<SECTsupobssmt>>&.
15329
15330
15331
15332 .option tls_privatekey main string&!! unset
15333 .cindex "TLS" "server private key; location of"
15334 The value of this option is expanded, and must then be the absolute path to a
15335 file which contains the server's private key. If this option is unset, or if
15336 the expansion is forced to fail, or the result is an empty string, the private
15337 key is assumed to be in the same file as the server's certificates. See chapter
15338 &<<CHAPTLS>>& for further details.
15339
15340
15341 .option tls_remember_esmtp main boolean false
15342 .cindex "TLS" "esmtp state; remembering"
15343 .cindex "TLS" "broken clients"
15344 If this option is set true, Exim violates the RFCs by remembering that it is in
15345 &"esmtp"& state after successfully negotiating a TLS session. This provides
15346 support for broken clients that fail to send a new EHLO after starting a
15347 TLS session.
15348
15349
15350 .option tls_require_ciphers main string&!! unset
15351 .cindex "TLS" "requiring specific ciphers"
15352 .cindex "cipher" "requiring specific"
15353 This option controls which ciphers can be used for incoming TLS connections.
15354 The &(smtp)& transport has an option of the same name for controlling outgoing
15355 connections. This option is expanded for each connection, so can be varied for
15356 different clients if required. The value of this option must be a list of
15357 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
15358 in somewhat different ways. If GnuTLS is being used, the client controls the
15359 preference order of the available ciphers. Details are given in sections
15360 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
15361
15362
15363 .option tls_try_verify_hosts main "host list&!!" unset
15364 .cindex "TLS" "client certificate verification"
15365 .cindex "certificate" "verification of client"
15366 See &%tls_verify_hosts%& below.
15367
15368
15369 .option tls_verify_certificates main string&!! unset
15370 .cindex "TLS" "client certificate verification"
15371 .cindex "certificate" "verification of client"
15372 The value of this option is expanded, and must then be the absolute path to
15373 a file containing permitted certificates for clients that
15374 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
15375 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
15376 directory containing certificate files. This does not work with GnuTLS; the
15377 option must be set to the name of a single file if you are using GnuTLS.
15378
15379
15380 .option tls_verify_hosts main "host list&!!" unset
15381 .cindex "TLS" "client certificate verification"
15382 .cindex "certificate" "verification of client"
15383 This option, along with &%tls_try_verify_hosts%&, controls the checking of
15384 certificates from clients. The expected certificates are defined by
15385 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
15386 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
15387 &%tls_verify_certificates%& is not set.
15388
15389 Any client that matches &%tls_verify_hosts%& is constrained by
15390 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
15391 present one of the listed certificates. If it does not, the connection is
15392 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
15393 the host to use TLS. It can still send SMTP commands through unencrypted
15394 connections. Forcing a client to use TLS has to be done separately using an
15395 ACL to reject inappropriate commands when the connection is not encrypted.
15396
15397 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
15398 matches this option (but not &%tls_verify_hosts%&), Exim requests a
15399 certificate and checks it against &%tls_verify_certificates%&, but does not
15400 abort the connection if there is no certificate or if it does not match. This
15401 state can be detected in an ACL, which makes it possible to implement policies
15402 such as &"accept for relay only if a verified certificate has been received,
15403 but accept for local delivery if encrypted, even without a verified
15404 certificate"&.
15405
15406 Client hosts that match neither of these lists are not asked to present
15407 certificates.
15408
15409
15410 .option trusted_groups main "string list&!!" unset
15411 .cindex "trusted groups"
15412 .cindex "groups" "trusted"
15413 This option is expanded just once, at the start of Exim's processing. If this
15414 option is set, any process that is running in one of the listed groups, or
15415 which has one of them as a supplementary group, is trusted. The groups can be
15416 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
15417 details of what trusted callers are permitted to do. If neither
15418 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
15419 are trusted.
15420
15421 .option trusted_users main "string list&!!" unset
15422 .cindex "trusted users"
15423 .cindex "user" "trusted"
15424 This option is expanded just once, at the start of Exim's processing. If this
15425 option is set, any process that is running as one of the listed users is
15426 trusted. The users can be specified numerically or by name. See section
15427 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
15428 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
15429 Exim user are trusted.
15430
15431 .option unknown_login main string&!! unset
15432 .cindex "uid (user id)" "unknown caller"
15433 .vindex "&$caller_uid$&"
15434 This is a specialized feature for use in unusual configurations. By default, if
15435 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
15436 gives up. The &%unknown_login%& option can be used to set a login name to be
15437 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
15438 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
15439 is used for the user's real name (gecos field), unless this has been set by the
15440 &%-F%& option.
15441
15442 .option unknown_username main string unset
15443 See &%unknown_login%&.
15444
15445 .option untrusted_set_sender main "address list&!!" unset
15446 .cindex "trusted users"
15447 .cindex "sender" "setting by untrusted user"
15448 .cindex "untrusted user setting sender"
15449 .cindex "user" "untrusted setting sender"
15450 .cindex "envelope sender"
15451 When an untrusted user submits a message to Exim using the standard input, Exim
15452 normally creates an envelope sender address from the user's login and the
15453 default qualification domain. Data from the &%-f%& option (for setting envelope
15454 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
15455 is used) is ignored.
15456
15457 However, untrusted users are permitted to set an empty envelope sender address,
15458 to declare that a message should never generate any bounces. For example:
15459 .code
15460 exim -f '<>' user@domain.example
15461 .endd
15462 .vindex "&$sender_ident$&"
15463 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
15464 other envelope sender addresses in a controlled way. When it is set, untrusted
15465 users are allowed to set envelope sender addresses that match any of the
15466 patterns in the list. Like all address lists, the string is expanded. The
15467 identity of the user is in &$sender_ident$&, so you can, for example, restrict
15468 users to setting senders that start with their login ids
15469 followed by a hyphen
15470 by a setting like this:
15471 .code
15472 untrusted_set_sender = ^$sender_ident-
15473 .endd
15474 If you want to allow untrusted users to set envelope sender addresses without
15475 restriction, you can use
15476 .code
15477 untrusted_set_sender = *
15478 .endd
15479 The &%untrusted_set_sender%& option applies to all forms of local input, but
15480 only to the setting of the envelope sender. It does not permit untrusted users
15481 to use the other options which trusted user can use to override message
15482 parameters. Furthermore, it does not stop Exim from removing an existing
15483 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
15484 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
15485 overriding these actions. The handling of the &'Sender:'& header is also
15486 described in section &<<SECTthesenhea>>&.
15487
15488 The log line for a message's arrival shows the envelope sender following
15489 &"<="&. For local messages, the user's login always follows, after &"U="&. In
15490 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
15491 envelope sender address, the user's login is shown in parentheses after the
15492 sender address.
15493
15494
15495 .option uucp_from_pattern main string "see below"
15496 .cindex "&""From""& line"
15497 .cindex "UUCP" "&""From""& line"
15498 Some applications that pass messages to an MTA via a command line interface use
15499 an initial line starting with &"From&~"& to pass the envelope sender. In
15500 particular, this is used by UUCP software. Exim recognizes such a line by means
15501 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
15502 matches, the sender address is constructed by expanding the contents of
15503 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
15504 default pattern recognizes lines in the following two forms:
15505 .code
15506 From ph10 Fri Jan  5 12:35 GMT 1996
15507 From ph10 Fri, 7 Jan 97 14:00:00 GMT
15508 .endd
15509 The pattern can be seen by running
15510 .code
15511 exim -bP uucp_from_pattern
15512 .endd
15513 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
15514 year in the second case. The first word after &"From&~"& is matched in the
15515 regular expression by a parenthesized subpattern. The default value for
15516 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
15517 (&"ph10"& in the example above) as the message's sender. See also
15518 &%ignore_fromline_hosts%&.
15519
15520
15521 .option uucp_from_sender main string&!! &`$1`&
15522 See &%uucp_from_pattern%& above.
15523
15524
15525 .option warn_message_file main string unset
15526 .cindex "warning of delay" "customizing the message"
15527 .cindex "customizing" "warning message"
15528 This option defines a template file containing paragraphs of text to be used
15529 for constructing the warning message which is sent by Exim when a message has
15530 been on the queue for a specified amount of time, as specified by
15531 &%delay_warning%&. Details of the file's contents are given in chapter
15532 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
15533
15534
15535 .option write_rejectlog main boolean true
15536 .cindex "reject log" "disabling"
15537 If this option is set false, Exim no longer writes anything to the reject log.
15538 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
15539 .ecindex IIDconfima
15540 .ecindex IIDmaiconf
15541
15542
15543
15544
15545 . ////////////////////////////////////////////////////////////////////////////
15546 . ////////////////////////////////////////////////////////////////////////////
15547
15548 .chapter "Generic options for routers" "CHAProutergeneric"
15549 .scindex IIDgenoprou1 "options" "generic; for routers"
15550 .scindex IIDgenoprou2 "generic options" "router"
15551 This chapter describes the generic options that apply to all routers.
15552 Those that are preconditions are marked with &Dagger; in the &"use"& field.
15553
15554 For a general description of how a router operates, see sections
15555 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
15556 which the preconditions are tested. The order of expansion of the options that
15557 provide data for a transport is: &%errors_to%&, &%headers_add%&,
15558 &%headers_remove%&, &%transport%&.
15559
15560
15561
15562 .option address_data routers string&!! unset
15563 .cindex "router" "data attached to address"
15564 The string is expanded just before the router is run, that is, after all the
15565 precondition tests have succeeded. If the expansion is forced to fail, the
15566 router declines, the value of &%address_data%& remains unchanged, and the
15567 &%more%& option controls what happens next. Other expansion failures cause
15568 delivery of the address to be deferred.
15569
15570 .vindex "&$address_data$&"
15571 When the expansion succeeds, the value is retained with the address, and can be
15572 accessed using the variable &$address_data$& in the current router, subsequent
15573 routers, and the eventual transport.
15574
15575 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
15576 that runs a user's filter file, the contents of &$address_data$& are accessible
15577 in the filter. This is not normally a problem, because such data is usually
15578 either not confidential or it &"belongs"& to the current user, but if you do
15579 put confidential data into &$address_data$& you need to remember this point.
15580
15581 Even if the router declines or passes, the value of &$address_data$& remains
15582 with the address, though it can be changed by another &%address_data%& setting
15583 on a subsequent router. If a router generates child addresses, the value of
15584 &$address_data$& propagates to them. This also applies to the special kind of
15585 &"child"& that is generated by a router with the &%unseen%& option.
15586
15587 The idea of &%address_data%& is that you can use it to look up a lot of data
15588 for the address once, and then pick out parts of the data later. For example,
15589 you could use a single LDAP lookup to return a string of the form
15590 .code
15591 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
15592 .endd
15593 In the transport you could pick out the mailbox by a setting such as
15594 .code
15595 file = ${extract{mailbox}{$address_data}}
15596 .endd
15597 This makes the configuration file less messy, and also reduces the number of
15598 lookups (though Exim does cache lookups).
15599
15600 .vindex "&$sender_address_data$&"
15601 .vindex "&$address_data$&"
15602 The &%address_data%& facility is also useful as a means of passing information
15603 from one router to another, and from a router to a transport. In addition, if
15604 &$address_data$& is set by a router when verifying a recipient address from an
15605 ACL, it remains available for use in the rest of the ACL statement. After
15606 verifying a sender, the value is transferred to &$sender_address_data$&.
15607
15608
15609
15610 .option address_test routers&!? boolean true
15611 .oindex "&%-bt%&"
15612 .cindex "router" "skipping when address testing"
15613 If this option is set false, the router is skipped when routing is being tested
15614 by means of the &%-bt%& command line option. This can be a convenience when
15615 your first router sends messages to an external scanner, because it saves you
15616 having to set the &"already scanned"& indicator when testing real address
15617 routing.
15618
15619
15620
15621 .option cannot_route_message routers string&!! unset
15622 .cindex "router" "customizing &""cannot route""& message"
15623 .cindex "customizing" "&""cannot route""& message"
15624 This option specifies a text message that is used when an address cannot be
15625 routed because Exim has run out of routers. The default message is
15626 &"Unrouteable address"&. This option is useful only on routers that have
15627 &%more%& set false, or on the very last router in a configuration, because the
15628 value that is used is taken from the last router that is considered. This
15629 includes a router that is skipped because its preconditions are not met, as
15630 well as a router that declines. For example, using the default configuration,
15631 you could put:
15632 .code
15633 cannot_route_message = Remote domain not found in DNS
15634 .endd
15635 on the first router, which is a &(dnslookup)& router with &%more%& set false,
15636 and
15637 .code
15638 cannot_route_message = Unknown local user
15639 .endd
15640 on the final router that checks for local users. If string expansion fails for
15641 this option, the default message is used. Unless the expansion failure was
15642 explicitly forced, a message about the failure is written to the main and panic
15643 logs, in addition to the normal message about the routing failure.
15644
15645
15646 .option caseful_local_part routers boolean false
15647 .cindex "case of local parts"
15648 .cindex "router" "case of local parts"
15649 By default, routers handle the local parts of addresses in a case-insensitive
15650 manner, though the actual case is preserved for transmission with the message.
15651 If you want the case of letters to be significant in a router, you must set
15652 this option true. For individual router options that contain address or local
15653 part lists (for example, &%local_parts%&), case-sensitive matching can be
15654 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
15655 more details.
15656
15657 .vindex "&$local_part$&"
15658 .vindex "&$original_local_part$&"
15659 .vindex "&$parent_local_part$&"
15660 The value of the &$local_part$& variable is forced to lower case while a
15661 router is running unless &%caseful_local_part%& is set. When a router assigns
15662 an address to a transport, the value of &$local_part$& when the transport runs
15663 is the same as it was in the router. Similarly, when a router generates child
15664 addresses by aliasing or forwarding, the values of &$original_local_part$&
15665 and &$parent_local_part$& are those that were used by the redirecting router.
15666
15667 This option applies to the processing of an address by a router. When a
15668 recipient address is being processed in an ACL, there is a separate &%control%&
15669 modifier that can be used to specify case-sensitive processing within the ACL
15670 (see section &<<SECTcontrols>>&).
15671
15672
15673
15674 .option check_local_user routers&!? boolean false
15675 .cindex "local user, checking in router"
15676 .cindex "router" "checking for local user"
15677 .cindex "&_/etc/passwd_&"
15678 .vindex "&$home$&"
15679 When this option is true, Exim checks that the local part of the recipient
15680 address (with affixes removed if relevant) is the name of an account on the
15681 local system. The check is done by calling the &[getpwnam()]& function rather
15682 than trying to read &_/etc/passwd_& directly. This means that other methods of
15683 holding password data (such as NIS) are supported. If the local part is a local
15684 user, &$home$& is set from the password data, and can be tested in other
15685 preconditions that are evaluated after this one (the order of evaluation is
15686 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
15687 overridden by &%router_home_directory%&. If the local part is not a local user,
15688 the router is skipped.
15689
15690 If you want to check that the local part is either the name of a local user
15691 or matches something else, you cannot combine &%check_local_user%& with a
15692 setting of &%local_parts%&, because that specifies the logical &'and'& of the
15693 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
15694 setting to achieve this. For example:
15695 .code
15696 local_parts = passwd;$local_part : lsearch;/etc/other/users
15697 .endd
15698 Note, however, that the side effects of &%check_local_user%& (such as setting
15699 up a home directory) do not occur when a &(passwd)& lookup is used in a
15700 &%local_parts%& (or any other) precondition.
15701
15702
15703
15704 .option condition routers&!? string&!! unset
15705 .cindex "router" "customized precondition"
15706 This option specifies a general precondition test that has to succeed for the
15707 router to be called. The &%condition%& option is the last precondition to be
15708 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
15709 result is a forced failure, or an empty string, or one of the strings &"0"& or
15710 &"no"& or &"false"& (checked without regard to the case of the letters), the
15711 router is skipped, and the address is offered to the next one.
15712
15713 If the result is any other value, the router is run (as this is the last
15714 precondition to be evaluated, all the other preconditions must be true).
15715
15716 This option is unique in that multiple &%condition%& options may be present.
15717 All &%condition%& options must succeed.
15718
15719 The &%condition%& option provides a means of applying custom conditions to the
15720 running of routers. Note that in the case of a simple conditional expansion,
15721 the default expansion values are exactly what is wanted. For example:
15722 .code
15723 condition = ${if >{$message_age}{600}}
15724 .endd
15725 Because of the default behaviour of the string expansion, this is equivalent to
15726 .code
15727 condition = ${if >{$message_age}{600}{true}{}}
15728 .endd
15729 A multiple condition example, which succeeds:
15730 .code
15731 condition = ${if >{$message_age}{600}}
15732 condition = ${if !eq{${lc:$local_part}}{postmaster}}
15733 condition = foobar
15734 .endd
15735 If the expansion fails (other than forced failure) delivery is deferred. Some
15736 of the other precondition options are common special cases that could in fact
15737 be specified using &%condition%&.
15738
15739
15740
15741 .option debug_print routers string&!! unset
15742 .cindex "testing" "variables in drivers"
15743 If this option is set and debugging is enabled (see the &%-d%& command line
15744 option), the string is expanded and included in the debugging output.
15745 If expansion of the string fails, the error message is written to the debugging
15746 output, and Exim carries on processing.
15747 This option is provided to help with checking out the values of variables and
15748 so on when debugging router configurations. For example, if a &%condition%&
15749 option appears not to be working, &%debug_print%& can be used to output the
15750 variables it references. The output happens after checks for &%domains%&,
15751 &%local_parts%&, and &%check_local_user%& but before any other preconditions
15752 are tested. A newline is added to the text if it does not end with one.
15753
15754
15755
15756 .option disable_logging routers boolean false
15757 If this option is set true, nothing is logged for any routing errors
15758 or for any deliveries caused by this router. You should not set this option
15759 unless you really, really know what you are doing. See also the generic
15760 transport option of the same name.
15761
15762
15763 .option domains routers&!? "domain list&!!" unset
15764 .cindex "router" "restricting to specific domains"
15765 .vindex "&$domain_data$&"
15766 If this option is set, the router is skipped unless the current domain matches
15767 the list. If the match is achieved by means of a file lookup, the data that the
15768 lookup returned for the domain is placed in &$domain_data$& for use in string
15769 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
15770 a list of the order in which preconditions are evaluated.
15771
15772
15773
15774 .option driver routers string unset
15775 This option must always be set. It specifies which of the available routers is
15776 to be used.
15777
15778
15779
15780 .option errors_to routers string&!! unset
15781 .cindex "envelope sender"
15782 .cindex "router" "changing address for errors"
15783 If a router successfully handles an address, it may assign the address to a
15784 transport for delivery or it may generate child addresses. In both cases, if
15785 there is a delivery problem during later processing, the resulting bounce
15786 message is sent to the address that results from expanding this string,
15787 provided that the address verifies successfully. The &%errors_to%& option is
15788 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
15789
15790 The &%errors_to%& setting associated with an address can be overridden if it
15791 subsequently passes through other routers that have their own &%errors_to%&
15792 settings, or if the message is delivered by a transport with a &%return_path%&
15793 setting.
15794
15795 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
15796 the expansion fails to verify, the errors address associated with the incoming
15797 address is used. At top level, this is the envelope sender. A non-forced
15798 expansion failure causes delivery to be deferred.
15799
15800 If an address for which &%errors_to%& has been set ends up being delivered over
15801 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
15802 any bounces that are generated by other MTAs on the delivery route are also
15803 sent there. You can set &%errors_to%& to the empty string by either of these
15804 settings:
15805 .code
15806 errors_to =
15807 errors_to = ""
15808 .endd
15809 An expansion item that yields an empty string has the same effect. If you do
15810 this, a locally detected delivery error for addresses processed by this router
15811 no longer gives rise to a bounce message; the error is discarded. If the
15812 address is delivered to a remote host, the return path is set to &`<>`&, unless
15813 overridden by the &%return_path%& option on the transport.
15814
15815 .vindex "&$address_data$&"
15816 If for some reason you want to discard local errors, but use a non-empty
15817 MAIL command for remote delivery, you can preserve the original return
15818 path in &$address_data$& in the router, and reinstate it in the transport by
15819 setting &%return_path%&.
15820
15821 The most common use of &%errors_to%& is to direct mailing list bounces to the
15822 manager of the list, as described in section &<<SECTmailinglists>>&, or to
15823 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
15824
15825
15826
15827 .option expn routers&!? boolean true
15828 .cindex "address" "testing"
15829 .cindex "testing" "addresses"
15830 .cindex "EXPN" "router skipping"
15831 .cindex "router" "skipping for EXPN"
15832 If this option is turned off, the router is skipped when testing an address
15833 as a result of processing an SMTP EXPN command. You might, for example,
15834 want to turn it off on a router for users' &_.forward_& files, while leaving it
15835 on for the system alias file.
15836 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
15837 are evaluated.
15838
15839 The use of the SMTP EXPN command is controlled by an ACL (see chapter
15840 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
15841 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
15842
15843
15844
15845 .option fail_verify routers boolean false
15846 .cindex "router" "forcing verification failure"
15847 Setting this option has the effect of setting both &%fail_verify_sender%& and
15848 &%fail_verify_recipient%& to the same value.
15849
15850
15851
15852 .option fail_verify_recipient routers boolean false
15853 If this option is true and an address is accepted by this router when
15854 verifying a recipient, verification fails.
15855
15856
15857
15858 .option fail_verify_sender routers boolean false
15859 If this option is true and an address is accepted by this router when
15860 verifying a sender, verification fails.
15861
15862
15863
15864 .option fallback_hosts routers "string list" unset
15865 .cindex "router" "fallback hosts"
15866 .cindex "fallback" "hosts specified on router"
15867 String expansion is not applied to this option. The argument must be a
15868 colon-separated list of host names or IP addresses. The list separator can be
15869 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
15870 each name or address. In fact, the format of each item is exactly the same as
15871 defined for the list of hosts in a &(manualroute)& router (see section
15872 &<<SECTformatonehostitem>>&).
15873
15874 If a router queues an address for a remote transport, this host list is
15875 associated with the address, and used instead of the transport's fallback host
15876 list. If &%hosts_randomize%& is set on the transport, the order of the list is
15877 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
15878 transport for further details.
15879
15880
15881 .option group routers string&!! "see below"
15882 .cindex "gid (group id)" "local delivery"
15883 .cindex "local transports" "uid and gid"
15884 .cindex "transport" "local"
15885 .cindex "router" "setting group"
15886 When a router queues an address for a transport, and the transport does not
15887 specify a group, the group given here is used when running the delivery
15888 process.
15889 The group may be specified numerically or by name. If expansion fails, the
15890 error is logged and delivery is deferred.
15891 The default is unset, unless &%check_local_user%& is set, when the default
15892 is taken from the password information. See also &%initgroups%& and &%user%&
15893 and the discussion in chapter &<<CHAPenvironment>>&.
15894
15895
15896
15897 .option headers_add routers string&!! unset
15898 .cindex "header lines" "adding"
15899 .cindex "router" "adding header lines"
15900 This option specifies a string of text that is expanded at routing time, and
15901 associated with any addresses that are accepted by the router. However, this
15902 option has no effect when an address is just being verified. The way in which
15903 the text is used to add header lines at transport time is described in section
15904 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
15905 message is in the process of being transported. This means that references to
15906 header lines in string expansions in the transport's configuration do not
15907 &"see"& the added header lines.
15908
15909 The &%headers_add%& option is expanded after &%errors_to%&, but before
15910 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
15911 the expansion is forced to fail, the option has no effect. Other expansion
15912 failures are treated as configuration errors.
15913
15914 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
15915 router that has the &%one_time%& option set.
15916
15917 .cindex "duplicate addresses"
15918 .oindex "&%unseen%&"
15919 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
15920 additions are deleted when the address is passed on to subsequent routers.
15921 For a &%redirect%& router, if a generated address is the same as the incoming
15922 address, this can lead to duplicate addresses with different header
15923 modifications. Exim does not do duplicate deliveries (except, in certain
15924 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
15925 which of the duplicates is discarded, so this ambiguous situation should be
15926 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
15927
15928
15929
15930 .option headers_remove routers string&!! unset
15931 .cindex "header lines" "removing"
15932 .cindex "router" "removing header lines"
15933 This option specifies a string of text that is expanded at routing time, and
15934 associated with any addresses that are accepted by the router. However, this
15935 option has no effect when an address is just being verified. The way in which
15936 the text is used to remove header lines at transport time is described in
15937 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
15938 the message is in the process of being transported. This means that references
15939 to header lines in string expansions in the transport's configuration still
15940 &"see"& the original header lines.
15941
15942 The &%headers_remove%& option is expanded after &%errors_to%& and
15943 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
15944 the option has no effect. Other expansion failures are treated as configuration
15945 errors.
15946
15947 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
15948 router that has the &%one_time%& option set.
15949
15950 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
15951 removal requests are deleted when the address is passed on to subsequent
15952 routers, and this can lead to problems with duplicates -- see the similar
15953 warning for &%headers_add%& above.
15954
15955
15956 .option ignore_target_hosts routers "host list&!!" unset
15957 .cindex "IP address" "discarding"
15958 .cindex "router" "discarding IP addresses"
15959 Although this option is a host list, it should normally contain IP address
15960 entries rather than names. If any host that is looked up by the router has an
15961 IP address that matches an item in this list, Exim behaves as if that IP
15962 address did not exist. This option allows you to cope with rogue DNS entries
15963 like
15964 .code
15965 remote.domain.example.  A  127.0.0.1
15966 .endd
15967 by setting
15968 .code
15969 ignore_target_hosts = 127.0.0.1
15970 .endd
15971 on the relevant router. If all the hosts found by a &(dnslookup)& router are
15972 discarded in this way, the router declines. In a conventional configuration, an
15973 attempt to mail to such a domain would normally provoke the &"unrouteable
15974 domain"& error, and an attempt to verify an address in the domain would fail.
15975 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
15976 router declines if presented with one of the listed addresses.
15977
15978 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
15979 means of the first or the second of the following settings, respectively:
15980 .code
15981 ignore_target_hosts = 0.0.0.0/0
15982 ignore_target_hosts = <; 0::0/0
15983 .endd
15984 The pattern in the first line matches all IPv4 addresses, whereas the pattern
15985 in the second line matches all IPv6 addresses.
15986
15987 This option may also be useful for ignoring link-local and site-local IPv6
15988 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
15989 is expanded before use as a list, it is possible to make it dependent on the
15990 domain that is being routed.
15991
15992 .vindex "&$host_address$&"
15993 During its expansion, &$host_address$& is set to the IP address that is being
15994 checked.
15995
15996 .option initgroups routers boolean false
15997 .cindex "additional groups"
15998 .cindex "groups" "additional"
15999 .cindex "local transports" "uid and gid"
16000 .cindex "transport" "local"
16001 If the router queues an address for a transport, and this option is true, and
16002 the uid supplied by the router is not overridden by the transport, the
16003 &[initgroups()]& function is called when running the transport to ensure that
16004 any additional groups associated with the uid are set up. See also &%group%&
16005 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16006
16007
16008
16009 .option local_part_prefix routers&!? "string list" unset
16010 .cindex "router" "prefix for local part"
16011 .cindex "prefix" "for local part, used in router"
16012 If this option is set, the router is skipped unless the local part starts with
16013 one of the given strings, or &%local_part_prefix_optional%& is true. See
16014 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16015 evaluated.
16016
16017 The list is scanned from left to right, and the first prefix that matches is
16018 used. A limited form of wildcard is available; if the prefix begins with an
16019 asterisk, it matches the longest possible sequence of arbitrary characters at
16020 the start of the local part. An asterisk should therefore always be followed by
16021 some character that does not occur in normal local parts.
16022 .cindex "multiple mailboxes"
16023 .cindex "mailbox" "multiple"
16024 Wildcarding can be used to set up multiple user mailboxes, as described in
16025 section &<<SECTmulbox>>&.
16026
16027 .vindex "&$local_part$&"
16028 .vindex "&$local_part_prefix$&"
16029 During the testing of the &%local_parts%& option, and while the router is
16030 running, the prefix is removed from the local part, and is available in the
16031 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16032 the router accepts the address, this remains true during subsequent delivery by
16033 a transport. In particular, the local part that is transmitted in the RCPT
16034 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16035 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16036 the relevant transport.
16037
16038 When an address is being verified, &%local_part_prefix%& affects only the
16039 behaviour of the router. If the callout feature of verification is in use, this
16040 means that the full address, including the prefix, will be used during the
16041 callout.
16042
16043 The prefix facility is commonly used to handle local parts of the form
16044 &%owner-something%&. Another common use is to support local parts of the form
16045 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16046 to tell a user their forwarding is broken &-- by placing a router like this one
16047 immediately before the router that handles &_.forward_& files:
16048 .code
16049 real_localuser:
16050   driver = accept
16051   local_part_prefix = real-
16052   check_local_user
16053   transport = local_delivery
16054 .endd
16055 For security, it would probably be a good idea to restrict the use of this
16056 router to locally-generated messages, using a condition such as this:
16057 .code
16058   condition = ${if match {$sender_host_address}\
16059                          {\N^(|127\.0\.0\.1)$\N}}
16060 .endd
16061
16062 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16063 both conditions must be met if not optional. Care must be taken if wildcards
16064 are used in both a prefix and a suffix on the same router. Different
16065 separator characters must be used to avoid ambiguity.
16066
16067
16068 .option local_part_prefix_optional routers boolean false
16069 See &%local_part_prefix%& above.
16070
16071
16072
16073 .option local_part_suffix routers&!? "string list" unset
16074 .cindex "router" "suffix for local part"
16075 .cindex "suffix for local part" "used in router"
16076 This option operates in the same way as &%local_part_prefix%&, except that the
16077 local part must end (rather than start) with the given string, the
16078 &%local_part_suffix_optional%& option determines whether the suffix is
16079 mandatory, and the wildcard * character, if present, must be the last
16080 character of the suffix. This option facility is commonly used to handle local
16081 parts of the form &%something-request%& and multiple user mailboxes of the form
16082 &%username-foo%&.
16083
16084
16085 .option local_part_suffix_optional routers boolean false
16086 See &%local_part_suffix%& above.
16087
16088
16089
16090 .option local_parts routers&!? "local part list&!!" unset
16091 .cindex "router" "restricting to specific local parts"
16092 .cindex "local part" "checking in router"
16093 The router is run only if the local part of the address matches the list.
16094 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16095 are evaluated, and
16096 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16097 string is expanded, it is possible to make it depend on the domain, for
16098 example:
16099 .code
16100 local_parts = dbm;/usr/local/specials/$domain
16101 .endd
16102 .vindex "&$local_part_data$&"
16103 If the match is achieved by a lookup, the data that the lookup returned
16104 for the local part is placed in the variable &$local_part_data$& for use in
16105 expansions of the router's private options. You might use this option, for
16106 example, if you have a large number of local virtual domains, and you want to
16107 send all postmaster mail to the same place without having to set up an alias in
16108 each virtual domain:
16109 .code
16110 postmaster:
16111   driver = redirect
16112   local_parts = postmaster
16113   data = postmaster@real.domain.example
16114 .endd
16115
16116
16117 .option log_as_local routers boolean "see below"
16118 .cindex "log" "delivery line"
16119 .cindex "delivery" "log line format"
16120 Exim has two logging styles for delivery, the idea being to make local
16121 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16122 recipient address is given just as the local part, without a domain. The use of
16123 this style is controlled by this option. It defaults to true for the &(accept)&
16124 router, and false for all the others. This option applies only when a
16125 router assigns an address to a transport. It has no effect on routers that
16126 redirect addresses.
16127
16128
16129
16130 .option more routers boolean&!! true
16131 The result of string expansion for this option must be a valid boolean value,
16132 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16133 result causes an error, and delivery is deferred. If the expansion is forced to
16134 fail, the default value for the option (true) is used. Other failures cause
16135 delivery to be deferred.
16136
16137 If this option is set false, and the router declines to handle the address, no
16138 further routers are tried, routing fails, and the address is bounced.
16139 .oindex "&%self%&"
16140 However, if the router explicitly passes an address to the following router by
16141 means of the setting
16142 .code
16143 self = pass
16144 .endd
16145 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16146 does not affect the behaviour if one of the precondition tests fails. In that
16147 case, the address is always passed to the next router.
16148
16149 Note that &%address_data%& is not considered to be a precondition. If its
16150 expansion is forced to fail, the router declines, and the value of &%more%&
16151 controls what happens next.
16152
16153
16154 .option pass_on_timeout routers boolean false
16155 .cindex "timeout" "of router"
16156 .cindex "router" "timeout"
16157 If a router times out during a host lookup, it normally causes deferral of the
16158 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16159 router, overriding &%no_more%&. This may be helpful for systems that are
16160 intermittently connected to the Internet, or those that want to pass to a smart
16161 host any messages that cannot immediately be delivered.
16162
16163 There are occasional other temporary errors that can occur while doing DNS
16164 lookups. They are treated in the same way as a timeout, and this option
16165 applies to all of them.
16166
16167
16168
16169 .option pass_router routers string unset
16170 .cindex "router" "go to after &""pass""&"
16171 Routers that recognize the generic &%self%& option (&(dnslookup)&,
16172 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
16173 routing to continue, and overriding a false setting of &%more%&. When one of
16174 these routers returns &"pass"&, the address is normally handed on to the next
16175 router in sequence. This can be changed by setting &%pass_router%& to the name
16176 of another router. However (unlike &%redirect_router%&) the named router must
16177 be below the current router, to avoid loops. Note that this option applies only
16178 to the special case of &"pass"&. It does not apply when a router returns
16179 &"decline"& because it cannot handle an address.
16180
16181
16182
16183 .option redirect_router routers string unset
16184 .cindex "router" "start at after redirection"
16185 Sometimes an administrator knows that it is pointless to reprocess addresses
16186 generated from alias or forward files with the same router again. For
16187 example, if an alias file translates real names into login ids there is no
16188 point searching the alias file a second time, especially if it is a large file.
16189
16190 The &%redirect_router%& option can be set to the name of any router instance.
16191 It causes the routing of any generated addresses to start at the named router
16192 instead of at the first router. This option has no effect if the router in
16193 which it is set does not generate new addresses.
16194
16195
16196
16197 .option require_files routers&!? "string list&!!" unset
16198 .cindex "file" "requiring for router"
16199 .cindex "router" "requiring file existence"
16200 This option provides a general mechanism for predicating the running of a
16201 router on the existence or non-existence of certain files or directories.
16202 Before running a router, as one of its precondition tests, Exim works its way
16203 through the &%require_files%& list, expanding each item separately.
16204
16205 Because the list is split before expansion, any colons in expansion items must
16206 be doubled, or the facility for using a different list separator must be used.
16207 If any expansion is forced to fail, the item is ignored. Other expansion
16208 failures cause routing of the address to be deferred.
16209
16210 If any expanded string is empty, it is ignored. Otherwise, except as described
16211 below, each string must be a fully qualified file path, optionally preceded by
16212 &"!"&. The paths are passed to the &[stat()]& function to test for the
16213 existence of the files or directories. The router is skipped if any paths not
16214 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
16215
16216 .cindex "NFS"
16217 If &[stat()]& cannot determine whether a file exists or not, delivery of
16218 the message is deferred. This can happen when NFS-mounted filesystems are
16219 unavailable.
16220
16221 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
16222 options, so you cannot use it to check for the existence of a file in which to
16223 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
16224 full list of the order in which preconditions are evaluated.) However, as
16225 these options are all expanded, you can use the &%exists%& expansion condition
16226 to make such tests. The &%require_files%& option is intended for checking files
16227 that the router may be going to use internally, or which are needed by a
16228 transport (for example &_.procmailrc_&).
16229
16230 During delivery, the &[stat()]& function is run as root, but there is a
16231 facility for some checking of the accessibility of a file by another user.
16232 This is not a proper permissions check, but just a &"rough"& check that
16233 operates as follows:
16234
16235 If an item in a &%require_files%& list does not contain any forward slash
16236 characters, it is taken to be the user (and optional group, separated by a
16237 comma) to be checked for subsequent files in the list. If no group is specified
16238 but the user is specified symbolically, the gid associated with the uid is
16239 used. For example:
16240 .code
16241 require_files = mail:/some/file
16242 require_files = $local_part:$home/.procmailrc
16243 .endd
16244 If a user or group name in a &%require_files%& list does not exist, the
16245 &%require_files%& condition fails.
16246
16247 Exim performs the check by scanning along the components of the file path, and
16248 checking the access for the given uid and gid. It checks for &"x"& access on
16249 directories, and &"r"& access on the final file. Note that this means that file
16250 access control lists, if the operating system has them, are ignored.
16251
16252 &*Warning 1*&: When the router is being run to verify addresses for an
16253 incoming SMTP message, Exim is not running as root, but under its own uid. This
16254 may affect the result of a &%require_files%& check. In particular, &[stat()]&
16255 may yield the error EACCES (&"Permission denied"&). This means that the Exim
16256 user is not permitted to read one of the directories on the file's path.
16257
16258 &*Warning 2*&: Even when Exim is running as root while delivering a message,
16259 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
16260 without root access. In this case, if a check for access by a particular user
16261 is requested, Exim creates a subprocess that runs as that user, and tries the
16262 check again in that process.
16263
16264 The default action for handling an unresolved EACCES is to consider it to
16265 be caused by a configuration error, and routing is deferred because the
16266 existence or non-existence of the file cannot be determined. However, in some
16267 circumstances it may be desirable to treat this condition as if the file did
16268 not exist. If the file name (or the exclamation mark that precedes the file
16269 name for non-existence) is preceded by a plus sign, the EACCES error is treated
16270 as if the file did not exist. For example:
16271 .code
16272 require_files = +/some/file
16273 .endd
16274 If the router is not an essential part of verification (for example, it
16275 handles users' &_.forward_& files), another solution is to set the &%verify%&
16276 option false so that the router is skipped when verifying.
16277
16278
16279
16280 .option retry_use_local_part routers boolean "see below"
16281 .cindex "hints database" "retry keys"
16282 .cindex "local part" "in retry keys"
16283 When a delivery suffers a temporary routing failure, a retry record is created
16284 in Exim's hints database. For addresses whose routing depends only on the
16285 domain, the key for the retry record should not involve the local part, but for
16286 other addresses, both the domain and the local part should be included.
16287 Usually, remote routing is of the former kind, and local routing is of the
16288 latter kind.
16289
16290 This option controls whether the local part is used to form the key for retry
16291 hints for addresses that suffer temporary errors while being handled by this
16292 router. The default value is true for any router that has &%check_local_user%&
16293 set, and false otherwise. Note that this option does not apply to hints keys
16294 for transport delays; they are controlled by a generic transport option of the
16295 same name.
16296
16297 The setting of &%retry_use_local_part%& applies only to the router on which it
16298 appears. If the router generates child addresses, they are routed
16299 independently; this setting does not become attached to them.
16300
16301
16302
16303 .option router_home_directory routers string&!! unset
16304 .cindex "router" "home directory for"
16305 .cindex "home directory" "for router"
16306 .vindex "&$home$&"
16307 This option sets a home directory for use while the router is running. (Compare
16308 &%transport_home_directory%&, which sets a home directory for later
16309 transporting.) In particular, if used on a &(redirect)& router, this option
16310 sets a value for &$home$& while a filter is running. The value is expanded;
16311 forced expansion failure causes the option to be ignored &-- other failures
16312 cause the router to defer.
16313
16314 Expansion of &%router_home_directory%& happens immediately after the
16315 &%check_local_user%& test (if configured), before any further expansions take
16316 place.
16317 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16318 are evaluated.)
16319 While the router is running, &%router_home_directory%& overrides the value of
16320 &$home$& that came from &%check_local_user%&.
16321
16322 When a router accepts an address and assigns it to a local transport (including
16323 the cases when a &(redirect)& router generates a pipe, file, or autoreply
16324 delivery), the home directory setting for the transport is taken from the first
16325 of these values that is set:
16326
16327 .ilist
16328 The &%home_directory%& option on the transport;
16329 .next
16330 The &%transport_home_directory%& option on the router;
16331 .next
16332 The password data if &%check_local_user%& is set on the router;
16333 .next
16334 The &%router_home_directory%& option on the router.
16335 .endlist
16336
16337 In other words, &%router_home_directory%& overrides the password data for the
16338 router, but not for the transport.
16339
16340
16341
16342 .option self routers string freeze
16343 .cindex "MX record" "pointing to local host"
16344 .cindex "local host" "MX pointing to"
16345 This option applies to those routers that use a recipient address to find a
16346 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
16347 and &(manualroute)& routers.
16348 Certain configurations of the &(queryprogram)& router can also specify a list
16349 of remote hosts.
16350 Usually such routers are configured to send the message to a remote host via an
16351 &(smtp)& transport. The &%self%& option specifies what happens when the first
16352 host on the list turns out to be the local host.
16353 The way in which Exim checks for the local host is described in section
16354 &<<SECTreclocipadd>>&.
16355
16356 Normally this situation indicates either an error in Exim's configuration (for
16357 example, the router should be configured not to process this domain), or an
16358 error in the DNS (for example, the MX should not point to this host). For this
16359 reason, the default action is to log the incident, defer the address, and
16360 freeze the message. The following alternatives are provided for use in special
16361 cases:
16362
16363 .vlist
16364 .vitem &%defer%&
16365 Delivery of the message is tried again later, but the message is not frozen.
16366
16367 .vitem "&%reroute%&: <&'domain'&>"
16368 The domain is changed to the given domain, and the address is passed back to
16369 be reprocessed by the routers. No rewriting of headers takes place. This
16370 behaviour is essentially a redirection.
16371
16372 .vitem "&%reroute: rewrite:%& <&'domain'&>"
16373 The domain is changed to the given domain, and the address is passed back to be
16374 reprocessed by the routers. Any headers that contain the original domain are
16375 rewritten.
16376
16377 .vitem &%pass%&
16378 .oindex "&%more%&"
16379 .vindex "&$self_hostname$&"
16380 The router passes the address to the next router, or to the router named in the
16381 &%pass_router%& option if it is set. This overrides &%no_more%&. During
16382 subsequent routing and delivery, the variable &$self_hostname$& contains the
16383 name of the local host that the router encountered. This can be used to
16384 distinguish between different cases for hosts with multiple names. The
16385 combination
16386 .code
16387 self = pass
16388 no_more
16389 .endd
16390 ensures that only those addresses that routed to the local host are passed on.
16391 Without &%no_more%&, addresses that were declined for other reasons would also
16392 be passed to the next router.
16393
16394 .vitem &%fail%&
16395 Delivery fails and an error report is generated.
16396
16397 .vitem &%send%&
16398 .cindex "local host" "sending to"
16399 The anomaly is ignored and the address is queued for the transport. This
16400 setting should be used with extreme caution. For an &(smtp)& transport, it
16401 makes sense only in cases where the program that is listening on the SMTP port
16402 is not this version of Exim. That is, it must be some other MTA, or Exim with a
16403 different configuration file that handles the domain in another way.
16404 .endlist
16405
16406
16407
16408 .option senders routers&!? "address list&!!" unset
16409 .cindex "router" "checking senders"
16410 If this option is set, the router is skipped unless the message's sender
16411 address matches something on the list.
16412 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16413 are evaluated.
16414
16415 There are issues concerning verification when the running of routers is
16416 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
16417 setting, it sets the sender to the null string. When using the &%-bt%& option
16418 to check a configuration file, it is necessary also to use the &%-f%& option to
16419 set an appropriate sender. For incoming mail, the sender is unset when
16420 verifying the sender, but is available when verifying any recipients. If the
16421 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
16422 matters.
16423
16424
16425 .option translate_ip_address routers string&!! unset
16426 .cindex "IP address" "translating"
16427 .cindex "packet radio"
16428 .cindex "router" "IP address translation"
16429 There exist some rare networking situations (for example, packet radio) where
16430 it is helpful to be able to translate IP addresses generated by normal routing
16431 mechanisms into other IP addresses, thus performing a kind of manual IP
16432 routing. This should be done only if the normal IP routing of the TCP/IP stack
16433 is inadequate or broken. Because this is an extremely uncommon requirement, the
16434 code to support this option is not included in the Exim binary unless
16435 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
16436
16437 .vindex "&$host_address$&"
16438 The &%translate_ip_address%& string is expanded for every IP address generated
16439 by the router, with the generated address set in &$host_address$&. If the
16440 expansion is forced to fail, no action is taken.
16441 For any other expansion error, delivery of the message is deferred.
16442 If the result of the expansion is an IP address, that replaces the original
16443 address; otherwise the result is assumed to be a host name &-- this is looked
16444 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
16445 produce one or more replacement IP addresses. For example, to subvert all IP
16446 addresses in some specific networks, this could be added to a router:
16447 .code
16448 translate_ip_address = \
16449   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
16450     {$value}fail}}
16451 .endd
16452 The file would contain lines like
16453 .code
16454 10.2.3.128/26    some.host
16455 10.8.4.34/26     10.44.8.15
16456 .endd
16457 You should not make use of this facility unless you really understand what you
16458 are doing.
16459
16460
16461
16462 .option transport routers string&!! unset
16463 This option specifies the transport to be used when a router accepts an address
16464 and sets it up for delivery. A transport is never needed if a router is used
16465 only for verification. The value of the option is expanded at routing time,
16466 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
16467 and result must be the name of one of the configured transports. If it is not,
16468 delivery is deferred.
16469
16470 The &%transport%& option is not used by the &(redirect)& router, but it does
16471 have some private options that set up transports for pipe and file deliveries
16472 (see chapter &<<CHAPredirect>>&).
16473
16474
16475
16476 .option transport_current_directory routers string&!! unset
16477 .cindex "current directory for local transport"
16478 This option associates a current directory with any address that is routed
16479 to a local transport. This can happen either because a transport is
16480 explicitly configured for the router, or because it generates a delivery to a
16481 file or a pipe. During the delivery process (that is, at transport time), this
16482 option string is expanded and is set as the current directory, unless
16483 overridden by a setting on the transport.
16484 If the expansion fails for any reason, including forced failure, an error is
16485 logged, and delivery is deferred.
16486 See chapter &<<CHAPenvironment>>& for details of the local delivery
16487 environment.
16488
16489
16490
16491
16492 .option transport_home_directory routers string&!! "see below"
16493 .cindex "home directory" "for local transport"
16494 This option associates a home directory with any address that is routed to a
16495 local transport. This can happen either because a transport is explicitly
16496 configured for the router, or because it generates a delivery to a file or a
16497 pipe. During the delivery process (that is, at transport time), the option
16498 string is expanded and is set as the home directory, unless overridden by a
16499 setting of &%home_directory%& on the transport.
16500 If the expansion fails for any reason, including forced failure, an error is
16501 logged, and delivery is deferred.
16502
16503 If the transport does not specify a home directory, and
16504 &%transport_home_directory%& is not set for the router, the home directory for
16505 the transport is taken from the password data if &%check_local_user%& is set for
16506 the router. Otherwise it is taken from &%router_home_directory%& if that option
16507 is set; if not, no home directory is set for the transport.
16508
16509 See chapter &<<CHAPenvironment>>& for further details of the local delivery
16510 environment.
16511
16512
16513
16514
16515 .option unseen routers boolean&!! false
16516 .cindex "router" "carrying on after success"
16517 The result of string expansion for this option must be a valid boolean value,
16518 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16519 result causes an error, and delivery is deferred. If the expansion is forced to
16520 fail, the default value for the option (false) is used. Other failures cause
16521 delivery to be deferred.
16522
16523 When this option is set true, routing does not cease if the router accepts the
16524 address. Instead, a copy of the incoming address is passed to the next router,
16525 overriding a false setting of &%more%&. There is little point in setting
16526 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
16527 the value of &%unseen%& contains expansion items (and therefore, presumably, is
16528 sometimes true and sometimes false).
16529
16530 .cindex "copy of message (&%unseen%& option)"
16531 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
16532 qualifier in filter files. It can be used to cause copies of messages to be
16533 delivered to some other destination, while also carrying out a normal delivery.
16534 In effect, the current address is made into a &"parent"& that has two children
16535 &-- one that is delivered as specified by this router, and a clone that goes on
16536 to be routed further. For this reason, &%unseen%& may not be combined with the
16537 &%one_time%& option in a &(redirect)& router.
16538
16539 &*Warning*&: Header lines added to the address (or specified for removal) by
16540 this router or by previous routers affect the &"unseen"& copy of the message
16541 only. The clone that continues to be processed by further routers starts with
16542 no added headers and none specified for removal. For a &%redirect%& router, if
16543 a generated address is the same as the incoming address, this can lead to
16544 duplicate addresses with different header modifications. Exim does not do
16545 duplicate deliveries (except, in certain circumstances, to pipes -- see section
16546 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
16547 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
16548 &%redirect%& router may be of help.
16549
16550 Unlike the handling of header modifications, any data that was set by the
16551 &%address_data%& option in the current or previous routers &'is'& passed on to
16552 subsequent routers.
16553
16554
16555 .option user routers string&!! "see below"
16556 .cindex "uid (user id)" "local delivery"
16557 .cindex "local transports" "uid and gid"
16558 .cindex "transport" "local"
16559 .cindex "router" "user for filter processing"
16560 .cindex "filter" "user for processing"
16561 When a router queues an address for a transport, and the transport does not
16562 specify a user, the user given here is used when running the delivery process.
16563 The user may be specified numerically or by name. If expansion fails, the
16564 error is logged and delivery is deferred.
16565 This user is also used by the &(redirect)& router when running a filter file.
16566 The default is unset, except when &%check_local_user%& is set. In this case,
16567 the default is taken from the password information. If the user is specified as
16568 a name, and &%group%& is not set, the group associated with the user is used.
16569 See also &%initgroups%& and &%group%& and the discussion in chapter
16570 &<<CHAPenvironment>>&.
16571
16572
16573
16574 .option verify routers&!? boolean true
16575 Setting this option has the effect of setting &%verify_sender%& and
16576 &%verify_recipient%& to the same value.
16577
16578
16579 .option verify_only routers&!? boolean false
16580 .cindex "EXPN" "with &%verify_only%&"
16581 .oindex "&%-bv%&"
16582 .cindex "router" "used only when verifying"
16583 If this option is set, the router is used only when verifying an address or
16584 testing with the &%-bv%& option, not when actually doing a delivery, testing
16585 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
16586 restricted to verifying only senders or recipients by means of
16587 &%verify_sender%& and &%verify_recipient%&.
16588
16589 &*Warning*&: When the router is being run to verify addresses for an incoming
16590 SMTP message, Exim is not running as root, but under its own uid. If the router
16591 accesses any files, you need to make sure that they are accessible to the Exim
16592 user or group.
16593
16594
16595 .option verify_recipient routers&!? boolean true
16596 If this option is false, the router is skipped when verifying recipient
16597 addresses
16598 or testing recipient verification using &%-bv%&.
16599 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16600 are evaluated.
16601
16602
16603 .option verify_sender routers&!? boolean true
16604 If this option is false, the router is skipped when verifying sender addresses
16605 or testing sender verification using &%-bvs%&.
16606 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16607 are evaluated.
16608 .ecindex IIDgenoprou1
16609 .ecindex IIDgenoprou2
16610
16611
16612
16613
16614
16615
16616 . ////////////////////////////////////////////////////////////////////////////
16617 . ////////////////////////////////////////////////////////////////////////////
16618
16619 .chapter "The accept router" "CHID4"
16620 .cindex "&(accept)& router"
16621 .cindex "routers" "&(accept)&"
16622 The &(accept)& router has no private options of its own. Unless it is being
16623 used purely for verification (see &%verify_only%&) a transport is required to
16624 be defined by the generic &%transport%& option. If the preconditions that are
16625 specified by generic options are met, the router accepts the address and queues
16626 it for the given transport. The most common use of this router is for setting
16627 up deliveries to local mailboxes. For example:
16628 .code
16629 localusers:
16630   driver = accept
16631   domains = mydomain.example
16632   check_local_user
16633   transport = local_delivery
16634 .endd
16635 The &%domains%& condition in this example checks the domain of the address, and
16636 &%check_local_user%& checks that the local part is the login of a local user.
16637 When both preconditions are met, the &(accept)& router runs, and queues the
16638 address for the &(local_delivery)& transport.
16639
16640
16641
16642
16643
16644
16645 . ////////////////////////////////////////////////////////////////////////////
16646 . ////////////////////////////////////////////////////////////////////////////
16647
16648 .chapter "The dnslookup router" "CHAPdnslookup"
16649 .scindex IIDdnsrou1 "&(dnslookup)& router"
16650 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
16651 The &(dnslookup)& router looks up the hosts that handle mail for the
16652 recipient's domain in the DNS. A transport must always be set for this router,
16653 unless &%verify_only%& is set.
16654
16655 If SRV support is configured (see &%check_srv%& below), Exim first searches for
16656 SRV records. If none are found, or if SRV support is not configured,
16657 MX records are looked up. If no MX records exist, address records are sought.
16658 However, &%mx_domains%& can be set to disable the direct use of address
16659 records.
16660
16661 MX records of equal priority are sorted by Exim into a random order. Exim then
16662 looks for address records for the host names obtained from MX or SRV records.
16663 When a host has more than one IP address, they are sorted into a random order,
16664 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
16665 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
16666 generic option, the router declines.
16667
16668 Unless they have the highest priority (lowest MX value), MX records that point
16669 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
16670 are discarded, together with any other MX records of equal or lower priority.
16671
16672 .cindex "MX record" "pointing to local host"
16673 .cindex "local host" "MX pointing to"
16674 .oindex "&%self%&" "in &(dnslookup)& router"
16675 If the host pointed to by the highest priority MX record, or looked up as an
16676 address record, is the local host, or matches &%hosts_treat_as_local%&, what
16677 happens is controlled by the generic &%self%& option.
16678
16679
16680 .section "Problems with DNS lookups" "SECTprowitdnsloo"
16681 There have been problems with DNS servers when SRV records are looked up.
16682 Some mis-behaving servers return a DNS error or timeout when a non-existent
16683 SRV record is sought. Similar problems have in the past been reported for
16684 MX records. The global &%dns_again_means_nonexist%& option can help with this
16685 problem, but it is heavy-handed because it is a global option.
16686
16687 For this reason, there are two options, &%srv_fail_domains%& and
16688 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
16689 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
16690 an attempt to look up an SRV or MX record causes one of these results, and the
16691 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
16692 such record"&. In the case of an SRV lookup, this means that the router
16693 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
16694 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
16695 case routing fails.
16696
16697
16698
16699
16700 .section "Private options for dnslookup" "SECID118"
16701 .cindex "options" "&(dnslookup)& router"
16702 The private options for the &(dnslookup)& router are as follows:
16703
16704 .option check_secondary_mx dnslookup boolean false
16705 .cindex "MX record" "checking for secondary"
16706 If this option is set, the router declines unless the local host is found in
16707 (and removed from) the list of hosts obtained by MX lookup. This can be used to
16708 process domains for which the local host is a secondary mail exchanger
16709 differently to other domains. The way in which Exim decides whether a host is
16710 the local host is described in section &<<SECTreclocipadd>>&.
16711
16712
16713 .option check_srv dnslookup string&!! unset
16714 .cindex "SRV record" "enabling use of"
16715 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
16716 addition to MX and address records. The support is disabled by default. To
16717 enable SRV support, set the &%check_srv%& option to the name of the service
16718 required. For example,
16719 .code
16720 check_srv = smtp
16721 .endd
16722 looks for SRV records that refer to the normal smtp service. The option is
16723 expanded, so the service name can vary from message to message or address
16724 to address. This might be helpful if SRV records are being used for a
16725 submission service. If the expansion is forced to fail, the &%check_srv%&
16726 option is ignored, and the router proceeds to look for MX records in the
16727 normal way.
16728
16729 When the expansion succeeds, the router searches first for SRV records for
16730 the given service (it assumes TCP protocol). A single SRV record with a
16731 host name that consists of just a single dot indicates &"no such service for
16732 this domain"&; if this is encountered, the router declines. If other kinds of
16733 SRV record are found, they are used to construct a host list for delivery
16734 according to the rules of RFC 2782. MX records are not sought in this case.
16735
16736 When no SRV records are found, MX records (and address records) are sought in
16737 the traditional way. In other words, SRV records take precedence over MX
16738 records, just as MX records take precedence over address records. Note that
16739 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
16740 defined it. It is apparently believed that MX records are sufficient for email
16741 and that SRV records should not be used for this purpose. However, SRV records
16742 have an additional &"weight"& feature which some people might find useful when
16743 trying to split an SMTP load between hosts of different power.
16744
16745 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
16746 when there is a DNS lookup error.
16747
16748
16749
16750 .option mx_domains dnslookup "domain list&!!" unset
16751 .cindex "MX record" "required to exist"
16752 .cindex "SRV record" "required to exist"
16753 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
16754 record in order to be recognized. (The name of this option could be improved.)
16755 For example, if all the mail hosts in &'fict.example'& are known to have MX
16756 records, except for those in &'discworld.fict.example'&, you could use this
16757 setting:
16758 .code
16759 mx_domains = ! *.discworld.fict.example : *.fict.example
16760 .endd
16761 This specifies that messages addressed to a domain that matches the list but
16762 has no MX record should be bounced immediately instead of being routed using
16763 the address record.
16764
16765
16766 .option mx_fail_domains dnslookup "domain list&!!" unset
16767 If the DNS lookup for MX records for one of the domains in this list causes a
16768 DNS lookup error, Exim behaves as if no MX records were found. See section
16769 &<<SECTprowitdnsloo>>& for more discussion.
16770
16771
16772
16773
16774 .option qualify_single dnslookup boolean true
16775 .cindex "DNS" "resolver options"
16776 .cindex "DNS" "qualifying single-component names"
16777 When this option is true, the resolver option RES_DEFNAMES is set for DNS
16778 lookups. Typically, but not standardly, this causes the resolver to qualify
16779 single-component names with the default domain. For example, on a machine
16780 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
16781 &'thesaurus.ref.example'& inside the resolver. For details of what your
16782 resolver actually does, consult your man pages for &'resolver'& and
16783 &'resolv.conf'&.
16784
16785
16786
16787 .option rewrite_headers dnslookup boolean true
16788 .cindex "rewriting" "header lines"
16789 .cindex "header lines" "rewriting"
16790 If the domain name in the address that is being processed is not fully
16791 qualified, it may be expanded to its full form by a DNS lookup. For example, if
16792 an address is specified as &'dormouse@teaparty'&, the domain might be
16793 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
16794 occur as a result of setting the &%widen_domains%& option. If
16795 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
16796 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
16797 header lines of the message are rewritten with the full domain name.
16798
16799 This option should be turned off only when it is known that no message is
16800 ever going to be sent outside an environment where the abbreviation makes
16801 sense.
16802
16803 When an MX record is looked up in the DNS and matches a wildcard record, name
16804 servers normally return a record containing the name that has been looked up,
16805 making it impossible to detect whether a wildcard was present or not. However,
16806 some name servers have recently been seen to return the wildcard entry. If the
16807 name returned by a DNS lookup begins with an asterisk, it is not used for
16808 header rewriting.
16809
16810
16811 .option same_domain_copy_routing dnslookup boolean false
16812 .cindex "address" "copying routing"
16813 Addresses with the same domain are normally routed by the &(dnslookup)& router
16814 to the same list of hosts. However, this cannot be presumed, because the router
16815 options and preconditions may refer to the local part of the address. By
16816 default, therefore, Exim routes each address in a message independently. DNS
16817 servers run caches, so repeated DNS lookups are not normally expensive, and in
16818 any case, personal messages rarely have more than a few recipients.
16819
16820 If you are running mailing lists with large numbers of subscribers at the same
16821 domain, and you are using a &(dnslookup)& router which is independent of the
16822 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
16823 lookups for identical domains in one message. In this case, when &(dnslookup)&
16824 routes an address to a remote transport, any other unrouted addresses in the
16825 message that have the same domain are automatically given the same routing
16826 without processing them independently,
16827 provided the following conditions are met:
16828
16829 .ilist
16830 No router that processed the address specified &%headers_add%& or
16831 &%headers_remove%&.
16832 .next
16833 The router did not change the address in any way, for example, by &"widening"&
16834 the domain.
16835 .endlist
16836
16837
16838
16839
16840 .option search_parents dnslookup boolean false
16841 .cindex "DNS" "resolver options"
16842 When this option is true, the resolver option RES_DNSRCH is set for DNS
16843 lookups. This is different from the &%qualify_single%& option in that it
16844 applies to domains containing dots. Typically, but not standardly, it causes
16845 the resolver to search for the name in the current domain and in parent
16846 domains. For example, on a machine in the &'fict.example'& domain, if looking
16847 up &'teaparty.wonderland'& failed, the resolver would try
16848 &'teaparty.wonderland.fict.example'&. For details of what your resolver
16849 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
16850
16851 Setting this option true can cause problems in domains that have a wildcard MX
16852 record, because any domain that does not have its own MX record matches the
16853 local wildcard.
16854
16855
16856
16857 .option srv_fail_domains dnslookup "domain list&!!" unset
16858 If the DNS lookup for SRV records for one of the domains in this list causes a
16859 DNS lookup error, Exim behaves as if no SRV records were found. See section
16860 &<<SECTprowitdnsloo>>& for more discussion.
16861
16862
16863
16864
16865 .option widen_domains dnslookup "string list" unset
16866 .cindex "domain" "partial; widening"
16867 If a DNS lookup fails and this option is set, each of its strings in turn is
16868 added onto the end of the domain, and the lookup is tried again. For example,
16869 if
16870 .code
16871 widen_domains = fict.example:ref.example
16872 .endd
16873 is set and a lookup of &'klingon.dictionary'& fails,
16874 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
16875 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
16876 and &%search_parents%& options can cause some widening to be undertaken inside
16877 the DNS resolver. &%widen_domains%& is not applied to sender addresses
16878 when verifying, unless &%rewrite_headers%& is false (not the default).
16879
16880
16881 .section "Effect of qualify_single and search_parents" "SECID119"
16882 When a domain from an envelope recipient is changed by the resolver as a result
16883 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
16884 corresponding address in the message's header lines unless &%rewrite_headers%&
16885 is set false. Exim then re-routes the address, using the full domain.
16886
16887 These two options affect only the DNS lookup that takes place inside the router
16888 for the domain of the address that is being routed. They do not affect lookups
16889 such as that implied by
16890 .code
16891 domains = @mx_any
16892 .endd
16893 that may happen while processing a router precondition before the router is
16894 entered. No widening ever takes place for these lookups.
16895 .ecindex IIDdnsrou1
16896 .ecindex IIDdnsrou2
16897
16898
16899
16900
16901
16902
16903
16904
16905
16906 . ////////////////////////////////////////////////////////////////////////////
16907 . ////////////////////////////////////////////////////////////////////////////
16908
16909 .chapter "The ipliteral router" "CHID5"
16910 .cindex "&(ipliteral)& router"
16911 .cindex "domain literal" "routing"
16912 .cindex "routers" "&(ipliteral)&"
16913 This router has no private options. Unless it is being used purely for
16914 verification (see &%verify_only%&) a transport is required to be defined by the
16915 generic &%transport%& option. The router accepts the address if its domain part
16916 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
16917 router handles the address
16918 .code
16919 root@[192.168.1.1]
16920 .endd
16921 by setting up delivery to the host with that IP address. IPv4 domain literals
16922 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
16923 are similar, but the address is preceded by &`ipv6:`&. For example:
16924 .code
16925 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
16926 .endd
16927 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
16928 grounds that sooner or later somebody will try it.
16929
16930 .oindex "&%self%&" "in &(ipliteral)& router"
16931 If the IP address matches something in &%ignore_target_hosts%&, the router
16932 declines. If an IP literal turns out to refer to the local host, the generic
16933 &%self%& option determines what happens.
16934
16935 The RFCs require support for domain literals; however, their use is
16936 controversial in today's Internet. If you want to use this router, you must
16937 also set the main configuration option &%allow_domain_literals%&. Otherwise,
16938 Exim will not recognize the domain literal syntax in addresses.
16939
16940
16941
16942 . ////////////////////////////////////////////////////////////////////////////
16943 . ////////////////////////////////////////////////////////////////////////////
16944
16945 .chapter "The iplookup router" "CHID6"
16946 .cindex "&(iplookup)& router"
16947 .cindex "routers" "&(iplookup)&"
16948 The &(iplookup)& router was written to fulfil a specific requirement in
16949 Cambridge University (which in fact no longer exists). For this reason, it is
16950 not included in the binary of Exim by default. If you want to include it, you
16951 must set
16952 .code
16953 ROUTER_IPLOOKUP=yes
16954 .endd
16955 in your &_Local/Makefile_& configuration file.
16956
16957 The &(iplookup)& router routes an address by sending it over a TCP or UDP
16958 connection to one or more specific hosts. The host can then return the same or
16959 a different address &-- in effect rewriting the recipient address in the
16960 message's envelope. The new address is then passed on to subsequent routers. If
16961 this process fails, the address can be passed on to other routers, or delivery
16962 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
16963 must not be specified for it.
16964
16965 .cindex "options" "&(iplookup)& router"
16966 .option hosts iplookup string unset
16967 This option must be supplied. Its value is a colon-separated list of host
16968 names. The hosts are looked up using &[gethostbyname()]&
16969 (or &[getipnodebyname()]& when available)
16970 and are tried in order until one responds to the query. If none respond, what
16971 happens is controlled by &%optional%&.
16972
16973
16974 .option optional iplookup boolean false
16975 If &%optional%& is true, if no response is obtained from any host, the address
16976 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
16977 delivery to the address is deferred.
16978
16979
16980 .option port iplookup integer 0
16981 .cindex "port" "&(iplookup)& router"
16982 This option must be supplied. It specifies the port number for the TCP or UDP
16983 call.
16984
16985
16986 .option protocol iplookup string udp
16987 This option can be set to &"udp"& or &"tcp"& to specify which of the two
16988 protocols is to be used.
16989
16990
16991 .option query iplookup string&!! "see below"
16992 This defines the content of the query that is sent to the remote hosts. The
16993 default value is:
16994 .code
16995 $local_part@$domain $local_part@$domain
16996 .endd
16997 The repetition serves as a way of checking that a response is to the correct
16998 query in the default case (see &%response_pattern%& below).
16999
17000
17001 .option reroute iplookup string&!! unset
17002 If this option is not set, the rerouted address is precisely the byte string
17003 returned by the remote host, up to the first white space, if any. If set, the
17004 string is expanded to form the rerouted address. It can include parts matched
17005 in the response by &%response_pattern%& by means of numeric variables such as
17006 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17007 whether or not a pattern is in use. In all cases, the rerouted address must end
17008 up in the form &'local_part@domain'&.
17009
17010
17011 .option response_pattern iplookup string unset
17012 This option can be set to a regular expression that is applied to the string
17013 returned from the remote host. If the pattern does not match the response, the
17014 router declines. If &%response_pattern%& is not set, no checking of the
17015 response is done, unless the query was defaulted, in which case there is a
17016 check that the text returned after the first white space is the original
17017 address. This checks that the answer that has been received is in response to
17018 the correct question. For example, if the response is just a new domain, the
17019 following could be used:
17020 .code
17021 response_pattern = ^([^@]+)$
17022 reroute = $local_part@$1
17023 .endd
17024
17025 .option timeout iplookup time 5s
17026 This specifies the amount of time to wait for a response from the remote
17027 machine. The same timeout is used for the &[connect()]& function for a TCP
17028 call. It does not apply to UDP.
17029
17030
17031
17032
17033 . ////////////////////////////////////////////////////////////////////////////
17034 . ////////////////////////////////////////////////////////////////////////////
17035
17036 .chapter "The manualroute router" "CHID7"
17037 .scindex IIDmanrou1 "&(manualroute)& router"
17038 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17039 .cindex "domain" "manually routing"
17040 The &(manualroute)& router is so-called because it provides a way of manually
17041 routing an address according to its domain. It is mainly used when you want to
17042 route addresses to remote hosts according to your own rules, bypassing the
17043 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17044 route to local transports, a facility that may be useful if you want to save
17045 messages for dial-in hosts in local files.
17046
17047 The &(manualroute)& router compares a list of domain patterns with the domain
17048 it is trying to route. If there is no match, the router declines. Each pattern
17049 has associated with it a list of hosts and some other optional data, which may
17050 include a transport. The combination of a pattern and its data is called a
17051 &"routing rule"&. For patterns that do not have an associated transport, the
17052 generic &%transport%& option must specify a transport, unless the router is
17053 being used purely for verification (see &%verify_only%&).
17054
17055 .vindex "&$host$&"
17056 In the case of verification, matching the domain pattern is sufficient for the
17057 router to accept the address. When actually routing an address for delivery,
17058 an address that matches a domain pattern is queued for the associated
17059 transport. If the transport is not a local one, a host list must be associated
17060 with the pattern; IP addresses are looked up for the hosts, and these are
17061 passed to the transport along with the mail address. For local transports, a
17062 host list is optional. If it is present, it is passed in &$host$& as a single
17063 text string.
17064
17065 The list of routing rules can be provided as an inline string in
17066 &%route_list%&, or the data can be obtained by looking up the domain in a file
17067 or database by setting &%route_data%&. Only one of these settings may appear in
17068 any one instance of &(manualroute)&. The format of routing rules is described
17069 below, following the list of private options.
17070
17071
17072 .section "Private options for manualroute" "SECTprioptman"
17073
17074 .cindex "options" "&(manualroute)& router"
17075 The private options for the &(manualroute)& router are as follows:
17076
17077 .option host_all_ignored manualroute string defer
17078 See &%host_find_failed%&.
17079
17080 .option host_find_failed manualroute string freeze
17081 This option controls what happens when &(manualroute)& tries to find an IP
17082 address for a host, and the host does not exist. The option can be set to one
17083 of the following values:
17084 .code
17085 decline
17086 defer
17087 fail
17088 freeze
17089 ignore
17090 pass
17091 .endd
17092 The default (&"freeze"&) assumes that this state is a serious configuration
17093 error. The difference between &"pass"& and &"decline"& is that the former
17094 forces the address to be passed to the next router (or the router defined by
17095 &%pass_router%&),
17096 .oindex "&%more%&"
17097 overriding &%no_more%&, whereas the latter passes the address to the next
17098 router only if &%more%& is true.
17099
17100 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17101 cannot be found. If all the hosts in the list are ignored, the behaviour is
17102 controlled by the &%host_all_ignored%& option. This takes the same values
17103 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17104
17105 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17106 state; if a host lookup gets a temporary error, delivery is deferred unless the
17107 generic &%pass_on_timeout%& option is set.
17108
17109
17110 .option hosts_randomize manualroute boolean false
17111 .cindex "randomized host list"
17112 .cindex "host" "list of; randomized"
17113 If this option is set, the order of the items in a host list in a routing rule
17114 is randomized each time the list is used, unless an option in the routing rule
17115 overrides (see below). Randomizing the order of a host list can be used to do
17116 crude load sharing. However, if more than one mail address is routed by the
17117 same router to the same host list, the host lists are considered to be the same
17118 (even though they may be randomized into different orders) for the purpose of
17119 deciding whether to batch the deliveries into a single SMTP transaction.
17120
17121 When &%hosts_randomize%& is true, a host list may be split
17122 into groups whose order is separately randomized. This makes it possible to
17123 set up MX-like behaviour. The boundaries between groups are indicated by an
17124 item that is just &`+`& in the host list. For example:
17125 .code
17126 route_list = * host1:host2:host3:+:host4:host5
17127 .endd
17128 The order of the first three hosts and the order of the last two hosts is
17129 randomized for each use, but the first three always end up before the last two.
17130 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
17131 randomized host list is passed to an &(smtp)& transport that also has
17132 &%hosts_randomize set%&, the list is not re-randomized.
17133
17134
17135 .option route_data manualroute string&!! unset
17136 If this option is set, it must expand to yield the data part of a routing rule.
17137 Typically, the expansion string includes a lookup based on the domain. For
17138 example:
17139 .code
17140 route_data = ${lookup{$domain}dbm{/etc/routes}}
17141 .endd
17142 If the expansion is forced to fail, or the result is an empty string, the
17143 router declines. Other kinds of expansion failure cause delivery to be
17144 deferred.
17145
17146
17147 .option route_list manualroute "string list" unset
17148 This string is a list of routing rules, in the form defined below. Note that,
17149 unlike most string lists, the items are separated by semicolons. This is so
17150 that they may contain colon-separated host lists.
17151
17152
17153 .option same_domain_copy_routing manualroute boolean false
17154 .cindex "address" "copying routing"
17155 Addresses with the same domain are normally routed by the &(manualroute)&
17156 router to the same list of hosts. However, this cannot be presumed, because the
17157 router options and preconditions may refer to the local part of the address. By
17158 default, therefore, Exim routes each address in a message independently. DNS
17159 servers run caches, so repeated DNS lookups are not normally expensive, and in
17160 any case, personal messages rarely have more than a few recipients.
17161
17162 If you are running mailing lists with large numbers of subscribers at the same
17163 domain, and you are using a &(manualroute)& router which is independent of the
17164 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17165 lookups for identical domains in one message. In this case, when
17166 &(manualroute)& routes an address to a remote transport, any other unrouted
17167 addresses in the message that have the same domain are automatically given the
17168 same routing without processing them independently. However, this is only done
17169 if &%headers_add%& and &%headers_remove%& are unset.
17170
17171
17172
17173
17174 .section "Routing rules in route_list" "SECID120"
17175 The value of &%route_list%& is a string consisting of a sequence of routing
17176 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
17177 entered as two semicolons. Alternatively, the list separator can be changed as
17178 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
17179 Empty rules are ignored. The format of each rule is
17180 .display
17181 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
17182 .endd
17183 The following example contains two rules, each with a simple domain pattern and
17184 no options:
17185 .code
17186 route_list = \
17187   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
17188   thes.ref.example  mail-3.ref.example:mail-4.ref.example
17189 .endd
17190 The three parts of a rule are separated by white space. The pattern and the
17191 list of hosts can be enclosed in quotes if necessary, and if they are, the
17192 usual quoting rules apply. Each rule in a &%route_list%& must start with a
17193 single domain pattern, which is the only mandatory item in the rule. The
17194 pattern is in the same format as one item in a domain list (see section
17195 &<<SECTdomainlist>>&),
17196 except that it may not be the name of an interpolated file.
17197 That is, it may be wildcarded, or a regular expression, or a file or database
17198 lookup (with semicolons doubled, because of the use of semicolon as a separator
17199 in a &%route_list%&).
17200
17201 The rules in &%route_list%& are searched in order until one of the patterns
17202 matches the domain that is being routed. The list of hosts and then options are
17203 then used as described below. If there is no match, the router declines. When
17204 &%route_list%& is set, &%route_data%& must not be set.
17205
17206
17207
17208 .section "Routing rules in route_data" "SECID121"
17209 The use of &%route_list%& is convenient when there are only a small number of
17210 routing rules. For larger numbers, it is easier to use a file or database to
17211 hold the routing information, and use the &%route_data%& option instead.
17212 The value of &%route_data%& is a list of hosts, followed by (optional) options.
17213 Most commonly, &%route_data%& is set as a string that contains an
17214 expansion lookup. For example, suppose we place two routing rules in a file
17215 like this:
17216 .code
17217 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
17218 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
17219 .endd
17220 This data can be accessed by setting
17221 .code
17222 route_data = ${lookup{$domain}lsearch{/the/file/name}}
17223 .endd
17224 Failure of the lookup results in an empty string, causing the router to
17225 decline. However, you do not have to use a lookup in &%route_data%&. The only
17226 requirement is that the result of expanding the string is a list of hosts,
17227 possibly followed by options, separated by white space. The list of hosts must
17228 be enclosed in quotes if it contains white space.
17229
17230
17231
17232
17233 .section "Format of the list of hosts" "SECID122"
17234 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
17235 always separately expanded before use. If the expansion fails, the router
17236 declines. The result of the expansion must be a colon-separated list of names
17237 and/or IP addresses, optionally also including ports. The format of each item
17238 in the list is described in the next section. The list separator can be changed
17239 as described in section &<<SECTlistconstruct>>&.
17240
17241 If the list of hosts was obtained from a &%route_list%& item, the following
17242 variables are set during its expansion:
17243
17244 .ilist
17245 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
17246 If the domain was matched against a regular expression, the numeric variables
17247 &$1$&, &$2$&, etc. may be set. For example:
17248 .code
17249 route_list = ^domain(\d+)   host-$1.text.example
17250 .endd
17251 .next
17252 &$0$& is always set to the entire domain.
17253 .next
17254 &$1$& is also set when partial matching is done in a file lookup.
17255
17256 .next
17257 .vindex "&$value$&"
17258 If the pattern that matched the domain was a lookup item, the data that was
17259 looked up is available in the expansion variable &$value$&. For example:
17260 .code
17261 route_list = lsearch;;/some/file.routes  $value
17262 .endd
17263 .endlist
17264
17265 Note the doubling of the semicolon in the pattern that is necessary because
17266 semicolon is the default route list separator.
17267
17268
17269
17270 .section "Format of one host item" "SECTformatonehostitem"
17271 Each item in the list of hosts is either a host name or an IP address,
17272 optionally with an attached port number. When no port is given, an IP address
17273 is not enclosed in brackets. When a port is specified, it overrides the port
17274 specification on the transport. The port is separated from the name or address
17275 by a colon. This leads to some complications:
17276
17277 .ilist
17278 Because colon is the default separator for the list of hosts, either
17279 the colon that specifies a port must be doubled, or the list separator must
17280 be changed. The following two examples have the same effect:
17281 .code
17282 route_list = * "host1.tld::1225 : host2.tld::1226"
17283 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
17284 .endd
17285 .next
17286 When IPv6 addresses are involved, it gets worse, because they contain
17287 colons of their own. To make this case easier, it is permitted to
17288 enclose an IP address (either v4 or v6) in square brackets if a port
17289 number follows. For example:
17290 .code
17291 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
17292 .endd
17293 .endlist
17294
17295 .section "How the list of hosts is used" "SECThostshowused"
17296 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
17297 the hosts is tried, in the order specified, when carrying out the SMTP
17298 delivery. However, the order can be changed by setting the &%hosts_randomize%&
17299 option, either on the router (see section &<<SECTprioptman>>& above), or on the
17300 transport.
17301
17302 Hosts may be listed by name or by IP address. An unadorned name in the list of
17303 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
17304 interpreted as an indirection to a sublist of hosts obtained by looking up MX
17305 records in the DNS. For example:
17306 .code
17307 route_list = *  x.y.z:p.q.r/MX:e.f.g
17308 .endd
17309 If this feature is used with a port specifier, the port must come last. For
17310 example:
17311 .code
17312 route_list = *  dom1.tld/mx::1225
17313 .endd
17314 If the &%hosts_randomize%& option is set, the order of the items in the list is
17315 randomized before any lookups are done. Exim then scans the list; for any name
17316 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
17317 be an interface on the local host and the item is not the first in the list,
17318 Exim discards it and any subsequent items. If it is the first item, what
17319 happens is controlled by the
17320 .oindex "&%self%&" "in &(manualroute)& router"
17321 &%self%& option of the router.
17322
17323 A name on the list that is followed by &`/MX`& is replaced with the list of
17324 hosts obtained by looking up MX records for the name. This is always a DNS
17325 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
17326 below) are not relevant here. The order of these hosts is determined by the
17327 preference values in the MX records, according to the usual rules. Because
17328 randomizing happens before the MX lookup, it does not affect the order that is
17329 defined by MX preferences.
17330
17331 If the local host is present in the sublist obtained from MX records, but is
17332 not the most preferred host in that list, it and any equally or less
17333 preferred hosts are removed before the sublist is inserted into the main list.
17334
17335 If the local host is the most preferred host in the MX list, what happens
17336 depends on where in the original list of hosts the &`/MX`& item appears. If it
17337 is not the first item (that is, there are previous hosts in the main list),
17338 Exim discards this name and any subsequent items in the main list.
17339
17340 If the MX item is first in the list of hosts, and the local host is the
17341 most preferred host, what happens is controlled by the &%self%& option of the
17342 router.
17343
17344 DNS failures when lookup up the MX records are treated in the same way as DNS
17345 failures when looking up IP addresses: &%pass_on_timeout%& and
17346 &%host_find_failed%& are used when relevant.
17347
17348 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
17349 whether obtained from an MX lookup or not.
17350
17351
17352
17353 .section "How the options are used" "SECThowoptused"
17354 The options are a sequence of words; in practice no more than three are ever
17355 present. One of the words can be the name of a transport; this overrides the
17356 &%transport%& option on the router for this particular routing rule only. The
17357 other words (if present) control randomization of the list of hosts on a
17358 per-rule basis, and how the IP addresses of the hosts are to be found when
17359 routing to a remote transport. These options are as follows:
17360
17361 .ilist
17362 &%randomize%&: randomize the order of the hosts in this list, overriding the
17363 setting of &%hosts_randomize%& for this routing rule only.
17364 .next
17365 &%no_randomize%&: do not randomize the order of the hosts in this list,
17366 overriding the setting of &%hosts_randomize%& for this routing rule only.
17367 .next
17368 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
17369 find IP addresses. This function may ultimately cause a DNS lookup, but it may
17370 also look in &_/etc/hosts_& or other sources of information.
17371 .next
17372 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
17373 no address records are found. If there is a temporary DNS error (such as a
17374 timeout), delivery is deferred.
17375 .endlist
17376
17377 For example:
17378 .code
17379 route_list = domain1  host1:host2:host3  randomize bydns;\
17380              domain2  host4:host5
17381 .endd
17382 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
17383 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
17384 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
17385 or &[gethostbyname()]&, and the result of the lookup is the result of that
17386 call.
17387
17388 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
17389 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
17390 instead of TRY_AGAIN. That is why the default action is to try a DNS
17391 lookup first. Only if that gives a definite &"no such host"& is the local
17392 function called.
17393
17394
17395
17396 If no IP address for a host can be found, what happens is controlled by the
17397 &%host_find_failed%& option.
17398
17399 .vindex "&$host$&"
17400 When an address is routed to a local transport, IP addresses are not looked up.
17401 The host list is passed to the transport in the &$host$& variable.
17402
17403
17404
17405 .section "Manualroute examples" "SECID123"
17406 In some of the examples that follow, the presence of the &%remote_smtp%&
17407 transport, as defined in the default configuration file, is assumed:
17408
17409 .ilist
17410 .cindex "smart host" "example router"
17411 The &(manualroute)& router can be used to forward all external mail to a
17412 &'smart host'&. If you have set up, in the main part of the configuration, a
17413 named domain list that contains your local domains, for example:
17414 .code
17415 domainlist local_domains = my.domain.example
17416 .endd
17417 You can arrange for all other domains to be routed to a smart host by making
17418 your first router something like this:
17419 .code
17420 smart_route:
17421   driver = manualroute
17422   domains = !+local_domains
17423   transport = remote_smtp
17424   route_list = * smarthost.ref.example
17425 .endd
17426 This causes all non-local addresses to be sent to the single host
17427 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
17428 they are tried in order
17429 (but you can use &%hosts_randomize%& to vary the order each time).
17430 Another way of configuring the same thing is this:
17431 .code
17432 smart_route:
17433   driver = manualroute
17434   transport = remote_smtp
17435   route_list = !+local_domains  smarthost.ref.example
17436 .endd
17437 There is no difference in behaviour between these two routers as they stand.
17438 However, they behave differently if &%no_more%& is added to them. In the first
17439 example, the router is skipped if the domain does not match the &%domains%&
17440 precondition; the following router is always tried. If the router runs, it
17441 always matches the domain and so can never decline. Therefore, &%no_more%&
17442 would have no effect. In the second case, the router is never skipped; it
17443 always runs. However, if it doesn't match the domain, it declines. In this case
17444 &%no_more%& would prevent subsequent routers from running.
17445
17446 .next
17447 .cindex "mail hub example"
17448 A &'mail hub'& is a host which receives mail for a number of domains via MX
17449 records in the DNS and delivers it via its own private routing mechanism. Often
17450 the final destinations are behind a firewall, with the mail hub being the one
17451 machine that can connect to machines both inside and outside the firewall. The
17452 &(manualroute)& router is usually used on a mail hub to route incoming messages
17453 to the correct hosts. For a small number of domains, the routing can be inline,
17454 using the &%route_list%& option, but for a larger number a file or database
17455 lookup is easier to manage.
17456
17457 If the domain names are in fact the names of the machines to which the mail is
17458 to be sent by the mail hub, the configuration can be quite simple. For
17459 example:
17460 .code
17461 hub_route:
17462   driver = manualroute
17463   transport = remote_smtp
17464   route_list = *.rhodes.tvs.example  $domain
17465 .endd
17466 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
17467 whose names are the same as the mail domains. A similar approach can be taken
17468 if the host name can be obtained from the domain name by a string manipulation
17469 that the expansion facilities can handle. Otherwise, a lookup based on the
17470 domain can be used to find the host:
17471 .code
17472 through_firewall:
17473   driver = manualroute
17474   transport = remote_smtp
17475   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
17476 .endd
17477 The result of the lookup must be the name or IP address of the host (or
17478 hosts) to which the address is to be routed. If the lookup fails, the route
17479 data is empty, causing the router to decline. The address then passes to the
17480 next router.
17481
17482 .next
17483 .cindex "batched SMTP output example"
17484 .cindex "SMTP" "batched outgoing; example"
17485 You can use &(manualroute)& to deliver messages to pipes or files in batched
17486 SMTP format for onward transportation by some other means. This is one way of
17487 storing mail for a dial-up host when it is not connected. The route list entry
17488 can be as simple as a single domain name in a configuration like this:
17489 .code
17490 save_in_file:
17491   driver = manualroute
17492   transport = batchsmtp_appendfile
17493   route_list = saved.domain.example
17494 .endd
17495 though often a pattern is used to pick up more than one domain. If there are
17496 several domains or groups of domains with different transport requirements,
17497 different transports can be listed in the routing information:
17498 .code
17499 save_in_file:
17500   driver = manualroute
17501   route_list = \
17502     *.saved.domain1.example  $domain  batch_appendfile; \
17503     *.saved.domain2.example  \
17504       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
17505       batch_pipe
17506 .endd
17507 .vindex "&$domain$&"
17508 .vindex "&$host$&"
17509 The first of these just passes the domain in the &$host$& variable, which
17510 doesn't achieve much (since it is also in &$domain$&), but the second does a
17511 file lookup to find a value to pass, causing the router to decline to handle
17512 the address if the lookup fails.
17513
17514 .next
17515 .cindex "UUCP" "example of router for"
17516 Routing mail directly to UUCP software is a specific case of the use of
17517 &(manualroute)& in a gateway to another mail environment. This is an example of
17518 one way it can be done:
17519 .code
17520 # Transport
17521 uucp:
17522   driver = pipe
17523   user = nobody
17524   command = /usr/local/bin/uux -r - \
17525     ${substr_-5:$host}!rmail ${local_part}
17526   return_fail_output = true
17527
17528 # Router
17529 uucphost:
17530   transport = uucp
17531   driver = manualroute
17532   route_data = \
17533     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
17534 .endd
17535 The file &_/usr/local/exim/uucphosts_& contains entries like
17536 .code
17537 darksite.ethereal.example:           darksite.UUCP
17538 .endd
17539 It can be set up more simply without adding and removing &".UUCP"& but this way
17540 makes clear the distinction between the domain name
17541 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
17542 .endlist
17543 .ecindex IIDmanrou1
17544 .ecindex IIDmanrou2
17545
17546
17547
17548
17549
17550
17551
17552
17553 . ////////////////////////////////////////////////////////////////////////////
17554 . ////////////////////////////////////////////////////////////////////////////
17555
17556 .chapter "The queryprogram router" "CHAPdriverlast"
17557 .scindex IIDquerou1 "&(queryprogram)& router"
17558 .scindex IIDquerou2 "routers" "&(queryprogram)&"
17559 .cindex "routing" "by external program"
17560 The &(queryprogram)& router routes an address by running an external command
17561 and acting on its output. This is an expensive way to route, and is intended
17562 mainly for use in lightly-loaded systems, or for performing experiments.
17563 However, if it is possible to use the precondition options (&%domains%&,
17564 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
17565 be used in special cases, even on a busy host. There are the following private
17566 options:
17567 .cindex "options" "&(queryprogram)& router"
17568
17569 .option command queryprogram string&!! unset
17570 This option must be set. It specifies the command that is to be run. The
17571 command is split up into a command name and arguments, and then each is
17572 expanded separately (exactly as for a &(pipe)& transport, described in chapter
17573 &<<CHAPpipetransport>>&).
17574
17575
17576 .option command_group queryprogram string unset
17577 .cindex "gid (group id)" "in &(queryprogram)& router"
17578 This option specifies a gid to be set when running the command while routing an
17579 address for deliver. It must be set if &%command_user%& specifies a numerical
17580 uid. If it begins with a digit, it is interpreted as the numerical value of the
17581 gid. Otherwise it is looked up using &[getgrnam()]&.
17582
17583
17584 .option command_user queryprogram string unset
17585 .cindex "uid (user id)" "for &(queryprogram)&"
17586 This option must be set. It specifies the uid which is set when running the
17587 command while routing an address for delivery. If the value begins with a digit,
17588 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
17589 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
17590 not set, a value for the gid also.
17591
17592 &*Warning:*& Changing uid and gid is possible only when Exim is running as
17593 root, which it does during a normal delivery in a conventional configuration.
17594 However, when an address is being verified during message reception, Exim is
17595 usually running as the Exim user, not as root. If the &(queryprogram)& router
17596 is called from a non-root process, Exim cannot change uid or gid before running
17597 the command. In this circumstance the command runs under the current uid and
17598 gid.
17599
17600
17601 .option current_directory queryprogram string /
17602 This option specifies an absolute path which is made the current directory
17603 before running the command.
17604
17605
17606 .option timeout queryprogram time 1h
17607 If the command does not complete within the timeout period, its process group
17608 is killed and the message is frozen. A value of zero time specifies no
17609 timeout.
17610
17611
17612 The standard output of the command is connected to a pipe, which is read when
17613 the command terminates. It should consist of a single line of output,
17614 containing up to five fields, separated by white space. The maximum length of
17615 the line is 1023 characters. Longer lines are silently truncated. The first
17616 field is one of the following words (case-insensitive):
17617
17618 .ilist
17619 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
17620 below).
17621 .next
17622 &'Decline'&: the router declines; pass the address to the next router, unless
17623 &%no_more%& is set.
17624 .next
17625 &'Fail'&: routing failed; do not pass the address to any more routers. Any
17626 subsequent text on the line is an error message. If the router is run as part
17627 of address verification during an incoming SMTP message, the message is
17628 included in the SMTP response.
17629 .next
17630 &'Defer'&: routing could not be completed at this time; try again later. Any
17631 subsequent text on the line is an error message which is logged. It is not
17632 included in any SMTP response.
17633 .next
17634 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
17635 .next
17636 &'Pass'&: pass the address to the next router (or the router specified by
17637 &%pass_router%&), overriding &%no_more%&.
17638 .next
17639 &'Redirect'&: the message is redirected. The remainder of the line is a list of
17640 new addresses, which are routed independently, starting with the first router,
17641 or the router specified by &%redirect_router%&, if set.
17642 .endlist
17643
17644 When the first word is &'accept'&, the remainder of the line consists of a
17645 number of keyed data values, as follows (split into two lines here, to fit on
17646 the page):
17647 .code
17648 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
17649 LOOKUP=byname|bydns DATA=<text>
17650 .endd
17651 The data items can be given in any order, and all are optional. If no transport
17652 is included, the transport specified by the generic &%transport%& option is
17653 used. The list of hosts and the lookup type are needed only if the transport is
17654 an &(smtp)& transport that does not itself supply a list of hosts.
17655
17656 The format of the list of hosts is the same as for the &(manualroute)& router.
17657 As well as host names and IP addresses with optional port numbers, as described
17658 in section &<<SECTformatonehostitem>>&, it may contain names followed by
17659 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
17660 (see section &<<SECThostshowused>>&).
17661
17662 If the lookup type is not specified, Exim behaves as follows when trying to
17663 find an IP address for each host: First, a DNS lookup is done. If this yields
17664 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
17665 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
17666 result of the lookup is the result of that call.
17667
17668 .vindex "&$address_data$&"
17669 If the DATA field is set, its value is placed in the &$address_data$&
17670 variable. For example, this return line
17671 .code
17672 accept hosts=x1.y.example:x2.y.example data="rule1"
17673 .endd
17674 routes the address to the default transport, passing a list of two hosts. When
17675 the transport runs, the string &"rule1"& is in &$address_data$&.
17676 .ecindex IIDquerou1
17677 .ecindex IIDquerou2
17678
17679
17680
17681
17682 . ////////////////////////////////////////////////////////////////////////////
17683 . ////////////////////////////////////////////////////////////////////////////
17684
17685 .chapter "The redirect router" "CHAPredirect"
17686 .scindex IIDredrou1 "&(redirect)& router"
17687 .scindex IIDredrou2 "routers" "&(redirect)&"
17688 .cindex "alias file" "in a &(redirect)& router"
17689 .cindex "address redirection" "&(redirect)& router"
17690 The &(redirect)& router handles several kinds of address redirection. Its most
17691 common uses are for resolving local part aliases from a central alias file
17692 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
17693 files, but it has many other potential uses. The incoming address can be
17694 redirected in several different ways:
17695
17696 .ilist
17697 It can be replaced by one or more new addresses which are themselves routed
17698 independently.
17699 .next
17700 It can be routed to be delivered to a given file or directory.
17701 .next
17702 It can be routed to be delivered to a specified pipe command.
17703 .next
17704 It can cause an automatic reply to be generated.
17705 .next
17706 It can be forced to fail, optionally with a custom error message.
17707 .next
17708 It can be temporarily deferred, optionally with a custom message.
17709 .next
17710 It can be discarded.
17711 .endlist
17712
17713 The generic &%transport%& option must not be set for &(redirect)& routers.
17714 However, there are some private options which define transports for delivery to
17715 files and pipes, and for generating autoreplies. See the &%file_transport%&,
17716 &%pipe_transport%& and &%reply_transport%& descriptions below.
17717
17718
17719
17720 .section "Redirection data" "SECID124"
17721 The router operates by interpreting a text string which it obtains either by
17722 expanding the contents of the &%data%& option, or by reading the entire
17723 contents of a file whose name is given in the &%file%& option. These two
17724 options are mutually exclusive. The first is commonly used for handling system
17725 aliases, in a configuration like this:
17726 .code
17727 system_aliases:
17728   driver = redirect
17729   data = ${lookup{$local_part}lsearch{/etc/aliases}}
17730 .endd
17731 If the lookup fails, the expanded string in this example is empty. When the
17732 expansion of &%data%& results in an empty string, the router declines. A forced
17733 expansion failure also causes the router to decline; other expansion failures
17734 cause delivery to be deferred.
17735
17736 A configuration using &%file%& is commonly used for handling users'
17737 &_.forward_& files, like this:
17738 .code
17739 userforward:
17740   driver = redirect
17741   check_local_user
17742   file = $home/.forward
17743   no_verify
17744 .endd
17745 If the file does not exist, or causes no action to be taken (for example, it is
17746 empty or consists only of comments), the router declines. &*Warning*&: This
17747 is not the case when the file contains syntactically valid items that happen to
17748 yield empty addresses, for example, items containing only RFC 2822 address
17749 comments.
17750
17751
17752
17753 .section "Forward files and address verification" "SECID125"
17754 .cindex "address redirection" "while verifying"
17755 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
17756 &_.forward_& files, as in the example above. There are two reasons for this:
17757
17758 .ilist
17759 When Exim is receiving an incoming SMTP message from a remote host, it is
17760 running under the Exim uid, not as root. Exim is unable to change uid to read
17761 the file as the user, and it may not be able to read it as the Exim user. So in
17762 practice the router may not be able to operate.
17763 .next
17764 However, even when the router can operate, the existence of a &_.forward_& file
17765 is unimportant when verifying an address. What should be checked is whether the
17766 local part is a valid user name or not. Cutting out the redirection processing
17767 saves some resources.
17768 .endlist
17769
17770
17771
17772
17773
17774
17775 .section "Interpreting redirection data" "SECID126"
17776 .cindex "Sieve filter" "specifying in redirection data"
17777 .cindex "filter" "specifying in redirection data"
17778 The contents of the data string, whether obtained from &%data%& or &%file%&,
17779 can be interpreted in two different ways:
17780
17781 .ilist
17782 If the &%allow_filter%& option is set true, and the data begins with the text
17783 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
17784 &'filtering'& instructions in the form of an Exim or Sieve filter file,
17785 respectively. Details of the syntax and semantics of filter files are described
17786 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
17787 document is intended for use by end users.
17788 .next
17789 Otherwise, the data must be a comma-separated list of redirection items, as
17790 described in the next section.
17791 .endlist
17792
17793 When a message is redirected to a file (a &"mail folder"&), the file name given
17794 in a non-filter redirection list must always be an absolute path. A filter may
17795 generate a relative path &-- how this is handled depends on the transport's
17796 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
17797 for the &(appendfile)& transport.
17798
17799
17800
17801 .section "Items in a non-filter redirection list" "SECTitenonfilred"
17802 .cindex "address redirection" "non-filter list items"
17803 When the redirection data is not an Exim or Sieve filter, for example, if it
17804 comes from a conventional alias or forward file, it consists of a list of
17805 addresses, file names, pipe commands, or certain special items (see section
17806 &<<SECTspecitredli>>& below). The special items can be individually enabled or
17807 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
17808 depending on their default values. The items in the list are separated by
17809 commas or newlines.
17810 If a comma is required in an item, the entire item must be enclosed in double
17811 quotes.
17812
17813 Lines starting with a # character are comments, and are ignored, and # may
17814 also appear following a comma, in which case everything between the # and the
17815 next newline character is ignored.
17816
17817 If an item is entirely enclosed in double quotes, these are removed. Otherwise
17818 double quotes are retained because some forms of mail address require their use
17819 (but never to enclose the entire address). In the following description,
17820 &"item"& refers to what remains after any surrounding double quotes have been
17821 removed.
17822
17823 .vindex "&$local_part$&"
17824 &*Warning*&: If you use an Exim expansion to construct a redirection address,
17825 and the expansion contains a reference to &$local_part$&, you should make use
17826 of the &%quote_local_part%& expansion operator, in case the local part contains
17827 special characters. For example, to redirect all mail for the domain
17828 &'obsolete.example'&, retaining the existing local part, you could use this
17829 setting:
17830 .code
17831 data = ${quote_local_part:$local_part}@newdomain.example
17832 .endd
17833
17834
17835 .section "Redirecting to a local mailbox" "SECTredlocmai"
17836 .cindex "routing" "loops in"
17837 .cindex "loop" "while routing, avoidance of"
17838 .cindex "address redirection" "to local mailbox"
17839 A redirection item may safely be the same as the address currently under
17840 consideration. This does not cause a routing loop, because a router is
17841 automatically skipped if any ancestor of the address that is being processed
17842 is the same as the current address and was processed by the current router.
17843 Such an address is therefore passed to the following routers, so it is handled
17844 as if there were no redirection. When making this loop-avoidance test, the
17845 complete local part, including any prefix or suffix, is used.
17846
17847 .cindex "address redirection" "local part without domain"
17848 Specifying the same local part without a domain is a common usage in personal
17849 filter files when the user wants to have messages delivered to the local
17850 mailbox and also forwarded elsewhere. For example, the user whose login is
17851 &'cleo'& might have a &_.forward_& file containing this:
17852 .code
17853 cleo, cleopatra@egypt.example
17854 .endd
17855 .cindex "backslash in alias file"
17856 .cindex "alias file" "backslash in"
17857 For compatibility with other MTAs, such unqualified local parts may be
17858 preceded by &"\"&, but this is not a requirement for loop prevention. However,
17859 it does make a difference if more than one domain is being handled
17860 synonymously.
17861
17862 If an item begins with &"\"& and the rest of the item parses as a valid RFC
17863 2822 address that does not include a domain, the item is qualified using the
17864 domain of the incoming address. In the absence of a leading &"\"&, unqualified
17865 addresses are qualified using the value in &%qualify_recipient%&, but you can
17866 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
17867
17868 Care must be taken if there are alias names for local users.
17869 Consider an MTA handling a single local domain where the system alias file
17870 contains:
17871 .code
17872 Sam.Reman: spqr
17873 .endd
17874 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
17875 messages in the local mailbox, and also forward copies elsewhere. He creates
17876 this forward file:
17877 .code
17878 Sam.Reman, spqr@reme.elsewhere.example
17879 .endd
17880 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
17881 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
17882 second time round, because it has previously routed it,
17883 and the following routers presumably cannot handle the alias. The forward file
17884 should really contain
17885 .code
17886 spqr, spqr@reme.elsewhere.example
17887 .endd
17888 but because this is such a common error, the &%check_ancestor%& option (see
17889 below) exists to provide a way to get round it. This is normally set on a
17890 &(redirect)& router that is handling users' &_.forward_& files.
17891
17892
17893
17894 .section "Special items in redirection lists" "SECTspecitredli"
17895 In addition to addresses, the following types of item may appear in redirection
17896 lists (that is, in non-filter redirection data):
17897
17898 .ilist
17899 .cindex "pipe" "in redirection list"
17900 .cindex "address redirection" "to pipe"
17901 An item is treated as a pipe command if it begins with &"|"& and does not parse
17902 as a valid RFC 2822 address that includes a domain. A transport for running the
17903 command must be specified by the &%pipe_transport%& option.
17904 Normally, either the router or the transport specifies a user and a group under
17905 which to run the delivery. The default is to use the Exim user and group.
17906
17907 Single or double quotes can be used for enclosing the individual arguments of
17908 the pipe command; no interpretation of escapes is done for single quotes. If
17909 the command contains a comma character, it is necessary to put the whole item
17910 in double quotes, for example:
17911 .code
17912 "|/some/command ready,steady,go"
17913 .endd
17914 since items in redirection lists are terminated by commas. Do not, however,
17915 quote just the command. An item such as
17916 .code
17917 |"/some/command ready,steady,go"
17918 .endd
17919 is interpreted as a pipe with a rather strange command name, and no arguments.
17920
17921 .next
17922 .cindex "file" "in redirection list"
17923 .cindex "address redirection" "to file"
17924 An item is interpreted as a path name if it begins with &"/"& and does not
17925 parse as a valid RFC 2822 address that includes a domain. For example,
17926 .code
17927 /home/world/minbari
17928 .endd
17929 is treated as a file name, but
17930 .code
17931 /s=molari/o=babylon/@x400gate.way
17932 .endd
17933 is treated as an address. For a file name, a transport must be specified using
17934 the &%file_transport%& option. However, if the generated path name ends with a
17935 forward slash character, it is interpreted as a directory name rather than a
17936 file name, and &%directory_transport%& is used instead.
17937
17938 Normally, either the router or the transport specifies a user and a group under
17939 which to run the delivery. The default is to use the Exim user and group.
17940
17941 .cindex "&_/dev/null_&"
17942 However, if a redirection item is the path &_/dev/null_&, delivery to it is
17943 bypassed at a high level, and the log entry shows &"**bypassed**"&
17944 instead of a transport name. In this case the user and group are not used.
17945
17946 .next
17947 .cindex "included address list"
17948 .cindex "address redirection" "included external list"
17949 If an item is of the form
17950 .code
17951 :include:<path name>
17952 .endd
17953 a list of further items is taken from the given file and included at that
17954 point. &*Note*&: Such a file can not be a filter file; it is just an
17955 out-of-line addition to the list. The items in the included list are separated
17956 by commas or newlines and are not subject to expansion. If this is the first
17957 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
17958 the alias name. This example is incorrect:
17959 .code
17960 list1    :include:/opt/lists/list1
17961 .endd
17962 It must be given as
17963 .code
17964 list1:   :include:/opt/lists/list1
17965 .endd
17966 .next
17967 .cindex "address redirection" "to black hole"
17968 Sometimes you want to throw away mail to a particular local part. Making the
17969 &%data%& option expand to an empty string does not work, because that causes
17970 the router to decline. Instead, the alias item
17971 .cindex "black hole"
17972 .cindex "abandoning mail"
17973 &':blackhole:'& can be used. It does what its name implies. No delivery is
17974 done, and no error message is generated. This has the same effect as specifing
17975 &_/dev/null_& as a destination, but it can be independently disabled.
17976
17977 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
17978 delivery is done for the original local part, even if other redirection items
17979 are present. If you are generating a multi-item list (for example, by reading a
17980 database) and need the ability to provide a no-op item, you must use
17981 &_/dev/null_&.
17982
17983 .next
17984 .cindex "delivery" "forcing failure"
17985 .cindex "delivery" "forcing deferral"
17986 .cindex "failing delivery" "forcing"
17987 .cindex "deferred delivery, forcing"
17988 .cindex "customizing" "failure message"
17989 An attempt to deliver a particular address can be deferred or forced to fail by
17990 redirection items of the form
17991 .code
17992 :defer:
17993 :fail:
17994 .endd
17995 respectively. When a redirection list contains such an item, it applies
17996 to the entire redirection; any other items in the list are ignored. Any
17997 text following &':fail:'& or &':defer:'& is placed in the error text
17998 associated with the failure. For example, an alias file might contain:
17999 .code
18000 X.Employee:  :fail: Gone away, no forwarding address
18001 .endd
18002 In the case of an address that is being verified from an ACL or as the subject
18003 of a
18004 .cindex "VRFY" "error text, display of"
18005 VRFY command, the text is included in the SMTP error response by
18006 default.
18007 .cindex "EXPN" "error text, display of"
18008 The text is not included in the response to an EXPN command. In non-SMTP cases
18009 the text is included in the error message that Exim generates.
18010
18011 .cindex "SMTP" "error codes"
18012 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18013 &':fail:'&. However, if the message starts with three digits followed by a
18014 space, optionally followed by an extended code of the form &'n.n.n'&, also
18015 followed by a space, and the very first digit is the same as the default error
18016 code, the code from the message is used instead. If the very first digit is
18017 incorrect, a panic error is logged, and the default code is used. You can
18018 suppress the use of the supplied code in a redirect router by setting the
18019 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18020 ignored.
18021
18022 .vindex "&$acl_verify_message$&"
18023 In an ACL, an explicitly provided message overrides the default, but the
18024 default message is available in the variable &$acl_verify_message$& and can
18025 therefore be included in a custom message if this is desired.
18026
18027 Normally the error text is the rest of the redirection list &-- a comma does
18028 not terminate it &-- but a newline does act as a terminator. Newlines are not
18029 normally present in alias expansions. In &(lsearch)& lookups they are removed
18030 as part of the continuation process, but they may exist in other kinds of
18031 lookup and in &':include:'& files.
18032
18033 During routing for message delivery (as opposed to verification), a redirection
18034 containing &':fail:'& causes an immediate failure of the incoming address,
18035 whereas &':defer:'& causes the message to remain on the queue so that a
18036 subsequent delivery attempt can happen at a later time. If an address is
18037 deferred for too long, it will ultimately fail, because the normal retry
18038 rules still apply.
18039
18040 .next
18041 .cindex "alias file" "exception to default"
18042 Sometimes it is useful to use a single-key search type with a default (see
18043 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18044 for exceptions to the default. These can be handled by aliasing them to
18045 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18046 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18047 results in an empty redirection list has the same effect.
18048 .endlist
18049
18050
18051 .section "Duplicate addresses" "SECTdupaddr"
18052 .cindex "duplicate addresses"
18053 .cindex "address duplicate, discarding"
18054 .cindex "pipe" "duplicated"
18055 Exim removes duplicate addresses from the list to which it is delivering, so as
18056 to deliver just one copy to each address. This does not apply to deliveries
18057 routed to pipes by different immediate parent addresses, but an indirect
18058 aliasing scheme of the type
18059 .code
18060 pipe:       |/some/command $local_part
18061 localpart1: pipe
18062 localpart2: pipe
18063 .endd
18064 does not work with a message that is addressed to both local parts, because
18065 when the second is aliased to the intermediate local part &"pipe"& it gets
18066 discarded as being the same as a previously handled address. However, a scheme
18067 such as
18068 .code
18069 localpart1: |/some/command $local_part
18070 localpart2: |/some/command $local_part
18071 .endd
18072 does result in two different pipe deliveries, because the immediate parents of
18073 the pipes are distinct.
18074
18075
18076
18077 .section "Repeated redirection expansion" "SECID128"
18078 .cindex "repeated redirection expansion"
18079 .cindex "address redirection" "repeated for each delivery attempt"
18080 When a message cannot be delivered to all of its recipients immediately,
18081 leading to two or more delivery attempts, redirection expansion is carried out
18082 afresh each time for those addresses whose children were not all previously
18083 delivered. If redirection is being used as a mailing list, this can lead to new
18084 members of the list receiving copies of old messages. The &%one_time%& option
18085 can be used to avoid this.
18086
18087
18088 .section "Errors in redirection lists" "SECID129"
18089 .cindex "address redirection" "errors"
18090 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18091 error is skipped, and an entry is written to the main log. This may be useful
18092 for mailing lists that are automatically managed. Otherwise, if an error is
18093 detected while generating the list of new addresses, the original address is
18094 deferred. See also &%syntax_errors_to%&.
18095
18096
18097
18098 .section "Private options for the redirect router" "SECID130"
18099
18100 .cindex "options" "&(redirect)& router"
18101 The private options for the &(redirect)& router are as follows:
18102
18103
18104 .option allow_defer redirect boolean false
18105 Setting this option allows the use of &':defer:'& in non-filter redirection
18106 data, or the &%defer%& command in an Exim filter file.
18107
18108
18109 .option allow_fail redirect boolean false
18110 .cindex "failing delivery" "from filter"
18111 If this option is true, the &':fail:'& item can be used in a redirection list,
18112 and the &%fail%& command may be used in an Exim filter file.
18113
18114
18115 .option allow_filter redirect boolean false
18116 .cindex "filter" "enabling use of"
18117 .cindex "Sieve filter" "enabling use of"
18118 Setting this option allows Exim to interpret redirection data that starts with
18119 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
18120 are some features of Exim filter files that some administrators may wish to
18121 lock out; see the &%forbid_filter_%&&'xxx'& options below.
18122
18123 It is also possible to lock out Exim filters or Sieve filters while allowing
18124 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
18125
18126
18127 The filter is run using the uid and gid set by the generic &%user%& and
18128 &%group%& options. These take their defaults from the password data if
18129 &%check_local_user%& is set, so in the normal case of users' personal filter
18130 files, the filter is run as the relevant user. When &%allow_filter%& is set
18131 true, Exim insists that either &%check_local_user%& or &%user%& is set.
18132
18133
18134
18135 .option allow_freeze redirect boolean false
18136 .cindex "freezing messages" "allowing in filter"
18137 Setting this option allows the use of the &%freeze%& command in an Exim filter.
18138 This command is more normally encountered in system filters, and is disabled by
18139 default for redirection filters because it isn't something you usually want to
18140 let ordinary users do.
18141
18142
18143
18144 .option check_ancestor redirect boolean false
18145 This option is concerned with handling generated addresses that are the same
18146 as some address in the list of redirection ancestors of the current address.
18147 Although it is turned off by default in the code, it is set in the default
18148 configuration file for handling users' &_.forward_& files. It is recommended
18149 for this use of the &(redirect)& router.
18150
18151 When &%check_ancestor%& is set, if a generated address (including the domain)
18152 is the same as any ancestor of the current address, it is replaced by a copy of
18153 the current address. This helps in the case where local part A is aliased to B,
18154 and B has a &_.forward_& file pointing back to A. For example, within a single
18155 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
18156 &_&~jb/.forward_& contains:
18157 .code
18158 \Joe.Bloggs, <other item(s)>
18159 .endd
18160 Without the &%check_ancestor%& setting, either local part (&"jb"& or
18161 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
18162 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
18163 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
18164 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
18165 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
18166 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
18167 original address. See also the &%repeat_use%& option below.
18168
18169
18170 .option check_group redirect boolean "see below"
18171 When the &%file%& option is used, the group owner of the file is checked only
18172 when this option is set. The permitted groups are those listed in the
18173 &%owngroups%& option, together with the user's default group if
18174 &%check_local_user%& is set. If the file has the wrong group, routing is
18175 deferred. The default setting for this option is true if &%check_local_user%&
18176 is set and the &%modemask%& option permits the group write bit, or if the
18177 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
18178
18179
18180
18181 .option check_owner redirect boolean "see below"
18182 When the &%file%& option is used, the owner of the file is checked only when
18183 this option is set. If &%check_local_user%& is set, the local user is
18184 permitted; otherwise the owner must be one of those listed in the &%owners%&
18185 option. The default value for this option is true if &%check_local_user%& or
18186 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
18187
18188
18189 .option data redirect string&!! unset
18190 This option is mutually exclusive with &%file%&. One or other of them must be
18191 set, but not both. The contents of &%data%& are expanded, and then used as the
18192 list of forwarding items, or as a set of filtering instructions. If the
18193 expansion is forced to fail, or the result is an empty string or a string that
18194 has no effect (consists entirely of comments), the router declines.
18195
18196 When filtering instructions are used, the string must begin with &"#Exim
18197 filter"&, and all comments in the string, including this initial one, must be
18198 terminated with newline characters. For example:
18199 .code
18200 data = #Exim filter\n\
18201        if $h_to: contains Exim then save $home/mail/exim endif
18202 .endd
18203 If you are reading the data from a database where newlines cannot be included,
18204 you can use the &${sg}$& expansion item to turn the escape string of your
18205 choice into a newline.
18206
18207
18208 .option directory_transport redirect string&!! unset
18209 A &(redirect)& router sets up a direct delivery to a directory when a path name
18210 ending with a slash is specified as a new &"address"&. The transport used is
18211 specified by this option, which, after expansion, must be the name of a
18212 configured transport. This should normally be an &(appendfile)& transport.
18213
18214
18215 .option file redirect string&!! unset
18216 This option specifies the name of a file that contains the redirection data. It
18217 is mutually exclusive with the &%data%& option. The string is expanded before
18218 use; if the expansion is forced to fail, the router declines. Other expansion
18219 failures cause delivery to be deferred. The result of a successful expansion
18220 must be an absolute path. The entire file is read and used as the redirection
18221 data. If the data is an empty string or a string that has no effect (consists
18222 entirely of comments), the router declines.
18223
18224 .cindex "NFS" "checking for file existence"
18225 If the attempt to open the file fails with a &"does not exist"& error, Exim
18226 runs a check on the containing directory,
18227 unless &%ignore_enotdir%& is true (see below).
18228 If the directory does not appear to exist, delivery is deferred. This can
18229 happen when users' &_.forward_& files are in NFS-mounted directories, and there
18230 is a mount problem. If the containing directory does exist, but the file does
18231 not, the router declines.
18232
18233
18234 .option file_transport redirect string&!! unset
18235 .vindex "&$address_file$&"
18236 A &(redirect)& router sets up a direct delivery to a file when a path name not
18237 ending in a slash is specified as a new &"address"&. The transport used is
18238 specified by this option, which, after expansion, must be the name of a
18239 configured transport. This should normally be an &(appendfile)& transport. When
18240 it is running, the file name is in &$address_file$&.
18241
18242
18243 .option filter_prepend_home redirect boolean true
18244 When this option is true, if a &(save)& command in an Exim filter specifies a
18245 relative path, and &$home$& is defined, it is automatically prepended to the
18246 relative path. If this option is set false, this action does not happen. The
18247 relative path is then passed to the transport unmodified.
18248
18249
18250 .option forbid_blackhole redirect boolean false
18251 If this option is true, the &':blackhole:'& item may not appear in a
18252 redirection list.
18253
18254
18255 .option forbid_exim_filter redirect boolean false
18256 If this option is set true, only Sieve filters are permitted when
18257 &%allow_filter%& is true.
18258
18259
18260
18261
18262 .option forbid_file redirect boolean false
18263 .cindex "delivery" "to file; forbidding"
18264 .cindex "Sieve filter" "forbidding delivery to a file"
18265 .cindex "Sieve filter" "&""keep""& facility; disabling"
18266 If this option is true, this router may not generate a new address that
18267 specifies delivery to a local file or directory, either from a filter or from a
18268 conventional forward file. This option is forced to be true if &%one_time%& is
18269 set. It applies to Sieve filters as well as to Exim filters, but if true, it
18270 locks out the Sieve's &"keep"& facility.
18271
18272
18273 .option forbid_filter_dlfunc redirect boolean false
18274 .cindex "filter" "locking out certain features"
18275 If this option is true, string expansions in Exim filters are not allowed to
18276 make use of the &%dlfunc%& expansion facility to run dynamically loaded
18277 functions.
18278
18279 .option forbid_filter_existstest redirect boolean false
18280 .cindex "expansion" "statting a file"
18281 If this option is true, string expansions in Exim filters are not allowed to
18282 make use of the &%exists%& condition or the &%stat%& expansion item.
18283
18284 .option forbid_filter_logwrite redirect boolean false
18285 If this option is true, use of the logging facility in Exim filters is not
18286 permitted. Logging is in any case available only if the filter is being run
18287 under some unprivileged uid (which is normally the case for ordinary users'
18288 &_.forward_& files).
18289
18290
18291 .option forbid_filter_lookup redirect boolean false
18292 If this option is true, string expansions in Exim filter files are not allowed
18293 to make use of &%lookup%& items.
18294
18295
18296 .option forbid_filter_perl redirect boolean false
18297 This option has an effect only if Exim is built with embedded Perl support. If
18298 it is true, string expansions in Exim filter files are not allowed to make use
18299 of the embedded Perl support.
18300
18301
18302 .option forbid_filter_readfile redirect boolean false
18303 If this option is true, string expansions in Exim filter files are not allowed
18304 to make use of &%readfile%& items.
18305
18306
18307 .option forbid_filter_readsocket redirect boolean false
18308 If this option is true, string expansions in Exim filter files are not allowed
18309 to make use of &%readsocket%& items.
18310
18311
18312 .option forbid_filter_reply redirect boolean false
18313 If this option is true, this router may not generate an automatic reply
18314 message. Automatic replies can be generated only from Exim or Sieve filter
18315 files, not from traditional forward files. This option is forced to be true if
18316 &%one_time%& is set.
18317
18318
18319 .option forbid_filter_run redirect boolean false
18320 If this option is true, string expansions in Exim filter files are not allowed
18321 to make use of &%run%& items.
18322
18323
18324 .option forbid_include redirect boolean false
18325 If this option is true, items of the form
18326 .code
18327 :include:<path name>
18328 .endd
18329 are not permitted in non-filter redirection lists.
18330
18331
18332 .option forbid_pipe redirect boolean false
18333 .cindex "delivery" "to pipe; forbidding"
18334 If this option is true, this router may not generate a new address which
18335 specifies delivery to a pipe, either from an Exim filter or from a conventional
18336 forward file. This option is forced to be true if &%one_time%& is set.
18337
18338
18339 .option forbid_sieve_filter redirect boolean false
18340 If this option is set true, only Exim filters are permitted when
18341 &%allow_filter%& is true.
18342
18343
18344 .cindex "SMTP" "error codes"
18345 .option forbid_smtp_code redirect boolean false
18346 If this option is set true, any SMTP error codes that are present at the start
18347 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
18348 the default codes (451 and 550, respectively) are always used.
18349
18350
18351
18352
18353 .option hide_child_in_errmsg redirect boolean false
18354 .cindex "bounce message" "redirection details; suppressing"
18355 If this option is true, it prevents Exim from quoting a child address if it
18356 generates a bounce or delay message for it. Instead it says &"an address
18357 generated from <&'the top level address'&>"&. Of course, this applies only to
18358 bounces generated locally. If a message is forwarded to another host, &'its'&
18359 bounce may well quote the generated address.
18360
18361
18362 .option ignore_eacces redirect boolean false
18363 .cindex "EACCES"
18364 If this option is set and an attempt to open a redirection file yields the
18365 EACCES error (permission denied), the &(redirect)& router behaves as if the
18366 file did not exist.
18367
18368
18369 .option ignore_enotdir redirect boolean false
18370 .cindex "ENOTDIR"
18371 If this option is set and an attempt to open a redirection file yields the
18372 ENOTDIR error (something on the path is not a directory), the &(redirect)&
18373 router behaves as if the file did not exist.
18374
18375 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
18376 router that has the &%file%& option set discovers that the file does not exist
18377 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
18378 against unmounted NFS directories. If the parent can not be statted, delivery
18379 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
18380 is set, because that option tells Exim to ignore &"something on the path is not
18381 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
18382 that some operating systems give ENOENT where others give ENOTDIR.
18383
18384
18385
18386 .option include_directory redirect string unset
18387 If this option is set, the path names of any &':include:'& items in a
18388 redirection list must start with this directory.
18389
18390
18391 .option modemask redirect "octal integer" 022
18392 This specifies mode bits which must not be set for a file specified by the
18393 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
18394
18395
18396 .option one_time redirect boolean false
18397 .cindex "one-time aliasing/forwarding expansion"
18398 .cindex "alias file" "one-time expansion"
18399 .cindex "forward file" "one-time expansion"
18400 .cindex "mailing lists" "one-time expansion"
18401 .cindex "address redirection" "one-time expansion"
18402 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
18403 files each time it tries to deliver a message causes a problem when one or more
18404 of the generated addresses fails be delivered at the first attempt. The problem
18405 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
18406 but of what happens when the redirection list changes during the time that the
18407 message is on Exim's queue. This is particularly true in the case of mailing
18408 lists, where new subscribers might receive copies of messages that were posted
18409 before they subscribed.
18410
18411 If &%one_time%& is set and any addresses generated by the router fail to
18412 deliver at the first attempt, the failing addresses are added to the message as
18413 &"top level"& addresses, and the parent address that generated them is marked
18414 &"delivered"&. Thus, redirection does not happen again at the next delivery
18415 attempt.
18416
18417 &*Warning 1*&: Any header line addition or removal that is specified by this
18418 router would be lost if delivery did not succeed at the first attempt. For this
18419 reason, the &%headers_add%& and &%headers_remove%& generic options are not
18420 permitted when &%one_time%& is set.
18421
18422 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
18423 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
18424 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
18425
18426 &*Warning 3*&: The &%unseen%& generic router option may not be set with
18427 &%one_time%&.
18428
18429 The original top-level address is remembered with each of the generated
18430 addresses, and is output in any log messages. However, any intermediate parent
18431 addresses are not recorded. This makes a difference to the log only if
18432 &%all_parents%& log selector is set. It is expected that &%one_time%& will
18433 typically be used for mailing lists, where there is normally just one level of
18434 expansion.
18435
18436
18437 .option owners redirect "string list" unset
18438 .cindex "ownership" "alias file"
18439 .cindex "ownership" "forward file"
18440 .cindex "alias file" "ownership"
18441 .cindex "forward file" "ownership"
18442 This specifies a list of permitted owners for the file specified by &%file%&.
18443 This list is in addition to the local user when &%check_local_user%& is set.
18444 See &%check_owner%& above.
18445
18446
18447 .option owngroups redirect "string list" unset
18448 This specifies a list of permitted groups for the file specified by &%file%&.
18449 The list is in addition to the local user's primary group when
18450 &%check_local_user%& is set. See &%check_group%& above.
18451
18452
18453 .option pipe_transport redirect string&!! unset
18454 .vindex "&$address_pipe$&"
18455 A &(redirect)& router sets up a direct delivery to a pipe when a string
18456 starting with a vertical bar character is specified as a new &"address"&. The
18457 transport used is specified by this option, which, after expansion, must be the
18458 name of a configured transport. This should normally be a &(pipe)& transport.
18459 When the transport is run, the pipe command is in &$address_pipe$&.
18460
18461
18462 .option qualify_domain redirect string&!! unset
18463 .vindex "&$qualify_recipient$&"
18464 If this option is set, and an unqualified address (one without a domain) is
18465 generated, and that address would normally be qualified by the global setting
18466 in &%qualify_recipient%&, it is instead qualified with the domain specified by
18467 expanding this string. If the expansion fails, the router declines. If you want
18468 to revert to the default, you can have the expansion generate
18469 &$qualify_recipient$&.
18470
18471 This option applies to all unqualified addresses generated by Exim filters,
18472 but for traditional &_.forward_& files, it applies only to addresses that are
18473 not preceded by a backslash. Sieve filters cannot generate unqualified
18474 addresses.
18475
18476 .option qualify_preserve_domain redirect boolean false
18477 .cindex "domain" "in redirection; preserving"
18478 .cindex "preserving domain in redirection"
18479 .cindex "address redirection" "domain; preserving"
18480 If this option is set, the router's local &%qualify_domain%& option must not be
18481 set (a configuration error occurs if it is). If an unqualified address (one
18482 without a domain) is generated, it is qualified with the domain of the parent
18483 address (the immediately preceding ancestor) instead of the global
18484 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
18485 this applies whether or not the address is preceded by a backslash.
18486
18487
18488 .option repeat_use redirect boolean true
18489 If this option is set false, the router is skipped for a child address that has
18490 any ancestor that was routed by this router. This test happens before any of
18491 the other preconditions are tested. Exim's default anti-looping rules skip
18492 only when the ancestor is the same as the current address. See also
18493 &%check_ancestor%& above and the generic &%redirect_router%& option.
18494
18495
18496 .option reply_transport redirect string&!! unset
18497 A &(redirect)& router sets up an automatic reply when a &%mail%& or
18498 &%vacation%& command is used in a filter file. The transport used is specified
18499 by this option, which, after expansion, must be the name of a configured
18500 transport. This should normally be an &(autoreply)& transport. Other transports
18501 are unlikely to do anything sensible or useful.
18502
18503
18504 .option rewrite redirect boolean true
18505 .cindex "address redirection" "disabling rewriting"
18506 If this option is set false, addresses generated by the router are not
18507 subject to address rewriting. Otherwise, they are treated like new addresses
18508 and are rewritten according to the global rewriting rules.
18509
18510
18511 .option sieve_subaddress redirect string&!! unset
18512 The value of this option is passed to a Sieve filter to specify the
18513 :subaddress part of an address.
18514
18515 .option sieve_useraddress redirect string&!! unset
18516 The value of this option is passed to a Sieve filter to specify the :user part
18517 of an address. However, if it is unset, the entire original local part
18518 (including any prefix or suffix) is used for :user.
18519
18520
18521 .option sieve_vacation_directory redirect string&!! unset
18522 .cindex "Sieve filter" "vacation directory"
18523 To enable the &"vacation"& extension for Sieve filters, you must set
18524 &%sieve_vacation_directory%& to the directory where vacation databases are held
18525 (do not put anything else in that directory), and ensure that the
18526 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
18527 needs their own directory; Exim will create it if necessary.
18528
18529
18530
18531 .option skip_syntax_errors redirect boolean false
18532 .cindex "forward file" "broken"
18533 .cindex "address redirection" "broken files"
18534 .cindex "alias file" "broken"
18535 .cindex "broken alias or forward files"
18536 .cindex "ignoring faulty addresses"
18537 .cindex "skipping faulty addresses"
18538 .cindex "error" "skipping bad syntax"
18539 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
18540 non-filter redirection data are skipped, and each failing address is logged. If
18541 &%syntax_errors_to%& is set, a message is sent to the address it defines,
18542 giving details of the failures. If &%syntax_errors_text%& is set, its contents
18543 are expanded and placed at the head of the error message generated by
18544 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
18545 be the same address as the generic &%errors_to%& option. The
18546 &%skip_syntax_errors%& option is often used when handling mailing lists.
18547
18548 If all the addresses in a redirection list are skipped because of syntax
18549 errors, the router declines to handle the original address, and it is passed to
18550 the following routers.
18551
18552 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
18553 error in the filter causes filtering to be abandoned without any action being
18554 taken. The incident is logged, and the router declines to handle the address,
18555 so it is passed to the following routers.
18556
18557 .cindex "Sieve filter" "syntax errors in"
18558 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
18559 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
18560 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
18561
18562 &%skip_syntax_errors%& can be used to specify that errors in users' forward
18563 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
18564 option, used with an address that does not get redirected, can be used to
18565 notify users of these errors, by means of a router like this:
18566 .code
18567 userforward:
18568   driver = redirect
18569   allow_filter
18570   check_local_user
18571   file = $home/.forward
18572   file_transport = address_file
18573   pipe_transport = address_pipe
18574   reply_transport = address_reply
18575   no_verify
18576   skip_syntax_errors
18577   syntax_errors_to = real-$local_part@$domain
18578   syntax_errors_text = \
18579    This is an automatically generated message. An error has\n\
18580    been found in your .forward file. Details of the error are\n\
18581    reported below. While this error persists, you will receive\n\
18582    a copy of this message for every message that is addressed\n\
18583    to you. If your .forward file is a filter file, or if it is\n\
18584    a non-filter file containing no valid forwarding addresses,\n\
18585    a copy of each incoming message will be put in your normal\n\
18586    mailbox. If a non-filter file contains at least one valid\n\
18587    forwarding address, forwarding to the valid addresses will\n\
18588    happen, and those will be the only deliveries that occur.
18589 .endd
18590 You also need a router to ensure that local addresses that are prefixed by
18591 &`real-`& are recognized, but not forwarded or filtered. For example, you could
18592 put this immediately before the &(userforward)& router:
18593 .code
18594 real_localuser:
18595   driver = accept
18596   check_local_user
18597   local_part_prefix = real-
18598   transport = local_delivery
18599 .endd
18600 For security, it would probably be a good idea to restrict the use of this
18601 router to locally-generated messages, using a condition such as this:
18602 .code
18603   condition = ${if match {$sender_host_address}\
18604                          {\N^(|127\.0\.0\.1)$\N}}
18605 .endd
18606
18607
18608 .option syntax_errors_text redirect string&!! unset
18609 See &%skip_syntax_errors%& above.
18610
18611
18612 .option syntax_errors_to redirect string unset
18613 See &%skip_syntax_errors%& above.
18614 .ecindex IIDredrou1
18615 .ecindex IIDredrou2
18616
18617
18618
18619
18620
18621
18622 . ////////////////////////////////////////////////////////////////////////////
18623 . ////////////////////////////////////////////////////////////////////////////
18624
18625 .chapter "Environment for running local transports" "CHAPenvironment" &&&
18626          "Environment for local transports"
18627 .scindex IIDenvlotra1 "local transports" "environment for"
18628 .scindex IIDenvlotra2 "environment for local transports"
18629 .scindex IIDenvlotra3 "transport" "local; environment for"
18630 Local transports handle deliveries to files and pipes. (The &(autoreply)&
18631 transport can be thought of as similar to a pipe.) Exim always runs transports
18632 in subprocesses, under specified uids and gids. Typical deliveries to local
18633 mailboxes run under the uid and gid of the local user.
18634
18635 Exim also sets a specific current directory while running the transport; for
18636 some transports a home directory setting is also relevant. The &(pipe)&
18637 transport is the only one that sets up environment variables; see section
18638 &<<SECTpipeenv>>& for details.
18639
18640 The values used for the uid, gid, and the directories may come from several
18641 different places. In many cases, the router that handles the address associates
18642 settings with that address as a result of its &%check_local_user%&, &%group%&,
18643 or &%user%& options. However, values may also be given in the transport's own
18644 configuration, and these override anything that comes from the router.
18645
18646
18647
18648 .section "Concurrent deliveries" "SECID131"
18649 .cindex "concurrent deliveries"
18650 .cindex "simultaneous deliveries"
18651 If two different messages for the same local recipient arrive more or less
18652 simultaneously, the two delivery processes are likely to run concurrently. When
18653 the &(appendfile)& transport is used to write to a file, Exim applies locking
18654 rules to stop concurrent processes from writing to the same file at the same
18655 time.
18656
18657 However, when you use a &(pipe)& transport, it is up to you to arrange any
18658 locking that is needed. Here is a silly example:
18659 .code
18660 my_transport:
18661   driver = pipe
18662   command = /bin/sh -c 'cat >>/some/file'
18663 .endd
18664 This is supposed to write the message at the end of the file. However, if two
18665 messages arrive at the same time, the file will be scrambled. You can use the
18666 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
18667 file using the same algorithm that Exim itself uses.
18668
18669
18670
18671
18672 .section "Uids and gids" "SECTenvuidgid"
18673 .cindex "local transports" "uid and gid"
18674 .cindex "transport" "local; uid and gid"
18675 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
18676 overrides any group that the router set in the address, even if &%user%& is not
18677 set for the transport. This makes it possible, for example, to run local mail
18678 delivery under the uid of the recipient (set by the router), but in a special
18679 group (set by the transport). For example:
18680 .code
18681 # Routers ...
18682 # User/group are set by check_local_user in this router
18683 local_users:
18684   driver = accept
18685   check_local_user
18686   transport = group_delivery
18687
18688 # Transports ...
18689 # This transport overrides the group
18690 group_delivery:
18691   driver = appendfile
18692   file = /var/spool/mail/$local_part
18693   group = mail
18694 .endd
18695 If &%user%& is set for a transport, its value overrides what is set in the
18696 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
18697 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
18698 set.
18699
18700 .oindex "&%initgroups%&"
18701 When the uid is taken from the transport's configuration, the &[initgroups()]&
18702 function is called for the groups associated with that uid if the
18703 &%initgroups%& option is set for the transport. When the uid is not specified
18704 by the transport, but is associated with the address by a router, the option
18705 for calling &[initgroups()]& is taken from the router configuration.
18706
18707 .cindex "&(pipe)& transport" "uid for"
18708 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
18709 is set and &%user%& is not set, the uid of the process that called Exim to
18710 receive the message is used, and if &%group%& is not set, the corresponding
18711 original gid is also used.
18712
18713 This is the detailed preference order for obtaining a gid; the first of the
18714 following that is set is used:
18715
18716 .ilist
18717 A &%group%& setting of the transport;
18718 .next
18719 A &%group%& setting of the router;
18720 .next
18721 A gid associated with a user setting of the router, either as a result of
18722 &%check_local_user%& or an explicit non-numeric &%user%& setting;
18723 .next
18724 The group associated with a non-numeric &%user%& setting of the transport;
18725 .next
18726 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
18727 the uid is the creator's uid;
18728 .next
18729 The Exim gid if the Exim uid is being used as a default.
18730 .endlist
18731
18732 If, for example, the user is specified numerically on the router and there are
18733 no group settings, no gid is available. In this situation, an error occurs.
18734 This is different for the uid, for which there always is an ultimate default.
18735 The first of the following that is set is used:
18736
18737 .ilist
18738 A &%user%& setting of the transport;
18739 .next
18740 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
18741 .next
18742 A &%user%& setting of the router;
18743 .next
18744 A &%check_local_user%& setting of the router;
18745 .next
18746 The Exim uid.
18747 .endlist
18748
18749 Of course, an error will still occur if the uid that is chosen is on the
18750 &%never_users%& list.
18751
18752
18753
18754
18755
18756 .section "Current and home directories" "SECID132"
18757 .cindex "current directory for local transport"
18758 .cindex "home directory" "for local transport"
18759 .cindex "transport" "local; home directory for"
18760 .cindex "transport" "local; current directory for"
18761 Routers may set current and home directories for local transports by means of
18762 the &%transport_current_directory%& and &%transport_home_directory%& options.
18763 However, if the transport's &%current_directory%& or &%home_directory%& options
18764 are set, they override the router's values. In detail, the home directory
18765 for a local transport is taken from the first of these values that is set:
18766
18767 .ilist
18768 The &%home_directory%& option on the transport;
18769 .next
18770 The &%transport_home_directory%& option on the router;
18771 .next
18772 The password data if &%check_local_user%& is set on the router;
18773 .next
18774 The &%router_home_directory%& option on the router.
18775 .endlist
18776
18777 The current directory is taken from the first of these values that is set:
18778
18779 .ilist
18780 The &%current_directory%& option on the transport;
18781 .next
18782 The &%transport_current_directory%& option on the router.
18783 .endlist
18784
18785
18786 If neither the router nor the transport sets a current directory, Exim uses the
18787 value of the home directory, if it is set. Otherwise it sets the current
18788 directory to &_/_& before running a local transport.
18789
18790
18791
18792 .section "Expansion variables derived from the address" "SECID133"
18793 .vindex "&$domain$&"
18794 .vindex "&$local_part$&"
18795 .vindex "&$original_domain$&"
18796 Normally a local delivery is handling a single address, and in that case the
18797 variables such as &$domain$& and &$local_part$& are set during local
18798 deliveries. However, in some circumstances more than one address may be handled
18799 at once (for example, while writing batch SMTP for onward transmission by some
18800 other means). In this case, the variables associated with the local part are
18801 never set, &$domain$& is set only if all the addresses have the same domain,
18802 and &$original_domain$& is never set.
18803 .ecindex IIDenvlotra1
18804 .ecindex IIDenvlotra2
18805 .ecindex IIDenvlotra3
18806
18807
18808
18809
18810
18811
18812
18813 . ////////////////////////////////////////////////////////////////////////////
18814 . ////////////////////////////////////////////////////////////////////////////
18815
18816 .chapter "Generic options for transports" "CHAPtransportgeneric"
18817 .scindex IIDgenoptra1 "generic options" "transport"
18818 .scindex IIDgenoptra2 "options" "generic; for transports"
18819 .scindex IIDgenoptra3 "transport" "generic options for"
18820 The following generic options apply to all transports:
18821
18822
18823 .option body_only transports boolean false
18824 .cindex "transport" "body only"
18825 .cindex "message" "transporting body only"
18826 .cindex "body of message" "transporting"
18827 If this option is set, the message's headers are not transported. It is
18828 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
18829 or &(pipe)& transports, the settings of &%message_prefix%& and
18830 &%message_suffix%& should be checked, because this option does not
18831 automatically suppress them.
18832
18833
18834 .option current_directory transports string&!! unset
18835 .cindex "transport" "current directory for"
18836 This specifies the current directory that is to be set while running the
18837 transport, overriding any value that may have been set by the router.
18838 If the expansion fails for any reason, including forced failure, an error is
18839 logged, and delivery is deferred.
18840
18841
18842 .option disable_logging transports boolean false
18843 If this option is set true, nothing is logged for any
18844 deliveries by the transport or for any
18845 transport errors. You should not set this option unless you really, really know
18846 what you are doing.
18847
18848
18849 .option debug_print transports string&!! unset
18850 .cindex "testing" "variables in drivers"
18851 If this option is set and debugging is enabled (see the &%-d%& command line
18852 option), the string is expanded and included in the debugging output when the
18853 transport is run.
18854 If expansion of the string fails, the error message is written to the debugging
18855 output, and Exim carries on processing.
18856 This facility is provided to help with checking out the values of variables and
18857 so on when debugging driver configurations. For example, if a &%headers_add%&
18858 option is not working properly, &%debug_print%& could be used to output the
18859 variables it references. A newline is added to the text if it does not end with
18860 one.
18861
18862
18863 .option delivery_date_add transports boolean false
18864 .cindex "&'Delivery-date:'& header line"
18865 If this option is true, a &'Delivery-date:'& header is added to the message.
18866 This gives the actual time the delivery was made. As this is not a standard
18867 header, Exim has a configuration option (&%delivery_date_remove%&) which
18868 requests its removal from incoming messages, so that delivered messages can
18869 safely be resent to other recipients.
18870
18871
18872 .option driver transports string unset
18873 This specifies which of the available transport drivers is to be used.
18874 There is no default, and this option must be set for every transport.
18875
18876
18877 .option envelope_to_add transports boolean false
18878 .cindex "&'Envelope-to:'& header line"
18879 If this option is true, an &'Envelope-to:'& header is added to the message.
18880 This gives the original address(es) in the incoming envelope that caused this
18881 delivery to happen. More than one address may be present if the transport is
18882 configured to handle several addresses at once, or if more than one original
18883 address was redirected to the same final address. As this is not a standard
18884 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
18885 its removal from incoming messages, so that delivered messages can safely be
18886 resent to other recipients.
18887
18888
18889 .option group transports string&!! "Exim group"
18890 .cindex "transport" "group; specifying"
18891 This option specifies a gid for running the transport process, overriding any
18892 value that the router supplies, and also overriding any value associated with
18893 &%user%& (see below).
18894
18895
18896 .option headers_add transports string&!! unset
18897 .cindex "header lines" "adding in transport"
18898 .cindex "transport" "header lines; adding"
18899 This option specifies a string of text that is expanded and added to the header
18900 portion of a message as it is transported, as described in section
18901 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
18902 routers. If the result of the expansion is an empty string, or if the expansion
18903 is forced to fail, no action is taken. Other expansion failures are treated as
18904 errors and cause the delivery to be deferred.
18905
18906
18907
18908 .option headers_only transports boolean false
18909 .cindex "transport" "header lines only"
18910 .cindex "message" "transporting headers only"
18911 .cindex "header lines" "transporting"
18912 If this option is set, the message's body is not transported. It is mutually
18913 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
18914 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
18915 checked, since this option does not automatically suppress them.
18916
18917
18918 .option headers_remove transports string&!! unset
18919 .cindex "header lines" "removing"
18920 .cindex "transport" "header lines; removing"
18921 This option specifies a string that is expanded into a list of header names;
18922 these headers are omitted from the message as it is transported, as described
18923 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
18924 routers. If the result of the expansion is an empty string, or if the expansion
18925 is forced to fail, no action is taken. Other expansion failures are treated as
18926 errors and cause the delivery to be deferred.
18927
18928
18929
18930 .option headers_rewrite transports string unset
18931 .cindex "transport" "header lines; rewriting"
18932 .cindex "rewriting" "at transport time"
18933 This option allows addresses in header lines to be rewritten at transport time,
18934 that is, as the message is being copied to its destination. The contents of the
18935 option are a colon-separated list of rewriting rules. Each rule is in exactly
18936 the same form as one of the general rewriting rules that are applied when a
18937 message is received. These are described in chapter &<<CHAPrewrite>>&. For
18938 example,
18939 .code
18940 headers_rewrite = a@b c@d f : \
18941                   x@y w@z
18942 .endd
18943 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
18944 &'w@z'& in all address-bearing header lines. The rules are applied to the
18945 header lines just before they are written out at transport time, so they affect
18946 only those copies of the message that pass through the transport. However, only
18947 the message's original header lines, and any that were added by a system
18948 filter, are rewritten. If a router or transport adds header lines, they are not
18949 affected by this option. These rewriting rules are &'not'& applied to the
18950 envelope. You can change the return path using &%return_path%&, but you cannot
18951 change envelope recipients at this time.
18952
18953
18954 .option home_directory transports string&!! unset
18955 .cindex "transport" "home directory for"
18956 .vindex "&$home$&"
18957 This option specifies a home directory setting for a local transport,
18958 overriding any value that may be set by the router. The home directory is
18959 placed in &$home$& while expanding the transport's private options. It is also
18960 used as the current directory if no current directory is set by the
18961 &%current_directory%& option on the transport or the
18962 &%transport_current_directory%& option on the router. If the expansion fails
18963 for any reason, including forced failure, an error is logged, and delivery is
18964 deferred.
18965
18966
18967 .option initgroups transports boolean false
18968 .cindex "additional groups"
18969 .cindex "groups" "additional"
18970 .cindex "transport" "group; additional"
18971 If this option is true and the uid for the delivery process is provided by the
18972 transport, the &[initgroups()]& function is called when running the transport
18973 to ensure that any additional groups associated with the uid are set up.
18974
18975
18976 .option message_size_limit transports string&!! 0
18977 .cindex "limit" "message size per transport"
18978 .cindex "size" "of message, limit"
18979 .cindex "transport" "message size; limiting"
18980 This option controls the size of messages passed through the transport. It is
18981 expanded before use; the result of the expansion must be a sequence of decimal
18982 digits, optionally followed by K or M. If the expansion fails for any reason,
18983 including forced failure, or if the result is not of the required form,
18984 delivery is deferred. If the value is greater than zero and the size of a
18985 message exceeds this limit, the address is failed. If there is any chance that
18986 the resulting bounce message could be routed to the same transport, you should
18987 ensure that &%return_size_limit%& is less than the transport's
18988 &%message_size_limit%&, as otherwise the bounce message will fail to get
18989 delivered.
18990
18991
18992
18993 .option rcpt_include_affixes transports boolean false
18994 .cindex "prefix" "for local part, including in envelope"
18995 .cindex "suffix for local part" "including in envelope"
18996 .cindex "local part" "prefix"
18997 .cindex "local part" "suffix"
18998 When this option is false (the default), and an address that has had any
18999 affixes (prefixes or suffixes) removed from the local part is delivered by any
19000 form of SMTP or LMTP, the affixes are not included. For example, if a router
19001 that contains
19002 .code
19003 local_part_prefix = *-
19004 .endd
19005 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19006 is delivered with
19007 .code
19008 RCPT TO:<xyz@some.domain>
19009 .endd
19010 This is also the case when an ACL-time callout is being used to verify a
19011 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19012 whole local part is included in the RCPT command. This option applies to BSMTP
19013 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19014 &(lmtp)& and &(smtp)& transports.
19015
19016
19017 .option retry_use_local_part transports boolean "see below"
19018 .cindex "hints database" "retry keys"
19019 When a delivery suffers a temporary failure, a retry record is created
19020 in Exim's hints database. For remote deliveries, the key for the retry record
19021 is based on the name and/or IP address of the failing remote host. For local
19022 deliveries, the key is normally the entire address, including both the local
19023 part and the domain. This is suitable for most common cases of local delivery
19024 temporary failure &-- for example, exceeding a mailbox quota should delay only
19025 deliveries to that mailbox, not to the whole domain.
19026
19027 However, in some special cases you may want to treat a temporary local delivery
19028 as a failure associated with the domain, and not with a particular local part.
19029 (For example, if you are storing all mail for some domain in files.) You can do
19030 this by setting &%retry_use_local_part%& false.
19031
19032 For all the local transports, its default value is true. For remote transports,
19033 the default value is false for tidiness, but changing the value has no effect
19034 on a remote transport in the current implementation.
19035
19036
19037 .option return_path transports string&!! unset
19038 .cindex "envelope sender"
19039 .cindex "transport" "return path; changing"
19040 .cindex "return path" "changing in transport"
19041 If this option is set, the string is expanded at transport time and replaces
19042 the existing return path (envelope sender) value in the copy of the message
19043 that is being delivered. An empty return path is permitted. This feature is
19044 designed for remote deliveries, where the value of this option is used in the
19045 SMTP MAIL command. If you set &%return_path%& for a local transport, the
19046 only effect is to change the address that is placed in the &'Return-path:'&
19047 header line, if one is added to the message (see the next option).
19048
19049 &*Note:*& A changed return path is not logged unless you add
19050 &%return_path_on_delivery%& to the log selector.
19051
19052 .vindex "&$return_path$&"
19053 The expansion can refer to the existing value via &$return_path$&. This is
19054 either the message's envelope sender, or an address set by the
19055 &%errors_to%& option on a router. If the expansion is forced to fail, no
19056 replacement occurs; if it fails for another reason, delivery is deferred. This
19057 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19058 section &<<SECTverp>>&.
19059
19060 &*Note*&: If a delivery error is detected locally, including the case when a
19061 remote server rejects a message at SMTP time, the bounce message is not sent to
19062 the value of this option. It is sent to the previously set errors address.
19063 This defaults to the incoming sender address, but can be changed by setting
19064 &%errors_to%& in a router.
19065
19066
19067
19068 .option return_path_add transports boolean false
19069 .cindex "&'Return-path:'& header line"
19070 If this option is true, a &'Return-path:'& header is added to the message.
19071 Although the return path is normally available in the prefix line of BSD
19072 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19073 have easy access to it.
19074
19075 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19076 the delivery SMTP server makes the final delivery"&. This implies that this
19077 header should not be present in incoming messages. Exim has a configuration
19078 option, &%return_path_remove%&, which requests removal of this header from
19079 incoming messages, so that delivered messages can safely be resent to other
19080 recipients.
19081
19082
19083 .option shadow_condition transports string&!! unset
19084 See &%shadow_transport%& below.
19085
19086
19087 .option shadow_transport transports string unset
19088 .cindex "shadow transport"
19089 .cindex "transport" "shadow"
19090 A local transport may set the &%shadow_transport%& option to the name of
19091 another local transport. Shadow remote transports are not supported.
19092
19093 Whenever a delivery to the main transport succeeds, and either
19094 &%shadow_condition%& is unset, or its expansion does not result in the empty
19095 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
19096 passed to the shadow transport, with the same delivery address or addresses. If
19097 expansion fails, no action is taken except that non-forced expansion failures
19098 cause a log line to be written.
19099
19100 The result of the shadow transport is discarded and does not affect the
19101 subsequent processing of the message. Only a single level of shadowing is
19102 provided; the &%shadow_transport%& option is ignored on any transport when it
19103 is running as a shadow. Options concerned with output from pipes are also
19104 ignored. The log line for the successful delivery has an item added on the end,
19105 of the form
19106 .code
19107 ST=<shadow transport name>
19108 .endd
19109 If the shadow transport did not succeed, the error message is put in
19110 parentheses afterwards. Shadow transports can be used for a number of different
19111 purposes, including keeping more detailed log information than Exim normally
19112 provides, and implementing automatic acknowledgment policies based on message
19113 headers that some sites insist on.
19114
19115
19116 .option transport_filter transports string&!! unset
19117 .cindex "transport" "filter"
19118 .cindex "filter" "transport filter"
19119 This option sets up a filtering (in the Unix shell sense) process for messages
19120 at transport time. It should not be confused with mail filtering as set up by
19121 individual users or via a system filter.
19122
19123 When the message is about to be written out, the command specified by
19124 &%transport_filter%& is started up in a separate, parallel process, and
19125 the entire message, including the header lines, is passed to it on its standard
19126 input (this in fact is done from a third process, to avoid deadlock). The
19127 command must be specified as an absolute path.
19128
19129 The lines of the message that are written to the transport filter are
19130 terminated by newline (&"\n"&). The message is passed to the filter before any
19131 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
19132 lines beginning with a dot, and also before any processing implied by the
19133 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
19134 &(pipe)& transports.
19135
19136 The standard error for the filter process is set to the same destination as its
19137 standard output; this is read and written to the message's ultimate
19138 destination. The process that writes the message to the filter, the
19139 filter itself, and the original process that reads the result and delivers it
19140 are all run in parallel, like a shell pipeline.
19141
19142 The filter can perform any transformations it likes, but of course should take
19143 care not to break RFC 2822 syntax. Exim does not check the result, except to
19144 test for a final newline when SMTP is in use. All messages transmitted over
19145 SMTP must end with a newline, so Exim supplies one if it is missing.
19146
19147 .cindex "content scanning" "per user"
19148 A transport filter can be used to provide content-scanning on a per-user basis
19149 at delivery time if the only required effect of the scan is to modify the
19150 message. For example, a content scan could insert a new header line containing
19151 a spam score. This could be interpreted by a filter in the user's MUA. It is
19152 not possible to discard a message at this stage.
19153
19154 .cindex "SMTP" "SIZE"
19155 A problem might arise if the filter increases the size of a message that is
19156 being sent down an SMTP connection. If the receiving SMTP server has indicated
19157 support for the SIZE parameter, Exim will have sent the size of the message
19158 at the start of the SMTP session. If what is actually sent is substantially
19159 more, the server might reject the message. This can be worked round by setting
19160 the &%size_addition%& option on the &(smtp)& transport, either to allow for
19161 additions to the message, or to disable the use of SIZE altogether.
19162
19163 .vindex "&$pipe_addresses$&"
19164 The value of the &%transport_filter%& option is the command string for starting
19165 the filter, which is run directly from Exim, not under a shell. The string is
19166 parsed by Exim in the same way as a command string for the &(pipe)& transport:
19167 Exim breaks it up into arguments and then expands each argument separately (see
19168 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
19169 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
19170 of arguments, one for each address that applies to this delivery. (This isn't
19171 an ideal name for this feature here, but as it was already implemented for the
19172 &(pipe)& transport, it seemed sensible not to change it.)
19173
19174 .vindex "&$host$&"
19175 .vindex "&$host_address$&"
19176 The expansion variables &$host$& and &$host_address$& are available when the
19177 transport is a remote one. They contain the name and IP address of the host to
19178 which the message is being sent. For example:
19179 .code
19180 transport_filter = /some/directory/transport-filter.pl \
19181   $host $host_address $sender_address $pipe_addresses
19182 .endd
19183
19184 Two problems arise if you want to use more complicated expansion items to
19185 generate transport filter commands, both of which due to the fact that the
19186 command is split up &'before'& expansion.
19187 .ilist
19188 If an expansion item contains white space, you must quote it, so that it is all
19189 part of the same command item. If the entire option setting is one such
19190 expansion item, you have to take care what kind of quoting you use. For
19191 example:
19192 .code
19193 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
19194 .endd
19195 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
19196 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
19197 stripped by Exim when it read the option's value. When the value is used, if
19198 the single quotes were missing, the line would be split into two items,
19199 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
19200 Exim tried to expand the first one.
19201 .next
19202 Except for the special case of &$pipe_addresses$& that is mentioned above, an
19203 expansion cannot generate multiple arguments, or a command name followed by
19204 arguments. Consider this example:
19205 .code
19206 transport_filter = ${lookup{$host}lsearch{/a/file}\
19207                     {$value}{/bin/cat}}
19208 .endd
19209 The result of the lookup is interpreted as the name of the command, even
19210 if it contains white space. The simplest way round this is to use a shell:
19211 .code
19212 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
19213                                {$value}{/bin/cat}}
19214 .endd
19215 .endlist
19216
19217 The filter process is run under the same uid and gid as the normal delivery.
19218 For remote deliveries this is the Exim uid/gid by default. The command should
19219 normally yield a zero return code. Transport filters are not supposed to fail.
19220 A non-zero code is taken to mean that the transport filter encountered some
19221 serious problem. Delivery of the message is deferred; the message remains on
19222 the queue and is tried again later. It is not possible to cause a message to be
19223 bounced from a transport filter.
19224
19225 If a transport filter is set on an autoreply transport, the original message is
19226 passed through the filter as it is being copied into the newly generated
19227 message, which happens if the &%return_message%& option is set.
19228
19229
19230 .option transport_filter_timeout transports time 5m
19231 .cindex "transport" "filter, timeout"
19232 When Exim is reading the output of a transport filter, it a applies a timeout
19233 that can be set by this option. Exceeding the timeout is normally treated as a
19234 temporary delivery failure. However, if a transport filter is used with a
19235 &(pipe)& transport, a timeout in the transport filter is treated in the same
19236 way as a timeout in the pipe command itself. By default, a timeout is a hard
19237 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
19238 becomes a temporary error.
19239
19240
19241 .option user transports string&!! "Exim user"
19242 .cindex "uid (user id)" "local delivery"
19243 .cindex "transport" "user, specifying"
19244 This option specifies the user under whose uid the delivery process is to be
19245 run, overriding any uid that may have been set by the router. If the user is
19246 given as a name, the uid is looked up from the password data, and the
19247 associated group is taken as the value of the gid to be used if the &%group%&
19248 option is not set.
19249
19250 For deliveries that use local transports, a user and group are normally
19251 specified explicitly or implicitly (for example, as a result of
19252 &%check_local_user%&) by the router or transport.
19253
19254 .cindex "hints database" "access by remote transport"
19255 For remote transports, you should leave this option unset unless you really are
19256 sure you know what you are doing. When a remote transport is running, it needs
19257 to be able to access Exim's hints databases, because each host may have its own
19258 retry data.
19259 .ecindex IIDgenoptra1
19260 .ecindex IIDgenoptra2
19261 .ecindex IIDgenoptra3
19262
19263
19264
19265
19266
19267
19268 . ////////////////////////////////////////////////////////////////////////////
19269 . ////////////////////////////////////////////////////////////////////////////
19270
19271 .chapter "Address batching in local transports" "CHAPbatching" &&&
19272          "Address batching"
19273 .cindex "transport" "local; address batching in"
19274 The only remote transport (&(smtp)&) is normally configured to handle more than
19275 one address at a time, so that when several addresses are routed to the same
19276 remote host, just one copy of the message is sent. Local transports, however,
19277 normally handle one address at a time. That is, a separate instance of the
19278 transport is run for each address that is routed to the transport. A separate
19279 copy of the message is delivered each time.
19280
19281 .cindex "batched local delivery"
19282 .oindex "&%batch_max%&"
19283 .oindex "&%batch_id%&"
19284 In special cases, it may be desirable to handle several addresses at once in a
19285 local transport, for example:
19286
19287 .ilist
19288 In an &(appendfile)& transport, when storing messages in files for later
19289 delivery by some other means, a single copy of the message with multiple
19290 recipients saves space.
19291 .next
19292 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
19293 a single copy saves time, and is the normal way LMTP is expected to work.
19294 .next
19295 In a &(pipe)& transport, when passing the message
19296 to a scanner program or
19297 to some other delivery mechanism such as UUCP, multiple recipients may be
19298 acceptable.
19299 .endlist
19300
19301 These three local transports all have the same options for controlling multiple
19302 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
19303 repeating the information for each transport, these options are described here.
19304
19305 The &%batch_max%& option specifies the maximum number of addresses that can be
19306 delivered together in a single run of the transport. Its default value is one
19307 (no batching). When more than one address is routed to a transport that has a
19308 &%batch_max%& value greater than one, the addresses are delivered in a batch
19309 (that is, in a single run of the transport with multiple recipients), subject
19310 to certain conditions:
19311
19312 .ilist
19313 .vindex "&$local_part$&"
19314 If any of the transport's options contain a reference to &$local_part$&, no
19315 batching is possible.
19316 .next
19317 .vindex "&$domain$&"
19318 If any of the transport's options contain a reference to &$domain$&, only
19319 addresses with the same domain are batched.
19320 .next
19321 .cindex "customizing" "batching condition"
19322 If &%batch_id%& is set, it is expanded for each address, and only those
19323 addresses with the same expanded value are batched. This allows you to specify
19324 customized batching conditions. Failure of the expansion for any reason,
19325 including forced failure, disables batching, but it does not stop the delivery
19326 from taking place.
19327 .next
19328 Batched addresses must also have the same errors address (where to send
19329 delivery errors), the same header additions and removals, the same user and
19330 group for the transport, and if a host list is present, the first host must
19331 be the same.
19332 .endlist
19333
19334 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
19335 both when the file or pipe command is specified in the transport, and when it
19336 is specified by a &(redirect)& router, but all the batched addresses must of
19337 course be routed to the same file or pipe command. These two transports have an
19338 option called &%use_bsmtp%&, which causes them to deliver the message in
19339 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
19340 &%check_string%& and &%escape_string%& options are forced to the values
19341 .code
19342 check_string = "."
19343 escape_string = ".."
19344 .endd
19345 when batched SMTP is in use. A full description of the batch SMTP mechanism is
19346 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
19347 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
19348
19349 .cindex "&'Envelope-to:'& header line"
19350 If the generic &%envelope_to_add%& option is set for a batching transport, the
19351 &'Envelope-to:'& header that is added to the message contains all the addresses
19352 that are being processed together. If you are using a batching &(appendfile)&
19353 transport without &%use_bsmtp%&, the only way to preserve the recipient
19354 addresses is to set the &%envelope_to_add%& option.
19355
19356 .cindex "&(pipe)& transport" "with multiple addresses"
19357 .vindex "&$pipe_addresses$&"
19358 If you are using a &(pipe)& transport without BSMTP, and setting the
19359 transport's &%command%& option, you can include &$pipe_addresses$& as part of
19360 the command. This is not a true variable; it is a bit of magic that causes each
19361 of the recipient addresses to be inserted into the command as a separate
19362 argument. This provides a way of accessing all the addresses that are being
19363 delivered in the batch. &*Note:*& This is not possible for pipe commands that
19364 are specified by a &(redirect)& router.
19365
19366
19367
19368
19369 . ////////////////////////////////////////////////////////////////////////////
19370 . ////////////////////////////////////////////////////////////////////////////
19371
19372 .chapter "The appendfile transport" "CHAPappendfile"
19373 .scindex IIDapptra1 "&(appendfile)& transport"
19374 .scindex IIDapptra2 "transports" "&(appendfile)&"
19375 .cindex "directory creation"
19376 .cindex "creating directories"
19377 The &(appendfile)& transport delivers a message by appending it to an existing
19378 file, or by creating an entirely new file in a specified directory. Single
19379 files to which messages are appended can be in the traditional Unix mailbox
19380 format, or optionally in the MBX format supported by the Pine MUA and
19381 University of Washington IMAP daemon, &'inter alia'&. When each message is
19382 being delivered as a separate file, &"maildir"& format can optionally be used
19383 to give added protection against failures that happen part-way through the
19384 delivery. A third form of separate-file delivery known as &"mailstore"& is also
19385 supported. For all file formats, Exim attempts to create as many levels of
19386 directory as necessary, provided that &%create_directory%& is set.
19387
19388 The code for the optional formats is not included in the Exim binary by
19389 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
19390 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
19391 included.
19392
19393 .cindex "quota" "system"
19394 Exim recognizes system quota errors, and generates an appropriate message. Exim
19395 also supports its own quota control within the transport, for use when the
19396 system facility is unavailable or cannot be used for some reason.
19397
19398 If there is an error while appending to a file (for example, quota exceeded or
19399 partition filled), Exim attempts to reset the file's length and last
19400 modification time back to what they were before. If there is an error while
19401 creating an entirely new file, the new file is removed.
19402
19403 Before appending to a file, a number of security checks are made, and the
19404 file is locked. A detailed description is given below, after the list of
19405 private options.
19406
19407 The &(appendfile)& transport is most commonly used for local deliveries to
19408 users' mailboxes. However, it can also be used as a pseudo-remote transport for
19409 putting messages into files for remote delivery by some means other than Exim.
19410 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
19411 option).
19412
19413
19414
19415 .section "The file and directory options" "SECTfildiropt"
19416 The &%file%& option specifies a single file, to which the message is appended;
19417 the &%directory%& option specifies a directory, in which a new file containing
19418 the message is created. Only one of these two options can be set, and for
19419 normal deliveries to mailboxes, one of them &'must'& be set.
19420
19421 .vindex "&$address_file$&"
19422 .vindex "&$local_part$&"
19423 However, &(appendfile)& is also used for delivering messages to files or
19424 directories whose names (or parts of names) are obtained from alias,
19425 forwarding, or filtering operations (for example, a &%save%& command in a
19426 user's Exim filter). When such a transport is running, &$local_part$& contains
19427 the local part that was aliased or forwarded, and &$address_file$& contains the
19428 name (or partial name) of the file or directory generated by the redirection
19429 operation. There are two cases:
19430
19431 .ilist
19432 If neither &%file%& nor &%directory%& is set, the redirection operation
19433 must specify an absolute path (one that begins with &`/`&). This is the most
19434 common case when users with local accounts use filtering to sort mail into
19435 different folders. See for example, the &(address_file)& transport in the
19436 default configuration. If the path ends with a slash, it is assumed to be the
19437 name of a directory. A delivery to a directory can also be forced by setting
19438 &%maildir_format%& or &%mailstore_format%&.
19439 .next
19440 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
19441 used to determine the file or directory name for the delivery. Normally, the
19442 contents of &$address_file$& are used in some way in the string expansion.
19443 .endlist
19444
19445
19446 .cindex "Sieve filter" "configuring &(appendfile)&"
19447 .cindex "Sieve filter" "relative mailbox path handling"
19448 As an example of the second case, consider an environment where users do not
19449 have home directories. They may be permitted to use Exim filter commands of the
19450 form:
19451 .code
19452 save folder23
19453 .endd
19454 or Sieve filter commands of the form:
19455 .code
19456 require "fileinto";
19457 fileinto "folder23";
19458 .endd
19459 In this situation, the expansion of &%file%& or &%directory%& in the transport
19460 must transform the relative path into an appropriate absolute file name. In the
19461 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
19462 is used as a result of a &"keep"& action in the filter. This example shows one
19463 way of handling this requirement:
19464 .code
19465 file = ${if eq{$address_file}{inbox} \
19466             {/var/mail/$local_part} \
19467             {${if eq{${substr_0_1:$address_file}}{/} \
19468                   {$address_file} \
19469                   {$home/mail/$address_file} \
19470             }} \
19471        }
19472 .endd
19473 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
19474 location, absolute paths are used without change, and other folders are in the
19475 &_mail_& directory within the home directory.
19476
19477 &*Note 1*&: While processing an Exim filter, a relative path such as
19478 &_folder23_& is turned into an absolute path if a home directory is known to
19479 the router. In particular, this is the case if &%check_local_user%& is set. If
19480 you want to prevent this happening at routing time, you can set
19481 &%router_home_directory%& empty. This forces the router to pass the relative
19482 path to the transport.
19483
19484 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
19485 the &%file%& or &%directory%& option is still used if it is set.
19486
19487
19488
19489
19490 .section "Private options for appendfile" "SECID134"
19491 .cindex "options" "&(appendfile)& transport"
19492
19493
19494
19495 .option allow_fifo appendfile boolean false
19496 .cindex "fifo (named pipe)"
19497 .cindex "named pipe (fifo)"
19498 .cindex "pipe" "named (fifo)"
19499 Setting this option permits delivery to named pipes (FIFOs) as well as to
19500 regular files. If no process is reading the named pipe at delivery time, the
19501 delivery is deferred.
19502
19503
19504 .option allow_symlink appendfile boolean false
19505 .cindex "symbolic link" "to mailbox"
19506 .cindex "mailbox" "symbolic link"
19507 By default, &(appendfile)& will not deliver if the path name for the file is
19508 that of a symbolic link. Setting this option relaxes that constraint, but there
19509 are security issues involved in the use of symbolic links. Be sure you know
19510 what you are doing if you set this. Details of exactly what this option affects
19511 are included in the discussion which follows this list of options.
19512
19513
19514 .option batch_id appendfile string&!! unset
19515 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19516 However, batching is automatically disabled for &(appendfile)& deliveries that
19517 happen as a result of forwarding or aliasing or other redirection directly to a
19518 file.
19519
19520
19521 .option batch_max appendfile integer 1
19522 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19523
19524
19525 .option check_group appendfile boolean false
19526 When this option is set, the group owner of the file defined by the &%file%&
19527 option is checked to see that it is the same as the group under which the
19528 delivery process is running. The default setting is false because the default
19529 file mode is 0600, which means that the group is irrelevant.
19530
19531
19532 .option check_owner appendfile boolean true
19533 When this option is set, the owner of the file defined by the &%file%& option
19534 is checked to ensure that it is the same as the user under which the delivery
19535 process is running.
19536
19537
19538 .option check_string appendfile string "see below"
19539 .cindex "&""From""& line"
19540 As &(appendfile)& writes the message, the start of each line is tested for
19541 matching &%check_string%&, and if it does, the initial matching characters are
19542 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
19543 a literal string, not a regular expression, and the case of any letters it
19544 contains is significant.
19545
19546 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
19547 are forced to &"."& and &".."& respectively, and any settings in the
19548 configuration are ignored. Otherwise, they default to &"From&~"& and
19549 &">From&~"& when the &%file%& option is set, and unset when any of the
19550 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
19551
19552 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
19553 suitable for traditional &"BSD"& mailboxes, where a line beginning with
19554 &"From&~"& indicates the start of a new message. All four options need changing
19555 if another format is used. For example, to deliver to mailboxes in MMDF format:
19556 .cindex "MMDF format mailbox"
19557 .cindex "mailbox" "MMDF format"
19558 .code
19559 check_string = "\1\1\1\1\n"
19560 escape_string = "\1\1\1\1 \n"
19561 message_prefix = "\1\1\1\1\n"
19562 message_suffix = "\1\1\1\1\n"
19563 .endd
19564 .option create_directory appendfile boolean true
19565 .cindex "directory creation"
19566 When this option is true, Exim attempts to create any missing superior
19567 directories for the file that it is about to write. A created directory's mode
19568 is given by the &%directory_mode%& option.
19569
19570 The group ownership of a newly created directory is highly dependent on the
19571 operating system (and possibly the file system) that is being used. For
19572 example, in Solaris, if the parent directory has the setgid bit set, its group
19573 is propagated to the child; if not, the currently set group is used. However,
19574 in FreeBSD, the parent's group is always used.
19575
19576
19577
19578 .option create_file appendfile string anywhere
19579 This option constrains the location of files and directories that are created
19580 by this transport. It applies to files defined by the &%file%& option and
19581 directories defined by the &%directory%& option. In the case of maildir
19582 delivery, it applies to the top level directory, not the maildir directories
19583 beneath.
19584
19585 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
19586 &"belowhome"&. In the second and third cases, a home directory must have been
19587 set for the transport. This option is not useful when an explicit file name is
19588 given for normal mailbox deliveries. It is intended for the case when file
19589 names are generated from users' &_.forward_& files. These are usually handled
19590 by an &(appendfile)& transport called &%address_file%&. See also
19591 &%file_must_exist%&.
19592
19593
19594 .option directory appendfile string&!! unset
19595 This option is mutually exclusive with the &%file%& option, but one of &%file%&
19596 or &%directory%& must be set, unless the delivery is the direct result of a
19597 redirection (see section &<<SECTfildiropt>>&).
19598
19599 When &%directory%& is set, the string is expanded, and the message is delivered
19600 into a new file or files in or below the given directory, instead of being
19601 appended to a single mailbox file. A number of different formats are provided
19602 (see &%maildir_format%& and &%mailstore_format%&), and see section
19603 &<<SECTopdir>>& for further details of this form of delivery.
19604
19605
19606 .option directory_file appendfile string&!! "see below"
19607 .cindex "base62"
19608 .vindex "&$inode$&"
19609 When &%directory%& is set, but neither &%maildir_format%& nor
19610 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
19611 whose name is obtained by expanding this string. The default value is:
19612 .code
19613 q${base62:$tod_epoch}-$inode
19614 .endd
19615 This generates a unique name from the current time, in base 62 form, and the
19616 inode of the file. The variable &$inode$& is available only when expanding this
19617 option.
19618
19619
19620 .option directory_mode appendfile "octal integer" 0700
19621 If &(appendfile)& creates any directories as a result of the
19622 &%create_directory%& option, their mode is specified by this option.
19623
19624
19625 .option escape_string appendfile string "see description"
19626 See &%check_string%& above.
19627
19628
19629 .option file appendfile string&!! unset
19630 This option is mutually exclusive with the &%directory%& option, but one of
19631 &%file%& or &%directory%& must be set, unless the delivery is the direct result
19632 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
19633 specifies a single file, to which the message is appended. One or more of
19634 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
19635 &%file%&.
19636
19637 .cindex "NFS" "lock file"
19638 .cindex "locking files"
19639 .cindex "lock files"
19640 If you are using more than one host to deliver over NFS into the same
19641 mailboxes, you should always use lock files.
19642
19643 The string value is expanded for each delivery, and must yield an absolute
19644 path. The most common settings of this option are variations on one of these
19645 examples:
19646 .code
19647 file = /var/spool/mail/$local_part
19648 file = /home/$local_part/inbox
19649 file = $home/inbox
19650 .endd
19651 .cindex "&""sticky""& bit"
19652 In the first example, all deliveries are done into the same directory. If Exim
19653 is configured to use lock files (see &%use_lockfile%& below) it must be able to
19654 create a file in the directory, so the &"sticky"& bit must be turned on for
19655 deliveries to be possible, or alternatively the &%group%& option can be used to
19656 run the delivery under a group id which has write access to the directory.
19657
19658
19659
19660 .option file_format appendfile string unset
19661 .cindex "file" "mailbox; checking existing format"
19662 This option requests the transport to check the format of an existing file
19663 before adding to it. The check consists of matching a specific string at the
19664 start of the file. The value of the option consists of an even number of
19665 colon-separated strings. The first of each pair is the test string, and the
19666 second is the name of a transport. If the transport associated with a matched
19667 string is not the current transport, control is passed over to the other
19668 transport. For example, suppose the standard &(local_delivery)& transport has
19669 this added to it:
19670 .code
19671 file_format = "From       : local_delivery :\
19672                \1\1\1\1\n : local_mmdf_delivery"
19673 .endd
19674 Mailboxes that begin with &"From"& are still handled by this transport, but if
19675 a mailbox begins with four binary ones followed by a newline, control is passed
19676 to a transport called &%local_mmdf_delivery%&, which presumably is configured
19677 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
19678 is assumed to match the current transport. If the start of a mailbox doesn't
19679 match any string, or if the transport named for a given string is not defined,
19680 delivery is deferred.
19681
19682
19683 .option file_must_exist appendfile boolean false
19684 If this option is true, the file specified by the &%file%& option must exist.
19685 A temporary error occurs if it does not, causing delivery to be deferred.
19686 If this option is false, the file is created if it does not exist.
19687
19688
19689 .option lock_fcntl_timeout appendfile time 0s
19690 .cindex "timeout" "mailbox locking"
19691 .cindex "mailbox" "locking, blocking and non-blocking"
19692 .cindex "locking files"
19693 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
19694 when locking an open mailbox file. If the call fails, the delivery process
19695 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
19696 Non-blocking calls are used so that the file is not kept open during the wait
19697 for the lock; the reason for this is to make it as safe as possible for
19698 deliveries over NFS in the case when processes might be accessing an NFS
19699 mailbox without using a lock file. This should not be done, but
19700 misunderstandings and hence misconfigurations are not unknown.
19701
19702 On a busy system, however, the performance of a non-blocking lock approach is
19703 not as good as using a blocking lock with a timeout. In this case, the waiting
19704 is done inside the system call, and Exim's delivery process acquires the lock
19705 and can proceed as soon as the previous lock holder releases it.
19706
19707 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
19708 timeout, are used. There may still be some retrying: the maximum number of
19709 retries is
19710 .code
19711 (lock_retries * lock_interval) / lock_fcntl_timeout
19712 .endd
19713 rounded up to the next whole number. In other words, the total time during
19714 which &(appendfile)& is trying to get a lock is roughly the same, unless
19715 &%lock_fcntl_timeout%& is set very large.
19716
19717 You should consider setting this option if you are getting a lot of delayed
19718 local deliveries because of errors of the form
19719 .code
19720 failed to lock mailbox /some/file (fcntl)
19721 .endd
19722
19723 .option lock_flock_timeout appendfile time 0s
19724 This timeout applies to file locking when using &[flock()]& (see
19725 &%use_flock%&); the timeout operates in a similar manner to
19726 &%lock_fcntl_timeout%&.
19727
19728
19729 .option lock_interval appendfile time 3s
19730 This specifies the time to wait between attempts to lock the file. See below
19731 for details of locking.
19732
19733
19734 .option lock_retries appendfile integer 10
19735 This specifies the maximum number of attempts to lock the file. A value of zero
19736 is treated as 1. See below for details of locking.
19737
19738
19739 .option lockfile_mode appendfile "octal integer" 0600
19740 This specifies the mode of the created lock file, when a lock file is being
19741 used (see &%use_lockfile%& and &%use_mbx_lock%&).
19742
19743
19744 .option lockfile_timeout appendfile time 30m
19745 .cindex "timeout" "mailbox locking"
19746 When a lock file is being used (see &%use_lockfile%&), if a lock file already
19747 exists and is older than this value, it is assumed to have been left behind by
19748 accident, and Exim attempts to remove it.
19749
19750
19751 .option mailbox_filecount appendfile string&!! unset
19752 .cindex "mailbox" "specifying size of"
19753 .cindex "size" "of mailbox"
19754 If this option is set, it is expanded, and the result is taken as the current
19755 number of files in the mailbox. It must be a decimal number, optionally
19756 followed by K or M. This provides a way of obtaining this information from an
19757 external source that maintains the data.
19758
19759
19760 .option mailbox_size appendfile string&!! unset
19761 .cindex "mailbox" "specifying size of"
19762 .cindex "size" "of mailbox"
19763 If this option is set, it is expanded, and the result is taken as the current
19764 size the mailbox. It must be a decimal number, optionally followed by K or M.
19765 This provides a way of obtaining this information from an external source that
19766 maintains the data. This is likely to be helpful for maildir deliveries where
19767 it is computationally expensive to compute the size of a mailbox.
19768
19769
19770
19771 .option maildir_format appendfile boolean false
19772 .cindex "maildir format" "specifying"
19773 If this option is set with the &%directory%& option, the delivery is into a new
19774 file, in the &"maildir"& format that is used by other mail software. When the
19775 transport is activated directly from a &(redirect)& router (for example, the
19776 &(address_file)& transport in the default configuration), setting
19777 &%maildir_format%& causes the path received from the router to be treated as a
19778 directory, whether or not it ends with &`/`&. This option is available only if
19779 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
19780 &<<SECTmaildirdelivery>>& below for further details.
19781
19782
19783 .option maildir_quota_directory_regex appendfile string "See below"
19784 .cindex "maildir format" "quota; directories included in"
19785 .cindex "quota" "maildir; directories included in"
19786 This option is relevant only when &%maildir_use_size_file%& is set. It defines
19787 a regular expression for specifying directories, relative to the quota
19788 directory (see &%quota_directory%&), that should be included in the quota
19789 calculation. The default value is:
19790 .code
19791 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
19792 .endd
19793 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
19794 (directories whose names begin with a dot). If you want to exclude the
19795 &_Trash_&
19796 folder from the count (as some sites do), you need to change this setting to
19797 .code
19798 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
19799 .endd
19800 This uses a negative lookahead in the regular expression to exclude the
19801 directory whose name is &_.Trash_&. When a directory is excluded from quota
19802 calculations, quota processing is bypassed for any messages that are delivered
19803 directly into that directory.
19804
19805
19806 .option maildir_retries appendfile integer 10
19807 This option specifies the number of times to retry when writing a file in
19808 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
19809
19810
19811 .option maildir_tag appendfile string&!! unset
19812 This option applies only to deliveries in maildir format, and is described in
19813 section &<<SECTmaildirdelivery>>& below.
19814
19815
19816 .option maildir_use_size_file appendfile boolean false
19817 .cindex "maildir format" "&_maildirsize_& file"
19818 Setting this option true enables support for &_maildirsize_& files. Exim
19819 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
19820 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
19821 value is zero. See &%maildir_quota_directory_regex%& above and section
19822 &<<SECTmaildirdelivery>>& below for further details.
19823
19824 .option maildirfolder_create_regex appendfile string unset
19825 .cindex "maildir format" "&_maildirfolder_& file"
19826 .cindex "&_maildirfolder_&, creating"
19827 The value of this option is a regular expression. If it is unset, it has no
19828 effect. Otherwise, before a maildir delivery takes place, the pattern is
19829 matched against the name of the maildir directory, that is, the directory
19830 containing the &_new_& and &_tmp_& subdirectories that will be used for the
19831 delivery. If there is a match, Exim checks for the existence of a file called
19832 &_maildirfolder_& in the directory, and creates it if it does not exist.
19833 See section &<<SECTmaildirdelivery>>& for more details.
19834
19835
19836 .option mailstore_format appendfile boolean false
19837 .cindex "mailstore format" "specifying"
19838 If this option is set with the &%directory%& option, the delivery is into two
19839 new files in  &"mailstore"& format. The option is available only if
19840 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
19841 below for further details.
19842
19843
19844 .option mailstore_prefix appendfile string&!! unset
19845 This option applies only to deliveries in mailstore format, and is described in
19846 section &<<SECTopdir>>& below.
19847
19848
19849 .option mailstore_suffix appendfile string&!! unset
19850 This option applies only to deliveries in mailstore format, and is described in
19851 section &<<SECTopdir>>& below.
19852
19853
19854 .option mbx_format appendfile boolean false
19855 .cindex "locking files"
19856 .cindex "file" "locking"
19857 .cindex "file" "MBX format"
19858 .cindex "MBX format, specifying"
19859 This option is available only if Exim has been compiled with SUPPORT_MBX
19860 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
19861 the message is appended to the mailbox file in MBX format instead of
19862 traditional Unix format. This format is supported by Pine4 and its associated
19863 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
19864
19865 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
19866 automatically changed by the use of &%mbx_format%&. They should normally be set
19867 empty when using MBX format, so this option almost always appears in this
19868 combination:
19869 .code
19870 mbx_format = true
19871 message_prefix =
19872 message_suffix =
19873 .endd
19874 If none of the locking options are mentioned in the configuration,
19875 &%use_mbx_lock%& is assumed and the other locking options default to false. It
19876 is possible to specify the other kinds of locking with &%mbx_format%&, but
19877 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
19878 interworks with &'c-client'&, providing for shared access to the mailbox. It
19879 should not be used if any program that does not use this form of locking is
19880 going to access the mailbox, nor should it be used if the mailbox file is NFS
19881 mounted, because it works only when the mailbox is accessed from a single host.
19882
19883 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
19884 the standard version of &'c-client'&, because as long as it has a mailbox open
19885 (this means for the whole of a Pine or IMAP session), Exim will not be able to
19886 append messages to it.
19887
19888
19889 .option message_prefix appendfile string&!! "see below"
19890 .cindex "&""From""& line"
19891 The string specified here is expanded and output at the start of every message.
19892 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
19893 in which case it is:
19894 .code
19895 message_prefix = "From ${if def:return_path{$return_path}\
19896   {MAILER-DAEMON}} $tod_bsdinbox\n"
19897 .endd
19898 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
19899 &`\n`& to &`\r\n`& in &%message_prefix%&.
19900
19901 .option message_suffix appendfile string&!! "see below"
19902 The string specified here is expanded and output at the end of every message.
19903 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
19904 in which case it is a single newline character. The suffix can be suppressed by
19905 setting
19906 .code
19907 message_suffix =
19908 .endd
19909 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
19910 &`\n`& to &`\r\n`& in &%message_suffix%&.
19911
19912 .option mode appendfile "octal integer" 0600
19913 If the output file is created, it is given this mode. If it already exists and
19914 has wider permissions, they are reduced to this mode. If it has narrower
19915 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
19916 if the delivery is the result of a &%save%& command in a filter file specifying
19917 a particular mode, the mode of the output file is always forced to take that
19918 value, and this option is ignored.
19919
19920
19921 .option mode_fail_narrower appendfile boolean true
19922 This option applies in the case when an existing mailbox file has a narrower
19923 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
19924 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
19925 continues with the delivery attempt, using the existing mode of the file.
19926
19927
19928 .option notify_comsat appendfile boolean false
19929 If this option is true, the &'comsat'& daemon is notified after every
19930 successful delivery to a user mailbox. This is the daemon that notifies logged
19931 on users about incoming mail.
19932
19933
19934 .option quota appendfile string&!! unset
19935 .cindex "quota" "imposed by Exim"
19936 This option imposes a limit on the size of the file to which Exim is appending,
19937 or to the total space used in the directory tree when the &%directory%& option
19938 is set. In the latter case, computation of the space used is expensive, because
19939 all the files in the directory (and any sub-directories) have to be
19940 individually inspected and their sizes summed. (See &%quota_size_regex%& and
19941 &%maildir_use_size_file%& for ways to avoid this in environments where users
19942 have no shell access to their mailboxes).
19943
19944 As there is no interlock against two simultaneous deliveries into a
19945 multi-file mailbox, it is possible for the quota to be overrun in this case.
19946 For single-file mailboxes, of course, an interlock is a necessity.
19947
19948 A file's size is taken as its &'used'& value. Because of blocking effects, this
19949 may be a lot less than the actual amount of disk space allocated to the file.
19950 If the sizes of a number of files are being added up, the rounding effect can
19951 become quite noticeable, especially on systems that have large block sizes.
19952 Nevertheless, it seems best to stick to the &'used'& figure, because this is
19953 the obvious value which users understand most easily.
19954
19955 The value of the option is expanded, and must then be a numerical value
19956 (decimal point allowed), optionally followed by one of the letters K, M, or G,
19957 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
19958 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
19959 be handled.
19960
19961 &*Note*&: A value of zero is interpreted as &"no quota"&.
19962
19963 The expansion happens while Exim is running as root, before it changes uid for
19964 the delivery. This means that files that are inaccessible to the end user can
19965 be used to hold quota values that are looked up in the expansion. When delivery
19966 fails because this quota is exceeded, the handling of the error is as for
19967 system quota failures.
19968
19969 By default, Exim's quota checking mimics system quotas, and restricts the
19970 mailbox to the specified maximum size, though the value is not accurate to the
19971 last byte, owing to separator lines and additional headers that may get added
19972 during message delivery. When a mailbox is nearly full, large messages may get
19973 refused even though small ones are accepted, because the size of the current
19974 message is added to the quota when the check is made. This behaviour can be
19975 changed by setting &%quota_is_inclusive%& false. When this is done, the check
19976 for exceeding the quota does not include the current message. Thus, deliveries
19977 continue until the quota has been exceeded; thereafter, no further messages are
19978 delivered. See also &%quota_warn_threshold%&.
19979
19980
19981 .option quota_directory appendfile string&!! unset
19982 This option defines the directory to check for quota purposes when delivering
19983 into individual files. The default is the delivery directory, or, if a file
19984 called &_maildirfolder_& exists in a maildir directory, the parent of the
19985 delivery directory.
19986
19987
19988 .option quota_filecount appendfile string&!! 0
19989 This option applies when the &%directory%& option is set. It limits the total
19990 number of files in the directory (compare the inode limit in system quotas). It
19991 can only be used if &%quota%& is also set. The value is expanded; an expansion
19992 failure causes delivery to be deferred. A value of zero is interpreted as
19993 &"no quota"&.
19994
19995
19996 .option quota_is_inclusive appendfile boolean true
19997 See &%quota%& above.
19998
19999
20000 .option quota_size_regex appendfile string unset
20001 This option applies when one of the delivery modes that writes a separate file
20002 for each message is being used. When Exim wants to find the size of one of
20003 these files in order to test the quota, it first checks &%quota_size_regex%&.
20004 If this is set to a regular expression that matches the file name, and it
20005 captures one string, that string is interpreted as a representation of the
20006 file's size. The value of &%quota_size_regex%& is not expanded.
20007
20008 This feature is useful only when users have no shell access to their mailboxes
20009 &-- otherwise they could defeat the quota simply by renaming the files. This
20010 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20011 the file length to the file name. For example:
20012 .code
20013 maildir_tag = ,S=$message_size
20014 quota_size_regex = ,S=(\d+)
20015 .endd
20016 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20017 number of lines in the message.
20018
20019 The regular expression should not assume that the length is at the end of the
20020 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20021 sometimes add other information onto the ends of message file names.
20022
20023
20024
20025 .option quota_warn_message appendfile string&!! "see below"
20026 See below for the use of this option. If it is not set when
20027 &%quota_warn_threshold%& is set, it defaults to
20028 .code
20029 quota_warn_message = "\
20030   To: $local_part@$domain\n\
20031   Subject: Your mailbox\n\n\
20032   This message is automatically created \
20033   by mail delivery software.\n\n\
20034   The size of your mailbox has exceeded \
20035   a warning threshold that is\n\
20036   set by the system administrator.\n"
20037 .endd
20038
20039
20040 .option quota_warn_threshold appendfile string&!! 0
20041 .cindex "quota" "warning threshold"
20042 .cindex "mailbox" "size warning"
20043 .cindex "size" "of mailbox"
20044 This option is expanded in the same way as &%quota%& (see above). If the
20045 resulting value is greater than zero, and delivery of the message causes the
20046 size of the file or total space in the directory tree to cross the given
20047 threshold, a warning message is sent. If &%quota%& is also set, the threshold
20048 may be specified as a percentage of it by following the value with a percent
20049 sign. For example:
20050 .code
20051 quota = 10M
20052 quota_warn_threshold = 75%
20053 .endd
20054 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20055 percent sign is ignored.
20056
20057 The warning message itself is specified by the &%quota_warn_message%& option,
20058 and it must start with a &'To:'& header line containing the recipient(s) of the
20059 warning message. These do not necessarily have to include the recipient(s) of
20060 the original message. A &'Subject:'& line should also normally be supplied. You
20061 can include any other header lines that you want. If you do not include a
20062 &'From:'& line, the default is:
20063 .code
20064 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20065 .endd
20066 .oindex &%errors_reply_to%&
20067 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20068 option.
20069
20070 The &%quota%& option does not have to be set in order to use this option; they
20071 are independent of one another except when the threshold is specified as a
20072 percentage.
20073
20074
20075 .option use_bsmtp appendfile boolean false
20076 .cindex "envelope sender"
20077 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20078 format, with the envelope sender and recipient(s) included as SMTP commands. If
20079 you want to include a leading HELO command with such messages, you can do
20080 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20081 for details of batch SMTP.
20082
20083
20084 .option use_crlf appendfile boolean false
20085 .cindex "carriage return"
20086 .cindex "linefeed"
20087 This option causes lines to be terminated with the two-character CRLF sequence
20088 (carriage return, linefeed) instead of just a linefeed character. In the case
20089 of batched SMTP, the byte sequence written to the file is then an exact image
20090 of what would be sent down a real SMTP connection.
20091
20092 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
20093 (which are used to supply the traditional &"From&~"& and blank line separators
20094 in Berkeley-style mailboxes) are written verbatim, so must contain their own
20095 carriage return characters if these are needed. In cases where these options
20096 have non-empty defaults, the values end with a single linefeed, so they must be
20097 changed to end with &`\r\n`& if &%use_crlf%& is set.
20098
20099
20100 .option use_fcntl_lock appendfile boolean "see below"
20101 This option controls the use of the &[fcntl()]& function to lock a file for
20102 exclusive use when a message is being appended. It is set by default unless
20103 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
20104 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
20105 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
20106
20107
20108 .option use_flock_lock appendfile boolean false
20109 This option is provided to support the use of &[flock()]& for file locking, for
20110 the few situations where it is needed. Most modern operating systems support
20111 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
20112 each other. Exim uses &[fcntl()]& locking by default.
20113
20114 This option is required only if you are using an operating system where
20115 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
20116 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
20117 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
20118
20119 .cindex "Solaris" "&[flock()]& support"
20120 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
20121 have it (and some, I think, provide a not quite right version built on top of
20122 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
20123 the ability to use it, and any attempt to do so will cause a configuration
20124 error.
20125
20126 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
20127 is just being mapped onto &[fcntl()]& by the OS).
20128
20129
20130 .option use_lockfile appendfile boolean "see below"
20131 If this option is turned off, Exim does not attempt to create a lock file when
20132 appending to a mailbox file. In this situation, the only locking is by
20133 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
20134 sure that every MUA that is ever going to look at your users' mailboxes uses
20135 &[fcntl()]& rather than a lock file, and even then only when you are not
20136 delivering over NFS from more than one host.
20137
20138 .cindex "NFS" "lock file"
20139 In order to append to an NFS file safely from more than one host, it is
20140 necessary to take out a lock &'before'& opening the file, and the lock file
20141 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
20142 file corruption.
20143
20144 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
20145 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
20146 except when &%mbx_format%& is set.
20147
20148
20149 .option use_mbx_lock appendfile boolean "see below"
20150 This option is available only if Exim has been compiled with SUPPORT_MBX
20151 set in &_Local/Makefile_&. Setting the option specifies that special MBX
20152 locking rules be used. It is set by default if &%mbx_format%& is set and none
20153 of the locking options are mentioned in the configuration. The locking rules
20154 are the same as are used by the &'c-client'& library that underlies Pine and
20155 the IMAP4 and POP daemons that come with it (see the discussion below). The
20156 rules allow for shared access to the mailbox. However, this kind of locking
20157 does not work when the mailbox is NFS mounted.
20158
20159 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
20160 &%use_flock_lock%& to control what kind of locking is used in implementing the
20161 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
20162 without &%use_fcntl_lock%& or &%use_flock_lock%&.
20163
20164
20165
20166
20167 .section "Operational details for appending" "SECTopappend"
20168 .cindex "appending to a file"
20169 .cindex "file" "appending"
20170 Before appending to a file, the following preparations are made:
20171
20172 .ilist
20173 If the name of the file is &_/dev/null_&, no action is taken, and a success
20174 return is given.
20175
20176 .next
20177 .cindex "directory creation"
20178 If any directories on the file's path are missing, Exim creates them if the
20179 &%create_directory%& option is set. A created directory's mode is given by the
20180 &%directory_mode%& option.
20181
20182 .next
20183 If &%file_format%& is set, the format of an existing file is checked. If this
20184 indicates that a different transport should be used, control is passed to that
20185 transport.
20186
20187 .next
20188 .cindex "file" "locking"
20189 .cindex "locking files"
20190 .cindex "NFS" "lock file"
20191 If &%use_lockfile%& is set, a lock file is built in a way that will work
20192 reliably over NFS, as follows:
20193
20194 .olist
20195 Create a &"hitching post"& file whose name is that of the lock file with the
20196 current time, primary host name, and process id added, by opening for writing
20197 as a new file. If this fails with an access error, delivery is deferred.
20198 .next
20199 Close the hitching post file, and hard link it to the lock file name.
20200 .next
20201 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
20202 Unlink the hitching post name.
20203 .next
20204 Otherwise, use &[stat()]& to get information about the hitching post file, and
20205 then unlink hitching post name. If the number of links is exactly two, creation
20206 of the lock file succeeded but something (for example, an NFS server crash and
20207 restart) caused this fact not to be communicated to the &[link()]& call.
20208 .next
20209 If creation of the lock file failed, wait for &%lock_interval%& and try again,
20210 up to &%lock_retries%& times. However, since any program that writes to a
20211 mailbox should complete its task very quickly, it is reasonable to time out old
20212 lock files that are normally the result of user agent and system crashes. If an
20213 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
20214 it before trying again.
20215 .endlist olist
20216
20217 .next
20218 A call is made to &[lstat()]& to discover whether the main file exists, and if
20219 so, what its characteristics are. If &[lstat()]& fails for any reason other
20220 than non-existence, delivery is deferred.
20221
20222 .next
20223 .cindex "symbolic link" "to mailbox"
20224 .cindex "mailbox" "symbolic link"
20225 If the file does exist and is a symbolic link, delivery is deferred, unless the
20226 &%allow_symlink%& option is set, in which case the ownership of the link is
20227 checked, and then &[stat()]& is called to find out about the real file, which
20228 is then subjected to the checks below. The check on the top-level link
20229 ownership prevents one user creating a link for another's mailbox in a sticky
20230 directory, though allowing symbolic links in this case is definitely not a good
20231 idea. If there is a chain of symbolic links, the intermediate ones are not
20232 checked.
20233
20234 .next
20235 If the file already exists but is not a regular file, or if the file's owner
20236 and group (if the group is being checked &-- see &%check_group%& above) are
20237 different from the user and group under which the delivery is running,
20238 delivery is deferred.
20239
20240 .next
20241 If the file's permissions are more generous than specified, they are reduced.
20242 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
20243 is set false, in which case the delivery is tried using the existing
20244 permissions.
20245
20246 .next
20247 The file's inode number is saved, and the file is then opened for appending.
20248 If this fails because the file has vanished, &(appendfile)& behaves as if it
20249 hadn't existed (see below). For any other failures, delivery is deferred.
20250
20251 .next
20252 If the file is opened successfully, check that the inode number hasn't
20253 changed, that it is still a regular file, and that the owner and permissions
20254 have not changed. If anything is wrong, defer delivery and freeze the message.
20255
20256 .next
20257 If the file did not exist originally, defer delivery if the &%file_must_exist%&
20258 option is set. Otherwise, check that the file is being created in a permitted
20259 directory if the &%create_file%& option is set (deferring on failure), and then
20260 open for writing as a new file, with the O_EXCL and O_CREAT options,
20261 except when dealing with a symbolic link (the &%allow_symlink%& option must be
20262 set). In this case, which can happen if the link points to a non-existent file,
20263 the file is opened for writing using O_CREAT but not O_EXCL, because
20264 that prevents link following.
20265
20266 .next
20267 .cindex "loop" "while file testing"
20268 If opening fails because the file exists, obey the tests given above for
20269 existing files. However, to avoid looping in a situation where the file is
20270 being continuously created and destroyed, the exists/not-exists loop is broken
20271 after 10 repetitions, and the message is then frozen.
20272
20273 .next
20274 If opening fails with any other error, defer delivery.
20275
20276 .next
20277 .cindex "file" "locking"
20278 .cindex "locking files"
20279 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
20280 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
20281 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
20282 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
20283 file, and an exclusive lock on the file whose name is
20284 .code
20285 /tmp/.<device-number>.<inode-number>
20286 .endd
20287 using the device and inode numbers of the open mailbox file, in accordance with
20288 the MBX locking rules. This file is created with a mode that is specified by
20289 the &%lockfile_mode%& option.
20290
20291 If Exim fails to lock the file, there are two possible courses of action,
20292 depending on the value of the locking timeout. This is obtained from
20293 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
20294
20295 If the timeout value is zero, the file is closed, Exim waits for
20296 &%lock_interval%&, and then goes back and re-opens the file as above and tries
20297 to lock it again. This happens up to &%lock_retries%& times, after which the
20298 delivery is deferred.
20299
20300 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
20301 &[flock()]& are used (with the given timeout), so there has already been some
20302 waiting involved by the time locking fails. Nevertheless, Exim does not give up
20303 immediately. It retries up to
20304 .code
20305 (lock_retries * lock_interval) / <timeout>
20306 .endd
20307 times (rounded up).
20308 .endlist
20309
20310 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
20311 and/or &[flock()]& locks) and then deletes the lock file if one was created.
20312
20313
20314 .section "Operational details for delivery to a new file" "SECTopdir"
20315 .cindex "delivery" "to single file"
20316 .cindex "&""From""& line"
20317 When the &%directory%& option is set instead of &%file%&, each message is
20318 delivered into a newly-created file or set of files. When &(appendfile)& is
20319 activated directly from a &(redirect)& router, neither &%file%& nor
20320 &%directory%& is normally set, because the path for delivery is supplied by the
20321 router. (See for example, the &(address_file)& transport in the default
20322 configuration.) In this case, delivery is to a new file if either the path name
20323 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
20324
20325 No locking is required while writing the message to a new file, so the various
20326 locking options of the transport are ignored. The &"From"& line that by default
20327 separates messages in a single file is not normally needed, nor is the escaping
20328 of message lines that start with &"From"&, and there is no need to ensure a
20329 newline at the end of each message. Consequently, the default values for
20330 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
20331 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
20332
20333 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
20334 the files in the delivery directory by default. However, you can specify a
20335 different directory by setting &%quota_directory%&. Also, for maildir
20336 deliveries (see below) the &_maildirfolder_& convention is honoured.
20337
20338
20339 .cindex "maildir format"
20340 .cindex "mailstore format"
20341 There are three different ways in which delivery to individual files can be
20342 done, controlled by the settings of the &%maildir_format%& and
20343 &%mailstore_format%& options. Note that code to support maildir or mailstore
20344 formats is not included in the binary unless SUPPORT_MAILDIR or
20345 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
20346
20347 .cindex "directory creation"
20348 In all three cases an attempt is made to create the directory and any necessary
20349 sub-directories if they do not exist, provided that the &%create_directory%&
20350 option is set (the default). The location of a created directory can be
20351 constrained by setting &%create_file%&. A created directory's mode is given by
20352 the &%directory_mode%& option. If creation fails, or if the
20353 &%create_directory%& option is not set when creation is required, delivery is
20354 deferred.
20355
20356
20357
20358 .section "Maildir delivery" "SECTmaildirdelivery"
20359 .cindex "maildir format" "description of"
20360 If the &%maildir_format%& option is true, Exim delivers each message by writing
20361 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
20362 directory that is defined by the &%directory%& option (the &"delivery
20363 directory"&). If the delivery is successful, the file is renamed into the
20364 &_new_& subdirectory.
20365
20366 In the file name, <&'stime'&> is the current time of day in seconds, and
20367 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
20368 Exim checks that the time-of-day clock has moved on by at least one microsecond
20369 before terminating the delivery process. This guarantees uniqueness for the
20370 file name. However, as a precaution, Exim calls &[stat()]& for the file before
20371 opening it. If any response other than ENOENT (does not exist) is given,
20372 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
20373
20374 Before Exim carries out a maildir delivery, it ensures that subdirectories
20375 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
20376 do not exist, Exim tries to create them and any superior directories in their
20377 path, subject to the &%create_directory%& and &%create_file%& options. If the
20378 &%maildirfolder_create_regex%& option is set, and the regular expression it
20379 contains matches the delivery directory, Exim also ensures that a file called
20380 &_maildirfolder_& exists in the delivery directory. If a missing directory or
20381 &_maildirfolder_& file cannot be created, delivery is deferred.
20382
20383 These features make it possible to use Exim to create all the necessary files
20384 and directories in a maildir mailbox, including subdirectories for maildir++
20385 folders. Consider this example:
20386 .code
20387 maildir_format = true
20388 directory = /var/mail/$local_part\
20389            ${if eq{$local_part_suffix}{}{}\
20390            {/.${substr_1:$local_part_suffix}}}
20391 maildirfolder_create_regex = /\.[^/]+$
20392 .endd
20393 If &$local_part_suffix$& is empty (there was no suffix for the local part),
20394 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
20395 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
20396 not match this name, so Exim will not look for or create the file
20397 &_/var/mail/pimbo/maildirfolder_&, though it will create
20398 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
20399
20400 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
20401 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
20402 does match &%maildirfolder_create_regex%&. In this case, Exim will create
20403 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
20404 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
20405
20406 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
20407 not inadvertently match the toplevel maildir directory, because a
20408 &_maildirfolder_& file at top level would completely break quota calculations.
20409
20410 .cindex "quota" "in maildir delivery"
20411 .cindex "maildir++"
20412 If Exim is required to check a &%quota%& setting before a maildir delivery, and
20413 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
20414 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
20415 Exim assumes the directory is a maildir++ folder directory, which is one level
20416 down from the user's top level mailbox directory. This causes it to start at
20417 the parent directory instead of the current directory when calculating the
20418 amount of space used.
20419
20420 One problem with delivering into a multi-file mailbox is that it is
20421 computationally expensive to compute the size of the mailbox for quota
20422 checking. Various approaches have been taken to reduce the amount of work
20423 needed. The next two sections describe two of them. A third alternative is to
20424 use some external process for maintaining the size data, and use the expansion
20425 of the &%mailbox_size%& option as a way of importing it into Exim.
20426
20427
20428
20429
20430 .section "Using tags to record message sizes" "SECID135"
20431 If &%maildir_tag%& is set, the string is expanded for each delivery.
20432 When the maildir file is renamed into the &_new_& sub-directory, the
20433 tag is added to its name. However, if adding the tag takes the length of the
20434 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
20435 the tag is dropped and the maildir file is created with no tag.
20436
20437 .vindex "&$message_size$&"
20438 Tags can be used to encode the size of files in their names; see
20439 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
20440 happens after the message has been written. The value of the &$message_size$&
20441 variable is set to the number of bytes actually written. If the expansion is
20442 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
20443 be deferred. The expanded tag may contain any printing characters except &"/"&.
20444 Non-printing characters in the string are ignored; if the resulting string is
20445 empty, it is ignored. If it starts with an alphanumeric character, a leading
20446 colon is inserted.
20447
20448
20449
20450 .section "Using a maildirsize file" "SECID136"
20451 .cindex "quota" "in maildir delivery"
20452 .cindex "maildir format" "&_maildirsize_& file"
20453 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
20454 storing quota and message size information in a file called &_maildirsize_&
20455 within the toplevel maildir directory. If this file does not exist, Exim
20456 creates it, setting the quota from the &%quota%& option of the transport. If
20457 the maildir directory itself does not exist, it is created before any attempt
20458 to write a &_maildirsize_& file.
20459
20460 The &_maildirsize_& file is used to hold information about the sizes of
20461 messages in the maildir, thus speeding up quota calculations. The quota value
20462 in the file is just a cache; if the quota is changed in the transport, the new
20463 value overrides the cached value when the next message is delivered. The cache
20464 is maintained for the benefit of other programs that access the maildir and
20465 need to know the quota.
20466
20467 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
20468 file is maintained (with a zero quota setting), but no quota is imposed.
20469
20470 A regular expression is available for controlling which directories in the
20471 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
20472 See the description of the &%maildir_quota_directory_regex%& option above for
20473 details.
20474
20475
20476 .section "Mailstore delivery" "SECID137"
20477 .cindex "mailstore format" "description of"
20478 If the &%mailstore_format%& option is true, each message is written as two
20479 files in the given directory. A unique base name is constructed from the
20480 message id and the current delivery process, and the files that are written use
20481 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
20482 contains the message's envelope, and the &_.msg_& file contains the message
20483 itself. The base name is placed in the variable &$mailstore_basename$&.
20484
20485 During delivery, the envelope is first written to a file with the suffix
20486 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
20487 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
20488 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
20489 file before accessing either of them. An alternative approach is to wait for
20490 the absence of a &_.tmp_& file.
20491
20492 The envelope file starts with any text defined by the &%mailstore_prefix%&
20493 option, expanded and terminated by a newline if there isn't one. Then follows
20494 the sender address on one line, then all the recipient addresses, one per line.
20495 There can be more than one recipient only if the &%batch_max%& option is set
20496 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
20497 appended to the file, followed by a newline if it does not end with one.
20498
20499 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
20500 failure, it is ignored. Other expansion errors are treated as serious
20501 configuration errors, and delivery is deferred. The variable
20502 &$mailstore_basename$& is available for use during these expansions.
20503
20504
20505 .section "Non-special new file delivery" "SECID138"
20506 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
20507 file is created directly in the named directory. For example, when delivering
20508 messages into files in batched SMTP format for later delivery to some host (see
20509 section &<<SECTbatchSMTP>>&), a setting such as
20510 .code
20511 directory = /var/bsmtp/$host
20512 .endd
20513 might be used. A message is written to a file with a temporary name, which is
20514 then renamed when the delivery is complete. The final name is obtained by
20515 expanding the contents of the &%directory_file%& option.
20516 .ecindex IIDapptra1
20517 .ecindex IIDapptra2
20518
20519
20520
20521
20522
20523
20524 . ////////////////////////////////////////////////////////////////////////////
20525 . ////////////////////////////////////////////////////////////////////////////
20526
20527 .chapter "The autoreply transport" "CHID8"
20528 .scindex IIDauttra1 "transports" "&(autoreply)&"
20529 .scindex IIDauttra2 "&(autoreply)& transport"
20530 The &(autoreply)& transport is not a true transport in that it does not cause
20531 the message to be transmitted. Instead, it generates a new mail message as an
20532 automatic reply to the incoming message. &'References:'& and
20533 &'Auto-Submitted:'& header lines are included. These are constructed according
20534 to the rules in RFCs 2822 and 3834, respectively.
20535
20536 If the router that passes the message to this transport does not have the
20537 &%unseen%& option set, the original message (for the current recipient) is not
20538 delivered anywhere. However, when the &%unseen%& option is set on the router
20539 that passes the message to this transport, routing of the address continues, so
20540 another router can set up a normal message delivery.
20541
20542
20543 The &(autoreply)& transport is usually run as the result of mail filtering, a
20544 &"vacation"& message being the standard example. However, it can also be run
20545 directly from a router like any other transport. To reduce the possibility of
20546 message cascades, messages created by the &(autoreply)& transport always have
20547 empty envelope sender addresses, like bounce messages.
20548
20549 The parameters of the message to be sent can be specified in the configuration
20550 by options described below. However, these are used only when the address
20551 passed to the transport does not contain its own reply information. When the
20552 transport is run as a consequence of a
20553 &%mail%&
20554 or &%vacation%& command in a filter file, the parameters of the message are
20555 supplied by the filter, and passed with the address. The transport's options
20556 that define the message are then ignored (so they are not usually set in this
20557 case). The message is specified entirely by the filter or by the transport; it
20558 is never built from a mixture of options. However, the &%file_optional%&,
20559 &%mode%&, and &%return_message%& options apply in all cases.
20560
20561 &(Autoreply)& is implemented as a local transport. When used as a result of a
20562 command in a user's filter file, &(autoreply)& normally runs under the uid and
20563 gid of the user, and with appropriate current and home directories (see chapter
20564 &<<CHAPenvironment>>&).
20565
20566 There is a subtle difference between routing a message to a &(pipe)& transport
20567 that generates some text to be returned to the sender, and routing it to an
20568 &(autoreply)& transport. This difference is noticeable only if more than one
20569 address from the same message is so handled. In the case of a pipe, the
20570 separate outputs from the different addresses are gathered up and returned to
20571 the sender in a single message, whereas if &(autoreply)& is used, a separate
20572 message is generated for each address that is passed to it.
20573
20574 Non-printing characters are not permitted in the header lines generated for the
20575 message that &(autoreply)& creates, with the exception of newlines that are
20576 immediately followed by white space. If any non-printing characters are found,
20577 the transport defers.
20578 Whether characters with the top bit set count as printing characters or not is
20579 controlled by the &%print_topbitchars%& global option.
20580
20581 If any of the generic options for manipulating headers (for example,
20582 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
20583 of the original message that is included in the generated message when
20584 &%return_message%& is set. They do not apply to the generated message itself.
20585
20586 .vindex "&$sender_address$&"
20587 If the &(autoreply)& transport receives return code 2 from Exim when it submits
20588 the message, indicating that there were no recipients, it does not treat this
20589 as an error. This means that autoreplies sent to &$sender_address$& when this
20590 is empty (because the incoming message is a bounce message) do not cause
20591 problems. They are just discarded.
20592
20593
20594
20595 .section "Private options for autoreply" "SECID139"
20596 .cindex "options" "&(autoreply)& transport"
20597
20598 .option bcc autoreply string&!! unset
20599 This specifies the addresses that are to receive &"blind carbon copies"& of the
20600 message when the message is specified by the transport.
20601
20602
20603 .option cc autoreply string&!! unset
20604 This specifies recipients of the message and the contents of the &'Cc:'& header
20605 when the message is specified by the transport.
20606
20607
20608 .option file autoreply string&!! unset
20609 The contents of the file are sent as the body of the message when the message
20610 is specified by the transport. If both &%file%& and &%text%& are set, the text
20611 string comes first.
20612
20613
20614 .option file_expand autoreply boolean false
20615 If this is set, the contents of the file named by the &%file%& option are
20616 subjected to string expansion as they are added to the message.
20617
20618
20619 .option file_optional autoreply boolean false
20620 If this option is true, no error is generated if the file named by the &%file%&
20621 option or passed with the address does not exist or cannot be read.
20622
20623
20624 .option from autoreply string&!! unset
20625 This specifies the contents of the &'From:'& header when the message is
20626 specified by the transport.
20627
20628
20629 .option headers autoreply string&!! unset
20630 This specifies additional RFC 2822 headers that are to be added to the message
20631 when the message is specified by the transport. Several can be given by using
20632 &"\n"& to separate them. There is no check on the format.
20633
20634
20635 .option log autoreply string&!! unset
20636 This option names a file in which a record of every message sent is logged when
20637 the message is specified by the transport.
20638
20639
20640 .option mode autoreply "octal integer" 0600
20641 If either the log file or the &"once"& file has to be created, this mode is
20642 used.
20643
20644
20645 .option never_mail autoreply "address list&!!" unset
20646 If any run of the transport creates a message with a recipient that matches any
20647 item in the list, that recipient is quietly discarded. If all recipients are
20648 discarded, no message is created. This applies both when the recipients are
20649 generated by a filter and when they are specified in the transport.
20650
20651
20652
20653 .option once autoreply string&!! unset
20654 This option names a file or DBM database in which a record of each &'To:'&
20655 recipient is kept when the message is specified by the transport. &*Note*&:
20656 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
20657
20658 If &%once%& is unset, or is set to an empty string, the message is always sent.
20659 By default, if &%once%& is set to a non-empty file name, the message
20660 is not sent if a potential recipient is already listed in the database.
20661 However, if the &%once_repeat%& option specifies a time greater than zero, the
20662 message is sent if that much time has elapsed since a message was last sent to
20663 this recipient. A setting of zero time for &%once_repeat%& (the default)
20664 prevents a message from being sent a second time &-- in this case, zero means
20665 infinity.
20666
20667 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
20668 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
20669 greater than zero, it changes the way Exim implements the &%once%& option.
20670 Instead of using a DBM file to record every recipient it sends to, it uses a
20671 regular file, whose size will never get larger than the given value.
20672
20673 In the file, Exim keeps a linear list of recipient addresses and the times at
20674 which they were sent messages. If the file is full when a new address needs to
20675 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
20676 means that a given recipient may receive multiple messages, but at
20677 unpredictable intervals that depend on the rate of turnover of addresses in the
20678 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
20679
20680
20681 .option once_file_size autoreply integer 0
20682 See &%once%& above.
20683
20684
20685 .option once_repeat autoreply time&!! 0s
20686 See &%once%& above.
20687 After expansion, the value of this option must be a valid time value.
20688
20689
20690 .option reply_to autoreply string&!! unset
20691 This specifies the contents of the &'Reply-To:'& header when the message is
20692 specified by the transport.
20693
20694
20695 .option return_message autoreply boolean false
20696 If this is set, a copy of the original message is returned with the new
20697 message, subject to the maximum size set in the &%return_size_limit%& global
20698 configuration option.
20699
20700
20701 .option subject autoreply string&!! unset
20702 This specifies the contents of the &'Subject:'& header when the message is
20703 specified by the transport. It is tempting to quote the original subject in
20704 automatic responses. For example:
20705 .code
20706 subject = Re: $h_subject:
20707 .endd
20708 There is a danger in doing this, however. It may allow a third party to
20709 subscribe your users to an opt-in mailing list, provided that the list accepts
20710 bounce messages as subscription confirmations. Well-managed lists require a
20711 non-bounce message to confirm a subscription, so the danger is relatively
20712 small.
20713
20714
20715
20716 .option text autoreply string&!! unset
20717 This specifies a single string to be used as the body of the message when the
20718 message is specified by the transport. If both &%text%& and &%file%& are set,
20719 the text comes first.
20720
20721
20722 .option to autoreply string&!! unset
20723 This specifies recipients of the message and the contents of the &'To:'& header
20724 when the message is specified by the transport.
20725 .ecindex IIDauttra1
20726 .ecindex IIDauttra2
20727
20728
20729
20730
20731 . ////////////////////////////////////////////////////////////////////////////
20732 . ////////////////////////////////////////////////////////////////////////////
20733
20734 .chapter "The lmtp transport" "CHAPLMTP"
20735 .cindex "transports" "&(lmtp)&"
20736 .cindex "&(lmtp)& transport"
20737 .cindex "LMTP" "over a pipe"
20738 .cindex "LMTP" "over a socket"
20739 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
20740 specified command
20741 or by interacting with a Unix domain socket.
20742 This transport is something of a cross between the &(pipe)& and &(smtp)&
20743 transports. Exim also has support for using LMTP over TCP/IP; this is
20744 implemented as an option for the &(smtp)& transport. Because LMTP is expected
20745 to be of minority interest, the default build-time configure in &_src/EDITME_&
20746 has it commented out. You need to ensure that
20747 .code
20748 TRANSPORT_LMTP=yes
20749 .endd
20750 .cindex "options" "&(lmtp)& transport"
20751 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
20752 included in the Exim binary. The private options of the &(lmtp)& transport are
20753 as follows:
20754
20755 .option batch_id lmtp string&!! unset
20756 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20757
20758
20759 .option batch_max lmtp integer 1
20760 This limits the number of addresses that can be handled in a single delivery.
20761 Most LMTP servers can handle several addresses at once, so it is normally a
20762 good idea to increase this value. See the description of local delivery
20763 batching in chapter &<<CHAPbatching>>&.
20764
20765
20766 .option command lmtp string&!! unset
20767 This option must be set if &%socket%& is not set. The string is a command which
20768 is run in a separate process. It is split up into a command name and list of
20769 arguments, each of which is separately expanded (so expansion cannot change the
20770 number of arguments). The command is run directly, not via a shell. The message
20771 is passed to the new process using the standard input and output to operate the
20772 LMTP protocol.
20773
20774 .option ignore_quota lmtp boolean false
20775 .cindex "LMTP" "ignoring quota errors"
20776 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
20777 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
20778 in its response to the LHLO command.
20779
20780 .option socket lmtp string&!! unset
20781 This option must be set if &%command%& is not set. The result of expansion must
20782 be the name of a Unix domain socket. The transport connects to the socket and
20783 delivers the message to it using the LMTP protocol.
20784
20785
20786 .option timeout lmtp time 5m
20787 The transport is aborted if the created process or Unix domain socket does not
20788 respond to LMTP commands or message input within this timeout. Delivery
20789 is deferred, and will be tried again later. Here is an example of a typical
20790 LMTP transport:
20791 .code
20792 lmtp:
20793   driver = lmtp
20794   command = /some/local/lmtp/delivery/program
20795   batch_max = 20
20796   user = exim
20797 .endd
20798 This delivers up to 20 addresses at a time, in a mixture of domains if
20799 necessary, running as the user &'exim'&.
20800
20801
20802
20803 . ////////////////////////////////////////////////////////////////////////////
20804 . ////////////////////////////////////////////////////////////////////////////
20805
20806 .chapter "The pipe transport" "CHAPpipetransport"
20807 .scindex IIDpiptra1 "transports" "&(pipe)&"
20808 .scindex IIDpiptra2 "&(pipe)& transport"
20809 The &(pipe)& transport is used to deliver messages via a pipe to a command
20810 running in another process. One example is the use of &(pipe)& as a
20811 pseudo-remote transport for passing messages to some other delivery mechanism
20812 (such as UUCP). Another is the use by individual users to automatically process
20813 their incoming messages. The &(pipe)& transport can be used in one of the
20814 following ways:
20815
20816 .ilist
20817 .vindex "&$local_part$&"
20818 A router routes one address to a transport in the normal way, and the
20819 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
20820 contains the local part of the address (as usual), and the command that is run
20821 is specified by the &%command%& option on the transport.
20822 .next
20823 .vindex "&$pipe_addresses$&"
20824 If the &%batch_max%& option is set greater than 1 (the default is 1), the
20825 transport can handle more than one address in a single run. In this case, when
20826 more than one address is routed to the transport, &$local_part$& is not set
20827 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
20828 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
20829 that are routed to the transport.
20830 .next
20831 .vindex "&$address_pipe$&"
20832 A router redirects an address directly to a pipe command (for example, from an
20833 alias or forward file). In this case, &$address_pipe$& contains the text of the
20834 pipe command, and the &%command%& option on the transport is ignored. If only
20835 one address is being transported (&%batch_max%& is not greater than one, or
20836 only one address was redirected to this pipe command), &$local_part$& contains
20837 the local part that was redirected.
20838 .endlist
20839
20840
20841 The &(pipe)& transport is a non-interactive delivery method. Exim can also
20842 deliver messages over pipes using the LMTP interactive protocol. This is
20843 implemented by the &(lmtp)& transport.
20844
20845 In the case when &(pipe)& is run as a consequence of an entry in a local user's
20846 &_.forward_& file, the command runs under the uid and gid of that user. In
20847 other cases, the uid and gid have to be specified explicitly, either on the
20848 transport or on the router that handles the address. Current and &"home"&
20849 directories are also controllable. See chapter &<<CHAPenvironment>>& for
20850 details of the local delivery environment and chapter &<<CHAPbatching>>&
20851 for a discussion of local delivery batching.
20852
20853
20854 .section "Concurrent delivery" "SECID140"
20855 If two messages arrive at almost the same time, and both are routed to a pipe
20856 delivery, the two pipe transports may be run concurrently. You must ensure that
20857 any pipe commands you set up are robust against this happening. If the commands
20858 write to a file, the &%exim_lock%& utility might be of use.
20859
20860
20861
20862
20863 .section "Returned status and data" "SECID141"
20864 .cindex "&(pipe)& transport" "returned data"
20865 If the command exits with a non-zero return code, the delivery is deemed to
20866 have failed, unless either the &%ignore_status%& option is set (in which case
20867 the return code is treated as zero), or the return code is one of those listed
20868 in the &%temp_errors%& option, which are interpreted as meaning &"try again
20869 later"&. In this case, delivery is deferred. Details of a permanent failure are
20870 logged, but are not included in the bounce message, which merely contains
20871 &"local delivery failed"&.
20872
20873 If the return code is greater than 128 and the command being run is a shell
20874 script, it normally means that the script was terminated by a signal whose
20875 value is the return code minus 128.
20876
20877 If Exim is unable to run the command (that is, if &[execve()]& fails), the
20878 return code is set to 127. This is the value that a shell returns if it is
20879 asked to run a non-existent command. The wording for the log line suggests that
20880 a non-existent command may be the problem.
20881
20882 The &%return_output%& option can affect the result of a pipe delivery. If it is
20883 set and the command produces any output on its standard output or standard
20884 error streams, the command is considered to have failed, even if it gave a zero
20885 return code or if &%ignore_status%& is set. The output from the command is
20886 included as part of the bounce message. The &%return_fail_output%& option is
20887 similar, except that output is returned only when the command exits with a
20888 failure return code, that is, a value other than zero or a code that matches
20889 &%temp_errors%&.
20890
20891
20892
20893 .section "How the command is run" "SECThowcommandrun"
20894 .cindex "&(pipe)& transport" "path for command"
20895 The command line is (by default) broken down into a command name and arguments
20896 by the &(pipe)& transport itself. The &%allow_commands%& and
20897 &%restrict_to_path%& options can be used to restrict the commands that may be
20898 run.
20899
20900 .cindex "quoting" "in pipe command"
20901 Unquoted arguments are delimited by white space. If an argument appears in
20902 double quotes, backslash is interpreted as an escape character in the usual
20903 way. If an argument appears in single quotes, no escaping is done.
20904
20905 String expansion is applied to the command line except when it comes from a
20906 traditional &_.forward_& file (commands from a filter file are expanded). The
20907 expansion is applied to each argument in turn rather than to the whole line.
20908 For this reason, any string expansion item that contains white space must be
20909 quoted so as to be contained within a single argument. A setting such as
20910 .code
20911 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
20912 .endd
20913 will not work, because the expansion item gets split between several
20914 arguments. You have to write
20915 .code
20916 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
20917 .endd
20918 to ensure that it is all in one argument. The expansion is done in this way,
20919 argument by argument, so that the number of arguments cannot be changed as a
20920 result of expansion, and quotes or backslashes in inserted variables do not
20921 interact with external quoting. However, this leads to problems if you want to
20922 generate multiple arguments (or the command name plus arguments) from a single
20923 expansion. In this situation, the simplest solution is to use a shell. For
20924 example:
20925 .code
20926 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
20927 .endd
20928
20929 .cindex "transport" "filter"
20930 .cindex "filter" "transport filter"
20931 .vindex "&$pipe_addresses$&"
20932 Special handling takes place when an argument consists of precisely the text
20933 &`$pipe_addresses`&. This is not a general expansion variable; the only
20934 place this string is recognized is when it appears as an argument for a pipe or
20935 transport filter command. It causes each address that is being handled to be
20936 inserted in the argument list at that point &'as a separate argument'&. This
20937 avoids any problems with spaces or shell metacharacters, and is of use when a
20938 &(pipe)& transport is handling groups of addresses in a batch.
20939
20940 After splitting up into arguments and expansion, the resulting command is run
20941 in a subprocess directly from the transport, &'not'& under a shell. The
20942 message that is being delivered is supplied on the standard input, and the
20943 standard output and standard error are both connected to a single pipe that is
20944 read by Exim. The &%max_output%& option controls how much output the command
20945 may produce, and the &%return_output%& and &%return_fail_output%& options
20946 control what is done with it.
20947
20948 Not running the command under a shell (by default) lessens the security risks
20949 in cases when a command from a user's filter file is built out of data that was
20950 taken from an incoming message. If a shell is required, it can of course be
20951 explicitly specified as the command to be run. However, there are circumstances
20952 where existing commands (for example, in &_.forward_& files) expect to be run
20953 under a shell and cannot easily be modified. To allow for these cases, there is
20954 an option called &%use_shell%&, which changes the way the &(pipe)& transport
20955 works. Instead of breaking up the command line as just described, it expands it
20956 as a single string and passes the result to &_/bin/sh_&. The
20957 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
20958 with &%use_shell%&, and the whole mechanism is inherently less secure.
20959
20960
20961
20962 .section "Environment variables" "SECTpipeenv"
20963 .cindex "&(pipe)& transport" "environment for command"
20964 .cindex "environment for pipe transport"
20965 The environment variables listed below are set up when the command is invoked.
20966 This list is a compromise for maximum compatibility with other MTAs. Note that
20967 the &%environment%& option can be used to add additional variables to this
20968 environment.
20969 .display
20970 &`DOMAIN            `&   the domain of the address
20971 &`HOME              `&   the home directory, if set
20972 &`HOST              `&   the host name when called from a router (see below)
20973 &`LOCAL_PART        `&   see below
20974 &`LOCAL_PART_PREFIX `&   see below
20975 &`LOCAL_PART_SUFFIX `&   see below
20976 &`LOGNAME           `&   see below
20977 &`MESSAGE_ID        `&   Exim's local ID for the message
20978 &`PATH              `&   as specified by the &%path%& option below
20979 &`QUALIFY_DOMAIN    `&   the sender qualification domain
20980 &`RECIPIENT         `&   the complete recipient address
20981 &`SENDER            `&   the sender of the message (empty if a bounce)
20982 &`SHELL             `&   &`/bin/sh`&
20983 &`TZ                `&   the value of the &%timezone%& option, if set
20984 &`USER              `&   see below
20985 .endd
20986 When a &(pipe)& transport is called directly from (for example) an &(accept)&
20987 router, LOCAL_PART is set to the local part of the address. When it is
20988 called as a result of a forward or alias expansion, LOCAL_PART is set to
20989 the local part of the address that was expanded. In both cases, any affixes are
20990 removed from the local part, and made available in LOCAL_PART_PREFIX and
20991 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
20992 same value as LOCAL_PART for compatibility with other MTAs.
20993
20994 .cindex "HOST"
20995 HOST is set only when a &(pipe)& transport is called from a router that
20996 associates hosts with an address, typically when using &(pipe)& as a
20997 pseudo-remote transport. HOST is set to the first host name specified by
20998 the router.
20999
21000 .cindex "HOME"
21001 If the transport's generic &%home_directory%& option is set, its value is used
21002 for the HOME environment variable. Otherwise, a home directory may be set
21003 by the router's &%transport_home_directory%& option, which defaults to the
21004 user's home directory if &%check_local_user%& is set.
21005
21006
21007 .section "Private options for pipe" "SECID142"
21008 .cindex "options" "&(pipe)& transport"
21009
21010
21011
21012 .option allow_commands pipe "string list&!!" unset
21013 .cindex "&(pipe)& transport" "permitted commands"
21014 The string is expanded, and is then interpreted as a colon-separated list of
21015 permitted commands. If &%restrict_to_path%& is not set, the only commands
21016 permitted are those in the &%allow_commands%& list. They need not be absolute
21017 paths; the &%path%& option is still used for relative paths. If
21018 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
21019 in the &%allow_commands%& list, or a name without any slashes that is found on
21020 the path. In other words, if neither &%allow_commands%& nor
21021 &%restrict_to_path%& is set, there is no restriction on the command, but
21022 otherwise only commands that are permitted by one or the other are allowed. For
21023 example, if
21024 .code
21025 allow_commands = /usr/bin/vacation
21026 .endd
21027 and &%restrict_to_path%& is not set, the only permitted command is
21028 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
21029 &%use_shell%& is set.
21030
21031
21032 .option batch_id pipe string&!! unset
21033 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21034
21035
21036 .option batch_max pipe integer 1
21037 This limits the number of addresses that can be handled in a single delivery.
21038 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21039
21040
21041 .option check_string pipe string unset
21042 As &(pipe)& writes the message, the start of each line is tested for matching
21043 &%check_string%&, and if it does, the initial matching characters are replaced
21044 by the contents of &%escape_string%&, provided both are set. The value of
21045 &%check_string%& is a literal string, not a regular expression, and the case of
21046 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
21047 of &%check_string%& and &%escape_string%& are forced to values that implement
21048 the SMTP escaping protocol. Any settings made in the configuration file are
21049 ignored.
21050
21051
21052 .option command pipe string&!! unset
21053 This option need not be set when &(pipe)& is being used to deliver to pipes
21054 obtained directly from address redirections. In other cases, the option must be
21055 set, to provide a command to be run. It need not yield an absolute path (see
21056 the &%path%& option below). The command is split up into separate arguments by
21057 Exim, and each argument is separately expanded, as described in section
21058 &<<SECThowcommandrun>>& above.
21059
21060
21061 .option environment pipe string&!! unset
21062 .cindex "&(pipe)& transport" "environment for command"
21063 .cindex "environment for &(pipe)& transport"
21064 This option is used to add additional variables to the environment in which the
21065 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
21066 a string which is expanded, and then interpreted as a colon-separated list of
21067 environment settings of the form <&'name'&>=<&'value'&>.
21068
21069
21070 .option escape_string pipe string unset
21071 See &%check_string%& above.
21072
21073
21074 .option freeze_exec_fail pipe boolean false
21075 .cindex "exec failure"
21076 .cindex "failure of exec"
21077 .cindex "&(pipe)& transport" "failure of exec"
21078 Failure to exec the command in a pipe transport is by default treated like
21079 any other failure while running the command. However, if &%freeze_exec_fail%&
21080 is set, failure to exec is treated specially, and causes the message to be
21081 frozen, whatever the setting of &%ignore_status%&.
21082
21083
21084 .option ignore_status pipe boolean false
21085 If this option is true, the status returned by the subprocess that is set up to
21086 run the command is ignored, and Exim behaves as if zero had been returned.
21087 Otherwise, a non-zero status or termination by signal causes an error return
21088 from the transport unless the status value is one of those listed in
21089 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
21090
21091 &*Note*&: This option does not apply to timeouts, which do not return a status.
21092 See the &%timeout_defer%& option for how timeouts are handled.
21093
21094 .option log_defer_output pipe boolean false
21095 .cindex "&(pipe)& transport" "logging output"
21096 If this option is set, and the status returned by the command is
21097 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
21098 and any output was produced, the first line of it is written to the main log.
21099
21100
21101 .option log_fail_output pipe boolean false
21102 If this option is set, and the command returns any output, and also ends with a
21103 return code that is neither zero nor one of the return codes listed in
21104 &%temp_errors%& (that is, the delivery failed), the first line of output is
21105 written to the main log. This option and &%log_output%& are mutually exclusive.
21106 Only one of them may be set.
21107
21108
21109
21110 .option log_output pipe boolean false
21111 If this option is set and the command returns any output, the first line of
21112 output is written to the main log, whatever the return code. This option and
21113 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
21114
21115
21116
21117 .option max_output pipe integer 20K
21118 This specifies the maximum amount of output that the command may produce on its
21119 standard output and standard error file combined. If the limit is exceeded, the
21120 process running the command is killed. This is intended as a safety measure to
21121 catch runaway processes. The limit is applied independently of the settings of
21122 the options that control what is done with such output (for example,
21123 &%return_output%&). Because of buffering effects, the amount of output may
21124 exceed the limit by a small amount before Exim notices.
21125
21126
21127 .option message_prefix pipe string&!! "see below"
21128 The string specified here is expanded and output at the start of every message.
21129 The default is unset if &%use_bsmtp%& is set. Otherwise it is
21130 .code
21131 message_prefix = \
21132   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
21133   ${tod_bsdinbox}\n
21134 .endd
21135 .cindex "Cyrus"
21136 .cindex "&%tmail%&"
21137 .cindex "&""From""& line"
21138 This is required by the commonly used &_/usr/bin/vacation_& program.
21139 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
21140 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
21141 setting
21142 .code
21143 message_prefix =
21144 .endd
21145 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21146 &`\n`& to &`\r\n`& in &%message_prefix%&.
21147
21148
21149 .option message_suffix pipe string&!! "see below"
21150 The string specified here is expanded and output at the end of every message.
21151 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
21152 The suffix can be suppressed by setting
21153 .code
21154 message_suffix =
21155 .endd
21156 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21157 &`\n`& to &`\r\n`& in &%message_suffix%&.
21158
21159
21160 .option path pipe string "see below"
21161 This option specifies the string that is set up in the PATH environment
21162 variable of the subprocess. The default is:
21163 .code
21164 /bin:/usr/bin
21165 .endd
21166 If the &%command%& option does not yield an absolute path name, the command is
21167 sought in the PATH directories, in the usual way. &*Warning*&: This does not
21168 apply to a command specified as a transport filter.
21169
21170
21171 .option permit_coredump pipe boolean false
21172 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
21173 a core-dump of a pipe command, enable this command.  This enables core-dumps
21174 during delivery and affects both the Exim binary and the pipe command run.
21175 It is recommended that this option remain off unless and until you have a need
21176 for it and that this only be enabled when needed, as the risk of excessive
21177 resource consumption can be quite high.  Note also that Exim is typically
21178 installed as a setuid binary and most operating systems will inhibit coredumps
21179 of these by default, so further OS-specific action may be required.
21180
21181
21182 .option pipe_as_creator pipe boolean false
21183 .cindex "uid (user id)" "local delivery"
21184 If the generic &%user%& option is not set and this option is true, the delivery
21185 process is run under the uid that was in force when Exim was originally called
21186 to accept the message. If the group id is not otherwise set (via the generic
21187 &%group%& option), the gid that was in force when Exim was originally called to
21188 accept the message is used.
21189
21190
21191 .option restrict_to_path pipe boolean false
21192 When this option is set, any command name not listed in &%allow_commands%& must
21193 contain no slashes. The command is searched for only in the directories listed
21194 in the &%path%& option. This option is intended for use in the case when a pipe
21195 command has been generated from a user's &_.forward_& file. This is usually
21196 handled by a &(pipe)& transport called &%address_pipe%&.
21197
21198
21199 .option return_fail_output pipe boolean false
21200 If this option is true, and the command produced any output and ended with a
21201 return code other than zero or one of the codes listed in &%temp_errors%& (that
21202 is, the delivery failed), the output is returned in the bounce message.
21203 However, if the message has a null sender (that is, it is itself a bounce
21204 message), output from the command is discarded. This option and
21205 &%return_output%& are mutually exclusive. Only one of them may be set.
21206
21207
21208
21209 .option return_output pipe boolean false
21210 If this option is true, and the command produced any output, the delivery is
21211 deemed to have failed whatever the return code from the command, and the output
21212 is returned in the bounce message. Otherwise, the output is just discarded.
21213 However, if the message has a null sender (that is, it is a bounce message),
21214 output from the command is always discarded, whatever the setting of this
21215 option. This option and &%return_fail_output%& are mutually exclusive. Only one
21216 of them may be set.
21217
21218
21219
21220 .option temp_errors pipe "string list" "see below"
21221 .cindex "&(pipe)& transport" "temporary failure"
21222 This option contains either a colon-separated list of numbers, or a single
21223 asterisk. If &%ignore_status%& is false
21224 and &%return_output%& is not set,
21225 and the command exits with a non-zero return code, the failure is treated as
21226 temporary and the delivery is deferred if the return code matches one of the
21227 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
21228 codes are treated as permanent errors. The default setting contains the codes
21229 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
21230 compiled on a system that does not define these macros, it assumes values of 75
21231 and 73, respectively.
21232
21233
21234 .option timeout pipe time 1h
21235 If the command fails to complete within this time, it is killed. This normally
21236 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
21237 specifies no timeout. In order to ensure that any subprocesses created by the
21238 command are also killed, Exim makes the initial process a process group leader,
21239 and kills the whole process group on a timeout. However, this can be defeated
21240 if one of the processes starts a new process group.
21241
21242 .option timeout_defer pipe boolean false
21243 A timeout in a &(pipe)& transport, either in the command that the transport
21244 runs, or in a transport filter that is associated with it, is by default
21245 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
21246 is set true, both kinds of timeout become temporary errors, causing the
21247 delivery to be deferred.
21248
21249 .option umask pipe "octal integer" 022
21250 This specifies the umask setting for the subprocess that runs the command.
21251
21252
21253 .option use_bsmtp pipe boolean false
21254 .cindex "envelope sender"
21255 If this option is set true, the &(pipe)& transport writes messages in &"batch
21256 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
21257 commands. If you want to include a leading HELO command with such messages,
21258 you can do so by setting the &%message_prefix%& option. See section
21259 &<<SECTbatchSMTP>>& for details of batch SMTP.
21260
21261 .option use_classresources pipe boolean false
21262 .cindex "class resources (BSD)"
21263 This option is available only when Exim is running on FreeBSD, NetBSD, or
21264 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
21265 resource limits when a &(pipe)& transport is run to perform a delivery. The
21266 limits for the uid under which the pipe is to run are obtained from the login
21267 class database.
21268
21269
21270 .option use_crlf pipe boolean false
21271 .cindex "carriage return"
21272 .cindex "linefeed"
21273 This option causes lines to be terminated with the two-character CRLF sequence
21274 (carriage return, linefeed) instead of just a linefeed character. In the case
21275 of batched SMTP, the byte sequence written to the pipe is then an exact image
21276 of what would be sent down a real SMTP connection.
21277
21278 The contents of the &%message_prefix%& and &%message_suffix%& options are
21279 written verbatim, so must contain their own carriage return characters if these
21280 are needed. When &%use_bsmtp%& is not set, the default values for both
21281 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
21282 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
21283
21284
21285 .option use_shell pipe boolean false
21286 .vindex "&$pipe_addresses$&"
21287 If this option is set, it causes the command to be passed to &_/bin/sh_&
21288 instead of being run directly from the transport, as described in section
21289 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
21290 where the command is expected to be run under a shell and cannot easily be
21291 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
21292 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
21293 command is expanded as a single string, and handed to &_/bin/sh_& as data for
21294 its &%-c%& option.
21295
21296
21297
21298 .section "Using an external local delivery agent" "SECID143"
21299 .cindex "local delivery" "using an external agent"
21300 .cindex "&'procmail'&"
21301 .cindex "external local delivery"
21302 .cindex "delivery" "&'procmail'&"
21303 .cindex "delivery" "by external agent"
21304 The &(pipe)& transport can be used to pass all messages that require local
21305 delivery to a separate local delivery agent such as &%procmail%&. When doing
21306 this, care must be taken to ensure that the pipe is run under an appropriate
21307 uid and gid. In some configurations one wants this to be a uid that is trusted
21308 by the delivery agent to supply the correct sender of the message. It may be
21309 necessary to recompile or reconfigure the delivery agent so that it trusts an
21310 appropriate user. The following is an example transport and router
21311 configuration for &%procmail%&:
21312 .code
21313 # transport
21314 procmail_pipe:
21315   driver = pipe
21316   command = /usr/local/bin/procmail -d $local_part
21317   return_path_add
21318   delivery_date_add
21319   envelope_to_add
21320   check_string = "From "
21321   escape_string = ">From "
21322   umask = 077
21323   user = $local_part
21324   group = mail
21325
21326 # router
21327 procmail:
21328   driver = accept
21329   check_local_user
21330   transport = procmail_pipe
21331 .endd
21332 In this example, the pipe is run as the local user, but with the group set to
21333 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
21334 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
21335 user to supply a correct sender address. If you do not specify either a
21336 &%group%& or a &%user%& option, the pipe command is run as the local user. The
21337 home directory is the user's home directory by default.
21338
21339 &*Note*&: The command that the pipe transport runs does &'not'& begin with
21340 .code
21341 IFS=" "
21342 .endd
21343 as shown in some &%procmail%& documentation, because Exim does not by default
21344 use a shell to run pipe commands.
21345
21346 .cindex "Cyrus"
21347 The next example shows a transport and a router for a system where local
21348 deliveries are handled by the Cyrus IMAP server.
21349 .code
21350 # transport
21351 local_delivery_cyrus:
21352   driver = pipe
21353   command = /usr/cyrus/bin/deliver \
21354             -m ${substr_1:$local_part_suffix} -- $local_part
21355   user = cyrus
21356   group = mail
21357   return_output
21358   log_output
21359   message_prefix =
21360   message_suffix =
21361
21362 # router
21363 local_user_cyrus:
21364   driver = accept
21365   check_local_user
21366   local_part_suffix = .*
21367   transport = local_delivery_cyrus
21368 .endd
21369 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
21370 &%return_output%& to cause any text written by Cyrus to be returned to the
21371 sender.
21372 .ecindex IIDpiptra1
21373 .ecindex IIDpiptra2
21374
21375
21376 . ////////////////////////////////////////////////////////////////////////////
21377 . ////////////////////////////////////////////////////////////////////////////
21378
21379 .chapter "The smtp transport" "CHAPsmtptrans"
21380 .scindex IIDsmttra1 "transports" "&(smtp)&"
21381 .scindex IIDsmttra2 "&(smtp)& transport"
21382 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
21383 or LMTP protocol. The list of hosts to try can either be taken from the address
21384 that is being processed (having been set up by the router), or specified
21385 explicitly for the transport. Timeout and retry processing (see chapter
21386 &<<CHAPretry>>&) is applied to each IP address independently.
21387
21388
21389 .section "Multiple messages on a single connection" "SECID144"
21390 The sending of multiple messages over a single TCP/IP connection can arise in
21391 two ways:
21392
21393 .ilist
21394 If a message contains more than &%max_rcpt%& (see below) addresses that are
21395 routed to the same host, more than one copy of the message has to be sent to
21396 that host. In this situation, multiple copies may be sent in a single run of
21397 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
21398 does when it has too many addresses to send in one message also depends on the
21399 value of the global &%remote_max_parallel%& option. Details are given in
21400 section &<<SECToutSMTPTCP>>&.)
21401 .next
21402 .cindex "hints database" "remembering routing"
21403 When a message has been successfully delivered over a TCP/IP connection, Exim
21404 looks in its hints database to see if there are any other messages awaiting a
21405 connection to the same host. If there are, a new delivery process is started
21406 for one of them, and the current TCP/IP connection is passed on to it. The new
21407 process may in turn send multiple copies and possibly create yet another
21408 process.
21409 .endlist
21410
21411
21412 For each copy sent over the same TCP/IP connection, a sequence counter is
21413 incremented, and if it ever gets to the value of &%connection_max_messages%&,
21414 no further messages are sent over that connection.
21415
21416
21417
21418 .section "Use of the $host and $host_address variables" "SECID145"
21419 .vindex "&$host$&"
21420 .vindex "&$host_address$&"
21421 At the start of a run of the &(smtp)& transport, the values of &$host$& and
21422 &$host_address$& are the name and IP address of the first host on the host list
21423 passed by the router. However, when the transport is about to connect to a
21424 specific host, and while it is connected to that host, &$host$& and
21425 &$host_address$& are set to the values for that host. These are the values
21426 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
21427 &%serialize_hosts%&, and the various TLS options are expanded.
21428
21429
21430 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
21431 .vindex &$tls_cipher$&
21432 .vindex &$tls_peerdn$&
21433 At the start of a run of the &(smtp)& transport, the values of &$tls_cipher$&
21434 and &$tls_peerdn$& are the values that were set when the message was received.
21435 These are the values that are used for options that are expanded before any
21436 SMTP connections are made. Just before each connection is made, these two
21437 variables are emptied. If TLS is subsequently started, they are set to the
21438 appropriate values for the outgoing connection, and these are the values that
21439 are in force when any authenticators are run and when the
21440 &%authenticated_sender%& option is expanded.
21441
21442
21443 .section "Private options for smtp" "SECID146"
21444 .cindex "options" "&(smtp)& transport"
21445 The private options of the &(smtp)& transport are as follows:
21446
21447
21448 .option address_retry_include_sender smtp boolean true
21449 .cindex "4&'xx'& responses" "retrying after"
21450 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
21451 is the combination of sender and recipient that is delayed in subsequent queue
21452 runs until the retry time is reached. You can delay the recipient without
21453 reference to the sender (which is what earlier versions of Exim did), by
21454 setting &%address_retry_include_sender%& false. However, this can lead to
21455 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
21456
21457 .option allow_localhost smtp boolean false
21458 .cindex "local host" "sending to"
21459 .cindex "fallback" "hosts specified on transport"
21460 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
21461 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
21462 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
21463 the delivery anyway. This should be used only in special cases when the
21464 configuration ensures that no looping will result (for example, a differently
21465 configured Exim is listening on the port to which the message is sent).
21466
21467
21468 .option authenticated_sender smtp string&!! unset
21469 .cindex "Cyrus"
21470 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
21471 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
21472 overriding any existing authenticated sender value. If the string expansion is
21473 forced to fail, the option is ignored. Other expansion failures cause delivery
21474 to be deferred. If the result of expansion is an empty string, that is also
21475 ignored.
21476
21477 The expansion happens after the outgoing connection has been made and TLS
21478 started, if required. This means that the &$host$&, &$host_address$&,
21479 &$tls_cipher$&, and &$tls_peerdn$& variables are set according to the
21480 particular connection.
21481
21482 If the SMTP session is not authenticated, the expansion of
21483 &%authenticated_sender%& still happens (and can cause the delivery to be
21484 deferred if it fails), but no AUTH= item is added to MAIL commands
21485 unless &%authenticated_sender_force%& is true.
21486
21487 This option allows you to use the &(smtp)& transport in LMTP mode to
21488 deliver mail to Cyrus IMAP and provide the proper local part as the
21489 &"authenticated sender"&, via a setting such as:
21490 .code
21491 authenticated_sender = $local_part
21492 .endd
21493 This removes the need for IMAP subfolders to be assigned special ACLs to
21494 allow direct delivery to those subfolders.
21495
21496 Because of expected uses such as that just described for Cyrus (when no
21497 domain is involved), there is no checking on the syntax of the provided
21498 value.
21499
21500
21501 .option authenticated_sender_force smtp boolean false
21502 If this option is set true, the &%authenticated_sender%& option's value
21503 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
21504 authenticated as a client.
21505
21506
21507 .option command_timeout smtp time 5m
21508 This sets a timeout for receiving a response to an SMTP command that has been
21509 sent out. It is also used when waiting for the initial banner line from the
21510 remote host. Its value must not be zero.
21511
21512
21513 .option connect_timeout smtp time 5m
21514 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
21515 to a remote host. A setting of zero allows the system timeout (typically
21516 several minutes) to act. To have any effect, the value of this option must be
21517 less than the system timeout. However, it has been observed that on some
21518 systems there is no system timeout, which is why the default value for this
21519 option is 5 minutes, a value recommended by RFC 1123.
21520
21521
21522 .option connection_max_messages smtp integer 500
21523 .cindex "SMTP" "passed connection"
21524 .cindex "SMTP" "multiple deliveries"
21525 .cindex "multiple SMTP deliveries"
21526 This controls the maximum number of separate message deliveries that are sent
21527 over a single TCP/IP connection. If the value is zero, there is no limit.
21528 For testing purposes, this value can be overridden by the &%-oB%& command line
21529 option.
21530
21531
21532 .option data_timeout smtp time 5m
21533 This sets a timeout for the transmission of each block in the data portion of
21534 the message. As a result, the overall timeout for a message depends on the size
21535 of the message. Its value must not be zero. See also &%final_timeout%&.
21536
21537
21538 .option delay_after_cutoff smtp boolean true
21539 This option controls what happens when all remote IP addresses for a given
21540 domain have been inaccessible for so long that they have passed their retry
21541 cutoff times.
21542
21543 In the default state, if the next retry time has not been reached for any of
21544 them, the address is bounced without trying any deliveries. In other words,
21545 Exim delays retrying an IP address after the final cutoff time until a new
21546 retry time is reached, and can therefore bounce an address without ever trying
21547 a delivery, when machines have been down for a long time. Some people are
21548 unhappy at this prospect, so...
21549
21550 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
21551 addresses are past their final cutoff time, Exim tries to deliver to those
21552 IP addresses that have not been tried since the message arrived. If there are
21553 none, of if they all fail, the address is bounced. In other words, it does not
21554 delay when a new message arrives, but immediately tries those expired IP
21555 addresses that haven't been tried since the message arrived. If there is a
21556 continuous stream of messages for the dead hosts, unsetting
21557 &%delay_after_cutoff%& means that there will be many more attempts to deliver
21558 to them.
21559
21560
21561 .option dns_qualify_single smtp boolean true
21562 If the &%hosts%& or &%fallback_hosts%& option is being used,
21563 and the &%gethostbyname%& option is false,
21564 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
21565 in chapter &<<CHAPdnslookup>>& for more details.
21566
21567
21568 .option dns_search_parents smtp boolean false
21569 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
21570 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
21571 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
21572 details.
21573
21574
21575
21576 .option fallback_hosts smtp "string list" unset
21577 .cindex "fallback" "hosts specified on transport"
21578 String expansion is not applied to this option. The argument must be a
21579 colon-separated list of host names or IP addresses, optionally also including
21580 port numbers, though the separator can be changed, as described in section
21581 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
21582 item in a &%route_list%& setting for the &(manualroute)& router, as described
21583 in section &<<SECTformatonehostitem>>&.
21584
21585 Fallback hosts can also be specified on routers, which associate them with the
21586 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
21587 &%fallback_hosts%& specified on the transport is used only if the address does
21588 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
21589 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
21590 However, &%hosts_randomize%& does apply to fallback host lists.
21591
21592 If Exim is unable to deliver to any of the hosts for a particular address, and
21593 the errors are not permanent rejections, the address is put on a separate
21594 transport queue with its host list replaced by the fallback hosts, unless the
21595 address was routed via MX records and the current host was in the original MX
21596 list. In that situation, the fallback host list is not used.
21597
21598 Once normal deliveries are complete, the fallback queue is delivered by
21599 re-running the same transports with the new host lists. If several failing
21600 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
21601 copy of the message is sent.
21602
21603 The resolution of the host names on the fallback list is controlled by the
21604 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
21605 both to cases when the host list comes with the address and when it is taken
21606 from &%hosts%&. This option provides a &"use a smart host only if delivery
21607 fails"& facility.
21608
21609
21610 .option final_timeout smtp time 10m
21611 This is the timeout that applies while waiting for the response to the final
21612 line containing just &"."& that terminates a message. Its value must not be
21613 zero.
21614
21615 .option gethostbyname smtp boolean false
21616 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
21617 being used, names are looked up using &[gethostbyname()]&
21618 (or &[getipnodebyname()]& when available)
21619 instead of using the DNS. Of course, that function may in fact use the DNS, but
21620 it may also consult other sources of information such as &_/etc/hosts_&.
21621
21622 .option gnutls_require_kx smtp string unset
21623 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
21624 client. For details, see section &<<SECTreqciphgnu>>&.
21625
21626 .option gnutls_require_mac smtp string unset
21627 This option controls the MAC algorithms when GnuTLS is used in an Exim
21628 client. For details, see section &<<SECTreqciphgnu>>&.
21629
21630 .option gnutls_require_protocols smtp string unset
21631 This option controls the protocols when GnuTLS is used in an Exim
21632 client. For details, see section &<<SECTreqciphgnu>>&.
21633
21634 .option gnutls_compat_mode smtp boolean unset
21635 This option controls whether GnuTLS is used in compatibility mode in an Exim
21636 server. This reduces security slightly, but improves interworking with older
21637 implementations of TLS.
21638
21639 .option helo_data smtp string&!! "see below"
21640 .cindex "HELO" "argument, setting"
21641 .cindex "EHLO" "argument, setting"
21642 .cindex "LHLO argument setting"
21643 The value of this option is expanded after a connection to a another host has
21644 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
21645 command that starts the outgoing SMTP or LMTP session. The default value of the
21646 option is:
21647 .code
21648 $primary_hostname
21649 .endd
21650 During the expansion, the variables &$host$& and &$host_address$& are set to
21651 the identity of the remote host, and the variables &$sending_ip_address$& and
21652 &$sending_port$& are set to the local IP address and port number that are being
21653 used. These variables can be used to generate different values for different
21654 servers or different local IP addresses. For example, if you want the string
21655 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
21656 interface address, you could use this:
21657 .code
21658 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
21659   {$primary_hostname}}
21660 .endd
21661 The use of &%helo_data%& applies both to sending messages and when doing
21662 callouts.
21663
21664 .option hosts smtp "string list&!!" unset
21665 Hosts are associated with an address by a router such as &(dnslookup)&, which
21666 finds the hosts by looking up the address domain in the DNS, or by
21667 &(manualroute)&, which has lists of hosts in its configuration. However,
21668 email addresses can be passed to the &(smtp)& transport by any router, and not
21669 all of them can provide an associated list of hosts.
21670
21671 The &%hosts%& option specifies a list of hosts to be used if the address being
21672 processed does not have any hosts associated with it. The hosts specified by
21673 &%hosts%& are also used, whether or not the address has its own hosts, if
21674 &%hosts_override%& is set.
21675
21676 The string is first expanded, before being interpreted as a colon-separated
21677 list of host names or IP addresses, possibly including port numbers. The
21678 separator may be changed to something other than colon, as described in section
21679 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
21680 item in a &%route_list%& setting for the &(manualroute)& router, as described
21681 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
21682 of the &(manualroute)& router is not available here.
21683
21684 If the expansion fails, delivery is deferred. Unless the failure was caused by
21685 the inability to complete a lookup, the error is logged to the panic log as
21686 well as the main log. Host names are looked up either by searching directly for
21687 address records in the DNS or by calling &[gethostbyname()]& (or
21688 &[getipnodebyname()]& when available), depending on the setting of the
21689 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
21690 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
21691 address are used.
21692
21693 During delivery, the hosts are tried in order, subject to their retry status,
21694 unless &%hosts_randomize%& is set.
21695
21696
21697 .option hosts_avoid_esmtp smtp "host list&!!" unset
21698 .cindex "ESMTP, avoiding use of"
21699 .cindex "HELO" "forcing use of"
21700 .cindex "EHLO" "avoiding use of"
21701 .cindex "PIPELINING" "avoiding the use of"
21702 This option is for use with broken hosts that announce ESMTP facilities (for
21703 example, PIPELINING) and then fail to implement them properly. When a host
21704 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
21705 start of the SMTP session. This means that it cannot use any of the ESMTP
21706 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
21707
21708
21709 .option hosts_avoid_pipelining smtp "host list&!!" unset
21710 .cindex "PIPELINING" "avoiding the use of"
21711 Exim will not use the SMTP PIPELINING extension when delivering to any host
21712 that matches this list, even if the server host advertises PIPELINING support.
21713
21714
21715 .option hosts_avoid_tls smtp "host list&!!" unset
21716 .cindex "TLS" "avoiding for certain hosts"
21717 Exim will not try to start a TLS session when delivering to any host that
21718 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
21719
21720
21721 .option hosts_max_try smtp integer 5
21722 .cindex "host" "maximum number to try"
21723 .cindex "limit" "number of hosts tried"
21724 .cindex "limit" "number of MX tried"
21725 .cindex "MX record" "maximum tried"
21726 This option limits the number of IP addresses that are tried for any one
21727 delivery in cases where there are temporary delivery errors. Section
21728 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
21729
21730
21731 .option hosts_max_try_hardlimit smtp integer 50
21732 This is an additional check on the maximum number of IP addresses that Exim
21733 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
21734 why it exists.
21735
21736
21737
21738 .option hosts_nopass_tls smtp "host list&!!" unset
21739 .cindex "TLS" "passing connection"
21740 .cindex "multiple SMTP deliveries"
21741 .cindex "TLS" "multiple message deliveries"
21742 For any host that matches this list, a connection on which a TLS session has
21743 been started will not be passed to a new delivery process for sending another
21744 message on the same connection. See section &<<SECTmulmessam>>& for an
21745 explanation of when this might be needed.
21746
21747
21748 .option hosts_override smtp boolean false
21749 If this option is set and the &%hosts%& option is also set, any hosts that are
21750 attached to the address are ignored, and instead the hosts specified by the
21751 &%hosts%& option are always used. This option does not apply to
21752 &%fallback_hosts%&.
21753
21754
21755 .option hosts_randomize smtp boolean false
21756 .cindex "randomized host list"
21757 .cindex "host" "list of; randomized"
21758 .cindex "fallback" "randomized hosts"
21759 If this option is set, and either the list of hosts is taken from the
21760 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
21761 were not obtained from MX records (this includes fallback hosts from the
21762 router), and were not randomized by the router, the order of trying the hosts
21763 is randomized each time the transport runs. Randomizing the order of a host
21764 list can be used to do crude load sharing.
21765
21766 When &%hosts_randomize%& is true, a host list may be split into groups whose
21767 order is separately randomized. This makes it possible to set up MX-like
21768 behaviour. The boundaries between groups are indicated by an item that is just
21769 &`+`& in the host list. For example:
21770 .code
21771 hosts = host1:host2:host3:+:host4:host5
21772 .endd
21773 The order of the first three hosts and the order of the last two hosts is
21774 randomized for each use, but the first three always end up before the last two.
21775 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
21776
21777 .option hosts_require_auth smtp "host list&!!" unset
21778 .cindex "authentication" "required by client"
21779 This option provides a list of servers for which authentication must succeed
21780 before Exim will try to transfer a message. If authentication fails for
21781 servers which are not in this list, Exim tries to send unauthenticated. If
21782 authentication fails for one of these servers, delivery is deferred. This
21783 temporary error is detectable in the retry rules, so it can be turned into a
21784 hard failure if required. See also &%hosts_try_auth%&, and chapter
21785 &<<CHAPSMTPAUTH>>& for details of authentication.
21786
21787
21788 .option hosts_require_tls smtp "host list&!!" unset
21789 .cindex "TLS" "requiring for certain servers"
21790 Exim will insist on using a TLS session when delivering to any host that
21791 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
21792 &*Note*&: This option affects outgoing mail only. To insist on TLS for
21793 incoming messages, use an appropriate ACL.
21794
21795 .option hosts_try_auth smtp "host list&!!" unset
21796 .cindex "authentication" "optional in client"
21797 This option provides a list of servers to which, provided they announce
21798 authentication support, Exim will attempt to authenticate as a client when it
21799 connects. If authentication fails, Exim will try to transfer the message
21800 unauthenticated. See also &%hosts_require_auth%&, and chapter
21801 &<<CHAPSMTPAUTH>>& for details of authentication.
21802
21803 .option interface smtp "string list&!!" unset
21804 .cindex "bind IP address"
21805 .cindex "IP address" "binding"
21806 .vindex "&$host$&"
21807 .vindex "&$host_address$&"
21808 This option specifies which interface to bind to when making an outgoing SMTP
21809 call. The value is an IP address, not an interface name such as
21810 &`eth0`&. Do not confuse this with the interface address that was used when a
21811 message was received, which is in &$received_ip_address$&, formerly known as
21812 &$interface_address$&. The name was changed to minimize confusion with the
21813 outgoing interface address. There is no variable that contains an outgoing
21814 interface address because, unless it is set by this option, its value is
21815 unknown.
21816
21817 During the expansion of the &%interface%& option the variables &$host$& and
21818 &$host_address$& refer to the host to which a connection is about to be made
21819 during the expansion of the string. Forced expansion failure, or an empty
21820 string result causes the option to be ignored. Otherwise, after expansion, the
21821 string must be a list of IP addresses, colon-separated by default, but the
21822 separator can be changed in the usual way. For example:
21823 .code
21824 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
21825 .endd
21826 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
21827 connection. If none of them are the correct type, the option is ignored. If
21828 &%interface%& is not set, or is ignored, the system's IP functions choose which
21829 interface to use if the host has more than one.
21830
21831
21832 .option keepalive smtp boolean true
21833 .cindex "keepalive" "on outgoing connection"
21834 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
21835 connections. When set, it causes the kernel to probe idle connections
21836 periodically, by sending packets with &"old"& sequence numbers. The other end
21837 of the connection should send a acknowledgment if the connection is still okay
21838 or a reset if the connection has been aborted. The reason for doing this is
21839 that it has the beneficial effect of freeing up certain types of connection
21840 that can get stuck when the remote host is disconnected without tidying up the
21841 TCP/IP call properly. The keepalive mechanism takes several hours to detect
21842 unreachable hosts.
21843
21844
21845 .option lmtp_ignore_quota smtp boolean false
21846 .cindex "LMTP" "ignoring quota errors"
21847 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
21848 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
21849 has advertised support for IGNOREQUOTA in its response to the LHLO command.
21850
21851 .option max_rcpt smtp integer 100
21852 .cindex "RCPT" "maximum number of outgoing"
21853 This option limits the number of RCPT commands that are sent in a single
21854 SMTP message transaction. Each set of addresses is treated independently, and
21855 so can cause parallel connections to the same host if &%remote_max_parallel%&
21856 permits this.
21857
21858
21859 .option multi_domain smtp boolean true
21860 .vindex "&$domain$&"
21861 When this option is set, the &(smtp)& transport can handle a number of
21862 addresses containing a mixture of different domains provided they all resolve
21863 to the same list of hosts. Turning the option off restricts the transport to
21864 handling only one domain at a time. This is useful if you want to use
21865 &$domain$& in an expansion for the transport, because it is set only when there
21866 is a single domain involved in a remote delivery.
21867
21868
21869 .option port smtp string&!! "see below"
21870 .cindex "port" "sending TCP/IP"
21871 .cindex "TCP/IP" "setting outgoing port"
21872 This option specifies the TCP/IP port on the server to which Exim connects.
21873 &*Note:*& Do not confuse this with the port that was used when a message was
21874 received, which is in &$received_port$&, formerly known as &$interface_port$&.
21875 The name was changed to minimize confusion with the outgoing port. There is no
21876 variable that contains an outgoing port.
21877
21878 If the value of this option begins with a digit it is taken as a port number;
21879 otherwise it is looked up using &[getservbyname()]&. The default value is
21880 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
21881 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
21882 is deferred.
21883
21884
21885
21886 .option protocol smtp string smtp
21887 .cindex "LMTP" "over TCP/IP"
21888 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
21889 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
21890 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
21891 deliveries into closed message stores. Exim also has support for running LMTP
21892 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
21893
21894
21895 .option retry_include_ip_address smtp boolean true
21896 Exim normally includes both the host name and the IP address in the key it
21897 constructs for indexing retry data after a temporary delivery failure. This
21898 means that when one of several IP addresses for a host is failing, it gets
21899 tried periodically (controlled by the retry rules), but use of the other IP
21900 addresses is not affected.
21901
21902 However, in some dialup environments hosts are assigned a different IP address
21903 each time they connect. In this situation the use of the IP address as part of
21904 the retry key leads to undesirable behaviour. Setting this option false causes
21905 Exim to use only the host name. This should normally be done on a separate
21906 instance of the &(smtp)& transport, set up specially to handle the dialup
21907 hosts.
21908
21909
21910 .option serialize_hosts smtp "host list&!!" unset
21911 .cindex "serializing connections"
21912 .cindex "host" "serializing connections"
21913 Because Exim operates in a distributed manner, if several messages for the same
21914 host arrive at around the same time, more than one simultaneous connection to
21915 the remote host can occur. This is not usually a problem except when there is a
21916 slow link between the hosts. In that situation it may be helpful to restrict
21917 Exim to one connection at a time. This can be done by setting
21918 &%serialize_hosts%& to match the relevant hosts.
21919
21920 .cindex "hints database" "serializing deliveries to a host"
21921 Exim implements serialization by means of a hints database in which a record is
21922 written whenever a process connects to one of the restricted hosts. The record
21923 is deleted when the connection is completed. Obviously there is scope for
21924 records to get left lying around if there is a system or program crash. To
21925 guard against this, Exim ignores any records that are more than six hours old.
21926
21927 If you set up this kind of serialization, you should also arrange to delete the
21928 relevant hints database whenever your system reboots. The names of the files
21929 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21930 may be one or two files, depending on the type of DBM in use. The same files
21931 are used for ETRN serialization.
21932
21933
21934 .option size_addition smtp integer 1024
21935 .cindex "SMTP" "SIZE"
21936 .cindex "message" "size issue for transport filter"
21937 .cindex "size" "of message"
21938 .cindex "transport" "filter"
21939 .cindex "filter" "transport filter"
21940 If a remote SMTP server indicates that it supports the SIZE option of the
21941 MAIL command, Exim uses this to pass over the message size at the start of
21942 an SMTP transaction. It adds the value of &%size_addition%& to the value it
21943 sends, to allow for headers and other text that may be added during delivery by
21944 configuration options or in a transport filter. It may be necessary to increase
21945 this if a lot of text is added to messages.
21946
21947 Alternatively, if the value of &%size_addition%& is set negative, it disables
21948 the use of the SIZE option altogether.
21949
21950
21951 .option tls_certificate smtp string&!! unset
21952 .cindex "TLS" "client certificate, location of"
21953 .cindex "certificate" "client, location of"
21954 .vindex "&$host$&"
21955 .vindex "&$host_address$&"
21956 The value of this option must be the absolute path to a file which contains the
21957 client's certificate, for possible use when sending a message over an encrypted
21958 connection. The values of &$host$& and &$host_address$& are set to the name and
21959 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
21960 details of TLS.
21961
21962 &*Note*&: This option must be set if you want Exim to be able to use a TLS
21963 certificate when sending messages as a client. The global option of the same
21964 name specifies the certificate for Exim as a server; it is not automatically
21965 assumed that the same certificate should be used when Exim is operating as a
21966 client.
21967
21968
21969 .option tls_crl smtp string&!! unset
21970 .cindex "TLS" "client certificate revocation list"
21971 .cindex "certificate" "revocation list for client"
21972 This option specifies a certificate revocation list. The expanded value must
21973 be the name of a file that contains a CRL in PEM format.
21974
21975
21976 .option tls_privatekey smtp string&!! unset
21977 .cindex "TLS" "client private key, location of"
21978 .vindex "&$host$&"
21979 .vindex "&$host_address$&"
21980 The value of this option must be the absolute path to a file which contains the
21981 client's private key. This is used when sending a message over an encrypted
21982 connection using a client certificate. The values of &$host$& and
21983 &$host_address$& are set to the name and address of the server during the
21984 expansion. If this option is unset, or the expansion is forced to fail, or the
21985 result is an empty string, the private key is assumed to be in the same file as
21986 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
21987
21988
21989 .option tls_require_ciphers smtp string&!! unset
21990 .cindex "TLS" "requiring specific ciphers"
21991 .cindex "cipher" "requiring specific"
21992 .vindex "&$host$&"
21993 .vindex "&$host_address$&"
21994 The value of this option must be a list of permitted cipher suites, for use
21995 when setting up an outgoing encrypted connection. (There is a global option of
21996 the same name for controlling incoming connections.) The values of &$host$& and
21997 &$host_address$& are set to the name and address of the server during the
21998 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
21999 is used in different ways by OpenSSL and GnuTLS (see sections
22000 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
22001 ciphers is a preference order.
22002
22003
22004
22005 .option tls_tempfail_tryclear smtp boolean true
22006 .cindex "4&'xx'& responses" "to STARTTLS"
22007 When the server host is not in &%hosts_require_tls%&, and there is a problem in
22008 setting up a TLS session, this option determines whether or not Exim should try
22009 to deliver the message unencrypted. If it is set false, delivery to the
22010 current host is deferred; if there are other hosts, they are tried. If this
22011 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
22012 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
22013 TLS negotiation fails, Exim closes the current connection (because it is in an
22014 unknown state), opens a new one to the same host, and then tries the delivery
22015 in clear.
22016
22017
22018 .option tls_verify_certificates smtp string&!! unset
22019 .cindex "TLS" "server certificate verification"
22020 .cindex "certificate" "verification of server"
22021 .vindex "&$host$&"
22022 .vindex "&$host_address$&"
22023 The value of this option must be the absolute path to a file containing
22024 permitted server certificates, for use when setting up an encrypted connection.
22025 Alternatively, if you are using OpenSSL, you can set
22026 &%tls_verify_certificates%& to the name of a directory containing certificate
22027 files. This does not work with GnuTLS; the option must be set to the name of a
22028 single file if you are using GnuTLS. The values of &$host$& and
22029 &$host_address$& are set to the name and address of the server during the
22030 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
22031
22032
22033
22034
22035 .section "How the limits for the number of hosts to try are used" &&&
22036          "SECTvalhosmax"
22037 .cindex "host" "maximum number to try"
22038 .cindex "limit" "hosts; maximum number tried"
22039 There are two options that are concerned with the number of hosts that are
22040 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
22041 &%hosts_max_try_hardlimit%&.
22042
22043
22044 The &%hosts_max_try%& option limits the number of hosts that are tried
22045 for a single delivery. However, despite the term &"host"& in its name, the
22046 option actually applies to each IP address independently. In other words, a
22047 multihomed host is treated as several independent hosts, just as it is for
22048 retrying.
22049
22050 Many of the larger ISPs have multiple MX records which often point to
22051 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
22052 created as a result of routing one of these domains.
22053
22054 Trying every single IP address on such a long list does not seem sensible; if
22055 several at the top of the list fail, it is reasonable to assume there is some
22056 problem that is likely to affect all of them. Roughly speaking, the value of
22057 &%hosts_max_try%& is the maximum number that are tried before deferring the
22058 delivery. However, the logic cannot be quite that simple.
22059
22060 Firstly, IP addresses that are skipped because their retry times have not
22061 arrived do not count, and in addition, addresses that are past their retry
22062 limits are also not counted, even when they are tried. This means that when
22063 some IP addresses are past their retry limits, more than the value of
22064 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
22065 that all IP addresses are considered before timing out an email address (but
22066 see below for an exception).
22067
22068 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
22069 list to see if there is a subsequent host with a different (higher valued) MX.
22070 If there is, that host is considered next, and the current IP address is used
22071 but not counted. This behaviour helps in the case of a domain with a retry rule
22072 that hardly ever delays any hosts, as is now explained:
22073
22074 Consider the case of a long list of hosts with one MX value, and a few with a
22075 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
22076 hosts at the top of the list are tried at first. With the default retry rule,
22077 which specifies increasing retry times, the higher MX hosts are eventually
22078 tried when those at the top of the list are skipped because they have not
22079 reached their retry times.
22080
22081 However, it is common practice to put a fixed short retry time on domains for
22082 large ISPs, on the grounds that their servers are rarely down for very long.
22083 Unfortunately, these are exactly the domains that tend to resolve to long lists
22084 of hosts. The short retry time means that the lowest MX hosts are tried every
22085 time. The attempts may be in a different order because of random sorting, but
22086 without the special MX check, the higher MX hosts would never be tried until
22087 all the lower MX hosts had timed out (which might be several days), because
22088 there are always some lower MX hosts that have reached their retry times. With
22089 the special check, Exim considers at least one IP address from each MX value at
22090 every delivery attempt, even if the &%hosts_max_try%& limit has already been
22091 reached.
22092
22093 The above logic means that &%hosts_max_try%& is not a hard limit, and in
22094 particular, Exim normally eventually tries all the IP addresses before timing
22095 out an email address. When &%hosts_max_try%& was implemented, this seemed a
22096 reasonable thing to do. Recently, however, some lunatic DNS configurations have
22097 been set up with hundreds of IP addresses for some domains. It can
22098 take a very long time indeed for an address to time out in these cases.
22099
22100 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
22101 Exim never tries more than this number of IP addresses; if it hits this limit
22102 and they are all timed out, the email address is bounced, even though not all
22103 possible IP addresses have been tried.
22104 .ecindex IIDsmttra1
22105 .ecindex IIDsmttra2
22106
22107
22108
22109
22110
22111 . ////////////////////////////////////////////////////////////////////////////
22112 . ////////////////////////////////////////////////////////////////////////////
22113
22114 .chapter "Address rewriting" "CHAPrewrite"
22115 .scindex IIDaddrew "rewriting" "addresses"
22116 There are some circumstances in which Exim automatically rewrites domains in
22117 addresses. The two most common are when an address is given without a domain
22118 (referred to as an &"unqualified address"&) or when an address contains an
22119 abbreviated domain that is expanded by DNS lookup.
22120
22121 Unqualified envelope addresses are accepted only for locally submitted
22122 messages, or for messages that are received from hosts matching
22123 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
22124 appropriate. Unqualified addresses in header lines are qualified if they are in
22125 locally submitted messages, or messages from hosts that are permitted to send
22126 unqualified envelope addresses. Otherwise, unqualified addresses in header
22127 lines are neither qualified nor rewritten.
22128
22129 One situation in which Exim does &'not'& automatically rewrite a domain is
22130 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
22131 such a domain should be rewritten using the &"canonical"& name, and some MTAs
22132 do this. The new RFCs do not contain this suggestion.
22133
22134
22135 .section "Explicitly configured address rewriting" "SECID147"
22136 This chapter describes the rewriting rules that can be used in the
22137 main rewrite section of the configuration file, and also in the generic
22138 &%headers_rewrite%& option that can be set on any transport.
22139
22140 Some people believe that configured address rewriting is a Mortal Sin.
22141 Others believe that life is not possible without it. Exim provides the
22142 facility; you do not have to use it.
22143
22144 The main rewriting rules that appear in the &"rewrite"& section of the
22145 configuration file are applied to addresses in incoming messages, both envelope
22146 addresses and addresses in header lines. Each rule specifies the types of
22147 address to which it applies.
22148
22149 Whether or not addresses in header lines are rewritten depends on the origin of
22150 the headers and the type of rewriting. Global rewriting, that is, rewriting
22151 rules from the rewrite section of the configuration file, is applied only to
22152 those headers that were received with the message. Header lines that are added
22153 by ACLs or by a system filter or by individual routers or transports (which
22154 are specific to individual recipient addresses) are not rewritten by the global
22155 rules.
22156
22157 Rewriting at transport time, by means of the &%headers_rewrite%& option,
22158 applies all headers except those added by routers and transports. That is, as
22159 well as the headers that were received with the message, it also applies to
22160 headers that were added by an ACL or a system filter.
22161
22162
22163 In general, rewriting addresses from your own system or domain has some
22164 legitimacy. Rewriting other addresses should be done only with great care and
22165 in special circumstances. The author of Exim believes that rewriting should be
22166 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
22167 Although it can sometimes be used as a routing tool, this is very strongly
22168 discouraged.
22169
22170 There are two commonly encountered circumstances where rewriting is used, as
22171 illustrated by these examples:
22172
22173 .ilist
22174 The company whose domain is &'hitch.fict.example'& has a number of hosts that
22175 exchange mail with each other behind a firewall, but there is only a single
22176 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
22177 &'hitch.fict.example'& when sending mail off-site.
22178 .next
22179 A host rewrites the local parts of its own users so that, for example,
22180 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
22181 .endlist
22182
22183
22184
22185 .section "When does rewriting happen?" "SECID148"
22186 .cindex "rewriting" "timing of"
22187 .cindex "&ACL;" "rewriting addresses in"
22188 Configured address rewriting can take place at several different stages of a
22189 message's processing.
22190
22191 .vindex "&$sender_address$&"
22192 At the start of an ACL for MAIL, the sender address may have been rewritten
22193 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
22194 ordinary rewrite rules have yet been applied. If, however, the sender address
22195 is verified in the ACL, it is rewritten before verification, and remains
22196 rewritten thereafter. The subsequent value of &$sender_address$& is the
22197 rewritten address. This also applies if sender verification happens in a
22198 RCPT ACL. Otherwise, when the sender address is not verified, it is
22199 rewritten as soon as a message's header lines have been received.
22200
22201 .vindex "&$domain$&"
22202 .vindex "&$local_part$&"
22203 Similarly, at the start of an ACL for RCPT, the current recipient's address
22204 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
22205 rewrite rules have yet been applied to it. However, the behaviour is different
22206 from the sender address when a recipient is verified. The address is rewritten
22207 for the verification, but the rewriting is not remembered at this stage. The
22208 value of &$local_part$& and &$domain$& after verification are always the same
22209 as they were before (that is, they contain the unrewritten &-- except for
22210 SMTP-time rewriting &-- address).
22211
22212 As soon as a message's header lines have been received, all the envelope
22213 recipient addresses are permanently rewritten, and rewriting is also applied to
22214 the addresses in the header lines (if configured). This happens before adding
22215 any header lines that were specified in MAIL or RCPT ACLs, and
22216 .cindex "&[local_scan()]& function" "address rewriting; timing of"
22217 before the DATA ACL and &[local_scan()]& functions are run.
22218
22219 When an address is being routed, either for delivery or for verification,
22220 rewriting is applied immediately to child addresses that are generated by
22221 redirection, unless &%no_rewrite%& is set on the router.
22222
22223 .cindex "envelope sender" "rewriting at transport time"
22224 .cindex "rewriting" "at transport time"
22225 .cindex "header lines" "rewriting at transport time"
22226 At transport time, additional rewriting of addresses in header lines can be
22227 specified by setting the generic &%headers_rewrite%& option on a transport.
22228 This option contains rules that are identical in form to those in the rewrite
22229 section of the configuration file. They are applied to the original message
22230 header lines and any that were added by ACLs or a system filter. They are not
22231 applied to header lines that are added by routers or the transport.
22232
22233 The outgoing envelope sender can be rewritten by means of the &%return_path%&
22234 transport option. However, it is not possible to rewrite envelope recipients at
22235 transport time.
22236
22237
22238
22239
22240 .section "Testing the rewriting rules that apply on input" "SECID149"
22241 .cindex "rewriting" "testing"
22242 .cindex "testing" "rewriting"
22243 Exim's input rewriting configuration appears in a part of the run time
22244 configuration file headed by &"begin rewrite"&. It can be tested by the
22245 &%-brw%& command line option. This takes an address (which can be a full RFC
22246 2822 address) as its argument. The output is a list of how the address would be
22247 transformed by the rewriting rules for each of the different places it might
22248 appear in an incoming message, that is, for each different header and for the
22249 envelope sender and recipient fields. For example,
22250 .code
22251 exim -brw ph10@exim.workshop.example
22252 .endd
22253 might produce the output
22254 .code
22255 sender: Philip.Hazel@exim.workshop.example
22256 from: Philip.Hazel@exim.workshop.example
22257 to: ph10@exim.workshop.example
22258 cc: ph10@exim.workshop.example
22259 bcc: ph10@exim.workshop.example
22260 reply-to: Philip.Hazel@exim.workshop.example
22261 env-from: Philip.Hazel@exim.workshop.example
22262 env-to: ph10@exim.workshop.example
22263 .endd
22264 which shows that rewriting has been set up for that address when used in any of
22265 the source fields, but not when it appears as a recipient address. At the
22266 present time, there is no equivalent way of testing rewriting rules that are
22267 set for a particular transport.
22268
22269
22270 .section "Rewriting rules" "SECID150"
22271 .cindex "rewriting" "rules"
22272 The rewrite section of the configuration file consists of lines of rewriting
22273 rules in the form
22274 .display
22275 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
22276 .endd
22277 Rewriting rules that are specified for the &%headers_rewrite%& generic
22278 transport option are given as a colon-separated list. Each item in the list
22279 takes the same form as a line in the main rewriting configuration (except that
22280 any colons must be doubled, of course).
22281
22282 The formats of source patterns and replacement strings are described below.
22283 Each is terminated by white space, unless enclosed in double quotes, in which
22284 case normal quoting conventions apply inside the quotes. The flags are single
22285 characters which may appear in any order. Spaces and tabs between them are
22286 ignored.
22287
22288 For each address that could potentially be rewritten, the rules are scanned in
22289 order, and replacements for the address from earlier rules can themselves be
22290 replaced by later rules (but see the &"q"& and &"R"& flags).
22291
22292 The order in which addresses are rewritten is undefined, may change between
22293 releases, and must not be relied on, with one exception: when a message is
22294 received, the envelope sender is always rewritten first, before any header
22295 lines are rewritten. For example, the replacement string for a rewrite of an
22296 address in &'To:'& must not assume that the message's address in &'From:'& has
22297 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
22298 that the envelope sender has already been rewritten.
22299
22300 .vindex "&$domain$&"
22301 .vindex "&$local_part$&"
22302 The variables &$local_part$& and &$domain$& can be used in the replacement
22303 string to refer to the address that is being rewritten. Note that lookup-driven
22304 rewriting can be done by a rule of the form
22305 .code
22306 *@*   ${lookup ...
22307 .endd
22308 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
22309 refer to the address that is being rewritten.
22310
22311
22312 .section "Rewriting patterns" "SECID151"
22313 .cindex "rewriting" "patterns"
22314 .cindex "address list" "in a rewriting pattern"
22315 The source pattern in a rewriting rule is any item which may appear in an
22316 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
22317 single-item address list, which means that it is expanded before being tested
22318 against the address. As always, if you use a regular expression as a pattern,
22319 you must take care to escape dollar and backslash characters, or use the &`\N`&
22320 facility to suppress string expansion within the regular expression.
22321
22322 Domains in patterns should be given in lower case. Local parts in patterns are
22323 case-sensitive. If you want to do case-insensitive matching of local parts, you
22324 can use a regular expression that starts with &`^(?i)`&.
22325
22326 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
22327 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
22328 depending on the type of match which occurred. These can be used in the
22329 replacement string to insert portions of the incoming address. &$0$& always
22330 refers to the complete incoming address. When a regular expression is used, the
22331 numerical variables are set from its capturing subexpressions. For other types
22332 of pattern they are set as follows:
22333
22334 .ilist
22335 If a local part or domain starts with an asterisk, the numerical variables
22336 refer to the character strings matched by asterisks, with &$1$& associated with
22337 the first asterisk, and &$2$& with the second, if present. For example, if the
22338 pattern
22339 .code
22340 *queen@*.fict.example
22341 .endd
22342 is matched against the address &'hearts-queen@wonderland.fict.example'& then
22343 .code
22344 $0 = hearts-queen@wonderland.fict.example
22345 $1 = hearts-
22346 $2 = wonderland
22347 .endd
22348 Note that if the local part does not start with an asterisk, but the domain
22349 does, it is &$1$& that contains the wild part of the domain.
22350
22351 .next
22352 If the domain part of the pattern is a partial lookup, the wild and fixed parts
22353 of the domain are placed in the next available numerical variables. Suppose,
22354 for example, that the address &'foo@bar.baz.example'& is processed by a
22355 rewriting rule of the form
22356 .display
22357 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
22358 .endd
22359 and the key in the file that matches the domain is &`*.baz.example`&. Then
22360 .code
22361 $1 = foo
22362 $2 = bar
22363 $3 = baz.example
22364 .endd
22365 If the address &'foo@baz.example'& is looked up, this matches the same
22366 wildcard file entry, and in this case &$2$& is set to the empty string, but
22367 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
22368 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
22369 whole domain. For non-partial domain lookups, no numerical variables are set.
22370 .endlist
22371
22372
22373 .section "Rewriting replacements" "SECID152"
22374 .cindex "rewriting" "replacements"
22375 If the replacement string for a rule is a single asterisk, addresses that
22376 match the pattern and the flags are &'not'& rewritten, and no subsequent
22377 rewriting rules are scanned. For example,
22378 .code
22379 hatta@lookingglass.fict.example  *  f
22380 .endd
22381 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
22382 &'From:'& headers.
22383
22384 .vindex "&$domain$&"
22385 .vindex "&$local_part$&"
22386 If the replacement string is not a single asterisk, it is expanded, and must
22387 yield a fully qualified address. Within the expansion, the variables
22388 &$local_part$& and &$domain$& refer to the address that is being rewritten.
22389 Any letters they contain retain their original case &-- they are not lower
22390 cased. The numerical variables are set up according to the type of pattern that
22391 matched the address, as described above. If the expansion is forced to fail by
22392 the presence of &"fail"& in a conditional or lookup item, rewriting by the
22393 current rule is abandoned, but subsequent rules may take effect. Any other
22394 expansion failure causes the entire rewriting operation to be abandoned, and an
22395 entry written to the panic log.
22396
22397
22398
22399 .section "Rewriting flags" "SECID153"
22400 There are three different kinds of flag that may appear on rewriting rules:
22401
22402 .ilist
22403 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
22404 c, f, h, r, s, t.
22405 .next
22406 A flag that specifies rewriting at SMTP time: S.
22407 .next
22408 Flags that control the rewriting process: Q, q, R, w.
22409 .endlist
22410
22411 For rules that are part of the &%headers_rewrite%& generic transport option,
22412 E, F, T, and S are not permitted.
22413
22414
22415
22416 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
22417          "SECID154"
22418 .cindex "rewriting" "flags"
22419 If none of the following flag letters, nor the &"S"& flag (see section
22420 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
22421 and to both the sender and recipient fields of the envelope, whereas a
22422 transport-time rewriting rule just applies to all headers. Otherwise, the
22423 rewriting rule is skipped unless the relevant addresses are being processed.
22424 .display
22425 &`E`&       rewrite all envelope fields
22426 &`F`&       rewrite the envelope From field
22427 &`T`&       rewrite the envelope To field
22428 &`b`&       rewrite the &'Bcc:'& header
22429 &`c`&       rewrite the &'Cc:'& header
22430 &`f`&       rewrite the &'From:'& header
22431 &`h`&       rewrite all headers
22432 &`r`&       rewrite the &'Reply-To:'& header
22433 &`s`&       rewrite the &'Sender:'& header
22434 &`t`&       rewrite the &'To:'& header
22435 .endd
22436 "All headers" means all of the headers listed above that can be selected
22437 individually, plus their &'Resent-'& versions. It does not include
22438 other headers such as &'Subject:'& etc.
22439
22440 You should be particularly careful about rewriting &'Sender:'& headers, and
22441 restrict this to special known cases in your own domains.
22442
22443
22444 .section "The SMTP-time rewriting flag" "SECTrewriteS"
22445 .cindex "SMTP" "rewriting malformed addresses"
22446 .cindex "RCPT" "rewriting argument of"
22447 .cindex "MAIL" "rewriting argument of"
22448 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
22449 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
22450 before any other processing; even before syntax checking. The pattern is
22451 required to be a regular expression, and it is matched against the whole of the
22452 data for the command, including any surrounding angle brackets.
22453
22454 .vindex "&$domain$&"
22455 .vindex "&$local_part$&"
22456 This form of rewrite rule allows for the handling of addresses that are not
22457 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
22458 input). Because the input is not required to be a syntactically valid address,
22459 the variables &$local_part$& and &$domain$& are not available during the
22460 expansion of the replacement string. The result of rewriting replaces the
22461 original address in the MAIL or RCPT command.
22462
22463
22464 .section "Flags controlling the rewriting process" "SECID155"
22465 There are four flags which control the way the rewriting process works. These
22466 take effect only when a rule is invoked, that is, when the address is of the
22467 correct type (matches the flags) and matches the pattern:
22468
22469 .ilist
22470 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
22471 unqualified local part. It is qualified with &%qualify_recipient%&. In the
22472 absence of &"Q"& the rewritten address must always include a domain.
22473 .next
22474 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
22475 even if no rewriting actually takes place because of a &"fail"& in the
22476 expansion. The &"q"& flag is not effective if the address is of the wrong type
22477 (does not match the flags) or does not match the pattern.
22478 .next
22479 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
22480 address, up to ten times. It can be combined with the &"q"& flag, to stop
22481 rewriting once it fails to match (after at least one successful rewrite).
22482 .next
22483 .cindex "rewriting" "whole addresses"
22484 When an address in a header is rewritten, the rewriting normally applies only
22485 to the working part of the address, with any comments and RFC 2822 &"phrase"&
22486 left unchanged. For example, rewriting might change
22487 .code
22488 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
22489 .endd
22490 into
22491 .code
22492 From: Ford Prefect <prefectf@hitch.fict.example>
22493 .endd
22494 .cindex "RFC 2047"
22495 Sometimes there is a need to replace the whole address item, and this can be
22496 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
22497 causes an address in a header line to be rewritten, the entire address is
22498 replaced, not just the working part. The replacement must be a complete RFC
22499 2822 address, including the angle brackets if necessary. If text outside angle
22500 brackets contains a character whose value is greater than 126 or less than 32
22501 (except for tab), the text is encoded according to RFC 2047. The character set
22502 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
22503
22504 When the &"w"& flag is set on a rule that causes an envelope address to be
22505 rewritten, all but the working part of the replacement address is discarded.
22506 .endlist
22507
22508
22509 .section "Rewriting examples" "SECID156"
22510 Here is an example of the two common rewriting paradigms:
22511 .code
22512 *@*.hitch.fict.example  $1@hitch.fict.example
22513 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
22514                      {$value}fail}@hitch.fict.example bctfrF
22515 .endd
22516 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
22517 the string expansion to fail if the lookup does not succeed. In this context it
22518 has the effect of leaving the original address unchanged, but Exim goes on to
22519 consider subsequent rewriting rules, if any, because the &"q"& flag is not
22520 present in that rule. An alternative to &"fail"& would be to supply &$1$&
22521 explicitly, which would cause the rewritten address to be the same as before,
22522 at the cost of a small bit of processing. Not supplying either of these is an
22523 error, since the rewritten address would then contain no local part.
22524
22525 The first example above replaces the domain with a superior, more general
22526 domain. This may not be desirable for certain local parts. If the rule
22527 .code
22528 root@*.hitch.fict.example  *
22529 .endd
22530 were inserted before the first rule, rewriting would be suppressed for the
22531 local part &'root'& at any domain ending in &'hitch.fict.example'&.
22532
22533 Rewriting can be made conditional on a number of tests, by making use of
22534 &${if$& in the expansion item. For example, to apply a rewriting rule only to
22535 messages that originate outside the local host:
22536 .code
22537 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
22538                          {$1@hitch.fict.example}fail}"
22539 .endd
22540 The replacement string is quoted in this example because it contains white
22541 space.
22542
22543 .cindex "rewriting" "bang paths"
22544 .cindex "bang paths" "rewriting"
22545 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
22546 an address it treats it as an unqualified local part which it qualifies with
22547 the local qualification domain (if the source of the message is local or if the
22548 remote host is permitted to send unqualified addresses). Rewriting can
22549 sometimes be used to handle simple bang paths with a fixed number of
22550 components. For example, the rule
22551 .code
22552 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
22553 .endd
22554 rewrites a two-component bang path &'host.name!user'& as the domain address
22555 &'user@host.name'&. However, there is a security implication in using this as
22556 a global rewriting rule for envelope addresses. It can provide a backdoor
22557 method for using your system as a relay, because the incoming addresses appear
22558 to be local. If the bang path addresses are received via SMTP, it is safer to
22559 use the &"S"& flag to rewrite them as they are received, so that relay checking
22560 can be done on the rewritten addresses.
22561 .ecindex IIDaddrew
22562
22563
22564
22565
22566
22567 . ////////////////////////////////////////////////////////////////////////////
22568 . ////////////////////////////////////////////////////////////////////////////
22569
22570 .chapter "Retry configuration" "CHAPretry"
22571 .scindex IIDretconf1 "retry" "configuration, description of"
22572 .scindex IIDregconf2 "configuration file" "retry section"
22573 The &"retry"& section of the runtime configuration file contains a list of
22574 retry rules that control how often Exim tries to deliver messages that cannot
22575 be delivered at the first attempt. If there are no retry rules (the section is
22576 empty or not present), there are no retries. In this situation, temporary
22577 errors are treated as permanent. The default configuration contains a single,
22578 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
22579 line option can be used to test which retry rule will be used for a given
22580 address, domain and error.
22581
22582 The most common cause of retries is temporary failure to deliver to a remote
22583 host because the host is down, or inaccessible because of a network problem.
22584 Exim's retry processing in this case is applied on a per-host (strictly, per IP
22585 address) basis, not on a per-message basis. Thus, if one message has recently
22586 been delayed, delivery of a new message to the same host is not immediately
22587 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
22588 log selector is set, the message
22589 .cindex "retry" "time not reached"
22590 &"retry time not reached"& is written to the main log whenever a delivery is
22591 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
22592 the handling of errors during remote deliveries.
22593
22594 Retry processing applies to routing as well as to delivering, except as covered
22595 in the next paragraph. The retry rules do not distinguish between these
22596 actions. It is not possible, for example, to specify different behaviour for
22597 failures to route the domain &'snark.fict.example'& and failures to deliver to
22598 the host &'snark.fict.example'&. I didn't think anyone would ever need this
22599 added complication, so did not implement it. However, although they share the
22600 same retry rule, the actual retry times for routing and transporting a given
22601 domain are maintained independently.
22602
22603 When a delivery is not part of a queue run (typically an immediate delivery on
22604 receipt of a message), the routers are always run, and local deliveries are
22605 always attempted, even if retry times are set for them. This makes for better
22606 behaviour if one particular message is causing problems (for example, causing
22607 quota overflow, or provoking an error in a filter file). If such a delivery
22608 suffers a temporary failure, the retry data is updated as normal, and
22609 subsequent delivery attempts from queue runs occur only when the retry time for
22610 the local address is reached.
22611
22612 .section "Changing retry rules" "SECID157"
22613 If you change the retry rules in your configuration, you should consider
22614 whether or not to delete the retry data that is stored in Exim's spool area in
22615 files with names like &_db/retry_&. Deleting any of Exim's hints files is
22616 always safe; that is why they are called &"hints"&.
22617
22618 The hints retry data contains suggested retry times based on the previous
22619 rules. In the case of a long-running problem with a remote host, it might
22620 record the fact that the host has timed out. If your new rules increase the
22621 timeout time for such a host, you should definitely remove the old retry data
22622 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
22623 messages that it should now be retaining.
22624
22625
22626
22627 .section "Format of retry rules" "SECID158"
22628 .cindex "retry" "rules"
22629 Each retry rule occupies one line and consists of three or four parts,
22630 separated by white space: a pattern, an error name, an optional list of sender
22631 addresses, and a list of retry parameters. The pattern and sender lists must be
22632 enclosed in double quotes if they contain white space. The rules are searched
22633 in order until one is found where the pattern, error name, and sender list (if
22634 present) match the failing host or address, the error that occurred, and the
22635 message's sender, respectively.
22636
22637
22638 The pattern is any single item that may appear in an address list (see section
22639 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
22640 which means that it is expanded before being tested against the address that
22641 has been delayed. A negated address list item is permitted. Address
22642 list processing treats a plain domain name as if it were preceded by &"*@"&,
22643 which makes it possible for many retry rules to start with just a domain. For
22644 example,
22645 .code
22646 lookingglass.fict.example        *  F,24h,30m;
22647 .endd
22648 provides a rule for any address in the &'lookingglass.fict.example'& domain,
22649 whereas
22650 .code
22651 alice@lookingglass.fict.example  *  F,24h,30m;
22652 .endd
22653 applies only to temporary failures involving the local part &%alice%&.
22654 In practice, almost all rules start with a domain name pattern without a local
22655 part.
22656
22657 .cindex "regular expressions" "in retry rules"
22658 &*Warning*&: If you use a regular expression in a routing rule pattern, it
22659 must match a complete address, not just a domain, because that is how regular
22660 expressions work in address lists.
22661 .display
22662 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
22663 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
22664 .endd
22665
22666
22667 .section "Choosing which retry rule to use for address errors" "SECID159"
22668 When Exim is looking for a retry rule after a routing attempt has failed (for
22669 example, after a DNS timeout), each line in the retry configuration is tested
22670 against the complete address only if &%retry_use_local_part%& is set for the
22671 router. Otherwise, only the domain is used, except when matching against a
22672 regular expression, when the local part of the address is replaced with &"*"&.
22673 A domain on its own can match a domain pattern, or a pattern that starts with
22674 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
22675 &%check_local_user%& is true, and false for other routers.
22676
22677 Similarly, when Exim is looking for a retry rule after a local delivery has
22678 failed (for example, after a mailbox full error), each line in the retry
22679 configuration is tested against the complete address only if
22680 &%retry_use_local_part%& is set for the transport (it defaults true for all
22681 local transports).
22682
22683 .cindex "4&'xx'& responses" "retry rules for"
22684 However, when Exim is looking for a retry rule after a remote delivery attempt
22685 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
22686 whole address is always used as the key when searching the retry rules. The
22687 rule that is found is used to create a retry time for the combination of the
22688 failing address and the message's sender. It is the combination of sender and
22689 recipient that is delayed in subsequent queue runs until its retry time is
22690 reached. You can delay the recipient without regard to the sender by setting
22691 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
22692 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
22693 commands.
22694
22695
22696
22697 .section "Choosing which retry rule to use for host and message errors" &&&
22698          "SECID160"
22699 For a temporary error that is not related to an individual address (for
22700 example, a connection timeout), each line in the retry configuration is checked
22701 twice. First, the name of the remote host is used as a domain name (preceded by
22702 &"*@"& when matching a regular expression). If this does not match the line,
22703 the domain from the email address is tried in a similar fashion. For example,
22704 suppose the MX records for &'a.b.c.example'& are
22705 .code
22706 a.b.c.example  MX  5  x.y.z.example
22707                MX  6  p.q.r.example
22708                MX  7  m.n.o.example
22709 .endd
22710 and the retry rules are
22711 .code
22712 p.q.r.example    *      F,24h,30m;
22713 a.b.c.example    *      F,4d,45m;
22714 .endd
22715 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
22716 first rule matches neither the host nor the domain, so Exim looks at the second
22717 rule. This does not match the host, but it does match the domain, so it is used
22718 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
22719 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
22720 first retry rule is used, because it matches the host.
22721
22722 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
22723 first rule to determine retry times, but for all the other hosts for the domain
22724 &'a.b.c.example'&, the second rule is used. The second rule is also used if
22725 routing to &'a.b.c.example'& suffers a temporary failure.
22726
22727 &*Note*&: The host name is used when matching the patterns, not its IP address.
22728 However, if a message is routed directly to an IP address without the use of a
22729 host name, for example, if a &(manualroute)& router contains a setting such as:
22730 .code
22731 route_list = *.a.example  192.168.34.23
22732 .endd
22733 then the &"host name"& that is used when searching for a retry rule is the
22734 textual form of the IP address.
22735
22736 .section "Retry rules for specific errors" "SECID161"
22737 .cindex "retry" "specific errors; specifying"
22738 The second field in a retry rule is the name of a particular error, or an
22739 asterisk, which matches any error. The errors that can be tested for are:
22740
22741 .vlist
22742 .vitem &%auth_failed%&
22743 Authentication failed when trying to send to a host in the
22744 &%hosts_require_auth%& list in an &(smtp)& transport.
22745
22746 .vitem &%data_4xx%&
22747 A 4&'xx'& error was received for an outgoing DATA command, either immediately
22748 after the command, or after sending the message's data.
22749
22750 .vitem &%mail_4xx%&
22751 A 4&'xx'& error was received for an outgoing MAIL command.
22752
22753 .vitem &%rcpt_4xx%&
22754 A 4&'xx'& error was received for an outgoing RCPT command.
22755 .endlist
22756
22757 For the three 4&'xx'& errors, either the first or both of the x's can be given
22758 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
22759 recognize 452 errors given to RCPT commands for addresses in a certain domain,
22760 and have retries every ten minutes with a one-hour timeout, you could set up a
22761 retry rule of this form:
22762 .code
22763 the.domain.name  rcpt_452   F,1h,10m
22764 .endd
22765 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
22766 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
22767
22768 .vlist
22769 .vitem &%lost_connection%&
22770 A server unexpectedly closed the SMTP connection. There may, of course,
22771 legitimate reasons for this (host died, network died), but if it repeats a lot
22772 for the same host, it indicates something odd.
22773
22774 .vitem &%refused_MX%&
22775 A connection to a host obtained from an MX record was refused.
22776
22777 .vitem &%refused_A%&
22778 A connection to a host not obtained from an MX record was refused.
22779
22780 .vitem &%refused%&
22781 A connection was refused.
22782
22783 .vitem &%timeout_connect_MX%&
22784 A connection attempt to a host obtained from an MX record timed out.
22785
22786 .vitem &%timeout_connect_A%&
22787 A connection attempt to a host not obtained from an MX record timed out.
22788
22789 .vitem &%timeout_connect%&
22790 A connection attempt timed out.
22791
22792 .vitem &%timeout_MX%&
22793 There was a timeout while connecting or during an SMTP session with a host
22794 obtained from an MX record.
22795
22796 .vitem &%timeout_A%&
22797 There was a timeout while connecting or during an SMTP session with a host not
22798 obtained from an MX record.
22799
22800 .vitem &%timeout%&
22801 There was a timeout while connecting or during an SMTP session.
22802
22803 .vitem &%tls_required%&
22804 The server was required to use TLS (it matched &%hosts_require_tls%& in the
22805 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
22806 to STARTTLS, or there was a problem setting up the TLS connection.
22807
22808 .vitem &%quota%&
22809 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
22810 transport.
22811
22812 .vitem &%quota_%&<&'time'&>
22813 .cindex "quota" "error testing in retry rule"
22814 .cindex "retry" "quota error testing"
22815 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
22816 transport, and the mailbox has not been accessed for <&'time'&>. For example,
22817 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
22818 for four days.
22819 .endlist
22820
22821 .cindex "mailbox" "time of last read"
22822 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
22823 timeouts when the mailbox is full and is not being read by its owner. Ideally,
22824 it should be based on the last time that the user accessed the mailbox.
22825 However, it is not always possible to determine this. Exim uses the following
22826 heuristic rules:
22827
22828 .ilist
22829 If the mailbox is a single file, the time of last access (the &"atime"&) is
22830 used. As no new messages are being delivered (because the mailbox is over
22831 quota), Exim does not access the file, so this is the time of last user access.
22832 .next
22833 .cindex "maildir format" "time of last read"
22834 For a maildir delivery, the time of last modification of the &_new_&
22835 subdirectory is used. As the mailbox is over quota, no new files are created in
22836 the &_new_& subdirectory, because no new messages are being delivered. Any
22837 change to the &_new_& subdirectory is therefore assumed to be the result of an
22838 MUA moving a new message to the &_cur_& directory when it is first read. The
22839 time that is used is therefore the last time that the user read a new message.
22840 .next
22841 For other kinds of multi-file mailbox, the time of last access cannot be
22842 obtained, so a retry rule that uses this type of error field is never matched.
22843 .endlist
22844
22845 The quota errors apply both to system-enforced quotas and to Exim's own quota
22846 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
22847 when a local delivery is deferred because a partition is full (the ENOSPC
22848 error).
22849
22850
22851
22852 .section "Retry rules for specified senders" "SECID162"
22853 .cindex "retry" "rules; sender-specific"
22854 You can specify retry rules that apply only when the failing message has a
22855 specific sender. In particular, this can be used to define retry rules that
22856 apply only to bounce messages. The third item in a retry rule can be of this
22857 form:
22858 .display
22859 &`senders=`&<&'address list'&>
22860 .endd
22861 The retry timings themselves are then the fourth item. For example:
22862 .code
22863 *   rcpt_4xx   senders=:   F,1h,30m
22864 .endd
22865 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
22866 host. If the address list contains white space, it must be enclosed in quotes.
22867 For example:
22868 .code
22869 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
22870 .endd
22871 &*Warning*&: This facility can be unhelpful if it is used for host errors
22872 (which do not depend on the recipient). The reason is that the sender is used
22873 only to match the retry rule. Once the rule has been found for a host error,
22874 its contents are used to set a retry time for the host, and this will apply to
22875 all messages, not just those with specific senders.
22876
22877 When testing retry rules using &%-brt%&, you can supply a sender using the
22878 &%-f%& command line option, like this:
22879 .code
22880 exim -f "" -brt user@dom.ain
22881 .endd
22882 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
22883 list is never matched.
22884
22885
22886
22887
22888
22889 .section "Retry parameters" "SECID163"
22890 .cindex "retry" "parameters in rules"
22891 The third (or fourth, if a senders list is present) field in a retry rule is a
22892 sequence of retry parameter sets, separated by semicolons. Each set consists of
22893 .display
22894 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
22895 .endd
22896 The letter identifies the algorithm for computing a new retry time; the cutoff
22897 time is the time beyond which this algorithm no longer applies, and the
22898 arguments vary the algorithm's action. The cutoff time is measured from the
22899 time that the first failure for the domain (combined with the local part if
22900 relevant) was detected, not from the time the message was received.
22901
22902 .cindex "retry" "algorithms"
22903 .cindex "retry" "fixed intervals"
22904 .cindex "retry" "increasing intervals"
22905 .cindex "retry" "random intervals"
22906 The available algorithms are:
22907
22908 .ilist
22909 &'F'&: retry at fixed intervals. There is a single time parameter specifying
22910 the interval.
22911 .next
22912 &'G'&: retry at geometrically increasing intervals. The first argument
22913 specifies a starting value for the interval, and the second a multiplier, which
22914 is used to increase the size of the interval at each retry.
22915 .next
22916 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
22917 retry, the previous interval is multiplied by the factor in order to get a
22918 maximum for the next interval. The minimum interval is the first argument of
22919 the parameter, and an actual interval is chosen randomly between them. Such a
22920 rule has been found to be helpful in cluster configurations when all the
22921 members of the cluster restart at once, and may therefore synchronize their
22922 queue processing times.
22923 .endlist
22924
22925 When computing the next retry time, the algorithm definitions are scanned in
22926 order until one whose cutoff time has not yet passed is reached. This is then
22927 used to compute a new retry time that is later than the current time. In the
22928 case of fixed interval retries, this simply means adding the interval to the
22929 current time. For geometrically increasing intervals, retry intervals are
22930 computed from the rule's parameters until one that is greater than the previous
22931 interval is found. The main configuration variable
22932 .cindex "limit" "retry interval"
22933 .cindex "retry" "interval, maximum"
22934 .oindex "&%retry_interval_max%&"
22935 &%retry_interval_max%& limits the maximum interval between retries. It
22936 cannot be set greater than &`24h`&, which is its default value.
22937
22938 A single remote domain may have a number of hosts associated with it, and each
22939 host may have more than one IP address. Retry algorithms are selected on the
22940 basis of the domain name, but are applied to each IP address independently. If,
22941 for example, a host has two IP addresses and one is unusable, Exim will
22942 generate retry times for it and will not try to use it until its next retry
22943 time comes. Thus the good IP address is likely to be tried first most of the
22944 time.
22945
22946 .cindex "hints database" "use for retrying"
22947 Retry times are hints rather than promises. Exim does not make any attempt to
22948 run deliveries exactly at the computed times. Instead, a queue runner process
22949 starts delivery processes for delayed messages periodically, and these attempt
22950 new deliveries only for those addresses that have passed their next retry time.
22951 If a new message arrives for a deferred address, an immediate delivery attempt
22952 occurs only if the address has passed its retry time. In the absence of new
22953 messages, the minimum time between retries is the interval between queue runner
22954 processes. There is not much point in setting retry times of five minutes if
22955 your queue runners happen only once an hour, unless there are a significant
22956 number of incoming messages (which might be the case on a system that is
22957 sending everything to a smart host, for example).
22958
22959 The data in the retry hints database can be inspected by using the
22960 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
22961 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
22962 &'exinext'& utility script can be used to find out what the next retry times
22963 are for the hosts associated with a particular mail domain, and also for local
22964 deliveries that have been deferred.
22965
22966
22967 .section "Retry rule examples" "SECID164"
22968 Here are some example retry rules:
22969 .code
22970 alice@wonderland.fict.example quota_5d  F,7d,3h
22971 wonderland.fict.example       quota_5d
22972 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
22973 lookingglass.fict.example     *         F,24h,30m;
22974 *                 refused_A   F,2h,20m;
22975 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
22976 .endd
22977 The first rule sets up special handling for mail to
22978 &'alice@wonderland.fict.example'& when there is an over-quota error and the
22979 mailbox has not been read for at least 5 days. Retries continue every three
22980 hours for 7 days. The second rule handles over-quota errors for all other local
22981 parts at &'wonderland.fict.example'&; the absence of a local part has the same
22982 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
22983 fail are bounced immediately if the mailbox has not been read for at least 5
22984 days.
22985
22986 The third rule handles all other errors at &'wonderland.fict.example'&; retries
22987 happen every 15 minutes for an hour, then with geometrically increasing
22988 intervals until two days have passed since a delivery first failed. After the
22989 first hour there is a delay of one hour, then two hours, then four hours, and
22990 so on (this is a rather extreme example).
22991
22992 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
22993 They happen every 30 minutes for 24 hours only. The remaining two rules handle
22994 all other domains, with special action for connection refusal from hosts that
22995 were not obtained from an MX record.
22996
22997 The final rule in a retry configuration should always have asterisks in the
22998 first two fields so as to provide a general catch-all for any addresses that do
22999 not have their own special handling. This example tries every 15 minutes for 2
23000 hours, then with intervals starting at one hour and increasing by a factor of
23001 1.5 up to 16 hours, then every 8 hours up to 5 days.
23002
23003
23004
23005 .section "Timeout of retry data" "SECID165"
23006 .cindex "timeout" "of retry data"
23007 .oindex "&%retry_data_expire%&"
23008 .cindex "hints database" "data expiry"
23009 .cindex "retry" "timeout of data"
23010 Exim timestamps the data that it writes to its retry hints database. When it
23011 consults the data during a delivery it ignores any that is older than the value
23012 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
23013 been tried for 7 days, Exim will try to deliver to it immediately a message
23014 arrives, and if that fails, it will calculate a retry time as if it were
23015 failing for the first time.
23016
23017 This improves the behaviour for messages routed to rarely-used hosts such as MX
23018 backups. If such a host was down at one time, and happens to be down again when
23019 Exim tries a month later, using the old retry data would imply that it had been
23020 down all the time, which is not a justified assumption.
23021
23022 If a host really is permanently dead, this behaviour causes a burst of retries
23023 every now and again, but only if messages routed to it are rare. If there is a
23024 message at least once every 7 days the retry data never expires.
23025
23026
23027
23028
23029 .section "Long-term failures" "SECID166"
23030 .cindex "delivery failure, long-term"
23031 .cindex "retry" "after long-term failure"
23032 Special processing happens when an email address has been failing for so long
23033 that the cutoff time for the last algorithm is reached. For example, using the
23034 default retry rule:
23035 .code
23036 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
23037 .endd
23038 the cutoff time is four days. Reaching the retry cutoff is independent of how
23039 long any specific message has been failing; it is the length of continuous
23040 failure for the recipient address that counts.
23041
23042 When the cutoff time is reached for a local delivery, or for all the IP
23043 addresses associated with a remote delivery, a subsequent delivery failure
23044 causes Exim to give up on the address, and a bounce message is generated.
23045 In order to cater for new messages that use the failing address, a next retry
23046 time is still computed from the final algorithm, and is used as follows:
23047
23048 For local deliveries, one delivery attempt is always made for any subsequent
23049 messages. If this delivery fails, the address fails immediately. The
23050 post-cutoff retry time is not used.
23051
23052 If the delivery is remote, there are two possibilities, controlled by the
23053 .oindex "&%delay_after_cutoff%&"
23054 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
23055 default. Until the post-cutoff retry time for one of the IP addresses is
23056 reached, the failing email address is bounced immediately, without a delivery
23057 attempt taking place. After that time, one new delivery attempt is made to
23058 those IP addresses that are past their retry times, and if that still fails,
23059 the address is bounced and new retry times are computed.
23060
23061 In other words, when all the hosts for a given email address have been failing
23062 for a long time, Exim bounces rather then defers until one of the hosts' retry
23063 times is reached. Then it tries once, and bounces if that attempt fails. This
23064 behaviour ensures that few resources are wasted in repeatedly trying to deliver
23065 to a broken destination, but if the host does recover, Exim will eventually
23066 notice.
23067
23068 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23069 addresses are past their final cutoff time, Exim tries to deliver to those IP
23070 addresses that have not been tried since the message arrived. If there are
23071 no suitable IP addresses, or if they all fail, the address is bounced. In other
23072 words, it does not delay when a new message arrives, but tries the expired
23073 addresses immediately, unless they have been tried since the message arrived.
23074 If there is a continuous stream of messages for the failing domains, setting
23075 &%delay_after_cutoff%& false means that there will be many more attempts to
23076 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
23077 true.
23078
23079 .section "Deliveries that work intermittently" "SECID167"
23080 .cindex "retry" "intermittently working deliveries"
23081 Some additional logic is needed to cope with cases where a host is
23082 intermittently available, or when a message has some attribute that prevents
23083 its delivery when others to the same address get through. In this situation,
23084 because some messages are successfully delivered, the &"retry clock"& for the
23085 host or address keeps getting reset by the successful deliveries, and so
23086 failing messages remain on the queue for ever because the cutoff time is never
23087 reached.
23088
23089 Two exceptional actions are applied to prevent this happening. The first
23090 applies to errors that are related to a message rather than a remote host.
23091 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
23092 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
23093 commands, and quota failures. For this type of error, if a message's arrival
23094 time is earlier than the &"first failed"& time for the error, the earlier time
23095 is used when scanning the retry rules to decide when to try next and when to
23096 time out the address.
23097
23098 The exceptional second action applies in all cases. If a message has been on
23099 the queue for longer than the cutoff time of any applicable retry rule for a
23100 given address, a delivery is attempted for that address, even if it is not yet
23101 time, and if this delivery fails, the address is timed out. A new retry time is
23102 not computed in this case, so that other messages for the same address are
23103 considered immediately.
23104 .ecindex IIDretconf1
23105 .ecindex IIDregconf2
23106
23107
23108
23109
23110
23111
23112 . ////////////////////////////////////////////////////////////////////////////
23113 . ////////////////////////////////////////////////////////////////////////////
23114
23115 .chapter "SMTP authentication" "CHAPSMTPAUTH"
23116 .scindex IIDauthconf1 "SMTP" "authentication configuration"
23117 .scindex IIDauthconf2 "authentication"
23118 The &"authenticators"& section of Exim's run time configuration is concerned
23119 with SMTP authentication. This facility is an extension to the SMTP protocol,
23120 described in RFC 2554, which allows a client SMTP host to authenticate itself
23121 to a server. This is a common way for a server to recognize clients that are
23122 permitted to use it as a relay. SMTP authentication is not of relevance to the
23123 transfer of mail between servers that have no managerial connection with each
23124 other.
23125
23126 .cindex "AUTH" "description of"
23127 Very briefly, the way SMTP authentication works is as follows:
23128
23129 .ilist
23130 The server advertises a number of authentication &'mechanisms'& in response to
23131 the client's EHLO command.
23132 .next
23133 The client issues an AUTH command, naming a specific mechanism. The command
23134 may, optionally, contain some authentication data.
23135 .next
23136 The server may issue one or more &'challenges'&, to which the client must send
23137 appropriate responses. In simple authentication mechanisms, the challenges are
23138 just prompts for user names and passwords. The server does not have to issue
23139 any challenges &-- in some mechanisms the relevant data may all be transmitted
23140 with the AUTH command.
23141 .next
23142 The server either accepts or denies authentication.
23143 .next
23144 If authentication succeeds, the client may optionally make use of the AUTH
23145 option on the MAIL command to pass an authenticated sender in subsequent
23146 mail transactions. Authentication lasts for the remainder of the SMTP
23147 connection.
23148 .next
23149 If authentication fails, the client may give up, or it may try a different
23150 authentication mechanism, or it may try transferring mail over the
23151 unauthenticated connection.
23152 .endlist
23153
23154 If you are setting up a client, and want to know which authentication
23155 mechanisms the server supports, you can use Telnet to connect to port 25 (the
23156 SMTP port) on the server, and issue an EHLO command. The response to this
23157 includes the list of supported mechanisms. For example:
23158 .display
23159 &`$ `&&*&`telnet server.example 25`&*&
23160 &`Trying 192.168.34.25...`&
23161 &`Connected to server.example.`&
23162 &`Escape character is &#x0027;^]&#x0027;.`&
23163 &`220 server.example ESMTP Exim 4.20 ...`&
23164 &*&`ehlo client.example`&*&
23165 &`250-server.example Hello client.example [10.8.4.5]`&
23166 &`250-SIZE 52428800`&
23167 &`250-PIPELINING`&
23168 &`250-AUTH PLAIN`&
23169 &`250 HELP`&
23170 .endd
23171 The second-last line of this example output shows that the server supports
23172 authentication using the PLAIN mechanism. In Exim, the different authentication
23173 mechanisms are configured by specifying &'authenticator'& drivers. Like the
23174 routers and transports, which authenticators are included in the binary is
23175 controlled by build-time definitions. The following are currently available,
23176 included by setting
23177 .code
23178 AUTH_CRAM_MD5=yes
23179 AUTH_CYRUS_SASL=yes
23180 AUTH_PLAINTEXT=yes
23181 AUTH_SPA=yes
23182 .endd
23183 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
23184 authentication mechanism (RFC 2195), and the second provides an interface to
23185 the Cyrus SASL authentication library. The third can be configured to support
23186 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
23187 not formally documented, but used by several MUAs. The fourth authenticator
23188 supports Microsoft's &'Secure Password Authentication'& mechanism.
23189
23190 The authenticators are configured using the same syntax as other drivers (see
23191 section &<<SECTfordricon>>&). If no authenticators are required, no
23192 authentication section need be present in the configuration file. Each
23193 authenticator can in principle have both server and client functions. When Exim
23194 is receiving SMTP mail, it is acting as a server; when it is sending out
23195 messages over SMTP, it is acting as a client. Authenticator configuration
23196 options are provided for use in both these circumstances.
23197
23198 To make it clear which options apply to which situation, the prefixes
23199 &%server_%& and &%client_%& are used on option names that are specific to
23200 either the server or the client function, respectively. Server and client
23201 functions are disabled if none of their options are set. If an authenticator is
23202 to be used for both server and client functions, a single definition, using
23203 both sets of options, is required. For example:
23204 .code
23205 cram:
23206   driver = cram_md5
23207   public_name = CRAM-MD5
23208   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
23209   client_name = ph10
23210   client_secret = secret2
23211 .endd
23212 The &%server_%& option is used when Exim is acting as a server, and the
23213 &%client_%& options when it is acting as a client.
23214
23215 Descriptions of the individual authenticators are given in subsequent chapters.
23216 The remainder of this chapter covers the generic options for the
23217 authenticators, followed by general discussion of the way authentication works
23218 in Exim.
23219
23220
23221
23222 .section "Generic options for authenticators" "SECID168"
23223 .cindex "authentication" "generic options"
23224 .cindex "options" "generic; for authenticators"
23225
23226 .option client_condition authenticators string&!! unset
23227 When Exim is authenticating as a client, it skips any authenticator whose
23228 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
23229 used, for example, to skip plain text authenticators when the connection is not
23230 encrypted by a setting such as:
23231 .code
23232 client_condition = ${if !eq{$tls_cipher}{}}
23233 .endd
23234 (Older documentation incorrectly states that &$tls_cipher$& contains the cipher
23235 used for incoming messages. In fact, during SMTP delivery, it contains the
23236 cipher used for the delivery.)
23237
23238
23239 .option driver authenticators string unset
23240 This option must always be set. It specifies which of the available
23241 authenticators is to be used.
23242
23243
23244 .option public_name authenticators string unset
23245 This option specifies the name of the authentication mechanism that the driver
23246 implements, and by which it is known to the outside world. These names should
23247 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
23248 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
23249 defaults to the driver's instance name.
23250
23251
23252 .option server_advertise_condition authenticators string&!! unset
23253 When a server is about to advertise an authentication mechanism, the condition
23254 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
23255 mechanism is not advertised.
23256 If the expansion fails, the mechanism is not advertised. If the failure was not
23257 forced, and was not caused by a lookup defer, the incident is logged.
23258 See section &<<SECTauthexiser>>& below for further discussion.
23259
23260
23261 .option server_condition authenticators string&!! unset
23262 This option must be set for a &%plaintext%& server authenticator, where it
23263 is used directly to control authentication. See section &<<SECTplainserver>>&
23264 for details.
23265
23266 For the other authenticators, &%server_condition%& can be used as an additional
23267 authentication or authorization mechanism that is applied after the other
23268 authenticator conditions succeed. If it is set, it is expanded when the
23269 authenticator would otherwise return a success code. If the expansion is forced
23270 to fail, authentication fails. Any other expansion failure causes a temporary
23271 error code to be returned. If the result of a successful expansion is an empty
23272 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23273 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
23274 other result, a temporary error code is returned, with the expanded string as
23275 the error text.
23276
23277
23278 .option server_debug_print authenticators string&!! unset
23279 If this option is set and authentication debugging is enabled (see the &%-d%&
23280 command line option), the string is expanded and included in the debugging
23281 output when the authenticator is run as a server. This can help with checking
23282 out the values of variables.
23283 If expansion of the string fails, the error message is written to the debugging
23284 output, and Exim carries on processing.
23285
23286
23287 .option server_set_id authenticators string&!! unset
23288 .vindex "&$authenticated_id$&"
23289 When an Exim server successfully authenticates a client, this string is
23290 expanded using data from the authentication, and preserved for any incoming
23291 messages in the variable &$authenticated_id$&. It is also included in the log
23292 lines for incoming messages. For example, a user/password authenticator
23293 configuration might preserve the user name that was used to authenticate, and
23294 refer to it subsequently during delivery of the message.
23295 If expansion fails, the option is ignored.
23296
23297
23298 .option server_mail_auth_condition authenticators string&!! unset
23299 This option allows a server to discard authenticated sender addresses supplied
23300 as part of MAIL commands in SMTP connections that are authenticated by the
23301 driver on which &%server_mail_auth_condition%& is set. The option is not used
23302 as part of the authentication process; instead its (unexpanded) value is
23303 remembered for later use.
23304 How it is used is described in the following section.
23305
23306
23307
23308
23309
23310 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
23311 .cindex "authentication" "sender; authenticated"
23312 .cindex "AUTH" "on MAIL command"
23313 When a client supplied an AUTH= item on a MAIL command, Exim applies
23314 the following checks before accepting it as the authenticated sender of the
23315 message:
23316
23317 .ilist
23318 If the connection is not using extended SMTP (that is, HELO was used rather
23319 than EHLO), the use of AUTH= is a syntax error.
23320 .next
23321 If the value of the AUTH= parameter is &"<>"&, it is ignored.
23322 .next
23323 .vindex "&$authenticated_sender$&"
23324 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
23325 running, the value of &$authenticated_sender$& is set to the value obtained
23326 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
23327 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
23328 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
23329 given for the MAIL command.
23330 .next
23331 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
23332 is accepted and placed in &$authenticated_sender$& only if the client has
23333 authenticated.
23334 .next
23335 If the AUTH= value was accepted by either of the two previous rules, and
23336 the client has authenticated, and the authenticator has a setting for the
23337 &%server_mail_auth_condition%&, the condition is checked at this point. The
23338 valued that was saved from the authenticator is expanded. If the expansion
23339 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
23340 &$authenticated_sender$& is deleted. If the expansion yields any other value,
23341 the value of &$authenticated_sender$& is retained and passed on with the
23342 message.
23343 .endlist
23344
23345
23346 When &$authenticated_sender$& is set for a message, it is passed on to other
23347 hosts to which Exim authenticates as a client. Do not confuse this value with
23348 &$authenticated_id$&, which is a string obtained from the authentication
23349 process, and which is not usually a complete email address.
23350
23351 .vindex "&$sender_address$&"
23352 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
23353 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
23354 therefore make use of &$authenticated_sender$&. The converse is not true: the
23355 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
23356 ACL is run.
23357
23358
23359
23360 .section "Authentication on an Exim server" "SECTauthexiser"
23361 .cindex "authentication" "on an Exim server"
23362 When Exim receives an EHLO command, it advertises the public names of those
23363 authenticators that are configured as servers, subject to the following
23364 conditions:
23365
23366 .ilist
23367 The client host must match &%auth_advertise_hosts%& (default *).
23368 .next
23369 It the &%server_advertise_condition%& option is set, its expansion must not
23370 yield the empty string, &"0"&, &"no"&, or &"false"&.
23371 .endlist
23372
23373 The order in which the authenticators are defined controls the order in which
23374 the mechanisms are advertised.
23375
23376 Some mail clients (for example, some versions of Netscape) require the user to
23377 provide a name and password for authentication whenever AUTH is advertised,
23378 even though authentication may not in fact be needed (for example, Exim may be
23379 set up to allow unconditional relaying from the client by an IP address check).
23380 You can make such clients more friendly by not advertising AUTH to them.
23381 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
23382 that runs for RCPT) to relay without authentication, you should set
23383 .code
23384 auth_advertise_hosts = ! 10.9.8.0/24
23385 .endd
23386 so that no authentication mechanisms are advertised to them.
23387
23388 The &%server_advertise_condition%& controls the advertisement of individual
23389 authentication mechanisms. For example, it can be used to restrict the
23390 advertisement of a particular mechanism to encrypted connections, by a setting
23391 such as:
23392 .code
23393 server_advertise_condition = ${if eq{$tls_cipher}{}{no}{yes}}
23394 .endd
23395 .vindex "&$tls_cipher$&"
23396 If the session is encrypted, &$tls_cipher$& is not empty, and so the expansion
23397 yields &"yes"&, which allows the advertisement to happen.
23398
23399 When an Exim server receives an AUTH command from a client, it rejects it
23400 immediately if AUTH was not advertised in response to an earlier EHLO
23401 command. This is the case if
23402
23403 .ilist
23404 The client host does not match &%auth_advertise_hosts%&; or
23405 .next
23406 No authenticators are configured with server options; or
23407 .next
23408 Expansion of &%server_advertise_condition%& blocked the advertising of all the
23409 server authenticators.
23410 .endlist
23411
23412
23413 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
23414 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
23415 AUTH is accepted from any client host.
23416
23417 If AUTH is not rejected by the ACL, Exim searches its configuration for a
23418 server authentication mechanism that was advertised in response to EHLO and
23419 that matches the one named in the AUTH command. If it finds one, it runs
23420 the appropriate authentication protocol, and authentication either succeeds or
23421 fails. If there is no matching advertised mechanism, the AUTH command is
23422 rejected with a 504 error.
23423
23424 .vindex "&$received_protocol$&"
23425 .vindex "&$sender_host_authenticated$&"
23426 When a message is received from an authenticated host, the value of
23427 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
23428 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
23429 public name) of the authenticator driver that successfully authenticated the
23430 client from which the message was received. This variable is empty if there was
23431 no successful authentication.
23432
23433
23434
23435
23436 .section "Testing server authentication" "SECID169"
23437 .cindex "authentication" "testing a server"
23438 .cindex "AUTH" "testing a server"
23439 .cindex "base64 encoding" "creating authentication test data"
23440 Exim's &%-bh%& option can be useful for testing server authentication
23441 configurations. The data for the AUTH command has to be sent using base64
23442 encoding. A quick way to produce such data for testing is the following Perl
23443 script:
23444 .code
23445 use MIME::Base64;
23446 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
23447 .endd
23448 .cindex "binary zero" "in authentication data"
23449 This interprets its argument as a Perl string, and then encodes it. The
23450 interpretation as a Perl string allows binary zeros, which are required for
23451 some kinds of authentication, to be included in the data. For example, a
23452 command line to run this script on such data might be
23453 .code
23454 encode '\0user\0password'
23455 .endd
23456 Note the use of single quotes to prevent the shell interpreting the
23457 backslashes, so that they can be interpreted by Perl to specify characters
23458 whose code value is zero.
23459
23460 &*Warning 1*&: If either of the user or password strings starts with an octal
23461 digit, you must use three zeros instead of one after the leading backslash. If
23462 you do not, the octal digit that starts your string will be incorrectly
23463 interpreted as part of the code for the first character.
23464
23465 &*Warning 2*&: If there are characters in the strings that Perl interprets
23466 specially, you must use a Perl escape to prevent them being misinterpreted. For
23467 example, a command such as
23468 .code
23469 encode '\0user@domain.com\0pas$$word'
23470 .endd
23471 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
23472
23473 If you have the &%mimencode%& command installed, another way to do produce
23474 base64-encoded strings is to run the command
23475 .code
23476 echo -e -n `\0user\0password' | mimencode
23477 .endd
23478 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
23479 in the argument, and the &%-n%& option specifies no newline at the end of its
23480 output. However, not all versions of &%echo%& recognize these options, so you
23481 should check your version before relying on this suggestion.
23482
23483
23484
23485 .section "Authentication by an Exim client" "SECID170"
23486 .cindex "authentication" "on an Exim client"
23487 The &(smtp)& transport has two options called &%hosts_require_auth%& and
23488 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
23489 announces support for authentication, and the host matches an entry in either
23490 of these options, Exim (as a client) tries to authenticate as follows:
23491
23492 .ilist
23493 For each authenticator that is configured as a client, in the order in which
23494 they are defined in the configuration, it searches the authentication
23495 mechanisms announced by the server for one whose name matches the public name
23496 of the authenticator.
23497 .next
23498 .vindex "&$host$&"
23499 .vindex "&$host_address$&"
23500 When it finds one that matches, it runs the authenticator's client code. The
23501 variables &$host$& and &$host_address$& are available for any string expansions
23502 that the client might do. They are set to the server's name and IP address. If
23503 any expansion is forced to fail, the authentication attempt is abandoned, and
23504 Exim moves on to the next authenticator. Otherwise an expansion failure causes
23505 delivery to be deferred.
23506 .next
23507 If the result of the authentication attempt is a temporary error or a timeout,
23508 Exim abandons trying to send the message to the host for the moment. It will
23509 try again later. If there are any backup hosts available, they are tried in the
23510 usual way.
23511 .next
23512 If the response to authentication is a permanent error (5&'xx'& code), Exim
23513 carries on searching the list of authenticators and tries another one if
23514 possible. If all authentication attempts give permanent errors, or if there are
23515 no attempts because no mechanisms match (or option expansions force failure),
23516 what happens depends on whether the host matches &%hosts_require_auth%& or
23517 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
23518 delivery is deferred. The error can be detected in the retry rules, and thereby
23519 turned into a permanent error if you wish. In the second case, Exim tries to
23520 deliver the message unauthenticated.
23521 .endlist
23522
23523 .cindex "AUTH" "on MAIL command"
23524 When Exim has authenticated itself to a remote server, it adds the AUTH
23525 parameter to the MAIL commands it sends, if it has an authenticated sender for
23526 the message. If the message came from a remote host, the authenticated sender
23527 is the one that was receiving on an incoming MAIL command, provided that the
23528 incoming connection was authenticated and the &%server_mail_auth%& condition
23529 allowed the authenticated sender to be retained. If a local process calls Exim
23530 to send a message, the sender address that is built from the login name and
23531 &%qualify_domain%& is treated as authenticated. However, if the
23532 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
23533 the authenticated sender that was received with the message.
23534 .ecindex IIDauthconf1
23535 .ecindex IIDauthconf2
23536
23537
23538
23539
23540
23541
23542 . ////////////////////////////////////////////////////////////////////////////
23543 . ////////////////////////////////////////////////////////////////////////////
23544
23545 .chapter "The plaintext authenticator" "CHAPplaintext"
23546 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
23547 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
23548 The &(plaintext)& authenticator can be configured to support the PLAIN and
23549 LOGIN authentication mechanisms, both of which transfer authentication data as
23550 plain (unencrypted) text (though base64 encoded). The use of plain text is a
23551 security risk; you are strongly advised to insist on the use of SMTP encryption
23552 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
23553 use unencrypted plain text, you should not use the same passwords for SMTP
23554 connections as you do for login accounts.
23555
23556 .section "Plaintext options" "SECID171"
23557 .cindex "options" "&(plaintext)& authenticator (server)"
23558 When configured as a server, &(plaintext)& uses the following options:
23559
23560 .option server_condition authenticators string&!! unset
23561 This is actually a global authentication option, but it must be set in order to
23562 configure the &(plaintext)& driver as a server. Its use is described below.
23563
23564 .option server_prompts plaintext string&!! unset
23565 The contents of this option, after expansion, must be a colon-separated list of
23566 prompt strings. If expansion fails, a temporary authentication rejection is
23567 given.
23568
23569 .section "Using plaintext in a server" "SECTplainserver"
23570 .cindex "AUTH" "in &(plaintext)& authenticator"
23571 .cindex "binary zero" "in &(plaintext)& authenticator"
23572 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
23573         "in &(plaintext)& authenticator"
23574 .vindex "&$auth1$&, &$auth2$&, etc"
23575 .cindex "base64 encoding" "in &(plaintext)& authenticator"
23576
23577 When running as a server, &(plaintext)& performs the authentication test by
23578 expanding a string. The data sent by the client with the AUTH command, or in
23579 response to subsequent prompts, is base64 encoded, and so may contain any byte
23580 values when decoded. If any data is supplied with the command, it is treated as
23581 a list of strings, separated by NULs (binary zeros), the first three of which
23582 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
23583 (neither LOGIN nor PLAIN uses more than three strings).
23584
23585 For compatibility with previous releases of Exim, the values are also placed in
23586 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
23587 variables for this purpose is now deprecated, as it can lead to confusion in
23588 string expansions that also use them for other things.
23589
23590 If there are more strings in &%server_prompts%& than the number of strings
23591 supplied with the AUTH command, the remaining prompts are used to obtain more
23592 data. Each response from the client may be a list of NUL-separated strings.
23593
23594 .vindex "&$authenticated_id$&"
23595 Once a sufficient number of data strings have been received,
23596 &%server_condition%& is expanded. If the expansion is forced to fail,
23597 authentication fails. Any other expansion failure causes a temporary error code
23598 to be returned. If the result of a successful expansion is an empty string,
23599 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23600 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
23601 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
23602 For any other result, a temporary error code is returned, with the expanded
23603 string as the error text.
23604
23605 &*Warning*&: If you use a lookup in the expansion to find the user's
23606 password, be sure to make the authentication fail if the user is unknown.
23607 There are good and bad examples at the end of the next section.
23608
23609
23610
23611 .section "The PLAIN authentication mechanism" "SECID172"
23612 .cindex "PLAIN authentication mechanism"
23613 .cindex "authentication" "PLAIN mechanism"
23614 .cindex "binary zero" "in &(plaintext)& authenticator"
23615 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
23616 sent as one item of data (that is, one combined string containing two NUL
23617 separators). The data is sent either as part of the AUTH command, or
23618 subsequently in response to an empty prompt from the server.
23619
23620 The second and third strings are a user name and a corresponding password.
23621 Using a single fixed user name and password as an example, this could be
23622 configured as follows:
23623 .code
23624 fixed_plain:
23625   driver = plaintext
23626   public_name = PLAIN
23627   server_prompts = :
23628   server_condition = \
23629     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
23630   server_set_id = $auth2
23631 .endd
23632 Note that the default result strings from &%if%& (&"true"& or an empty string)
23633 are exactly what we want here, so they need not be specified. Obviously, if the
23634 password contains expansion-significant characters such as dollar, backslash,
23635 or closing brace, they have to be escaped.
23636
23637 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
23638 the end of a string list are ignored). If all the data comes as part of the
23639 AUTH command, as is commonly the case, the prompt is not used. This
23640 authenticator is advertised in the response to EHLO as
23641 .code
23642 250-AUTH PLAIN
23643 .endd
23644 and a client host can authenticate itself by sending the command
23645 .code
23646 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
23647 .endd
23648 As this contains three strings (more than the number of prompts), no further
23649 data is required from the client. Alternatively, the client may just send
23650 .code
23651 AUTH PLAIN
23652 .endd
23653 to initiate authentication, in which case the server replies with an empty
23654 prompt. The client must respond with the combined data string.
23655
23656 The data string is base64 encoded, as required by the RFC. This example,
23657 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
23658 represents a zero byte. This is split up into three strings, the first of which
23659 is empty. The &%server_condition%& option in the authenticator checks that the
23660 second two are &`username`& and &`mysecret`& respectively.
23661
23662 Having just one fixed user name and password, as in this example, is not very
23663 realistic, though for a small organization with only a handful of
23664 authenticating clients it could make sense.
23665
23666 A more sophisticated instance of this authenticator could use the user name in
23667 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
23668 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
23669 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
23670 This is an incorrect example:
23671 .code
23672 server_condition = \
23673   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
23674 .endd
23675 The expansion uses the user name (&$auth2$&) as the key to look up a password,
23676 which it then compares to the supplied password (&$auth3$&). Why is this example
23677 incorrect? It works fine for existing users, but consider what happens if a
23678 non-existent user name is given. The lookup fails, but as no success/failure
23679 strings are given for the lookup, it yields an empty string. Thus, to defeat
23680 the authentication, all a client has to do is to supply a non-existent user
23681 name and an empty password. The correct way of writing this test is:
23682 .code
23683 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
23684   {${if eq{$value}{$auth3}}} {false}}
23685 .endd
23686 In this case, if the lookup succeeds, the result is checked; if the lookup
23687 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
23688 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
23689 always fails if its second argument is empty. However, the second way of
23690 writing the test makes the logic clearer.
23691
23692
23693 .section "The LOGIN authentication mechanism" "SECID173"
23694 .cindex "LOGIN authentication mechanism"
23695 .cindex "authentication" "LOGIN mechanism"
23696 The LOGIN authentication mechanism is not documented in any RFC, but is in use
23697 in a number of programs. No data is sent with the AUTH command. Instead, a
23698 user name and password are supplied separately, in response to prompts. The
23699 plaintext authenticator can be configured to support this as in this example:
23700 .code
23701 fixed_login:
23702   driver = plaintext
23703   public_name = LOGIN
23704   server_prompts = User Name : Password
23705   server_condition = \
23706     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
23707   server_set_id = $auth1
23708 .endd
23709 Because of the way plaintext operates, this authenticator accepts data supplied
23710 with the AUTH command (in contravention of the specification of LOGIN), but
23711 if the client does not supply it (as is the case for LOGIN clients), the prompt
23712 strings are used to obtain two data items.
23713
23714 Some clients are very particular about the precise text of the prompts. For
23715 example, Outlook Express is reported to recognize only &"Username:"& and
23716 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
23717 strings. It uses the &%ldapauth%& expansion condition to check the user
23718 name and password by binding to an LDAP server:
23719 .code
23720 login:
23721   driver = plaintext
23722   public_name = LOGIN
23723   server_prompts = Username:: : Password::
23724   server_condition = ${if and{{
23725     !eq{}{$auth1} }{ \
23726     ldapauth{user="cn=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
23727              pass=${quote:$auth2} \
23728              ldap://ldap.example.org/} }} }
23729   server_set_id = uid=$auth1,ou=people,o=example.org
23730 .endd
23731 We have to check that the username is not empty before using it, because LDAP
23732 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
23733 operator to correctly quote the DN for authentication. However, the basic
23734 &%quote%& operator, rather than any of the LDAP quoting operators, is the
23735 correct one to use for the password, because quoting is needed only to make
23736 the password conform to the Exim syntax. At the LDAP level, the password is an
23737 uninterpreted string.
23738
23739
23740 .section "Support for different kinds of authentication" "SECID174"
23741 A number of string expansion features are provided for the purpose of
23742 interfacing to different ways of user authentication. These include checking
23743 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
23744 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
23745 &<<SECTexpcond>>&.
23746
23747
23748
23749
23750 .section "Using plaintext in a client" "SECID175"
23751 .cindex "options" "&(plaintext)& authenticator (client)"
23752 The &(plaintext)& authenticator has two client options:
23753
23754 .option client_ignore_invalid_base64 plaintext boolean false
23755 If the client receives a server prompt that is not a valid base64 string,
23756 authentication is abandoned by default. However, if this option is set true,
23757 the error in the challenge is ignored and the client sends the response as
23758 usual.
23759
23760 .option client_send plaintext string&!! unset
23761 The string is a colon-separated list of authentication data strings. Each
23762 string is independently expanded before being sent to the server. The first
23763 string is sent with the AUTH command; any more strings are sent in response
23764 to prompts from the server. Before each string is expanded, the value of the
23765 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
23766 with &$auth1$& for the first prompt. Up to three prompts are stored in this
23767 way. Thus, the prompt that is received in response to sending the first string
23768 (with the AUTH command) can be used in the expansion of the second string, and
23769 so on. If an invalid base64 string is received when
23770 &%client_ignore_invalid_base64%& is set, an empty string is put in the
23771 &$auth$&<&'n'&> variable.
23772
23773 &*Note*&: You cannot use expansion to create multiple strings, because
23774 splitting takes priority and happens first.
23775
23776 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
23777 the data, further processing is applied to each string before it is sent. If
23778 there are any single circumflex characters in the string, they are converted to
23779 NULs. Should an actual circumflex be required as data, it must be doubled in
23780 the string.
23781
23782 This is an example of a client configuration that implements the PLAIN
23783 authentication mechanism with a fixed user name and password:
23784 .code
23785 fixed_plain:
23786   driver = plaintext
23787   public_name = PLAIN
23788   client_send = ^username^mysecret
23789 .endd
23790 The lack of colons means that the entire text is sent with the AUTH
23791 command, with the circumflex characters converted to NULs. A similar example
23792 that uses the LOGIN mechanism is:
23793 .code
23794 fixed_login:
23795   driver = plaintext
23796   public_name = LOGIN
23797   client_send = : username : mysecret
23798 .endd
23799 The initial colon means that the first string is empty, so no data is sent with
23800 the AUTH command itself. The remaining strings are sent in response to
23801 prompts.
23802 .ecindex IIDplaiauth1
23803 .ecindex IIDplaiauth2
23804
23805
23806
23807
23808 . ////////////////////////////////////////////////////////////////////////////
23809 . ////////////////////////////////////////////////////////////////////////////
23810
23811 .chapter "The cram_md5 authenticator" "CHID9"
23812 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
23813 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
23814 .cindex "CRAM-MD5 authentication mechanism"
23815 .cindex "authentication" "CRAM-MD5 mechanism"
23816 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
23817 sends a challenge string to the client, and the response consists of a user
23818 name and the CRAM-MD5 digest of the challenge string combined with a secret
23819 string (password) which is known to both server and client. Thus, the secret
23820 is not sent over the network as plain text, which makes this authenticator more
23821 secure than &(plaintext)&. However, the downside is that the secret has to be
23822 available in plain text at either end.
23823
23824
23825 .section "Using cram_md5 as a server" "SECID176"
23826 .cindex "options" "&(cram_md5)& authenticator (server)"
23827 This authenticator has one server option, which must be set to configure the
23828 authenticator as a server:
23829
23830 .option server_secret cram_md5 string&!! unset
23831 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
23832 When the server receives the client's response, the user name is placed in
23833 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
23834 obtain the password for that user. The server then computes the CRAM-MD5 digest
23835 that the client should have sent, and checks that it received the correct
23836 string. If the expansion of &%server_secret%& is forced to fail, authentication
23837 fails. If the expansion fails for some other reason, a temporary error code is
23838 returned to the client.
23839
23840 For compatibility with previous releases of Exim, the user name is also placed
23841 in &$1$&. However, the use of this variables for this purpose is now
23842 deprecated, as it can lead to confusion in string expansions that also use
23843 numeric variables for other things.
23844
23845 For example, the following authenticator checks that the user name given by the
23846 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
23847 user name, authentication fails.
23848 .code
23849 fixed_cram:
23850   driver = cram_md5
23851   public_name = CRAM-MD5
23852   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
23853   server_set_id = $auth1
23854 .endd
23855 .vindex "&$authenticated_id$&"
23856 If authentication succeeds, the setting of &%server_set_id%& preserves the user
23857 name in &$authenticated_id$&. A more typical configuration might look up the
23858 secret string in a file, using the user name as the key. For example:
23859 .code
23860 lookup_cram:
23861   driver = cram_md5
23862   public_name = CRAM-MD5
23863   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
23864                   {$value}fail}
23865   server_set_id = $auth1
23866 .endd
23867 Note that this expansion explicitly forces failure if the lookup fails
23868 because &$auth1$& contains an unknown user name.
23869
23870
23871 .section "Using cram_md5 as a client" "SECID177"
23872 .cindex "options" "&(cram_md5)& authenticator (client)"
23873 When used as a client, the &(cram_md5)& authenticator has two options:
23874
23875
23876
23877 .option client_name cram_md5 string&!! "the primary host name"
23878 This string is expanded, and the result used as the user name data when
23879 computing the response to the server's challenge.
23880
23881
23882 .option client_secret cram_md5 string&!! unset
23883 This option must be set for the authenticator to work as a client. Its value is
23884 expanded and the result used as the secret string when computing the response.
23885
23886
23887 .vindex "&$host$&"
23888 .vindex "&$host_address$&"
23889 Different user names and secrets can be used for different servers by referring
23890 to &$host$& or &$host_address$& in the options. Forced failure of either
23891 expansion string is treated as an indication that this authenticator is not
23892 prepared to handle this case. Exim moves on to the next configured client
23893 authenticator. Any other expansion failure causes Exim to give up trying to
23894 send the message to the current server.
23895
23896 A simple example configuration of a &(cram_md5)& authenticator, using fixed
23897 strings, is:
23898 .code
23899 fixed_cram:
23900   driver = cram_md5
23901   public_name = CRAM-MD5
23902   client_name = ph10
23903   client_secret = secret
23904 .endd
23905 .ecindex IIDcramauth1
23906 .ecindex IIDcramauth2
23907
23908
23909
23910 . ////////////////////////////////////////////////////////////////////////////
23911 . ////////////////////////////////////////////////////////////////////////////
23912
23913 .chapter "The cyrus_sasl authenticator" "CHID10"
23914 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
23915 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
23916 .cindex "Cyrus" "SASL library"
23917 .cindex "Kerberos"
23918 The code for this authenticator was provided by Matthew Byng-Maddick of A L
23919 Digital Ltd (&url(http://www.aldigital.co.uk)).
23920
23921 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
23922 library implementation of the RFC 2222 (&"Simple Authentication and Security
23923 Layer"&). This library supports a number of authentication mechanisms,
23924 including PLAIN and LOGIN, but also several others that Exim does not support
23925 directly. In particular, there is support for Kerberos authentication.
23926
23927 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
23928 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
23929 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
23930 name of the driver to determine which mechanism to support.
23931
23932 Where access to some kind of secret file is required, for example in GSSAPI
23933 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
23934 user, and that the Cyrus SASL library has no way of escalating privileges
23935 by default. You may also find you need to set environment variables,
23936 depending on the driver you are using.
23937
23938 The application name provided by Exim is &"exim"&, so various SASL options may
23939 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
23940 Kerberos, note that because of limitations in the GSSAPI interface,
23941 changing the server keytab might need to be communicated down to the Kerberos
23942 layer independently. The mechanism for doing so is dependent upon the Kerberos
23943 implementation. For example, for Heimdal, the environment variable KRB5_KTNAME
23944 may be set to point to an alternative keytab file. Exim will pass this
23945 variable through from its own inherited environment when started as root or the
23946 Exim user. The keytab file needs to be readable by the Exim user.
23947
23948
23949 .section "Using cyrus_sasl as a server" "SECID178"
23950 The &(cyrus_sasl)& authenticator has four private options. It puts the username
23951 (on a successful authentication) into &$auth1$&. For compatibility with
23952 previous releases of Exim, the username is also placed in &$1$&. However, the
23953 use of this variable for this purpose is now deprecated, as it can lead to
23954 confusion in string expansions that also use numeric variables for other
23955 things.
23956
23957
23958 .option server_hostname cyrus_sasl string&!! "see below"
23959 This option selects the hostname that is used when communicating with the
23960 library. The default value is &`$primary_hostname`&. It is up to the underlying
23961 SASL plug-in what it does with this data.
23962
23963
23964 .option server_mech cyrus_sasl string "see below"
23965 This option selects the authentication mechanism this driver should use. The
23966 default is the value of the generic &%public_name%& option. This option allows
23967 you to use a different underlying mechanism from the advertised name. For
23968 example:
23969 .code
23970 sasl:
23971   driver = cyrus_sasl
23972   public_name = X-ANYTHING
23973   server_mech = CRAM-MD5
23974   server_set_id = $auth1
23975 .endd
23976
23977 .option server_realm cyrus_sasl string unset
23978 This specifies the SASL realm that the server claims to be in.
23979
23980
23981 .option server_service cyrus_sasl string &`smtp`&
23982 This is the SASL service that the server claims to implement.
23983
23984
23985 For straightforward cases, you do not need to set any of the authenticator's
23986 private options. All you need to do is to specify an appropriate mechanism as
23987 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
23988 PLAIN, you could have two authenticators as follows:
23989 .code
23990 sasl_cram_md5:
23991   driver = cyrus_sasl
23992   public_name = CRAM-MD5
23993   server_set_id = $auth1
23994
23995 sasl_plain:
23996   driver = cyrus_sasl
23997   public_name = PLAIN
23998   server_set_id = $auth2
23999 .endd
24000 Cyrus SASL does implement the LOGIN authentication method, even though it is
24001 not a standard method. It is disabled by default in the source distribution,
24002 but it is present in many binary distributions.
24003 .ecindex IIDcyrauth1
24004 .ecindex IIDcyrauth2
24005
24006
24007
24008
24009 . ////////////////////////////////////////////////////////////////////////////
24010 . ////////////////////////////////////////////////////////////////////////////
24011 .chapter "The dovecot authenticator" "CHAPdovecot"
24012 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
24013 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
24014 This authenticator is an interface to the authentication facility of the
24015 Dovecot POP/IMAP server, which can support a number of authentication methods.
24016 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
24017 to use the same mechanisms for SMTP authentication. This is a server
24018 authenticator only. There is only one option:
24019
24020 .option server_socket dovecot string unset
24021
24022 This option must specify the socket that is the interface to Dovecot
24023 authentication. The &%public_name%& option must specify an authentication
24024 mechanism that Dovecot is configured to support. You can have several
24025 authenticators for different mechanisms. For example:
24026 .code
24027 dovecot_plain:
24028   driver = dovecot
24029   public_name = PLAIN
24030   server_socket = /var/run/dovecot/auth-client
24031   server_set_id = $auth2
24032
24033 dovecot_ntlm:
24034   driver = dovecot
24035   public_name = NTLM
24036   server_socket = /var/run/dovecot/auth-client
24037   server_set_id = $auth1
24038 .endd
24039 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
24040 &$received_ip_address$& (that is, the connection is local), the &"secured"&
24041 option is passed in the Dovecot authentication command. If, for a TLS
24042 connection, a client certificate has been verified, the &"valid-client-cert"&
24043 option is passed. When authentication succeeds, the identity of the user
24044 who authenticated is placed in &$auth1$&.
24045 .ecindex IIDdcotauth1
24046 .ecindex IIDdcotauth2
24047
24048
24049 . ////////////////////////////////////////////////////////////////////////////
24050 . ////////////////////////////////////////////////////////////////////////////
24051
24052 .chapter "The spa authenticator" "CHAPspa"
24053 .scindex IIDspaauth1 "&(spa)& authenticator"
24054 .scindex IIDspaauth2 "authenticators" "&(spa)&"
24055 .cindex "authentication" "Microsoft Secure Password"
24056 .cindex "authentication" "NTLM"
24057 .cindex "Microsoft Secure Password Authentication"
24058 .cindex "NTLM authentication"
24059 The &(spa)& authenticator provides client support for Microsoft's &'Secure
24060 Password Authentication'& mechanism,
24061 which is also sometimes known as NTLM (NT LanMan). The code for client side of
24062 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
24063 taken from the Samba project (&url(http://www.samba.org)). The code for the
24064 server side was subsequently contributed by Tom Kistner. The mechanism works as
24065 follows:
24066
24067 .ilist
24068 After the AUTH command has been accepted, the client sends an SPA
24069 authentication request based on the user name and optional domain.
24070 .next
24071 The server sends back a challenge.
24072 .next
24073 The client builds a challenge response which makes use of the user's password
24074 and sends it to the server, which then accepts or rejects it.
24075 .endlist
24076
24077 Encryption is used to protect the password in transit.
24078
24079
24080
24081 .section "Using spa as a server" "SECID179"
24082 .cindex "options" "&(spa)& authenticator (server)"
24083 The &(spa)& authenticator has just one server option:
24084
24085 .option server_password spa string&!! unset
24086 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
24087 This option is expanded, and the result must be the cleartext password for the
24088 authenticating user, whose name is at this point in &$auth1$&. For
24089 compatibility with previous releases of Exim, the user name is also placed in
24090 &$1$&. However, the use of this variable for this purpose is now deprecated, as
24091 it can lead to confusion in string expansions that also use numeric variables
24092 for other things. For example:
24093 .code
24094 spa:
24095   driver = spa
24096   public_name = NTLM
24097   server_password = \
24098     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
24099 .endd
24100 If the expansion is forced to fail, authentication fails. Any other expansion
24101 failure causes a temporary error code to be returned.
24102
24103
24104
24105
24106
24107 .section "Using spa as a client" "SECID180"
24108 .cindex "options" "&(spa)& authenticator (client)"
24109 The &(spa)& authenticator has the following client options:
24110
24111
24112
24113 .option client_domain spa string&!! unset
24114 This option specifies an optional domain for the authentication.
24115
24116
24117 .option client_password spa string&!! unset
24118 This option specifies the user's password, and must be set.
24119
24120
24121 .option client_username spa string&!! unset
24122 This option specifies the user name, and must be set. Here is an example of a
24123 configuration of this authenticator for use with the mail servers at
24124 &'msn.com'&:
24125 .code
24126 msn:
24127   driver = spa
24128   public_name = MSN
24129   client_username = msn/msn_username
24130   client_password = msn_plaintext_password
24131   client_domain = DOMAIN_OR_UNSET
24132 .endd
24133 .ecindex IIDspaauth1
24134 .ecindex IIDspaauth2
24135
24136
24137
24138
24139
24140 . ////////////////////////////////////////////////////////////////////////////
24141 . ////////////////////////////////////////////////////////////////////////////
24142
24143 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
24144          "Encrypted SMTP connections"
24145 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
24146 .scindex IIDencsmtp2 "SMTP" "encryption"
24147 .cindex "TLS" "on SMTP connection"
24148 .cindex "OpenSSL"
24149 .cindex "GnuTLS"
24150 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
24151 Sockets Layer), is implemented by making use of the OpenSSL library or the
24152 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
24153 cryptographic code in the Exim distribution itself for implementing TLS. In
24154 order to use this feature you must install OpenSSL or GnuTLS, and then build a
24155 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
24156 You also need to understand the basic concepts of encryption at a managerial
24157 level, and in particular, the way that public keys, private keys, and
24158 certificates are used.
24159
24160 RFC 3207 defines how SMTP connections can make use of encryption. Once a
24161 connection is established, the client issues a STARTTLS command. If the
24162 server accepts this, the client and the server negotiate an encryption
24163 mechanism. If the negotiation succeeds, the data that subsequently passes
24164 between them is encrypted.
24165
24166 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
24167 and if so, what cipher suite is in use, whether the client supplied a
24168 certificate, and whether or not that certificate was verified. This makes it
24169 possible for an Exim server to deny or accept certain commands based on the
24170 encryption state.
24171
24172 &*Warning*&: Certain types of firewall and certain anti-virus products can
24173 disrupt TLS connections. You need to turn off SMTP scanning for these products
24174 in order to get TLS to work.
24175
24176
24177
24178 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
24179          "SECID284"
24180 .cindex "ssmtp protocol"
24181 .cindex "smtps protocol"
24182 .cindex "SMTP" "ssmtp protocol"
24183 .cindex "SMTP" "smtps protocol"
24184 Early implementations of encrypted SMTP used a different TCP port from normal
24185 SMTP, and expected an encryption negotiation to start immediately, instead of
24186 waiting for a STARTTLS command from the client using the standard SMTP
24187 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
24188 allocated for this purpose.
24189
24190 This approach was abandoned when encrypted SMTP was standardized, but there are
24191 still some legacy clients that use it. Exim supports these clients by means of
24192 the &%tls_on_connect_ports%& global option. Its value must be a list of port
24193 numbers; the most common use is expected to be:
24194 .code
24195 tls_on_connect_ports = 465
24196 .endd
24197 The port numbers specified by this option apply to all SMTP connections, both
24198 via the daemon and via &'inetd'&. You still need to specify all the ports that
24199 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
24200 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
24201 an extra port &-- rather, it specifies different behaviour on a port that is
24202 defined elsewhere.
24203
24204 There is also a &%-tls-on-connect%& command line option. This overrides
24205 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
24206
24207
24208
24209
24210
24211
24212 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
24213 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
24214 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
24215 followed later, when the first versions of GnuTLS were released. To build Exim
24216 to use GnuTLS, you need to set
24217 .code
24218 USE_GNUTLS=yes
24219 .endd
24220 in Local/Makefile, in addition to
24221 .code
24222 SUPPORT_TLS=yes
24223 .endd
24224 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
24225 include files and libraries for GnuTLS can be found.
24226
24227 There are some differences in usage when using GnuTLS instead of OpenSSL:
24228
24229 .ilist
24230 The &%tls_verify_certificates%& option must contain the name of a file, not the
24231 name of a directory (for OpenSSL it can be either).
24232 .next
24233 The &%tls_dhparam%& option is ignored, because early versions of GnuTLS had no
24234 facility for varying its Diffie-Hellman parameters. I understand that this has
24235 changed, but Exim has not been updated to provide this facility.
24236 .next
24237 .vindex "&$tls_peerdn$&"
24238 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
24239 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
24240 affects the value of the &$tls_peerdn$& variable.
24241 .next
24242 OpenSSL identifies cipher suites using hyphens as separators, for example:
24243 DES-CBC3-SHA. GnuTLS uses underscores, for example: RSA_ARCFOUR_SHA. What is
24244 more, OpenSSL complains if underscores are present in a cipher list. To make
24245 life simpler, Exim changes underscores to hyphens for OpenSSL and hyphens to
24246 underscores for GnuTLS when processing lists of cipher suites in the
24247 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
24248 option).
24249 .next
24250 The &%tls_require_ciphers%& options operate differently, as described in the
24251 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
24252 .endlist
24253
24254
24255 .section "GnuTLS parameter computation" "SECID181"
24256 GnuTLS uses D-H parameters that may take a substantial amount of time
24257 to compute. It is unreasonable to re-compute them for every TLS session.
24258 Therefore, Exim keeps this data in a file in its spool directory, called
24259 &_gnutls-params_&. The file is owned by the Exim user and is readable only by
24260 its owner. Every Exim process that start up GnuTLS reads the D-H
24261 parameters from this file. If the file does not exist, the first Exim process
24262 that needs it computes the data and writes it to a temporary file which is
24263 renamed once it is complete. It does not matter if several Exim processes do
24264 this simultaneously (apart from wasting a few resources). Once a file is in
24265 place, new Exim processes immediately start using it.
24266
24267 For maximum security, the parameters that are stored in this file should be
24268 recalculated periodically, the frequency depending on your paranoia level.
24269 Arranging this is easy in principle; just delete the file when you want new
24270 values to be computed. However, there may be a problem. The calculation of new
24271 parameters needs random numbers, and these are obtained from &_/dev/random_&.
24272 If the system is not very active, &_/dev/random_& may delay returning data
24273 until enough randomness (entropy) is available. This may cause Exim to hang for
24274 a substantial amount of time, causing timeouts on incoming connections.
24275
24276 The solution is to generate the parameters externally to Exim. They are stored
24277 in &_gnutls-params_& in PEM format, which means that they can be generated
24278 externally using the &(certtool)& command that is part of GnuTLS.
24279
24280 To replace the parameters with new ones, instead of deleting the file
24281 and letting Exim re-create it, you can generate new parameters using
24282 &(certtool)& and, when this has been done, replace Exim's cache file by
24283 renaming. The relevant commands are something like this:
24284 .code
24285 # rm -f new-params
24286 # touch new-params
24287 # chown exim:exim new-params
24288 # chmod 0400 new-params
24289 # certtool --generate-privkey --bits 512 >new-params
24290 # echo "" >>new-params
24291 # certtool --generate-dh-params --bits 1024 >> new-params
24292 # mv new-params gnutls-params
24293 .endd
24294 If Exim never has to generate the parameters itself, the possibility of
24295 stalling is removed.
24296
24297
24298 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
24299 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
24300 .oindex "&%tls_require_ciphers%&" "OpenSSL"
24301 There is a function in the OpenSSL library that can be passed a list of cipher
24302 suites before the cipher negotiation takes place. This specifies which ciphers
24303 are acceptable. The list is colon separated and may contain names like
24304 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
24305 directly to this function call. The following quotation from the OpenSSL
24306 documentation specifies what forms of item are allowed in the cipher string:
24307
24308 .ilist
24309 It can consist of a single cipher suite such as RC4-SHA.
24310 .next
24311 It can represent a list of cipher suites containing a certain algorithm,
24312 or cipher suites of a certain type. For example SHA1 represents all
24313 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
24314 SSL v3 algorithms.
24315 .next
24316 Lists of cipher suites can be combined in a single cipher string using
24317 the + character. This is used as a logical and operation. For example
24318 SHA1+DES represents all cipher suites containing the SHA1 and the DES
24319 algorithms.
24320 .endlist
24321
24322 Each cipher string can be optionally preceded by one of the characters &`!`&,
24323 &`-`& or &`+`&.
24324 .ilist
24325 If &`!`& is used, the ciphers are permanently deleted from the list. The
24326 ciphers deleted can never reappear in the list even if they are explicitly
24327 stated.
24328 .next
24329 If &`-`& is used, the ciphers are deleted from the list, but some or all
24330 of the ciphers can be added again by later options.
24331 .next
24332 If &`+`& is used, the ciphers are moved to the end of the list. This
24333 option does not add any new ciphers; it just moves matching existing ones.
24334 .endlist
24335
24336 If none of these characters is present, the string is interpreted as
24337 a list of ciphers to be appended to the current preference list. If the list
24338 includes any ciphers already present they will be ignored: that is, they will
24339 not be moved to the end of the list.
24340 .endlist
24341
24342
24343
24344 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
24345          "SECTreqciphgnu"
24346 .cindex "GnuTLS" "specifying parameters for"
24347 .cindex "TLS" "specifying ciphers (GnuTLS)"
24348 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
24349 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
24350 .cindex "TLS" "specifying protocols (GnuTLS)"
24351 .oindex "&%tls_require_ciphers%&" "GnuTLS"
24352 The GnuTLS library allows the caller to specify separate lists of permitted key
24353 exchange methods, main cipher algorithms, MAC algorithms, and protocols.
24354 Unfortunately, these lists are numerical, and the library does not have a
24355 function for turning names into numbers. Consequently, lists of recognized
24356 names have to be built into the application. The permitted key exchange
24357 methods, ciphers, and MAC algorithms may be used in any combination to form a
24358 cipher suite. This is unlike OpenSSL, where complete cipher suite names are
24359 passed to its control function.
24360
24361 For compatibility with OpenSSL, the &%tls_require_ciphers%& option can be set
24362 to complete cipher suite names such as RSA_ARCFOUR_SHA, but for GnuTLS this
24363 option controls only the cipher algorithms. Exim searches each item in the
24364 list for the name of an available algorithm. For example, if the list
24365 contains RSA_AES_SHA, then AES is recognized, and the behaviour is exactly
24366 the same as if just AES were given.
24367
24368 .oindex "&%gnutls_require_kx%&"
24369 .oindex "&%gnutls_require_mac%&"
24370 .oindex "&%gnutls_require_protocols%&"
24371 There are additional options called &%gnutls_require_kx%&,
24372 &%gnutls_require_mac%&, and &%gnutls_require_protocols%& that can be used to
24373 restrict the key exchange methods, MAC algorithms, and protocols, respectively.
24374 These options are ignored if OpenSSL is in use.
24375
24376 All four options are available as global options, controlling how Exim
24377 behaves as a server, and also as options of the &(smtp)& transport, controlling
24378 how Exim behaves as a client. All the values are string expanded. After
24379 expansion, the values must be colon-separated lists, though the separator
24380 can be changed in the usual way.
24381
24382 Each of the four lists starts out with a default set of algorithms. If the
24383 first item in a list does &'not'& start with an exclamation mark, all the
24384 default items are deleted. In this case, only those that are explicitly
24385 specified can be used. If the first item in a list &'does'& start with an
24386 exclamation mark, the defaults are left on the list.
24387
24388 Then, any item that starts with an exclamation mark causes the relevant
24389 entry to be removed from the list, and any item that does not start with an
24390 exclamation mark causes a new entry to be added to the list. Unrecognized
24391 items in the list are ignored. Thus:
24392 .code
24393 tls_require_ciphers = !ARCFOUR
24394 .endd
24395 allows all the defaults except ARCFOUR, whereas
24396 .code
24397 tls_require_ciphers = AES : 3DES
24398 .endd
24399 allows only cipher suites that use AES or 3DES.
24400
24401 For &%tls_require_ciphers%& the recognized names are AES_256, AES_128, AES
24402 (both of the preceding), 3DES, ARCFOUR_128, ARCFOUR_40, and ARCFOUR (both of
24403 the preceding). The default list does not contain all of these; it just has
24404 AES_256, AES_128, 3DES, and ARCFOUR_128.
24405
24406 For &%gnutls_require_kx%&, the recognized names are DHE_RSA, RSA (which
24407 includes DHE_RSA), DHE_DSS, and DHE (which includes both DHE_RSA and
24408 DHE_DSS). The default list contains RSA, DHE_DSS, DHE_RSA.
24409
24410 For &%gnutls_require_mac%&, the recognized names are SHA (synonym SHA1), and
24411 MD5. The default list contains SHA, MD5.
24412
24413 For &%gnutls_require_protocols%&, the recognized names are TLS1 and SSL3.
24414 The default list contains TLS1, SSL3.
24415
24416 In a server, the order of items in these lists is unimportant. The server
24417 advertises the availability of all the relevant cipher suites. However, in a
24418 client, the order in the &%tls_require_ciphers%& list specifies a preference
24419 order for the cipher algorithms. The first one in the client's list that is
24420 also advertised by the server is tried first. The default order is as listed
24421 above.
24422
24423
24424
24425 .section "Configuring an Exim server to use TLS" "SECID182"
24426 .cindex "TLS" "configuring an Exim server"
24427 When Exim has been built with TLS support, it advertises the availability of
24428 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
24429 but not to any others. The default value of this option is unset, which means
24430 that STARTTLS is not advertised at all. This default is chosen because you
24431 need to set some other options in order to make TLS available, and also it is
24432 sensible for systems that want to use TLS only as a client.
24433
24434 If a client issues a STARTTLS command and there is some configuration
24435 problem in the server, the command is rejected with a 454 error. If the client
24436 persists in trying to issue SMTP commands, all except QUIT are rejected
24437 with the error
24438 .code
24439 554 Security failure
24440 .endd
24441 If a STARTTLS command is issued within an existing TLS session, it is
24442 rejected with a 554 error code.
24443
24444 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
24445 match some hosts. You can, of course, set it to * to match all hosts.
24446 However, this is not all you need to do. TLS sessions to a server won't work
24447 without some further configuration at the server end.
24448
24449 It is rumoured that all existing clients that support TLS/SSL use RSA
24450 encryption. To make this work you need to set, in the server,
24451 .code
24452 tls_certificate = /some/file/name
24453 tls_privatekey = /some/file/name
24454 .endd
24455 These options are, in fact, expanded strings, so you can make them depend on
24456 the identity of the client that is connected if you wish. The first file
24457 contains the server's X509 certificate, and the second contains the private key
24458 that goes with it. These files need to be readable by the Exim user, and must
24459 always be given as full path names. They can be the same file if both the
24460 certificate and the key are contained within it. If &%tls_privatekey%& is not
24461 set, or if its expansion is forced to fail or results in an empty string, this
24462 is assumed to be the case. The certificate file may also contain intermediate
24463 certificates that need to be sent to the client to enable it to authenticate
24464 the server's certificate.
24465
24466 If you do not understand about certificates and keys, please try to find a
24467 source of this background information, which is not Exim-specific. (There are a
24468 few comments below in section &<<SECTcerandall>>&.)
24469
24470 &*Note*&: These options do not apply when Exim is operating as a client &--
24471 they apply only in the case of a server. If you need to use a certificate in an
24472 Exim client, you must set the options of the same names in an &(smtp)&
24473 transport.
24474
24475 With just these options, an Exim server will be able to use TLS. It does not
24476 require the client to have a certificate (but see below for how to insist on
24477 this). There is one other option that may be needed in other situations. If
24478 .code
24479 tls_dhparam = /some/file/name
24480 .endd
24481 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
24482 with the parameters contained in the file. This increases the set of cipher
24483 suites that the server supports. See the command
24484 .code
24485 openssl dhparam
24486 .endd
24487 for a way of generating this data. At present, &%tls_dhparam%& is used only
24488 when Exim is linked with OpenSSL. It is ignored if GnuTLS is being used.
24489
24490 The strings supplied for these three options are expanded every time a client
24491 host connects. It is therefore possible to use different certificates and keys
24492 for different hosts, if you so wish, by making use of the client's IP address
24493 in &$sender_host_address$& to control the expansion. If a string expansion is
24494 forced to fail, Exim behaves as if the option is not set.
24495
24496 .cindex "cipher" "logging"
24497 .cindex "log" "TLS cipher"
24498 .vindex "&$tls_cipher$&"
24499 The variable &$tls_cipher$& is set to the cipher suite that was negotiated for
24500 an incoming TLS connection. It is included in the &'Received:'& header of an
24501 incoming message (by default &-- you can, of course, change this), and it is
24502 also included in the log line that records a message's arrival, keyed by
24503 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
24504 condition can be used to test for specific cipher suites in ACLs.
24505 (For outgoing SMTP deliveries, &$tls_cipher$& is reset &-- see section
24506 &<<SECID185>>&.)
24507
24508 Once TLS has been established, the ACLs that run for subsequent SMTP commands
24509 can check the name of the cipher suite and vary their actions accordingly. The
24510 cipher suite names vary, depending on which TLS library is being used. For
24511 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
24512 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
24513 documentation for more details.
24514
24515
24516 .section "Requesting and verifying client certificates" "SECID183"
24517 .cindex "certificate" "verification of client"
24518 .cindex "TLS" "client certificate verification"
24519 If you want an Exim server to request a certificate when negotiating a TLS
24520 session with a client, you must set either &%tls_verify_hosts%& or
24521 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
24522 apply to all TLS connections. For any host that matches one of these options,
24523 Exim requests a certificate as part of the setup of the TLS session. The
24524 contents of the certificate are verified by comparing it with a list of
24525 expected certificates. These must be available in a file or,
24526 for OpenSSL only (not GnuTLS), a directory, identified by
24527 &%tls_verify_certificates%&.
24528
24529 A file can contain multiple certificates, concatenated end to end. If a
24530 directory is used
24531 (OpenSSL only),
24532 each certificate must be in a separate file, with a name (or a symbolic link)
24533 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
24534 certificate. You can compute the relevant hash by running the command
24535 .code
24536 openssl x509 -hash -noout -in /cert/file
24537 .endd
24538 where &_/cert/file_& contains a single certificate.
24539
24540 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
24541 what happens if the client does not supply a certificate, or if the certificate
24542 does not match any of the certificates in the collection named by
24543 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
24544 attempt to set up a TLS session is aborted, and the incoming connection is
24545 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
24546 session continues. ACLs that run for subsequent SMTP commands can detect the
24547 fact that no certificate was verified, and vary their actions accordingly. For
24548 example, you can insist on a certificate before accepting a message for
24549 relaying, but not when the message is destined for local delivery.
24550
24551 .vindex "&$tls_peerdn$&"
24552 When a client supplies a certificate (whether it verifies or not), the value of
24553 the Distinguished Name of the certificate is made available in the variable
24554 &$tls_peerdn$& during subsequent processing of the message.
24555
24556 .cindex "log" "distinguished name"
24557 Because it is often a long text string, it is not included in the log line or
24558 &'Received:'& header by default. You can arrange for it to be logged, keyed by
24559 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
24560 &%received_header_text%& to change the &'Received:'& header. When no
24561 certificate is supplied, &$tls_peerdn$& is empty.
24562
24563
24564 .section "Revoked certificates" "SECID184"
24565 .cindex "TLS" "revoked certificates"
24566 .cindex "revocation list"
24567 .cindex "certificate" "revocation list"
24568 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
24569 certificates are revoked. If you have such a list, you can pass it to an Exim
24570 server using the global option called &%tls_crl%& and to an Exim client using
24571 an identically named option for the &(smtp)& transport. In each case, the value
24572 of the option is expanded and must then be the name of a file that contains a
24573 CRL in PEM format.
24574
24575
24576 .section "Configuring an Exim client to use TLS" "SECID185"
24577 .cindex "cipher" "logging"
24578 .cindex "log" "TLS cipher"
24579 .cindex "log" "distinguished name"
24580 .cindex "TLS" "configuring an Exim client"
24581 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
24582 deliveries as well as to incoming, the latter one causing logging of the
24583 server certificate's DN. The remaining client configuration for TLS is all
24584 within the &(smtp)& transport.
24585
24586 It is not necessary to set any options to have TLS work in the &(smtp)&
24587 transport. If Exim is built with TLS support, and TLS is advertised by a
24588 server, the &(smtp)& transport always tries to start a TLS session. However,
24589 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
24590 transport) to a list of server hosts for which TLS should not be used.
24591
24592 If you do not want Exim to attempt to send messages unencrypted when an attempt
24593 to set up an encrypted connection fails in any way, you can set
24594 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
24595 those hosts, delivery is always deferred if an encrypted connection cannot be
24596 set up. If there are any other hosts for the address, they are tried in the
24597 usual way.
24598
24599 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
24600 the message unencrypted. It always does this if the response to STARTTLS is
24601 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
24602 session after a success response code, what happens is controlled by the
24603 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
24604 delivery to this host is deferred, and other hosts (if available) are tried. If
24605 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
24606 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
24607 negotiation fails, Exim closes the current connection (because it is in an
24608 unknown state), opens a new one to the same host, and then tries the delivery
24609 unencrypted.
24610
24611 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
24612 transport provide the client with a certificate, which is passed to the server
24613 if it requests it. If the server is Exim, it will request a certificate only if
24614 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
24615
24616 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
24617 must name a file or,
24618 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
24619 expected server certificates. The client verifies the server's certificate
24620 against this collection, taking into account any revoked certificates that are
24621 in the list defined by &%tls_crl%&.
24622
24623 If
24624 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
24625 list of permitted cipher suites. If either of these checks fails, delivery to
24626 the current host is abandoned, and the &(smtp)& transport tries to deliver to
24627 alternative hosts, if any.
24628
24629  &*Note*&:
24630 These options must be set in the &(smtp)& transport for Exim to use TLS when it
24631 is operating as a client. Exim does not assume that a server certificate (set
24632 by the global options of the same name) should also be used when operating as a
24633 client.
24634
24635 .vindex "&$host$&"
24636 .vindex "&$host_address$&"
24637 All the TLS options in the &(smtp)& transport are expanded before use, with
24638 &$host$& and &$host_address$& containing the name and address of the server to
24639 which the client is connected. Forced failure of an expansion causes Exim to
24640 behave as if the relevant option were unset.
24641
24642 .vindex &$tls_cipher$&
24643 .vindex &$tls_peerdn$&
24644 Before an SMTP connection is established, the &$tls_cipher$& and &$tls_peerdn$&
24645 variables are emptied. (Until the first connection, they contain the values
24646 that were set when the message was received.) If STARTTLS is subsequently
24647 successfully obeyed, these variables are set to the relevant values for the
24648 outgoing connection.
24649
24650
24651
24652 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
24653          "SECTmulmessam"
24654 .cindex "multiple SMTP deliveries with TLS"
24655 .cindex "TLS" "multiple message deliveries"
24656 Exim sends multiple messages down the same TCP/IP connection by starting up
24657 an entirely new delivery process for each message, passing the socket from
24658 one process to the next. This implementation does not fit well with the use
24659 of TLS, because there is quite a lot of state information associated with a TLS
24660 connection, not just a socket identification. Passing all the state information
24661 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
24662 session before passing the socket to a new process. The new process may then
24663 try to start a new TLS session, and if successful, may try to re-authenticate
24664 if AUTH is in use, before sending the next message.
24665
24666 The RFC is not clear as to whether or not an SMTP session continues in clear
24667 after TLS has been shut down, or whether TLS may be restarted again later, as
24668 just described. However, if the server is Exim, this shutdown and
24669 reinitialization works. It is not known which (if any) other servers operate
24670 successfully if the client closes a TLS session and continues with unencrypted
24671 SMTP, but there are certainly some that do not work. For such servers, Exim
24672 should not pass the socket to another process, because the failure of the
24673 subsequent attempt to use it would cause Exim to record a temporary host error,
24674 and delay other deliveries to that host.
24675
24676 To test for this case, Exim sends an EHLO command to the server after
24677 closing down the TLS session. If this fails in any way, the connection is
24678 closed instead of being passed to a new delivery process, but no retry
24679 information is recorded.
24680
24681 There is also a manual override; you can set &%hosts_nopass_tls%& on the
24682 &(smtp)& transport to match those hosts for which Exim should not pass
24683 connections to new processes if TLS has been used.
24684
24685
24686
24687
24688 .section "Certificates and all that" "SECTcerandall"
24689 .cindex "certificate" "references to discussion"
24690 In order to understand fully how TLS works, you need to know about
24691 certificates, certificate signing, and certificate authorities. This is not the
24692 place to give a tutorial, especially as I do not know very much about it
24693 myself. Some helpful introduction can be found in the FAQ for the SSL addition
24694 to Apache, currently at
24695 .display
24696 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
24697 .endd
24698 Other parts of the &'modssl'& documentation are also helpful, and have
24699 links to further files.
24700 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
24701 0-201-61598-3), contains both introductory and more in-depth descriptions.
24702 Some sample programs taken from the book are available from
24703 .display
24704 &url(http://www.rtfm.com/openssl-examples/)
24705 .endd
24706
24707
24708 .section "Certificate chains" "SECID186"
24709 The file named by &%tls_certificate%& may contain more than one
24710 certificate. This is useful in the case where the certificate that is being
24711 sent is validated by an intermediate certificate which the other end does
24712 not have. Multiple certificates must be in the correct order in the file.
24713 First the host's certificate itself, then the first intermediate
24714 certificate to validate the issuer of the host certificate, then the next
24715 intermediate certificate to validate the issuer of the first intermediate
24716 certificate, and so on, until finally (optionally) the root certificate.
24717 The root certificate must already be trusted by the recipient for
24718 validation to succeed, of course, but if it's not preinstalled, sending the
24719 root certificate along with the rest makes it available for the user to
24720 install if the receiving end is a client MUA that can interact with a user.
24721
24722
24723 .section "Self-signed certificates" "SECID187"
24724 .cindex "certificate" "self-signed"
24725 You can create a self-signed certificate using the &'req'& command provided
24726 with OpenSSL, like this:
24727 .code
24728 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
24729             -days 9999 -nodes
24730 .endd
24731 &_file1_& and &_file2_& can be the same file; the key and the certificate are
24732 delimited and so can be identified independently. The &%-days%& option
24733 specifies a period for which the certificate is valid. The &%-nodes%& option is
24734 important: if you do not set it, the key is encrypted with a passphrase
24735 that you are prompted for, and any use that is made of the key causes more
24736 prompting for the passphrase. This is not helpful if you are going to use
24737 this certificate and key in an MTA, where prompting is not possible.
24738
24739 A self-signed certificate made in this way is sufficient for testing, and
24740 may be adequate for all your requirements if you are mainly interested in
24741 encrypting transfers, and not in secure identification.
24742
24743 However, many clients require that the certificate presented by the server be a
24744 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
24745 certificate. In this situation, the self-signed certificate described above
24746 must be installed on the client host as a trusted root &'certification
24747 authority'& (CA), and the certificate used by Exim must be a user certificate
24748 signed with that self-signed certificate.
24749
24750 For information on creating self-signed CA certificates and using them to sign
24751 user certificates, see the &'General implementation overview'& chapter of the
24752 Open-source PKI book, available online at
24753 &url(http://ospkibook.sourceforge.net/).
24754 .ecindex IIDencsmtp1
24755 .ecindex IIDencsmtp2
24756
24757
24758
24759 . ////////////////////////////////////////////////////////////////////////////
24760 . ////////////////////////////////////////////////////////////////////////////
24761
24762 .chapter "Access control lists" "CHAPACL"
24763 .scindex IIDacl "&ACL;" "description"
24764 .cindex "control of incoming mail"
24765 .cindex "message" "controlling incoming"
24766 .cindex "policy control" "access control lists"
24767 Access Control Lists (ACLs) are defined in a separate section of the run time
24768 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
24769 name, terminated by a colon. Here is a complete ACL section that contains just
24770 one very small ACL:
24771 .code
24772 begin acl
24773 small_acl:
24774   accept   hosts = one.host.only
24775 .endd
24776 You can have as many lists as you like in the ACL section, and the order in
24777 which they appear does not matter. The lists are self-terminating.
24778
24779 The majority of ACLs are used to control Exim's behaviour when it receives
24780 certain SMTP commands. This applies both to incoming TCP/IP connections, and
24781 when a local process submits a message using SMTP by specifying the &%-bs%&
24782 option. The most common use is for controlling which recipients are accepted
24783 in incoming messages. In addition, you can define an ACL that is used to check
24784 local non-SMTP messages. The default configuration file contains an example of
24785 a realistic ACL for checking RCPT commands. This is discussed in chapter
24786 &<<CHAPdefconfil>>&.
24787
24788
24789 .section "Testing ACLs" "SECID188"
24790 The &%-bh%& command line option provides a way of testing your ACL
24791 configuration locally by running a fake SMTP session with which you interact.
24792 The host &'relay-test.mail-abuse.org'& provides a service for checking your
24793 relaying configuration (see section &<<SECTcheralcon>>& for more details).
24794
24795
24796
24797 .section "Specifying when ACLs are used" "SECID189"
24798 .cindex "&ACL;" "options for specifying"
24799 In order to cause an ACL to be used, you have to name it in one of the relevant
24800 options in the main part of the configuration. These options are:
24801 .cindex "AUTH" "ACL for"
24802 .cindex "DATA" "ACLs for"
24803 .cindex "ETRN" "ACL for"
24804 .cindex "EXPN" "ACL for"
24805 .cindex "HELO" "ACL for"
24806 .cindex "EHLO" "ACL for"
24807 .cindex "MAIL" "ACL for"
24808 .cindex "QUIT, ACL for"
24809 .cindex "RCPT" "ACL for"
24810 .cindex "STARTTLS, ACL for"
24811 .cindex "VRFY" "ACL for"
24812 .cindex "SMTP" "connection, ACL for"
24813 .cindex "non-SMTP messages" "ACLs for"
24814 .cindex "MIME content scanning" "ACL for"
24815
24816 .table2 140pt
24817 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
24818 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
24819 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
24820 .irow &%acl_smtp_auth%&        "ACL for AUTH"
24821 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
24822 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
24823 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
24824 .irow &%acl_smtp_expn%&        "ACL for EXPN"
24825 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
24826 .irow &%acl_smtp_mail%&        "ACL for MAIL"
24827 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
24828 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
24829 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
24830 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
24831 .irow &%acl_smtp_quit%&        "ACL for QUIT"
24832 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
24833 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
24834 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
24835 .endtable
24836
24837 For example, if you set
24838 .code
24839 acl_smtp_rcpt = small_acl
24840 .endd
24841 the little ACL defined above is used whenever Exim receives a RCPT command
24842 in an SMTP dialogue. The majority of policy tests on incoming messages can be
24843 done when RCPT commands arrive. A rejection of RCPT should cause the
24844 sending MTA to give up on the recipient address contained in the RCPT
24845 command, whereas rejection at other times may cause the client MTA to keep on
24846 trying to deliver the message. It is therefore recommended that you do as much
24847 testing as possible at RCPT time.
24848
24849
24850 .section "The non-SMTP ACLs" "SECID190"
24851 .cindex "non-SMTP messages" "ACLs for"
24852 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
24853 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
24854 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
24855 the state of the SMTP connection such as encryption and authentication) are not
24856 relevant and are forbidden in these ACLs. However, the sender and recipients
24857 are known, so the &%senders%& and &%sender_domains%& conditions and the
24858 &$sender_address$& and &$recipients$& variables can be used. Variables such as
24859 &$authenticated_sender$& are also available. You can specify added header lines
24860 in any of these ACLs.
24861
24862 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
24863 non-SMTP message, before any of the message has been read. (This is the
24864 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
24865 batched SMTP input, it runs after the DATA command has been reached. The
24866 result of this ACL is ignored; it cannot be used to reject a message. If you
24867 really need to, you could set a value in an ACL variable here and reject based
24868 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
24869 controls, and in particular, it can be used to set
24870 .code
24871 control = suppress_local_fixups
24872 .endd
24873 This cannot be used in the other non-SMTP ACLs because by the time they are
24874 run, it is too late.
24875
24876 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
24877 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
24878
24879 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
24880 kind of rejection is treated as permanent, because there is no way of sending a
24881 temporary error for these kinds of message.
24882
24883
24884 .section "The SMTP connect ACL" "SECID191"
24885 .cindex "SMTP" "connection, ACL for"
24886 .oindex &%smtp_banner%&
24887 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
24888 session, after the test specified by &%host_reject_connection%& (which is now
24889 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
24890 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
24891 the message override the banner message that is otherwise specified by the
24892 &%smtp_banner%& option.
24893
24894
24895 .section "The EHLO/HELO ACL" "SECID192"
24896 .cindex "EHLO" "ACL for"
24897 .cindex "HELO" "ACL for"
24898 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
24899 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
24900 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
24901 Note that a client may issue more than one EHLO or HELO command in an SMTP
24902 session, and indeed is required to issue a new EHLO or HELO after successfully
24903 setting up encryption following a STARTTLS command.
24904
24905 If the command is accepted by an &%accept%& verb that has a &%message%&
24906 modifier, the message may not contain more than one line (it will be truncated
24907 at the first newline and a panic logged if it does). Such a message cannot
24908 affect the EHLO options that are listed on the second and subsequent lines of
24909 an EHLO response.
24910
24911
24912 .section "The DATA ACLs" "SECID193"
24913 .cindex "DATA" "ACLs for"
24914 Two ACLs are associated with the DATA command, because it is two-stage
24915 command, with two responses being sent to the client.
24916 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
24917 is obeyed. This gives you control after all the RCPT commands, but before
24918 the message itself is received. It offers the opportunity to give a negative
24919 response to the DATA command before the data is transmitted. Header lines
24920 added by MAIL or RCPT ACLs are not visible at this time, but any that
24921 are defined here are visible when the &%acl_smtp_data%& ACL is run.
24922
24923 You cannot test the contents of the message, for example, to verify addresses
24924 in the headers, at RCPT time or when the DATA command is received. Such
24925 tests have to appear in the ACL that is run after the message itself has been
24926 received, before the final response to the DATA command is sent. This is
24927 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
24928 associated with the DATA command.
24929
24930 For both of these ACLs, it is not possible to reject individual recipients. An
24931 error response rejects the entire message. Unfortunately, it is known that some
24932 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
24933 before or after the data) correctly &-- they keep the message on their queues
24934 and try again later, but that is their problem, though it does waste some of
24935 your resources.
24936
24937
24938 .section "The SMTP MIME ACL" "SECID194"
24939 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
24940 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
24941
24942
24943 .section "The QUIT ACL" "SECTQUITACL"
24944 .cindex "QUIT, ACL for"
24945 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
24946 does not affect the response code to QUIT, which is always 221. Thus, the ACL
24947 does not in fact control any access. For this reason, the only verbs that are
24948 permitted are &%accept%& and &%warn%&.
24949
24950 This ACL can be used for tasks such as custom logging at the end of an SMTP
24951 session. For example, you can use ACL variables in other ACLs to count
24952 messages, recipients, etc., and log the totals at QUIT time using one or
24953 more &%logwrite%& modifiers on a &%warn%& verb.
24954
24955 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
24956 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
24957
24958 You do not need to have a final &%accept%&, but if you do, you can use a
24959 &%message%& modifier to specify custom text that is sent as part of the 221
24960 response to QUIT.
24961
24962 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
24963 failure (for example, failure to open a log file, or when Exim is bombing out
24964 because it has detected an unrecoverable error), all SMTP commands from the
24965 client are given temporary error responses until QUIT is received or the
24966 connection is closed. In these special cases, the QUIT ACL does not run.
24967
24968
24969 .section "The not-QUIT ACL" "SECTNOTQUITACL"
24970 .vindex &$acl_smtp_notquit$&
24971 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
24972 an SMTP session ends without sending QUIT. However, when Exim itself is is bad
24973 trouble, such as being unable to write to its log files, this ACL is not run,
24974 because it might try to do things (such as write to log files) that make the
24975 situation even worse.
24976
24977 Like the QUIT ACL, this ACL is provided to make it possible to do customized
24978 logging or to gather statistics, and its outcome is ignored. The &%delay%&
24979 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
24980 and &%warn%&.
24981
24982 .vindex &$smtp_notquit_reason$&
24983 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
24984 to a string that indicates the reason for the termination of the SMTP
24985 connection. The possible values are:
24986 .table2
24987 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
24988 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
24989 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
24990 .irow &`connection-lost`&          "The SMTP connection has been lost"
24991 .irow &`data-timeout`&             "Timeout while reading message data"
24992 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
24993 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
24994 .irow &`signal-exit`&              "SIGTERM or SIGINT"
24995 .irow &`synchronization-error`&    "SMTP synchronization error"
24996 .irow &`tls-failed`&               "TLS failed to start"
24997 .endtable
24998 In most cases when an SMTP connection is closed without having received QUIT,
24999 Exim sends an SMTP response message before actually closing the connection.
25000 With the exception of the &`acl-drop`& case, the default message can be
25001 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
25002 &%drop%& verb in another ACL, it is the message from the other ACL that is
25003 used.
25004
25005
25006 .section "Finding an ACL to use" "SECID195"
25007 .cindex "&ACL;" "finding which to use"
25008 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
25009 you can use different ACLs in different circumstances. For example,
25010 .code
25011 acl_smtp_rcpt = ${if ={25}{$interface_port} \
25012                      {acl_check_rcpt} {acl_check_rcpt_submit} }
25013 .endd
25014 In the default configuration file there are some example settings for
25015 providing an RFC 4409 message submission service on port 587 and a
25016 non-standard &"smtps"& service on port 465. You can use a string
25017 expansion like this to choose an ACL for MUAs on these ports which is
25018 more appropriate for this purpose than the default ACL on port 25.
25019
25020 The expanded string does not have to be the name of an ACL in the
25021 configuration file; there are other possibilities. Having expanded the
25022 string, Exim searches for an ACL as follows:
25023
25024 .ilist
25025 If the string begins with a slash, Exim uses it as a file name, and reads its
25026 contents as an ACL. The lines are processed in the same way as lines in the
25027 Exim configuration file. In particular, continuation lines are supported, blank
25028 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
25029 If the file does not exist or cannot be read, an error occurs (typically
25030 causing a temporary failure of whatever caused the ACL to be run). For example:
25031 .code
25032 acl_smtp_data = /etc/acls/\
25033   ${lookup{$sender_host_address}lsearch\
25034   {/etc/acllist}{$value}{default}}
25035 .endd
25036 This looks up an ACL file to use on the basis of the host's IP address, falling
25037 back to a default if the lookup fails. If an ACL is successfully read from a
25038 file, it is retained in memory for the duration of the Exim process, so that it
25039 can be re-used without having to re-read the file.
25040 .next
25041 If the string does not start with a slash, and does not contain any spaces,
25042 Exim searches the ACL section of the configuration for an ACL whose name
25043 matches the string.
25044 .next
25045 If no named ACL is found, or if the string contains spaces, Exim parses
25046 the string as an inline ACL. This can save typing in cases where you just
25047 want to have something like
25048 .code
25049 acl_smtp_vrfy = accept
25050 .endd
25051 in order to allow free use of the VRFY command. Such a string may contain
25052 newlines; it is processed in the same way as an ACL that is read from a file.
25053 .endlist
25054
25055
25056
25057
25058 .section "ACL return codes" "SECID196"
25059 .cindex "&ACL;" "return codes"
25060 Except for the QUIT ACL, which does not affect the SMTP return code (see
25061 section &<<SECTQUITACL>>& above), the result of running an ACL is either
25062 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
25063 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
25064 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
25065 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
25066 This also causes a 4&'xx'& return code.
25067
25068 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
25069 &"deny"&, because there is no mechanism for passing temporary errors to the
25070 submitters of non-SMTP messages.
25071
25072
25073 ACLs that are relevant to message reception may also return &"discard"&. This
25074 has the effect of &"accept"&, but causes either the entire message or an
25075 individual recipient address to be discarded. In other words, it is a
25076 blackholing facility. Use it with care.
25077
25078 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
25079 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
25080 RCPT ACL is to discard just the one recipient address. If there are no
25081 recipients left when the message's data is received, the DATA ACL is not
25082 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
25083 remaining recipients. The &"discard"& return is not permitted for the
25084 &%acl_smtp_predata%& ACL.
25085
25086
25087 .cindex "&[local_scan()]& function" "when all recipients discarded"
25088 The &[local_scan()]& function is always run, even if there are no remaining
25089 recipients; it may create new recipients.
25090
25091
25092
25093 .section "Unset ACL options" "SECID197"
25094 .cindex "&ACL;" "unset options"
25095 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
25096 all the same. &*Note*&: These defaults apply only when the relevant ACL is
25097 not defined at all. For any defined ACL, the default action when control
25098 reaches the end of the ACL statements is &"deny"&.
25099
25100 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
25101 these two are ACLs that are used only for their side effects. They cannot be
25102 used to accept or reject anything.
25103
25104 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
25105 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
25106 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
25107 when the ACL is not defined is &"accept"&.
25108
25109 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
25110 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
25111 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
25112 messages over an SMTP connection. For an example, see the ACL in the default
25113 configuration file.
25114
25115
25116
25117
25118 .section "Data for message ACLs" "SECID198"
25119 .cindex "&ACL;" "data for message ACL"
25120 .vindex &$domain$&
25121 .vindex &$local_part$&
25122 .vindex &$sender_address$&
25123 .vindex &$sender_host_address$&
25124 .vindex &$smtp_command$&
25125 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
25126 that contain information about the host and the message's sender (for example,
25127 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
25128 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
25129 &$local_part$& are set from the argument address. The entire SMTP command
25130 is available in &$smtp_command$&.
25131
25132 When an ACL for the AUTH parameter of MAIL is running, the variables that
25133 contain information about the host are set, but &$sender_address$& is not yet
25134 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
25135 how it is used.
25136
25137 .vindex "&$message_size$&"
25138 The &$message_size$& variable is set to the value of the SIZE parameter on
25139 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
25140 that parameter is not given. The value is updated to the true message size by
25141 the time the final DATA ACL is run (after the message data has been
25142 received).
25143
25144 .vindex "&$rcpt_count$&"
25145 .vindex "&$recipients_count$&"
25146 The &$rcpt_count$& variable increases by one for each RCPT command received.
25147 The &$recipients_count$& variable increases by one each time a RCPT command is
25148 accepted, so while an ACL for RCPT is being processed, it contains the number
25149 of previously accepted recipients. At DATA time (for both the DATA ACLs),
25150 &$rcpt_count$& contains the total number of RCPT commands, and
25151 &$recipients_count$& contains the total number of accepted recipients.
25152
25153
25154
25155
25156
25157 .section "Data for non-message ACLs" "SECTdatfornon"
25158 .cindex "&ACL;" "data for non-message ACL"
25159 .vindex &$smtp_command_argument$&
25160 .vindex &$smtp_command$&
25161 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
25162 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
25163 and the entire SMTP command is available in &$smtp_command$&.
25164 These variables can be tested using a &%condition%& condition. For example,
25165 here is an ACL for use with AUTH, which insists that either the session is
25166 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
25167 does not permit authentication methods that use cleartext passwords on
25168 unencrypted connections.
25169 .code
25170 acl_check_auth:
25171   accept encrypted = *
25172   accept condition = ${if eq{${uc:$smtp_command_argument}}\
25173                      {CRAM-MD5}}
25174   deny   message   = TLS encryption or CRAM-MD5 required
25175 .endd
25176 (Another way of applying this restriction is to arrange for the authenticators
25177 that use cleartext passwords not to be advertised when the connection is not
25178 encrypted. You can use the generic &%server_advertise_condition%& authenticator
25179 option to do this.)
25180
25181
25182
25183 .section "Format of an ACL" "SECID199"
25184 .cindex "&ACL;" "format of"
25185 .cindex "&ACL;" "verbs, definition of"
25186 An individual ACL consists of a number of statements. Each statement starts
25187 with a verb, optionally followed by a number of conditions and &"modifiers"&.
25188 Modifiers can change the way the verb operates, define error and log messages,
25189 set variables, insert delays, and vary the processing of accepted messages.
25190
25191 If all the conditions are met, the verb is obeyed. The same condition may be
25192 used (with different arguments) more than once in the same statement. This
25193 provides a means of specifying an &"and"& conjunction between conditions. For
25194 example:
25195 .code
25196 deny  dnslists = list1.example
25197 dnslists = list2.example
25198 .endd
25199 If there are no conditions, the verb is always obeyed. Exim stops evaluating
25200 the conditions and modifiers when it reaches a condition that fails. What
25201 happens then depends on the verb (and in one case, on a special modifier). Not
25202 all the conditions make sense at every testing point. For example, you cannot
25203 test a sender address in the ACL that is run for a VRFY command.
25204
25205
25206 .section "ACL verbs" "SECID200"
25207 The ACL verbs are as follows:
25208
25209 .ilist
25210 .cindex "&%accept%& ACL verb"
25211 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
25212 of the conditions are not met, what happens depends on whether &%endpass%&
25213 appears among the conditions (for syntax see below). If the failing condition
25214 is before &%endpass%&, control is passed to the next ACL statement; if it is
25215 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
25216 check a RCPT command:
25217 .code
25218 accept domains = +local_domains
25219 endpass
25220 verify = recipient
25221 .endd
25222 If the recipient domain does not match the &%domains%& condition, control
25223 passes to the next statement. If it does match, the recipient is verified, and
25224 the command is accepted if verification succeeds. However, if verification
25225 fails, the ACL yields &"deny"&, because the failing condition is after
25226 &%endpass%&.
25227
25228 The &%endpass%& feature has turned out to be confusing to many people, so its
25229 use is not recommended nowadays. It is always possible to rewrite an ACL so
25230 that &%endpass%& is not needed, and it is no longer used in the default
25231 configuration.
25232
25233 .cindex "&%message%& ACL modifier" "with &%accept%&"
25234 If a &%message%& modifier appears on an &%accept%& statement, its action
25235 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
25236 (when an &%accept%& verb either accepts or passes control to the next
25237 statement), &%message%& can be used to vary the message that is sent when an
25238 SMTP command is accepted. For example, in a RCPT ACL you could have:
25239 .display
25240 &`accept  `&<&'some conditions'&>
25241 &`        message = OK, I will allow you through today`&
25242 .endd
25243 You can specify an SMTP response code, optionally followed by an &"extended
25244 response code"& at the start of the message, but the first digit must be the
25245 same as would be sent by default, which is 2 for an &%accept%& verb.
25246
25247 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
25248 an error message that is used when access is denied. This behaviour is retained
25249 for backward compatibility, but current &"best practice"& is to avoid the use
25250 of &%endpass%&.
25251
25252
25253 .next
25254 .cindex "&%defer%& ACL verb"
25255 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
25256 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
25257 &%defer%& is the same as &%deny%&, because there is no way of sending a
25258 temporary error. For a RCPT command, &%defer%& is much the same as using a
25259 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
25260 be used in any ACL, and even for a recipient it might be a simpler approach.
25261
25262
25263 .next
25264 .cindex "&%deny%& ACL verb"
25265 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
25266 the conditions are not met, control is passed to the next ACL statement. For
25267 example,
25268 .code
25269 deny dnslists = blackholes.mail-abuse.org
25270 .endd
25271 rejects commands from hosts that are on a DNS black list.
25272
25273
25274 .next
25275 .cindex "&%discard%& ACL verb"
25276 &%discard%&: This verb behaves like &%accept%&, except that it returns
25277 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
25278 that are concerned with receiving messages. When all the conditions are true,
25279 the sending entity receives a &"success"& response. However, &%discard%& causes
25280 recipients to be discarded. If it is used in an ACL for RCPT, just the one
25281 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
25282 message's recipients are discarded. Recipients that are discarded before DATA
25283 do not appear in the log line when the &%received_recipients%& log selector is set.
25284
25285 If the &%log_message%& modifier is set when &%discard%& operates,
25286 its contents are added to the line that is automatically written to the log.
25287 The &%message%& modifier operates exactly as it does for &%accept%&.
25288
25289
25290 .next
25291 .cindex "&%drop%& ACL verb"
25292 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
25293 forcibly closed after the 5&'xx'& error message has been sent. For example:
25294 .code
25295 drop   message   = I don't take more than 20 RCPTs
25296        condition = ${if > {$rcpt_count}{20}}
25297 .endd
25298 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
25299 The connection is always dropped after sending a 550 response.
25300
25301 .next
25302 .cindex "&%require%& ACL verb"
25303 &%require%&: If all the conditions are met, control is passed to the next ACL
25304 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
25305 example, when checking a RCPT command,
25306 .code
25307 require message = Sender did not verify
25308         verify  = sender
25309 .endd
25310 passes control to subsequent statements only if the message's sender can be
25311 verified. Otherwise, it rejects the command. Note the positioning of the
25312 &%message%& modifier, before the &%verify%& condition. The reason for this is
25313 discussed in section &<<SECTcondmodproc>>&.
25314
25315 .next
25316 .cindex "&%warn%& ACL verb"
25317 &%warn%&: If all the conditions are true, a line specified by the
25318 &%log_message%& modifier is written to Exim's main log. Control always passes
25319 to the next ACL statement. If any condition is false, the log line is not
25320 written. If an identical log line is requested several times in the same
25321 message, only one copy is actually written to the log. If you want to force
25322 duplicates to be written, use the &%logwrite%& modifier instead.
25323
25324 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
25325 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
25326 &%logwrite%&, and &%add_header%&) that appear before the first failing
25327 condition. There is more about adding header lines in section
25328 &<<SECTaddheadacl>>&.
25329
25330 If any condition on a &%warn%& statement cannot be completed (that is, there is
25331 some sort of defer), the log line specified by &%log_message%& is not written.
25332 This does not include the case of a forced failure from a lookup, which
25333 is considered to be a successful completion. After a defer, no further
25334 conditions or modifiers in the &%warn%& statement are processed. The incident
25335 is logged, and the ACL continues to be processed, from the next statement
25336 onwards.
25337
25338
25339 .vindex "&$acl_verify_message$&"
25340 When one of the &%warn%& conditions is an address verification that fails, the
25341 text of the verification failure message is in &$acl_verify_message$&. If you
25342 want this logged, you must set it up explicitly. For example:
25343 .code
25344 warn   !verify = sender
25345        log_message = sender verify failed: $acl_verify_message
25346 .endd
25347 .endlist
25348
25349 At the end of each ACL there is an implicit unconditional &%deny%&.
25350
25351 As you can see from the examples above, the conditions and modifiers are
25352 written one to a line, with the first one on the same line as the verb, and
25353 subsequent ones on following lines. If you have a very long condition, you can
25354 continue it onto several physical lines by the usual backslash continuation
25355 mechanism. It is conventional to align the conditions vertically.
25356
25357
25358
25359 .section "ACL variables" "SECTaclvariables"
25360 .cindex "&ACL;" "variables"
25361 There are some special variables that can be set during ACL processing. They
25362 can be used to pass information between different ACLs, different invocations
25363 of the same ACL in the same SMTP connection, and between ACLs and the routers,
25364 transports, and filters that are used to deliver a message. The names of these
25365 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
25366 an underscore, but the remainder of the name can be any sequence of
25367 alphanumeric characters and underscores that you choose. There is no limit on
25368 the number of ACL variables. The two sets act as follows:
25369 .ilist
25370 The values of those variables whose names begin with &$acl_c$& persist
25371 throughout an SMTP connection. They are never reset. Thus, a value that is set
25372 while receiving one message is still available when receiving the next message
25373 on the same SMTP connection.
25374 .next
25375 The values of those variables whose names begin with &$acl_m$& persist only
25376 while a message is being received. They are reset afterwards. They are also
25377 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
25378 .endlist
25379
25380 When a message is accepted, the current values of all the ACL variables are
25381 preserved with the message and are subsequently made available at delivery
25382 time. The ACL variables are set by a modifier called &%set%&. For example:
25383 .code
25384 accept hosts = whatever
25385        set acl_m4 = some value
25386 accept authenticated = *
25387        set acl_c_auth = yes
25388 .endd
25389 &*Note*&: A leading dollar sign is not used when naming a variable that is to
25390 be set. If you want to set a variable without taking any action, you can use a
25391 &%warn%& verb without any other modifiers or conditions.
25392
25393 .oindex &%strict_acl_vars%&
25394 What happens if a syntactically valid but undefined ACL variable is
25395 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
25396 false (the default), an empty string is substituted; if it is true, an
25397 error is generated.
25398
25399 Versions of Exim before 4.64 have a limited set of numbered variables, but
25400 their names are compatible, so there is no problem with upgrading.
25401
25402
25403 .section "Condition and modifier processing" "SECTcondmodproc"
25404 .cindex "&ACL;" "conditions; processing"
25405 .cindex "&ACL;" "modifiers; processing"
25406 An exclamation mark preceding a condition negates its result. For example:
25407 .code
25408 deny   domains = *.dom.example
25409       !verify  = recipient
25410 .endd
25411 causes the ACL to return &"deny"& if the recipient domain ends in
25412 &'dom.example'& and the recipient address cannot be verified. Sometimes
25413 negation can be used on the right-hand side of a condition. For example, these
25414 two statements are equivalent:
25415 .code
25416 deny  hosts = !192.168.3.4
25417 deny !hosts =  192.168.3.4
25418 .endd
25419 However, for many conditions (&%verify%& being a good example), only left-hand
25420 side negation of the whole condition is possible.
25421
25422 The arguments of conditions and modifiers are expanded. A forced failure
25423 of an expansion causes a condition to be ignored, that is, it behaves as if the
25424 condition is true. Consider these two statements:
25425 .code
25426 accept  senders = ${lookup{$host_name}lsearch\
25427                   {/some/file}{$value}fail}
25428 accept  senders = ${lookup{$host_name}lsearch\
25429                   {/some/file}{$value}{}}
25430 .endd
25431 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
25432 the returned list is searched, but if the lookup fails the behaviour is
25433 different in the two cases. The &%fail%& in the first statement causes the
25434 condition to be ignored, leaving no further conditions. The &%accept%& verb
25435 therefore succeeds. The second statement, however, generates an empty list when
25436 the lookup fails. No sender can match an empty list, so the condition fails,
25437 and therefore the &%accept%& also fails.
25438
25439 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
25440 specify actions that are taken as the conditions for a statement are checked;
25441 others specify text for messages that are used when access is denied or a
25442 warning is generated. The &%control%& modifier affects the way an incoming
25443 message is handled.
25444
25445 The positioning of the modifiers in an ACL statement important, because the
25446 processing of a verb ceases as soon as its outcome is known. Only those
25447 modifiers that have already been encountered will take effect. For example,
25448 consider this use of the &%message%& modifier:
25449 .code
25450 require message = Can't verify sender
25451         verify  = sender
25452         message = Can't verify recipient
25453         verify  = recipient
25454         message = This message cannot be used
25455 .endd
25456 If sender verification fails, Exim knows that the result of the statement is
25457 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
25458 so its text is used as the error message. If sender verification succeeds, but
25459 recipient verification fails, the second message is used. If recipient
25460 verification succeeds, the third message becomes &"current"&, but is never used
25461 because there are no more conditions to cause failure.
25462
25463 For the &%deny%& verb, on the other hand, it is always the last &%message%&
25464 modifier that is used, because all the conditions must be true for rejection to
25465 happen. Specifying more than one &%message%& modifier does not make sense, and
25466 the message can even be specified after all the conditions. For example:
25467 .code
25468 deny   hosts = ...
25469       !senders = *@my.domain.example
25470        message = Invalid sender from client host
25471 .endd
25472 The &"deny"& result does not happen until the end of the statement is reached,
25473 by which time Exim has set up the message.
25474
25475
25476
25477 .section "ACL modifiers" "SECTACLmodi"
25478 .cindex "&ACL;" "modifiers; list of"
25479 The ACL modifiers are as follows:
25480
25481 .vlist
25482 .vitem &*add_header*&&~=&~<&'text'&>
25483 This modifier specifies one or more header lines that are to be added to an
25484 incoming message, assuming, of course, that the message is ultimately
25485 accepted. For details, see section &<<SECTaddheadacl>>&.
25486
25487 .vitem &*continue*&&~=&~<&'text'&>
25488 .cindex "&%continue%& ACL modifier"
25489 .cindex "database" "updating in ACL"
25490 This modifier does nothing of itself, and processing of the ACL always
25491 continues with the next condition or modifier. The value of &%continue%& is in
25492 the side effects of expanding its argument. Typically this could be used to
25493 update a database. It is really just a syntactic tidiness, to avoid having to
25494 write rather ugly lines like this:
25495 .display
25496 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
25497 .endd
25498 Instead, all you need is
25499 .display
25500 &`continue = `&<&'some expansion'&>
25501 .endd
25502
25503 .vitem &*control*&&~=&~<&'text'&>
25504 .cindex "&%control%& ACL modifier"
25505 This modifier affects the subsequent processing of the SMTP connection or of an
25506 incoming message that is accepted. The effect of the first type of control
25507 lasts for the duration of the connection, whereas the effect of the second type
25508 lasts only until the current message has been received. The message-specific
25509 controls always apply to the whole message, not to individual recipients,
25510 even if the &%control%& modifier appears in a RCPT ACL.
25511
25512 As there are now quite a few controls that can be applied, they are described
25513 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
25514 in several different ways. For example:
25515
25516 . ==== As this is a nested list, any displays it contains must be indented
25517 . ==== as otherwise they are too far to the left. That comment applies only
25518 . ==== when xmlto and fop are used; formatting with sdop gets it right either
25519 . ==== way.
25520
25521 .ilist
25522 It can be at the end of an &%accept%& statement:
25523 .code
25524     accept  ...some conditions
25525             control = queue_only
25526 .endd
25527 In this case, the control is applied when this statement yields &"accept"&, in
25528 other words, when the conditions are all true.
25529
25530 .next
25531 It can be in the middle of an &%accept%& statement:
25532 .code
25533     accept  ...some conditions...
25534             control = queue_only
25535             ...some more conditions...
25536 .endd
25537 If the first set of conditions are true, the control is applied, even if the
25538 statement does not accept because one of the second set of conditions is false.
25539 In this case, some subsequent statement must yield &"accept"& for the control
25540 to be relevant.
25541
25542 .next
25543 It can be used with &%warn%& to apply the control, leaving the
25544 decision about accepting or denying to a subsequent verb. For
25545 example:
25546 .code
25547     warn    ...some conditions...
25548             control = freeze
25549     accept  ...
25550 .endd
25551 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
25552 &%logwrite%&, so it does not add anything to the message and does not write a
25553 log entry.
25554
25555 .next
25556 If you want to apply a control unconditionally, you can use it with a
25557 &%require%& verb. For example:
25558 .code
25559     require  control = no_multiline_responses
25560 .endd
25561 .endlist
25562
25563 .vitem &*delay*&&~=&~<&'time'&>
25564 .cindex "&%delay%& ACL modifier"
25565 .oindex "&%-bh%&"
25566 This modifier may appear in any ACL. It causes Exim to wait for the time
25567 interval before proceeding. However, when testing Exim using the &%-bh%&
25568 option, the delay is not actually imposed (an appropriate message is output
25569 instead). The time is given in the usual Exim notation, and the delay happens
25570 as soon as the modifier is processed. In an SMTP session, pending output is
25571 flushed before the delay is imposed.
25572
25573 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
25574 example:
25575 .code
25576 deny    ...some conditions...
25577         delay = 30s
25578 .endd
25579 The delay happens if all the conditions are true, before the statement returns
25580 &"deny"&. Compare this with:
25581 .code
25582 deny    delay = 30s
25583         ...some conditions...
25584 .endd
25585 which waits for 30s before processing the conditions. The &%delay%& modifier
25586 can also be used with &%warn%& and together with &%control%&:
25587 .code
25588 warn    ...some conditions...
25589         delay = 2m
25590         control = freeze
25591 accept  ...
25592 .endd
25593
25594 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
25595 responses to several commands are no longer buffered and sent in one packet (as
25596 they would normally be) because all output is flushed before imposing the
25597 delay. This optimization is disabled so that a number of small delays do not
25598 appear to the client as one large aggregated delay that might provoke an
25599 unwanted timeout. You can, however, disable output flushing for &%delay%& by
25600 using a &%control%& modifier to set &%no_delay_flush%&.
25601
25602
25603 .vitem &*endpass*&
25604 .cindex "&%endpass%& ACL modifier"
25605 This modifier, which has no argument, is recognized only in &%accept%& and
25606 &%discard%& statements. It marks the boundary between the conditions whose
25607 failure causes control to pass to the next statement, and the conditions whose
25608 failure causes the ACL to return &"deny"&. This concept has proved to be
25609 confusing to some people, so the use of &%endpass%& is no longer recommended as
25610 &"best practice"&. See the description of &%accept%& above for more details.
25611
25612
25613 .vitem &*log_message*&&~=&~<&'text'&>
25614 .cindex "&%log_message%& ACL modifier"
25615 This modifier sets up a message that is used as part of the log message if the
25616 ACL denies access or a &%warn%& statement's conditions are true. For example:
25617 .code
25618 require log_message = wrong cipher suite $tls_cipher
25619         encrypted   = DES-CBC3-SHA
25620 .endd
25621 &%log_message%& is also used when recipients are discarded by &%discard%&. For
25622 example:
25623 .display
25624 &`discard `&<&'some conditions'&>
25625 &`        log_message = Discarded $local_part@$domain because...`&
25626 .endd
25627 When access is denied, &%log_message%& adds to any underlying error message
25628 that may exist because of a condition failure. For example, while verifying a
25629 recipient address, a &':fail:'& redirection might have already set up a
25630 message.
25631
25632 The message may be defined before the conditions to which it applies, because
25633 the string expansion does not happen until Exim decides that access is to be
25634 denied. This means that any variables that are set by the condition are
25635 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
25636 variables are set after a DNS black list lookup succeeds. If the expansion of
25637 &%log_message%& fails, or if the result is an empty string, the modifier is
25638 ignored.
25639
25640 .vindex "&$acl_verify_message$&"
25641 If you want to use a &%warn%& statement to log the result of an address
25642 verification, you can use &$acl_verify_message$& to include the verification
25643 error message.
25644
25645 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
25646 the start of the logged message. If the same warning log message is requested
25647 more than once while receiving  a single email message, only one copy is
25648 actually logged. If you want to log multiple copies, use &%logwrite%& instead
25649 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
25650 is logged for a successful &%warn%& statement.
25651
25652 If &%log_message%& is not present and there is no underlying error message (for
25653 example, from the failure of address verification), but &%message%& is present,
25654 the &%message%& text is used for logging rejections. However, if any text for
25655 logging contains newlines, only the first line is logged. In the absence of
25656 both &%log_message%& and &%message%&, a default built-in message is used for
25657 logging rejections.
25658
25659
25660 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
25661 .cindex "&%log_reject_target%& ACL modifier"
25662 .cindex "logging in ACL" "specifying which log"
25663 This modifier makes it possible to specify which logs are used for messages
25664 about ACL rejections. Its argument is a colon-separated list of words that can
25665 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
25666 may be empty, in which case a rejection is not logged at all. For example, this
25667 ACL fragment writes no logging information when access is denied:
25668 .display
25669 &`deny `&<&'some conditions'&>
25670 &`     log_reject_target =`&
25671 .endd
25672 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
25673 permanent and temporary rejections. Its effect lasts for the rest of the
25674 current ACL.
25675
25676
25677 .vitem &*logwrite*&&~=&~<&'text'&>
25678 .cindex "&%logwrite%& ACL modifier"
25679 .cindex "logging in ACL" "immediate"
25680 This modifier writes a message to a log file as soon as it is encountered when
25681 processing an ACL. (Compare &%log_message%&, which, except in the case of
25682 &%warn%& and &%discard%&, is used only if the ACL statement denies
25683 access.) The &%logwrite%& modifier can be used to log special incidents in
25684 ACLs. For example:
25685 .display
25686 &`accept `&<&'some special conditions'&>
25687 &`       control  = freeze`&
25688 &`       logwrite = froze message because ...`&
25689 .endd
25690 By default, the message is written to the main log. However, it may begin
25691 with a colon, followed by a comma-separated list of log names, and then
25692 another colon, to specify exactly which logs are to be written. For
25693 example:
25694 .code
25695 logwrite = :main,reject: text for main and reject logs
25696 logwrite = :panic: text for panic log only
25697 .endd
25698
25699
25700 .vitem &*message*&&~=&~<&'text'&>
25701 .cindex "&%message%& ACL modifier"
25702 This modifier sets up a text string that is expanded and used as a response
25703 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
25704 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
25705 there is some complication if &%endpass%& is involved; see the description of
25706 &%accept%& for details.)
25707
25708 The expansion of the message happens at the time Exim decides that the ACL is
25709 to end, not at the time it processes &%message%&. If the expansion fails, or
25710 generates an empty string, the modifier is ignored. Here is an example where
25711 &%message%& must be specified first, because the ACL ends with a rejection if
25712 the &%hosts%& condition fails:
25713 .code
25714 require  message = Host not recognized
25715          hosts = 10.0.0.0/8
25716 .endd
25717 (Once a condition has failed, no further conditions or modifiers are
25718 processed.)
25719
25720 .cindex "SMTP" "error codes"
25721 .oindex "&%smtp_banner%&
25722 For ACLs that are triggered by SMTP commands, the message is returned as part
25723 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
25724 is meaningful only for SMTP, as no message is returned when a non-SMTP message
25725 is accepted. In the case of the connect ACL, accepting with a message modifier
25726 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
25727 accept message may not contain more than one line (otherwise it will be
25728 truncated at the first newline and a panic logged), and it cannot affect the
25729 EHLO options.
25730
25731 When SMTP is involved, the message may begin with an overriding response code,
25732 consisting of three digits optionally followed by an &"extended response code"&
25733 of the form &'n.n.n'&, each code being followed by a space. For example:
25734 .code
25735 deny  message = 599 1.2.3 Host not welcome
25736       hosts = 192.168.34.0/24
25737 .endd
25738 The first digit of the supplied response code must be the same as would be sent
25739 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
25740 access, but for the predata ACL, note that the default success code is 354, not
25741 2&'xx'&.
25742
25743 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
25744 the message modifier cannot override the 221 response code.
25745
25746 The text in a &%message%& modifier is literal; any quotes are taken as
25747 literals, but because the string is expanded, backslash escapes are processed
25748 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
25749 response.
25750
25751 .vindex "&$acl_verify_message$&"
25752 If &%message%& is used on a statement that verifies an address, the message
25753 specified overrides any message that is generated by the verification process.
25754 However, the original message is available in the variable
25755 &$acl_verify_message$&, so you can incorporate it into your message if you
25756 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
25757 routers to be passed back as part of the SMTP response, you should either not
25758 use a &%message%& modifier, or make use of &$acl_verify_message$&.
25759
25760 For compatibility with previous releases of Exim, a &%message%& modifier that
25761 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
25762 modifier, but this usage is now deprecated. However, &%message%& acts only when
25763 all the conditions are true, wherever it appears in an ACL command, whereas
25764 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
25765 &%warn%& in an ACL that is not concerned with receiving a message, it has no
25766 effect.
25767
25768
25769 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
25770 .cindex "&%set%& ACL modifier"
25771 This modifier puts a value into one of the ACL variables (see section
25772 &<<SECTaclvariables>>&).
25773 .endlist
25774
25775
25776
25777
25778
25779 .section "Use of the control modifier" "SECTcontrols"
25780 .cindex "&%control%& ACL modifier"
25781 The &%control%& modifier supports the following settings:
25782
25783 .vlist
25784 .vitem &*control&~=&~allow_auth_unadvertised*&
25785 This modifier allows a client host to use the SMTP AUTH command even when it
25786 has not been advertised in response to EHLO. Furthermore, because there are
25787 apparently some really broken clients that do this, Exim will accept AUTH after
25788 HELO (rather than EHLO) when this control is set. It should be used only if you
25789 really need it, and you should limit its use to those broken clients that do
25790 not work without it. For example:
25791 .code
25792 warn hosts   = 192.168.34.25
25793      control = allow_auth_unadvertised
25794 .endd
25795 Normally, when an Exim server receives an AUTH command, it checks the name of
25796 the authentication mechanism that is given in the command to ensure that it
25797 matches an advertised mechanism. When this control is set, the check that a
25798 mechanism has been advertised is bypassed. Any configured mechanism can be used
25799 by the client. This control is permitted only in the connection and HELO ACLs.
25800
25801
25802 .vitem &*control&~=&~caseful_local_part*& &&&
25803        &*control&~=&~caselower_local_part*&
25804 .cindex "&ACL;" "case of local part in"
25805 .cindex "case of local parts"
25806 .vindex "&$local_part$&"
25807 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
25808 (that is, during RCPT processing). By default, the contents of &$local_part$&
25809 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
25810 any uppercase letters in the original local part are restored in &$local_part$&
25811 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
25812 is encountered.
25813
25814 These controls affect only the current recipient. Moreover, they apply only to
25815 local part handling that takes place directly in the ACL (for example, as a key
25816 in lookups). If a test to verify the recipient is obeyed, the case-related
25817 handling of the local part during the verification is controlled by the router
25818 configuration (see the &%caseful_local_part%& generic router option).
25819
25820 This facility could be used, for example, to add a spam score to local parts
25821 containing upper case letters. For example, using &$acl_m4$& to accumulate the
25822 spam score:
25823 .code
25824 warn  control = caseful_local_part
25825       set acl_m4 = ${eval:\
25826                      $acl_m4 + \
25827                      ${if match{$local_part}{[A-Z]}{1}{0}}\
25828                     }
25829       control = caselower_local_part
25830 .endd
25831 Notice that we put back the lower cased version afterwards, assuming that
25832 is what is wanted for subsequent tests.
25833
25834 .vitem &*control&~=&~debug/*&<&'options'&>
25835 .cindex "&ACL;" "enabling debug logging"
25836 .cindex "debugging" "enabling from an ACL"
25837 This control turns on debug logging, almost as though Exim had been invoked
25838 with &`-d`&, with the output going to a new logfile, by default called
25839 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
25840 may access any variables already defined.  The logging may be adjusted with
25841 the &'opts'& option, which takes the same values as the &`-d`& command-line
25842 option.  Some examples (which depend on variables that don't exist in all
25843 contexts):
25844 .code
25845       control = debug
25846       control = debug/tag=.$sender_host_address
25847       control = debug/opts=+expand+acl
25848       control = debug/tag=.$message_exim_id/opts=+expand
25849 .endd
25850
25851 .vitem &*control&~=&~enforce_sync*& &&&
25852        &*control&~=&~no_enforce_sync*&
25853 .cindex "SMTP" "synchronization checking"
25854 .cindex "synchronization checking in SMTP"
25855 These controls make it possible to be selective about when SMTP synchronization
25856 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
25857 state of the switch (it is true by default). See the description of this option
25858 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
25859
25860 The effect of these two controls lasts for the remainder of the SMTP
25861 connection. They can appear in any ACL except the one for the non-SMTP
25862 messages. The most straightforward place to put them is in the ACL defined by
25863 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
25864 before the first synchronization check. The expected use is to turn off the
25865 synchronization checks for badly-behaved hosts that you nevertheless need to
25866 work with.
25867
25868
25869 .vitem &*control&~=&~fakedefer/*&<&'message'&>
25870 .cindex "fake defer"
25871 .cindex "defer, fake"
25872 This control works in exactly the same way as &%fakereject%& (described below)
25873 except that it causes an SMTP 450 response after the message data instead of a
25874 550 response. You must take care when using &%fakedefer%& because it causes the
25875 messages to be duplicated when the sender retries. Therefore, you should not
25876 use &%fakedefer%& if the message is to be delivered normally.
25877
25878 .vitem &*control&~=&~fakereject/*&<&'message'&>
25879 .cindex "fake rejection"
25880 .cindex "rejection, fake"
25881 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
25882 words, only when an SMTP message is being received. If Exim accepts the
25883 message, instead the final 250 response, a 550 rejection message is sent.
25884 However, Exim proceeds to deliver the message as normal. The control applies
25885 only to the current message, not to any subsequent ones that may be received in
25886 the same SMTP connection.
25887
25888 The text for the 550 response is taken from the &%control%& modifier. If no
25889 message is supplied, the following is used:
25890 .code
25891 550-Your message has been rejected but is being
25892 550-kept for evaluation.
25893 550-If it was a legitimate message, it may still be
25894 550 delivered to the target recipient(s).
25895 .endd
25896 This facility should be used with extreme caution.
25897
25898 .vitem &*control&~=&~freeze*&
25899 .cindex "frozen messages" "forcing in ACL"
25900 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
25901 other words, only when a message is being received. If the message is accepted,
25902 it is placed on Exim's queue and frozen. The control applies only to the
25903 current message, not to any subsequent ones that may be received in the same
25904 SMTP connection.
25905
25906 This modifier can optionally be followed by &`/no_tell`&. If the global option
25907 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
25908 is told about the freezing), provided all the &*control=freeze*& modifiers that
25909 are obeyed for the current message have the &`/no_tell`& option.
25910
25911 .vitem &*control&~=&~no_delay_flush*&
25912 .cindex "SMTP" "output flushing, disabling for delay"
25913 Exim normally flushes SMTP output before implementing a delay in an ACL, to
25914 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
25915 use. This control, as long as it is encountered before the &%delay%& modifier,
25916 disables such output flushing.
25917
25918 .vitem &*control&~=&~no_callout_flush*&
25919 .cindex "SMTP" "output flushing, disabling for callout"
25920 Exim normally flushes SMTP output before performing a callout in an ACL, to
25921 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
25922 use. This control, as long as it is encountered before the &%verify%& condition
25923 that causes the callout, disables such output flushing.
25924
25925 .vitem &*control&~=&~no_mbox_unspool*&
25926 This control is available when Exim is compiled with the content scanning
25927 extension. Content scanning may require a copy of the current message, or parts
25928 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
25929 or spam scanner. Normally, such copies are deleted when they are no longer
25930 needed. If this control is set, the copies are not deleted. The control applies
25931 only to the current message, not to any subsequent ones that may be received in
25932 the same SMTP connection. It is provided for debugging purposes and is unlikely
25933 to be useful in production.
25934
25935 .vitem &*control&~=&~no_multiline_responses*&
25936 .cindex "multiline responses, suppressing"
25937 This control is permitted for any ACL except the one for non-SMTP messages.
25938 It seems that there are broken clients in use that cannot handle multiline
25939 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
25940
25941 If this control is set, multiline SMTP responses from ACL rejections are
25942 suppressed. One way of doing this would have been to put out these responses as
25943 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
25944 (&"use multiline responses for more"& it says &-- ha!), and some of the
25945 responses might get close to that. So this facility, which is after all only a
25946 sop to broken clients, is implemented by doing two very easy things:
25947
25948 .ilist
25949 Extra information that is normally output as part of a rejection caused by
25950 sender verification failure is omitted. Only the final line (typically &"sender
25951 verification failed"&) is sent.
25952 .next
25953 If a &%message%& modifier supplies a multiline response, only the first
25954 line is output.
25955 .endlist
25956
25957 The setting of the switch can, of course, be made conditional on the
25958 calling host. Its effect lasts until the end of the SMTP connection.
25959
25960 .vitem &*control&~=&~no_pipelining*&
25961 .cindex "PIPELINING" "suppressing advertising"
25962 This control turns off the advertising of the PIPELINING extension to SMTP in
25963 the current session. To be useful, it must be obeyed before Exim sends its
25964 response to an EHLO command. Therefore, it should normally appear in an ACL
25965 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
25966 &%pipelining_advertise_hosts%&.
25967
25968 .vitem &*control&~=&~queue_only*&
25969 .oindex "&%queue_only%&"
25970 .cindex "queueing incoming messages"
25971 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
25972 other words, only when a message is being received. If the message is accepted,
25973 it is placed on Exim's queue and left there for delivery by a subsequent queue
25974 runner. No immediate delivery process is started. In other words, it has the
25975 effect as the &%queue_only%& global option. However, the control applies only
25976 to the current message, not to any subsequent ones that may be received in the
25977 same SMTP connection.
25978
25979 .vitem &*control&~=&~submission/*&<&'options'&>
25980 .cindex "message" "submission"
25981 .cindex "submission mode"
25982 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
25983 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
25984 the current message is a submission from a local MUA. In this case, Exim
25985 operates in &"submission mode"&, and applies certain fixups to the message if
25986 necessary. For example, it adds a &'Date:'& header line if one is not present.
25987 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
25988 late (the message has already been created).
25989
25990 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
25991 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
25992 submission mode; the available options for this control are described there.
25993 The control applies only to the current message, not to any subsequent ones
25994 that may be received in the same SMTP connection.
25995
25996 .vitem &*control&~=&~suppress_local_fixups*&
25997 .cindex "submission fixups, suppressing"
25998 This control applies to locally submitted (non TCP/IP) messages, and is the
25999 complement of &`control = submission`&. It disables the fixups that are
26000 normally applied to locally-submitted messages. Specifically:
26001
26002 .ilist
26003 Any &'Sender:'& header line is left alone (in this respect, it is a
26004 dynamic version of &%local_sender_retain%&).
26005 .next
26006 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
26007 .next
26008 There is no check that &'From:'& corresponds to the actual sender.
26009 .endlist ilist
26010
26011 This control may be useful when a remotely-originated message is accepted,
26012 passed to some scanning program, and then re-submitted for delivery. It can be
26013 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
26014 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
26015 data is read.
26016
26017 &*Note:*& This control applies only to the current message, not to any others
26018 that are being submitted at the same time using &%-bs%& or &%-bS%&.
26019 .endlist vlist
26020
26021
26022 .section "Summary of message fixup control" "SECTsummesfix"
26023 All four possibilities for message fixups can be specified:
26024
26025 .ilist
26026 Locally submitted, fixups applied: the default.
26027 .next
26028 Locally submitted, no fixups applied: use
26029 &`control = suppress_local_fixups`&.
26030 .next
26031 Remotely submitted, no fixups applied: the default.
26032 .next
26033 Remotely submitted, fixups applied: use &`control = submission`&.
26034 .endlist
26035
26036
26037
26038 .section "Adding header lines in ACLs" "SECTaddheadacl"
26039 .cindex "header lines" "adding in an ACL"
26040 .cindex "header lines" "position of added lines"
26041 .cindex "&%message%& ACL modifier"
26042 The &%add_header%& modifier can be used to add one or more extra header lines
26043 to an incoming message, as in this example:
26044 .code
26045 warn dnslists = sbl.spamhaus.org : \
26046                 dialup.mail-abuse.org
26047      add_header = X-blacklisted-at: $dnslist_domain
26048 .endd
26049 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
26050 MIME, and non-SMTP ACLs (in other words, those that are concerned with
26051 receiving a message). The message must ultimately be accepted for
26052 &%add_header%& to have any significant effect. You can use &%add_header%& with
26053 any ACL verb, including &%deny%& (though this is potentially useful only in a
26054 RCPT ACL).
26055
26056 If the data for the &%add_header%& modifier contains one or more newlines that
26057 are not followed by a space or a tab, it is assumed to contain multiple header
26058 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
26059 front of any line that is not a valid header line.
26060
26061 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
26062 They are added to the message before processing the DATA and MIME ACLs.
26063 However, if an identical header line is requested more than once, only one copy
26064 is actually added to the message. Further header lines may be accumulated
26065 during the DATA and MIME ACLs, after which they are added to the message, again
26066 with duplicates suppressed. Thus, it is possible to add two identical header
26067 lines to an SMTP message, but only if one is added before DATA and one after.
26068 In the case of non-SMTP messages, new headers are accumulated during the
26069 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
26070 message is rejected after DATA or by the non-SMTP ACL, all added header lines
26071 are included in the entry that is written to the reject log.
26072
26073 .cindex "header lines" "added; visibility of"
26074 Header lines are not visible in string expansions until they are added to the
26075 message. It follows that header lines defined in the MAIL, RCPT, and predata
26076 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
26077 header lines that are added by the DATA or MIME ACLs are not visible in those
26078 ACLs. Because of this restriction, you cannot use header lines as a way of
26079 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
26080 this, you can use ACL variables, as described in section
26081 &<<SECTaclvariables>>&.
26082
26083 The &%add_header%& modifier acts immediately it is encountered during the
26084 processing of an ACL. Notice the difference between these two cases:
26085 .display
26086 &`accept add_header = ADDED: some text`&
26087 &`       `&<&'some condition'&>
26088
26089 &`accept `&<&'some condition'&>
26090 &`       add_header = ADDED: some text`&
26091 .endd
26092 In the first case, the header line is always added, whether or not the
26093 condition is true. In the second case, the header line is added only if the
26094 condition is true. Multiple occurrences of &%add_header%& may occur in the same
26095 ACL statement. All those that are encountered before a condition fails are
26096 honoured.
26097
26098 .cindex "&%warn%& ACL verb"
26099 For compatibility with previous versions of Exim, a &%message%& modifier for a
26100 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
26101 effect only if all the conditions are true, even if it appears before some of
26102 them. Furthermore, only the last occurrence of &%message%& is honoured. This
26103 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
26104 are present on a &%warn%& verb, both are processed according to their
26105 specifications.
26106
26107 By default, new header lines are added to a message at the end of the existing
26108 header lines. However, you can specify that any particular header line should
26109 be added right at the start (before all the &'Received:'& lines), immediately
26110 after the first block of &'Received:'& lines, or immediately before any line
26111 that is not a &'Received:'& or &'Resent-something:'& header.
26112
26113 This is done by specifying &":at_start:"&, &":after_received:"&, or
26114 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
26115 header line, respectively. (Header text cannot start with a colon, as there has
26116 to be a header name first.) For example:
26117 .code
26118 warn add_header = \
26119        :after_received:X-My-Header: something or other...
26120 .endd
26121 If more than one header line is supplied in a single &%add_header%& modifier,
26122 each one is treated independently and can therefore be placed differently. If
26123 you add more than one line at the start, or after the Received: block, they end
26124 up in reverse order.
26125
26126 &*Warning*&: This facility currently applies only to header lines that are
26127 added in an ACL. It does NOT work for header lines that are added in a
26128 system filter or in a router or transport.
26129
26130
26131
26132
26133 .section "ACL conditions" "SECTaclconditions"
26134 .cindex "&ACL;" "conditions; list of"
26135 Some of conditions listed in this section are available only when Exim is
26136 compiled with the content-scanning extension. They are included here briefly
26137 for completeness. More detailed descriptions can be found in the discussion on
26138 content scanning in chapter &<<CHAPexiscan>>&.
26139
26140 Not all conditions are relevant in all circumstances. For example, testing
26141 senders and recipients does not make sense in an ACL that is being run as the
26142 result of the arrival of an ETRN command, and checks on message headers can be
26143 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
26144 can use the same condition (with different parameters) more than once in the
26145 same ACL statement. This provides a way of specifying an &"and"& conjunction.
26146 The conditions are as follows:
26147
26148
26149 .vlist
26150 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
26151 .cindex "&ACL;" "nested"
26152 .cindex "&ACL;" "indirect"
26153 .cindex "&%acl%& ACL condition"
26154 The possible values of the argument are the same as for the
26155 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
26156 &"accept"& the condition is true; if it returns &"deny"& the condition is
26157 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
26158 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
26159 condition false. This means that further processing of the &%warn%& verb
26160 ceases, but processing of the ACL continues.
26161
26162 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
26163 the connection is dropped. If it returns &"discard"&, the verb must be
26164 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
26165 conditions are tested.
26166
26167 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
26168 loops. This condition allows you to use different ACLs in different
26169 circumstances. For example, different ACLs can be used to handle RCPT commands
26170 for different local users or different local domains.
26171
26172 .vitem &*authenticated&~=&~*&<&'string&~list'&>
26173 .cindex "&%authenticated%& ACL condition"
26174 .cindex "authentication" "ACL checking"
26175 .cindex "&ACL;" "testing for authentication"
26176 If the SMTP connection is not authenticated, the condition is false. Otherwise,
26177 the name of the authenticator is tested against the list. To test for
26178 authentication by any authenticator, you can set
26179 .code
26180 authenticated = *
26181 .endd
26182
26183 .vitem &*condition&~=&~*&<&'string'&>
26184 .cindex "&%condition%& ACL condition"
26185 .cindex "customizing" "ACL condition"
26186 .cindex "&ACL;" "customized test"
26187 .cindex "&ACL;" "testing, customized"
26188 This feature allows you to make up custom conditions. If the result of
26189 expanding the string is an empty string, the number zero, or one of the strings
26190 &"no"& or &"false"&, the condition is false. If the result is any non-zero
26191 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
26192 any other value, some error is assumed to have occurred, and the ACL returns
26193 &"defer"&. However, if the expansion is forced to fail, the condition is
26194 ignored. The effect is to treat it as true, whether it is positive or
26195 negative.
26196
26197 .vitem &*decode&~=&~*&<&'location'&>
26198 .cindex "&%decode%& ACL condition"
26199 This condition is available only when Exim is compiled with the
26200 content-scanning extension, and it is allowed only in the ACL defined by
26201 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
26202 If all goes well, the condition is true. It is false only if there are
26203 problems such as a syntax error or a memory shortage. For more details, see
26204 chapter &<<CHAPexiscan>>&.
26205
26206 .vitem &*demime&~=&~*&<&'extension&~list'&>
26207 .cindex "&%demime%& ACL condition"
26208 This condition is available only when Exim is compiled with the
26209 content-scanning extension. Its use is described in section
26210 &<<SECTdemimecond>>&.
26211
26212 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
26213 .cindex "&%dnslists%& ACL condition"
26214 .cindex "DNS list" "in ACL"
26215 .cindex "black list (DNS)"
26216 .cindex "&ACL;" "testing a DNS list"
26217 This condition checks for entries in DNS black lists. These are also known as
26218 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
26219 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
26220 different variants of this condition to describe briefly here. See sections
26221 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
26222
26223 .vitem &*domains&~=&~*&<&'domain&~list'&>
26224 .cindex "&%domains%& ACL condition"
26225 .cindex "domain" "ACL checking"
26226 .cindex "&ACL;" "testing a recipient domain"
26227 .vindex "&$domain_data$&"
26228 This condition is relevant only after a RCPT command. It checks that the domain
26229 of the recipient address is in the domain list. If percent-hack processing is
26230 enabled, it is done before this test is done. If the check succeeds with a
26231 lookup, the result of the lookup is placed in &$domain_data$& until the next
26232 &%domains%& test.
26233
26234 &*Note carefully*& (because many people seem to fall foul of this): you cannot
26235 use &%domains%& in a DATA ACL.
26236
26237
26238 .vitem &*encrypted&~=&~*&<&'string&~list'&>
26239 .cindex "&%encrypted%& ACL condition"
26240 .cindex "encryption" "checking in an ACL"
26241 .cindex "&ACL;" "testing for encryption"
26242 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
26243 name of the cipher suite in use is tested against the list. To test for
26244 encryption without testing for any specific cipher suite(s), set
26245 .code
26246 encrypted = *
26247 .endd
26248
26249
26250 .vitem &*hosts&~=&~*&<&'&~host&~list'&>
26251 .cindex "&%hosts%& ACL condition"
26252 .cindex "host" "ACL checking"
26253 .cindex "&ACL;" "testing the client host"
26254 This condition tests that the calling host matches the host list. If you have
26255 name lookups or wildcarded host names and IP addresses in the same host list,
26256 you should normally put the IP addresses first. For example, you could have:
26257 .code
26258 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
26259 .endd
26260 The lookup in this example uses the host name for its key. This is implied by
26261 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
26262 and it wouldn't matter which way round you had these two items.)
26263
26264 The reason for the problem with host names lies in the left-to-right way that
26265 Exim processes lists. It can test IP addresses without doing any DNS lookups,
26266 but when it reaches an item that requires a host name, it fails if it cannot
26267 find a host name to compare with the pattern. If the above list is given in the
26268 opposite order, the &%accept%& statement fails for a host whose name cannot be
26269 found, even if its IP address is 10.9.8.7.
26270
26271 If you really do want to do the name check first, and still recognize the IP
26272 address even if the name lookup fails, you can rewrite the ACL like this:
26273 .code
26274 accept hosts = dbm;/etc/friendly/hosts
26275 accept hosts = 10.9.8.7
26276 .endd
26277 The default action on failing to find the host name is to assume that the host
26278 is not in the list, so the first &%accept%& statement fails. The second
26279 statement can then check the IP address.
26280
26281 .vindex "&$host_data$&"
26282 If a &%hosts%& condition is satisfied by means of a lookup, the result
26283 of the lookup is made available in the &$host_data$& variable. This
26284 allows you, for example, to set up a statement like this:
26285 .code
26286 deny  hosts = net-lsearch;/some/file
26287 message = $host_data
26288 .endd
26289 which gives a custom error message for each denied host.
26290
26291 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
26292 .cindex "&%local_parts%& ACL condition"
26293 .cindex "local part" "ACL checking"
26294 .cindex "&ACL;" "testing a local part"
26295 .vindex "&$local_part_data$&"
26296 This condition is relevant only after a RCPT command. It checks that the local
26297 part of the recipient address is in the list. If percent-hack processing is
26298 enabled, it is done before this test. If the check succeeds with a lookup, the
26299 result of the lookup is placed in &$local_part_data$&, which remains set until
26300 the next &%local_parts%& test.
26301
26302 .vitem &*malware&~=&~*&<&'option'&>
26303 .cindex "&%malware%& ACL condition"
26304 .cindex "&ACL;" "virus scanning"
26305 .cindex "&ACL;" "scanning for viruses"
26306 This condition is available only when Exim is compiled with the
26307 content-scanning extension. It causes the incoming message to be scanned for
26308 viruses. For details, see chapter &<<CHAPexiscan>>&.
26309
26310 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
26311 .cindex "&%mime_regex%& ACL condition"
26312 .cindex "&ACL;" "testing by regex matching"
26313 This condition is available only when Exim is compiled with the
26314 content-scanning extension, and it is allowed only in the ACL defined by
26315 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
26316 with any of the regular expressions. For details, see chapter
26317 &<<CHAPexiscan>>&.
26318
26319 .vitem &*ratelimit&~=&~*&<&'parameters'&>
26320 .cindex "rate limiting"
26321 This condition can be used to limit the rate at which a user or host submits
26322 messages. Details are given in section &<<SECTratelimiting>>&.
26323
26324 .vitem &*recipients&~=&~*&<&'address&~list'&>
26325 .cindex "&%recipients%& ACL condition"
26326 .cindex "recipient" "ACL checking"
26327 .cindex "&ACL;" "testing a recipient"
26328 This condition is relevant only after a RCPT command. It checks the entire
26329 recipient address against a list of recipients.
26330
26331 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
26332 .cindex "&%regex%& ACL condition"
26333 .cindex "&ACL;" "testing by regex matching"
26334 This condition is available only when Exim is compiled with the
26335 content-scanning extension, and is available only in the DATA, MIME, and
26336 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
26337 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
26338
26339 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
26340 .cindex "&%sender_domains%& ACL condition"
26341 .cindex "sender" "ACL checking"
26342 .cindex "&ACL;" "testing a sender domain"
26343 .vindex "&$domain$&"
26344 .vindex "&$sender_address_domain$&"
26345 This condition tests the domain of the sender of the message against the given
26346 domain list. &*Note*&: The domain of the sender address is in
26347 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
26348 of this condition. This is an exception to the general rule for testing domain
26349 lists. It is done this way so that, if this condition is used in an ACL for a
26350 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
26351 influence the sender checking.
26352
26353 &*Warning*&: It is a bad idea to use this condition on its own as a control on
26354 relaying, because sender addresses are easily, and commonly, forged.
26355
26356 .vitem &*senders&~=&~*&<&'address&~list'&>
26357 .cindex "&%senders%& ACL condition"
26358 .cindex "sender" "ACL checking"
26359 .cindex "&ACL;" "testing a sender"
26360 This condition tests the sender of the message against the given list. To test
26361 for a bounce message, which has an empty sender, set
26362 .code
26363 senders = :
26364 .endd
26365 &*Warning*&: It is a bad idea to use this condition on its own as a control on
26366 relaying, because sender addresses are easily, and commonly, forged.
26367
26368 .vitem &*spam&~=&~*&<&'username'&>
26369 .cindex "&%spam%& ACL condition"
26370 .cindex "&ACL;" "scanning for spam"
26371 This condition is available only when Exim is compiled with the
26372 content-scanning extension. It causes the incoming message to be scanned by
26373 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
26374
26375 .vitem &*verify&~=&~certificate*&
26376 .cindex "&%verify%& ACL condition"
26377 .cindex "TLS" "client certificate verification"
26378 .cindex "certificate" "verification of client"
26379 .cindex "&ACL;" "certificate verification"
26380 .cindex "&ACL;" "testing a TLS certificate"
26381 This condition is true in an SMTP session if the session is encrypted, and a
26382 certificate was received from the client, and the certificate was verified. The
26383 server requests a certificate only if the client matches &%tls_verify_hosts%&
26384 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
26385
26386 .vitem &*verify&~=&~csa*&
26387 .cindex "CSA verification"
26388 This condition checks whether the sending host (the client) is authorized to
26389 send email. Details of how this works are given in section
26390 &<<SECTverifyCSA>>&.
26391
26392 .vitem &*verify&~=&~header_sender/*&<&'options'&>
26393 .cindex "&%verify%& ACL condition"
26394 .cindex "&ACL;" "verifying sender in the header"
26395 .cindex "header lines" "verifying the sender in"
26396 .cindex "sender" "verifying in header"
26397 .cindex "verifying" "sender in header"
26398 This condition is relevant only in an ACL that is run after a message has been
26399 received, that is, in an ACL specified by &%acl_smtp_data%& or
26400 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
26401 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
26402 is loosely thought of as a &"sender"& address (hence the name of the test).
26403 However, an address that appears in one of these headers need not be an address
26404 that accepts bounce messages; only sender addresses in envelopes are required
26405 to accept bounces. Therefore, if you use the callout option on this check, you
26406 might want to arrange for a non-empty address in the MAIL command.
26407
26408 Details of address verification and the options are given later, starting at
26409 section &<<SECTaddressverification>>& (callouts are described in section
26410 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
26411 condition to restrict it to bounce messages only:
26412 .code
26413 deny    senders = :
26414         message = A valid sender header is required for bounces
26415        !verify  = header_sender
26416 .endd
26417
26418 .vitem &*verify&~=&~header_syntax*&
26419 .cindex "&%verify%& ACL condition"
26420 .cindex "&ACL;" "verifying header syntax"
26421 .cindex "header lines" "verifying syntax"
26422 .cindex "verifying" "header syntax"
26423 This condition is relevant only in an ACL that is run after a message has been
26424 received, that is, in an ACL specified by &%acl_smtp_data%& or
26425 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
26426 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
26427 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
26428 permitted only in locally generated messages and from hosts that match
26429 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26430 appropriate.
26431
26432 Note that this condition is a syntax check only. However, a common spamming
26433 ploy used to be to send syntactically invalid headers such as
26434 .code
26435 To: @
26436 .endd
26437 and this condition can be used to reject such messages, though they are not as
26438 common as they used to be.
26439
26440 .vitem &*verify&~=&~helo*&
26441 .cindex "&%verify%& ACL condition"
26442 .cindex "&ACL;" "verifying HELO/EHLO"
26443 .cindex "HELO" "verifying"
26444 .cindex "EHLO" "verifying"
26445 .cindex "verifying" "EHLO"
26446 .cindex "verifying" "HELO"
26447 This condition is true if a HELO or EHLO command has been received from the
26448 client host, and its contents have been verified. If there has been no previous
26449 attempt to verify the HELO/EHLO contents, it is carried out when this
26450 condition is encountered. See the description of the &%helo_verify_hosts%& and
26451 &%helo_try_verify_hosts%& options for details of how to request verification
26452 independently of this condition.
26453
26454 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
26455 option), this condition is always true.
26456
26457
26458 .vitem &*verify&~=&~not_blind*&
26459 .cindex "verifying" "not blind"
26460 .cindex "bcc recipients, verifying none"
26461 This condition checks that there are no blind (bcc) recipients in the message.
26462 Every envelope recipient must appear either in a &'To:'& header line or in a
26463 &'Cc:'& header line for this condition to be true. Local parts are checked
26464 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
26465 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
26466 used only in a DATA or non-SMTP ACL.
26467
26468 There are, of course, many legitimate messages that make use of blind (bcc)
26469 recipients. This check should not be used on its own for blocking messages.
26470
26471
26472 .vitem &*verify&~=&~recipient/*&<&'options'&>
26473 .cindex "&%verify%& ACL condition"
26474 .cindex "&ACL;" "verifying recipient"
26475 .cindex "recipient" "verifying"
26476 .cindex "verifying" "recipient"
26477 .vindex "&$address_data$&"
26478 This condition is relevant only after a RCPT command. It verifies the current
26479 recipient. Details of address verification are given later, starting at section
26480 &<<SECTaddressverification>>&. After a recipient has been verified, the value
26481 of &$address_data$& is the last value that was set while routing the address.
26482 This applies even if the verification fails. When an address that is being
26483 verified is redirected to a single address, verification continues with the new
26484 address, and in that case, the subsequent value of &$address_data$& is the
26485 value for the child address.
26486
26487 .vitem &*verify&~=&~reverse_host_lookup*&
26488 .cindex "&%verify%& ACL condition"
26489 .cindex "&ACL;" "verifying host reverse lookup"
26490 .cindex "host" "verifying reverse lookup"
26491 This condition ensures that a verified host name has been looked up from the IP
26492 address of the client host. (This may have happened already if the host name
26493 was needed for checking a host list, or if the host matched &%host_lookup%&.)
26494 Verification ensures that the host name obtained from a reverse DNS lookup, or
26495 one of its aliases, does, when it is itself looked up in the DNS, yield the
26496 original IP address.
26497
26498 If this condition is used for a locally generated message (that is, when there
26499 is no client host involved), it always succeeds.
26500
26501 .vitem &*verify&~=&~sender/*&<&'options'&>
26502 .cindex "&%verify%& ACL condition"
26503 .cindex "&ACL;" "verifying sender"
26504 .cindex "sender" "verifying"
26505 .cindex "verifying" "sender"
26506 This condition is relevant only after a MAIL or RCPT command, or after a
26507 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
26508 the message's sender is empty (that is, this is a bounce message), the
26509 condition is true. Otherwise, the sender address is verified.
26510
26511 .vindex "&$address_data$&"
26512 .vindex "&$sender_address_data$&"
26513 If there is data in the &$address_data$& variable at the end of routing, its
26514 value is placed in &$sender_address_data$& at the end of verification. This
26515 value can be used in subsequent conditions and modifiers in the same ACL
26516 statement. It does not persist after the end of the current statement. If you
26517 want to preserve the value for longer, you can save it in an ACL variable.
26518
26519 Details of verification are given later, starting at section
26520 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
26521 to avoid doing it more than once per message.
26522
26523 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
26524 .cindex "&%verify%& ACL condition"
26525 This is a variation of the previous option, in which a modified address is
26526 verified as a sender.
26527 .endlist
26528
26529
26530
26531 .section "Using DNS lists" "SECTmorednslists"
26532 .cindex "DNS list" "in ACL"
26533 .cindex "black list (DNS)"
26534 .cindex "&ACL;" "testing a DNS list"
26535 In its simplest form, the &%dnslists%& condition tests whether the calling host
26536 is on at least one of a number of DNS lists by looking up the inverted IP
26537 address in one or more DNS domains. (Note that DNS list domains are not mail
26538 domains, so the &`+`& syntax for named lists doesn't work - it is used for
26539 special options instead.) For example, if the calling host's IP
26540 address is 192.168.62.43, and the ACL statement is
26541 .code
26542 deny dnslists = blackholes.mail-abuse.org : \
26543                 dialups.mail-abuse.org
26544 .endd
26545 the following records are looked up:
26546 .code
26547 43.62.168.192.blackholes.mail-abuse.org
26548 43.62.168.192.dialups.mail-abuse.org
26549 .endd
26550 As soon as Exim finds an existing DNS record, processing of the list stops.
26551 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
26552 to test that a host is on more than one list (an &"and"& conjunction), you can
26553 use two separate conditions:
26554 .code
26555 deny dnslists = blackholes.mail-abuse.org
26556      dnslists = dialups.mail-abuse.org
26557 .endd
26558 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
26559 behaves as if the host does not match the list item, that is, as if the DNS
26560 record does not exist. If there are further items in the DNS list, they are
26561 processed.
26562
26563 This is usually the required action when &%dnslists%& is used with &%deny%&
26564 (which is the most common usage), because it prevents a DNS failure from
26565 blocking mail. However, you can change this behaviour by putting one of the
26566 following special items in the list:
26567 .display
26568 &`+include_unknown `&   behave as if the item is on the list
26569 &`+exclude_unknown `&   behave as if the item is not on the list (default)
26570 &`+defer_unknown   `&   give a temporary error
26571 .endd
26572 .cindex "&`+include_unknown`&"
26573 .cindex "&`+exclude_unknown`&"
26574 .cindex "&`+defer_unknown`&"
26575 Each of these applies to any subsequent items on the list. For example:
26576 .code
26577 deny dnslists = +defer_unknown : foo.bar.example
26578 .endd
26579 Testing the list of domains stops as soon as a match is found. If you want to
26580 warn for one list and block for another, you can use two different statements:
26581 .code
26582 deny  dnslists = blackholes.mail-abuse.org
26583 warn  message  = X-Warn: sending host is on dialups list
26584       dnslists = dialups.mail-abuse.org
26585 .endd
26586 DNS list lookups are cached by Exim for the duration of the SMTP session,
26587 so a lookup based on the IP address is done at most once for any incoming
26588 connection. Exim does not share information between multiple incoming
26589 connections (but your local name server cache should be active).
26590
26591
26592
26593 .section "Specifying the IP address for a DNS list lookup" "SECID201"
26594 .cindex "DNS list" "keyed by explicit IP address"
26595 By default, the IP address that is used in a DNS list lookup is the IP address
26596 of the calling host. However, you can specify another IP address by listing it
26597 after the domain name, introduced by a slash. For example:
26598 .code
26599 deny dnslists = black.list.tld/192.168.1.2
26600 .endd
26601 This feature is not very helpful with explicit IP addresses; it is intended for
26602 use with IP addresses that are looked up, for example, the IP addresses of the
26603 MX hosts or nameservers of an email sender address. For an example, see section
26604 &<<SECTmulkeyfor>>& below.
26605
26606
26607
26608
26609 .section "DNS lists keyed on domain names" "SECID202"
26610 .cindex "DNS list" "keyed by domain name"
26611 There are some lists that are keyed on domain names rather than inverted IP
26612 addresses (see for example the &'domain based zones'& link at
26613 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
26614 with these lists. You can change the name that is looked up in a DNS list by
26615 listing it after the domain name, introduced by a slash. For example,
26616 .code
26617 deny  message  = Sender's domain is listed at $dnslist_domain
26618       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
26619 .endd
26620 This particular example is useful only in ACLs that are obeyed after the
26621 RCPT or DATA commands, when a sender address is available. If (for
26622 example) the message's sender is &'user@tld.example'& the name that is looked
26623 up by this example is
26624 .code
26625 tld.example.dsn.rfc-ignorant.org
26626 .endd
26627 A single &%dnslists%& condition can contain entries for both names and IP
26628 addresses. For example:
26629 .code
26630 deny dnslists = sbl.spamhaus.org : \
26631                 dsn.rfc-ignorant.org/$sender_address_domain
26632 .endd
26633 The first item checks the sending host's IP address; the second checks a domain
26634 name. The whole condition is true if either of the DNS lookups succeeds.
26635
26636
26637
26638
26639 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
26640 .cindex "DNS list" "multiple keys for"
26641 The syntax described above for looking up explicitly-defined values (either
26642 names or IP addresses) in a DNS blacklist is a simplification. After the domain
26643 name for the DNS list, what follows the slash can in fact be a list of items.
26644 As with all lists in Exim, the default separator is a colon. However, because
26645 this is a sublist within the list of DNS blacklist domains, it is necessary
26646 either to double the separators like this:
26647 .code
26648 dnslists = black.list.tld/name.1::name.2
26649 .endd
26650 or to change the separator character, like this:
26651 .code
26652 dnslists = black.list.tld/<;name.1;name.2
26653 .endd
26654 If an item in the list is an IP address, it is inverted before the DNS
26655 blacklist domain is appended. If it is not an IP address, no inversion
26656 occurs. Consider this condition:
26657 .code
26658 dnslists = black.list.tld/<;192.168.1.2;a.domain
26659 .endd
26660 The DNS lookups that occur are:
26661 .code
26662 2.1.168.192.black.list.tld
26663 a.domain.black.list.tld
26664 .endd
26665 Once a DNS record has been found (that matches a specific IP return
26666 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
26667 are done. If there is a temporary DNS error, the rest of the sublist of domains
26668 or IP addresses is tried. A temporary error for the whole dnslists item occurs
26669 only if no other DNS lookup in this sublist succeeds. In other words, a
26670 successful lookup for any of the items in the sublist overrides a temporary
26671 error for a previous item.
26672
26673 The ability to supply a list of items after the slash is in some sense just a
26674 syntactic convenience. These two examples have the same effect:
26675 .code
26676 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
26677 dnslists = black.list.tld/a.domain::b.domain
26678 .endd
26679 However, when the data for the list is obtained from a lookup, the second form
26680 is usually much more convenient. Consider this example:
26681 .code
26682 deny message  = The mail servers for the domain \
26683                 $sender_address_domain \
26684                 are listed at $dnslist_domain ($dnslist_value); \
26685                 see $dnslist_text.
26686      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
26687                                    ${lookup dnsdb {>|mxh=\
26688                                    $sender_address_domain} }} }
26689 .endd
26690 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
26691 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
26692 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
26693 of expanding the condition might be something like this:
26694 .code
26695 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
26696 .endd
26697 Thus, this example checks whether or not the IP addresses of the sender
26698 domain's mail servers are on the Spamhaus black list.
26699
26700 The key that was used for a successful DNS list lookup is put into the variable
26701 &$dnslist_matched$& (see section &<<SECID204>>&).
26702
26703
26704
26705
26706 .section "Data returned by DNS lists" "SECID203"
26707 .cindex "DNS list" "data returned from"
26708 DNS lists are constructed using address records in the DNS. The original RBL
26709 just used the address 127.0.0.1 on the right hand side of each record, but the
26710 RBL+ list and some other lists use a number of values with different meanings.
26711 The values used on the RBL+ list are:
26712 .display
26713 127.1.0.1  RBL
26714 127.1.0.2  DUL
26715 127.1.0.3  DUL and RBL
26716 127.1.0.4  RSS
26717 127.1.0.5  RSS and RBL
26718 127.1.0.6  RSS and DUL
26719 127.1.0.7  RSS and DUL and RBL
26720 .endd
26721 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
26722 different values. Some DNS lists may return more than one address record;
26723 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
26724
26725
26726 .section "Variables set from DNS lists" "SECID204"
26727 .cindex "expansion" "variables, set from DNS list"
26728 .cindex "DNS list" "variables set from"
26729 .vindex "&$dnslist_domain$&"
26730 .vindex "&$dnslist_matched$&"
26731 .vindex "&$dnslist_text$&"
26732 .vindex "&$dnslist_value$&"
26733 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
26734 the name of the overall domain that matched (for example,
26735 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
26736 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
26737 the DNS record. When the key is an IP address, it is not reversed in
26738 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
26739 cases, for example:
26740 .code
26741 deny dnslists = spamhaus.example
26742 .endd
26743 the key is also available in another variable (in this case,
26744 &$sender_host_address$&). In more complicated cases, however, this is not true.
26745 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
26746 might generate a dnslists lookup like this:
26747 .code
26748 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
26749 .endd
26750 If this condition succeeds, the value in &$dnslist_matched$& might be
26751 &`192.168.6.7`& (for example).
26752
26753 If more than one address record is returned by the DNS lookup, all the IP
26754 addresses are included in &$dnslist_value$&, separated by commas and spaces.
26755 The variable &$dnslist_text$& contains the contents of any associated TXT
26756 record. For lists such as RBL+ the TXT record for a merged entry is often not
26757 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
26758 information.
26759
26760 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
26761 &-- although these appear before the condition in the ACL, they are not
26762 expanded until after it has failed. For example:
26763 .code
26764 deny    hosts = !+local_networks
26765         message = $sender_host_address is listed \
26766                   at $dnslist_domain
26767         dnslists = rbl-plus.mail-abuse.example
26768 .endd
26769
26770
26771
26772 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
26773 .cindex "DNS list" "matching specific returned data"
26774 You can add an equals sign and an IP address after a &%dnslists%& domain name
26775 in order to restrict its action to DNS records with a matching right hand side.
26776 For example,
26777 .code
26778 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
26779 .endd
26780 rejects only those hosts that yield 127.0.0.2. Without this additional data,
26781 any address record is considered to be a match. For the moment, we assume
26782 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
26783 describes how multiple records are handled.
26784
26785 More than one IP address may be given for checking, using a comma as a
26786 separator. These are alternatives &-- if any one of them matches, the
26787 &%dnslists%& condition is true. For example:
26788 .code
26789 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
26790 .endd
26791 If you want to specify a constraining address list and also specify names or IP
26792 addresses to be looked up, the constraining address list must be specified
26793 first. For example:
26794 .code
26795 deny dnslists = dsn.rfc-ignorant.org\
26796                 =127.0.0.2/$sender_address_domain
26797 .endd
26798
26799 If the character &`&&`& is used instead of &`=`&, the comparison for each
26800 listed IP address is done by a bitwise &"and"& instead of by an equality test.
26801 In other words, the listed addresses are used as bit masks. The comparison is
26802 true if all the bits in the mask are present in the address that is being
26803 tested. For example:
26804 .code
26805 dnslists = a.b.c&0.0.0.3
26806 .endd
26807 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
26808 want to test whether one bit or another bit is present (as opposed to both
26809 being present), you must use multiple values. For example:
26810 .code
26811 dnslists = a.b.c&0.0.0.1,0.0.0.2
26812 .endd
26813 matches if the final component of the address is an odd number or two times
26814 an odd number.
26815
26816
26817
26818 .section "Negated DNS matching conditions" "SECID205"
26819 You can supply a negative list of IP addresses as part of a &%dnslists%&
26820 condition. Whereas
26821 .code
26822 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
26823 .endd
26824 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
26825 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
26826 .code
26827 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
26828 .endd
26829 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
26830 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
26831 words, the result of the test is inverted if an exclamation mark appears before
26832 the &`=`& (or the &`&&`&) sign.
26833
26834 &*Note*&: This kind of negation is not the same as negation in a domain,
26835 host, or address list (which is why the syntax is different).
26836
26837 If you are using just one list, the negation syntax does not gain you much. The
26838 previous example is precisely equivalent to
26839 .code
26840 deny  dnslists = a.b.c
26841      !dnslists = a.b.c=127.0.0.2,127.0.0.3
26842 .endd
26843 However, if you are using multiple lists, the negation syntax is clearer.
26844 Consider this example:
26845 .code
26846 deny  dnslists = sbl.spamhaus.org : \
26847                  list.dsbl.org : \
26848                  dnsbl.njabl.org!=127.0.0.3 : \
26849                  relays.ordb.org
26850 .endd
26851 Using only positive lists, this would have to be:
26852 .code
26853 deny  dnslists = sbl.spamhaus.org : \
26854                  list.dsbl.org
26855 deny  dnslists = dnsbl.njabl.org
26856      !dnslists = dnsbl.njabl.org=127.0.0.3
26857 deny  dnslists = relays.ordb.org
26858 .endd
26859 which is less clear, and harder to maintain.
26860
26861
26862
26863
26864 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
26865 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
26866 thereby providing more than one IP address. When an item in a &%dnslists%& list
26867 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
26868 the match to specific results from the DNS lookup, there are two ways in which
26869 the checking can be handled. For example, consider the condition:
26870 .code
26871 dnslists = a.b.c=127.0.0.1
26872 .endd
26873 What happens if the DNS lookup for the incoming IP address yields both
26874 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
26875 condition true because at least one given value was found, or is it false
26876 because at least one of the found values was not listed? And how does this
26877 affect negated conditions? Both possibilities are provided for with the help of
26878 additional separators &`==`& and &`=&&`&.
26879
26880 .ilist
26881 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
26882 IP addresses matches one of the listed addresses. For the example above, the
26883 condition is true because 127.0.0.1 matches.
26884 .next
26885 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
26886 looked up IP addresses matches one of the listed addresses. If the condition is
26887 changed to:
26888 .code
26889 dnslists = a.b.c==127.0.0.1
26890 .endd
26891 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
26892 false because 127.0.0.2 is not listed. You would need to have:
26893 .code
26894 dnslists = a.b.c==127.0.0.1,127.0.0.2
26895 .endd
26896 for the condition to be true.
26897 .endlist
26898
26899 When &`!`& is used to negate IP address matching, it inverts the result, giving
26900 the precise opposite of the behaviour above. Thus:
26901 .ilist
26902 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
26903 addresses matches one of the listed addresses. Consider:
26904 .code
26905 dnslists = a.b.c!&0.0.0.1
26906 .endd
26907 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
26908 false because 127.0.0.1 matches.
26909 .next
26910 If &`!==`& or &`!=&&`& is used, the condition is true there is at least one
26911 looked up IP address that does not match. Consider:
26912 .code
26913 dnslists = a.b.c!=&0.0.0.1
26914 .endd
26915 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
26916 true, because 127.0.0.2 does not match. You would need to have:
26917 .code
26918 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
26919 .endd
26920 for the condition to be false.
26921 .endlist
26922 When the DNS lookup yields only a single IP address, there is no difference
26923 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
26924
26925
26926
26927
26928 .section "Detailed information from merged DNS lists" "SECTmordetinf"
26929 .cindex "DNS list" "information from merged"
26930 When the facility for restricting the matching IP values in a DNS list is used,
26931 the text from the TXT record that is set in &$dnslist_text$& may not reflect
26932 the true reason for rejection. This happens when lists are merged and the IP
26933 address in the A record is used to distinguish them; unfortunately there is
26934 only one TXT record. One way round this is not to use merged lists, but that
26935 can be inefficient because it requires multiple DNS lookups where one would do
26936 in the vast majority of cases when the host of interest is not on any of the
26937 lists.
26938
26939 A less inefficient way of solving this problem is available. If
26940 two domain names, comma-separated, are given, the second is used first to
26941 do an initial check, making use of any IP value restrictions that are set.
26942 If there is a match, the first domain is used, without any IP value
26943 restrictions, to get the TXT record. As a byproduct of this, there is also
26944 a check that the IP being tested is indeed on the first list. The first
26945 domain is the one that is put in &$dnslist_domain$&. For example:
26946 .code
26947 reject message  = \
26948          rejected because $sender_host_address is blacklisted \
26949          at $dnslist_domain\n$dnslist_text
26950        dnslists = \
26951          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
26952          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
26953 .endd
26954 For the first blacklist item, this starts by doing a lookup in
26955 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
26956 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
26957 value, and as long as something is found, it looks for the corresponding TXT
26958 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
26959 The second blacklist item is processed similarly.
26960
26961 If you are interested in more than one merged list, the same list must be
26962 given several times, but because the results of the DNS lookups are cached,
26963 the DNS calls themselves are not repeated. For example:
26964 .code
26965 reject dnslists = \
26966          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
26967          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
26968          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
26969          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
26970 .endd
26971 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
26972 values matches (or if no record is found), this is the only lookup that is
26973 done. Only if there is a match is one of the more specific lists consulted.
26974
26975
26976
26977 .section "DNS lists and IPv6" "SECTmorednslistslast"
26978 .cindex "IPv6" "DNS black lists"
26979 .cindex "DNS list" "IPv6 usage"
26980 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
26981 nibble by nibble. For example, if the calling host's IP address is
26982 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
26983 .code
26984 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
26985   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
26986 .endd
26987 (split over two lines here to fit on the page). Unfortunately, some of the DNS
26988 lists contain wildcard records, intended for IPv4, that interact badly with
26989 IPv6. For example, the DNS entry
26990 .code
26991 *.3.some.list.example.    A    127.0.0.1
26992 .endd
26993 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
26994 Unfortunately, it also matches the entire 3::/4 IPv6 network.
26995
26996 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
26997 &%condition%& condition, as in this example:
26998 .code
26999 deny   condition = ${if isip4{$sender_host_address}}
27000        dnslists  = some.list.example
27001 .endd
27002
27003 .section "Rate limiting incoming messages" "SECTratelimiting"
27004 .cindex "rate limiting" "client sending"
27005 .cindex "limiting client sending rates"
27006 .oindex "&%smtp_ratelimit_*%&"
27007 The &%ratelimit%& ACL condition can be used to measure and control the rate at
27008 which clients can send email. This is more powerful than the
27009 &%smtp_ratelimit_*%& options, because those options control the rate of
27010 commands in a single SMTP session only, whereas the &%ratelimit%& condition
27011 works across all connections (concurrent and sequential) from the same client
27012 host. The syntax of the &%ratelimit%& condition is:
27013 .display
27014 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
27015 .endd
27016 If the average client sending rate is less than &'m'& messages per time
27017 period &'p'& then the condition is false; otherwise it is true.
27018
27019 As a side-effect, the &%ratelimit%& condition sets the expansion variable
27020 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
27021 configured value of &'m'&, and &$sender_rate_period$& to the configured value
27022 of &'p'&.
27023
27024 The parameter &'p'& is the smoothing time constant, in the form of an Exim
27025 time interval, for example, &`8h`& for eight hours. A larger time constant
27026 means that it takes Exim longer to forget a client's past behaviour. The
27027 parameter &'m'& is the maximum number of messages that a client is permitted to
27028 send in each time interval. It also specifies the number of messages permitted
27029 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
27030 constant, you can allow a client to send more messages in a burst without
27031 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
27032 both small, messages must be sent at an even rate.
27033
27034 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
27035 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
27036 when deploying the &%ratelimit%& ACL condition. The script prints usage
27037 instructions when it is run with no arguments.
27038
27039 The key is used to look up the data for calculating the client's average
27040 sending rate. This data is stored in Exim's spool directory, alongside the
27041 retry and other hints databases. The default key is &$sender_host_address$&,
27042 which means Exim computes the sending rate of each client host IP address.
27043 By changing the key you can change how Exim identifies clients for the purpose
27044 of ratelimiting. For example, to limit the sending rate of each authenticated
27045 user, independent of the computer they are sending from, set the key to
27046 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
27047 example, &$authenticated_id$& is only meaningful if the client has
27048 authenticated (which you can check with the &%authenticated%& ACL condition).
27049
27050 The lookup key does not have to identify clients: If you want to limit the
27051 rate at which a recipient receives messages, you can use the key
27052 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
27053 ACL.
27054
27055 Internally, Exim appends the smoothing constant &'p'& and the options onto the
27056 lookup key because they alter the meaning of the stored data. This is not true
27057 for the limit &'m'&, so you can alter the configured maximum rate and Exim will
27058 still remember clients' past behaviour, but if you alter the other ratelimit
27059 parameters Exim forgets past behaviour.
27060
27061 Each &%ratelimit%& condition can have up to three options. One option
27062 specifies what Exim measures the rate of, and the second specifies how Exim
27063 handles excessively fast clients. The third option can be &`noupdate`&, to
27064 disable updating of the ratelimiting database (see section &<<rearatdat>>&).
27065 The options are separated by a slash, like the other parameters. They may
27066 appear in any order.
27067
27068 .section "Ratelimit options for what is being measured" "ratoptmea"
27069 The &%per_conn%& option limits the client's connection rate.
27070
27071 The &%per_mail%& option limits the client's rate of sending messages. This is
27072 the default if none of the &%per_*%& options is specified.
27073
27074 The &%per_byte%& option limits the sender's email bandwidth. Note that it is
27075 best to use this option in the DATA ACL; if it is used in an earlier ACL it
27076 relies on the SIZE parameter specified by the client in its MAIL command,
27077 which may be inaccurate or completely missing. You can follow the limit &'m'&
27078 in the configuration with K, M, or G to specify limits in kilobytes,
27079 megabytes, or gigabytes, respectively.
27080
27081 The &%per_rcpt%& option causes Exim to limit the rate at which
27082 recipients are accepted. To be effective, it would need to be used in
27083 either the &%acl_smtp_rcpt%& or the &%acl_not_smtp%& ACL. In the
27084 &%acl_smtp_rcpt%& ACL, the number of recipients is incremented by one.
27085 In the case of a locally submitted message in the &%acl_not_smtp%& ACL,
27086 the number of recipients is incremented by the &%$recipients_count%&
27087 for the entire message. Note that in either case the rate limiting
27088 engine will see a message with many recipients as a large high-speed
27089 burst.
27090
27091 The &%per_cmd%& option causes Exim to recompute the rate every time the
27092 condition is processed. This can be used to limit the SMTP command rate.
27093 This command is essentially an alias of &%per_rcpt%& to make it clear
27094 that the effect is to limit the rate at which individual commands,
27095 rather than recipients, are accepted.
27096
27097 .section "Ratelimit options for handling fast clients" "ratophanfas"
27098 If a client's average rate is greater than the maximum, the rate limiting
27099 engine can react in two possible ways, depending on the presence of the
27100 &%strict%& or &%leaky%& options. This is independent of the other
27101 counter-measures (such as rejecting the message) that may be specified by the
27102 rest of the ACL. The default mode is leaky, which avoids a sender's
27103 over-aggressive retry rate preventing it from getting any email through.
27104
27105 The &%strict%& option means that the client's recorded rate is always
27106 updated. The effect of this is that Exim measures the client's average rate
27107 of attempts to send email, which can be much higher than the maximum it is
27108 actually allowed. If the client is over the limit it may be subjected to
27109 counter-measures by the ACL until it slows down below the maximum rate. If
27110 the client stops attempting to send email for the time specified in the &'p'&
27111 parameter then its computed rate will decay exponentially to 37% of its peak
27112 value. You can work out the time (the number of smoothing periods) that a
27113 client is subjected to counter-measures after an over-limit burst with this
27114 formula:
27115 .code
27116         ln(peakrate/maxrate)
27117 .endd
27118 The &%leaky%& (default) option means that the client's recorded rate is not
27119 updated if it is above the limit. The effect of this is that Exim measures the
27120 client's average rate of successfully sent email, which cannot be greater than
27121 the maximum allowed. If the client is over the limit it may suffer some
27122 counter-measures (as specified in the ACL), but it will still be able to send
27123 email at the configured maximum rate, whatever the rate of its attempts. This
27124 is generally the better choice if you have clients that retry automatically.
27125
27126 .section "Using rate limiting" "useratlim"
27127 Exim's other ACL facilities are used to define what counter-measures are taken
27128 when the rate limit is exceeded. This might be anything from logging a warning
27129 (for example, while measuring existing sending rates in order to define
27130 policy), through time delays to slow down fast senders, up to rejecting the
27131 message. For example:
27132 .code
27133 # Log all senders' rates
27134 warn ratelimit = 0 / 1h / strict
27135      log_message = Sender rate $sender_rate / $sender_rate_period
27136
27137 # Slow down fast senders; note the need to truncate $sender_rate
27138 # at the decimal point.
27139 warn ratelimit = 100 / 1h / per_rcpt / strict
27140      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
27141                    $sender_rate_limit }s
27142
27143 # Keep authenticated users under control
27144 deny authenticated = *
27145      ratelimit = 100 / 1d / strict / $authenticated_id
27146
27147 # System-wide rate limit
27148 defer message = Sorry, too busy. Try again later.
27149      ratelimit = 10 / 1s / $primary_hostname
27150
27151 # Restrict incoming rate from each host, with a default
27152 # set using a macro and special cases looked up in a table.
27153 defer message = Sender rate exceeds $sender_rate_limit \
27154                messages per $sender_rate_period
27155      ratelimit = ${lookup {$sender_host_address} \
27156                    cdb {DB/ratelimits.cdb} \
27157                    {$value} {RATELIMIT} }
27158 .endd
27159 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
27160 especially with the &%per_rcpt%& option, you may suffer from a performance
27161 bottleneck caused by locking on the ratelimit hints database. Apart from
27162 making your ACLs less complicated, you can reduce the problem by using a
27163 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
27164 this means that Exim will lose its hints data after a reboot (including retry
27165 hints, the callout cache, and ratelimit data).
27166
27167
27168 .section "Reading ratelimit data without updating" "rearatdat"
27169 .cindex "rate limitint" "reading data without updating"
27170 If the &%noupdate%& option is present on a &%ratelimit%& ACL condition, Exim
27171 computes the rate and checks the limit as normal, but it does not update the
27172 saved data. This means that, in relevant ACLs, it is possible to lookup the
27173 existence of a specified (or auto-generated) ratelimit key without incrementing
27174 the ratelimit counter for that key. In order for this to be useful, another ACL
27175 entry must set the rate for the same key (otherwise it will always be zero).
27176 For example:
27177 .code
27178 acl_check_connect:
27179   deny ratelimit = 100 / 5m / strict / per_cmd / noupdate
27180        log_message = RATE: $sender_rate/$sender_rate_period \
27181                      (max $sender_rate_limit)
27182 .endd
27183 .display
27184 &'... some other logic and tests...'&
27185 .endd
27186 .code
27187 acl_check_mail:
27188   warn ratelimit = 100 / 5m / strict / per_cmd
27189        condition = ${if le{$sender_rate}{$sender_rate_limit}}
27190        logwrite  = RATE UPDATE: $sender_rate/$sender_rate_period \
27191                      (max $sender_rate_limit)
27192 .endd
27193 In this example, the rate is tested and used to deny access (when it is too
27194 high) in the connect ACL, but the actual computation of the remembered rate
27195 happens later, on a per-command basis, in another ACL.
27196
27197
27198
27199 .section "Address verification" "SECTaddressverification"
27200 .cindex "verifying address" "options for"
27201 .cindex "policy control" "address verification"
27202 Several of the &%verify%& conditions described in section
27203 &<<SECTaclconditions>>& cause addresses to be verified. Section
27204 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
27205 The verification conditions can be followed by options that modify the
27206 verification process. The options are separated from the keyword and from each
27207 other by slashes, and some of them contain parameters. For example:
27208 .code
27209 verify = sender/callout
27210 verify = recipient/defer_ok/callout=10s,defer_ok
27211 .endd
27212 The first stage of address verification, which always happens, is to run the
27213 address through the routers, in &"verify mode"&. Routers can detect the
27214 difference between verification and routing for delivery, and their actions can
27215 be varied by a number of generic options such as &%verify%& and &%verify_only%&
27216 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
27217 The available options are as follows:
27218
27219 .ilist
27220 If the &%callout%& option is specified, successful routing to one or more
27221 remote hosts is followed by a &"callout"& to those hosts as an additional
27222 check. Callouts and their sub-options are discussed in the next section.
27223 .next
27224 If there is a defer error while doing verification routing, the ACL
27225 normally returns &"defer"&. However, if you include &%defer_ok%& in the
27226 options, the condition is forced to be true instead. Note that this is a main
27227 verification option as well as a suboption for callouts.
27228 .next
27229 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
27230 discusses the reporting of sender address verification failures.
27231 .next
27232 The &%success_on_redirect%& option causes verification always to succeed
27233 immediately after a successful redirection. By default, if a redirection
27234 generates just one address, that address is also verified. See further
27235 discussion in section &<<SECTredirwhilveri>>&.
27236 .endlist
27237
27238 .cindex "verifying address" "differentiating failures"
27239 .vindex "&$recipient_verify_failure$&"
27240 .vindex "&$sender_verify_failure$&"
27241 .vindex "&$acl_verify_message$&"
27242 After an address verification failure, &$acl_verify_message$& contains the
27243 error message that is associated with the failure. It can be preserved by
27244 coding like this:
27245 .code
27246 warn  !verify = sender
27247        set acl_m0 = $acl_verify_message
27248 .endd
27249 If you are writing your own custom rejection message or log message when
27250 denying access, you can use this variable to include information about the
27251 verification failure.
27252
27253 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
27254 appropriate) contains one of the following words:
27255
27256 .ilist
27257 &%qualify%&: The address was unqualified (no domain), and the message
27258 was neither local nor came from an exempted host.
27259 .next
27260 &%route%&: Routing failed.
27261 .next
27262 &%mail%&: Routing succeeded, and a callout was attempted; rejection
27263 occurred at or before the MAIL command (that is, on initial
27264 connection, HELO, or MAIL).
27265 .next
27266 &%recipient%&: The RCPT command in a callout was rejected.
27267 .next
27268 &%postmaster%&: The postmaster check in a callout was rejected.
27269 .endlist
27270
27271 The main use of these variables is expected to be to distinguish between
27272 rejections of MAIL and rejections of RCPT in callouts.
27273
27274
27275
27276
27277 .section "Callout verification" "SECTcallver"
27278 .cindex "verifying address" "by callout"
27279 .cindex "callout" "verification"
27280 .cindex "SMTP" "callout verification"
27281 For non-local addresses, routing verifies the domain, but is unable to do any
27282 checking of the local part. There are situations where some means of verifying
27283 the local part is desirable. One way this can be done is to make an SMTP
27284 &'callback'& to a delivery host for the sender address or a &'callforward'& to
27285 a subsequent host for a recipient address, to see if the host accepts the
27286 address. We use the term &'callout'& to cover both cases. Note that for a
27287 sender address, the callback is not to the client host that is trying to
27288 deliver the message, but to one of the hosts that accepts incoming mail for the
27289 sender's domain.
27290
27291 Exim does not do callouts by default. If you want them to happen, you must
27292 request them by setting appropriate options on the &%verify%& condition, as
27293 described below. This facility should be used with care, because it can add a
27294 lot of resource usage to the cost of verifying an address. However, Exim does
27295 cache the results of callouts, which helps to reduce the cost. Details of
27296 caching are in section &<<SECTcallvercache>>&.
27297
27298 Recipient callouts are usually used only between hosts that are controlled by
27299 the same administration. For example, a corporate gateway host could use
27300 callouts to check for valid recipients on an internal mailserver. A successful
27301 callout does not guarantee that a real delivery to the address would succeed;
27302 on the other hand, a failing callout does guarantee that a delivery would fail.
27303
27304 If the &%callout%& option is present on a condition that verifies an address, a
27305 second stage of verification occurs if the address is successfully routed to
27306 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
27307 &(manualroute)& router, where the router specifies the hosts. However, if a
27308 router that does not set up hosts routes to an &(smtp)& transport with a
27309 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
27310 &%hosts_override%& set, its hosts are always used, whether or not the router
27311 supplies a host list.
27312
27313 The port that is used is taken from the transport, if it is specified and is a
27314 remote transport. (For routers that do verification only, no transport need be
27315 specified.) Otherwise, the default SMTP port is used. If a remote transport
27316 specifies an outgoing interface, this is used; otherwise the interface is not
27317 specified. Likewise, the text that is used for the HELO command is taken from
27318 the transport's &%helo_data%& option; if there is no transport, the value of
27319 &$smtp_active_hostname$& is used.
27320
27321 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
27322 test whether a bounce message could be delivered to the sender address. The
27323 following SMTP commands are sent:
27324 .display
27325 &`HELO `&<&'local host name'&>
27326 &`MAIL FROM:<>`&
27327 &`RCPT TO:`&<&'the address to be tested'&>
27328 &`QUIT`&
27329 .endd
27330 LHLO is used instead of HELO if the transport's &%protocol%& option is
27331 set to &"lmtp"&.
27332
27333 A recipient callout check is similar. By default, it also uses an empty address
27334 for the sender. This default is chosen because most hosts do not make use of
27335 the sender address when verifying a recipient. Using the same address means
27336 that a single cache entry can be used for each recipient. Some sites, however,
27337 do make use of the sender address when verifying. These are catered for by the
27338 &%use_sender%& and &%use_postmaster%& options, described in the next section.
27339
27340 If the response to the RCPT command is a 2&'xx'& code, the verification
27341 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
27342 Exim tries the next host, if any. If there is a problem with all the remote
27343 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
27344 &%callout%& option is given, in which case the condition is forced to succeed.
27345
27346 .cindex "SMTP" "output flushing, disabling for callout"
27347 A callout may take a little time. For this reason, Exim normally flushes SMTP
27348 output before performing a callout in an ACL, to avoid unexpected timeouts in
27349 clients when the SMTP PIPELINING extension is in use. The flushing can be
27350 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
27351
27352
27353
27354
27355 .section "Additional parameters for callouts" "CALLaddparcall"
27356 .cindex "callout" "additional parameters for"
27357 The &%callout%& option can be followed by an equals sign and a number of
27358 optional parameters, separated by commas. For example:
27359 .code
27360 verify = recipient/callout=10s,defer_ok
27361 .endd
27362 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
27363 separate verify options, is retained for backwards compatibility, but is now
27364 deprecated. The additional parameters for &%callout%& are as follows:
27365
27366
27367 .vlist
27368 .vitem <&'a&~time&~interval'&>
27369 .cindex "callout" "timeout, specifying"
27370 This specifies the timeout that applies for the callout attempt to each host.
27371 For example:
27372 .code
27373 verify = sender/callout=5s
27374 .endd
27375 The default is 30 seconds. The timeout is used for each response from the
27376 remote host. It is also used for the initial connection, unless overridden by
27377 the &%connect%& parameter.
27378
27379
27380 .vitem &*connect&~=&~*&<&'time&~interval'&>
27381 .cindex "callout" "connection timeout, specifying"
27382 This parameter makes it possible to set a different (usually smaller) timeout
27383 for making the SMTP connection. For example:
27384 .code
27385 verify = sender/callout=5s,connect=1s
27386 .endd
27387 If not specified, this timeout defaults to the general timeout value.
27388
27389 .vitem &*defer_ok*&
27390 .cindex "callout" "defer, action on"
27391 When this parameter is present, failure to contact any host, or any other kind
27392 of temporary error, is treated as success by the ACL. However, the cache is not
27393 updated in this circumstance.
27394
27395 .vitem &*fullpostmaster*&
27396 .cindex "callout" "full postmaster check"
27397 This operates like the &%postmaster%& option (see below), but if the check for
27398 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
27399 accordance with the specification in RFC 2821. The RFC states that the
27400 unqualified address &'postmaster'& should be accepted.
27401
27402
27403 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
27404 .cindex "callout" "sender when verifying header"
27405 When verifying addresses in header lines using the &%header_sender%&
27406 verification option, Exim behaves by default as if the addresses are envelope
27407 sender addresses from a message. Callout verification therefore tests to see
27408 whether a bounce message could be delivered, by using an empty address in the
27409 MAIL command. However, it is arguable that these addresses might never be used
27410 as envelope senders, and could therefore justifiably reject bounce messages
27411 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
27412 address to use in the MAIL command. For example:
27413 .code
27414 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
27415 .endd
27416 This parameter is available only for the &%header_sender%& verification option.
27417
27418
27419 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
27420 .cindex "callout" "overall timeout, specifying"
27421 This parameter sets an overall timeout for performing a callout verification.
27422 For example:
27423 .code
27424 verify = sender/callout=5s,maxwait=30s
27425 .endd
27426 This timeout defaults to four times the callout timeout for individual SMTP
27427 commands. The overall timeout applies when there is more than one host that can
27428 be tried. The timeout is checked before trying the next host. This prevents
27429 very long delays if there are a large number of hosts and all are timing out
27430 (for example, when network connections are timing out).
27431
27432
27433 .vitem &*no_cache*&
27434 .cindex "callout" "cache, suppressing"
27435 .cindex "caching callout, suppressing"
27436 When this parameter is given, the callout cache is neither read nor updated.
27437
27438 .vitem &*postmaster*&
27439 .cindex "callout" "postmaster; checking"
27440 When this parameter is set, a successful callout check is followed by a similar
27441 check for the local part &'postmaster'& at the same domain. If this address is
27442 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
27443 the postmaster check is recorded in a cache record; if it is a failure, this is
27444 used to fail subsequent callouts for the domain without a connection being
27445 made, until the cache record expires.
27446
27447 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
27448 The postmaster check uses an empty sender in the MAIL command by default.
27449 You can use this parameter to do a postmaster check using a different address.
27450 For example:
27451 .code
27452 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
27453 .endd
27454 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
27455 one overrides. The &%postmaster%& parameter is equivalent to this example:
27456 .code
27457 require  verify = sender/callout=postmaster_mailfrom=
27458 .endd
27459 &*Warning*&: The caching arrangements for postmaster checking do not take
27460 account of the sender address. It is assumed that either the empty address or
27461 a fixed non-empty address will be used. All that Exim remembers is that the
27462 postmaster check for the domain succeeded or failed.
27463
27464
27465 .vitem &*random*&
27466 .cindex "callout" "&""random""& check"
27467 When this parameter is set, before doing the normal callout check, Exim does a
27468 check for a &"random"& local part at the same domain. The local part is not
27469 really random &-- it is defined by the expansion of the option
27470 &%callout_random_local_part%&, which defaults to
27471 .code
27472 $primary_host_name-$tod_epoch-testing
27473 .endd
27474 The idea here is to try to determine whether the remote host accepts all local
27475 parts without checking. If it does, there is no point in doing callouts for
27476 specific local parts. If the &"random"& check succeeds, the result is saved in
27477 a cache record, and used to force the current and subsequent callout checks to
27478 succeed without a connection being made, until the cache record expires.
27479
27480 .vitem &*use_postmaster*&
27481 .cindex "callout" "sender for recipient check"
27482 This parameter applies to recipient callouts only. For example:
27483 .code
27484 deny  !verify = recipient/callout=use_postmaster
27485 .endd
27486 .vindex "&$qualify_domain$&"
27487 It causes a non-empty postmaster address to be used in the MAIL command when
27488 performing the callout for the recipient, and also for a &"random"& check if
27489 that is configured. The local part of the address is &`postmaster`& and the
27490 domain is the contents of &$qualify_domain$&.
27491
27492 .vitem &*use_sender*&
27493 This option applies to recipient callouts only. For example:
27494 .code
27495 require  verify = recipient/callout=use_sender
27496 .endd
27497 It causes the message's actual sender address to be used in the MAIL
27498 command when performing the callout, instead of an empty address. There is no
27499 need to use this option unless you know that the called hosts make use of the
27500 sender when checking recipients. If used indiscriminately, it reduces the
27501 usefulness of callout caching.
27502 .endlist
27503
27504 If you use any of the parameters that set a non-empty sender for the MAIL
27505 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
27506 &%use_sender%&), you should think about possible loops. Recipient checking is
27507 usually done between two hosts that are under the same management, and the host
27508 that receives the callouts is not normally configured to do callouts itself.
27509 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
27510 these circumstances.
27511
27512 However, if you use a non-empty sender address for a callout to an arbitrary
27513 host, there is the likelihood that the remote host will itself initiate a
27514 callout check back to your host. As it is checking what appears to be a message
27515 sender, it is likely to use an empty address in MAIL, thus avoiding a
27516 callout loop. However, to be on the safe side it would be best to set up your
27517 own ACLs so that they do not do sender verification checks when the recipient
27518 is the address you use for header sender or postmaster callout checking.
27519
27520 Another issue to think about when using non-empty senders for callouts is
27521 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
27522 by the sender/recipient combination; thus, for any given recipient, many more
27523 actual callouts are performed than when an empty sender or postmaster is used.
27524
27525
27526
27527
27528 .section "Callout caching" "SECTcallvercache"
27529 .cindex "hints database" "callout cache"
27530 .cindex "callout" "cache, description of"
27531 .cindex "caching" "callout"
27532 Exim caches the results of callouts in order to reduce the amount of resources
27533 used, unless you specify the &%no_cache%& parameter with the &%callout%&
27534 option. A hints database called &"callout"& is used for the cache. Two
27535 different record types are used: one records the result of a callout check for
27536 a specific address, and the other records information that applies to the
27537 entire domain (for example, that it accepts the local part &'postmaster'&).
27538
27539 When an original callout fails, a detailed SMTP error message is given about
27540 the failure. However, for subsequent failures use the cache data, this message
27541 is not available.
27542
27543 The expiry times for negative and positive address cache records are
27544 independent, and can be set by the global options &%callout_negative_expire%&
27545 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
27546
27547 If a host gives a negative response to an SMTP connection, or rejects any
27548 commands up to and including
27549 .code
27550 MAIL FROM:<>
27551 .endd
27552 (but not including the MAIL command with a non-empty address),
27553 any callout attempt is bound to fail. Exim remembers such failures in a
27554 domain cache record, which it uses to fail callouts for the domain without
27555 making new connections, until the domain record times out. There are two
27556 separate expiry times for domain cache records:
27557 &%callout_domain_negative_expire%& (default 3h) and
27558 &%callout_domain_positive_expire%& (default 7d).
27559
27560 Domain records expire when the negative expiry time is reached if callouts
27561 cannot be made for the domain, or if the postmaster check failed.
27562 Otherwise, they expire when the positive expiry time is reached. This
27563 ensures that, for example, a host that stops accepting &"random"& local parts
27564 will eventually be noticed.
27565
27566 The callout caching mechanism is based on the domain of the address that is
27567 being tested. If the domain routes to several hosts, it is assumed that their
27568 behaviour will be the same.
27569
27570
27571
27572 .section "Sender address verification reporting" "SECTsenaddver"
27573 .cindex "verifying" "suppressing error details"
27574 See section &<<SECTaddressverification>>& for a general discussion of
27575 verification. When sender verification fails in an ACL, the details of the
27576 failure are given as additional output lines before the 550 response to the
27577 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
27578 you might see:
27579 .code
27580 MAIL FROM:<xyz@abc.example>
27581 250 OK
27582 RCPT TO:<pqr@def.example>
27583 550-Verification failed for <xyz@abc.example>
27584 550-Called:   192.168.34.43
27585 550-Sent:     RCPT TO:<xyz@abc.example>
27586 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
27587 550 Sender verification failed
27588 .endd
27589 If more than one RCPT command fails in the same way, the details are given
27590 only for the first of them. However, some administrators do not want to send
27591 out this much information. You can suppress the details by adding
27592 &`/no_details`& to the ACL statement that requests sender verification. For
27593 example:
27594 .code
27595 verify = sender/no_details
27596 .endd
27597
27598 .section "Redirection while verifying" "SECTredirwhilveri"
27599 .cindex "verifying" "redirection while"
27600 .cindex "address redirection" "while verifying"
27601 A dilemma arises when a local address is redirected by aliasing or forwarding
27602 during verification: should the generated addresses themselves be verified,
27603 or should the successful expansion of the original address be enough to verify
27604 it? By default, Exim takes the following pragmatic approach:
27605
27606 .ilist
27607 When an incoming address is redirected to just one child address, verification
27608 continues with the child address, and if that fails to verify, the original
27609 verification also fails.
27610 .next
27611 When an incoming address is redirected to more than one child address,
27612 verification does not continue. A success result is returned.
27613 .endlist
27614
27615 This seems the most reasonable behaviour for the common use of aliasing as a
27616 way of redirecting different local parts to the same mailbox. It means, for
27617 example, that a pair of alias entries of the form
27618 .code
27619 A.Wol:   aw123
27620 aw123:   :fail: Gone away, no forwarding address
27621 .endd
27622 work as expected, with both local parts causing verification failure. When a
27623 redirection generates more than one address, the behaviour is more like a
27624 mailing list, where the existence of the alias itself is sufficient for
27625 verification to succeed.
27626
27627 It is possible, however, to change the default behaviour so that all successful
27628 redirections count as successful verifications, however many new addresses are
27629 generated. This is specified by the &%success_on_redirect%& verification
27630 option. For example:
27631 .code
27632 require verify = recipient/success_on_redirect/callout=10s
27633 .endd
27634 In this example, verification succeeds if a router generates a new address, and
27635 the callout does not occur, because no address was routed to a remote host.
27636
27637 When verification is being tested via the &%-bv%& option, the treatment of
27638 redirections is as just described, unless the &%-v%& or any debugging option is
27639 also specified. In that case, full verification is done for every generated
27640 address and a report is output for each of them.
27641
27642
27643
27644 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
27645 .cindex "CSA" "verifying"
27646 Client SMTP Authorization is a system that allows a site to advertise
27647 which machines are and are not permitted to send email. This is done by placing
27648 special SRV records in the DNS; these are looked up using the client's HELO
27649 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
27650 Authorization checks in Exim are performed by the ACL condition:
27651 .code
27652 verify = csa
27653 .endd
27654 This fails if the client is not authorized. If there is a DNS problem, or if no
27655 valid CSA SRV record is found, or if the client is authorized, the condition
27656 succeeds. These three cases can be distinguished using the expansion variable
27657 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
27658 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
27659 be likely to cause problems for legitimate email.
27660
27661 The error messages produced by the CSA code include slightly more
27662 detail. If &$csa_status$& is &"defer"&, this may be because of problems
27663 looking up the CSA SRV record, or problems looking up the CSA target
27664 address record. There are four reasons for &$csa_status$& being &"fail"&:
27665
27666 .ilist
27667 The client's host name is explicitly not authorized.
27668 .next
27669 The client's IP address does not match any of the CSA target IP addresses.
27670 .next
27671 The client's host name is authorized but it has no valid target IP addresses
27672 (for example, the target's addresses are IPv6 and the client is using IPv4).
27673 .next
27674 The client's host name has no CSA SRV record but a parent domain has asserted
27675 that all subdomains must be explicitly authorized.
27676 .endlist
27677
27678 The &%csa%& verification condition can take an argument which is the domain to
27679 use for the DNS query. The default is:
27680 .code
27681 verify = csa/$sender_helo_name
27682 .endd
27683 This implementation includes an extension to CSA. If the query domain
27684 is an address literal such as [192.0.2.95], or if it is a bare IP
27685 address, Exim searches for CSA SRV records in the reverse DNS as if
27686 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
27687 meaningful to say:
27688 .code
27689 verify = csa/$sender_host_address
27690 .endd
27691 In fact, this is the check that Exim performs if the client does not say HELO.
27692 This extension can be turned off by setting the main configuration option
27693 &%dns_csa_use_reverse%& to be false.
27694
27695 If a CSA SRV record is not found for the domain itself, a search
27696 is performed through its parent domains for a record which might be
27697 making assertions about subdomains. The maximum depth of this search is limited
27698 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
27699 default. Exim does not look for CSA SRV records in a top level domain, so the
27700 default settings handle HELO domains as long as seven
27701 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
27702 of legitimate HELO domains.
27703
27704 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
27705 direct SRV lookups, this is not sufficient because of the extra parent domain
27706 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
27707 addresses into lookups in the reverse DNS space. The result of a successful
27708 lookup such as:
27709 .code
27710 ${lookup dnsdb {csa=$sender_helo_name}}
27711 .endd
27712 has two space-separated fields: an authorization code and a target host name.
27713 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
27714 authorization required but absent, or &"?"& for unknown.
27715
27716
27717
27718
27719 .section "Bounce address tag validation" "SECTverifyPRVS"
27720 .cindex "BATV, verifying"
27721 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
27722 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
27723 Genuine incoming bounce messages should therefore always be addressed to
27724 recipients that have a valid tag. This scheme is a way of detecting unwanted
27725 bounce messages caused by sender address forgeries (often called &"collateral
27726 spam"&), because the recipients of such messages do not include valid tags.
27727
27728 There are two expansion items to help with the implementation of the BATV
27729 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
27730 the original envelope sender address by using a simple key to add a hash of the
27731 address and some time-based randomizing information. The &%prvs%& expansion
27732 item creates a signed address, and the &%prvscheck%& expansion item checks one.
27733 The syntax of these expansion items is described in section
27734 &<<SECTexpansionitems>>&.
27735
27736 As an example, suppose the secret per-address keys are stored in an MySQL
27737 database. A query to look up the key for an address could be defined as a macro
27738 like this:
27739 .code
27740 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
27741                 WHERE sender='${quote_mysql:$prvscheck_address}'\
27742                 }{$value}}
27743 .endd
27744 Suppose also that the senders who make use of BATV are defined by an address
27745 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
27746 use this:
27747 .code
27748 # Bounces: drop unsigned addresses for BATV senders
27749 deny message = This address does not send an unsigned reverse path
27750      senders = :
27751      recipients = +batv_senders
27752
27753 # Bounces: In case of prvs-signed address, check signature.
27754 deny message = Invalid reverse path signature.
27755      senders = :
27756      condition  = ${prvscheck {$local_part@$domain}\
27757                   {PRVSCHECK_SQL}{1}}
27758      !condition = $prvscheck_result
27759 .endd
27760 The first statement rejects recipients for bounce messages that are addressed
27761 to plain BATV sender addresses, because it is known that BATV senders do not
27762 send out messages with plain sender addresses. The second statement rejects
27763 recipients that are prvs-signed, but with invalid signatures (either because
27764 the key is wrong, or the signature has timed out).
27765
27766 A non-prvs-signed address is not rejected by the second statement, because the
27767 &%prvscheck%& expansion yields an empty string if its first argument is not a
27768 prvs-signed address, thus causing the &%condition%& condition to be false. If
27769 the first argument is a syntactically valid prvs-signed address, the yield is
27770 the third string (in this case &"1"&), whether or not the cryptographic and
27771 timeout checks succeed. The &$prvscheck_result$& variable contains the result
27772 of the checks (empty for failure, &"1"& for success).
27773
27774 There is one more issue you must consider when implementing prvs-signing:
27775 you have to ensure that the routers accept prvs-signed addresses and
27776 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
27777 router to remove the signature with a configuration along these lines:
27778 .code
27779 batv_redirect:
27780   driver = redirect
27781   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
27782 .endd
27783 This works because, if the third argument of &%prvscheck%& is empty, the result
27784 of the expansion of a prvs-signed address is the decoded value of the original
27785 address. This router should probably be the first of your routers that handles
27786 local addresses.
27787
27788 To create BATV-signed addresses in the first place, a transport of this form
27789 can be used:
27790 .code
27791 external_smtp_batv:
27792   driver = smtp
27793   return_path = ${prvs {$return_path} \
27794                        {${lookup mysql{SELECT \
27795                        secret FROM batv_prvs WHERE \
27796                        sender='${quote_mysql:$sender_address}'} \
27797                        {$value}fail}}}
27798 .endd
27799 If no key can be found for the existing return path, no signing takes place.
27800
27801
27802
27803 .section "Using an ACL to control relaying" "SECTrelaycontrol"
27804 .cindex "&ACL;" "relay control"
27805 .cindex "relaying" "control by ACL"
27806 .cindex "policy control" "relay control"
27807 An MTA is said to &'relay'& a message if it receives it from some host and
27808 delivers it directly to another host as a result of a remote address contained
27809 within it. Redirecting a local address via an alias or forward file and then
27810 passing the message on to another host is not relaying,
27811 .cindex "&""percent hack""&"
27812 but a redirection as a result of the &"percent hack"& is.
27813
27814 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
27815 A host which is acting as a gateway or an MX backup is concerned with incoming
27816 relaying from arbitrary hosts to a specific set of domains. On the other hand,
27817 a host which is acting as a smart host for a number of clients is concerned
27818 with outgoing relaying from those clients to the Internet at large. Often the
27819 same host is fulfilling both functions,
27820 . ///
27821 . as illustrated in the diagram below,
27822 . ///
27823 but in principle these two kinds of relaying are entirely independent. What is
27824 not wanted is the transmission of mail from arbitrary remote hosts through your
27825 system to arbitrary domains.
27826
27827
27828 You can implement relay control by means of suitable statements in the ACL that
27829 runs for each RCPT command. For convenience, it is often easiest to use
27830 Exim's named list facility to define the domains and hosts involved. For
27831 example, suppose you want to do the following:
27832
27833 .ilist
27834 Deliver a number of domains to mailboxes on the local host (or process them
27835 locally in some other way). Let's say these are &'my.dom1.example'& and
27836 &'my.dom2.example'&.
27837 .next
27838 Relay mail for a number of other domains for which you are the secondary MX.
27839 These might be &'friend1.example'& and &'friend2.example'&.
27840 .next
27841 Relay mail from the hosts on your local LAN, to whatever domains are involved.
27842 Suppose your LAN is 192.168.45.0/24.
27843 .endlist
27844
27845
27846 In the main part of the configuration, you put the following definitions:
27847 .code
27848 domainlist local_domains = my.dom1.example : my.dom2.example
27849 domainlist relay_domains = friend1.example : friend2.example
27850 hostlist   relay_hosts   = 192.168.45.0/24
27851 .endd
27852 Now you can use these definitions in the ACL that is run for every RCPT
27853 command:
27854 .code
27855 acl_check_rcpt:
27856   accept domains = +local_domains : +relay_domains
27857   accept hosts   = +relay_hosts
27858 .endd
27859 The first statement accepts any RCPT command that contains an address in
27860 the local or relay domains. For any other domain, control passes to the second
27861 statement, which accepts the command only if it comes from one of the relay
27862 hosts. In practice, you will probably want to make your ACL more sophisticated
27863 than this, for example, by including sender and recipient verification. The
27864 default configuration includes a more comprehensive example, which is described
27865 in chapter &<<CHAPdefconfil>>&.
27866
27867
27868
27869 .section "Checking a relay configuration" "SECTcheralcon"
27870 .cindex "relaying" "checking control of"
27871 You can check the relay characteristics of your configuration in the same way
27872 that you can test any ACL behaviour for an incoming SMTP connection, by using
27873 the &%-bh%& option to run a fake SMTP session with which you interact.
27874
27875 For specifically testing for unwanted relaying, the host
27876 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
27877 host from the host on which Exim is running, using the normal telnet port, you
27878 will see a normal telnet connection message and then quite a long delay. Be
27879 patient. The remote host is making an SMTP connection back to your host, and
27880 trying a number of common probes to test for open relay vulnerability. The
27881 results of the tests will eventually appear on your terminal.
27882 .ecindex IIDacl
27883
27884
27885
27886 . ////////////////////////////////////////////////////////////////////////////
27887 . ////////////////////////////////////////////////////////////////////////////
27888
27889 .chapter "Content scanning at ACL time" "CHAPexiscan"
27890 .scindex IIDcosca "content scanning" "at ACL time"
27891 The extension of Exim to include content scanning at ACL time, formerly known
27892 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
27893 was integrated into the main source for Exim release 4.50, and Tom continues to
27894 maintain it. Most of the wording of this chapter is taken from Tom's
27895 specification.
27896
27897 It is also possible to scan the content of messages at other times. The
27898 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
27899 scanning after all the ACLs have run. A transport filter can be used to scan
27900 messages at delivery time (see the &%transport_filter%& option, described in
27901 chapter &<<CHAPtransportgeneric>>&).
27902
27903 If you want to include the ACL-time content-scanning features when you compile
27904 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
27905 &_Local/Makefile_&. When you do that, the Exim binary is built with:
27906
27907 .ilist
27908 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
27909 for all MIME parts for SMTP and non-SMTP messages, respectively.
27910 .next
27911 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
27912 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
27913 run at the end of message reception (the &%acl_smtp_data%& ACL).
27914 .next
27915 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
27916 of messages, or parts of messages, for debugging purposes.
27917 .next
27918 Additional expansion variables that are set in the new ACL and by the new
27919 conditions.
27920 .next
27921 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
27922 .endlist
27923
27924 There is another content-scanning configuration option for &_Local/Makefile_&,
27925 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
27926 condition is compiled, in addition to all the other content-scanning features.
27927
27928 Content-scanning is continually evolving, and new features are still being
27929 added. While such features are still unstable and liable to incompatible
27930 changes, they are made available in Exim by setting options whose names begin
27931 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
27932 this manual. You can find out about them by reading the file called
27933 &_doc/experimental.txt_&.
27934
27935 All the content-scanning facilities work on a MBOX copy of the message that is
27936 temporarily created in a file called:
27937 .display
27938 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
27939 .endd
27940 The &_.eml_& extension is a friendly hint to virus scanners that they can
27941 expect an MBOX-like structure inside that file. The file is created when the
27942 first content scanning facility is called. Subsequent calls to content
27943 scanning conditions open the same file again. The directory is recursively
27944 removed when the &%acl_smtp_data%& ACL has finished running, unless
27945 .code
27946 control = no_mbox_unspool
27947 .endd
27948 has been encountered. When the MIME ACL decodes files, they are put into the
27949 same directory by default.
27950
27951
27952
27953 .section "Scanning for viruses" "SECTscanvirus"
27954 .cindex "virus scanning"
27955 .cindex "content scanning" "for viruses"
27956 .cindex "content scanning" "the &%malware%& condition"
27957 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
27958 It supports a &"generic"& interface to scanners called via the shell, and
27959 specialized interfaces for &"daemon"& type virus scanners, which are resident
27960 in memory and thus are much faster.
27961
27962 .oindex "&%av_scanner%&"
27963 You can set the &%av_scanner%& option in first part of the Exim configuration
27964 file to specify which scanner to use, together with any additional options that
27965 are needed. The basic syntax is as follows:
27966 .display
27967 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
27968 .endd
27969 If you do not set &%av_scanner%&, it defaults to
27970 .code
27971 av_scanner = sophie:/var/run/sophie
27972 .endd
27973 If the value of &%av_scanner%& starts with a dollar character, it is expanded
27974 before use. The following scanner types are supported in this release:
27975
27976 .vlist
27977 .vitem &%aveserver%&
27978 .cindex "virus scanners" "Kaspersky"
27979 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
27980 at &url(http://www.kaspersky.com). This scanner type takes one option,
27981 which is the path to the daemon's UNIX socket. The default is shown in this
27982 example:
27983 .code
27984 av_scanner = aveserver:/var/run/aveserver
27985 .endd
27986
27987 .vitem &%clamd%&
27988 .cindex "virus scanners" "clamd"
27989 This daemon-type scanner is GPL and free. You can get it at
27990 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
27991 unpack MIME containers, so it used to be recommended to unpack MIME attachments
27992 in the MIME ACL. This no longer believed to be necessary. One option is
27993 required: either the path and name of a UNIX socket file, or a hostname or IP
27994 number, and a port, separated by space, as in the second of these examples:
27995 .code
27996 av_scanner = clamd:/opt/clamd/socket
27997 av_scanner = clamd:192.0.2.3 1234
27998 av_scanner = clamd:192.0.2.3 1234:local
27999 .endd
28000 If the value of av_scanner points to a UNIX socket file or contains the local
28001 keyword, then the ClamAV interface will pass a filename containing the data
28002 to be scanned, which will should normally result in less I/O happening and be
28003 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
28004 Exim does not assume that there is a common filesystem with the remote host.
28005 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
28006 you be running a version of ClamAV prior to 0.95.
28007 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
28008 contributing the code for this scanner.
28009
28010 .vitem &%cmdline%&
28011 .cindex "virus scanners" "command line interface"
28012 This is the keyword for the generic command line scanner interface. It can be
28013 used to attach virus scanners that are invoked from the shell. This scanner
28014 type takes 3 mandatory options:
28015
28016 .olist
28017 The full path and name of the scanner binary, with all command line options,
28018 and a placeholder (&`%s`&) for the directory to scan.
28019
28020 .next
28021 A regular expression to match against the STDOUT and STDERR output of the
28022 virus scanner. If the expression matches, a virus was found. You must make
28023 absolutely sure that this expression matches on &"virus found"&. This is called
28024 the &"trigger"& expression.
28025
28026 .next
28027 Another regular expression, containing exactly one pair of parentheses, to
28028 match the name of the virus found in the scanners output. This is called the
28029 &"name"& expression.
28030 .endlist olist
28031
28032 For example, Sophos Sweep reports a virus on a line like this:
28033 .code
28034 Virus 'W32/Magistr-B' found in file ./those.bat
28035 .endd
28036 For the trigger expression, we can match the phrase &"found in file"&. For the
28037 name expression, we want to extract the W32/Magistr-B string, so we can match
28038 for the single quotes left and right of it. Altogether, this makes the
28039 configuration setting:
28040 .code
28041 av_scanner = cmdline:\
28042              /path/to/sweep -ss -all -rec -archive %s:\
28043              found in file:'(.+)'
28044 .endd
28045 .vitem &%drweb%&
28046 .cindex "virus scanners" "DrWeb"
28047 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
28048 argument, either a full path to a UNIX socket, or an IP address and port
28049 separated by white space, as in these examples:
28050 .code
28051 av_scanner = drweb:/var/run/drwebd.sock
28052 av_scanner = drweb:192.168.2.20 31337
28053 .endd
28054 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
28055 is used. Thanks to Alex Miller for contributing the code for this scanner.
28056
28057 .vitem &%fsecure%&
28058 .cindex "virus scanners" "F-Secure"
28059 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
28060 argument which is the path to a UNIX socket. For example:
28061 .code
28062 av_scanner = fsecure:/path/to/.fsav
28063 .endd
28064 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
28065 Thelmen for contributing the code for this scanner.
28066
28067 .vitem &%kavdaemon%&
28068 .cindex "virus scanners" "Kaspersky"
28069 This is the scanner daemon of Kaspersky Version 4. This version of the
28070 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
28071 scanner type takes one option, which is the path to the daemon's UNIX socket.
28072 For example:
28073 .code
28074 av_scanner = kavdaemon:/opt/AVP/AvpCtl
28075 .endd
28076 The default path is &_/var/run/AvpCtl_&.
28077
28078 .vitem &%mksd%&
28079 .cindex "virus scanners" "mksd"
28080 This is a daemon type scanner that is aimed mainly at Polish users, though some
28081 parts of documentation are now available in English. You can get it at
28082 &url(http://linux.mks.com.pl/). The only option for this scanner type is
28083 the maximum number of processes used simultaneously to scan the attachments,
28084 provided that the demime facility is employed and also provided that mksd has
28085 been run with at least the same number of child processes. For example:
28086 .code
28087 av_scanner = mksd:2
28088 .endd
28089 You can safely omit this option (the default value is 1).
28090
28091 .vitem &%sophie%&
28092 .cindex "virus scanners" "Sophos and Sophie"
28093 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
28094 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
28095 for this scanner type is the path to the UNIX socket that Sophie uses for
28096 client communication. For example:
28097 .code
28098 av_scanner = sophie:/tmp/sophie
28099 .endd
28100 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
28101 the option.
28102 .endlist
28103
28104 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
28105 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
28106 ACL.
28107
28108 The &%av_scanner%& option is expanded each time &%malware%& is called. This
28109 makes it possible to use different scanners. See further below for an example.
28110 The &%malware%& condition caches its results, so when you use it multiple times
28111 for the same message, the actual scanning process is only carried out once.
28112 However, using expandable items in &%av_scanner%& disables this caching, in
28113 which case each use of the &%malware%& condition causes a new scan of the
28114 message.
28115
28116 The &%malware%& condition takes a right-hand argument that is expanded before
28117 use. It can then be one of
28118
28119 .ilist
28120 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
28121 The condition succeeds if a virus was found, and fail otherwise. This is the
28122 recommended usage.
28123 .next
28124 &"false"& or &"0"& or an empty string, in which case no scanning is done and
28125 the condition fails immediately.
28126 .next
28127 A regular expression, in which case the message is scanned for viruses. The
28128 condition succeeds if a virus is found and its name matches the regular
28129 expression. This allows you to take special actions on certain types of virus.
28130 .endlist
28131
28132 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
28133 even if there is a problem with the virus scanner. Otherwise, such a problem
28134 causes the ACL to defer.
28135
28136 .vindex "&$malware_name$&"
28137 When a virus is found, the condition sets up an expansion variable called
28138 &$malware_name$& that contains the name of the virus. You can use it in a
28139 &%message%& modifier that specifies the error returned to the sender, and/or in
28140 logging data.
28141
28142 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
28143 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
28144 &%malware%& condition.
28145
28146 Beware the interaction of Exim's &%message_size_limit%& with any size limits
28147 imposed by your anti-virus scanner.
28148
28149 Here is a very simple scanning example:
28150 .code
28151 deny message = This message contains malware ($malware_name)
28152      demime = *
28153      malware = *
28154 .endd
28155 The next example accepts messages when there is a problem with the scanner:
28156 .code
28157 deny message = This message contains malware ($malware_name)
28158      demime = *
28159      malware = */defer_ok
28160 .endd
28161 The next example shows how to use an ACL variable to scan with both sophie and
28162 aveserver. It assumes you have set:
28163 .code
28164 av_scanner = $acl_m0
28165 .endd
28166 in the main Exim configuration.
28167 .code
28168 deny message = This message contains malware ($malware_name)
28169      set acl_m0 = sophie
28170      malware = *
28171
28172 deny message = This message contains malware ($malware_name)
28173      set acl_m0 = aveserver
28174      malware = *
28175 .endd
28176
28177
28178 .section "Scanning with SpamAssassin" "SECTscanspamass"
28179 .cindex "content scanning" "for spam"
28180 .cindex "spam scanning"
28181 .cindex "SpamAssassin"
28182 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
28183 score and a report for the message. You can get SpamAssassin at
28184 &url(http://www.spamassassin.org), or, if you have a working Perl
28185 installation, you can use CPAN by running:
28186 .code
28187 perl -MCPAN -e 'install Mail::SpamAssassin'
28188 .endd
28189 SpamAssassin has its own set of configuration files. Please review its
28190 documentation to see how you can tweak it. The default installation should work
28191 nicely, however.
28192
28193 .oindex "&%spamd_address%&"
28194 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
28195 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
28196 port for &%spamd%&, you must set the &%spamd_address%& option in the global
28197 part of the Exim configuration as follows (example):
28198 .code
28199 spamd_address = 192.168.99.45 387
28200 .endd
28201 You do not need to set this option if you use the default. As of version 2.60,
28202 &%spamd%& also supports communication over UNIX sockets. If you want to use
28203 these, supply &%spamd_address%& with an absolute file name instead of a
28204 address/port pair:
28205 .code
28206 spamd_address = /var/run/spamd_socket
28207 .endd
28208 You can have multiple &%spamd%& servers to improve scalability. These can
28209 reside on other hardware reachable over the network. To specify multiple
28210 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
28211 option, separated with colons:
28212 .code
28213 spamd_address = 192.168.2.10 783 : \
28214                 192.168.2.11 783 : \
28215                 192.168.2.12 783
28216 .endd
28217 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
28218 fashion. When a server fails to respond to the connection attempt, all other
28219 servers are tried until one succeeds. If no server responds, the &%spam%&
28220 condition defers.
28221
28222 &*Warning*&: It is not possible to use the UNIX socket connection method with
28223 multiple &%spamd%& servers.
28224
28225 The &%spamd_address%& variable is expanded before use if it starts with
28226 a dollar sign. In this case, the expansion may return a string that is
28227 used as the list so that multiple spamd servers can be the result of an
28228 expansion.
28229
28230 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
28231 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
28232 .code
28233 deny message = This message was classified as SPAM
28234      spam = joe
28235 .endd
28236 The right-hand side of the &%spam%& condition specifies a name. This is
28237 relevant if you have set up multiple SpamAssassin profiles. If you do not want
28238 to scan using a specific profile, but rather use the SpamAssassin system-wide
28239 default profile, you can scan for an unknown name, or simply use &"nobody"&.
28240 However, you must put something on the right-hand side.
28241
28242 The name allows you to use per-domain or per-user antispam profiles in
28243 principle, but this is not straightforward in practice, because a message may
28244 have multiple recipients, not necessarily all in the same domain. Because the
28245 &%spam%& condition has to be called from a DATA ACL in order to be able to
28246 read the contents of the message, the variables &$local_part$& and &$domain$&
28247 are not set.
28248
28249 The right-hand side of the &%spam%& condition is expanded before being used, so
28250 you can put lookups or conditions there. When the right-hand side evaluates to
28251 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
28252
28253
28254 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
28255 large ones may cause significant performance degradation. As most spam messages
28256 are quite small, it is recommended that you do not scan the big ones. For
28257 example:
28258 .code
28259 deny message = This message was classified as SPAM
28260      condition = ${if < {$message_size}{10K}}
28261      spam = nobody
28262 .endd
28263
28264 The &%spam%& condition returns true if the threshold specified in the user's
28265 SpamAssassin profile has been matched or exceeded. If you want to use the
28266 &%spam%& condition for its side effects (see the variables below), you can make
28267 it always return &"true"& by appending &`:true`& to the username.
28268
28269 .cindex "spam scanning" "returned variables"
28270 When the &%spam%& condition is run, it sets up a number of expansion
28271 variables. These variables are saved with the received message, thus they are
28272 available for use at delivery time.
28273
28274 .vlist
28275 .vitem &$spam_score$&
28276 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
28277 for inclusion in log or reject messages.
28278
28279 .vitem &$spam_score_int$&
28280 The spam score of the message, multiplied by ten, as an integer value. For
28281 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
28282 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
28283 The integer value is useful for numeric comparisons in conditions.
28284
28285
28286 .vitem &$spam_bar$&
28287 A string consisting of a number of &"+"& or &"-"& characters, representing the
28288 integer part of the spam score value. A spam score of 4.4 would have a
28289 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
28290 headers, since MUAs can match on such strings.
28291
28292 .vitem &$spam_report$&
28293 A multiline text table, containing the full SpamAssassin report for the
28294 message. Useful for inclusion in headers or reject messages.
28295 .endlist
28296
28297 The &%spam%& condition caches its results unless expansion in
28298 spamd_address was used. If you call it again with the same user name, it
28299 does not scan again, but rather returns the same values as before.
28300
28301 The &%spam%& condition returns DEFER if there is any error while running
28302 the message through SpamAssassin or if the expansion of spamd_address
28303 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
28304 statement block), append &`/defer_ok`& to the right-hand side of the
28305 spam condition, like this:
28306 .code
28307 deny message = This message was classified as SPAM
28308      spam    = joe/defer_ok
28309 .endd
28310 This causes messages to be accepted even if there is a problem with &%spamd%&.
28311
28312 Here is a longer, commented example of the use of the &%spam%&
28313 condition:
28314 .code
28315 # put headers in all messages (no matter if spam or not)
28316 warn  spam = nobody:true
28317       add_header = X-Spam-Score: $spam_score ($spam_bar)
28318       add_header = X-Spam-Report: $spam_report
28319
28320 # add second subject line with *SPAM* marker when message
28321 # is over threshold
28322 warn  spam = nobody
28323       add_header = Subject: *SPAM* $h_Subject:
28324
28325 # reject spam at high scores (> 12)
28326 deny  message = This message scored $spam_score spam points.
28327       spam = nobody:true
28328       condition = ${if >{$spam_score_int}{120}{1}{0}}
28329 .endd
28330
28331
28332
28333 .section "Scanning MIME parts" "SECTscanmimepart"
28334 .cindex "content scanning" "MIME parts"
28335 .cindex "MIME content scanning"
28336 .oindex "&%acl_smtp_mime%&"
28337 .oindex "&%acl_not_smtp_mime%&"
28338 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
28339 each MIME part of an SMTP message, including multipart types, in the sequence
28340 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
28341 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
28342 options may both refer to the same ACL if you want the same processing in both
28343 cases.
28344
28345 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
28346 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
28347 the case of a non-SMTP message. However, a MIME ACL is called only if the
28348 message contains a &'Content-Type:'& header line. When a call to a MIME
28349 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
28350 result code is sent to the client. In the case of an SMTP message, the
28351 &%acl_smtp_data%& ACL is not called when this happens.
28352
28353 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
28354 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
28355 condition to match against the raw MIME part. You can also use the
28356 &%mime_regex%& condition to match against the decoded MIME part (see section
28357 &<<SECTscanregex>>&).
28358
28359 At the start of a MIME ACL, a number of variables are set from the header
28360 information for the relevant MIME part. These are described below. The contents
28361 of the MIME part are not by default decoded into a disk file except for MIME
28362 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
28363 part into a disk file, you can use the &%decode%& condition. The general
28364 syntax is:
28365 .display
28366 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
28367 .endd
28368 The right hand side is expanded before use. After expansion,
28369 the value can be:
28370
28371 .olist
28372 &"0"& or &"false"&, in which case no decoding is done.
28373 .next
28374 The string &"default"&. In that case, the file is put in the temporary
28375 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
28376 a sequential file name consisting of the message id and a sequence number. The
28377 full path and name is available in &$mime_decoded_filename$& after decoding.
28378 .next
28379 A full path name starting with a slash. If the full name is an existing
28380 directory, it is used as a replacement for the default directory. The filename
28381 is then sequentially assigned. If the path does not exist, it is used as
28382 the full path and file name.
28383 .next
28384 If the string does not start with a slash, it is used as the
28385 filename, and the default path is then used.
28386 .endlist
28387 The &%decode%& condition normally succeeds. It is only false for syntax
28388 errors or unusual circumstances such as memory shortages. You can easily decode
28389 a file with its original, proposed filename using
28390 .code
28391 decode = $mime_filename
28392 .endd
28393 However, you should keep in mind that &$mime_filename$& might contain
28394 anything. If you place files outside of the default path, they are not
28395 automatically unlinked.
28396
28397 For RFC822 attachments (these are messages attached to messages, with a
28398 content-type of &"message/rfc822"&), the ACL is called again in the same manner
28399 as for the primary message, only that the &$mime_is_rfc822$& expansion
28400 variable is set (see below). Attached messages are always decoded to disk
28401 before being checked, and the files are unlinked once the check is done.
28402
28403 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
28404 used to match regular expressions against raw and decoded MIME parts,
28405 respectively. They are described in section &<<SECTscanregex>>&.
28406
28407 .cindex "MIME content scanning" "returned variables"
28408 The following list describes all expansion variables that are
28409 available in the MIME ACL:
28410
28411 .vlist
28412 .vitem &$mime_boundary$&
28413 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
28414 have a boundary string, which is stored in this variable. If the current part
28415 has no boundary parameter in the &'Content-Type:'& header, this variable
28416 contains the empty string.
28417
28418 .vitem &$mime_charset$&
28419 This variable contains the character set identifier, if one was found in the
28420 &'Content-Type:'& header. Examples for charset identifiers are:
28421 .code
28422 us-ascii
28423 gb2312 (Chinese)
28424 iso-8859-1
28425 .endd
28426 Please note that this value is not normalized, so you should do matches
28427 case-insensitively.
28428
28429 .vitem &$mime_content_description$&
28430 This variable contains the normalized content of the &'Content-Description:'&
28431 header. It can contain a human-readable description of the parts content. Some
28432 implementations repeat the filename for attachments here, but they are usually
28433 only used for display purposes.
28434
28435 .vitem &$mime_content_disposition$&
28436 This variable contains the normalized content of the &'Content-Disposition:'&
28437 header. You can expect strings like &"attachment"& or &"inline"& here.
28438
28439 .vitem &$mime_content_id$&
28440 This variable contains the normalized content of the &'Content-ID:'& header.
28441 This is a unique ID that can be used to reference a part from another part.
28442
28443 .vitem &$mime_content_size$&
28444 This variable is set only after the &%decode%& modifier (see above) has been
28445 successfully run. It contains the size of the decoded part in kilobytes. The
28446 size is always rounded up to full kilobytes, so only a completely empty part
28447 has a &$mime_content_size$& of zero.
28448
28449 .vitem &$mime_content_transfer_encoding$&
28450 This variable contains the normalized content of the
28451 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
28452 type. Typical values are &"base64"& and &"quoted-printable"&.
28453
28454 .vitem &$mime_content_type$&
28455 If the MIME part has a &'Content-Type:'& header, this variable contains its
28456 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
28457 are some examples of popular MIME types, as they may appear in this variable:
28458 .code
28459 text/plain
28460 text/html
28461 application/octet-stream
28462 image/jpeg
28463 audio/midi
28464 .endd
28465 If the MIME part has no &'Content-Type:'& header, this variable contains the
28466 empty string.
28467
28468 .vitem &$mime_decoded_filename$&
28469 This variable is set only after the &%decode%& modifier (see above) has been
28470 successfully run. It contains the full path and file name of the file
28471 containing the decoded data.
28472 .endlist
28473
28474 .cindex "RFC 2047"
28475 .vlist
28476 .vitem &$mime_filename$&
28477 This is perhaps the most important of the MIME variables. It contains a
28478 proposed filename for an attachment, if one was found in either the
28479 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
28480 RFC2047 decoded, but no additional sanity checks are done. If no filename was
28481 found, this variable contains the empty string.
28482
28483 .vitem &$mime_is_coverletter$&
28484 This variable attempts to differentiate the &"cover letter"& of an e-mail from
28485 attached data. It can be used to clamp down on flashy or unnecessarily encoded
28486 content in the cover letter, while not restricting attachments at all.
28487
28488 The variable contains 1 (true) for a MIME part believed to be part of the
28489 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
28490 follows:
28491
28492 .olist
28493 The outermost MIME part of a message is always a cover letter.
28494
28495 .next
28496 If a multipart/alternative or multipart/related MIME part is a cover letter,
28497 so are all MIME subparts within that multipart.
28498
28499 .next
28500 If any other multipart is a cover letter, the first subpart is a cover letter,
28501 and the rest are attachments.
28502
28503 .next
28504 All parts contained within an attachment multipart are attachments.
28505 .endlist olist
28506
28507 As an example, the following will ban &"HTML mail"& (including that sent with
28508 alternative plain text), while allowing HTML files to be attached. HTML
28509 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
28510 .code
28511 deny message = HTML mail is not accepted here
28512 !condition = $mime_is_rfc822
28513 condition = $mime_is_coverletter
28514 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
28515 .endd
28516 .vitem &$mime_is_multipart$&
28517 This variable has the value 1 (true) when the current part has the main type
28518 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
28519 Since multipart entities only serve as containers for other parts, you may not
28520 want to carry out specific actions on them.
28521
28522 .vitem &$mime_is_rfc822$&
28523 This variable has the value 1 (true) if the current part is not a part of the
28524 checked message itself, but part of an attached message. Attached message
28525 decoding is fully recursive.
28526
28527 .vitem &$mime_part_count$&
28528 This variable is a counter that is raised for each processed MIME part. It
28529 starts at zero for the very first part (which is usually a multipart). The
28530 counter is per-message, so it is reset when processing RFC822 attachments (see
28531 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
28532 complete, so you can use it in the DATA ACL to determine the number of MIME
28533 parts of a message. For non-MIME messages, this variable contains the value -1.
28534 .endlist
28535
28536
28537
28538 .section "Scanning with regular expressions" "SECTscanregex"
28539 .cindex "content scanning" "with regular expressions"
28540 .cindex "regular expressions" "content scanning with"
28541 You can specify your own custom regular expression matches on the full body of
28542 the message, or on individual MIME parts.
28543
28544 The &%regex%& condition takes one or more regular expressions as arguments and
28545 matches them against the full message (when called in the DATA ACL) or a raw
28546 MIME part (when called in the MIME ACL). The &%regex%& condition matches
28547 linewise, with a maximum line length of 32K characters. That means you cannot
28548 have multiline matches with the &%regex%& condition.
28549
28550 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
28551 to 32K of decoded content (the whole content at once, not linewise). If the
28552 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
28553 is decoded automatically when &%mime_regex%& is executed (using default path
28554 and filename values). If the decoded data is larger than  32K, only the first
28555 32K characters are checked.
28556
28557 The regular expressions are passed as a colon-separated list. To include a
28558 literal colon, you must double it. Since the whole right-hand side string is
28559 expanded before being used, you must also escape dollar signs and backslashes
28560 with more backslashes, or use the &`\N`& facility to disable expansion.
28561 Here is a simple example that contains two regular expressions:
28562 .code
28563 deny message = contains blacklisted regex ($regex_match_string)
28564      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
28565 .endd
28566 The conditions returns true if any one of the regular expressions matches. The
28567 &$regex_match_string$& expansion variable is then set up and contains the
28568 matching regular expression.
28569
28570 &*Warning*&: With large messages, these conditions can be fairly
28571 CPU-intensive.
28572
28573
28574
28575
28576 .section "The demime condition" "SECTdemimecond"
28577 .cindex "content scanning" "MIME checking"
28578 .cindex "MIME content scanning"
28579 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
28580 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
28581 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
28582 ACL functionality, but provides no additional facilities. Please note that this
28583 condition is deprecated and kept only for backward compatibility. You must set
28584 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
28585 use the &%demime%& condition.
28586
28587 The &%demime%& condition unpacks MIME containers in the message. It detects
28588 errors in MIME containers and can match file extensions found in the message
28589 against a list. Using this facility produces files containing the unpacked MIME
28590 parts of the message in the temporary scan directory. If you do antivirus
28591 scanning, it is recommended that you use the &%demime%& condition before the
28592 antivirus (&%malware%&) condition.
28593
28594 On the right-hand side of the &%demime%& condition you can pass a
28595 colon-separated list of file extensions that it should match against. For
28596 example:
28597 .code
28598 deny message = Found blacklisted file attachment
28599      demime  = vbs:com:bat:pif:prf:lnk
28600 .endd
28601 If one of the file extensions is found, the condition is true, otherwise it is
28602 false. If there is a temporary error while demimeing (for example, &"disk
28603 full"&), the condition defers, and the message is temporarily rejected (unless
28604 the condition is on a &%warn%& verb).
28605
28606 The right-hand side is expanded before being treated as a list, so you can have
28607 conditions and lookups there. If it expands to an empty string, &"false"&, or
28608 zero (&"0"&), no demimeing is done and the condition is false.
28609
28610 The &%demime%& condition set the following variables:
28611
28612 .vlist
28613 .vitem &$demime_errorlevel$&
28614 .vindex "&$demime_errorlevel$&"
28615 When an error is detected in a MIME container, this variable contains the
28616 severity of the error, as an integer number. The higher the value, the more
28617 severe the error (the current maximum value is 3). If this variable is unset or
28618 zero, no error occurred.
28619
28620 .vitem &$demime_reason$&
28621 .vindex "&$demime_reason$&"
28622 When &$demime_errorlevel$& is greater than zero, this variable contains a
28623 human-readable text string describing the MIME error that occurred.
28624 .endlist
28625
28626 .vlist
28627 .vitem &$found_extension$&
28628 .vindex "&$found_extension$&"
28629 When the &%demime%& condition is true, this variable contains the file
28630 extension it found.
28631 .endlist
28632
28633 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
28634 the &%demime%& condition, and are not changed on subsequent calls.
28635
28636 If you do not want to check for file extensions, but rather use the &%demime%&
28637 condition for unpacking or error checking purposes, pass &"*"& as the
28638 right-hand side value. Here is a more elaborate example of how to use this
28639 facility:
28640 .code
28641 # Reject messages with serious MIME container errors
28642 deny  message = Found MIME error ($demime_reason).
28643       demime = *
28644       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
28645
28646 # Reject known virus spreading file extensions.
28647 # Accepting these is pretty much braindead.
28648 deny  message = contains $found_extension file (blacklisted).
28649       demime  = com:vbs:bat:pif:scr
28650
28651 # Freeze .exe and .doc files. Postmaster can
28652 # examine them and eventually thaw them.
28653 deny  log_message = Another $found_extension file.
28654       demime = exe:doc
28655       control = freeze
28656 .endd
28657 .ecindex IIDcosca
28658
28659
28660
28661
28662 . ////////////////////////////////////////////////////////////////////////////
28663 . ////////////////////////////////////////////////////////////////////////////
28664
28665 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
28666          "Local scan function"
28667 .scindex IIDlosca "&[local_scan()]& function" "description of"
28668 .cindex "customizing" "input scan using C function"
28669 .cindex "policy control" "by local scan function"
28670 In these days of email worms, viruses, and ever-increasing spam, some sites
28671 want to apply a lot of checking to messages before accepting them.
28672
28673 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
28674 passing messages to external virus and spam scanning software. You can also do
28675 a certain amount in Exim itself through string expansions and the &%condition%&
28676 condition in the ACL that runs after the SMTP DATA command or the ACL for
28677 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
28678
28679 To allow for further customization to a site's own requirements, there is the
28680 possibility of linking Exim with a private message scanning function, written
28681 in C. If you want to run code that is written in something other than C, you
28682 can of course use a little C stub to call it.
28683
28684 The local scan function is run once for every incoming message, at the point
28685 when Exim is just about to accept the message.
28686 It can therefore be used to control non-SMTP messages from local processes as
28687 well as messages arriving via SMTP.
28688
28689 Exim applies a timeout to calls of the local scan function, and there is an
28690 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
28691 Zero means &"no timeout"&.
28692 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
28693 before calling the local scan function, so that the most common types of crash
28694 are caught. If the timeout is exceeded or one of those signals is caught, the
28695 incoming message is rejected with a temporary error if it is an SMTP message.
28696 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
28697 code. The incident is logged on the main and reject logs.
28698
28699
28700
28701 .section "Building Exim to use a local scan function" "SECID207"
28702 .cindex "&[local_scan()]& function" "building Exim to use"
28703 To make use of the local scan function feature, you must tell Exim where your
28704 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
28705 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
28706 directory, so you might set
28707 .code
28708 LOCAL_SCAN_SOURCE=Local/local_scan.c
28709 .endd
28710 for example. The function must be called &[local_scan()]&. It is called by
28711 Exim after it has received a message, when the success return code is about to
28712 be sent. This is after all the ACLs have been run. The return code from your
28713 function controls whether the message is actually accepted or not. There is a
28714 commented template function (that just accepts the message) in the file
28715 _src/local_scan.c_.
28716
28717 If you want to make use of Exim's run time configuration file to set options
28718 for your &[local_scan()]& function, you must also set
28719 .code
28720 LOCAL_SCAN_HAS_OPTIONS=yes
28721 .endd
28722 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
28723
28724
28725
28726
28727 .section "API for local_scan()" "SECTapiforloc"
28728 .cindex "&[local_scan()]& function" "API description"
28729 You must include this line near the start of your code:
28730 .code
28731 #include "local_scan.h"
28732 .endd
28733 This header file defines a number of variables and other values, and the
28734 prototype for the function itself. Exim is coded to use unsigned char values
28735 almost exclusively, and one of the things this header defines is a shorthand
28736 for &`unsigned char`& called &`uschar`&.
28737 It also contains the following macro definitions, to simplify casting character
28738 strings and pointers to character strings:
28739 .code
28740 #define CS   (char *)
28741 #define CCS  (const char *)
28742 #define CSS  (char **)
28743 #define US   (unsigned char *)
28744 #define CUS  (const unsigned char *)
28745 #define USS  (unsigned char **)
28746 .endd
28747 The function prototype for &[local_scan()]& is:
28748 .code
28749 extern int local_scan(int fd, uschar **return_text);
28750 .endd
28751 The arguments are as follows:
28752
28753 .ilist
28754 &%fd%& is a file descriptor for the file that contains the body of the message
28755 (the -D file). The file is open for reading and writing, but updating it is not
28756 recommended. &*Warning*&: You must &'not'& close this file descriptor.
28757
28758 The descriptor is positioned at character 19 of the file, which is the first
28759 character of the body itself, because the first 19 characters are the message
28760 id followed by &`-D`& and a newline. If you rewind the file, you should use the
28761 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
28762 case this changes in some future version.
28763 .next
28764 &%return_text%& is an address which you can use to return a pointer to a text
28765 string at the end of the function. The value it points to on entry is NULL.
28766 .endlist
28767
28768 The function must return an &%int%& value which is one of the following macros:
28769
28770 .vlist
28771 .vitem &`LOCAL_SCAN_ACCEPT`&
28772 .vindex "&$local_scan_data$&"
28773 The message is accepted. If you pass back a string of text, it is saved with
28774 the message, and made available in the variable &$local_scan_data$&. No
28775 newlines are permitted (if there are any, they are turned into spaces) and the
28776 maximum length of text is 1000 characters.
28777
28778 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
28779 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
28780 queued without immediate delivery, and is frozen.
28781
28782 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
28783 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
28784 queued without immediate delivery.
28785
28786 .vitem &`LOCAL_SCAN_REJECT`&
28787 The message is rejected; the returned text is used as an error message which is
28788 passed back to the sender and which is also logged. Newlines are permitted &--
28789 they cause a multiline response for SMTP rejections, but are converted to
28790 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
28791 used.
28792
28793 .vitem &`LOCAL_SCAN_TEMPREJECT`&
28794 The message is temporarily rejected; the returned text is used as an error
28795 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
28796 problem"& is used.
28797
28798 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
28799 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
28800 message is not written to the reject log. It has the effect of unsetting the
28801 &%rejected_header%& log selector for just this rejection. If
28802 &%rejected_header%& is already unset (see the discussion of the
28803 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
28804 same as LOCAL_SCAN_REJECT.
28805
28806 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
28807 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
28808 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
28809 .endlist
28810
28811 If the message is not being received by interactive SMTP, rejections are
28812 reported by writing to &%stderr%& or by sending an email, as configured by the
28813 &%-oe%& command line options.
28814
28815
28816
28817 .section "Configuration options for local_scan()" "SECTconoptloc"
28818 .cindex "&[local_scan()]& function" "configuration options"
28819 It is possible to have option settings in the main configuration file
28820 that set values in static variables in the &[local_scan()]& module. If you
28821 want to do this, you must have the line
28822 .code
28823 LOCAL_SCAN_HAS_OPTIONS=yes
28824 .endd
28825 in your &_Local/Makefile_& when you build Exim. (This line is in
28826 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
28827 file, you must define static variables to hold the option values, and a table
28828 to define them.
28829
28830 The table must be a vector called &%local_scan_options%&, of type
28831 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
28832 and a pointer to the variable that holds the value. The entries must appear in
28833 alphabetical order. Following &%local_scan_options%& you must also define a
28834 variable called &%local_scan_options_count%& that contains the number of
28835 entries in the table. Here is a short example, showing two kinds of option:
28836 .code
28837 static int my_integer_option = 42;
28838 static uschar *my_string_option = US"a default string";
28839
28840 optionlist local_scan_options[] = {
28841   { "my_integer", opt_int,       &my_integer_option },
28842   { "my_string",  opt_stringptr, &my_string_option }
28843 };
28844
28845 int local_scan_options_count =
28846   sizeof(local_scan_options)/sizeof(optionlist);
28847 .endd
28848 The values of the variables can now be changed from Exim's runtime
28849 configuration file by including a local scan section as in this example:
28850 .code
28851 begin local_scan
28852 my_integer = 99
28853 my_string = some string of text...
28854 .endd
28855 The available types of option data are as follows:
28856
28857 .vlist
28858 .vitem &*opt_bool*&
28859 This specifies a boolean (true/false) option. The address should point to a
28860 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
28861 that are defined as &"1"& and &"0"&, respectively. If you want to detect
28862 whether such a variable has been set at all, you can initialize it to
28863 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
28864 values.)
28865
28866 .vitem &*opt_fixed*&
28867 This specifies a fixed point number, such as is used for load averages.
28868 The address should point to a variable of type &`int`&. The value is stored
28869 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
28870
28871 .vitem &*opt_int*&
28872 This specifies an integer; the address should point to a variable of type
28873 &`int`&. The value may be specified in any of the integer formats accepted by
28874 Exim.
28875
28876 .vitem &*opt_mkint*&
28877 This is the same as &%opt_int%&, except that when such a value is output in a
28878 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
28879 printed with the suffix K or M.
28880
28881 .vitem &*opt_octint*&
28882 This also specifies an integer, but the value is always interpreted as an
28883 octal integer, whether or not it starts with the digit zero, and it is
28884 always output in octal.
28885
28886 .vitem &*opt_stringptr*&
28887 This specifies a string value; the address must be a pointer to a
28888 variable that points to a string (for example, of type &`uschar *`&).
28889
28890 .vitem &*opt_time*&
28891 This specifies a time interval value. The address must point to a variable of
28892 type &`int`&. The value that is placed there is a number of seconds.
28893 .endlist
28894
28895 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
28896 out the values of all the &[local_scan()]& options.
28897
28898
28899
28900 .section "Available Exim variables" "SECID208"
28901 .cindex "&[local_scan()]& function" "available Exim variables"
28902 The header &_local_scan.h_& gives you access to a number of C variables. These
28903 are the only ones that are guaranteed to be maintained from release to release.
28904 Note, however, that you can obtain the value of any Exim expansion variable,
28905 including &$recipients$&, by calling &'expand_string()'&. The exported
28906 C variables are as follows:
28907
28908 .vlist
28909 .vitem &*int&~body_linecount*&
28910 This variable contains the number of lines in the message's body.
28911
28912 .vitem &*int&~body_zerocount*&
28913 This variable contains the number of binary zero bytes in the message's body.
28914
28915 .vitem &*unsigned&~int&~debug_selector*&
28916 This variable is set to zero when no debugging is taking place. Otherwise, it
28917 is a bitmap of debugging selectors. Two bits are identified for use in
28918 &[local_scan()]&; they are defined as macros:
28919
28920 .ilist
28921 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
28922 testing option that is not privileged &-- any caller may set it. All the
28923 other selector bits can be set only by admin users.
28924
28925 .next
28926 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
28927 by the &`+local_scan`& debug selector. It is not included in the default set
28928 of debugging bits.
28929 .endlist ilist
28930
28931 Thus, to write to the debugging output only when &`+local_scan`& has been
28932 selected, you should use code like this:
28933 .code
28934 if ((debug_selector & D_local_scan) != 0)
28935   debug_printf("xxx", ...);
28936 .endd
28937 .vitem &*uschar&~*expand_string_message*&
28938 After a failing call to &'expand_string()'& (returned value NULL), the
28939 variable &%expand_string_message%& contains the error message, zero-terminated.
28940
28941 .vitem &*header_line&~*header_list*&
28942 A pointer to a chain of header lines. The &%header_line%& structure is
28943 discussed below.
28944
28945 .vitem &*header_line&~*header_last*&
28946 A pointer to the last of the header lines.
28947
28948 .vitem &*uschar&~*headers_charset*&
28949 The value of the &%headers_charset%& configuration option.
28950
28951 .vitem &*BOOL&~host_checking*&
28952 This variable is TRUE during a host checking session that is initiated by the
28953 &%-bh%& command line option.
28954
28955 .vitem &*uschar&~*interface_address*&
28956 The IP address of the interface that received the message, as a string. This
28957 is NULL for locally submitted messages.
28958
28959 .vitem &*int&~interface_port*&
28960 The port on which this message was received. When testing with the &%-bh%&
28961 command line option, the value of this variable is -1 unless a port has been
28962 specified via the &%-oMi%& option.
28963
28964 .vitem &*uschar&~*message_id*&
28965 This variable contains Exim's message id for the incoming message (the value of
28966 &$message_exim_id$&) as a zero-terminated string.
28967
28968 .vitem &*uschar&~*received_protocol*&
28969 The name of the protocol by which the message was received.
28970
28971 .vitem &*int&~recipients_count*&
28972 The number of accepted recipients.
28973
28974 .vitem &*recipient_item&~*recipients_list*&
28975 .cindex "recipient" "adding in local scan"
28976 .cindex "recipient" "removing in local scan"
28977 The list of accepted recipients, held in a vector of length
28978 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
28979 can add additional recipients by calling &'receive_add_recipient()'& (see
28980 below). You can delete recipients by removing them from the vector and
28981 adjusting the value in &%recipients_count%&. In particular, by setting
28982 &%recipients_count%& to zero you remove all recipients. If you then return the
28983 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
28984 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
28985 and then call &'receive_add_recipient()'& as often as needed.
28986
28987 .vitem &*uschar&~*sender_address*&
28988 The envelope sender address. For bounce messages this is the empty string.
28989
28990 .vitem &*uschar&~*sender_host_address*&
28991 The IP address of the sending host, as a string. This is NULL for
28992 locally-submitted messages.
28993
28994 .vitem &*uschar&~*sender_host_authenticated*&
28995 The name of the authentication mechanism that was used, or NULL if the message
28996 was not received over an authenticated SMTP connection.
28997
28998 .vitem &*uschar&~*sender_host_name*&
28999 The name of the sending host, if known.
29000
29001 .vitem &*int&~sender_host_port*&
29002 The port on the sending host.
29003
29004 .vitem &*BOOL&~smtp_input*&
29005 This variable is TRUE for all SMTP input, including BSMTP.
29006
29007 .vitem &*BOOL&~smtp_batched_input*&
29008 This variable is TRUE for BSMTP input.
29009
29010 .vitem &*int&~store_pool*&
29011 The contents of this variable control which pool of memory is used for new
29012 requests. See section &<<SECTmemhanloc>>& for details.
29013 .endlist
29014
29015
29016 .section "Structure of header lines" "SECID209"
29017 The &%header_line%& structure contains the members listed below.
29018 You can add additional header lines by calling the &'header_add()'& function
29019 (see below). You can cause header lines to be ignored (deleted) by setting
29020 their type to *.
29021
29022
29023 .vlist
29024 .vitem &*struct&~header_line&~*next*&
29025 A pointer to the next header line, or NULL for the last line.
29026
29027 .vitem &*int&~type*&
29028 A code identifying certain headers that Exim recognizes. The codes are printing
29029 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
29030 Notice in particular that any header line whose type is * is not transmitted
29031 with the message. This flagging is used for header lines that have been
29032 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
29033 lines.) Effectively, * means &"deleted"&.
29034
29035 .vitem &*int&~slen*&
29036 The number of characters in the header line, including the terminating and any
29037 internal newlines.
29038
29039 .vitem &*uschar&~*text*&
29040 A pointer to the text of the header. It always ends with a newline, followed by
29041 a zero byte. Internal newlines are preserved.
29042 .endlist
29043
29044
29045
29046 .section "Structure of recipient items" "SECID210"
29047 The &%recipient_item%& structure contains these members:
29048
29049 .vlist
29050 .vitem &*uschar&~*address*&
29051 This is a pointer to the recipient address as it was received.
29052
29053 .vitem &*int&~pno*&
29054 This is used in later Exim processing when top level addresses are created by
29055 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
29056 and must always contain -1 at this stage.
29057
29058 .vitem &*uschar&~*errors_to*&
29059 If this value is not NULL, bounce messages caused by failing to deliver to the
29060 recipient are sent to the address it contains. In other words, it overrides the
29061 envelope sender for this one recipient. (Compare the &%errors_to%& generic
29062 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
29063 an unqualified address, Exim qualifies it using the domain from
29064 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
29065 is NULL for all recipients.
29066 .endlist
29067
29068
29069
29070 .section "Available Exim functions" "SECID211"
29071 .cindex "&[local_scan()]& function" "available Exim functions"
29072 The header &_local_scan.h_& gives you access to a number of Exim functions.
29073 These are the only ones that are guaranteed to be maintained from release to
29074 release:
29075
29076 .vlist
29077 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
29078        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
29079
29080 This function creates a child process that runs the command specified by
29081 &%argv%&. The environment for the process is specified by &%envp%&, which can
29082 be NULL if no environment variables are to be passed. A new umask is supplied
29083 for the process in &%newumask%&.
29084
29085 Pipes to the standard input and output of the new process are set up
29086 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
29087 standard error is cloned to the standard output. If there are any file
29088 descriptors &"in the way"& in the new process, they are closed. If the final
29089 argument is TRUE, the new process is made into a process group leader.
29090
29091 The function returns the pid of the new process, or -1 if things go wrong.
29092
29093 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
29094 This function waits for a child process to terminate, or for a timeout (in
29095 seconds) to expire. A timeout value of zero means wait as long as it takes. The
29096 return value is as follows:
29097
29098 .ilist
29099 >= 0
29100
29101 The process terminated by a normal exit and the value is the process
29102 ending status.
29103
29104 .next
29105 < 0 and > &--256
29106
29107 The process was terminated by a signal and the value is the negation of the
29108 signal number.
29109
29110 .next
29111 &--256
29112
29113 The process timed out.
29114 .next
29115 &--257
29116
29117 The was some other error in wait(); &%errno%& is still set.
29118 .endlist
29119
29120 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
29121 This function provide you with a means of submitting a new message to
29122 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
29123 want, but this packages it all up for you.) The function creates a pipe,
29124 forks a subprocess that is running
29125 .code
29126 exim -t -oem -oi -f <>
29127 .endd
29128 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
29129 that is connected to the standard input. The yield of the function is the PID
29130 of the subprocess. You can then write a message to the file descriptor, with
29131 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
29132
29133 When you have finished, call &'child_close()'& to wait for the process to
29134 finish and to collect its ending status. A timeout value of zero is usually
29135 fine in this circumstance. Unless you have made a mistake with the recipient
29136 addresses, you should get a return code of zero.
29137
29138
29139 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
29140        *sender_authentication)*&
29141 This function is a more sophisticated version of &'child_open()'&. The command
29142 that it runs is:
29143 .display
29144 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
29145 .endd
29146 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
29147
29148
29149 .vitem &*void&~debug_printf(char&~*,&~...)*&
29150 This is Exim's debugging function, with arguments as for &'(printf()'&. The
29151 output is written to the standard error stream. If no debugging is selected,
29152 calls to &'debug_printf()'& have no effect. Normally, you should make calls
29153 conditional on the &`local_scan`& debug selector by coding like this:
29154 .code
29155 if ((debug_selector & D_local_scan) != 0)
29156   debug_printf("xxx", ...);
29157 .endd
29158
29159 .vitem &*uschar&~*expand_string(uschar&~*string)*&
29160 This is an interface to Exim's string expansion code. The return value is the
29161 expanded string, or NULL if there was an expansion failure.
29162 The C variable &%expand_string_message%& contains an error message after an
29163 expansion failure. If expansion does not change the string, the return value is
29164 the pointer to the input string. Otherwise, the return value points to a new
29165 block of memory that was obtained by a call to &'store_get()'&. See section
29166 &<<SECTmemhanloc>>& below for a discussion of memory handling.
29167
29168 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
29169 This function allows you to an add additional header line at the end of the
29170 existing ones. The first argument is the type, and should normally be a space
29171 character. The second argument is a format string and any number of
29172 substitution arguments as for &[sprintf()]&. You may include internal newlines
29173 if you want, and you must ensure that the string ends with a newline.
29174
29175 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
29176         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
29177 This function adds a new header line at a specified point in the header
29178 chain. The header itself is specified as for &'header_add()'&.
29179
29180 If &%name%& is NULL, the new header is added at the end of the chain if
29181 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
29182 NULL, the header lines are searched for the first non-deleted header that
29183 matches the name. If one is found, the new header is added before it if
29184 &%after%& is false. If &%after%& is true, the new header is added after the
29185 found header and any adjacent subsequent ones with the same name (even if
29186 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
29187 option controls where the header is added. If it is true, addition is at the
29188 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
29189 headers, or at the top if there are no &'Received:'& headers, you could use
29190 .code
29191 header_add_at_position(TRUE, US"Received", TRUE,
29192   ' ', "X-xxx: ...");
29193 .endd
29194 Normally, there is always at least one non-deleted &'Received:'& header, but
29195 there may not be if &%received_header_text%& expands to an empty string.
29196
29197
29198 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
29199 This function removes header lines. If &%occurrence%& is zero or negative, all
29200 occurrences of the header are removed. If occurrence is greater than zero, that
29201 particular instance of the header is removed. If no header(s) can be found that
29202 match the specification, the function does nothing.
29203
29204
29205 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
29206         int&~length,&~BOOL&~notdel)*&"
29207 This function tests whether the given header has the given name. It is not just
29208 a string comparison, because white space is permitted between the name and the
29209 colon. If the &%notdel%& argument is true, a false return is forced for all
29210 &"deleted"& headers; otherwise they are not treated specially. For example:
29211 .code
29212 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
29213 .endd
29214 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
29215 .cindex "base64 encoding" "functions for &[local_scan()]& use"
29216 This function base64-encodes a string, which is passed by address and length.
29217 The text may contain bytes of any value, including zero. The result is passed
29218 back in dynamic memory that is obtained by calling &'store_get()'&. It is
29219 zero-terminated.
29220
29221 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
29222 This function decodes a base64-encoded string. Its arguments are a
29223 zero-terminated base64-encoded string and the address of a variable that is set
29224 to point to the result, which is in dynamic memory. The length of the decoded
29225 string is the yield of the function. If the input is invalid base64 data, the
29226 yield is -1. A zero byte is added to the end of the output string to make it
29227 easy to interpret as a C string (assuming it contains no zeros of its own). The
29228 added zero byte is not included in the returned count.
29229
29230 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
29231 This function checks for a match in a domain list. Domains are always
29232 matched caselessly. The return value is one of the following:
29233 .display
29234 &`OK     `& match succeeded
29235 &`FAIL   `& match failed
29236 &`DEFER  `& match deferred
29237 .endd
29238 DEFER is usually caused by some kind of lookup defer, such as the
29239 inability to contact a database.
29240
29241 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
29242         BOOL&~caseless)*&"
29243 This function checks for a match in a local part list. The third argument
29244 controls case-sensitivity. The return values are as for
29245 &'lss_match_domain()'&.
29246
29247 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
29248         BOOL&~caseless)*&"
29249 This function checks for a match in an address list. The third argument
29250 controls the case-sensitivity of the local part match. The domain is always
29251 matched caselessly. The return values are as for &'lss_match_domain()'&.
29252
29253 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
29254         uschar&~*list)*&"
29255 This function checks for a match in a host list. The most common usage is
29256 expected to be
29257 .code
29258 lss_match_host(sender_host_name, sender_host_address, ...)
29259 .endd
29260 .vindex "&$sender_host_address$&"
29261 An empty address field matches an empty item in the host list. If the host name
29262 is NULL, the name corresponding to &$sender_host_address$& is automatically
29263 looked up if a host name is required to match an item in the list. The return
29264 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
29265 returns ERROR in the case when it had to look up a host name, but the lookup
29266 failed.
29267
29268 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
29269         *format,&~...)*&"
29270 This function writes to Exim's log files. The first argument should be zero (it
29271 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
29272 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
29273 them. It specifies to which log or logs the message is written. The remaining
29274 arguments are a format and relevant insertion arguments. The string should not
29275 contain any newlines, not even at the end.
29276
29277
29278 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
29279 This function adds an additional recipient to the message. The first argument
29280 is the recipient address. If it is unqualified (has no domain), it is qualified
29281 with the &%qualify_recipient%& domain. The second argument must always be -1.
29282
29283 This function does not allow you to specify a private &%errors_to%& address (as
29284 described with the structure of &%recipient_item%& above), because it pre-dates
29285 the addition of that field to the structure. However, it is easy to add such a
29286 value afterwards. For example:
29287 .code
29288  receive_add_recipient(US"monitor@mydom.example", -1);
29289  recipients_list[recipients_count-1].errors_to =
29290    US"postmaster@mydom.example";
29291 .endd
29292
29293 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
29294 This is a convenience function to remove a named recipient from the list of
29295 recipients. It returns true if a recipient was removed, and false if no
29296 matching recipient could be found. The argument must be a complete email
29297 address.
29298 .endlist
29299
29300
29301 .cindex "RFC 2047"
29302 .vlist
29303 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
29304   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
29305 This function decodes strings that are encoded according to RFC 2047. Typically
29306 these are the contents of header lines. First, each &"encoded word"& is decoded
29307 from the Q or B encoding into a byte-string. Then, if provided with the name of
29308 a charset encoding, and if the &[iconv()]& function is available, an attempt is
29309 made  to translate the result to the named character set. If this fails, the
29310 binary string is returned with an error message.
29311
29312 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
29313 maximum MIME word length is enforced. The third argument is the target
29314 encoding, or NULL if no translation is wanted.
29315
29316 .cindex "binary zero" "in RFC 2047 decoding"
29317 .cindex "RFC 2047" "binary zero in"
29318 If a binary zero is encountered in the decoded string, it is replaced by the
29319 contents of the &%zeroval%& argument. For use with Exim headers, the value must
29320 not be 0 because header lines are handled as zero-terminated strings.
29321
29322 The function returns the result of processing the string, zero-terminated; if
29323 &%lenptr%& is not NULL, the length of the result is set in the variable to
29324 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
29325
29326 If an error is encountered, the function returns NULL and uses the &%error%&
29327 argument to return an error message. The variable pointed to by &%error%& is
29328 set to NULL if there is no error; it may be set non-NULL even when the function
29329 returns a non-NULL value if decoding was successful, but there was a problem
29330 with translation.
29331
29332
29333 .vitem &*int&~smtp_fflush(void)*&
29334 This function is used in conjunction with &'smtp_printf()'&, as described
29335 below.
29336
29337 .vitem &*void&~smtp_printf(char&~*,&~...)*&
29338 The arguments of this function are like &[printf()]&; it writes to the SMTP
29339 output stream. You should use this function only when there is an SMTP output
29340 stream, that is, when the incoming message is being received via interactive
29341 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
29342 is FALSE. If you want to test for an incoming message from another host (as
29343 opposed to a local process that used the &%-bs%& command line option), you can
29344 test the value of &%sender_host_address%&, which is non-NULL when a remote host
29345 is involved.
29346
29347 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
29348 output function, so it can be used for all forms of SMTP connection.
29349
29350 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
29351 must start with an appropriate response code: 550 if you are going to return
29352 LOCAL_SCAN_REJECT, 451 if you are going to return
29353 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
29354 initial lines of a multi-line response, the code must be followed by a hyphen
29355 to indicate that the line is not the final response line. You must also ensure
29356 that the lines you write terminate with CRLF. For example:
29357 .code
29358 smtp_printf("550-this is some extra info\r\n");
29359 return LOCAL_SCAN_REJECT;
29360 .endd
29361 Note that you can also create multi-line responses by including newlines in
29362 the data returned via the &%return_text%& argument. The added value of using
29363 &'smtp_printf()'& is that, for instance, you could introduce delays between
29364 multiple output lines.
29365
29366 The &'smtp_printf()'& function does not return any error indication, because it
29367 does not automatically flush pending output, and therefore does not test
29368 the state of the stream. (In the main code of Exim, flushing and error
29369 detection is done when Exim is ready for the next SMTP input command.) If
29370 you want to flush the output and check for an error (for example, the
29371 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
29372 arguments. It flushes the output stream, and returns a non-zero value if there
29373 is an error.
29374
29375 .vitem &*void&~*store_get(int)*&
29376 This function accesses Exim's internal store (memory) manager. It gets a new
29377 chunk of memory whose size is given by the argument. Exim bombs out if it ever
29378 runs out of memory. See the next section for a discussion of memory handling.
29379
29380 .vitem &*void&~*store_get_perm(int)*&
29381 This function is like &'store_get()'&, but it always gets memory from the
29382 permanent pool. See the next section for a discussion of memory handling.
29383
29384 .vitem &*uschar&~*string_copy(uschar&~*string)*&
29385 See below.
29386
29387 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
29388 See below.
29389
29390 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
29391 These three functions create strings using Exim's dynamic memory facilities.
29392 The first makes a copy of an entire string. The second copies up to a maximum
29393 number of characters, indicated by the second argument. The third uses a format
29394 and insertion arguments to create a new string. In each case, the result is a
29395 pointer to a new string in the current memory pool. See the next section for
29396 more discussion.
29397 .endlist
29398
29399
29400
29401 .section "More about Exim's memory handling" "SECTmemhanloc"
29402 .cindex "&[local_scan()]& function" "memory handling"
29403 No function is provided for freeing memory, because that is never needed.
29404 The dynamic memory that Exim uses when receiving a message is automatically
29405 recycled if another message is received by the same process (this applies only
29406 to incoming SMTP connections &-- other input methods can supply only one
29407 message at a time). After receiving the last message, a reception process
29408 terminates.
29409
29410 Because it is recycled, the normal dynamic memory cannot be used for holding
29411 data that must be preserved over a number of incoming messages on the same SMTP
29412 connection. However, Exim in fact uses two pools of dynamic memory; the second
29413 one is not recycled, and can be used for this purpose.
29414
29415 If you want to allocate memory that remains available for subsequent messages
29416 in the same SMTP connection, you should set
29417 .code
29418 store_pool = POOL_PERM
29419 .endd
29420 before calling the function that does the allocation. There is no need to
29421 restore the value if you do not need to; however, if you do want to revert to
29422 the normal pool, you can either restore the previous value of &%store_pool%& or
29423 set it explicitly to POOL_MAIN.
29424
29425 The pool setting applies to all functions that get dynamic memory, including
29426 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
29427 There is also a convenience function called &'store_get_perm()'& that gets a
29428 block of memory from the permanent pool while preserving the value of
29429 &%store_pool%&.
29430 .ecindex IIDlosca
29431
29432
29433
29434
29435 . ////////////////////////////////////////////////////////////////////////////
29436 . ////////////////////////////////////////////////////////////////////////////
29437
29438 .chapter "System-wide message filtering" "CHAPsystemfilter"
29439 .scindex IIDsysfil1 "filter" "system filter"
29440 .scindex IIDsysfil2 "filtering all mail"
29441 .scindex IIDsysfil3 "system filter"
29442 The previous chapters (on ACLs and the local scan function) describe checks
29443 that can be applied to messages before they are accepted by a host. There is
29444 also a mechanism for checking messages once they have been received, but before
29445 they are delivered. This is called the &'system filter'&.
29446
29447 The system filter operates in a similar manner to users' filter files, but it
29448 is run just once per message (however many recipients the message has).
29449 It should not normally be used as a substitute for routing, because &%deliver%&
29450 commands in a system router provide new envelope recipient addresses.
29451 The system filter must be an Exim filter. It cannot be a Sieve filter.
29452
29453 The system filter is run at the start of a delivery attempt, before any routing
29454 is done. If a message fails to be completely delivered at the first attempt,
29455 the system filter is run again at the start of every retry.
29456 If you want your filter to do something only once per message, you can make use
29457 of the &%first_delivery%& condition in an &%if%& command in the filter to
29458 prevent it happening on retries.
29459
29460 .vindex "&$domain$&"
29461 .vindex "&$local_part$&"
29462 &*Warning*&: Because the system filter runs just once, variables that are
29463 specific to individual recipient addresses, such as &$local_part$& and
29464 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
29465 you want to run a centrally-specified filter for each recipient address
29466 independently, you can do so by setting up a suitable &(redirect)& router, as
29467 described in section &<<SECTperaddfil>>& below.
29468
29469
29470 .section "Specifying a system filter" "SECID212"
29471 .cindex "uid (user id)" "system filter"
29472 .cindex "gid (group id)" "system filter"
29473 The name of the file that contains the system filter must be specified by
29474 setting &%system_filter%&. If you want the filter to run under a uid and gid
29475 other than root, you must also set &%system_filter_user%& and
29476 &%system_filter_group%& as appropriate. For example:
29477 .code
29478 system_filter = /etc/mail/exim.filter
29479 system_filter_user = exim
29480 .endd
29481 If a system filter generates any deliveries directly to files or pipes (via the
29482 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
29483 specified by setting &%system_filter_file_transport%& and
29484 &%system_filter_pipe_transport%&, respectively. Similarly,
29485 &%system_filter_reply_transport%& must be set to handle any messages generated
29486 by the &%reply%& command.
29487
29488
29489 .section "Testing a system filter" "SECID213"
29490 You can run simple tests of a system filter in the same way as for a user
29491 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
29492 are permitted only in system filters are recognized.
29493
29494 If you want to test the combined effect of a system filter and a user filter,
29495 you can use both &%-bF%& and &%-bf%& on the same command line.
29496
29497
29498
29499 .section "Contents of a system filter" "SECID214"
29500 The language used to specify system filters is the same as for users' filter
29501 files. It is described in the separate end-user document &'Exim's interface to
29502 mail filtering'&. However, there are some additional features that are
29503 available only in system filters; these are described in subsequent sections.
29504 If they are encountered in a user's filter file or when testing with &%-bf%&,
29505 they cause errors.
29506
29507 .cindex "frozen messages" "manual thaw; testing in filter"
29508 There are two special conditions which, though available in users' filter
29509 files, are designed for use in system filters. The condition &%first_delivery%&
29510 is true only for the first attempt at delivering a message, and
29511 &%manually_thawed%& is true only if the message has been frozen, and
29512 subsequently thawed by an admin user. An explicit forced delivery counts as a
29513 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
29514
29515 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
29516 specify an &"unseen"& (non-significant) delivery, and that delivery does not
29517 succeed, it will not be tried again.
29518 If you want Exim to retry an unseen delivery until it succeeds, you should
29519 arrange to set it up every time the filter runs.
29520
29521 When a system filter finishes running, the values of the variables &$n0$& &--
29522 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
29523 users' filter files. Thus a system filter can, for example, set up &"scores"&
29524 to which users' filter files can refer.
29525
29526
29527
29528 .section "Additional variable for system filters" "SECID215"
29529 .vindex "&$recipients$&"
29530 The expansion variable &$recipients$&, containing a list of all the recipients
29531 of the message (separated by commas and white space), is available in system
29532 filters. It is not available in users' filters for privacy reasons.
29533
29534
29535
29536 .section "Defer, freeze, and fail commands for system filters" "SECID216"
29537 .cindex "freezing messages"
29538 .cindex "message" "freezing"
29539 .cindex "message" "forced failure"
29540 .cindex "&%fail%&" "in system filter"
29541 .cindex "&%freeze%& in system filter"
29542 .cindex "&%defer%& in system filter"
29543 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
29544 always available in system filters, but are not normally enabled in users'
29545 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
29546 for the &(redirect)& router.) These commands can optionally be followed by the
29547 word &%text%& and a string containing an error message, for example:
29548 .code
29549 fail text "this message looks like spam to me"
29550 .endd
29551 The keyword &%text%& is optional if the next character is a double quote.
29552
29553 The &%defer%& command defers delivery of the original recipients of the
29554 message. The &%fail%& command causes all the original recipients to be failed,
29555 and a bounce message to be created. The &%freeze%& command suspends all
29556 delivery attempts for the original recipients. In all cases, any new deliveries
29557 that are specified by the filter are attempted as normal after the filter has
29558 run.
29559
29560 The &%freeze%& command is ignored if the message has been manually unfrozen and
29561 not manually frozen since. This means that automatic freezing by a system
29562 filter can be used as a way of checking out suspicious messages. If a message
29563 is found to be all right, manually unfreezing it allows it to be delivered.
29564
29565 .cindex "log" "&%fail%& command log line"
29566 .cindex "&%fail%&" "log line; reducing"
29567 The text given with a fail command is used as part of the bounce message as
29568 well as being written to the log. If the message is quite long, this can fill
29569 up a lot of log space when such failures are common. To reduce the size of the
29570 log message, Exim interprets the text in a special way if it starts with the
29571 two characters &`<<`& and contains &`>>`& later. The text between these two
29572 strings is written to the log, and the rest of the text is used in the bounce
29573 message. For example:
29574 .code
29575 fail "<<filter test 1>>Your message is rejected \
29576      because it contains attachments that we are \
29577      not prepared to receive."
29578 .endd
29579
29580 .cindex "loop" "caused by &%fail%&"
29581 Take great care with the &%fail%& command when basing the decision to fail on
29582 the contents of the message, because the bounce message will of course include
29583 the contents of the original message and will therefore trigger the &%fail%&
29584 command again (causing a mail loop) unless steps are taken to prevent this.
29585 Testing the &%error_message%& condition is one way to prevent this. You could
29586 use, for example
29587 .code
29588 if $message_body contains "this is spam" and not error_message
29589 then fail text "spam is not wanted here" endif
29590 .endd
29591 though of course that might let through unwanted bounce messages. The
29592 alternative is clever checking of the body and/or headers to detect bounces
29593 generated by the filter.
29594
29595 The interpretation of a system filter file ceases after a
29596 &%defer%&,
29597 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
29598 set up earlier in the filter file are honoured, so you can use a sequence such
29599 as
29600 .code
29601 mail ...
29602 freeze
29603 .endd
29604 to send a specified message when the system filter is freezing (or deferring or
29605 failing) a message. The normal deliveries for the message do not, of course,
29606 take place.
29607
29608
29609
29610 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
29611 .cindex "header lines" "adding; in system filter"
29612 .cindex "header lines" "removing; in system filter"
29613 .cindex "filter" "header lines; adding/removing"
29614 Two filter commands that are available only in system filters are:
29615 .code
29616 headers add <string>
29617 headers remove <string>
29618 .endd
29619 The argument for the &%headers add%& is a string that is expanded and then
29620 added to the end of the message's headers. It is the responsibility of the
29621 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
29622 space is ignored, and if the string is otherwise empty, or if the expansion is
29623 forced to fail, the command has no effect.
29624
29625 You can use &"\n"& within the string, followed by white space, to specify
29626 continued header lines. More than one header may be added in one command by
29627 including &"\n"& within the string without any following white space. For
29628 example:
29629 .code
29630 headers add "X-header-1: ....\n  \
29631              continuation of X-header-1 ...\n\
29632              X-header-2: ...."
29633 .endd
29634 Note that the header line continuation white space after the first newline must
29635 be placed before the backslash that continues the input string, because white
29636 space after input continuations is ignored.
29637
29638 The argument for &%headers remove%& is a colon-separated list of header names.
29639 This command applies only to those headers that are stored with the message;
29640 those that are added at delivery time (such as &'Envelope-To:'& and
29641 &'Return-Path:'&) cannot be removed by this means. If there is more than one
29642 header with the same name, they are all removed.
29643
29644 The &%headers%& command in a system filter makes an immediate change to the set
29645 of header lines that was received with the message (with possible additions
29646 from ACL processing). Subsequent commands in the system filter operate on the
29647 modified set, which also forms the basis for subsequent message delivery.
29648 Unless further modified during routing or transporting, this set of headers is
29649 used for all recipients of the message.
29650
29651 During routing and transporting, the variables that refer to the contents of
29652 header lines refer only to those lines that are in this set. Thus, header lines
29653 that are added by a system filter are visible to users' filter files and to all
29654 routers and transports. This contrasts with the manipulation of header lines by
29655 routers and transports, which is not immediate, but which instead is saved up
29656 until the message is actually being written (see section
29657 &<<SECTheadersaddrem>>&).
29658
29659 If the message is not delivered at the first attempt, header lines that were
29660 added by the system filter are stored with the message, and so are still
29661 present at the next delivery attempt. Header lines that were removed are still
29662 present, but marked &"deleted"& so that they are not transported with the
29663 message. For this reason, it is usual to make the &%headers%& command
29664 conditional on &%first_delivery%& so that the set of header lines is not
29665 modified more than once.
29666
29667 Because header modification in a system filter acts immediately, you have to
29668 use an indirect approach if you want to modify the contents of a header line.
29669 For example:
29670 .code
29671 headers add "Old-Subject: $h_subject:"
29672 headers remove "Subject"
29673 headers add "Subject: new subject (was: $h_old-subject:)"
29674 headers remove "Old-Subject"
29675 .endd
29676
29677
29678
29679 .section "Setting an errors address in a system filter" "SECID217"
29680 .cindex "envelope sender"
29681 In a system filter, if a &%deliver%& command is followed by
29682 .code
29683 errors_to <some address>
29684 .endd
29685 in order to change the envelope sender (and hence the error reporting) for that
29686 delivery, any address may be specified. (In a user filter, only the current
29687 user's address can be set.) For example, if some mail is being monitored, you
29688 might use
29689 .code
29690 unseen deliver monitor@spying.example errors_to root@local.example
29691 .endd
29692 to take a copy which would not be sent back to the normal error reporting
29693 address if its delivery failed.
29694
29695
29696
29697 .section "Per-address filtering" "SECTperaddfil"
29698 .vindex "&$domain$&"
29699 .vindex "&$local_part$&"
29700 In contrast to the system filter, which is run just once per message for each
29701 delivery attempt, it is also possible to set up a system-wide filtering
29702 operation that runs once for each recipient address. In this case, variables
29703 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
29704 filter file could be made dependent on them. This is an example of a router
29705 which implements such a filter:
29706 .code
29707 central_filter:
29708   check_local_user
29709   driver = redirect
29710   domains = +local_domains
29711   file = /central/filters/$local_part
29712   no_verify
29713   allow_filter
29714   allow_freeze
29715 .endd
29716 The filter is run in a separate process under its own uid. Therefore, either
29717 &%check_local_user%& must be set (as above), in which case the filter is run as
29718 the local user, or the &%user%& option must be used to specify which user to
29719 use. If both are set, &%user%& overrides.
29720
29721 Care should be taken to ensure that none of the commands in the filter file
29722 specify a significant delivery if the message is to go on to be delivered to
29723 its intended recipient. The router will not then claim to have dealt with the
29724 address, so it will be passed on to subsequent routers to be delivered in the
29725 normal way.
29726 .ecindex IIDsysfil1
29727 .ecindex IIDsysfil2
29728 .ecindex IIDsysfil3
29729
29730
29731
29732
29733
29734
29735 . ////////////////////////////////////////////////////////////////////////////
29736 . ////////////////////////////////////////////////////////////////////////////
29737
29738 .chapter "Message processing" "CHAPmsgproc"
29739 .scindex IIDmesproc "message" "general processing"
29740 Exim performs various transformations on the sender and recipient addresses of
29741 all messages that it handles, and also on the messages' header lines. Some of
29742 these are optional and configurable, while others always take place. All of
29743 this processing, except rewriting as a result of routing, and the addition or
29744 removal of header lines while delivering, happens when a message is received,
29745 before it is placed on Exim's queue.
29746
29747 Some of the automatic processing takes place by default only for
29748 &"locally-originated"& messages. This adjective is used to describe messages
29749 that are not received over TCP/IP, but instead are passed to an Exim process on
29750 its standard input. This includes the interactive &"local SMTP"& case that is
29751 set up by the &%-bs%& command line option.
29752
29753 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
29754 or ::1) are not considered to be locally-originated. Exim does not treat the
29755 loopback interface specially in any way.
29756
29757 If you want the loopback interface to be treated specially, you must ensure
29758 that there are appropriate entries in your ACLs.
29759
29760
29761
29762
29763 .section "Submission mode for non-local messages" "SECTsubmodnon"
29764 .cindex "message" "submission"
29765 .cindex "submission mode"
29766 Processing that happens automatically for locally-originated messages (unless
29767 &%suppress_local_fixups%& is set) can also be requested for messages that are
29768 received over TCP/IP. The term &"submission mode"& is used to describe this
29769 state. Submission mode is set by the modifier
29770 .code
29771 control = submission
29772 .endd
29773 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
29774 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
29775 a local submission, and is normally used when the source of the message is
29776 known to be an MUA running on a client host (as opposed to an MTA). For
29777 example, to set submission mode for messages originating on the IPv4 loopback
29778 interface, you could include the following in the MAIL ACL:
29779 .code
29780 warn  hosts = 127.0.0.1
29781       control = submission
29782 .endd
29783 .cindex "&%sender_retain%& submission option"
29784 There are some options that can be used when setting submission mode. A slash
29785 is used to separate options. For example:
29786 .code
29787 control = submission/sender_retain
29788 .endd
29789 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
29790 true and &%local_from_check%& false for the current incoming message. The first
29791 of these allows an existing &'Sender:'& header in the message to remain, and
29792 the second suppresses the check to ensure that &'From:'& matches the
29793 authenticated sender. With this setting, Exim still fixes up messages by adding
29794 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
29795 attempt to check sender authenticity in header lines.
29796
29797 When &%sender_retain%& is not set, a submission mode setting may specify a
29798 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
29799 example:
29800 .code
29801 control = submission/domain=some.domain
29802 .endd
29803 The domain may be empty. How this value is used is described in sections
29804 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
29805 that allows you to specify the user's full name for inclusion in a created
29806 &'Sender:'& or &'From:'& header line. For example:
29807 .code
29808 accept authenticated = *
29809        control = submission/domain=wonderland.example/\
29810                             name=${lookup {$authenticated_id} \
29811                                    lsearch {/etc/exim/namelist}}
29812 .endd
29813 Because the name may contain any characters, including slashes, the &%name%&
29814 option must be given last. The remainder of the string is used as the name. For
29815 the example above, if &_/etc/exim/namelist_& contains:
29816 .code
29817 bigegg:  Humpty Dumpty
29818 .endd
29819 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
29820 line would be:
29821 .code
29822 Sender: Humpty Dumpty <bigegg@wonderland.example>
29823 .endd
29824 .cindex "return path" "in submission mode"
29825 By default, submission mode forces the return path to the same address as is
29826 used to create the &'Sender:'& header. However, if &%sender_retain%& is
29827 specified, the return path is also left unchanged.
29828
29829 &*Note*&: The changes caused by submission mode take effect after the predata
29830 ACL. This means that any sender checks performed before the fix-ups use the
29831 untrusted sender address specified by the user, not the trusted sender address
29832 specified by submission mode. Although this might be slightly unexpected, it
29833 does mean that you can configure ACL checks to spot that a user is trying to
29834 spoof another's address.
29835
29836 .section "Line endings" "SECTlineendings"
29837 .cindex "line endings"
29838 .cindex "carriage return"
29839 .cindex "linefeed"
29840 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
29841 linefeed) is the line ending for messages transmitted over the Internet using
29842 SMTP over TCP/IP. However, within individual operating systems, different
29843 conventions are used. For example, Unix-like systems use just LF, but others
29844 use CRLF or just CR.
29845
29846 Exim was designed for Unix-like systems, and internally, it stores messages
29847 using the system's convention of a single LF as a line terminator. When
29848 receiving a message, all line endings are translated to this standard format.
29849 Originally, it was thought that programs that passed messages directly to an
29850 MTA within an operating system would use that system's convention. Experience
29851 has shown that this is not the case; for example, there are Unix applications
29852 that use CRLF in this circumstance. For this reason, and for compatibility with
29853 other MTAs, the way Exim handles line endings for all messages is now as
29854 follows:
29855
29856 .ilist
29857 LF not preceded by CR is treated as a line ending.
29858 .next
29859 CR is treated as a line ending; if it is immediately followed by LF, the LF
29860 is ignored.
29861 .next
29862 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
29863 nor a local message in the state where a line containing only a dot is a
29864 terminator.
29865 .next
29866 If a bare CR is encountered within a header line, an extra space is added after
29867 the line terminator so as not to end the header line. The reasoning behind this
29868 is that bare CRs in header lines are most likely either to be mistakes, or
29869 people trying to play silly games.
29870 .next
29871 If the first header line received in a message ends with CRLF, a subsequent
29872 bare LF in a header line is treated in the same way as a bare CR in a header
29873 line.
29874 .endlist
29875
29876
29877
29878
29879
29880 .section "Unqualified addresses" "SECID218"
29881 .cindex "unqualified addresses"
29882 .cindex "address" "qualification"
29883 By default, Exim expects every envelope address it receives from an external
29884 host to be fully qualified. Unqualified addresses cause negative responses to
29885 SMTP commands. However, because SMTP is used as a means of transporting
29886 messages from MUAs running on personal workstations, there is sometimes a
29887 requirement to accept unqualified addresses from specific hosts or IP networks.
29888
29889 Exim has two options that separately control which hosts may send unqualified
29890 sender or recipient addresses in SMTP commands, namely
29891 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
29892 cases, if an unqualified address is accepted, it is qualified by adding the
29893 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
29894
29895 .oindex "&%qualify_domain%&"
29896 .oindex "&%qualify_recipient%&"
29897 Unqualified addresses in header lines are automatically qualified for messages
29898 that are locally originated, unless the &%-bnq%& option is given on the command
29899 line. For messages received over SMTP, unqualified addresses in header lines
29900 are qualified only if unqualified addresses are permitted in SMTP commands. In
29901 other words, such qualification is also controlled by
29902 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
29903
29904
29905
29906
29907 .section "The UUCP From line" "SECID219"
29908 .cindex "&""From""& line"
29909 .cindex "UUCP" "&""From""& line"
29910 .cindex "sender" "address"
29911 .oindex "&%uucp_from_pattern%&"
29912 .oindex "&%uucp_from_sender%&"
29913 .cindex "envelope sender"
29914 .cindex "Sendmail compatibility" "&""From""& line"
29915 Messages that have come from UUCP (and some other applications) often begin
29916 with a line containing the envelope sender and a timestamp, following the word
29917 &"From"&. Examples of two common formats are:
29918 .code
29919 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
29920 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
29921 .endd
29922 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
29923 Exim recognizes such lines at the start of messages that are submitted to it
29924 via the command line (that is, on the standard input). It does not recognize
29925 such lines in incoming SMTP messages, unless the sending host matches
29926 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
29927 and &%ignore_fromline_local%& is set. The recognition is controlled by a
29928 regular expression that is defined by the &%uucp_from_pattern%& option, whose
29929 default value matches the two common cases shown above and puts the address
29930 that follows &"From"& into &$1$&.
29931
29932 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
29933 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
29934 a trusted user, the message's sender address is constructed by expanding the
29935 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
29936 then parsed as an RFC 2822 address. If there is no domain, the local part is
29937 qualified with &%qualify_domain%& unless it is the empty string. However, if
29938 the command line &%-f%& option is used, it overrides the &"From"& line.
29939
29940 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
29941 sender address is not changed. This is also the case for incoming SMTP messages
29942 that are permitted to contain &"From"& lines.
29943
29944 Only one &"From"& line is recognized. If there is more than one, the second is
29945 treated as a data line that starts the body of the message, as it is not valid
29946 as a header line. This also happens if a &"From"& line is present in an
29947 incoming SMTP message from a source that is not permitted to send them.
29948
29949
29950
29951 .section "Resent- header lines" "SECID220"
29952 .cindex "&%Resent-%& header lines"
29953 RFC 2822 makes provision for sets of header lines starting with the string
29954 &`Resent-`& to be added to a message when it is resent by the original
29955 recipient to somebody else. These headers are &'Resent-Date:'&,
29956 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
29957 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
29958
29959 .blockquote
29960 &'Resent fields are strictly informational. They MUST NOT be used in the normal
29961 processing of replies or other such automatic actions on messages.'&
29962 .endblockquote
29963
29964 This leaves things a bit vague as far as other processing actions such as
29965 address rewriting are concerned. Exim treats &%Resent-%& header lines as
29966 follows:
29967
29968 .ilist
29969 A &'Resent-From:'& line that just contains the login id of the submitting user
29970 is automatically rewritten in the same way as &'From:'& (see below).
29971 .next
29972 If there's a rewriting rule for a particular header line, it is also applied to
29973 &%Resent-%& header lines of the same type. For example, a rule that rewrites
29974 &'From:'& also rewrites &'Resent-From:'&.
29975 .next
29976 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
29977 also removed.
29978 .next
29979 For a locally-submitted message,
29980 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
29981 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
29982 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
29983 included in log lines in this case.
29984 .next
29985 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
29986 &%Resent-%& header lines are present.
29987 .endlist
29988
29989
29990
29991
29992 .section "The Auto-Submitted: header line" "SECID221"
29993 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
29994 includes the header line:
29995 .code
29996 Auto-Submitted: auto-replied
29997 .endd
29998
29999 .section "The Bcc: header line" "SECID222"
30000 .cindex "&'Bcc:'& header line"
30001 If Exim is called with the &%-t%& option, to take recipient addresses from a
30002 message's header, it removes any &'Bcc:'& header line that may exist (after
30003 extracting its addresses). If &%-t%& is not present on the command line, any
30004 existing &'Bcc:'& is not removed.
30005
30006
30007 .section "The Date: header line" "SECID223"
30008 .cindex "&'Date:'& header line"
30009 If a locally-generated or submission-mode message has no &'Date:'& header line,
30010 Exim adds one, using the current date and time, unless the
30011 &%suppress_local_fixups%& control has been specified.
30012
30013 .section "The Delivery-date: header line" "SECID224"
30014 .cindex "&'Delivery-date:'& header line"
30015 .oindex "&%delivery_date_remove%&"
30016 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
30017 set. Exim can be configured to add them to the final delivery of messages. (See
30018 the generic &%delivery_date_add%& transport option.) They should not be present
30019 in messages in transit. If the &%delivery_date_remove%& configuration option is
30020 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
30021 messages.
30022
30023
30024 .section "The Envelope-to: header line" "SECID225"
30025 .cindex "&'Envelope-to:'& header line"
30026 .oindex "&%envelope_to_remove%&"
30027 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
30028 Exim can be configured to add them to the final delivery of messages. (See the
30029 generic &%envelope_to_add%& transport option.) They should not be present in
30030 messages in transit. If the &%envelope_to_remove%& configuration option is set
30031 (the default), Exim removes &'Envelope-to:'& header lines from incoming
30032 messages.
30033
30034
30035 .section "The From: header line" "SECTthefrohea"
30036 .cindex "&'From:'& header line"
30037 .cindex "Sendmail compatibility" "&""From""& line"
30038 .cindex "message" "submission"
30039 .cindex "submission mode"
30040 If a submission-mode message does not contain a &'From:'& header line, Exim
30041 adds one if either of the following conditions is true:
30042
30043 .ilist
30044 The envelope sender address is not empty (that is, this is not a bounce
30045 message). The added header line copies the envelope sender address.
30046 .next
30047 .vindex "&$authenticated_id$&"
30048 The SMTP session is authenticated and &$authenticated_id$& is not empty.
30049 .olist
30050 .vindex "&$qualify_domain$&"
30051 If no domain is specified by the submission control, the local part is
30052 &$authenticated_id$& and the domain is &$qualify_domain$&.
30053 .next
30054 If a non-empty domain is specified by the submission control, the local
30055 part is &$authenticated_id$&, and the domain is the specified domain.
30056 .next
30057 If an empty domain is specified by the submission control,
30058 &$authenticated_id$& is assumed to be the complete address.
30059 .endlist
30060 .endlist
30061
30062 A non-empty envelope sender takes precedence.
30063
30064 If a locally-generated incoming message does not contain a &'From:'& header
30065 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
30066 containing the sender's address. The calling user's login name and full name
30067 are used to construct the address, as described in section &<<SECTconstr>>&.
30068 They are obtained from the password data by calling &[getpwuid()]& (but see the
30069 &%unknown_login%& configuration option). The address is qualified with
30070 &%qualify_domain%&.
30071
30072 For compatibility with Sendmail, if an incoming, non-SMTP message has a
30073 &'From:'& header line containing just the unqualified login name of the calling
30074 user, this is replaced by an address containing the user's login name and full
30075 name as described in section &<<SECTconstr>>&.
30076
30077
30078 .section "The Message-ID: header line" "SECID226"
30079 .cindex "&'Message-ID:'& header line"
30080 .cindex "message" "submission"
30081 .oindex "&%message_id_header_text%&"
30082 If a locally-generated or submission-mode incoming message does not contain a
30083 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
30084 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
30085 to the message. If there are any &'Resent-:'& headers in the message, it
30086 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
30087 message id, preceded by the letter E to ensure it starts with a letter, and
30088 followed by @ and the primary host name. Additional information can be included
30089 in this header line by setting the &%message_id_header_text%& and/or
30090 &%message_id_header_domain%& options.
30091
30092
30093 .section "The Received: header line" "SECID227"
30094 .cindex "&'Received:'& header line"
30095 A &'Received:'& header line is added at the start of every message. The
30096 contents are defined by the &%received_header_text%& configuration option, and
30097 Exim automatically adds a semicolon and a timestamp to the configured string.
30098
30099 The &'Received:'& header is generated as soon as the message's header lines
30100 have been received. At this stage, the timestamp in the &'Received:'& header
30101 line is the time that the message started to be received. This is the value
30102 that is seen by the DATA ACL and by the &[local_scan()]& function.
30103
30104 Once a message is accepted, the timestamp in the &'Received:'& header line is
30105 changed to the time of acceptance, which is (apart from a small delay while the
30106 -H spool file is written) the earliest time at which delivery could start.
30107
30108
30109 .section "The References: header line" "SECID228"
30110 .cindex "&'References:'& header line"
30111 Messages created by the &(autoreply)& transport include a &'References:'&
30112 header line. This is constructed according to the rules that are described in
30113 section 3.64 of RFC 2822 (which states that replies should contain such a
30114 header line), and section 3.14 of RFC 3834 (which states that automatic
30115 responses are not different in this respect). However, because some mail
30116 processing software does not cope well with very long header lines, no more
30117 than 12 message IDs are copied from the &'References:'& header line in the
30118 incoming message. If there are more than 12, the first one and then the final
30119 11 are copied, before adding the message ID of the incoming message.
30120
30121
30122
30123 .section "The Return-path: header line" "SECID229"
30124 .cindex "&'Return-path:'& header line"
30125 .oindex "&%return_path_remove%&"
30126 &'Return-path:'& header lines are defined as something an MTA may insert when
30127 it does the final delivery of messages. (See the generic &%return_path_add%&
30128 transport option.) Therefore, they should not be present in messages in
30129 transit. If the &%return_path_remove%& configuration option is set (the
30130 default), Exim removes &'Return-path:'& header lines from incoming messages.
30131
30132
30133
30134 .section "The Sender: header line" "SECTthesenhea"
30135 .cindex "&'Sender:'& header line"
30136 .cindex "message" "submission"
30137 For a locally-originated message from an untrusted user, Exim may remove an
30138 existing &'Sender:'& header line, and it may add a new one. You can modify
30139 these actions by setting the &%local_sender_retain%& option true, the
30140 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
30141 control setting.
30142
30143 When a local message is received from an untrusted user and
30144 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
30145 control has not been set, a check is made to see if the address given in the
30146 &'From:'& header line is the correct (local) sender of the message. The address
30147 that is expected has the login name as the local part and the value of
30148 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
30149 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
30150 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
30151 line is added to the message.
30152
30153 If you set &%local_from_check%& false, this checking does not occur. However,
30154 the removal of an existing &'Sender:'& line still happens, unless you also set
30155 &%local_sender_retain%& to be true. It is not possible to set both of these
30156 options true at the same time.
30157
30158 .cindex "submission mode"
30159 By default, no processing of &'Sender:'& header lines is done for messages
30160 received over TCP/IP or for messages submitted by trusted users. However, when
30161 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
30162 not specified on the submission control, the following processing takes place:
30163
30164 .vindex "&$authenticated_id$&"
30165 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
30166 authenticated, and &$authenticated_id$& is not empty, a sender address is
30167 created as follows:
30168
30169 .ilist
30170 .vindex "&$qualify_domain$&"
30171 If no domain is specified by the submission control, the local part is
30172 &$authenticated_id$& and the domain is &$qualify_domain$&.
30173 .next
30174 If a non-empty domain is specified by the submission control, the local part
30175 is &$authenticated_id$&, and the domain is the specified domain.
30176 .next
30177 If an empty domain is specified by the submission control,
30178 &$authenticated_id$& is assumed to be the complete address.
30179 .endlist
30180
30181 This address is compared with the address in the &'From:'& header line. If they
30182 are different, a &'Sender:'& header line containing the created address is
30183 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
30184 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
30185
30186 .cindex "return path" "created from &'Sender:'&"
30187 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
30188 the message (the envelope sender address) is changed to be the same address,
30189 except in the case of submission mode when &%sender_retain%& is specified.
30190
30191
30192
30193 .section "Adding and removing header lines in routers and transports" &&&
30194          "SECTheadersaddrem"
30195 .cindex "header lines" "adding; in router or transport"
30196 .cindex "header lines" "removing; in router or transport"
30197 When a message is delivered, the addition and removal of header lines can be
30198 specified in a system filter, or on any of the routers and transports that
30199 process the message. Section &<<SECTaddremheasys>>& contains details about
30200 modifying headers in a system filter. Header lines can also be added in an ACL
30201 as a message is received (see section &<<SECTaddheadacl>>&).
30202
30203 In contrast to what happens in a system filter, header modifications that are
30204 specified on routers and transports apply only to the particular recipient
30205 addresses that are being processed by those routers and transports. These
30206 changes do not actually take place until a copy of the message is being
30207 transported. Therefore, they do not affect the basic set of header lines, and
30208 they do not affect the values of the variables that refer to header lines.
30209
30210 &*Note*&: In particular, this means that any expansions in the configuration of
30211 the transport cannot refer to the modified header lines, because such
30212 expansions all occur before the message is actually transported.
30213
30214 For both routers and transports, the result of expanding a &%headers_add%&
30215 option must be in the form of one or more RFC 2822 header lines, separated by
30216 newlines (coded as &"\n"&). For example:
30217 .code
30218 headers_add = X-added-header: added by $primary_hostname\n\
30219               X-added-second: another added header line
30220 .endd
30221 Exim does not check the syntax of these added header lines.
30222
30223 The result of expanding &%headers_remove%& must consist of a colon-separated
30224 list of header names. This is confusing, because header names themselves are
30225 often terminated by colons. In this case, the colons are the list separators,
30226 not part of the names. For example:
30227 .code
30228 headers_remove = return-receipt-to:acknowledge-to
30229 .endd
30230 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
30231 is expanded at routing time, and then associated with all addresses that are
30232 accepted by that router, and also with any new addresses that it generates. If
30233 an address passes through several routers as a result of aliasing or
30234 forwarding, the changes are cumulative.
30235
30236 .oindex "&%unseen%&"
30237 However, this does not apply to multiple routers that result from the use of
30238 the &%unseen%& option. Any header modifications that were specified by the
30239 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
30240
30241 Addresses that end up with different &%headers_add%& or &%headers_remove%&
30242 settings cannot be delivered together in a batch, so a transport is always
30243 dealing with a set of addresses that have the same header-processing
30244 requirements.
30245
30246 The transport starts by writing the original set of header lines that arrived
30247 with the message, possibly modified by the system filter. As it writes out
30248 these lines, it consults the list of header names that were attached to the
30249 recipient address(es) by &%headers_remove%& options in routers, and it also
30250 consults the transport's own &%headers_remove%& option. Header lines whose
30251 names are on either of these lists are not written out. If there are multiple
30252 instances of any listed header, they are all skipped.
30253
30254 After the remaining original header lines have been written, new header
30255 lines that were specified by routers' &%headers_add%& options are written, in
30256 the order in which they were attached to the address. These are followed by any
30257 header lines specified by the transport's &%headers_add%& option.
30258
30259 This way of handling header line modifications in routers and transports has
30260 the following consequences:
30261
30262 .ilist
30263 The original set of header lines, possibly modified by the system filter,
30264 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
30265 to it, at all times.
30266 .next
30267 Header lines that are added by a router's
30268 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
30269 expansion syntax in subsequent routers or the transport.
30270 .next
30271 Conversely, header lines that are specified for removal by &%headers_remove%&
30272 in a router remain visible to subsequent routers and the transport.
30273 .next
30274 Headers added to an address by &%headers_add%& in a router cannot be removed by
30275 a later router or by a transport.
30276 .next
30277 An added header can refer to the contents of an original header that is to be
30278 removed, even it has the same name as the added header. For example:
30279 .code
30280 headers_remove = subject
30281 headers_add = Subject: new subject (was: $h_subject:)
30282 .endd
30283 .endlist
30284
30285 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
30286 for a &(redirect)& router that has the &%one_time%& option set.
30287
30288
30289
30290
30291
30292 .section "Constructed addresses" "SECTconstr"
30293 .cindex "address" "constructed"
30294 .cindex "constructed address"
30295 When Exim constructs a sender address for a locally-generated message, it uses
30296 the form
30297 .display
30298 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
30299 .endd
30300 For example:
30301 .code
30302 Zaphod Beeblebrox <zaphod@end.univ.example>
30303 .endd
30304 The user name is obtained from the &%-F%& command line option if set, or
30305 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
30306 &"gecos"& field from the password entry. If the &"gecos"& field contains an
30307 ampersand character, this is replaced by the login name with the first letter
30308 upper cased, as is conventional in a number of operating systems. See the
30309 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
30310 The &%unknown_username%& option can be used to specify user names in cases when
30311 there is no password file entry.
30312
30313 .cindex "RFC 2047"
30314 In all cases, the user name is made to conform to RFC 2822 by quoting all or
30315 parts of it if necessary. In addition, if it contains any non-printing
30316 characters, it is encoded as described in RFC 2047, which defines a way of
30317 including non-ASCII characters in header lines. The value of the
30318 &%headers_charset%& option specifies the name of the encoding that is used (the
30319 characters are assumed to be in this encoding). The setting of
30320 &%print_topbitchars%& controls whether characters with the top bit set (that
30321 is, with codes greater than 127) count as printing characters or not.
30322
30323
30324
30325 .section "Case of local parts" "SECID230"
30326 .cindex "case of local parts"
30327 .cindex "local part" "case of"
30328 RFC 2822 states that the case of letters in the local parts of addresses cannot
30329 be assumed to be non-significant. Exim preserves the case of local parts of
30330 addresses, but by default it uses a lower-cased form when it is routing,
30331 because on most Unix systems, usernames are in lower case and case-insensitive
30332 routing is required. However, any particular router can be made to use the
30333 original case for local parts by setting the &%caseful_local_part%& generic
30334 router option.
30335
30336 .cindex "mixed-case login names"
30337 If you must have mixed-case user names on your system, the best way to proceed,
30338 assuming you want case-independent handling of incoming email, is to set up
30339 your first router to convert incoming local parts in your domains to the
30340 correct case by means of a file lookup. For example:
30341 .code
30342 correct_case:
30343   driver = redirect
30344   domains = +local_domains
30345   data = ${lookup{$local_part}cdb\
30346               {/etc/usercased.cdb}{$value}fail}\
30347               @$domain
30348 .endd
30349 For this router, the local part is forced to lower case by the default action
30350 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
30351 up a new local part in the correct case. If you then set &%caseful_local_part%&
30352 on any subsequent routers which process your domains, they will operate on
30353 local parts with the correct case in a case-sensitive manner.
30354
30355
30356
30357 .section "Dots in local parts" "SECID231"
30358 .cindex "dot" "in local part"
30359 .cindex "local part" "dots in"
30360 RFC 2822 forbids empty components in local parts. That is, an unquoted local
30361 part may not begin or end with a dot, nor have two consecutive dots in the
30362 middle. However, it seems that many MTAs do not enforce this, so Exim permits
30363 empty components for compatibility.
30364
30365
30366
30367 .section "Rewriting addresses" "SECID232"
30368 .cindex "rewriting" "addresses"
30369 Rewriting of sender and recipient addresses, and addresses in headers, can
30370 happen automatically, or as the result of configuration options, as described
30371 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
30372 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
30373
30374 Automatic rewriting includes qualification, as mentioned above. The other case
30375 in which it can happen is when an incomplete non-local domain is given. The
30376 routing process may cause this to be expanded into the full domain name. For
30377 example, a header such as
30378 .code
30379 To: hare@teaparty
30380 .endd
30381 might get rewritten as
30382 .code
30383 To: hare@teaparty.wonderland.fict.example
30384 .endd
30385 Rewriting as a result of routing is the one kind of message processing that
30386 does not happen at input time, as it cannot be done until the address has
30387 been routed.
30388
30389 Strictly, one should not do &'any'& deliveries of a message until all its
30390 addresses have been routed, in case any of the headers get changed as a
30391 result of routing. However, doing this in practice would hold up many
30392 deliveries for unreasonable amounts of time, just because one address could not
30393 immediately be routed. Exim therefore does not delay other deliveries when
30394 routing of one or more addresses is deferred.
30395 .ecindex IIDmesproc
30396
30397
30398
30399 . ////////////////////////////////////////////////////////////////////////////
30400 . ////////////////////////////////////////////////////////////////////////////
30401
30402 .chapter "SMTP processing" "CHAPSMTP"
30403 .scindex IIDsmtpproc1 "SMTP" "processing details"
30404 .scindex IIDsmtpproc2 "LMTP" "processing details"
30405 Exim supports a number of different ways of using the SMTP protocol, and its
30406 LMTP variant, which is an interactive protocol for transferring messages into a
30407 closed mail store application. This chapter contains details of how SMTP is
30408 processed. For incoming mail, the following are available:
30409
30410 .ilist
30411 SMTP over TCP/IP (Exim daemon or &'inetd'&);
30412 .next
30413 SMTP over the standard input and output (the &%-bs%& option);
30414 .next
30415 Batched SMTP on the standard input (the &%-bS%& option).
30416 .endlist
30417
30418 For mail delivery, the following are available:
30419
30420 .ilist
30421 SMTP over TCP/IP (the &(smtp)& transport);
30422 .next
30423 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
30424 &"lmtp"&);
30425 .next
30426 LMTP over a pipe to a process running in the local host (the &(lmtp)&
30427 transport);
30428 .next
30429 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
30430 the &%use_bsmtp%& option set).
30431 .endlist
30432
30433 &'Batched SMTP'& is the name for a process in which batches of messages are
30434 stored in or read from files (or pipes), in a format in which SMTP commands are
30435 used to contain the envelope information.
30436
30437
30438
30439 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
30440 .cindex "SMTP" "outgoing over TCP/IP"
30441 .cindex "outgoing SMTP over TCP/IP"
30442 .cindex "LMTP" "over TCP/IP"
30443 .cindex "outgoing LMTP over TCP/IP"
30444 .cindex "EHLO"
30445 .cindex "HELO"
30446 .cindex "SIZE option on MAIL command"
30447 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
30448 The &%protocol%& option selects which protocol is to be used, but the actual
30449 processing is the same in both cases.
30450
30451 If, in response to its EHLO command, Exim is told that the SIZE
30452 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
30453 command. The value of <&'n'&> is the message size plus the value of the
30454 &%size_addition%& option (default 1024) to allow for additions to the message
30455 such as per-transport header lines, or changes made in a
30456 .cindex "transport" "filter"
30457 .cindex "filter" "transport filter"
30458 transport filter. If &%size_addition%& is set negative, the use of SIZE is
30459 suppressed.
30460
30461 If the remote server advertises support for PIPELINING, Exim uses the
30462 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
30463 required for the transaction.
30464
30465 If the remote server advertises support for the STARTTLS command, and Exim
30466 was built to support TLS encryption, it tries to start a TLS session unless the
30467 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
30468
30469 If the remote server advertises support for the AUTH command, Exim scans
30470 the authenticators configuration for any suitable client settings, as described
30471 in chapter &<<CHAPSMTPAUTH>>&.
30472
30473 .cindex "carriage return"
30474 .cindex "linefeed"
30475 Responses from the remote host are supposed to be terminated by CR followed by
30476 LF. However, there are known to be hosts that do not send CR characters, so in
30477 order to be able to interwork with such hosts, Exim treats LF on its own as a
30478 line terminator.
30479
30480 If a message contains a number of different addresses, all those with the same
30481 characteristics (for example, the same envelope sender) that resolve to the
30482 same set of hosts, in the same order, are sent in a single SMTP transaction,
30483 even if they are for different domains, unless there are more than the setting
30484 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
30485 they are split into groups containing no more than &%max_rcpt%&s addresses
30486 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
30487 in parallel sessions. The order of hosts with identical MX values is not
30488 significant when checking whether addresses can be batched in this way.
30489
30490 When the &(smtp)& transport suffers a temporary failure that is not
30491 message-related, Exim updates its transport-specific database, which contains
30492 records indexed by host name that remember which messages are waiting for each
30493 particular host. It also updates the retry database with new retry times.
30494
30495 .cindex "hints database" "retry keys"
30496 Exim's retry hints are based on host name plus IP address, so if one address of
30497 a multi-homed host is broken, it will soon be skipped most of the time.
30498 See the next section for more detail about error handling.
30499
30500 .cindex "SMTP" "passed connection"
30501 .cindex "SMTP" "batching over TCP/IP"
30502 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
30503 looks in the hints database for the transport to see if there are any queued
30504 messages waiting for the host to which it is connected. If it finds one, it
30505 creates a new Exim process using the &%-MC%& option (which can only be used by
30506 a process running as root or the Exim user) and passes the TCP/IP socket to it
30507 so that it can deliver another message using the same socket. The new process
30508 does only those deliveries that are routed to the connected host, and may in
30509 turn pass the socket on to a third process, and so on.
30510
30511 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
30512 limit the number of messages sent down a single TCP/IP connection.
30513
30514 .cindex "asterisk" "after IP address"
30515 The second and subsequent messages delivered down an existing connection are
30516 identified in the main log by the addition of an asterisk after the closing
30517 square bracket of the IP address.
30518
30519
30520
30521
30522 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
30523 .cindex "error" "in outgoing SMTP"
30524 .cindex "SMTP" "errors in outgoing"
30525 .cindex "host" "error"
30526 Three different kinds of error are recognized for outgoing SMTP: host errors,
30527 message errors, and recipient errors.
30528
30529 .vlist
30530 .vitem "&*Host errors*&"
30531 A host error is not associated with a particular message or with a
30532 particular recipient of a message. The host errors are:
30533
30534 .ilist
30535 Connection refused or timed out,
30536 .next
30537 Any error response code on connection,
30538 .next
30539 Any error response code to EHLO or HELO,
30540 .next
30541 Loss of connection at any time, except after &"."&,
30542 .next
30543 I/O errors at any time,
30544 .next
30545 Timeouts during the session, other than in response to MAIL, RCPT or
30546 the &"."& at the end of the data.
30547 .endlist ilist
30548
30549 For a host error, a permanent error response on connection, or in response to
30550 EHLO, causes all addresses routed to the host to be failed. Any other host
30551 error causes all addresses to be deferred, and retry data to be created for the
30552 host. It is not tried again, for any message, until its retry time arrives. If
30553 the current set of addresses are not all delivered in this run (to some
30554 alternative host), the message is added to the list of those waiting for this
30555 host, so if it is still undelivered when a subsequent successful delivery is
30556 made to the host, it will be sent down the same SMTP connection.
30557
30558 .vitem "&*Message errors*&"
30559 .cindex "message" "error"
30560 A message error is associated with a particular message when sent to a
30561 particular host, but not with a particular recipient of the message. The
30562 message errors are:
30563
30564 .ilist
30565 Any error response code to MAIL, DATA, or the &"."& that terminates
30566 the data,
30567 .next
30568 Timeout after MAIL,
30569 .next
30570 Timeout or loss of connection after the &"."& that terminates the data. A
30571 timeout after the DATA command itself is treated as a host error, as is loss of
30572 connection at any other time.
30573 .endlist ilist
30574
30575 For a message error, a permanent error response (5&'xx'&) causes all addresses
30576 to be failed, and a delivery error report to be returned to the sender. A
30577 temporary error response (4&'xx'&), or one of the timeouts, causes all
30578 addresses to be deferred. Retry data is not created for the host, but instead,
30579 a retry record for the combination of host plus message id is created. The
30580 message is not added to the list of those waiting for this host. This ensures
30581 that the failing message will not be sent to this host again until the retry
30582 time arrives. However, other messages that are routed to the host are not
30583 affected, so if it is some property of the message that is causing the error,
30584 it will not stop the delivery of other mail.
30585
30586 If the remote host specified support for the SIZE parameter in its response
30587 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
30588 over-large message will cause a message error because the error arrives as a
30589 response to MAIL.
30590
30591 .vitem "&*Recipient errors*&"
30592 .cindex "recipient" "error"
30593 A recipient error is associated with a particular recipient of a message. The
30594 recipient errors are:
30595
30596 .ilist
30597 Any error response to RCPT,
30598 .next
30599 Timeout after RCPT.
30600 .endlist
30601
30602 For a recipient error, a permanent error response (5&'xx'&) causes the
30603 recipient address to be failed, and a bounce message to be returned to the
30604 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
30605 address to be deferred, and routing retry data to be created for it. This is
30606 used to delay processing of the address in subsequent queue runs, until its
30607 routing retry time arrives. This applies to all messages, but because it
30608 operates only in queue runs, one attempt will be made to deliver a new message
30609 to the failing address before the delay starts to operate. This ensures that,
30610 if the failure is really related to the message rather than the recipient
30611 (&"message too big for this recipient"& is a possible example), other messages
30612 have a chance of getting delivered. If a delivery to the address does succeed,
30613 the retry information gets cleared, so all stuck messages get tried again, and
30614 the retry clock is reset.
30615
30616 The message is not added to the list of those waiting for this host. Use of the
30617 host for other messages is unaffected, and except in the case of a timeout,
30618 other recipients are processed independently, and may be successfully delivered
30619 in the current SMTP session. After a timeout it is of course impossible to
30620 proceed with the session, so all addresses get deferred. However, those other
30621 than the one that failed do not suffer any subsequent retry delays. Therefore,
30622 if one recipient is causing trouble, the others have a chance of getting
30623 through when a subsequent delivery attempt occurs before the failing
30624 recipient's retry time.
30625 .endlist
30626
30627 In all cases, if there are other hosts (or IP addresses) available for the
30628 current set of addresses (for example, from multiple MX records), they are
30629 tried in this run for any undelivered addresses, subject of course to their
30630 own retry data. In other words, recipient error retry data does not take effect
30631 until the next delivery attempt.
30632
30633 Some hosts have been observed to give temporary error responses to every
30634 MAIL command at certain times (&"insufficient space"& has been seen). It
30635 would be nice if such circumstances could be recognized, and defer data for the
30636 host itself created, but this is not possible within the current Exim design.
30637 What actually happens is that retry data for every (host, message) combination
30638 is created.
30639
30640 The reason that timeouts after MAIL and RCPT are treated specially is that
30641 these can sometimes arise as a result of the remote host's verification
30642 procedures. Exim makes this assumption, and treats them as if a temporary error
30643 response had been received. A timeout after &"."& is treated specially because
30644 it is known that some broken implementations fail to recognize the end of the
30645 message if the last character of the last line is a binary zero. Thus, it is
30646 helpful to treat this case as a message error.
30647
30648 Timeouts at other times are treated as host errors, assuming a problem with the
30649 host, or the connection to it. If a timeout after MAIL, RCPT,
30650 or &"."& is really a connection problem, the assumption is that at the next try
30651 the timeout is likely to occur at some other point in the dialogue, causing it
30652 then to be treated as a host error.
30653
30654 There is experimental evidence that some MTAs drop the connection after the
30655 terminating &"."& if they do not like the contents of the message for some
30656 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
30657 should be given. That is why Exim treats this case as a message rather than a
30658 host error, in order not to delay other messages to the same host.
30659
30660
30661
30662
30663 .section "Incoming SMTP messages over TCP/IP" "SECID233"
30664 .cindex "SMTP" "incoming over TCP/IP"
30665 .cindex "incoming SMTP over TCP/IP"
30666 .cindex "inetd"
30667 .cindex "daemon"
30668 Incoming SMTP messages can be accepted in one of two ways: by running a
30669 listening daemon, or by using &'inetd'&. In the latter case, the entry in
30670 &_/etc/inetd.conf_& should be like this:
30671 .code
30672 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
30673 .endd
30674 Exim distinguishes between this case and the case of a locally running user
30675 agent using the &%-bs%& option by checking whether or not the standard input is
30676 a socket. When it is, either the port must be privileged (less than 1024), or
30677 the caller must be root or the Exim user. If any other user passes a socket
30678 with an unprivileged port number, Exim prints a message on the standard error
30679 stream and exits with an error code.
30680
30681 By default, Exim does not make a log entry when a remote host connects or
30682 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
30683 unexpected. It can be made to write such log entries by setting the
30684 &%smtp_connection%& log selector.
30685
30686 .cindex "carriage return"
30687 .cindex "linefeed"
30688 Commands from the remote host are supposed to be terminated by CR followed by
30689 LF. However, there are known to be hosts that do not send CR characters. In
30690 order to be able to interwork with such hosts, Exim treats LF on its own as a
30691 line terminator.
30692 Furthermore, because common code is used for receiving messages from all
30693 sources, a CR on its own is also interpreted as a line terminator. However, the
30694 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
30695
30696 .cindex "EHLO" "invalid data"
30697 .cindex "HELO" "invalid data"
30698 One area that sometimes gives rise to problems concerns the EHLO or
30699 HELO commands. Some clients send syntactically invalid versions of these
30700 commands, which Exim rejects by default. (This is nothing to do with verifying
30701 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
30702 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
30703 match the broken hosts that send invalid commands.
30704
30705 .cindex "SIZE option on MAIL command"
30706 .cindex "MAIL" "SIZE option"
30707 The amount of disk space available is checked whenever SIZE is received on
30708 a MAIL command, independently of whether &%message_size_limit%& or
30709 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
30710 false. A temporary error is given if there is not enough space. If
30711 &%check_spool_space%& is set, the check is for that amount of space plus the
30712 value given with SIZE, that is, it checks that the addition of the incoming
30713 message will not reduce the space below the threshold.
30714
30715 When a message is successfully received, Exim includes the local message id in
30716 its response to the final &"."& that terminates the data. If the remote host
30717 logs this text it can help with tracing what has happened to a message.
30718
30719 The Exim daemon can limit the number of simultaneous incoming connections it is
30720 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
30721 number of simultaneous incoming connections from a single remote host (see the
30722 &%smtp_accept_max_per_host%& option). Additional connection attempts are
30723 rejected using the SMTP temporary error code 421.
30724
30725 The Exim daemon does not rely on the SIGCHLD signal to detect when a
30726 subprocess has finished, as this can get lost at busy times. Instead, it looks
30727 for completed subprocesses every time it wakes up. Provided there are other
30728 things happening (new incoming calls, starts of queue runs), completed
30729 processes will be noticed and tidied away. On very quiet systems you may
30730 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
30731 it will be noticed when the daemon next wakes up.
30732
30733 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
30734 and can also be set up to reject SMTP calls from non-reserved hosts at times of
30735 high system load &-- for details see the &%smtp_accept_reserve%&,
30736 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
30737 applies in both the daemon and &'inetd'& cases.
30738
30739 Exim normally starts a delivery process for each message received, though this
30740 can be varied by means of the &%-odq%& command line option and the
30741 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
30742 number of simultaneously running delivery processes started in this way from
30743 SMTP input can be limited by the &%smtp_accept_queue%& and
30744 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
30745 subsequently received messages are just put on the input queue without starting
30746 a delivery process.
30747
30748 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
30749 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
30750 started up from the &'inetd'& daemon, because in that case each connection is
30751 handled by an entirely independent Exim process. Control by load average is,
30752 however, available with &'inetd'&.
30753
30754 Exim can be configured to verify addresses in incoming SMTP commands as they
30755 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
30756 to rewrite addresses at this time &-- before any syntax checking is done. See
30757 section &<<SECTrewriteS>>&.
30758
30759 Exim can also be configured to limit the rate at which a client host submits
30760 MAIL and RCPT commands in a single SMTP session. See the
30761 &%smtp_ratelimit_hosts%& option.
30762
30763
30764
30765 .section "Unrecognized SMTP commands" "SECID234"
30766 .cindex "SMTP" "unrecognized commands"
30767 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
30768 commands during a single SMTP connection, it drops the connection after sending
30769 the error response to the last command. The default value for
30770 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
30771 abuse that subvert web servers into making connections to SMTP ports; in these
30772 circumstances, a number of non-SMTP lines are sent first.
30773
30774
30775 .section "Syntax and protocol errors in SMTP commands" "SECID235"
30776 .cindex "SMTP" "syntax errors"
30777 .cindex "SMTP" "protocol errors"
30778 A syntax error is detected if an SMTP command is recognized, but there is
30779 something syntactically wrong with its data, for example, a malformed email
30780 address in a RCPT command. Protocol errors include invalid command
30781 sequencing such as RCPT before MAIL. If Exim receives more than
30782 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
30783 drops the connection after sending the error response to the last command. The
30784 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
30785 broken clients that loop sending bad commands (yes, it has been seen).
30786
30787
30788
30789 .section "Use of non-mail SMTP commands" "SECID236"
30790 .cindex "SMTP" "non-mail commands"
30791 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
30792 DATA. Exim counts such commands, and drops the connection if there are too
30793 many of them in a single SMTP session. This action catches some
30794 denial-of-service attempts and things like repeated failing AUTHs, or a mad
30795 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
30796 defines what &"too many"& means. Its default value is 10.
30797
30798 When a new message is expected, one occurrence of RSET is not counted. This
30799 allows a client to send one RSET between messages (this is not necessary,
30800 but some clients do it). Exim also allows one uncounted occurrence of HELO
30801 or EHLO, and one occurrence of STARTTLS between messages. After
30802 starting up a TLS session, another EHLO is expected, and so it too is not
30803 counted.
30804
30805 The first occurrence of AUTH in a connection, or immediately following
30806 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
30807 RCPT, DATA, and QUIT are counted.
30808
30809 You can control which hosts are subject to the limit set by
30810 &%smtp_accept_max_nonmail%& by setting
30811 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
30812 the limit apply to all hosts. This option means that you can exclude any
30813 specific badly-behaved hosts that you have to live with.
30814
30815
30816
30817
30818 .section "The VRFY and EXPN commands" "SECID237"
30819 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
30820 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
30821 appropriate) in order to decide whether the command should be accepted or not.
30822 If no ACL is defined, the command is rejected.
30823
30824 .cindex "VRFY" "processing"
30825 When VRFY is accepted, it runs exactly the same code as when Exim is
30826 called with the &%-bv%& option.
30827
30828 .cindex "EXPN" "processing"
30829 When EXPN is accepted, a single-level expansion of the address is done.
30830 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
30831 than a verification (the &%-bv%& option). If an unqualified local part is given
30832 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
30833 of VRFY and EXPN commands are logged on the main and reject logs, and
30834 VRFY verification failures are logged on the main log for consistency with
30835 RCPT failures.
30836
30837
30838
30839 .section "The ETRN command" "SECTETRN"
30840 .cindex "ETRN" "processing"
30841 RFC 1985 describes an SMTP command called ETRN that is designed to
30842 overcome the security problems of the TURN command (which has fallen into
30843 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
30844 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
30845 should be accepted or not. If no ACL is defined, the command is rejected.
30846
30847 The ETRN command is concerned with &"releasing"& messages that are awaiting
30848 delivery to certain hosts. As Exim does not organize its message queue by host,
30849 the only form of ETRN that is supported by default is the one where the
30850 text starts with the &"#"& prefix, in which case the remainder of the text is
30851 specific to the SMTP server. A valid ETRN command causes a run of Exim with
30852 the &%-R%& option to happen, with the remainder of the ETRN text as its
30853 argument. For example,
30854 .code
30855 ETRN #brigadoon
30856 .endd
30857 runs the command
30858 .code
30859 exim -R brigadoon
30860 .endd
30861 which causes a delivery attempt on all messages with undelivered addresses
30862 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
30863 default), Exim prevents the simultaneous execution of more than one queue run
30864 for the same argument string as a result of an ETRN command. This stops
30865 a misbehaving client from starting more than one queue runner at once.
30866
30867 .cindex "hints database" "ETRN serialization"
30868 Exim implements the serialization by means of a hints database in which a
30869 record is written whenever a process is started by ETRN, and deleted when
30870 the process completes. However, Exim does not keep the SMTP session waiting for
30871 the ETRN process to complete. Once ETRN is accepted, the client is sent
30872 a &"success"& return code. Obviously there is scope for hints records to get
30873 left lying around if there is a system or program crash. To guard against this,
30874 Exim ignores any records that are more than six hours old.
30875
30876 .oindex "&%smtp_etrn_command%&"
30877 For more control over what ETRN does, the &%smtp_etrn_command%& option can
30878 used. This specifies a command that is run whenever ETRN is received,
30879 whatever the form of its argument. For
30880 example:
30881 .code
30882 smtp_etrn_command = /etc/etrn_command $domain \
30883                     $sender_host_address
30884 .endd
30885 .vindex "&$domain$&"
30886 The string is split up into arguments which are independently expanded. The
30887 expansion variable &$domain$& is set to the argument of the ETRN command,
30888 and no syntax checking is done on the contents of this argument. Exim does not
30889 wait for the command to complete, so its status code is not checked. Exim runs
30890 under its own uid and gid when receiving incoming SMTP, so it is not possible
30891 for it to change them before running the command.
30892
30893
30894
30895 .section "Incoming local SMTP" "SECID238"
30896 .cindex "SMTP" "local incoming"
30897 Some user agents use SMTP to pass messages to their local MTA using the
30898 standard input and output, as opposed to passing the envelope on the command
30899 line and writing the message to the standard input. This is supported by the
30900 &%-bs%& option. This form of SMTP is handled in the same way as incoming
30901 messages over TCP/IP (including the use of ACLs), except that the envelope
30902 sender given in a MAIL command is ignored unless the caller is trusted. In
30903 an ACL you can detect this form of SMTP input by testing for an empty host
30904 identification. It is common to have this as the first line in the ACL that
30905 runs for RCPT commands:
30906 .code
30907 accept hosts = :
30908 .endd
30909 This accepts SMTP messages from local processes without doing any other tests.
30910
30911
30912
30913 .section "Outgoing batched SMTP" "SECTbatchSMTP"
30914 .cindex "SMTP" "batched outgoing"
30915 .cindex "batched SMTP output"
30916 Both the &(appendfile)& and &(pipe)& transports can be used for handling
30917 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
30918 be output in BSMTP format. No SMTP responses are possible for this form of
30919 delivery. All it is doing is using SMTP commands as a way of transmitting the
30920 envelope along with the message.
30921
30922 The message is written to the file or pipe preceded by the SMTP commands
30923 MAIL and RCPT, and followed by a line containing a single dot. Lines in
30924 the message that start with a dot have an extra dot added. The SMTP command
30925 HELO is not normally used. If it is required, the &%message_prefix%& option
30926 can be used to specify it.
30927
30928 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
30929 one recipient address at a time by default. However, you can arrange for them
30930 to handle several addresses at once by setting the &%batch_max%& option. When
30931 this is done for BSMTP, messages may contain multiple RCPT commands. See
30932 chapter &<<CHAPbatching>>& for more details.
30933
30934 .vindex "&$host$&"
30935 When one or more addresses are routed to a BSMTP transport by a router that
30936 sets up a host list, the name of the first host on the list is available to the
30937 transport in the variable &$host$&. Here is an example of such a transport and
30938 router:
30939 .code
30940 begin routers
30941 route_append:
30942   driver = manualroute
30943   transport = smtp_appendfile
30944   route_list = domain.example  batch.host.example
30945
30946 begin transports
30947 smtp_appendfile:
30948   driver = appendfile
30949   directory = /var/bsmtp/$host
30950   batch_max = 1000
30951   use_bsmtp
30952   user = exim
30953 .endd
30954 This causes messages addressed to &'domain.example'& to be written in BSMTP
30955 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
30956 message (unless there are more than 1000 recipients).
30957
30958
30959
30960 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
30961 .cindex "SMTP" "batched incoming"
30962 .cindex "batched SMTP input"
30963 The &%-bS%& command line option causes Exim to accept one or more messages by
30964 reading SMTP on the standard input, but to generate no responses. If the caller
30965 is trusted, the senders in the MAIL commands are believed; otherwise the
30966 sender is always the caller of Exim. Unqualified senders and receivers are not
30967 rejected (there seems little point) but instead just get qualified. HELO
30968 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
30969 as NOOP; QUIT quits.
30970
30971 No policy checking is done for BSMTP input. That is, no ACL is run at anytime.
30972 In this respect it is like non-SMTP local input.
30973
30974 If an error is detected while reading a message, including a missing &"."& at
30975 the end, Exim gives up immediately. It writes details of the error to the
30976 standard output in a stylized way that the calling program should be able to
30977 make some use of automatically, for example:
30978 .code
30979 554 Unexpected end of file
30980 Transaction started in line 10
30981 Error detected in line 14
30982 .endd
30983 It writes a more verbose version, for human consumption, to the standard error
30984 file, for example:
30985 .code
30986 An error was detected while processing a file of BSMTP input.
30987 The error message was:
30988
30989 501 '>' missing at end of address
30990
30991 The SMTP transaction started in line 10.
30992 The error was detected in line 12.
30993 The SMTP command at fault was:
30994
30995 rcpt to:<malformed@in.com.plete
30996
30997 1 previous message was successfully processed.
30998 The rest of the batch was abandoned.
30999 .endd
31000 The return code from Exim is zero only if there were no errors. It is 1 if some
31001 messages were accepted before an error was detected, and 2 if no messages were
31002 accepted.
31003 .ecindex IIDsmtpproc1
31004 .ecindex IIDsmtpproc2
31005
31006
31007
31008 . ////////////////////////////////////////////////////////////////////////////
31009 . ////////////////////////////////////////////////////////////////////////////
31010
31011 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
31012          "Customizing messages"
31013 When a message fails to be delivered, or remains on the queue for more than a
31014 configured amount of time, Exim sends a message to the original sender, or
31015 to an alternative configured address. The text of these messages is built into
31016 the code of Exim, but it is possible to change it, either by adding a single
31017 string, or by replacing each of the paragraphs by text supplied in a file.
31018
31019 The &'From:'& and &'To:'& header lines are automatically generated; you can
31020 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
31021 option. Exim also adds the line
31022 .code
31023 Auto-Submitted: auto-generated
31024 .endd
31025 to all warning and bounce messages,
31026
31027
31028 .section "Customizing bounce messages" "SECID239"
31029 .cindex "customizing" "bounce message"
31030 .cindex "bounce message" "customizing"
31031 If &%bounce_message_text%& is set, its contents are included in the default
31032 message immediately after &"This message was created automatically by mail
31033 delivery software."& The string is not expanded. It is not used if
31034 &%bounce_message_file%& is set.
31035
31036 When &%bounce_message_file%& is set, it must point to a template file for
31037 constructing error messages. The file consists of a series of text items,
31038 separated by lines consisting of exactly four asterisks. If the file cannot be
31039 opened, default text is used and a message is written to the main and panic
31040 logs. If any text item in the file is empty, default text is used for that
31041 item.
31042
31043 .vindex "&$bounce_recipient$&"
31044 .vindex "&$bounce_return_size_limit$&"
31045 Each item of text that is read from the file is expanded, and there are two
31046 expansion variables which can be of use here: &$bounce_recipient$& is set to
31047 the recipient of an error message while it is being created, and
31048 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
31049 option, rounded to a whole number.
31050
31051 The items must appear in the file in the following order:
31052
31053 .ilist
31054 The first item is included in the headers, and should include at least a
31055 &'Subject:'& header. Exim does not check the syntax of these headers.
31056 .next
31057 The second item forms the start of the error message. After it, Exim lists the
31058 failing addresses with their error messages.
31059 .next
31060 The third item is used to introduce any text from pipe transports that is to be
31061 returned to the sender. It is omitted if there is no such text.
31062 .next
31063 The fourth item is used to introduce the copy of the message that is returned
31064 as part of the error report.
31065 .next
31066 The fifth item is added after the fourth one if the returned message is
31067 truncated because it is bigger than &%return_size_limit%&.
31068 .next
31069 The sixth item is added after the copy of the original message.
31070 .endlist
31071
31072 The default state (&%bounce_message_file%& unset) is equivalent to the
31073 following file, in which the sixth item is empty. The &'Subject:'& and some
31074 other lines have been split in order to fit them on the page:
31075 .code
31076 Subject: Mail delivery failed
31077   ${if eq{$sender_address}{$bounce_recipient}
31078   {: returning message to sender}}
31079 ****
31080 This message was created automatically by mail delivery software.
31081
31082 A message ${if eq{$sender_address}{$bounce_recipient}
31083   {that you sent }{sent by
31084
31085 <$sender_address>
31086
31087 }}could not be delivered to all of its recipients.
31088 This is a permanent error. The following address(es) failed:
31089 ****
31090 The following text was generated during the delivery attempt(s):
31091 ****
31092 ------ This is a copy of the message, including all the headers.
31093   ------
31094 ****
31095 ------ The body of the message is $message_size characters long;
31096   only the first
31097 ------ $bounce_return_size_limit or so are included here.
31098 ****
31099 .endd
31100 .section "Customizing warning messages" "SECTcustwarn"
31101 .cindex "customizing" "warning message"
31102 .cindex "warning of delay" "customizing the message"
31103 The option &%warn_message_file%& can be pointed at a template file for use when
31104 warnings about message delays are created. In this case there are only three
31105 text sections:
31106
31107 .ilist
31108 The first item is included in the headers, and should include at least a
31109 &'Subject:'& header. Exim does not check the syntax of these headers.
31110 .next
31111 The second item forms the start of the warning message. After it, Exim lists
31112 the delayed addresses.
31113 .next
31114 The third item then ends the message.
31115 .endlist
31116
31117 The default state is equivalent to the following file, except that some lines
31118 have been split here, in order to fit them on the page:
31119 .code
31120 Subject: Warning: message $message_exim_id delayed
31121   $warn_message_delay
31122 ****
31123 This message was created automatically by mail delivery software.
31124
31125 A message ${if eq{$sender_address}{$warn_message_recipients}
31126 {that you sent }{sent by
31127
31128 <$sender_address>
31129
31130 }}has not been delivered to all of its recipients after
31131 more than $warn_message_delay on the queue on $primary_hostname.
31132
31133 The message identifier is:     $message_exim_id
31134 The subject of the message is: $h_subject
31135 The date of the message is:    $h_date
31136
31137 The following address(es) have not yet been delivered:
31138 ****
31139 No action is required on your part. Delivery attempts will
31140 continue for some time, and this warning may be repeated at
31141 intervals if the message remains undelivered. Eventually the
31142 mail delivery software will give up, and when that happens,
31143 the message will be returned to you.
31144 .endd
31145 .vindex "&$warn_message_delay$&"
31146 .vindex "&$warn_message_recipients$&"
31147 However, in the default state the subject and date lines are omitted if no
31148 appropriate headers exist. During the expansion of this file,
31149 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
31150 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
31151 of recipients for the warning message. There may be more than one if there are
31152 multiple addresses with different &%errors_to%& settings on the routers that
31153 handled them.
31154
31155
31156
31157
31158 . ////////////////////////////////////////////////////////////////////////////
31159 . ////////////////////////////////////////////////////////////////////////////
31160
31161 .chapter "Some common configuration settings" "CHAPcomconreq"
31162 This chapter discusses some configuration settings that seem to be fairly
31163 common. More examples and discussion can be found in the Exim book.
31164
31165
31166
31167 .section "Sending mail to a smart host" "SECID240"
31168 .cindex "smart host" "example router"
31169 If you want to send all mail for non-local domains to a &"smart host"&, you
31170 should replace the default &(dnslookup)& router with a router which does the
31171 routing explicitly:
31172 .code
31173 send_to_smart_host:
31174   driver = manualroute
31175   route_list = !+local_domains smart.host.name
31176   transport = remote_smtp
31177 .endd
31178 You can use the smart host's IP address instead of the name if you wish.
31179 If you are using Exim only to submit messages to a smart host, and not for
31180 receiving incoming messages, you can arrange for it to do the submission
31181 synchronously by setting the &%mua_wrapper%& option (see chapter
31182 &<<CHAPnonqueueing>>&).
31183
31184
31185
31186
31187 .section "Using Exim to handle mailing lists" "SECTmailinglists"
31188 .cindex "mailing lists"
31189 Exim can be used to run simple mailing lists, but for large and/or complicated
31190 requirements, the use of additional specialized mailing list software such as
31191 Majordomo or Mailman is recommended.
31192
31193 The &(redirect)& router can be used to handle mailing lists where each list
31194 is maintained in a separate file, which can therefore be managed by an
31195 independent manager. The &%domains%& router option can be used to run these
31196 lists in a separate domain from normal mail. For example:
31197 .code
31198 lists:
31199   driver = redirect
31200   domains = lists.example
31201   file = /usr/lists/$local_part
31202   forbid_pipe
31203   forbid_file
31204   errors_to = $local_part-request@lists.example
31205   no_more
31206 .endd
31207 This router is skipped for domains other than &'lists.example'&. For addresses
31208 in that domain, it looks for a file that matches the local part. If there is no
31209 such file, the router declines, but because &%no_more%& is set, no subsequent
31210 routers are tried, and so the whole delivery fails.
31211
31212 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
31213 expanded into a file name or a pipe delivery, which is usually inappropriate in
31214 a mailing list.
31215
31216 .oindex "&%errors_to%&"
31217 The &%errors_to%& option specifies that any delivery errors caused by addresses
31218 taken from a mailing list are to be sent to the given address rather than the
31219 original sender of the message. However, before acting on this, Exim verifies
31220 the error address, and ignores it if verification fails.
31221
31222 For example, using the configuration above, mail sent to
31223 &'dicts@lists.example'& is passed on to those addresses contained in
31224 &_/usr/lists/dicts_&, with error reports directed to
31225 &'dicts-request@lists.example'&, provided that this address can be verified.
31226 There could be a file called &_/usr/lists/dicts-request_& containing
31227 the address(es) of this particular list's manager(s), but other approaches,
31228 such as setting up an earlier router (possibly using the &%local_part_prefix%&
31229 or &%local_part_suffix%& options) to handle addresses of the form
31230 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
31231
31232
31233
31234 .section "Syntax errors in mailing lists" "SECID241"
31235 .cindex "mailing lists" "syntax errors in"
31236 If an entry in redirection data contains a syntax error, Exim normally defers
31237 delivery of the original address. That means that a syntax error in a mailing
31238 list holds up all deliveries to the list. This may not be appropriate when a
31239 list is being maintained automatically from data supplied by users, and the
31240 addresses are not rigorously checked.
31241
31242 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
31243 entries that fail to parse, noting the incident in the log. If in addition
31244 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
31245 whenever a broken address is skipped. It is usually appropriate to set
31246 &%syntax_errors_to%& to the same address as &%errors_to%&.
31247
31248
31249
31250 .section "Re-expansion of mailing lists" "SECID242"
31251 .cindex "mailing lists" "re-expansion of"
31252 Exim remembers every individual address to which a message has been delivered,
31253 in order to avoid duplication, but it normally stores only the original
31254 recipient addresses with a message. If all the deliveries to a mailing list
31255 cannot be done at the first attempt, the mailing list is re-expanded when the
31256 delivery is next tried. This means that alterations to the list are taken into
31257 account at each delivery attempt, so addresses that have been added to
31258 the list since the message arrived will therefore receive a copy of the
31259 message, even though it pre-dates their subscription.
31260
31261 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
31262 on the &(redirect)& router. If this is done, any addresses generated by the
31263 router that fail to deliver at the first attempt are added to the message as
31264 &"top level"& addresses, and the parent address that generated them is marked
31265 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
31266 subsequent delivery attempts. The disadvantage of this is that if any of the
31267 failing addresses are incorrect, correcting them in the file has no effect on
31268 pre-existing messages.
31269
31270 The original top-level address is remembered with each of the generated
31271 addresses, and is output in any log messages. However, any intermediate parent
31272 addresses are not recorded. This makes a difference to the log only if the
31273 &%all_parents%& selector is set, but for mailing lists there is normally only
31274 one level of expansion anyway.
31275
31276
31277
31278 .section "Closed mailing lists" "SECID243"
31279 .cindex "mailing lists" "closed"
31280 The examples so far have assumed open mailing lists, to which anybody may
31281 send mail. It is also possible to set up closed lists, where mail is accepted
31282 from specified senders only. This is done by making use of the generic
31283 &%senders%& option to restrict the router that handles the list.
31284
31285 The following example uses the same file as a list of recipients and as a list
31286 of permitted senders. It requires three routers:
31287 .code
31288 lists_request:
31289   driver = redirect
31290   domains = lists.example
31291   local_part_suffix = -request
31292   file = /usr/lists/$local_part$local_part_suffix
31293   no_more
31294
31295 lists_post:
31296   driver = redirect
31297   domains = lists.example
31298   senders = ${if exists {/usr/lists/$local_part}\
31299              {lsearch;/usr/lists/$local_part}{*}}
31300   file = /usr/lists/$local_part
31301   forbid_pipe
31302   forbid_file
31303   errors_to = $local_part-request@lists.example
31304   no_more
31305
31306 lists_closed:
31307   driver = redirect
31308   domains = lists.example
31309   allow_fail
31310   data = :fail: $local_part@lists.example is a closed mailing list
31311 .endd
31312 All three routers have the same &%domains%& setting, so for any other domains,
31313 they are all skipped. The first router runs only if the local part ends in
31314 &%-request%&. It handles messages to the list manager(s) by means of an open
31315 mailing list.
31316
31317 The second router runs only if the &%senders%& precondition is satisfied. It
31318 checks for the existence of a list that corresponds to the local part, and then
31319 checks that the sender is on the list by means of a linear search. It is
31320 necessary to check for the existence of the file before trying to search it,
31321 because otherwise Exim thinks there is a configuration error. If the file does
31322 not exist, the expansion of &%senders%& is *, which matches all senders. This
31323 means that the router runs, but because there is no list, declines, and
31324 &%no_more%& ensures that no further routers are run. The address fails with an
31325 &"unrouteable address"& error.
31326
31327 The third router runs only if the second router is skipped, which happens when
31328 a mailing list exists, but the sender is not on it. This router forcibly fails
31329 the address, giving a suitable error message.
31330
31331
31332
31333
31334 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
31335 .cindex "VERP"
31336 .cindex "Variable Envelope Return Paths"
31337 .cindex "envelope sender"
31338 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
31339 are a way of helping mailing list administrators discover which subscription
31340 address is the cause of a particular delivery failure. The idea is to encode
31341 the original recipient address in the outgoing envelope sender address, so that
31342 if the message is forwarded by another host and then subsequently bounces, the
31343 original recipient can be extracted from the recipient address of the bounce.
31344
31345 .oindex &%errors_to%&
31346 .oindex &%return_path%&
31347 Envelope sender addresses can be modified by Exim using two different
31348 facilities: the &%errors_to%& option on a router (as shown in previous mailing
31349 list examples), or the &%return_path%& option on a transport. The second of
31350 these is effective only if the message is successfully delivered to another
31351 host; it is not used for errors detected on the local host (see the description
31352 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
31353 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
31354 .code
31355 verp_smtp:
31356   driver = smtp
31357   max_rcpt = 1
31358   return_path = \
31359     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
31360       {$1-request+$local_part=$domain@your.dom.example}fail}
31361 .endd
31362 This has the effect of rewriting the return path (envelope sender) on outgoing
31363 SMTP messages, if the local part of the original return path ends in
31364 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
31365 local part and domain of the recipient into the return path. Suppose, for
31366 example, that a message whose return path has been set to
31367 &'somelist-request@your.dom.example'& is sent to
31368 &'subscriber@other.dom.example'&. In the transport, the return path is
31369 rewritten as
31370 .code
31371 somelist-request+subscriber=other.dom.example@your.dom.example
31372 .endd
31373 .vindex "&$local_part$&"
31374 For this to work, you must tell Exim to send multiple copies of messages that
31375 have more than one recipient, so that each copy has just one recipient. This is
31376 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
31377 might be sent to several different recipients in the same domain, in which case
31378 &$local_part$& is not available in the transport, because it is not unique.
31379
31380 Unless your host is doing nothing but mailing list deliveries, you should
31381 probably use a separate transport for the VERP deliveries, so as not to use
31382 extra resources in making one-per-recipient copies for other deliveries. This
31383 can easily be done by expanding the &%transport%& option in the router:
31384 .code
31385 dnslookup:
31386   driver = dnslookup
31387   domains = ! +local_domains
31388   transport = \
31389     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
31390       {verp_smtp}{remote_smtp}}
31391   no_more
31392 .endd
31393 If you want to change the return path using &%errors_to%& in a router instead
31394 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
31395 routers that handle mailing list addresses. This will ensure that all delivery
31396 errors, including those detected on the local host, are sent to the VERP
31397 address.
31398
31399 On a host that does no local deliveries and has no manual routing, only the
31400 &(dnslookup)& router needs to be changed. A special transport is not needed for
31401 SMTP deliveries. Every mailing list recipient has its own return path value,
31402 and so Exim must hand them to the transport one at a time. Here is an example
31403 of a &(dnslookup)& router that implements VERP:
31404 .code
31405 verp_dnslookup:
31406   driver = dnslookup
31407   domains = ! +local_domains
31408   transport = remote_smtp
31409   errors_to = \
31410     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
31411      {$1-request+$local_part=$domain@your.dom.example}fail}
31412   no_more
31413 .endd
31414 Before you start sending out messages with VERPed return paths, you must also
31415 configure Exim to accept the bounce messages that come back to those paths.
31416 Typically this is done by setting a &%local_part_suffix%& option for a
31417 router, and using this to route the messages to wherever you want to handle
31418 them.
31419
31420 The overhead incurred in using VERP depends very much on the size of the
31421 message, the number of recipient addresses that resolve to the same remote
31422 host, and the speed of the connection over which the message is being sent. If
31423 a lot of addresses resolve to the same host and the connection is slow, sending
31424 a separate copy of the message for each address may take substantially longer
31425 than sending a single copy with many recipients (for which VERP cannot be
31426 used).
31427
31428
31429
31430
31431
31432
31433 .section "Virtual domains" "SECTvirtualdomains"
31434 .cindex "virtual domains"
31435 .cindex "domain" "virtual"
31436 The phrase &'virtual domain'& is unfortunately used with two rather different
31437 meanings:
31438
31439 .ilist
31440 A domain for which there are no real mailboxes; all valid local parts are
31441 aliases for other email addresses. Common examples are organizational
31442 top-level domains and &"vanity"& domains.
31443 .next
31444 One of a number of independent domains that are all handled by the same host,
31445 with mailboxes on that host, but where the mailbox owners do not necessarily
31446 have login accounts on that host.
31447 .endlist
31448
31449 The first usage is probably more common, and does seem more &"virtual"& than
31450 the second. This kind of domain can be handled in Exim with a straightforward
31451 aliasing router. One approach is to create a separate alias file for each
31452 virtual domain. Exim can test for the existence of the alias file to determine
31453 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
31454 to a router of this form:
31455 .code
31456 virtual:
31457   driver = redirect
31458   domains = dsearch;/etc/mail/virtual
31459   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
31460   no_more
31461 .endd
31462 The &%domains%& option specifies that the router is to be skipped, unless there
31463 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
31464 domain that is being processed. When the router runs, it looks up the local
31465 part in the file to find a new address (or list of addresses). The &%no_more%&
31466 setting ensures that if the lookup fails (leading to &%data%& being an empty
31467 string), Exim gives up on the address without trying any subsequent routers.
31468
31469 This one router can handle all the virtual domains because the alias file names
31470 follow a fixed pattern. Permissions can be arranged so that appropriate people
31471 can edit the different alias files. A successful aliasing operation results in
31472 a new envelope recipient address, which is then routed from scratch.
31473
31474 The other kind of &"virtual"& domain can also be handled in a straightforward
31475 way. One approach is to create a file for each domain containing a list of
31476 valid local parts, and use it in a router like this:
31477 .code
31478 my_domains:
31479   driver = accept
31480   domains = dsearch;/etc/mail/domains
31481   local_parts = lsearch;/etc/mail/domains/$domain
31482   transport = my_mailboxes
31483 .endd
31484 The address is accepted if there is a file for the domain, and the local part
31485 can be found in the file. The &%domains%& option is used to check for the
31486 file's existence because &%domains%& is tested before the &%local_parts%&
31487 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
31488 because that option is tested after &%local_parts%&. The transport is as
31489 follows:
31490 .code
31491 my_mailboxes:
31492   driver = appendfile
31493   file = /var/mail/$domain/$local_part
31494   user = mail
31495 .endd
31496 This uses a directory of mailboxes for each domain. The &%user%& setting is
31497 required, to specify which uid is to be used for writing to the mailboxes.
31498
31499 The configuration shown here is just one example of how you might support this
31500 requirement. There are many other ways this kind of configuration can be set
31501 up, for example, by using a database instead of separate files to hold all the
31502 information about the domains.
31503
31504
31505
31506 .section "Multiple user mailboxes" "SECTmulbox"
31507 .cindex "multiple mailboxes"
31508 .cindex "mailbox" "multiple"
31509 .cindex "local part" "prefix"
31510 .cindex "local part" "suffix"
31511 Heavy email users often want to operate with multiple mailboxes, into which
31512 incoming mail is automatically sorted. A popular way of handling this is to
31513 allow users to use multiple sender addresses, so that replies can easily be
31514 identified. Users are permitted to add prefixes or suffixes to their local
31515 parts for this purpose. The wildcard facility of the generic router options
31516 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
31517 example, consider this router:
31518 .code
31519 userforward:
31520   driver = redirect
31521   check_local_user
31522   file = $home/.forward
31523   local_part_suffix = -*
31524   local_part_suffix_optional
31525   allow_filter
31526 .endd
31527 .vindex "&$local_part_suffix$&"
31528 It runs a user's &_.forward_& file for all local parts of the form
31529 &'username-*'&. Within the filter file the user can distinguish different
31530 cases by testing the variable &$local_part_suffix$&. For example:
31531 .code
31532 if $local_part_suffix contains -special then
31533 save /home/$local_part/Mail/special
31534 endif
31535 .endd
31536 If the filter file does not exist, or does not deal with such addresses, they
31537 fall through to subsequent routers, and, assuming no subsequent use of the
31538 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
31539 control over which suffixes are valid.
31540
31541 Alternatively, a suffix can be used to trigger the use of a different
31542 &_.forward_& file &-- which is the way a similar facility is implemented in
31543 another MTA:
31544 .code
31545 userforward:
31546   driver = redirect
31547   check_local_user
31548   file = $home/.forward$local_part_suffix
31549   local_part_suffix = -*
31550   local_part_suffix_optional
31551   allow_filter
31552 .endd
31553 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
31554 example, &_.forward-special_& is used. Once again, if the appropriate file
31555 does not exist, or does not deal with the address, it is passed on to
31556 subsequent routers, which could, if required, look for an unqualified
31557 &_.forward_& file to use as a default.
31558
31559
31560
31561 .section "Simplified vacation processing" "SECID244"
31562 .cindex "vacation processing"
31563 The traditional way of running the &'vacation'& program is for a user to set up
31564 a pipe command in a &_.forward_& file
31565 (see section &<<SECTspecitredli>>& for syntax details).
31566 This is prone to error by inexperienced users. There are two features of Exim
31567 that can be used to make this process simpler for users:
31568
31569 .ilist
31570 A local part prefix such as &"vacation-"& can be specified on a router which
31571 can cause the message to be delivered directly to the &'vacation'& program, or
31572 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
31573 &_.forward_& file are then much simpler. For example:
31574 .code
31575 spqr, vacation-spqr
31576 .endd
31577 .next
31578 The &%require_files%& generic router option can be used to trigger a
31579 vacation delivery by checking for the existence of a certain file in the
31580 user's home directory. The &%unseen%& generic option should also be used, to
31581 ensure that the original delivery also proceeds. In this case, all the user has
31582 to do is to create a file called, say, &_.vacation_&, containing a vacation
31583 message.
31584 .endlist
31585
31586 Another advantage of both these methods is that they both work even when the
31587 use of arbitrary pipes by users is locked out.
31588
31589
31590
31591 .section "Taking copies of mail" "SECID245"
31592 .cindex "message" "copying every"
31593 Some installations have policies that require archive copies of all messages to
31594 be made. A single copy of each message can easily be taken by an appropriate
31595 command in a system filter, which could, for example, use a different file for
31596 each day's messages.
31597
31598 There is also a shadow transport mechanism that can be used to take copies of
31599 messages that are successfully delivered by local transports, one copy per
31600 delivery. This could be used, &'inter alia'&, to implement automatic
31601 notification of delivery by sites that insist on doing such things.
31602
31603
31604
31605 .section "Intermittently connected hosts" "SECID246"
31606 .cindex "intermittently connected hosts"
31607 It has become quite common (because it is cheaper) for hosts to connect to the
31608 Internet periodically rather than remain connected all the time. The normal
31609 arrangement is that mail for such hosts accumulates on a system that is
31610 permanently connected.
31611
31612 Exim was designed for use on permanently connected hosts, and so it is not
31613 particularly well-suited to use in an intermittently connected environment.
31614 Nevertheless there are some features that can be used.
31615
31616
31617 .section "Exim on the upstream server host" "SECID247"
31618 It is tempting to arrange for incoming mail for the intermittently connected
31619 host to remain on Exim's queue until the client connects. However, this
31620 approach does not scale very well. Two different kinds of waiting message are
31621 being mixed up in the same queue &-- those that cannot be delivered because of
31622 some temporary problem, and those that are waiting for their destination host
31623 to connect. This makes it hard to manage the queue, as well as wasting
31624 resources, because each queue runner scans the entire queue.
31625
31626 A better approach is to separate off those messages that are waiting for an
31627 intermittently connected host. This can be done by delivering these messages
31628 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
31629 format, from where they are transmitted by other software when their
31630 destination connects. This makes it easy to collect all the mail for one host
31631 in a single directory, and to apply local timeout rules on a per-message basis
31632 if required.
31633
31634 On a very small scale, leaving the mail on Exim's queue can be made to work. If
31635 you are doing this, you should configure Exim with a long retry period for the
31636 intermittent host. For example:
31637 .code
31638 cheshire.wonderland.fict.example    *   F,5d,24h
31639 .endd
31640 This stops a lot of failed delivery attempts from occurring, but Exim remembers
31641 which messages it has queued up for that host. Once the intermittent host comes
31642 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
31643 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
31644 causes all the queued up messages to be delivered, often down a single SMTP
31645 connection. While the host remains connected, any new messages get delivered
31646 immediately.
31647
31648 If the connecting hosts do not have fixed IP addresses, that is, if a host is
31649 issued with a different IP address each time it connects, Exim's retry
31650 mechanisms on the holding host get confused, because the IP address is normally
31651 used as part of the key string for holding retry information. This can be
31652 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
31653 Since this has disadvantages for permanently connected hosts, it is best to
31654 arrange a separate transport for the intermittently connected ones.
31655
31656
31657
31658 .section "Exim on the intermittently connected client host" "SECID248"
31659 The value of &%smtp_accept_queue_per_connection%& should probably be
31660 increased, or even set to zero (that is, disabled) on the intermittently
31661 connected host, so that all incoming messages down a single connection get
31662 delivered immediately.
31663
31664 .cindex "SMTP" "passed connection"
31665 .cindex "SMTP" "multiple deliveries"
31666 .cindex "multiple SMTP deliveries"
31667 Mail waiting to be sent from an intermittently connected host will probably
31668 not have been routed, because without a connection DNS lookups are not
31669 possible. This means that if a normal queue run is done at connection time,
31670 each message is likely to be sent in a separate SMTP session. This can be
31671 avoided by starting the queue run with a command line option beginning with
31672 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
31673 first pass, routing is done but no deliveries take place. The second pass is a
31674 normal queue run; since all the messages have been previously routed, those
31675 destined for the same host are likely to get sent as multiple deliveries in a
31676 single SMTP connection.
31677
31678
31679
31680 . ////////////////////////////////////////////////////////////////////////////
31681 . ////////////////////////////////////////////////////////////////////////////
31682
31683 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
31684          "Exim as a non-queueing client"
31685 .cindex "client, non-queueing"
31686 .cindex "smart host" "suppressing queueing"
31687 On a personal computer, it is a common requirement for all
31688 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
31689 configured to operate that way, for all the popular operating systems.
31690 However, there are some MUAs for Unix-like systems that cannot be so
31691 configured: they submit messages using the command line interface of
31692 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
31693 messages this way.
31694
31695 If the personal computer runs continuously, there is no problem, because it can
31696 run a conventional MTA that handles delivery to the smart host, and deal with
31697 any delays via its queueing mechanism. However, if the computer does not run
31698 continuously or runs different operating systems at different times, queueing
31699 email is not desirable.
31700
31701 There is therefore a requirement for something that can provide the
31702 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
31703 any queueing or retrying facilities. Furthermore, the delivery to the smart
31704 host should be synchronous, so that if it fails, the sending MUA is immediately
31705 informed. In other words, we want something that extends an MUA that submits
31706 to a local MTA via the command line so that it behaves like one that submits
31707 to a remote smart host using TCP/SMTP.
31708
31709 There are a number of applications (for example, there is one called &'ssmtp'&)
31710 that do this job. However, people have found them to be lacking in various
31711 ways. For instance, you might want to allow aliasing and forwarding to be done
31712 before sending a message to the smart host.
31713
31714 Exim already had the necessary infrastructure for doing this job. Just a few
31715 tweaks were needed to make it behave as required, though it is somewhat of an
31716 overkill to use a fully-featured MTA for this purpose.
31717
31718 .oindex "&%mua_wrapper%&"
31719 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
31720 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
31721 assumes that it is being used to &"wrap"& a command-line MUA in the manner
31722 just described. As well as setting &%mua_wrapper%&, you also need to provide a
31723 compatible router and transport configuration. Typically there will be just one
31724 router and one transport, sending everything to a smart host.
31725
31726 When run in MUA wrapping mode, the behaviour of Exim changes in the
31727 following ways:
31728
31729 .ilist
31730 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
31731 In other words, the only way to submit messages is via the command line.
31732 .next
31733 Each message is synchronously delivered as soon as it is received (&%-odi%& is
31734 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
31735 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
31736 does not finish until the delivery attempt is complete. If the delivery is
31737 successful, a zero return code is given.
31738 .next
31739 Address redirection is permitted, but the final routing for all addresses must
31740 be to the same remote transport, and to the same list of hosts. Furthermore,
31741 the return address (envelope sender) must be the same for all recipients, as
31742 must any added or deleted header lines. In other words, it must be possible to
31743 deliver the message in a single SMTP transaction, however many recipients there
31744 are.
31745 .next
31746 If these conditions are not met, or if routing any address results in a
31747 failure or defer status, or if Exim is unable to deliver all the recipients
31748 successfully to one of the smart hosts, delivery of the entire message fails.
31749 .next
31750 Because no queueing is allowed, all failures are treated as permanent; there
31751 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
31752 smart host. Furthermore, because only a single yes/no response can be given to
31753 the caller, it is not possible to deliver to some recipients and not others. If
31754 there is an error (temporary or permanent) for any recipient, all are failed.
31755 .next
31756 If more than one smart host is listed, Exim will try another host after a
31757 connection failure or a timeout, in the normal way. However, if this kind of
31758 failure happens for all the hosts, the delivery fails.
31759 .next
31760 When delivery fails, an error message is written to the standard error stream
31761 (as well as to Exim's log), and Exim exits to the caller with a return code
31762 value 1. The message is expunged from Exim's spool files. No bounce messages
31763 are ever generated.
31764 .next
31765 No retry data is maintained, and any retry rules are ignored.
31766 .next
31767 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
31768 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
31769 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
31770 .endlist
31771
31772 The overall effect is that Exim makes a single synchronous attempt to deliver
31773 the message, failing if there is any kind of problem. Because no local
31774 deliveries are done and no daemon can be run, Exim does not need root
31775 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
31776 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
31777 the advantages and disadvantages of running without root privilege.
31778
31779
31780
31781
31782 . ////////////////////////////////////////////////////////////////////////////
31783 . ////////////////////////////////////////////////////////////////////////////
31784
31785 .chapter "Log files" "CHAPlog"
31786 .scindex IIDloggen "log" "general description"
31787 .cindex "log" "types of"
31788 Exim writes three different logs, referred to as the main log, the reject log,
31789 and the panic log:
31790
31791 .ilist
31792 .cindex "main log"
31793 The main log records the arrival of each message and each delivery in a single
31794 line in each case. The format is as compact as possible, in an attempt to keep
31795 down the size of log files. Two-character flag sequences make it easy to pick
31796 out these lines. A number of other events are recorded in the main log. Some of
31797 them are optional, in which case the &%log_selector%& option controls whether
31798 they are included or not. A Perl script called &'eximstats'&, which does simple
31799 analysis of main log files, is provided in the Exim distribution (see section
31800 &<<SECTmailstat>>&).
31801 .next
31802 .cindex "reject log"
31803 The reject log records information from messages that are rejected as a result
31804 of a configuration option (that is, for policy reasons).
31805 The first line of each rejection is a copy of the line that is also written to
31806 the main log. Then, if the message's header has been read at the time the log
31807 is written, its contents are written to this log. Only the original header
31808 lines are available; header lines added by ACLs are not logged. You can use the
31809 reject log to check that your policy controls are working correctly; on a busy
31810 host this may be easier than scanning the main log for rejection messages. You
31811 can suppress the writing of the reject log by setting &%write_rejectlog%&
31812 false.
31813 .next
31814 .cindex "panic log"
31815 .cindex "system log"
31816 When certain serious errors occur, Exim writes entries to its panic log. If the
31817 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
31818 are usually written to the main log as well, but can get lost amid the mass of
31819 other entries. The panic log should be empty under normal circumstances. It is
31820 therefore a good idea to check it (or to have a &'cron'& script check it)
31821 regularly, in order to become aware of any problems. When Exim cannot open its
31822 panic log, it tries as a last resort to write to the system log (syslog). This
31823 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
31824 message itself is written at priority LOG_CRIT.
31825 .endlist
31826
31827 Every log line starts with a timestamp, in the format shown in the following
31828 example. Note that many of the examples shown in this chapter are line-wrapped.
31829 In the log file, this would be all on one line:
31830 .code
31831 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
31832   by QUIT
31833 .endd
31834 By default, the timestamps are in the local timezone. There are two
31835 ways of changing this:
31836
31837 .ilist
31838 You can set the &%timezone%& option to a different time zone; in particular, if
31839 you set
31840 .code
31841 timezone = UTC
31842 .endd
31843 the timestamps will be in UTC (aka GMT).
31844 .next
31845 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
31846 example:
31847 .code
31848 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
31849 .endd
31850 .endlist
31851
31852 .cindex "log" "process ids in"
31853 .cindex "pid (process id)" "in log lines"
31854 Exim does not include its process id in log lines by default, but you can
31855 request that it does so by specifying the &`pid`& log selector (see section
31856 &<<SECTlogselector>>&). When this is set, the process id is output, in square
31857 brackets, immediately after the time and date.
31858
31859
31860
31861
31862 .section "Where the logs are written" "SECTwhelogwri"
31863 .cindex "log" "destination"
31864 .cindex "log" "to file"
31865 .cindex "log" "to syslog"
31866 .cindex "syslog"
31867 The logs may be written to local files, or to syslog, or both. However, it
31868 should be noted that many syslog implementations use UDP as a transport, and
31869 are therefore unreliable in the sense that messages are not guaranteed to
31870 arrive at the loghost, nor is the ordering of messages necessarily maintained.
31871 It has also been reported that on large log files (tens of megabytes) you may
31872 need to tweak syslog to prevent it syncing the file with each write &-- on
31873 Linux this has been seen to make syslog take 90% plus of CPU time.
31874
31875 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
31876 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
31877 configuration. This latter string is expanded, so it can contain, for example,
31878 references to the host name:
31879 .code
31880 log_file_path = /var/log/$primary_hostname/exim_%slog
31881 .endd
31882 It is generally advisable, however, to set the string in &_Local/Makefile_&
31883 rather than at run time, because then the setting is available right from the
31884 start of Exim's execution. Otherwise, if there's something it wants to log
31885 before it has read the configuration file (for example, an error in the
31886 configuration file) it will not use the path you want, and may not be able to
31887 log at all.
31888
31889 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
31890 list, currently limited to at most two items. This is one option where the
31891 facility for changing a list separator may not be used. The list must always be
31892 colon-separated. If an item in the list is &"syslog"& then syslog is used;
31893 otherwise the item must either be an absolute path, containing &`%s`& at the
31894 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
31895 implying the use of a default path.
31896
31897 When Exim encounters an empty item in the list, it searches the list defined by
31898 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
31899 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
31900 mean &"use the path specified at build time"&. It no such item exists, log
31901 files are written in the &_log_& subdirectory of the spool directory. This is
31902 equivalent to the setting:
31903 .code
31904 log_file_path = $spool_directory/log/%slog
31905 .endd
31906 If you do not specify anything at build time or run time, that is where the
31907 logs are written.
31908
31909 A log file path may also contain &`%D`& if datestamped log file names are in
31910 use &-- see section &<<SECTdatlogfil>>& below.
31911
31912 Here are some examples of possible settings:
31913 .display
31914 &`LOG_FILE_PATH=syslog                    `& syslog only
31915 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
31916 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
31917 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
31918 .endd
31919 If there are more than two paths in the list, the first is used and a panic
31920 error is logged.
31921
31922
31923
31924 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
31925 .cindex "log" "cycling local files"
31926 .cindex "cycling logs"
31927 .cindex "&'exicyclog'&"
31928 .cindex "log" "local files; writing to"
31929 Some operating systems provide centralized and standardized methods for cycling
31930 log files. For those that do not, a utility script called &'exicyclog'& is
31931 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
31932 main and reject logs each time it is called. The maximum number of old logs to
31933 keep can be set. It is suggested this script is run as a daily &'cron'& job.
31934
31935 An Exim delivery process opens the main log when it first needs to write to it,
31936 and it keeps the file open in case subsequent entries are required &-- for
31937 example, if a number of different deliveries are being done for the same
31938 message. However, remote SMTP deliveries can take a long time, and this means
31939 that the file may be kept open long after it is renamed if &'exicyclog'& or
31940 something similar is being used to rename log files on a regular basis. To
31941 ensure that a switch of log files is noticed as soon as possible, Exim calls
31942 &[stat()]& on the main log's name before reusing an open file, and if the file
31943 does not exist, or its inode has changed, the old file is closed and Exim
31944 tries to open the main log from scratch. Thus, an old log file may remain open
31945 for quite some time, but no Exim processes should write to it once it has been
31946 renamed.
31947
31948
31949
31950 .section "Datestamped log files" "SECTdatlogfil"
31951 .cindex "log" "datestamped files"
31952 Instead of cycling the main and reject log files by renaming them
31953 periodically, some sites like to use files whose names contain a datestamp,
31954 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_&.
31955 Exim has support for this way of working. It is enabled by setting the
31956 &%log_file_path%& option to a path that includes &`%D`& at the point where the
31957 datestamp is required. For example:
31958 .code
31959 log_file_path = /var/spool/exim/log/%slog-%D
31960 log_file_path = /var/log/exim-%s-%D.log
31961 log_file_path = /var/spool/exim/log/%D-%slog
31962 .endd
31963 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
31964 examples of names generated by the above examples:
31965 .code
31966 /var/spool/exim/log/mainlog-20021225
31967 /var/log/exim-reject-20021225.log
31968 /var/spool/exim/log/20021225-mainlog
31969 .endd
31970 When this form of log file is specified, Exim automatically switches to new
31971 files at midnight. It does not make any attempt to compress old logs; you
31972 will need to write your own script if you require this. You should not
31973 run &'exicyclog'& with this form of logging.
31974
31975 The location of the panic log is also determined by &%log_file_path%&, but it
31976 is not datestamped, because rotation of the panic log does not make sense.
31977 When generating the name of the panic log, &`%D`& is removed from the string.
31978 In addition, if it immediately follows a slash, a following non-alphanumeric
31979 character is removed; otherwise a preceding non-alphanumeric character is
31980 removed. Thus, the three examples above would give these panic log names:
31981 .code
31982 /var/spool/exim/log/paniclog
31983 /var/log/exim-panic.log
31984 /var/spool/exim/log/paniclog
31985 .endd
31986
31987
31988 .section "Logging to syslog" "SECID249"
31989 .cindex "log" "syslog; writing to"
31990 The use of syslog does not change what Exim logs or the format of its messages,
31991 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
31992 Exim's log lines are omitted when these lines are sent to syslog. Apart from
31993 that, the same strings are written to syslog as to log files. The syslog
31994 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
31995 by default, but you can change these by setting the &%syslog_facility%& and
31996 &%syslog_processname%& options, respectively. If Exim was compiled with
31997 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
31998 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
31999 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
32000 the time and host name to each line.
32001 The three log streams are mapped onto syslog priorities as follows:
32002
32003 .ilist
32004 &'mainlog'& is mapped to LOG_INFO
32005 .next
32006 &'rejectlog'& is mapped to LOG_NOTICE
32007 .next
32008 &'paniclog'& is mapped to LOG_ALERT
32009 .endlist
32010
32011 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
32012 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
32013 these are routed by syslog to the same place. You can suppress this duplication
32014 by setting &%syslog_duplication%& false.
32015
32016 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
32017 entries contain multiple lines when headers are included. To cope with both
32018 these cases, entries written to syslog are split into separate &[syslog()]&
32019 calls at each internal newline, and also after a maximum of
32020 870 data characters. (This allows for a total syslog line length of 1024, when
32021 additions such as timestamps are added.) If you are running a syslog
32022 replacement that can handle lines longer than the 1024 characters allowed by
32023 RFC 3164, you should set
32024 .code
32025 SYSLOG_LONG_LINES=yes
32026 .endd
32027 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
32028 lines, but it still splits at internal newlines in &'reject'& log entries.
32029
32030 To make it easy to re-assemble split lines later, each component of a split
32031 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
32032 where <&'n'&> is the component number and <&'m'&> is the total number of
32033 components in the entry. The / delimiter is used when the line was split
32034 because it was too long; if it was split because of an internal newline, the \
32035 delimiter is used. For example, supposing the length limit to be 50 instead of
32036 870, the following would be the result of a typical rejection message to
32037 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
32038 name, and pid as added by syslog:
32039 .code
32040 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
32041 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
32042 [3/5]  when scanning for sender: missing or malformed lo
32043 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
32044 [5/5] mple>)
32045 .endd
32046 The same error might cause the following lines to be written to &"rejectlog"&
32047 (LOG_NOTICE):
32048 .code
32049 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
32050 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
32051 [3/18] er when scanning for sender: missing or malformed
32052 [4/18]  local part in "<>" (envelope sender is <ph10@cam
32053 [5\18] .example>)
32054 [6\18] Recipients: ph10@some.domain.cam.example
32055 [7\18] P Received: from [127.0.0.1] (ident=ph10)
32056 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
32057 [9\18]        id 16RdAL-0006pc-00
32058 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
32059 [11\18] 09:43 +0100
32060 [12\18] F From: <>
32061 [13\18]   Subject: this is a test header
32062 [18\18]   X-something: this is another header
32063 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
32064 [16\18] le>
32065 [17\18] B Bcc:
32066 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
32067 .endd
32068 Log lines that are neither too long nor contain newlines are written to syslog
32069 without modification.
32070
32071 If only syslog is being used, the Exim monitor is unable to provide a log tail
32072 display, unless syslog is routing &'mainlog'& to a file on the local host and
32073 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
32074 where it is.
32075
32076
32077
32078 .section "Log line flags" "SECID250"
32079 One line is written to the main log for each message received, and for each
32080 successful, unsuccessful, and delayed delivery. These lines can readily be
32081 picked out by the distinctive two-character flags that immediately follow the
32082 timestamp. The flags are:
32083 .display
32084 &`<=`&     message arrival
32085 &`=>`&     normal message delivery
32086 &`->`&     additional address in same delivery
32087 &`*>`&     delivery suppressed by &%-N%&
32088 &`**`&     delivery failed; address bounced
32089 &`==`&     delivery deferred; temporary problem
32090 .endd
32091
32092
32093 .section "Logging message reception" "SECID251"
32094 .cindex "log" "reception line"
32095 The format of the single-line entry in the main log that is written for every
32096 message received is shown in the basic example below, which is split over
32097 several lines in order to fit it on the page:
32098 .code
32099 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
32100   H=mailer.fict.example [192.168.123.123] U=exim
32101   P=smtp S=5678 id=<incoming message id>
32102 .endd
32103 The address immediately following &"<="& is the envelope sender address. A
32104 bounce message is shown with the sender address &"<>"&, and if it is locally
32105 generated, this is followed by an item of the form
32106 .code
32107 R=<message id>
32108 .endd
32109 which is a reference to the message that caused the bounce to be sent.
32110
32111 .cindex "HELO"
32112 .cindex "EHLO"
32113 For messages from other hosts, the H and U fields identify the remote host and
32114 record the RFC 1413 identity of the user that sent the message, if one was
32115 received. The number given in square brackets is the IP address of the sending
32116 host. If there is a single, unparenthesized  host name in the H field, as
32117 above, it has been verified to correspond to the IP address (see the
32118 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
32119 by the remote host in the SMTP HELO or EHLO command, and has not been
32120 verified. If verification yields a different name to that given for HELO or
32121 EHLO, the verified name appears first, followed by the HELO or EHLO
32122 name in parentheses.
32123
32124 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
32125 without brackets, in the HELO or EHLO command, leading to entries in
32126 the log containing text like these examples:
32127 .code
32128 H=(10.21.32.43) [192.168.8.34]
32129 H=([10.21.32.43]) [192.168.8.34]
32130 .endd
32131 This can be confusing. Only the final address in square brackets can be relied
32132 on.
32133
32134 For locally generated messages (that is, messages not received over TCP/IP),
32135 the H field is omitted, and the U field contains the login name of the caller
32136 of Exim.
32137
32138 .cindex "authentication" "logging"
32139 .cindex "AUTH" "logging"
32140 For all messages, the P field specifies the protocol used to receive the
32141 message. This is the value that is stored in &$received_protocol$&. In the case
32142 of incoming SMTP messages, the value indicates whether or not any SMTP
32143 extensions (ESMTP), encryption, or authentication were used. If the SMTP
32144 session was encrypted, there is an additional X field that records the cipher
32145 suite that was used.
32146
32147 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
32148 hosts that have authenticated themselves using the SMTP AUTH command. The first
32149 value is used when the SMTP connection was encrypted (&"secure"&). In this case
32150 there is an additional item A= followed by the name of the authenticator that
32151 was used. If an authenticated identification was set up by the authenticator's
32152 &%server_set_id%& option, this is logged too, separated by a colon from the
32153 authenticator name.
32154
32155 .cindex "size" "of message"
32156 The id field records the existing message id, if present. The size of the
32157 received message is given by the S field. When the message is delivered,
32158 headers may be removed or added, so that the size of delivered copies of the
32159 message may not correspond with this value (and indeed may be different to each
32160 other).
32161
32162 The &%log_selector%& option can be used to request the logging of additional
32163 data when a message is received. See section &<<SECTlogselector>>& below.
32164
32165
32166
32167 .section "Logging deliveries" "SECID252"
32168 .cindex "log" "delivery line"
32169 The format of the single-line entry in the main log that is written for every
32170 delivery is shown in one of the examples below, for local and remote
32171 deliveries, respectively. Each example has been split into two lines in order
32172 to fit it on the page:
32173 .code
32174 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
32175   <marv@hitch.fict.example> R=localuser T=local_delivery
32176 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
32177   monk@holistic.fict.example R=dnslookup T=remote_smtp
32178   H=holistic.fict.example [192.168.234.234]
32179 .endd
32180 For ordinary local deliveries, the original address is given in angle brackets
32181 after the final delivery address, which might be a pipe or a file. If
32182 intermediate address(es) exist between the original and the final address, the
32183 last of these is given in parentheses after the final address. The R and T
32184 fields record the router and transport that were used to process the address.
32185
32186 If a shadow transport was run after a successful local delivery, the log line
32187 for the successful delivery has an item added on the end, of the form
32188 .display
32189 &`ST=<`&&'shadow transport name'&&`>`&
32190 .endd
32191 If the shadow transport did not succeed, the error message is put in
32192 parentheses afterwards.
32193
32194 .cindex "asterisk" "after IP address"
32195 When more than one address is included in a single delivery (for example, two
32196 SMTP RCPT commands in one transaction) the second and subsequent addresses are
32197 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
32198 down a single SMTP connection, an asterisk follows the IP address in the log
32199 lines for the second and subsequent messages.
32200
32201 The generation of a reply message by a filter file gets logged as a
32202 &"delivery"& to the addressee, preceded by &">"&.
32203
32204 The &%log_selector%& option can be used to request the logging of additional
32205 data when a message is delivered. See section &<<SECTlogselector>>& below.
32206
32207
32208 .section "Discarded deliveries" "SECID253"
32209 .cindex "discarded messages"
32210 .cindex "message" "discarded"
32211 .cindex "delivery" "discarded; logging"
32212 When a message is discarded as a result of the command &"seen finish"& being
32213 obeyed in a filter file which generates no deliveries, a log entry of the form
32214 .code
32215 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
32216   <low.club@bridge.example> R=userforward
32217 .endd
32218 is written, to record why no deliveries are logged. When a message is discarded
32219 because it is aliased to &":blackhole:"& the log line is like this:
32220 .code
32221 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
32222   <hole@nowhere.example> R=blackhole_router
32223 .endd
32224
32225
32226 .section "Deferred deliveries" "SECID254"
32227 When a delivery is deferred, a line of the following form is logged:
32228 .code
32229 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
32230   R=dnslookup T=smtp defer (146): Connection refused
32231 .endd
32232 In the case of remote deliveries, the error is the one that was given for the
32233 last IP address that was tried. Details of individual SMTP failures are also
32234 written to the log, so the above line would be preceded by something like
32235 .code
32236 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
32237   mail1.endrest.example [192.168.239.239]: Connection refused
32238 .endd
32239 When a deferred address is skipped because its retry time has not been reached,
32240 a message is written to the log, but this can be suppressed by setting an
32241 appropriate value in &%log_selector%&.
32242
32243
32244
32245 .section "Delivery failures" "SECID255"
32246 .cindex "delivery" "failure; logging"
32247 If a delivery fails because an address cannot be routed, a line of the
32248 following form is logged:
32249 .code
32250 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
32251   <jim@trek99.example>: unknown mail domain
32252 .endd
32253 If a delivery fails at transport time, the router and transport are shown, and
32254 the response from the remote host is included, as in this example:
32255 .code
32256 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
32257   R=dnslookup T=remote_smtp: SMTP error from remote mailer
32258   after pipelined RCPT TO:<ace400@pb.example>: host
32259   pbmail3.py.example [192.168.63.111]: 553 5.3.0
32260   <ace400@pb.example>...Addressee unknown
32261 .endd
32262 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
32263 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
32264 disabling PIPELINING. The log lines for all forms of delivery failure are
32265 flagged with &`**`&.
32266
32267
32268
32269 .section "Fake deliveries" "SECID256"
32270 .cindex "delivery" "fake; logging"
32271 If a delivery does not actually take place because the &%-N%& option has been
32272 used to suppress it, a normal delivery line is written to the log, except that
32273 &"=>"& is replaced by &"*>"&.
32274
32275
32276
32277 .section "Completion" "SECID257"
32278 A line of the form
32279 .code
32280 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
32281 .endd
32282 is written to the main log when a message is about to be removed from the spool
32283 at the end of its processing.
32284
32285
32286
32287
32288 .section "Summary of Fields in Log Lines" "SECID258"
32289 .cindex "log" "summary of fields"
32290 A summary of the field identifiers that are used in log lines is shown in
32291 the following table:
32292 .display
32293 &`A   `&        authenticator name (and optional id)
32294 &`C   `&        SMTP confirmation on delivery
32295 &`    `&        command list for &"no mail in SMTP session"&
32296 &`CV  `&        certificate verification status
32297 &`D   `&        duration of &"no mail in SMTP session"&
32298 &`DN  `&        distinguished name from peer certificate
32299 &`DT  `&        on &`=>`& lines: time taken for a delivery
32300 &`F   `&        sender address (on delivery lines)
32301 &`H   `&        host name and IP address
32302 &`I   `&        local interface used
32303 &`id  `&        message id for incoming message
32304 &`P   `&        on &`<=`& lines: protocol used
32305 &`    `&        on &`=>`& and &`**`& lines: return path
32306 &`QT  `&        on &`=>`& lines: time spent on queue so far
32307 &`    `&        on &"Completed"& lines: time spent on queue
32308 &`R   `&        on &`<=`& lines: reference for local bounce
32309 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
32310 &`S   `&        size of message
32311 &`ST  `&        shadow transport name
32312 &`T   `&        on &`<=`& lines: message subject (topic)
32313 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
32314 &`U   `&        local user or RFC 1413 identity
32315 &`X   `&        TLS cipher suite
32316 .endd
32317
32318
32319 .section "Other log entries" "SECID259"
32320 Various other types of log entry are written from time to time. Most should be
32321 self-explanatory. Among the more common are:
32322
32323 .ilist
32324 .cindex "retry" "time not reached"
32325 &'retry time not reached'&&~&~An address previously suffered a temporary error
32326 during routing or local delivery, and the time to retry has not yet arrived.
32327 This message is not written to an individual message log file unless it happens
32328 during the first delivery attempt.
32329 .next
32330 &'retry time not reached for any host'&&~&~An address previously suffered
32331 temporary errors during remote delivery, and the retry time has not yet arrived
32332 for any of the hosts to which it is routed.
32333 .next
32334 .cindex "spool directory" "file locked"
32335 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
32336 some other Exim process is already working on the message. This can be quite
32337 common if queue running processes are started at frequent intervals. The
32338 &'exiwhat'& utility script can be used to find out what Exim processes are
32339 doing.
32340 .next
32341 .cindex "error" "ignored"
32342 &'error ignored'&&~&~There are several circumstances that give rise to this
32343 message:
32344 .olist
32345 Exim failed to deliver a bounce message whose age was greater than
32346 &%ignore_bounce_errors_after%&. The bounce was discarded.
32347 .next
32348 A filter file set up a delivery using the &"noerror"& option, and the delivery
32349 failed. The delivery was discarded.
32350 .next
32351 A delivery set up by a router configured with
32352 . ==== As this is a nested list, any displays it contains must be indented
32353 . ==== as otherwise they are too far to the left.
32354 .code
32355     errors_to = <>
32356 .endd
32357 failed. The delivery was discarded.
32358 .endlist olist
32359 .endlist ilist
32360
32361
32362
32363
32364
32365 .section "Reducing or increasing what is logged" "SECTlogselector"
32366 .cindex "log" "selectors"
32367 By setting the &%log_selector%& global option, you can disable some of Exim's
32368 default logging, or you can request additional logging. The value of
32369 &%log_selector%& is made up of names preceded by plus or minus characters. For
32370 example:
32371 .code
32372 log_selector = +arguments -retry_defer
32373 .endd
32374 The list of optional log items is in the following table, with the default
32375 selection marked by asterisks:
32376 .display
32377 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
32378 &` address_rewrite            `&  address rewriting
32379 &` all_parents                `&  all parents in => lines
32380 &` arguments                  `&  command line arguments
32381 &`*connection_reject          `&  connection rejections
32382 &`*delay_delivery             `&  immediate delivery delayed
32383 &` deliver_time               `&  time taken to perform delivery
32384 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
32385 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
32386 &`*etrn                       `&  ETRN commands
32387 &`*host_lookup_failed         `&  as it says
32388 &` ident_timeout              `&  timeout for ident connection
32389 &` incoming_interface         `&  incoming interface on <= lines
32390 &` incoming_port              `&  incoming port on <= lines
32391 &`*lost_incoming_connection   `&  as it says (includes timeouts)
32392 &` outgoing_port              `&  add remote port to => lines
32393 &`*queue_run                  `&  start and end queue runs
32394 &` queue_time                 `&  time on queue for one recipient
32395 &` queue_time_overall         `&  time on queue for whole message
32396 &` pid                        `&  Exim process id
32397 &` received_recipients        `&  recipients on <= lines
32398 &` received_sender            `&  sender on <= lines
32399 &`*rejected_header            `&  header contents on reject log
32400 &`*retry_defer                `&  &"retry time not reached"&
32401 &` return_path_on_delivery    `&  put return path on => and ** lines
32402 &` sender_on_delivery         `&  add sender to => lines
32403 &`*sender_verify_fail         `&  sender verification failures
32404 &`*size_reject                `&  rejection because too big
32405 &`*skip_delivery              `&  delivery skipped in a queue run
32406 &` smtp_confirmation          `&  SMTP confirmation on => lines
32407 &` smtp_connection            `&  SMTP connections
32408 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
32409 &` smtp_no_mail               `&  session with no MAIL commands
32410 &` smtp_protocol_error        `&  SMTP protocol errors
32411 &` smtp_syntax_error          `&  SMTP syntax errors
32412 &` subject                    `&  contents of &'Subject:'& on <= lines
32413 &` tls_certificate_verified   `&  certificate verification status
32414 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
32415 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
32416 &` unknown_in_list            `&  DNS lookup failed in list match
32417
32418 &` all                        `&  all of the above
32419 .endd
32420 More details on each of these items follows:
32421
32422 .ilist
32423 .cindex "&%warn%& ACL verb" "log when skipping"
32424 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
32425 its conditions cannot be evaluated, a log line to this effect is written if
32426 this log selector is set.
32427 .next
32428 .cindex "log" "rewriting"
32429 .cindex "rewriting" "logging"
32430 &%address_rewrite%&: This applies both to global rewrites and per-transport
32431 rewrites, but not to rewrites in filters run as an unprivileged user (because
32432 such users cannot access the log).
32433 .next
32434 .cindex "log" "full parentage"
32435 &%all_parents%&: Normally only the original and final addresses are logged on
32436 delivery lines; with this selector, intermediate parents are given in
32437 parentheses between them.
32438 .next
32439 .cindex "log" "Exim arguments"
32440 .cindex "Exim arguments, logging"
32441 &%arguments%&: This causes Exim to write the arguments with which it was called
32442 to the main log, preceded by the current working directory. This is a debugging
32443 feature, added to make it easier to find out how certain MUAs call
32444 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
32445 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
32446 that are empty or that contain white space are quoted. Non-printing characters
32447 are shown as escape sequences. This facility cannot log unrecognized arguments,
32448 because the arguments are checked before the configuration file is read. The
32449 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
32450 between the caller and Exim.
32451 .next
32452 .cindex "log" "connection rejections"
32453 &%connection_reject%&: A log entry is written whenever an incoming SMTP
32454 connection is rejected, for whatever reason.
32455 .next
32456 .cindex "log" "delayed delivery"
32457 .cindex "delayed delivery, logging"
32458 &%delay_delivery%&: A log entry is written whenever a delivery process is not
32459 started for an incoming message because the load is too high or too many
32460 messages were received on one connection. Logging does not occur if no delivery
32461 process is started because &%queue_only%& is set or &%-odq%& was used.
32462 .next
32463 .cindex "log" "delivery duration"
32464 &%deliver_time%&: For each delivery, the amount of real time it has taken to
32465 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
32466 .next
32467 .cindex "log" "message size on delivery"
32468 .cindex "size" "of message"
32469 &%delivery_size%&: For each delivery, the size of message delivered is added to
32470 the &"=>"& line, tagged with S=.
32471 .next
32472 .cindex "log" "dnslist defer"
32473 .cindex "DNS list" "logging defer"
32474 .cindex "black list (DNS)"
32475 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
32476 DNS black list suffers a temporary error.
32477 .next
32478 .cindex "log" "ETRN commands"
32479 .cindex "ETRN" "logging"
32480 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
32481 is run to determine whether or not it is actually accepted. An invalid ETRN
32482 command, or one received within a message transaction is not logged by this
32483 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
32484 .next
32485 .cindex "log" "host lookup failure"
32486 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
32487 any addresses, or when a lookup of an IP address fails to find a host name, a
32488 log line is written. This logging does not apply to direct DNS lookups when
32489 routing email addresses, but it does apply to &"byname"& lookups.
32490 .next
32491 .cindex "log" "ident timeout"
32492 .cindex "RFC 1413" "logging timeout"
32493 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
32494 client's ident port times out.
32495 .next
32496 .cindex "log" "incoming interface"
32497 .cindex "interface" "logging"
32498 &%incoming_interface%&: The interface on which a message was received is added
32499 to the &"<="& line as an IP address in square brackets, tagged by I= and
32500 followed by a colon and the port number. The local interface and port are also
32501 added to other SMTP log lines, for example &"SMTP connection from"&, and to
32502 rejection lines.
32503 .next
32504 .cindex "log" "incoming remote port"
32505 .cindex "port" "logging remote"
32506 .cindex "TCP/IP" "logging incoming remote port"
32507 .vindex "&$sender_fullhost$&"
32508 .vindex "&$sender_rcvhost$&"
32509 &%incoming_port%&: The remote port number from which a message was received is
32510 added to log entries and &'Received:'& header lines, following the IP address
32511 in square brackets, and separated from it by a colon. This is implemented by
32512 changing the value that is put in the &$sender_fullhost$& and
32513 &$sender_rcvhost$& variables. Recording the remote port number has become more
32514 important with the widening use of NAT (see RFC 2505).
32515 .next
32516 .cindex "log" "dropped connection"
32517 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
32518 connection is unexpectedly dropped.
32519 .next
32520 .cindex "log" "outgoing remote port"
32521 .cindex "port" "logging outgoint remote"
32522 .cindex "TCP/IP" "logging ougtoing remote port"
32523 &%outgoing_port%&: The remote port number is added to delivery log lines (those
32524 containing => tags) following the IP address. This option is not included in
32525 the default setting, because for most ordinary configurations, the remote port
32526 number is always 25 (the SMTP port).
32527 .next
32528 .cindex "log" "process ids in"
32529 .cindex "pid (process id)" "in log lines"
32530 &%pid%&: The current process id is added to every log line, in square brackets,
32531 immediately after the time and date.
32532 .next
32533 .cindex "log" "queue run"
32534 .cindex "queue runner" "logging"
32535 &%queue_run%&: The start and end of every queue run are logged.
32536 .next
32537 .cindex "log" "queue time"
32538 &%queue_time%&: The amount of time the message has been in the queue on the
32539 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
32540 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
32541 includes reception time as well as the delivery time for the current address.
32542 This means that it may be longer than the difference between the arrival and
32543 delivery log line times, because the arrival log line is not written until the
32544 message has been successfully received.
32545 .next
32546 &%queue_time_overall%&: The amount of time the message has been in the queue on
32547 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
32548 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
32549 message, so it includes reception time as well as the total delivery time.
32550 .next
32551 .cindex "log" "recipients"
32552 &%received_recipients%&: The recipients of a message are listed in the main log
32553 as soon as the message is received. The list appears at the end of the log line
32554 that is written when a message is received, preceded by the word &"for"&. The
32555 addresses are listed after they have been qualified, but before any rewriting
32556 has taken place.
32557 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
32558 in the list.
32559 .next
32560 .cindex "log" "sender reception"
32561 &%received_sender%&: The unrewritten original sender of a message is added to
32562 the end of the log line that records the message's arrival, after the word
32563 &"from"& (before the recipients if &%received_recipients%& is also set).
32564 .next
32565 .cindex "log" "header lines for rejection"
32566 &%rejected_header%&: If a message's header has been received at the time a
32567 rejection is written to the reject log, the complete header is added to the
32568 log. Header logging can be turned off individually for messages that are
32569 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
32570 .next
32571 .cindex "log" "retry defer"
32572 &%retry_defer%&: A log line is written if a delivery is deferred because a
32573 retry time has not yet been reached. However, this &"retry time not reached"&
32574 message is always omitted from individual message logs after the first delivery
32575 attempt.
32576 .next
32577 .cindex "log" "return path"
32578 &%return_path_on_delivery%&: The return path that is being transmitted with
32579 the message is included in delivery and bounce lines, using the tag P=.
32580 This is omitted if no delivery actually happens, for example, if routing fails,
32581 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
32582 .next
32583 .cindex "log" "sender on delivery"
32584 &%sender_on_delivery%&: The message's sender address is added to every delivery
32585 and bounce line, tagged by F= (for &"from"&).
32586 This is the original sender that was received with the message; it is not
32587 necessarily the same as the outgoing return path.
32588 .next
32589 .cindex "log" "sender verify failure"
32590 &%sender_verify_fail%&: If this selector is unset, the separate log line that
32591 gives details of a sender verification failure is not written. Log lines for
32592 the rejection of SMTP commands contain just &"sender verify failed"&, so some
32593 detail is lost.
32594 .next
32595 .cindex "log" "size rejection"
32596 &%size_reject%&: A log line is written whenever a message is rejected because
32597 it is too big.
32598 .next
32599 .cindex "log" "frozen messages; skipped"
32600 .cindex "frozen messages" "logging skipping"
32601 &%skip_delivery%&: A log line is written whenever a message is skipped during a
32602 queue run because it is frozen or because another process is already delivering
32603 it.
32604 .cindex "&""spool file is locked""&"
32605 The message that is written is &"spool file is locked"&.
32606 .next
32607 .cindex "log" "smtp confirmation"
32608 .cindex "SMTP" "logging confirmation"
32609 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
32610 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
32611 A number of MTAs (including Exim) return an identifying string in this
32612 response.
32613 .next
32614 .cindex "log" "SMTP connections"
32615 .cindex "SMTP" "logging connections"
32616 &%smtp_connection%&: A log line is written whenever an SMTP connection is
32617 established or closed, unless the connection is from a host that matches
32618 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
32619 only when the closure is unexpected.) This applies to connections from local
32620 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
32621 dropped in the middle of a message, a log line is always written, whether or
32622 not this selector is set, but otherwise nothing is written at the start and end
32623 of connections unless this selector is enabled.
32624
32625 For TCP/IP connections to an Exim daemon, the current number of connections is
32626 included in the log message for each new connection, but note that the count is
32627 reset if the daemon is restarted.
32628 Also, because connections are closed (and the closure is logged) in
32629 subprocesses, the count may not include connections that have been closed but
32630 whose termination the daemon has not yet noticed. Thus, while it is possible to
32631 match up the opening and closing of connections in the log, the value of the
32632 logged counts may not be entirely accurate.
32633 .next
32634 .cindex "log" "SMTP transaction; incomplete"
32635 .cindex "SMTP" "logging incomplete transactions"
32636 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
32637 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
32638 and the message sender plus any accepted recipients are included in the log
32639 line. This can provide evidence of dictionary attacks.
32640 .next
32641 .cindex "log" "non-MAIL SMTP sessions"
32642 .cindex "MAIL" "logging session without"
32643 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
32644 connection terminates without having issued a MAIL command. This includes both
32645 the case when the connection is dropped, and the case when QUIT is used. It
32646 does not include cases where the connection is rejected right at the start (by
32647 an ACL, or because there are too many connections, or whatever). These cases
32648 already have their own log lines.
32649
32650 The log line that is written contains the identity of the client in the usual
32651 way, followed by D= and a time, which records the duration of the connection.
32652 If the connection was authenticated, this fact is logged exactly as it is for
32653 an incoming message, with an A= item. If the connection was encrypted, CV=,
32654 DN=, and X= items may appear as they do for an incoming message, controlled by
32655 the same logging options.
32656
32657 Finally, if any SMTP commands were issued during the connection, a C= item
32658 is added to the line, listing the commands that were used. For example,
32659 .code
32660 C=EHLO,QUIT
32661 .endd
32662 shows that the client issued QUIT straight after EHLO. If there were fewer
32663 than 20 commands, they are all listed. If there were more than 20 commands,
32664 the last 20 are listed, preceded by &"..."&. However, with the default
32665 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
32666 have been aborted before 20 non-mail commands are processed.
32667 .next
32668 .cindex "log" "SMTP protocol error"
32669 .cindex "SMTP" "logging protocol error"
32670 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
32671 encountered. Exim does not have perfect detection of all protocol errors
32672 because of transmission delays and the use of pipelining. If PIPELINING has
32673 been advertised to a client, an Exim server assumes that the client will use
32674 it, and therefore it does not count &"expected"& errors (for example, RCPT
32675 received after rejecting MAIL) as protocol errors.
32676 .next
32677 .cindex "SMTP" "logging syntax errors"
32678 .cindex "SMTP" "syntax errors; logging"
32679 .cindex "SMTP" "unknown command; logging"
32680 .cindex "log" "unknown SMTP command"
32681 .cindex "log" "SMTP syntax error"
32682 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
32683 encountered. An unrecognized command is treated as a syntax error. For an
32684 external connection, the host identity is given; for an internal connection
32685 using &%-bs%& the sender identification (normally the calling user) is given.
32686 .next
32687 .cindex "log" "subject"
32688 .cindex "subject, logging"
32689 &%subject%&: The subject of the message is added to the arrival log line,
32690 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
32691 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
32692 specifies whether characters with values greater than 127 should be logged
32693 unchanged, or whether they should be rendered as escape sequences.
32694 .next
32695 .cindex "log" "certificate verification"
32696 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
32697 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
32698 verified, and &`CV=no`& if not.
32699 .next
32700 .cindex "log" "TLS cipher"
32701 .cindex "TLS" "logging cipher"
32702 &%tls_cipher%&: When a message is sent or received over an encrypted
32703 connection, the cipher suite used is added to the log line, preceded by X=.
32704 .next
32705 .cindex "log" "TLS peer DN"
32706 .cindex "TLS" "logging peer DN"
32707 &%tls_peerdn%&: When a message is sent or received over an encrypted
32708 connection, and a certificate is supplied by the remote host, the peer DN is
32709 added to the log line, preceded by DN=.
32710 .next
32711 .cindex "log" "DNS failure in list"
32712 &%unknown_in_list%&: This setting causes a log entry to be written when the
32713 result of a list match is failure because a DNS lookup failed.
32714 .endlist
32715
32716
32717 .section "Message log" "SECID260"
32718 .cindex "message" "log file for"
32719 .cindex "log" "message log; description of"
32720 .cindex "&_msglog_& directory"
32721 .oindex "&%preserve_message_logs%&"
32722 In addition to the general log files, Exim writes a log file for each message
32723 that it handles. The names of these per-message logs are the message ids, and
32724 they are kept in the &_msglog_& sub-directory of the spool directory. Each
32725 message log contains copies of the log lines that apply to the message. This
32726 makes it easier to inspect the status of an individual message without having
32727 to search the main log. A message log is deleted when processing of the message
32728 is complete, unless &%preserve_message_logs%& is set, but this should be used
32729 only with great care because they can fill up your disk very quickly.
32730
32731 On a heavily loaded system, it may be desirable to disable the use of
32732 per-message logs, in order to reduce disk I/O. This can be done by setting the
32733 &%message_logs%& option false.
32734 .ecindex IIDloggen
32735
32736
32737
32738
32739 . ////////////////////////////////////////////////////////////////////////////
32740 . ////////////////////////////////////////////////////////////////////////////
32741
32742 .chapter "Exim utilities" "CHAPutils"
32743 .scindex IIDutils "utilities"
32744 A number of utility scripts and programs are supplied with Exim and are
32745 described in this chapter. There is also the Exim Monitor, which is covered in
32746 the next chapter. The utilities described here are:
32747
32748 .itable none 0 0 3  7* left  15* left  40* left
32749 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
32750   "list what Exim processes are doing"
32751 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
32752 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
32753 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
32754 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
32755                                                 various criteria"
32756 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
32757 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
32758   "extract statistics from the log"
32759 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
32760   "check address acceptance from given IP"
32761 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
32762 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
32763 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
32764 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
32765 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
32766 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
32767 .endtable
32768
32769 Another utility that might be of use to sites with many MTAs is Tom Kistner's
32770 &'exilog'&. It provides log visualizations across multiple Exim servers. See
32771 &url(http://duncanthrax.net/exilog/) for details.
32772
32773
32774
32775
32776 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
32777 .cindex "&'exiwhat'&"
32778 .cindex "process, querying"
32779 .cindex "SIGUSR1"
32780 On operating systems that can restart a system call after receiving a signal
32781 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
32782 a line describing what it is doing to the file &_exim-process.info_& in the
32783 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
32784 processes it can find, having first emptied the file. It then waits for one
32785 second to allow the Exim processes to react before displaying the results. In
32786 order to run &'exiwhat'& successfully you have to have sufficient privilege to
32787 send the signal to the Exim processes, so it is normally run as root.
32788
32789 &*Warning*&: This is not an efficient process. It is intended for occasional
32790 use by system administrators. It is not sensible, for example, to set up a
32791 script that sends SIGUSR1 signals to Exim processes at short intervals.
32792
32793
32794 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
32795 varies in different operating systems. Not only are different options used,
32796 but the format of the output is different. For this reason, there are some
32797 system configuration options that configure exactly how &'exiwhat'& works. If
32798 it doesn't seem to be working for you, check the following compile-time
32799 options:
32800 .display
32801 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
32802 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
32803 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
32804 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
32805 .endd
32806 An example of typical output from &'exiwhat'& is
32807 .code
32808 164 daemon: -q1h, listening on port 25
32809 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
32810 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
32811   [10.19.42.42] (editor@ref.example)
32812 10592 handling incoming call from [192.168.243.242]
32813 10628 accepting a local non-SMTP message
32814 .endd
32815 The first number in the output line is the process number. The third line has
32816 been split here, in order to fit it on the page.
32817
32818
32819
32820 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
32821 .cindex "&'exiqgrep'&"
32822 .cindex "queue" "grepping"
32823 This utility is a Perl script contributed by Matt Hubbard. It runs
32824 .code
32825 exim -bpu
32826 .endd
32827 to obtain a queue listing with undelivered recipients only, and then greps the
32828 output to select messages that match given criteria. The following selection
32829 options are available:
32830
32831 .vlist
32832 .vitem &*-f*&&~<&'regex'&>
32833 Match the sender address. The field that is tested is enclosed in angle
32834 brackets, so you can test for bounce messages with
32835 .code
32836 exiqgrep -f '^<>$'
32837 .endd
32838 .vitem &*-r*&&~<&'regex'&>
32839 Match a recipient address. The field that is tested is not enclosed in angle
32840 brackets.
32841
32842 .vitem &*-s*&&~<&'regex'&>
32843 Match against the size field.
32844
32845 .vitem &*-y*&&~<&'seconds'&>
32846 Match messages that are younger than the given time.
32847
32848 .vitem &*-o*&&~<&'seconds'&>
32849 Match messages that are older than the given time.
32850
32851 .vitem &*-z*&
32852 Match only frozen messages.
32853
32854 .vitem &*-x*&
32855 Match only non-frozen messages.
32856 .endlist
32857
32858 The following options control the format of the output:
32859
32860 .vlist
32861 .vitem &*-c*&
32862 Display only the count of matching messages.
32863
32864 .vitem &*-l*&
32865 Long format &-- display the full message information as output by Exim. This is
32866 the default.
32867
32868 .vitem &*-i*&
32869 Display message ids only.
32870
32871 .vitem &*-b*&
32872 Brief format &-- one line per message.
32873
32874 .vitem &*-R*&
32875 Display messages in reverse order.
32876 .endlist
32877
32878 There is one more option, &%-h%&, which outputs a list of options.
32879
32880
32881
32882 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
32883 .cindex "&'exiqsumm'&"
32884 .cindex "queue" "summary"
32885 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
32886 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
32887 running a command such as
32888 .code
32889 exim -bp | exiqsumm
32890 .endd
32891 The output consists of one line for each domain that has messages waiting for
32892 it, as in the following example:
32893 .code
32894 3   2322   74m   66m  msn.com.example
32895 .endd
32896 Each line lists the number of pending deliveries for a domain, their total
32897 volume, and the length of time that the oldest and the newest messages have
32898 been waiting. Note that the number of pending deliveries is greater than the
32899 number of messages when messages have more than one recipient.
32900
32901 A summary line is output at the end. By default the output is sorted on the
32902 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
32903 the output to be sorted by oldest message and by count of messages,
32904 respectively. There are also three options that split the messages for each
32905 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
32906 separates frozen messages, and &%-s%& separates messages according to their
32907 sender.
32908
32909 The output of &'exim -bp'& contains the original addresses in the message, so
32910 this also applies to the output from &'exiqsumm'&. No domains from addresses
32911 generated by aliasing or forwarding are included (unless the &%one_time%&
32912 option of the &(redirect)& router has been used to convert them into &"top
32913 level"& addresses).
32914
32915
32916
32917
32918 .section "Extracting specific information from the log (exigrep)" &&&
32919          "SECTextspeinf"
32920 .cindex "&'exigrep'&"
32921 .cindex "log" "extracts; grepping for"
32922 The &'exigrep'& utility is a Perl script that searches one or more main log
32923 files for entries that match a given pattern. When it finds a match, it
32924 extracts all the log entries for the relevant message, not just those that
32925 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
32926 given message, or all mail for a given user, or for a given host, for example.
32927 The input files can be in Exim log format or syslog format.
32928 If a matching log line is not associated with a specific message, it is
32929 included in &'exigrep'&'s output without any additional lines. The usage is:
32930 .display
32931 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
32932 .endd
32933 If no log file names are given on the command line, the standard input is read.
32934
32935 The &%-t%& argument specifies a number of seconds. It adds an additional
32936 condition for message selection. Messages that are complete are shown only if
32937 they spent more than <&'n'&> seconds on the queue.
32938
32939 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
32940 makes it case-sensitive. This may give a performance improvement when searching
32941 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
32942 option; with &%-I%& they do not. In both cases it is possible to change the
32943 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
32944
32945 The &%-l%& option means &"literal"&, that is, treat all characters in the
32946 pattern as standing for themselves. Otherwise the pattern must be a Perl
32947 regular expression.
32948
32949 The &%-v%& option inverts the matching condition. That is, a line is selected
32950 if it does &'not'& match the pattern.
32951
32952 If the location of a &'zcat'& command is known from the definition of
32953 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
32954 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
32955
32956
32957 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
32958 .cindex "&'exipick'&"
32959 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
32960 lists messages from the queue according to a variety of criteria. For details
32961 of &'exipick'&'s facilities, visit the web page at
32962 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
32963 the &%--help%& option.
32964
32965
32966 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
32967 .cindex "log" "cycling local files"
32968 .cindex "cycling logs"
32969 .cindex "&'exicyclog'&"
32970 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
32971 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
32972 you are using log files with datestamps in their names (see section
32973 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
32974 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
32975 There are two command line options for &'exicyclog'&:
32976 .ilist
32977 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
32978 default that is set when Exim is built. The default default is 10.
32979 .next
32980 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
32981 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
32982 overriding the script's default, which is to find the setting from Exim's
32983 configuration.
32984 .endlist
32985
32986 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
32987 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
32988 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
32989 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
32990 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
32991 logs are handled similarly.
32992
32993 If the limit is greater than 99, the script uses 3-digit numbers such as
32994 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
32995 to one that is greater, or &'vice versa'&, you will have to fix the names of
32996 any existing log files.
32997
32998 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
32999 the end are deleted. All files with numbers greater than 01 are compressed,
33000 using a compression command which is configured by the COMPRESS_COMMAND
33001 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
33002 root &%crontab%& entry of the form
33003 .code
33004 1 0 * * * su exim -c /usr/exim/bin/exicyclog
33005 .endd
33006 assuming you have used the name &"exim"& for the Exim user. You can run
33007 &'exicyclog'& as root if you wish, but there is no need.
33008
33009
33010
33011 .section "Mail statistics (eximstats)" "SECTmailstat"
33012 .cindex "statistics"
33013 .cindex "&'eximstats'&"
33014 A Perl script called &'eximstats'& is provided for extracting statistical
33015 information from log files. The output is either plain text, or HTML.
33016 Exim log files are also supported by the &'Lire'& system produced by the
33017 LogReport Foundation &url(http://www.logreport.org).
33018
33019 The &'eximstats'& script has been hacked about quite a bit over time. The
33020 latest version is the result of some extensive revision by Steve Campbell. A
33021 lot of information is given by default, but there are options for suppressing
33022 various parts of it. Following any options, the arguments to the script are a
33023 list of files, which should be main log files. For example:
33024 .code
33025 eximstats -nr /var/spool/exim/log/mainlog.01
33026 .endd
33027 By default, &'eximstats'& extracts information about the number and volume of
33028 messages received from or delivered to various hosts. The information is sorted
33029 both by message count and by volume, and the top fifty hosts in each category
33030 are listed on the standard output. Similar information, based on email
33031 addresses or domains instead of hosts can be requested by means of various
33032 options. For messages delivered and received locally, similar statistics are
33033 also produced per user.
33034
33035 The output also includes total counts and statistics about delivery errors, and
33036 histograms showing the number of messages received and deliveries made in each
33037 hour of the day. A delivery with more than one address in its envelope (for
33038 example, an SMTP transaction with more than one RCPT command) is counted
33039 as a single delivery by &'eximstats'&.
33040
33041 Though normally more deliveries than receipts are reported (as messages may
33042 have multiple recipients), it is possible for &'eximstats'& to report more
33043 messages received than delivered, even though the queue is empty at the start
33044 and end of the period in question. If an incoming message contains no valid
33045 recipients, no deliveries are recorded for it. A bounce message is handled as
33046 an entirely separate message.
33047
33048 &'eximstats'& always outputs a grand total summary giving the volume and number
33049 of messages received and deliveries made, and the number of hosts involved in
33050 each case. It also outputs the number of messages that were delayed (that is,
33051 not completely delivered at the first attempt), and the number that had at
33052 least one address that failed.
33053
33054 The remainder of the output is in sections that can be independently disabled
33055 or modified by various options. It consists of a summary of deliveries by
33056 transport, histograms of messages received and delivered per time interval
33057 (default per hour), information about the time messages spent on the queue,
33058 a list of relayed messages, lists of the top fifty sending hosts, local
33059 senders, destination hosts, and destination local users by count and by volume,
33060 and a list of delivery errors that occurred.
33061
33062 The relay information lists messages that were actually relayed, that is, they
33063 came from a remote host and were directly delivered to some other remote host,
33064 without being processed (for example, for aliasing or forwarding) locally.
33065
33066 There are quite a few options for &'eximstats'& to control exactly what it
33067 outputs. These are documented in the Perl script itself, and can be extracted
33068 by running the command &(perldoc)& on the script. For example:
33069 .code
33070 perldoc /usr/exim/bin/eximstats
33071 .endd
33072
33073 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
33074 .cindex "&'exim_checkaccess'&"
33075 .cindex "policy control" "checking access"
33076 .cindex "checking access"
33077 The &%-bh%& command line argument allows you to run a fake SMTP session with
33078 debugging output, in order to check what Exim is doing when it is applying
33079 policy controls to incoming SMTP mail. However, not everybody is sufficiently
33080 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
33081 sometimes you just want to answer the question &"Does this address have
33082 access?"& without bothering with any further details.
33083
33084 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
33085 two arguments, an IP address and an email address:
33086 .code
33087 exim_checkaccess 10.9.8.7 A.User@a.domain.example
33088 .endd
33089 The utility runs a call to Exim with the &%-bh%& option, to test whether the
33090 given email address would be accepted in a RCPT command in a TCP/IP
33091 connection from the host with the given IP address. The output of the utility
33092 is either the word &"accepted"&, or the SMTP error response, for example:
33093 .code
33094 Rejected:
33095 550 Relay not permitted
33096 .endd
33097 When running this test, the utility uses &`<>`& as the envelope sender address
33098 for the MAIL command, but you can change this by providing additional
33099 options. These are passed directly to the Exim command. For example, to specify
33100 that the test is to be run with the sender address &'himself@there.example'&
33101 you can use:
33102 .code
33103 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
33104                  -f himself@there.example
33105 .endd
33106 Note that these additional Exim command line items must be given after the two
33107 mandatory arguments.
33108
33109 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
33110 while running its checks. You can run checks that include callouts by using
33111 &%-bhc%&, but this is not yet available in a &"packaged"& form.
33112
33113
33114
33115 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
33116 .cindex "DBM" "building dbm files"
33117 .cindex "building DBM files"
33118 .cindex "&'exim_dbmbuild'&"
33119 .cindex "lower casing"
33120 .cindex "binary zero" "in lookup key"
33121 The &'exim_dbmbuild'& program reads an input file containing keys and data in
33122 the format used by the &(lsearch)& lookup (see section
33123 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
33124 names as keys and the remainder of the information as data. The lower-casing
33125 can be prevented by calling the program with the &%-nolc%& option.
33126
33127 A terminating zero is included as part of the key string. This is expected by
33128 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
33129 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
33130 strings or the data strings. The &(dbmnz)& lookup type can be used with such
33131 files.
33132
33133 The program requires two arguments: the name of the input file (which can be a
33134 single hyphen to indicate the standard input), and the name of the output file.
33135 It creates the output under a temporary name, and then renames it if all went
33136 well.
33137
33138 .cindex "USE_DB"
33139 If the native DB interface is in use (USE_DB is set in a compile-time
33140 configuration file &-- this is common in free versions of Unix) the two file
33141 names must be different, because in this mode the Berkeley DB functions create
33142 a single output file using exactly the name given. For example,
33143 .code
33144 exim_dbmbuild /etc/aliases /etc/aliases.db
33145 .endd
33146 reads the system alias file and creates a DBM version of it in
33147 &_/etc/aliases.db_&.
33148
33149 In systems that use the &'ndbm'& routines (mostly proprietary versions of
33150 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
33151 environment, the suffixes are added to the second argument of
33152 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
33153 when the Berkeley functions are used in compatibility mode (though this is not
33154 recommended), because in that case it adds a &_.db_& suffix to the file name.
33155
33156 If a duplicate key is encountered, the program outputs a warning, and when it
33157 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
33158 option is used. By default, only the first of a set of duplicates is used &--
33159 this makes it compatible with &(lsearch)& lookups. There is an option
33160 &%-lastdup%& which causes it to use the data for the last duplicate instead.
33161 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
33162 &%stderr%&. For other errors, where it doesn't actually make a new file, the
33163 return code is 2.
33164
33165
33166
33167
33168 .section "Finding individual retry times (exinext)" "SECTfinindret"
33169 .cindex "retry" "times"
33170 .cindex "&'exinext'&"
33171 A utility called &'exinext'& (mostly a Perl script) provides the ability to
33172 fish specific information out of the retry database. Given a mail domain (or a
33173 complete address), it looks up the hosts for that domain, and outputs any retry
33174 information for the hosts or for the domain. At present, the retry information
33175 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
33176 output. For example:
33177 .code
33178 $ exinext piglet@milne.fict.example
33179 kanga.milne.example:192.168.8.1 error 146: Connection refused
33180   first failed: 21-Feb-1996 14:57:34
33181   last tried:   21-Feb-1996 14:57:34
33182   next try at:  21-Feb-1996 15:02:34
33183 roo.milne.example:192.168.8.3 error 146: Connection refused
33184   first failed: 20-Jan-1996 13:12:08
33185   last tried:   21-Feb-1996 11:42:03
33186   next try at:  21-Feb-1996 19:42:03
33187   past final cutoff time
33188 .endd
33189 You can also give &'exinext'& a local part, without a domain, and it
33190 will give any retry information for that local part in your default domain.
33191 A message id can be used to obtain retry information pertaining to a specific
33192 message. This exists only when an attempt to deliver a message to a remote host
33193 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
33194 &'exinext'& is not particularly efficient, but then it is not expected to be
33195 run very often.
33196
33197 The &'exinext'& utility calls Exim to find out information such as the location
33198 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
33199 passed on to the &'exim'& commands. The first specifies an alternate Exim
33200 configuration file, and the second sets macros for use within the configuration
33201 file. These features are mainly to help in testing, but might also be useful in
33202 environments where more than one configuration file is in use.
33203
33204
33205
33206 .section "Hints database maintenance" "SECThindatmai"
33207 .cindex "hints database" "maintenance"
33208 .cindex "maintaining Exim's hints database"
33209 Three utility programs are provided for maintaining the DBM files that Exim
33210 uses to contain its delivery hint information. Each program requires two
33211 arguments. The first specifies the name of Exim's spool directory, and the
33212 second is the name of the database it is to operate on. These are as follows:
33213
33214 .ilist
33215 &'retry'&: the database of retry information
33216 .next
33217 &'wait-'&<&'transport name'&>: databases of information about messages waiting
33218 for remote hosts
33219 .next
33220 &'callout'&: the callout cache
33221 .next
33222 &'ratelimit'&: the data for implementing the ratelimit ACL condition
33223 .next
33224 &'misc'&: other hints data
33225 .endlist
33226
33227 The &'misc'& database is used for
33228
33229 .ilist
33230 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
33231 .next
33232 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
33233 &(smtp)& transport)
33234 .endlist
33235
33236
33237
33238 .section "exim_dumpdb" "SECID261"
33239 .cindex "&'exim_dumpdb'&"
33240 The entire contents of a database are written to the standard output by the
33241 &'exim_dumpdb'& program, which has no options or arguments other than the
33242 spool and database names. For example, to dump the retry database:
33243 .code
33244 exim_dumpdb /var/spool/exim retry
33245 .endd
33246 Two lines of output are produced for each entry:
33247 .code
33248 T:mail.ref.example:192.168.242.242 146 77 Connection refused
33249 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
33250 .endd
33251 The first item on the first line is the key of the record. It starts with one
33252 of the letters R, or T, depending on whether it refers to a routing or
33253 transport retry. For a local delivery, the next part is the local address; for
33254 a remote delivery it is the name of the remote host, followed by its failing IP
33255 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
33256 transport). If the remote port is not the standard one (port 25), it is added
33257 to the IP address. Then there follows an error code, an additional error code,
33258 and a textual description of the error.
33259
33260 The three times on the second line are the time of first failure, the time of
33261 the last delivery attempt, and the computed time for the next attempt. The line
33262 ends with an asterisk if the cutoff time for the last retry rule has been
33263 exceeded.
33264
33265 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
33266 consists of a host name followed by a list of ids for messages that are or were
33267 waiting to be delivered to that host. If there are a very large number for any
33268 one host, continuation records, with a sequence number added to the host name,
33269 may be seen. The data in these records is often out of date, because a message
33270 may be routed to several alternative hosts, and Exim makes no effort to keep
33271 cross-references.
33272
33273
33274
33275 .section "exim_tidydb" "SECID262"
33276 .cindex "&'exim_tidydb'&"
33277 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
33278 database. If run with no options, it removes all records that are more than 30
33279 days old. The age is calculated from the date and time that the record was last
33280 updated. Note that, in the case of the retry database, it is &'not'& the time
33281 since the first delivery failure. Information about a host that has been down
33282 for more than 30 days will remain in the database, provided that the record is
33283 updated sufficiently often.
33284
33285 The cutoff date can be altered by means of the &%-t%& option, which must be
33286 followed by a time. For example, to remove all records older than a week from
33287 the retry database:
33288 .code
33289 exim_tidydb -t 7d /var/spool/exim retry
33290 .endd
33291 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
33292 message ids. In the former these appear as data in records keyed by host &--
33293 they were messages that were waiting for that host &-- and in the latter they
33294 are the keys for retry information for messages that have suffered certain
33295 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
33296 message ids in database records are those of messages that are still on the
33297 queue. Message ids for messages that no longer exist are removed from
33298 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
33299 For the &'retry'& database, records whose keys are non-existent message ids are
33300 removed. The &'exim_tidydb'& utility outputs comments on the standard output
33301 whenever it removes information from the database.
33302
33303 Certain records are automatically removed by Exim when they are no longer
33304 needed, but others are not. For example, if all the MX hosts for a domain are
33305 down, a retry record is created for each one. If the primary MX host comes back
33306 first, its record is removed when Exim successfully delivers to it, but the
33307 records for the others remain because Exim has not tried to use those hosts.
33308
33309 It is important, therefore, to run &'exim_tidydb'& periodically on all the
33310 hints databases. You should do this at a quiet time of day, because it requires
33311 a database to be locked (and therefore inaccessible to Exim) while it does its
33312 work. Removing records from a DBM file does not normally make the file smaller,
33313 but all the common DBM libraries are able to re-use the space that is released.
33314 After an initial phase of increasing in size, the databases normally reach a
33315 point at which they no longer get any bigger, as long as they are regularly
33316 tidied.
33317
33318 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
33319 databases is likely to keep on increasing.
33320
33321
33322
33323
33324 .section "exim_fixdb" "SECID263"
33325 .cindex "&'exim_fixdb'&"
33326 The &'exim_fixdb'& program is a utility for interactively modifying databases.
33327 Its main use is for testing Exim, but it might also be occasionally useful for
33328 getting round problems in a live system. It has no options, and its interface
33329 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
33330 key of a database record can then be entered, and the data for that record is
33331 displayed.
33332
33333 If &"d"& is typed at the next prompt, the entire record is deleted. For all
33334 except the &'retry'& database, that is the only operation that can be carried
33335 out. For the &'retry'& database, each field is output preceded by a number, and
33336 data for individual fields can be changed by typing the field number followed
33337 by new data, for example:
33338 .code
33339 > 4 951102:1000
33340 .endd
33341 resets the time of the next delivery attempt. Time values are given as a
33342 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
33343 used as optional separators.
33344
33345
33346
33347
33348 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
33349 .cindex "mailbox" "maintenance"
33350 .cindex "&'exim_lock'&"
33351 .cindex "locking mailboxes"
33352 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
33353 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
33354 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
33355 a user agent while investigating a problem. The utility requires the name of
33356 the file as its first argument. If the locking is successful, the second
33357 argument is run as a command (using C's &[system()]& function); if there is no
33358 second argument, the value of the SHELL environment variable is used; if this
33359 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
33360 is unlocked and the utility ends. The following options are available:
33361
33362 .vlist
33363 .vitem &%-fcntl%&
33364 Use &[fcntl()]& locking on the open mailbox.
33365
33366 .vitem &%-flock%&
33367 Use &[flock()]& locking on the open mailbox, provided the operating system
33368 supports it.
33369
33370 .vitem &%-interval%&
33371 This must be followed by a number, which is a number of seconds; it sets the
33372 interval to sleep between retries (default 3).
33373
33374 .vitem &%-lockfile%&
33375 Create a lock file before opening the mailbox.
33376
33377 .vitem &%-mbx%&
33378 Lock the mailbox using MBX rules.
33379
33380 .vitem &%-q%&
33381 Suppress verification output.
33382
33383 .vitem &%-retries%&
33384 This must be followed by a number; it sets the number of times to try to get
33385 the lock (default 10).
33386
33387 .vitem &%-restore_time%&
33388 This option causes &%exim_lock%& to restore the modified and read times to the
33389 locked file before exiting. This allows you to access a locked mailbox (for
33390 example, to take a backup copy) without disturbing the times that the user
33391 subsequently sees.
33392
33393 .vitem &%-timeout%&
33394 This must be followed by a number, which is a number of seconds; it sets a
33395 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
33396 default), a non-blocking call is used.
33397
33398 .vitem &%-v%&
33399 Generate verbose output.
33400 .endlist
33401
33402 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
33403 default is to create a lock file and also to use &[fcntl()]& locking on the
33404 mailbox, which is the same as Exim's default. The use of &%-flock%& or
33405 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
33406 requires that the directory containing the file be writeable. Locking by lock
33407 file does not last for ever; Exim assumes that a lock file is expired if it is
33408 more than 30 minutes old.
33409
33410 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
33411 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
33412 to be taken out on the open mailbox, and an exclusive lock on the file
33413 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
33414 number of the mailbox file. When the locking is released, if an exclusive lock
33415 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
33416
33417 The default output contains verification of the locking that takes place. The
33418 &%-v%& option causes some additional information to be given. The &%-q%& option
33419 suppresses all output except error messages.
33420
33421 A command such as
33422 .code
33423 exim_lock /var/spool/mail/spqr
33424 .endd
33425 runs an interactive shell while the file is locked, whereas
33426 .display
33427 &`exim_lock -q /var/spool/mail/spqr <<End`&
33428 <&'some commands'&>
33429 &`End`&
33430 .endd
33431 runs a specific non-interactive sequence of commands while the file is locked,
33432 suppressing all verification output. A single command can be run by a command
33433 such as
33434 .code
33435 exim_lock -q /var/spool/mail/spqr \
33436   "cp /var/spool/mail/spqr /some/where"
33437 .endd
33438 Note that if a command is supplied, it must be entirely contained within the
33439 second argument &-- hence the quotes.
33440 .ecindex IIDutils
33441
33442
33443 . ////////////////////////////////////////////////////////////////////////////
33444 . ////////////////////////////////////////////////////////////////////////////
33445
33446 .chapter "The Exim monitor" "CHAPeximon"
33447 .scindex IIDeximon "Exim monitor" "description"
33448 .cindex "X-windows"
33449 .cindex "&'eximon'&"
33450 .cindex "Local/eximon.conf"
33451 .cindex "&_exim_monitor/EDITME_&"
33452 The Exim monitor is an application which displays in an X window information
33453 about the state of Exim's queue and what Exim is doing. An admin user can
33454 perform certain operations on messages from this GUI interface; however all
33455 such facilities are also available from the command line, and indeed, the
33456 monitor itself makes use of the command line to perform any actions requested.
33457
33458
33459
33460 .section "Running the monitor" "SECID264"
33461 The monitor is started by running the script called &'eximon'&. This is a shell
33462 script that sets up a number of environment variables, and then runs the
33463 binary called &_eximon.bin_&. The default appearance of the monitor window can
33464 be changed by editing the &_Local/eximon.conf_& file created by editing
33465 &_exim_monitor/EDITME_&. Comments in that file describe what the various
33466 parameters are for.
33467
33468 The parameters that get built into the &'eximon'& script can be overridden for
33469 a particular invocation by setting up environment variables of the same names,
33470 preceded by &`EXIMON_`&. For example, a shell command such as
33471 .code
33472 EXIMON_LOG_DEPTH=400 eximon
33473 .endd
33474 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
33475 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
33476 overrides the Exim log file configuration. This makes it possible to have
33477 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
33478 syslog messages are routed to a file on the local host.
33479
33480 X resources can be used to change the appearance of the window in the normal
33481 way. For example, a resource setting of the form
33482 .code
33483 Eximon*background: gray94
33484 .endd
33485 changes the colour of the background to light grey rather than white. The
33486 stripcharts are drawn with both the data lines and the reference lines in
33487 black. This means that the reference lines are not visible when on top of the
33488 data. However, their colour can be changed by setting a resource called
33489 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
33490 For example, if your X server is running Unix, you could set up lighter
33491 reference lines in the stripcharts by obeying
33492 .code
33493 xrdb -merge <<End
33494 Eximon*highlight: gray
33495 End
33496 .endd
33497 .cindex "admin user"
33498 In order to see the contents of messages on the queue, and to operate on them,
33499 &'eximon'& must either be run as root or by an admin user.
33500
33501 The monitor's window is divided into three parts. The first contains one or
33502 more stripcharts and two action buttons, the second contains a &"tail"& of the
33503 main log file, and the third is a display of the queue of messages awaiting
33504 delivery, with two more action buttons. The following sections describe these
33505 different parts of the display.
33506
33507
33508
33509
33510 .section "The stripcharts" "SECID265"
33511 .cindex "stripchart"
33512 The first stripchart is always a count of messages on the queue. Its name can
33513 be configured by setting QUEUE_STRIPCHART_NAME in the
33514 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
33515 configuration script by regular expression matches on log file entries, making
33516 it possible to display, for example, counts of messages delivered to certain
33517 hosts or using certain transports. The supplied defaults display counts of
33518 received and delivered messages, and of local and SMTP deliveries. The default
33519 period between stripchart updates is one minute; this can be adjusted by a
33520 parameter in the &_Local/eximon.conf_& file.
33521
33522 The stripchart displays rescale themselves automatically as the value they are
33523 displaying changes. There are always 10 horizontal lines in each chart; the
33524 title string indicates the value of each division when it is greater than one.
33525 For example, &"x2"& means that each division represents a value of 2.
33526
33527 It is also possible to have a stripchart which shows the percentage fullness of
33528 a particular disk partition, which is useful when local deliveries are confined
33529 to a single partition.
33530
33531 .cindex "&%statvfs%& function"
33532 This relies on the availability of the &[statvfs()]& function or equivalent in
33533 the operating system. Most, but not all versions of Unix that support Exim have
33534 this. For this particular stripchart, the top of the chart always represents
33535 100%, and the scale is given as &"x10%"&. This chart is configured by setting
33536 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
33537 &_Local/eximon.conf_& file.
33538
33539
33540
33541
33542 .section "Main action buttons" "SECID266"
33543 .cindex "size" "of monitor window"
33544 .cindex "Exim monitor" "window size"
33545 .cindex "window size"
33546 Below the stripcharts there is an action button for quitting the monitor. Next
33547 to this is another button marked &"Size"&. They are placed here so that
33548 shrinking the window to its default minimum size leaves just the queue count
33549 stripchart and these two buttons visible. Pressing the &"Size"& button causes
33550 the window to expand to its maximum size, unless it is already at the maximum,
33551 in which case it is reduced to its minimum.
33552
33553 When expanding to the maximum, if the window cannot be fully seen where it
33554 currently is, it is moved back to where it was the last time it was at full
33555 size. When it is expanding from its minimum size, the old position is
33556 remembered, and next time it is reduced to the minimum it is moved back there.
33557
33558 The idea is that you can keep a reduced window just showing one or two
33559 stripcharts at a convenient place on your screen, easily expand it to show
33560 the full window when required, and just as easily put it back to what it was.
33561 The idea is copied from what the &'twm'& window manager does for its
33562 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
33563 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
33564
33565 Normally, the monitor starts up with the window at its full size, but it can be
33566 built so that it starts up with the window at its smallest size, by setting
33567 START_SMALL=yes in &_Local/eximon.conf_&.
33568
33569
33570
33571 .section "The log display" "SECID267"
33572 .cindex "log" "tail of; in monitor"
33573 The second section of the window is an area in which a display of the tail of
33574 the main log is maintained.
33575 To save space on the screen, the timestamp on each log line is shortened by
33576 removing the date and, if &%log_timezone%& is set, the timezone.
33577 The log tail is not available when the only destination for logging data is
33578 syslog, unless the syslog lines are routed to a local file whose name is passed
33579 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
33580
33581 The log sub-window has a scroll bar at its lefthand side which can be used to
33582 move back to look at earlier text, and the up and down arrow keys also have a
33583 scrolling effect. The amount of log that is kept depends on the setting of
33584 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
33585 to use. When this is full, the earlier 50% of data is discarded &-- this is
33586 much more efficient than throwing it away line by line. The sub-window also has
33587 a horizontal scroll bar for accessing the ends of long log lines. This is the
33588 only means of horizontal scrolling; the right and left arrow keys are not
33589 available. Text can be cut from this part of the window using the mouse in the
33590 normal way. The size of this subwindow is controlled by parameters in the
33591 configuration file &_Local/eximon.conf_&.
33592
33593 Searches of the text in the log window can be carried out by means of the ^R
33594 and ^S keystrokes, which default to a reverse and a forward search,
33595 respectively. The search covers only the text that is displayed in the window.
33596 It cannot go further back up the log.
33597
33598 The point from which the search starts is indicated by a caret marker. This is
33599 normally at the end of the text in the window, but can be positioned explicitly
33600 by pointing and clicking with the left mouse button, and is moved automatically
33601 by a successful search. If new text arrives in the window when it is scrolled
33602 back, the caret remains where it is, but if the window is not scrolled back,
33603 the caret is moved to the end of the new text.
33604
33605 Pressing ^R or ^S pops up a window into which the search text can be typed.
33606 There are buttons for selecting forward or reverse searching, for carrying out
33607 the search, and for cancelling. If the &"Search"& button is pressed, the search
33608 happens and the window remains so that further searches can be done. If the
33609 &"Return"& key is pressed, a single search is done and the window is closed. If
33610 ^C is typed the search is cancelled.
33611
33612 The searching facility is implemented using the facilities of the Athena text
33613 widget. By default this pops up a window containing both &"search"& and
33614 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
33615 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
33616 However, the linkers in BSDI and HP-UX seem unable to handle an externally
33617 provided version of &%TextPop%& when the remaining parts of the text widget
33618 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
33619 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
33620 on these systems, at the expense of having unwanted items in the search popup
33621 window.
33622
33623
33624
33625 .section "The queue display" "SECID268"
33626 .cindex "queue" "display in monitor"
33627 The bottom section of the monitor window contains a list of all messages that
33628 are on the queue, which includes those currently being received or delivered,
33629 as well as those awaiting delivery. The size of this subwindow is controlled by
33630 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
33631 at which it is updated is controlled by another parameter in the same file &--
33632 the default is 5 minutes, since queue scans can be quite expensive. However,
33633 there is an &"Update"& action button just above the display which can be used
33634 to force an update of the queue display at any time.
33635
33636 When a host is down for some time, a lot of pending mail can build up for it,
33637 and this can make it hard to deal with other messages on the queue. To help
33638 with this situation there is a button next to &"Update"& called &"Hide"&. If
33639 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
33640 type anything in here and press &"Return"&, the text is added to a chain of
33641 such texts, and if every undelivered address in a message matches at least one
33642 of the texts, the message is not displayed.
33643
33644 If there is an address that does not match any of the texts, all the addresses
33645 are displayed as normal. The matching happens on the ends of addresses so, for
33646 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
33647 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
33648 has been set up, a button called &"Unhide"& is displayed. If pressed, it
33649 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
33650 a hide request is automatically cancelled after one hour.
33651
33652 While the dialogue box is displayed, you can't press any buttons or do anything
33653 else to the monitor window. For this reason, if you want to cut text from the
33654 queue display to use in the dialogue box, you have to do the cutting before
33655 pressing the &"Hide"& button.
33656
33657 The queue display contains, for each unhidden queued message, the length of
33658 time it has been on the queue, the size of the message, the message id, the
33659 message sender, and the first undelivered recipient, all on one line. If it is
33660 a bounce message, the sender is shown as &"<>"&. If there is more than one
33661 recipient to which the message has not yet been delivered, subsequent ones are
33662 listed on additional lines, up to a maximum configured number, following which
33663 an ellipsis is displayed. Recipients that have already received the message are
33664 not shown.
33665
33666 .cindex "frozen messages" "display"
33667 If a message is frozen, an asterisk is displayed at the left-hand side.
33668
33669 The queue display has a vertical scroll bar, and can also be scrolled by means
33670 of the arrow keys. Text can be cut from it using the mouse in the normal way.
33671 The text searching facilities, as described above for the log window, are also
33672 available, but the caret is always moved to the end of the text when the queue
33673 display is updated.
33674
33675
33676
33677 .section "The queue menu" "SECID269"
33678 .cindex "queue" "menu in monitor"
33679 If the &%shift%& key is held down and the left button is clicked when the mouse
33680 pointer is over the text for any message, an action menu pops up, and the first
33681 line of the queue display for the message is highlighted. This does not affect
33682 any selected text.
33683
33684 If you want to use some other event for popping up the menu, you can set the
33685 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
33686 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
33687 value set in this parameter is a standard X event description. For example, to
33688 run eximon using &%ctrl%& rather than &%shift%& you could use
33689 .code
33690 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
33691 .endd
33692 The title of the menu is the message id, and it contains entries which act as
33693 follows:
33694
33695 .ilist
33696 &'message log'&: The contents of the message log for the message are displayed
33697 in a new text window.
33698 .next
33699 &'headers'&: Information from the spool file that contains the envelope
33700 information and headers is displayed in a new text window. See chapter
33701 &<<CHAPspool>>& for a description of the format of spool files.
33702 .next
33703 &'body'&: The contents of the spool file containing the body of the message are
33704 displayed in a new text window. There is a default limit of 20,000 bytes to the
33705 amount of data displayed. This can be changed by setting the BODY_MAX
33706 option at compile time, or the EXIMON_BODY_MAX option at run time.
33707 .next
33708 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
33709 delivery of the message. This causes an automatic thaw if the message is
33710 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
33711 a new text window. The delivery is run in a separate process, to avoid holding
33712 up the monitor while the delivery proceeds.
33713 .next
33714 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
33715 that the message be frozen.
33716 .next
33717 .cindex "thawing messages"
33718 .cindex "unfreezing messages"
33719 .cindex "frozen messages" "thawing"
33720 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
33721 that the message be thawed.
33722 .next
33723 .cindex "delivery" "forcing failure"
33724 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
33725 that Exim gives up trying to deliver the message. A bounce message is generated
33726 for any remaining undelivered addresses.
33727 .next
33728 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
33729 that the message be deleted from the system without generating a bounce
33730 message.
33731 .next
33732 &'add recipient'&: A dialog box is displayed into which a recipient address can
33733 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
33734 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
33735 Otherwise it must be entered as a fully qualified address. Pressing RETURN
33736 causes a call to Exim to be made using the &%-Mar%& option to request that an
33737 additional recipient be added to the message, unless the entry box is empty, in
33738 which case no action is taken.
33739 .next
33740 &'mark delivered'&: A dialog box is displayed into which a recipient address
33741 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
33742 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
33743 Otherwise it must be entered as a fully qualified address. Pressing RETURN
33744 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
33745 recipient address as already delivered, unless the entry box is empty, in which
33746 case no action is taken.
33747 .next
33748 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
33749 mark all recipient addresses as already delivered.
33750 .next
33751 &'edit sender'&: A dialog box is displayed initialized with the current
33752 sender's address. Pressing RETURN causes a call to Exim to be made using the
33753 &%-Mes%& option to replace the sender address, unless the entry box is empty,
33754 in which case no action is taken. If you want to set an empty sender (as in
33755 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
33756 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
33757 the address is qualified with that domain.
33758 .endlist
33759
33760 When a delivery is forced, a window showing the &%-v%& output is displayed. In
33761 other cases when a call to Exim is made, if there is any output from Exim (in
33762 particular, if the command fails) a window containing the command and the
33763 output is displayed. Otherwise, the results of the action are normally apparent
33764 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
33765 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
33766 if no output is generated.
33767
33768 The queue display is automatically updated for actions such as freezing and
33769 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
33770 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
33771 force an update of the display after one of these actions.
33772
33773 In any text window that is displayed as result of a menu action, the normal
33774 cut-and-paste facility is available, and searching can be carried out using ^R
33775 and ^S, as described above for the log tail window.
33776 .ecindex IIDeximon
33777
33778
33779
33780
33781
33782 . ////////////////////////////////////////////////////////////////////////////
33783 . ////////////////////////////////////////////////////////////////////////////
33784
33785 .chapter "Security considerations" "CHAPsecurity"
33786 .scindex IIDsecurcon "security" "discussion of"
33787 This chapter discusses a number of issues concerned with security, some of
33788 which are also covered in other parts of this manual.
33789
33790 For reasons that this author does not understand, some people have promoted
33791 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
33792 existence of this chapter in the documentation. However, the intent of the
33793 chapter is simply to describe the way Exim works in relation to certain
33794 security concerns, not to make any specific claims about the effectiveness of
33795 its security as compared with other MTAs.
33796
33797 What follows is a description of the way Exim is supposed to be. Best efforts
33798 have been made to try to ensure that the code agrees with the theory, but an
33799 absence of bugs can never be guaranteed. Any that are reported will get fixed
33800 as soon as possible.
33801
33802
33803 .section "Building a more &""hardened""& Exim" "SECID286"
33804 .cindex "security" "build-time features"
33805 There are a number of build-time options that can be set in &_Local/Makefile_&
33806 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
33807 Exim administrator who does not have the root password, or by someone who has
33808 penetrated the Exim (but not the root) account. These options are as follows:
33809
33810 .ilist
33811 ALT_CONFIG_PREFIX can be set to a string that is required to match the
33812 start of any file names used with the &%-C%& option. When it is set, these file
33813 names are also not allowed to contain the sequence &"/../"&. (However, if the
33814 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
33815 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
33816 default setting for &%ALT_CONFIG_PREFIX%&.
33817
33818 If the permitted configuration files are confined to a directory to
33819 which only root has access, this guards against someone who has broken
33820 into the Exim account from running a privileged Exim with an arbitrary
33821 configuration file, and using it to break into other accounts.
33822 .next
33823 If a non-trusted configuration file (i.e. not the default configuration file
33824 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
33825 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
33826 the next item), then root privilege is retained only if the caller of Exim is
33827 root. This locks out the possibility of testing a configuration using &%-C%&
33828 right through message reception and delivery, even if the caller is root. The
33829 reception works, but by that time, Exim is running as the Exim user, so when
33830 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
33831 privilege to be lost. However, root can test reception and delivery using two
33832 separate commands.
33833 .next
33834 The WHITELIST_D_MACROS build option declares some macros to be safe to override
33835 with &%-D%& if the real uid is one of root, the Exim run-time user or the
33836 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
33837 requiring the run-time value supplied to &%-D%& to match a regex that errs on
33838 the restrictive side.  Requiring build-time selection of safe macros is onerous
33839 but this option is intended solely as a transition mechanism to permit
33840 previously-working configurations to continue to work after release 4.73.
33841 .next
33842 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
33843 is disabled.
33844 .next
33845 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
33846 never to be used for any deliveries. This is like the &%never_users%& runtime
33847 option, but it cannot be overridden; the runtime option adds additional users
33848 to the list. The default setting is &"root"&; this prevents a non-root user who
33849 is permitted to modify the runtime file from using Exim as a way to get root.
33850 .endlist
33851
33852
33853
33854
33855 .section "Root privilege" "SECID270"
33856 .cindex "setuid"
33857 .cindex "root privilege"
33858 The Exim binary is normally setuid to root, which means that it gains root
33859 privilege (runs as root) when it starts execution. In some special cases (for
33860 example, when the daemon is not in use and there are no local deliveries), it
33861 may be possible to run Exim setuid to some user other than root. This is
33862 discussed in the next section. However, in most installations, root privilege
33863 is required for two things:
33864
33865 .ilist
33866 To set up a socket connected to the standard SMTP port (25) when initialising
33867 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
33868 not required.
33869 .next
33870 To be able to change uid and gid in order to read users' &_.forward_& files and
33871 perform local deliveries as the receiving user or as specified in the
33872 configuration.
33873 .endlist
33874
33875 It is not necessary to be root to do any of the other things Exim does, such as
33876 receiving messages and delivering them externally over SMTP, and it is
33877 obviously more secure if Exim does not run as root except when necessary.
33878 For this reason, a user and group for Exim to use must be defined in
33879 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
33880 group"&. Their values can be changed by the run time configuration, though this
33881 is not recommended. Often a user called &'exim'& is used, but some sites use
33882 &'mail'& or another user name altogether.
33883
33884 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
33885 abdication; the process cannot regain root afterwards. Prior to release 4.00,
33886 &[seteuid()]& was used in some circumstances, but this is no longer the case.
33887
33888 After a new Exim process has interpreted its command line options, it changes
33889 uid and gid in the following cases:
33890
33891 .ilist
33892 .oindex "&%-C%&"
33893 .oindex "&%-D%&"
33894 If the &%-C%& option is used to specify an alternate configuration file, or if
33895 the &%-D%& option is used to define macro values for the configuration, and the
33896 calling process is not running as root, the uid and gid are changed to those of
33897 the calling process.
33898 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
33899 option may not be used at all.
33900 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
33901 can be supplied if the calling process is running as root, the Exim run-time
33902 user or CONFIGURE_OWNER, if defined.
33903 .next
33904 .oindex "&%-be%&"
33905 .oindex "&%-bf%&"
33906 .oindex "&%-bF%&"
33907 If the expansion test option (&%-be%&) or one of the filter testing options
33908 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
33909 calling process.
33910 .next
33911 If the process is not a daemon process or a queue runner process or a delivery
33912 process or a process for testing address routing (started with &%-bt%&), the
33913 uid and gid are changed to the Exim user and group. This means that Exim always
33914 runs under its own uid and gid when receiving messages. This also applies when
33915 testing address verification
33916 .oindex "&%-bv%&"
33917 .oindex "&%-bh%&"
33918 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
33919 option).
33920 .next
33921 For a daemon, queue runner, delivery, or address testing process, the uid
33922 remains as root at this stage, but the gid is changed to the Exim group.
33923 .endlist
33924
33925 The processes that initially retain root privilege behave as follows:
33926
33927 .ilist
33928 A daemon process changes the gid to the Exim group and the uid to the Exim
33929 user after setting up one or more listening sockets. The &[initgroups()]&
33930 function is called, so that if the Exim user is in any additional groups, they
33931 will be used during message reception.
33932 .next
33933 A queue runner process retains root privilege throughout its execution. Its
33934 job is to fork a controlled sequence of delivery processes.
33935 .next
33936 A delivery process retains root privilege throughout most of its execution,
33937 but any actual deliveries (that is, the transports themselves) are run in
33938 subprocesses which always change to a non-root uid and gid. For local
33939 deliveries this is typically the uid and gid of the owner of the mailbox; for
33940 remote deliveries, the Exim uid and gid are used. Once all the delivery
33941 subprocesses have been run, a delivery process changes to the Exim uid and gid
33942 while doing post-delivery tidying up such as updating the retry database and
33943 generating bounce and warning messages.
33944
33945 While the recipient addresses in a message are being routed, the delivery
33946 process runs as root. However, if a user's filter file has to be processed,
33947 this is done in a subprocess that runs under the individual user's uid and
33948 gid. A system filter is run as root unless &%system_filter_user%& is set.
33949 .next
33950 A process that is testing addresses (the &%-bt%& option) runs as root so that
33951 the routing is done in the same environment as a message delivery.
33952 .endlist
33953
33954
33955
33956
33957 .section "Running Exim without privilege" "SECTrunexiwitpri"
33958 .cindex "privilege, running without"
33959 .cindex "unprivileged running"
33960 .cindex "root privilege" "running without"
33961 Some installations like to run Exim in an unprivileged state for more of its
33962 operation, for added security. Support for this mode of operation is provided
33963 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
33964 gid are changed to the Exim user and group at the start of a delivery process
33965 (and also queue runner and address testing processes). This means that address
33966 routing is no longer run as root, and the deliveries themselves cannot change
33967 to any other uid.
33968
33969 .cindex SIGHUP
33970 .cindex "daemon" "restarting"
33971 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
33972 that the daemon can still be started in the usual way, and it can respond
33973 correctly to SIGHUP because the re-invocation regains root privilege.
33974
33975 An alternative approach is to make Exim setuid to the Exim user and also setgid
33976 to the Exim group. If you do this, the daemon must be started from a root
33977 process. (Calling Exim from a root process makes it behave in the way it does
33978 when it is setuid root.) However, the daemon cannot restart itself after a
33979 SIGHUP signal because it cannot regain privilege.
33980
33981 It is still useful to set &%deliver_drop_privilege%& in this case, because it
33982 stops Exim from trying to re-invoke itself to do a delivery after a message has
33983 been received. Such a re-invocation is a waste of resources because it has no
33984 effect.
33985
33986 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
33987 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
33988 to the Exim user seems a clean approach, but there is one complication:
33989
33990 In this style of operation, Exim is running with the real uid and gid set to
33991 those of the calling process, and the effective uid/gid set to Exim's values.
33992 Ideally, any association with the calling process' uid/gid should be dropped,
33993 that is, the real uid/gid should be reset to the effective values so as to
33994 discard any privileges that the caller may have. While some operating systems
33995 have a function that permits this action for a non-root effective uid, quite a
33996 number of them do not. Because of this lack of standardization, Exim does not
33997 address this problem at this time.
33998
33999 For this reason, the recommended approach for &"mostly unprivileged"& running
34000 is to keep the Exim binary setuid to root, and to set
34001 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
34002 be used in the most straightforward way.
34003
34004 If you configure Exim not to run delivery processes as root, there are a
34005 number of restrictions on what you can do:
34006
34007 .ilist
34008 You can deliver only as the Exim user/group. You should  explicitly use the
34009 &%user%& and &%group%& options to override routers or local transports that
34010 normally deliver as the recipient. This makes sure that configurations that
34011 work in this mode function the same way in normal mode. Any implicit or
34012 explicit specification of another user causes an error.
34013 .next
34014 Use of &_.forward_& files is severely restricted, such that it is usually
34015 not worthwhile to include them in the configuration.
34016 .next
34017 Users who wish to use &_.forward_& would have to make their home directory and
34018 the file itself accessible to the Exim user. Pipe and append-to-file entries,
34019 and their equivalents in Exim filters, cannot be used. While they could be
34020 enabled in the Exim user's name, that would be insecure and not very useful.
34021 .next
34022 Unless the local user mailboxes are all owned by the Exim user (possible in
34023 some POP3 or IMAP-only environments):
34024
34025 .olist
34026 They must be owned by the Exim group and be writeable by that group. This
34027 implies you must set &%mode%& in the appendfile configuration, as well as the
34028 mode of the mailbox files themselves.
34029 .next
34030 You must set &%no_check_owner%&, since most or all of the files will not be
34031 owned by the Exim user.
34032 .next
34033 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
34034 on a newly created mailbox when unprivileged. This also implies that new
34035 mailboxes need to be created manually.
34036 .endlist olist
34037 .endlist ilist
34038
34039
34040 These restrictions severely restrict what can be done in local deliveries.
34041 However, there are no restrictions on remote deliveries. If you are running a
34042 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
34043 gives more security at essentially no cost.
34044
34045 If you are using the &%mua_wrapper%& facility (see chapter
34046 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
34047
34048
34049
34050
34051 .section "Delivering to local files" "SECID271"
34052 Full details of the checks applied by &(appendfile)& before it writes to a file
34053 are given in chapter &<<CHAPappendfile>>&.
34054
34055
34056
34057 .section "IPv4 source routing" "SECID272"
34058 .cindex "source routing" "in IP packets"
34059 .cindex "IP source routing"
34060 Many operating systems suppress IP source-routed packets in the kernel, but
34061 some cannot be made to do this, so Exim does its own check. It logs incoming
34062 IPv4 source-routed TCP calls, and then drops them. Things are all different in
34063 IPv6. No special checking is currently done.
34064
34065
34066
34067 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
34068 Support for these SMTP commands is disabled by default. If required, they can
34069 be enabled by defining suitable ACLs.
34070
34071
34072
34073
34074 .section "Privileged users" "SECID274"
34075 .cindex "trusted users"
34076 .cindex "admin user"
34077 .cindex "privileged user"
34078 .cindex "user" "trusted"
34079 .cindex "user" "admin"
34080 Exim recognizes two sets of users with special privileges. Trusted users are
34081 able to submit new messages to Exim locally, but supply their own sender
34082 addresses and information about a sending host. For other users submitting
34083 local messages, Exim sets up the sender address from the uid, and doesn't
34084 permit a remote host to be specified.
34085
34086 .oindex "&%-f%&"
34087 However, an untrusted user is permitted to use the &%-f%& command line option
34088 in the special form &%-f <>%& to indicate that a delivery failure for the
34089 message should not cause an error report. This affects the message's envelope,
34090 but it does not affect the &'Sender:'& header. Untrusted users may also be
34091 permitted to use specific forms of address with the &%-f%& option by setting
34092 the &%untrusted_set_sender%& option.
34093
34094 Trusted users are used to run processes that receive mail messages from some
34095 other mail domain and pass them on to Exim for delivery either locally, or over
34096 the Internet. Exim trusts a caller that is running as root, as the Exim user,
34097 as any user listed in the &%trusted_users%& configuration option, or under any
34098 group listed in the &%trusted_groups%& option.
34099
34100 Admin users are permitted to do things to the messages on Exim's queue. They
34101 can freeze or thaw messages, cause them to be returned to their senders, remove
34102 them entirely, or modify them in various ways. In addition, admin users can run
34103 the Exim monitor and see all the information it is capable of providing, which
34104 includes the contents of files on the spool.
34105
34106 .oindex "&%-M%&"
34107 .oindex "&%-q%&"
34108 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
34109 delivery of messages on its queue is restricted to admin users. This
34110 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
34111 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
34112 queue is also restricted to admin users. This restriction can be relaxed by
34113 setting &%no_queue_list_requires_admin%&.
34114
34115 Exim recognizes an admin user if the calling process is running as root or as
34116 the Exim user or if any of the groups associated with the calling process is
34117 the Exim group. It is not necessary actually to be running under the Exim
34118 group. However, if admin users who are not root or the Exim user are to access
34119 the contents of files on the spool via the Exim monitor (which runs
34120 unprivileged), Exim must be built to allow group read access to its spool
34121 files.
34122
34123
34124
34125 .section "Spool files" "SECID275"
34126 .cindex "spool directory" "files"
34127 Exim's spool directory and everything it contains is owned by the Exim user and
34128 set to the Exim group. The mode for spool files is defined in the
34129 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
34130 any user who is a member of the Exim group can access these files.
34131
34132
34133
34134 .section "Use of argv[0]" "SECID276"
34135 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
34136 of specific strings, Exim assumes certain options. For example, calling Exim
34137 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
34138 to calling it with the option &%-bS%&. There are no security implications in
34139 this.
34140
34141
34142
34143 .section "Use of %f formatting" "SECID277"
34144 The only use made of &"%f"& by Exim is in formatting load average values. These
34145 are actually stored in integer variables as 1000 times the load average.
34146 Consequently, their range is limited and so therefore is the length of the
34147 converted output.
34148
34149
34150
34151 .section "Embedded Exim path" "SECID278"
34152 Exim uses its own path name, which is embedded in the code, only when it needs
34153 to re-exec in order to regain root privilege. Therefore, it is not root when it
34154 does so. If some bug allowed the path to get overwritten, it would lead to an
34155 arbitrary program's being run as exim, not as root.
34156
34157
34158
34159 .section "Use of sprintf()" "SECID279"
34160 .cindex "&[sprintf()]&"
34161 A large number of occurrences of &"sprintf"& in the code are actually calls to
34162 &'string_sprintf()'&, a function that returns the result in malloc'd store.
34163 The intermediate formatting is done into a large fixed buffer by a function
34164 that runs through the format string itself, and checks the length of each
34165 conversion before performing it, thus preventing buffer overruns.
34166
34167 The remaining uses of &[sprintf()]& happen in controlled circumstances where
34168 the output buffer is known to be sufficiently long to contain the converted
34169 string.
34170
34171
34172
34173 .section "Use of debug_printf() and log_write()" "SECID280"
34174 Arbitrary strings are passed to both these functions, but they do their
34175 formatting by calling the function &'string_vformat()'&, which runs through
34176 the format string itself, and checks the length of each conversion.
34177
34178
34179
34180 .section "Use of strcat() and strcpy()" "SECID281"
34181 These are used only in cases where the output buffer is known to be large
34182 enough to hold the result.
34183 .ecindex IIDsecurcon
34184
34185
34186
34187
34188 . ////////////////////////////////////////////////////////////////////////////
34189 . ////////////////////////////////////////////////////////////////////////////
34190
34191 .chapter "Format of spool files" "CHAPspool"
34192 .scindex IIDforspo1 "format" "spool files"
34193 .scindex IIDforspo2 "spool directory" "format of files"
34194 .scindex IIDforspo3 "spool files" "format of"
34195 .cindex "spool files" "editing"
34196 A message on Exim's queue consists of two files, whose names are the message id
34197 followed by -D and -H, respectively. The data portion of the message is kept in
34198 the -D file on its own. The message's envelope, status, and headers are all
34199 kept in the -H file, whose format is described in this chapter. Each of these
34200 two files contains the final component of its own name as its first line. This
34201 is insurance against disk crashes where the directory is lost but the files
34202 themselves are recoverable.
34203
34204 Some people are tempted into editing -D files in order to modify messages. You
34205 need to be extremely careful if you do this; it is not recommended and you are
34206 on your own if you do it. Here are some of the pitfalls:
34207
34208 .ilist
34209 You must ensure that Exim does not try to deliver the message while you are
34210 fiddling with it. The safest way is to take out a write lock on the -D file,
34211 which is what Exim itself does, using &[fcntl()]&. If you update the file in
34212 place, the lock will be retained. If you write a new file and rename it, the
34213 lock will be lost at the instant of rename.
34214 .next
34215 .vindex "&$body_linecount$&"
34216 If you change the number of lines in the file, the value of
34217 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
34218 present, this value is not used by Exim, but there is no guarantee that this
34219 will always be the case.
34220 .next
34221 If the message is in MIME format, you must take care not to break it.
34222 .next
34223 If the message is cryptographically signed, any change will invalidate the
34224 signature.
34225 .endlist
34226 All in all, modifying -D files is fraught with danger.
34227
34228 Files whose names end with -J may also be seen in the &_input_& directory (or
34229 its subdirectories when &%split_spool_directory%& is set). These are journal
34230 files, used to record addresses to which the message has been delivered during
34231 the course of a delivery attempt. If there are still undelivered recipients at
34232 the end, the -H file is updated, and the -J file is deleted. If, however, there
34233 is some kind of crash (for example, a power outage) before this happens, the -J
34234 file remains in existence. When Exim next processes the message, it notices the
34235 -J file and uses it to update the -H file before starting the next delivery
34236 attempt.
34237
34238 .section "Format of the -H file" "SECID282"
34239 .cindex "uid (user id)" "in spool file"
34240 .cindex "gid (group id)" "in spool file"
34241 The second line of the -H file contains the login name for the uid of the
34242 process that called Exim to read the message, followed by the numerical uid and
34243 gid. For a locally generated message, this is normally the user who sent the
34244 message. For a message received over TCP/IP via the daemon, it is
34245 normally the Exim user.
34246
34247 The third line of the file contains the address of the message's sender as
34248 transmitted in the envelope, contained in angle brackets. The sender address is
34249 empty for bounce messages. For incoming SMTP mail, the sender address is given
34250 in the MAIL command. For locally generated mail, the sender address is
34251 created by Exim from the login name of the current user and the configured
34252 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
34253 leading &"From&~"& line if the caller is trusted, or if the supplied address is
34254 &"<>"& or an address that matches &%untrusted_set_senders%&.
34255
34256 The fourth line contains two numbers. The first is the time that the message
34257 was received, in the conventional Unix form &-- the number of seconds since the
34258 start of the epoch. The second number is a count of the number of messages
34259 warning of delayed delivery that have been sent to the sender.
34260
34261 There follow a number of lines starting with a hyphen. These can appear in any
34262 order, and are omitted when not relevant:
34263
34264 .vlist
34265 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
34266 This item is obsolete, and is not generated from Exim release 4.61 onwards;
34267 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
34268 recognized, to provide backward compatibility. In the old format, a line of
34269 this form is present for every ACL variable that is not empty. The number
34270 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
34271 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
34272 the data string for the variable. The string itself starts at the beginning of
34273 the next line, and is followed by a newline character. It may contain internal
34274 newlines.
34275
34276 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
34277 A line of this form is present for every ACL connection variable that is
34278 defined. Note that there is a space between &%-aclc%& and the rest of the name.
34279 The length is the length of the data string for the variable. The string itself
34280 starts at the beginning of the next line, and is followed by a newline
34281 character. It may contain internal newlines.
34282
34283 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
34284 A line of this form is present for every ACL message variable that is defined.
34285 Note that there is a space between &%-aclm%& and the rest of the name. The
34286 length is the length of the data string for the variable. The string itself
34287 starts at the beginning of the next line, and is followed by a newline
34288 character. It may contain internal newlines.
34289
34290 .vitem "&%-active_hostname%&&~<&'hostname'&>"
34291 This is present if, when the message was received over SMTP, the value of
34292 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
34293
34294 .vitem &%-allow_unqualified_recipient%&
34295 This is present if unqualified recipient addresses are permitted in header
34296 lines (to stop such addresses from being qualified if rewriting occurs at
34297 transport time). Local messages that were input using &%-bnq%& and remote
34298 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
34299
34300 .vitem &%-allow_unqualified_sender%&
34301 This is present if unqualified sender addresses are permitted in header lines
34302 (to stop such addresses from being qualified if rewriting occurs at transport
34303 time). Local messages that were input using &%-bnq%& and remote messages from
34304 hosts that match &%sender_unqualified_hosts%& set this flag.
34305
34306 .vitem "&%-auth_id%&&~<&'text'&>"
34307 The id information for a message received on an authenticated SMTP connection
34308 &-- the value of the &$authenticated_id$& variable.
34309
34310 .vitem "&%-auth_sender%&&~<&'address'&>"
34311 The address of an authenticated sender &-- the value of the
34312 &$authenticated_sender$& variable.
34313
34314 .vitem "&%-body_linecount%&&~<&'number'&>"
34315 This records the number of lines in the body of the message, and is always
34316 present.
34317
34318 .vitem "&%-body_zerocount%&&~<&'number'&>"
34319 This records the number of binary zero bytes in the body of the message, and is
34320 present if the number is greater than zero.
34321
34322 .vitem &%-deliver_firsttime%&
34323 This is written when a new message is first added to the spool. When the spool
34324 file is updated after a deferral, it is omitted.
34325
34326 .vitem "&%-frozen%&&~<&'time'&>"
34327 .cindex "frozen messages" "spool data"
34328 The message is frozen, and the freezing happened at <&'time'&>.
34329
34330 .vitem "&%-helo_name%&&~<&'text'&>"
34331 This records the host name as specified by a remote host in a HELO or EHLO
34332 command.
34333
34334 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
34335 This records the IP address of the host from which the message was received and
34336 the remote port number that was used. It is omitted for locally generated
34337 messages.
34338
34339 .vitem "&%-host_auth%&&~<&'text'&>"
34340 If the message was received on an authenticated SMTP connection, this records
34341 the name of the authenticator &-- the value of the
34342 &$sender_host_authenticated$& variable.
34343
34344 .vitem &%-host_lookup_failed%&
34345 This is present if an attempt to look up the sending host's name from its IP
34346 address failed. It corresponds to the &$host_lookup_failed$& variable.
34347
34348 .vitem "&%-host_name%&&~<&'text'&>"
34349 .cindex "reverse DNS lookup"
34350 .cindex "DNS" "reverse lookup"
34351 This records the name of the remote host from which the message was received,
34352 if the host name was looked up from the IP address when the message was being
34353 received. It is not present if no reverse lookup was done.
34354
34355 .vitem "&%-ident%&&~<&'text'&>"
34356 For locally submitted messages, this records the login of the originating user,
34357 unless it was a trusted user and the &%-oMt%& option was used to specify an
34358 ident value. For messages received over TCP/IP, this records the ident string
34359 supplied by the remote host, if any.
34360
34361 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
34362 This records the IP address of the local interface and the port number through
34363 which a message was received from a remote host. It is omitted for locally
34364 generated messages.
34365
34366 .vitem &%-local%&
34367 The message is from a local sender.
34368
34369 .vitem &%-localerror%&
34370 The message is a locally-generated bounce message.
34371
34372 .vitem "&%-local_scan%&&~<&'string'&>"
34373 This records the data string that was returned by the &[local_scan()]& function
34374 when the message was received &-- the value of the &$local_scan_data$&
34375 variable. It is omitted if no data was returned.
34376
34377 .vitem &%-manual_thaw%&
34378 The message was frozen but has been thawed manually, that is, by an explicit
34379 Exim command rather than via the auto-thaw process.
34380
34381 .vitem &%-N%&
34382 A testing delivery process was started using the &%-N%& option to suppress any
34383 actual deliveries, but delivery was deferred. At any further delivery attempts,
34384 &%-N%& is assumed.
34385
34386 .vitem &%-received_protocol%&
34387 This records the value of the &$received_protocol$& variable, which contains
34388 the name of the protocol by which the message was received.
34389
34390 .vitem &%-sender_set_untrusted%&
34391 The envelope sender of this message was set by an untrusted local caller (used
34392 to ensure that the caller is displayed in queue listings).
34393
34394 .vitem "&%-spam_score_int%&&~<&'number'&>"
34395 If a message was scanned by SpamAssassin, this is present. It records the value
34396 of &$spam_score_int$&.
34397
34398 .vitem &%-tls_certificate_verified%&
34399 A TLS certificate was received from the client that sent this message, and the
34400 certificate was verified by the server.
34401
34402 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
34403 When the message was received over an encrypted connection, this records the
34404 name of the cipher suite that was used.
34405
34406 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
34407 When the message was received over an encrypted connection, and a certificate
34408 was received from the client, this records the Distinguished Name from that
34409 certificate.
34410 .endlist
34411
34412 Following the options there is a list of those addresses to which the message
34413 is not to be delivered. This set of addresses is initialized from the command
34414 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
34415 is set; otherwise it starts out empty. Whenever a successful delivery is made,
34416 the address is added to this set. The addresses are kept internally as a
34417 balanced binary tree, and it is a representation of that tree which is written
34418 to the spool file. If an address is expanded via an alias or forward file, the
34419 original address is added to the tree when deliveries to all its child
34420 addresses are complete.
34421
34422 If the tree is empty, there is a single line in the spool file containing just
34423 the text &"XX"&. Otherwise, each line consists of two letters, which are either
34424 Y or N, followed by an address. The address is the value for the node of the
34425 tree, and the letters indicate whether the node has a left branch and/or a
34426 right branch attached to it, respectively. If branches exist, they immediately
34427 follow. Here is an example of a three-node tree:
34428 .code
34429 YY darcy@austen.fict.example
34430 NN alice@wonderland.fict.example
34431 NN editor@thesaurus.ref.example
34432 .endd
34433 After the non-recipients tree, there is a list of the message's recipients.
34434 This is a simple list, preceded by a count. It includes all the original
34435 recipients of the message, including those to whom the message has already been
34436 delivered. In the simplest case, the list contains one address per line. For
34437 example:
34438 .code
34439 4
34440 editor@thesaurus.ref.example
34441 darcy@austen.fict.example
34442 rdo@foundation
34443 alice@wonderland.fict.example
34444 .endd
34445 However, when a child address has been added to the top-level addresses as a
34446 result of the use of the &%one_time%& option on a &(redirect)& router, each
34447 line is of the following form:
34448 .display
34449 <&'top-level address'&> <&'errors_to address'&> &&&
34450   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
34451 .endd
34452 The 01 flag bit indicates the presence of the three other fields that follow
34453 the top-level address. Other bits may be used in future to support additional
34454 fields. The <&'parent number'&> is the offset in the recipients list of the
34455 original parent of the &"one time"& address. The first two fields are the
34456 envelope sender that is associated with this address and its length. If the
34457 length is zero, there is no special envelope sender (there are then two space
34458 characters in the line). A non-empty field can arise from a &(redirect)& router
34459 that has an &%errors_to%& setting.
34460
34461
34462 A blank line separates the envelope and status information from the headers
34463 which follow. A header may occupy several lines of the file, and to save effort
34464 when reading it in, each header is preceded by a number and an identifying
34465 character. The number is the number of characters in the header, including any
34466 embedded newlines and the terminating newline. The character is one of the
34467 following:
34468
34469 .table2 50pt
34470 .row <&'blank'&>         "header in which Exim has no special interest"
34471 .row &`B`&               "&'Bcc:'& header"
34472 .row &`C`&               "&'Cc:'& header"
34473 .row &`F`&               "&'From:'& header"
34474 .row &`I`&               "&'Message-id:'& header"
34475 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
34476 .row &`R`&               "&'Reply-To:'& header"
34477 .row &`S`&               "&'Sender:'& header"
34478 .row &`T`&               "&'To:'& header"
34479 .row &`*`&               "replaced or deleted header"
34480 .endtable
34481
34482 Deleted or replaced (rewritten) headers remain in the spool file for debugging
34483 purposes. They are not transmitted when the message is delivered. Here is a
34484 typical set of headers:
34485 .code
34486 111P Received: by hobbit.fict.example with local (Exim 4.00)
34487 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
34488 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
34489 038* X-rewrote-sender: bb@hobbit.fict.example
34490 042* From: Bilbo Baggins <bb@hobbit.fict.example>
34491 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
34492 099* To: alice@wonderland.fict.example, rdo@foundation,
34493 darcy@austen.fict.example, editor@thesaurus.ref.example
34494 104T To: alice@wonderland.fict.example, rdo@foundation.example,
34495 darcy@austen.fict.example, editor@thesaurus.ref.example
34496 038  Date: Fri, 11 May 2001 10:28:59 +0100
34497 .endd
34498 The asterisked headers indicate that the envelope sender, &'From:'& header, and
34499 &'To:'& header have been rewritten, the last one because routing expanded the
34500 unqualified domain &'foundation'&.
34501 .ecindex IIDforspo1
34502 .ecindex IIDforspo2
34503 .ecindex IIDforspo3
34504
34505 . ////////////////////////////////////////////////////////////////////////////
34506 . ////////////////////////////////////////////////////////////////////////////
34507
34508 .chapter "Support for DKIM (DomainKeys Identified Mail) - RFC4871" "CHID12" &&&
34509          "DKIM Support"
34510 .cindex "DKIM"
34511
34512 Since version 4.70, DKIM support is compiled into Exim by default. It can be
34513 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
34514
34515 Exim's DKIM implementation allows to
34516 .olist
34517 Sign outgoing messages: This function is implemented in the SMTP transport.
34518 It can co-exist with all other Exim features, including transport filters.
34519 .next
34520 Verify signatures in incoming messages: This is implemented by an additional
34521 ACL (acl_smtp_dkim), which can be called several times per message, with
34522 different signature contexts.
34523 .endlist
34524
34525 In typical Exim style, the verification implementation does not include any
34526 default "policy". Instead it enables you to build your own policy using
34527 Exim's standard controls.
34528
34529 Please note that verification of DKIM signatures in incoming mail is turned
34530 on by default for logging purposes. For each signature in incoming email,
34531 exim will log a line displaying the most important signature details, and the
34532 signature status. Here is an example:
34533 .code
34534 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]
34535 .endd
34536 You might want to turn off DKIM verification processing entirely for internal
34537 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
34538 control modifier. This should typically be done in the RCPT ACL, at points
34539 where you accept mail from relay sources (internal hosts or authenticated
34540 senders).
34541
34542
34543 .section "Signing outgoing messages" "SECID513"
34544 .cindex "DKIM" "signing"
34545
34546 Signing is implemented by setting private options on the SMTP transport.
34547 These options take (expandable) strings as arguments.
34548
34549 .option dkim_domain smtp string&!! unset
34550 MANDATORY:
34551 The domain you want to sign with. The result of this expanded
34552 option is put into the &%$dkim_domain%& expansion variable.
34553
34554 .option dkim_selector smtp string&!! unset
34555 MANDATORY:
34556 This sets the key selector string. You can use the &%$dkim_domain%& expansion
34557 variable to look up a matching selector. The result is put in the expansion
34558 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
34559 option along with &%$dkim_domain%&.
34560
34561 .option dkim_private_key smtp string&!! unset
34562 MANDATORY:
34563 This sets the private key to use. You can use the &%$dkim_domain%& and
34564 &%$dkim_selector%& expansion variables to determine the private key to use.
34565 The result can either
34566 .ilist
34567 be a valid RSA private key in ASCII armor, including line breaks.
34568 .next
34569 start with a slash, in which case it is treated as a file that contains
34570 the private key.
34571 .next
34572 be "0", "false" or the empty string, in which case the message will not
34573 be signed. This case will not result in an error, even if &%dkim_strict%&
34574 is set.
34575 .endlist
34576
34577 .option dkim_canon smtp string&!! unset
34578 OPTIONAL:
34579 This option sets the canonicalization method used when signing a message.
34580 The DKIM RFC currently supports two methods: "simple" and "relaxed".
34581 The option defaults to "relaxed" when unset. Note: the current implementation
34582 only supports using the same canonicalization method for both headers and body.
34583
34584 .option dkim_strict smtp string&!! unset
34585 OPTIONAL:
34586 This  option  defines  how  Exim  behaves  when  signing a message that
34587 should be signed fails for some reason.  When the expansion evaluates to
34588 either "1" or "true", Exim will defer. Otherwise Exim will send the message
34589 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
34590 variables here.
34591
34592 .option dkim_sign_headers smtp string&!! unset
34593 OPTIONAL:
34594 When set, this option must expand to (or be specified as) a colon-separated
34595 list of header names. Headers with these names will be included in the message
34596 signature. When unspecified, the header names recommended in RFC4871 will be
34597 used.
34598
34599
34600 .section "Verifying DKIM signatures in incoming mail" "SECID514"
34601 .cindex "DKIM" "verification"
34602
34603 Verification of DKIM signatures in incoming email is implemented via the
34604 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
34605 syntactically(!) correct signature in the incoming message.
34606
34607 To evaluate the signature in the ACL a large number of expansion variables
34608 containing the signature status and its details are set up during the
34609 runtime of the ACL.
34610
34611 Calling the ACL only for existing signatures is not sufficient to build
34612 more advanced policies. For that reason, the global option
34613 &%dkim_verify_signers%&, and a global expansion variable
34614 &%$dkim_signers%& exist.
34615
34616 The global option &%dkim_verify_signers%& can be set to a colon-separated
34617 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
34618 called. It is expanded when the message has been received. At this point,
34619 the expansion variable &%$dkim_signers%& already contains a colon-separated
34620 list of signer domains and identities for the message. When
34621 &%dkim_verify_signers%& is not specified in the main configuration,
34622 it defaults as:
34623 .code
34624 dkim_verify_signers = $dkim_signers
34625 .endd
34626 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
34627 DKIM signature in the message. Current DKIM verifiers may want to explicitly
34628 call the ACL for known domains or identities. This would be achieved as follows:
34629 .code
34630 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
34631 .endd
34632 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
34633 and "ebay.com", plus all domains and identities that have signatures in the message.
34634 You can also be more creative in constructing your policy. For example:
34635 .code
34636 dkim_verify_signers = $sender_address_domain:$dkim_signers
34637 .endd
34638
34639 If a domain or identity is listed several times in the (expanded) value of
34640 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
34641
34642
34643 Inside the &%acl_smtp_dkim%&, the following expansion variables are
34644 available (from most to least important):
34645
34646 .vlist
34647 .vitem &%$dkim_cur_signer%&
34648 The signer that is being evaluated in this ACL run. This can be a domain or
34649 an identity. This is one of the list items from the expanded main option
34650 &%dkim_verify_signers%& (see above).
34651 .vitem &%$dkim_verify_status%&
34652 A string describing the general status of the signature. One of
34653 .ilist
34654 &%none%&: There is no signature in the message for the current domain or
34655 identity (as reflected by &%$dkim_cur_signer%&).
34656 .next
34657 &%invalid%&: The signature could not be verified due to a processing error.
34658 More detail is available in &%$dkim_verify_reason%&.
34659 .next
34660 &%fail%&: Verification of the signature failed.  More detail is
34661 available in &%$dkim_verify_reason%&.
34662 .next
34663 &%pass%&: The signature passed verification. It is valid.
34664 .endlist
34665 .vitem &%$dkim_verify_reason%&
34666 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
34667 "fail" or "invalid". One of
34668 .ilist
34669 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
34670 key for the domain could not be retrieved. This may be a temporary problem.
34671 .next
34672 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
34673 record for the domain is syntactically invalid.
34674 .next
34675 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
34676 body hash does not match the one specified in the signature header. This
34677 means that the message body was modified in transit.
34678 .next
34679 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
34680 could not be verified. This may mean that headers were modified,
34681 re-written or otherwise changed in a way which is incompatible with
34682 DKIM verification. It may of course also mean that the signature is forged.
34683 .endlist
34684 .vitem &%$dkim_domain%&
34685 The signing domain. IMPORTANT: This variable is only populated if there is
34686 an actual signature in the message for the current domain or identity (as
34687 reflected by &%$dkim_cur_signer%&).
34688 .vitem &%$dkim_identity%&
34689 The signing identity, if present. IMPORTANT: This variable is only populated
34690 if there is an actual signature in the message for the current domain or
34691 identity (as reflected by &%$dkim_cur_signer%&).
34692 .vitem &%$dkim_selector%&
34693 The key record selector string.
34694 .vitem &%$dkim_algo%&
34695 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
34696 .vitem &%$dkim_canon_body%&
34697 The body canonicalization method. One of 'relaxed' or 'simple'.
34698 .vitem &%dkim_canon_headers%&
34699 The header canonicalization method. One of 'relaxed' or 'simple'.
34700 .vitem &%$dkim_copiedheaders%&
34701 A transcript of headers and their values which are included in the signature
34702 (copied from the 'z=' tag of the signature).
34703 .vitem &%$dkim_bodylength%&
34704 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
34705 limit was set by the signer, "9999999999999" is returned. This makes sure
34706 that this variable always expands to an integer value.
34707 .vitem &%$dkim_created%&
34708 UNIX timestamp reflecting the date and time when the signature was created.
34709 When this was not specified by the signer, "0" is returned.
34710 .vitem &%$dkim_expires%&
34711 UNIX timestamp reflecting the date and time when the signer wants the
34712 signature to be treated as "expired". When this was not specified by the
34713 signer, "9999999999999" is returned. This makes it possible to do useful
34714 integer size comparisons against this value.
34715 .vitem &%$dkim_headernames%&
34716 A colon-separated list of names of headers included in the signature.
34717 .vitem &%$dkim_key_testing%&
34718 "1" if the key record has the "testing" flag set, "0" if not.
34719 .vitem &%$dkim_key_nosubdomaining%&
34720 "1" if the key record forbids subdomaining, "0" otherwise.
34721 .vitem &%$dkim_key_srvtype%&
34722 Service type (tag s=) from the key record. Defaults to "*" if not specified
34723 in the key record.
34724 .vitem &%$dkim_key_granularity%&
34725 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
34726 in the key record.
34727 .vitem &%$dkim_key_notes%&
34728 Notes from the key record (tag n=).
34729 .endlist
34730
34731 In addition, two ACL conditions are provided:
34732
34733 .vlist
34734 .vitem &%dkim_signers%&
34735 ACL condition that checks a colon-separated list of domains or identities
34736 for a match against the domain or identity that the ACL is currently verifying
34737 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
34738 verb to a group of domains or identities. For example:
34739
34740 .code
34741 # Warn when message apparently from GMail has no signature at all
34742 warn log_message = GMail sender without DKIM signature
34743      sender_domains = gmail.com
34744      dkim_signers = gmail.com
34745      dkim_status = none
34746 .endd
34747
34748 .vitem &%dkim_status%&
34749 ACL condition that checks a colon-separated list of possible DKIM verification
34750 results agains the actual result of verification. This is typically used
34751 to restrict an ACL verb to a list of verification outcomes, like:
34752
34753 .code
34754 deny message = Message from Paypal with invalid or missing signature
34755      sender_domains = paypal.com:paypal.de
34756      dkim_signers = paypal.com:paypal.de
34757      dkim_status = none:invalid:fail
34758 .endd
34759
34760 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
34761 see the documentation of the &%$dkim_verify_status%& expansion variable above
34762 for more information of what they mean.
34763 .endlist
34764
34765 . ////////////////////////////////////////////////////////////////////////////
34766 . ////////////////////////////////////////////////////////////////////////////
34767
34768 .chapter "Adding new drivers or lookup types" "CHID13" &&&
34769          "Adding drivers or lookups"
34770 .cindex "adding drivers"
34771 .cindex "new drivers, adding"
34772 .cindex "drivers" "adding new"
34773 The following actions have to be taken in order to add a new router, transport,
34774 authenticator, or lookup type to Exim:
34775
34776 .olist
34777 Choose a name for the driver or lookup type that does not conflict with any
34778 existing name; I will use &"newdriver"& in what follows.
34779 .next
34780 Add to &_src/EDITME_& the line:
34781 .display
34782 <&'type'&>&`_NEWDRIVER=yes`&
34783 .endd
34784 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
34785 code is not to be included in the binary by default, comment this line out. You
34786 should also add any relevant comments about the driver or lookup type.
34787 .next
34788 Add to &_src/config.h.defaults_& the line:
34789 .code
34790 #define <type>_NEWDRIVER
34791 .endd
34792 .next
34793 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
34794 and create a table entry as is done for all the other drivers and lookup types.
34795 .next
34796 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
34797 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
34798 driver or lookup type and add it to the definition of OBJ.
34799 .next
34800 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
34801 &_src_&.
34802 .next
34803 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
34804 as for other drivers and lookups.
34805 .endlist
34806
34807 Then all you need to do is write the code! A good way to start is to make a
34808 proforma by copying an existing module of the same type, globally changing all
34809 occurrences of the name, and cutting out most of the code. Note that any
34810 options you create must be listed in alphabetical order, because the tables are
34811 searched using a binary chop procedure.
34812
34813 There is a &_README_& file in each of the sub-directories of &_src_& describing
34814 the interface that is expected.
34815
34816
34817
34818
34819 . ////////////////////////////////////////////////////////////////////////////
34820 . ////////////////////////////////////////////////////////////////////////////
34821
34822 . /////////////////////////////////////////////////////////////////////////////
34823 . These lines are processing instructions for the Simple DocBook Processor that
34824 . Philip Hazel has developed as a less cumbersome way of making PostScript and
34825 . PDFs than using xmlto and fop. They will be ignored by all other XML
34826 . processors.
34827 . /////////////////////////////////////////////////////////////////////////////
34828
34829 .literal xml
34830 <?sdop
34831   format="newpage"
34832   foot_right_recto="&chaptertitle;"
34833   foot_right_verso="&chaptertitle;"
34834 ?>
34835 .literal off
34836
34837 .makeindex "Options index"   "option"
34838 .makeindex "Variables index" "variable"
34839 .makeindex "Concept index"   "concept"
34840
34841
34842 . /////////////////////////////////////////////////////////////////////////////
34843 . /////////////////////////////////////////////////////////////////////////////