15b3a2b896ebe271094a206a8bfb17c1a5fa0b1a
[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 .cindex "hints database"
1548 Exim makes a note in its hints database, and whenever a successful
1549 SMTP delivery has happened, it looks to see if any other messages are waiting
1550 for the same host. If any are found, they are sent over the same SMTP
1551 connection, subject to a configuration limit as to the maximum number in any
1552 one connection.
1553
1554
1555
1556
1557 .section "Permanent delivery failure" "SECID21"
1558 .cindex "delivery" "permanent failure"
1559 .cindex "bounce message" "when generated"
1560 When a message cannot be delivered to some or all of its intended recipients, a
1561 bounce message is generated. Temporary delivery failures turn into permanent
1562 errors when their timeout expires. All the addresses that fail in a given
1563 delivery attempt are listed in a single message. If the original message has
1564 many recipients, it is possible for some addresses to fail in one delivery
1565 attempt and others to fail subsequently, giving rise to more than one bounce
1566 message. The wording of bounce messages can be customized by the administrator.
1567 See chapter &<<CHAPemsgcust>>& for details.
1568
1569 .cindex "&'X-Failed-Recipients:'& header line"
1570 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1571 failed addresses, for the benefit of programs that try to analyse such messages
1572 automatically.
1573
1574 .cindex "bounce message" "recipient of"
1575 A bounce message is normally sent to the sender of the original message, as
1576 obtained from the message's envelope. For incoming SMTP messages, this is the
1577 address given in the MAIL command. However, when an address is expanded via a
1578 forward or alias file, an alternative address can be specified for delivery
1579 failures of the generated addresses. For a mailing list expansion (see section
1580 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1581 of the list.
1582
1583
1584
1585 .section "Failures to deliver bounce messages" "SECID22"
1586 .cindex "bounce message" "failure to deliver"
1587 If a bounce message (either locally generated or received from a remote host)
1588 itself suffers a permanent delivery failure, the message is left on the queue,
1589 but it is frozen, awaiting the attention of an administrator. There are options
1590 that can be used to make Exim discard such failed messages, or to keep them
1591 for only a short time (see &%timeout_frozen_after%& and
1592 &%ignore_bounce_errors_after%&).
1593
1594
1595
1596
1597
1598 . ////////////////////////////////////////////////////////////////////////////
1599 . ////////////////////////////////////////////////////////////////////////////
1600
1601 .chapter "Building and installing Exim" "CHID3"
1602 .scindex IIDbuex "building Exim"
1603
1604 .section "Unpacking" "SECID23"
1605 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1606 creates a directory with the name of the current release (for example,
1607 &_exim-&version;_&) into which the following files are placed:
1608
1609 .table2 140pt
1610 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1611 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1612   documented"
1613 .irow &_LICENCE_&         "the GNU General Public Licence"
1614 .irow &_Makefile_&        "top-level make file"
1615 .irow &_NOTICE_&          "conditions for the use of Exim"
1616 .irow &_README_&          "list of files, directories and simple build &&&
1617   instructions"
1618 .endtable
1619
1620 Other files whose names begin with &_README_& may also be present. The
1621 following subdirectories are created:
1622
1623 .table2 140pt
1624 .irow &_Local_&           "an empty directory for local configuration files"
1625 .irow &_OS_&              "OS-specific files"
1626 .irow &_doc_&             "documentation files"
1627 .irow &_exim_monitor_&    "source files for the Exim monitor"
1628 .irow &_scripts_&         "scripts used in the build process"
1629 .irow &_src_&             "remaining source files"
1630 .irow &_util_&            "independent utilities"
1631 .endtable
1632
1633 The main utility programs are contained in the &_src_& directory, and are built
1634 with the Exim binary. The &_util_& directory contains a few optional scripts
1635 that may be useful to some sites.
1636
1637
1638 .section "Multiple machine architectures and operating systems" "SECID24"
1639 .cindex "building Exim" "multiple OS/architectures"
1640 The building process for Exim is arranged to make it easy to build binaries for
1641 a number of different architectures and operating systems from the same set of
1642 source files. Compilation does not take place in the &_src_& directory.
1643 Instead, a &'build directory'& is created for each architecture and operating
1644 system.
1645 .cindex "symbolic link" "to build directory"
1646 Symbolic links to the sources are installed in this directory, which is where
1647 the actual building takes place. In most cases, Exim can discover the machine
1648 architecture and operating system for itself, but the defaults can be
1649 overridden if necessary.
1650
1651
1652 .section "PCRE library" "SECTpcre"
1653 .cindex "PCRE library"
1654 Exim no longer has an embedded PCRE library as the vast majority of
1655 modern systems include PCRE as a system library, although you may need
1656 to install the PCRE or PCRE development package for your operating
1657 system. If your system has a normal PCRE installation the Exim build
1658 process will need no further configuration. If the library or the
1659 headers are in an unusual location you will need to set the PCRE_LIBS
1660 and INCLUDE directives appropriately. If your operating system has no
1661 PCRE support then you will need to obtain and build the current PCRE
1662 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1663
1664 .section "DBM libraries" "SECTdb"
1665 .cindex "DBM libraries" "discussion of"
1666 .cindex "hints database" "DBM files used for"
1667 Even if you do not use any DBM files in your configuration, Exim still needs a
1668 DBM library in order to operate, because it uses indexed files for its hints
1669 databases. Unfortunately, there are a number of DBM libraries in existence, and
1670 different operating systems often have different ones installed.
1671
1672 .cindex "Solaris" "DBM library for"
1673 .cindex "IRIX, DBM library for"
1674 .cindex "BSD, DBM library for"
1675 .cindex "Linux, DBM library for"
1676 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1677 Linux distribution, the DBM configuration should happen automatically, and you
1678 may be able to ignore this section. Otherwise, you may have to learn more than
1679 you would like about DBM libraries from what follows.
1680
1681 .cindex "&'ndbm'& DBM library"
1682 Licensed versions of Unix normally contain a library of DBM functions operating
1683 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1684 versions of Unix seem to vary in what they contain as standard. In particular,
1685 some early versions of Linux have no default DBM library, and different
1686 distributors have chosen to bundle different libraries with their packaged
1687 versions. However, the more recent releases seem to have standardized on the
1688 Berkeley DB library.
1689
1690 Different DBM libraries have different conventions for naming the files they
1691 use. When a program opens a file called &_dbmfile_&, there are several
1692 possibilities:
1693
1694 .olist
1695 A traditional &'ndbm'& implementation, such as that supplied as part of
1696 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1697 .next
1698 .cindex "&'gdbm'& DBM library"
1699 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1700 compatibility interface it makes two different hard links to it with names
1701 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1702 file name is used unmodified.
1703 .next
1704 .cindex "Berkeley DB library"
1705 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1706 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1707 programmer exactly the same as the traditional &'ndbm'& implementation.
1708 .next
1709 If the Berkeley package is used in its native mode, it operates on a single
1710 file called &_dbmfile_&; the programmer's interface is somewhat different to
1711 the traditional &'ndbm'& interface.
1712 .next
1713 To complicate things further, there are several very different versions of the
1714 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1715 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1716 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1717 versions of Berkeley DB can be obtained from
1718 &url(http://www.sleepycat.com/).
1719 .next
1720 .cindex "&'tdb'& DBM library"
1721 Yet another DBM library, called &'tdb'&, is available from
1722 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1723 operates on a single file.
1724 .endlist
1725
1726 .cindex "USE_DB"
1727 .cindex "DBM libraries" "configuration for building"
1728 Exim and its utilities can be compiled to use any of these interfaces. In order
1729 to use any version of the Berkeley DB package in native mode, you must set
1730 USE_DB in an appropriate configuration file (typically
1731 &_Local/Makefile_&). For example:
1732 .code
1733 USE_DB=yes
1734 .endd
1735 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1736 error is diagnosed if you set more than one of these.
1737
1738 At the lowest level, the build-time configuration sets none of these options,
1739 thereby assuming an interface of type (1). However, some operating system
1740 configuration files (for example, those for the BSD operating systems and
1741 Linux) assume type (4) by setting USE_DB as their default, and the
1742 configuration files for Cygwin set USE_GDBM. Anything you set in
1743 &_Local/Makefile_&, however, overrides these system defaults.
1744
1745 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1746 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1747 in one of these lines:
1748 .code
1749 DBMLIB = -ldb
1750 DBMLIB = -ltdb
1751 .endd
1752 Settings like that will work if the DBM library is installed in the standard
1753 place. Sometimes it is not, and the library's header file may also not be in
1754 the default path. You may need to set INCLUDE to specify where the header
1755 file is, and to specify the path to the library more fully in DBMLIB, as in
1756 this example:
1757 .code
1758 INCLUDE=-I/usr/local/include/db-4.1
1759 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1760 .endd
1761 There is further detailed discussion about the various DBM libraries in the
1762 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1763
1764
1765
1766 .section "Pre-building configuration" "SECID25"
1767 .cindex "building Exim" "pre-building configuration"
1768 .cindex "configuration for building Exim"
1769 .cindex "&_Local/Makefile_&"
1770 .cindex "&_src/EDITME_&"
1771 Before building Exim, a local configuration file that specifies options
1772 independent of any operating system has to be created with the name
1773 &_Local/Makefile_&. A template for this file is supplied as the file
1774 &_src/EDITME_&, and it contains full descriptions of all the option settings
1775 therein. These descriptions are therefore not repeated here. If you are
1776 building Exim for the first time, the simplest thing to do is to copy
1777 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1778
1779 There are three settings that you must supply, because Exim will not build
1780 without them. They are the location of the run time configuration file
1781 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1782 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1783 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1784 a colon-separated list of file names; Exim uses the first of them that exists.
1785
1786 There are a few other parameters that can be specified either at build time or
1787 at run time, to enable the same binary to be used on a number of different
1788 machines. However, if the locations of Exim's spool directory and log file
1789 directory (if not within the spool directory) are fixed, it is recommended that
1790 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1791 detected early in Exim's execution (such as a malformed configuration file) can
1792 be logged.
1793
1794 .cindex "content scanning" "specifying at build time"
1795 Exim's interfaces for calling virus and spam scanning software directly from
1796 access control lists are not compiled by default. If you want to include these
1797 facilities, you need to set
1798 .code
1799 WITH_CONTENT_SCAN=yes
1800 .endd
1801 in your &_Local/Makefile_&. For details of the facilities themselves, see
1802 chapter &<<CHAPexiscan>>&.
1803
1804
1805 .cindex "&_Local/eximon.conf_&"
1806 .cindex "&_exim_monitor/EDITME_&"
1807 If you are going to build the Exim monitor, a similar configuration process is
1808 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1809 your installation and saved under the name &_Local/eximon.conf_&. If you are
1810 happy with the default settings described in &_exim_monitor/EDITME_&,
1811 &_Local/eximon.conf_& can be empty, but it must exist.
1812
1813 This is all the configuration that is needed in straightforward cases for known
1814 operating systems. However, the building process is set up so that it is easy
1815 to override options that are set by default or by operating-system-specific
1816 configuration files, for example to change the name of the C compiler, which
1817 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1818 do this.
1819
1820
1821
1822 .section "Support for iconv()" "SECID26"
1823 .cindex "&[iconv()]& support"
1824 .cindex "RFC 2047"
1825 The contents of header lines in messages may be encoded according to the rules
1826 described RFC 2047. This makes it possible to transmit characters that are not
1827 in the ASCII character set, and to label them as being in a particular
1828 character set. When Exim is inspecting header lines by means of the &%$h_%&
1829 mechanism, it decodes them, and translates them into a specified character set
1830 (default ISO-8859-1). The translation is possible only if the operating system
1831 supports the &[iconv()]& function.
1832
1833 However, some of the operating systems that supply &[iconv()]& do not support
1834 very many conversions. The GNU &%libiconv%& library (available from
1835 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1836 systems to remedy this deficiency, as well as on systems that do not supply
1837 &[iconv()]& at all. After installing &%libiconv%&, you should add
1838 .code
1839 HAVE_ICONV=yes
1840 .endd
1841 to your &_Local/Makefile_& and rebuild Exim.
1842
1843
1844
1845 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1846 .cindex "TLS" "including support for TLS"
1847 .cindex "encryption" "including support for"
1848 .cindex "SUPPORT_TLS"
1849 .cindex "OpenSSL" "building Exim with"
1850 .cindex "GnuTLS" "building Exim with"
1851 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1852 command as per RFC 2487. It can also support legacy clients that expect to
1853 start a TLS session immediately on connection to a non-standard port (see the
1854 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1855 line option).
1856
1857 If you want to build Exim with TLS support, you must first install either the
1858 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1859 implementing SSL.
1860
1861 If OpenSSL is installed, you should set
1862 .code
1863 SUPPORT_TLS=yes
1864 TLS_LIBS=-lssl -lcrypto
1865 .endd
1866 in &_Local/Makefile_&. You may also need to specify the locations of the
1867 OpenSSL library and include files. For example:
1868 .code
1869 SUPPORT_TLS=yes
1870 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1871 TLS_INCLUDE=-I/usr/local/openssl/include/
1872 .endd
1873 .cindex "USE_GNUTLS"
1874 If GnuTLS is installed, you should set
1875 .code
1876 SUPPORT_TLS=yes
1877 USE_GNUTLS=yes
1878 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1879 .endd
1880 in &_Local/Makefile_&, and again you may need to specify the locations of the
1881 library and include files. For example:
1882 .code
1883 SUPPORT_TLS=yes
1884 USE_GNUTLS=yes
1885 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1886 TLS_INCLUDE=-I/usr/gnu/include
1887 .endd
1888 You do not need to set TLS_INCLUDE if the relevant directory is already
1889 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1890 given in chapter &<<CHAPTLS>>&.
1891
1892
1893
1894
1895 .section "Use of tcpwrappers" "SECID27"
1896 .new
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 .wen
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 "Dynamically loaded lookup module support" "SECTdynamicmodules"
1950 .cindex "lookup modules"
1951 .cindex "dynamic modules"
1952 .cindex ".so building"
1953 On some platforms, Exim supports not compiling all lookup types directly into
1954 the main binary, instead putting some into external modules which can be loaded
1955 on demand.
1956 This permits packagers to build Exim with support for lookups with extensive
1957 library dependencies without requiring all users to install all of those
1958 dependencies.
1959 Most, but not all, lookup types can be built this way.
1960
1961 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
1962 installed; Exim will only load modules from that directory, as a security
1963 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
1964 for your OS; see &_OS/Makefile-Linux_& for an example.
1965 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
1966 see &_src/EDITME_& for details.
1967
1968 Then, for each module to be loaded dynamically, define the relevant
1969 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
1970 For example, this will build in lsearch but load sqlite and mysql support
1971 on demand:
1972 .code
1973 LOOKUP_LSEARCH=yes
1974 LOOKUP_SQLITE=2
1975 LOOKUP_MYSQL=2
1976 .endd
1977
1978
1979 .section "The building process" "SECID29"
1980 .cindex "build directory"
1981 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
1982 created, run &'make'& at the top level. It determines the architecture and
1983 operating system types, and creates a build directory if one does not exist.
1984 For example, on a Sun system running Solaris 8, the directory
1985 &_build-SunOS5-5.8-sparc_& is created.
1986 .cindex "symbolic link" "to source files"
1987 Symbolic links to relevant source files are installed in the build directory.
1988
1989 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
1990 building process fails if it is set.
1991
1992 If this is the first time &'make'& has been run, it calls a script that builds
1993 a make file inside the build directory, using the configuration files from the
1994 &_Local_& directory. The new make file is then passed to another instance of
1995 &'make'&. This does the real work, building a number of utility scripts, and
1996 then compiling and linking the binaries for the Exim monitor (if configured), a
1997 number of utility programs, and finally Exim itself. The command &`make
1998 makefile`& can be used to force a rebuild of the make file in the build
1999 directory, should this ever be necessary.
2000
2001 If you have problems building Exim, check for any comments there may be in the
2002 &_README_& file concerning your operating system, and also take a look at the
2003 FAQ, where some common problems are covered.
2004
2005
2006
2007 .section 'Output from &"make"&' "SECID283"
2008 The output produced by the &'make'& process for compile lines is often very
2009 unreadable, because these lines can be very long. For this reason, the normal
2010 output is suppressed by default, and instead output similar to that which
2011 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2012 each module that is being compiled or linked. However, it is still possible to
2013 get the full output, by calling &'make'& like this:
2014 .code
2015 FULLECHO='' make -e
2016 .endd
2017 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2018 command reflection in &'make'&. When you ask for the full output, it is
2019 given in addition to the short output.
2020
2021
2022
2023 .section "Overriding build-time options for Exim" "SECToverride"
2024 .cindex "build-time options, overriding"
2025 The main make file that is created at the beginning of the building process
2026 consists of the concatenation of a number of files which set configuration
2027 values, followed by a fixed set of &'make'& instructions. If a value is set
2028 more than once, the last setting overrides any previous ones. This provides a
2029 convenient way of overriding defaults. The files that are concatenated are, in
2030 order:
2031 .display
2032 &_OS/Makefile-Default_&
2033 &_OS/Makefile-_&<&'ostype'&>
2034 &_Local/Makefile_&
2035 &_Local/Makefile-_&<&'ostype'&>
2036 &_Local/Makefile-_&<&'archtype'&>
2037 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2038 &_OS/Makefile-Base_&
2039 .endd
2040 .cindex "&_Local/Makefile_&"
2041 .cindex "building Exim" "operating system type"
2042 .cindex "building Exim" "architecture type"
2043 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2044 architecture type. &_Local/Makefile_& is required to exist, and the building
2045 process fails if it is absent. The other three &_Local_& files are optional,
2046 and are often not needed.
2047
2048 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2049 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2050 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2051 values are used, thereby providing a means of forcing particular settings.
2052 Otherwise, the scripts try to get values from the &%uname%& command. If this
2053 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2054 of &'ad hoc'& transformations are then applied, to produce the standard names
2055 that Exim expects. You can run these scripts directly from the shell in order
2056 to find out what values are being used on your system.
2057
2058
2059 &_OS/Makefile-Default_& contains comments about the variables that are set
2060 therein. Some (but not all) are mentioned below. If there is something that
2061 needs changing, review the contents of this file and the contents of the make
2062 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2063 default values are.
2064
2065
2066 .cindex "building Exim" "overriding default settings"
2067 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2068 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2069 need to change the original files. Instead, you should make the changes by
2070 putting the new values in an appropriate &_Local_& file. For example,
2071 .cindex "Tru64-Unix build-time settings"
2072 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2073 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2074 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2075 called with the option &%-std1%&, to make it recognize some of the features of
2076 Standard C that Exim uses. (Most other compilers recognize Standard C by
2077 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2078 containing the lines
2079 .code
2080 CC=cc
2081 CFLAGS=-std1
2082 .endd
2083 If you are compiling for just one operating system, it may be easier to put
2084 these lines directly into &_Local/Makefile_&.
2085
2086 Keeping all your local configuration settings separate from the distributed
2087 files makes it easy to transfer them to new versions of Exim simply by copying
2088 the contents of the &_Local_& directory.
2089
2090
2091 .cindex "NIS lookup type" "including support for"
2092 .cindex "NIS+ lookup type" "including support for"
2093 .cindex "LDAP" "including support for"
2094 .cindex "lookup" "inclusion in binary"
2095 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2096 lookup, but not all systems have these components installed, so the default is
2097 not to include the relevant code in the binary. All the different kinds of file
2098 and database lookup that Exim supports are implemented as separate code modules
2099 which are included only if the relevant compile-time options are set. In the
2100 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2101 .code
2102 LOOKUP_LDAP=yes
2103 LOOKUP_NIS=yes
2104 LOOKUP_NISPLUS=yes
2105 .endd
2106 and similar settings apply to the other lookup types. They are all listed in
2107 &_src/EDITME_&. In many cases the relevant include files and interface
2108 libraries need to be installed before compiling Exim.
2109 .cindex "cdb" "including support for"
2110 However, there are some optional lookup types (such as cdb) for which
2111 the code is entirely contained within Exim, and no external include
2112 files or libraries are required. When a lookup type is not included in the
2113 binary, attempts to configure Exim to use it cause run time configuration
2114 errors.
2115
2116 .cindex "Perl" "including support for"
2117 Exim can be linked with an embedded Perl interpreter, allowing Perl
2118 subroutines to be called during string expansion. To enable this facility,
2119 .code
2120 EXIM_PERL=perl.o
2121 .endd
2122 must be defined in &_Local/Makefile_&. Details of this facility are given in
2123 chapter &<<CHAPperl>>&.
2124
2125 .cindex "X11 libraries, location of"
2126 The location of the X11 libraries is something that varies a lot between
2127 operating systems, and there may be different versions of X11 to cope
2128 with. Exim itself makes no use of X11, but if you are compiling the Exim
2129 monitor, the X11 libraries must be available.
2130 The following three variables are set in &_OS/Makefile-Default_&:
2131 .code
2132 X11=/usr/X11R6
2133 XINCLUDE=-I$(X11)/include
2134 XLFLAGS=-L$(X11)/lib
2135 .endd
2136 These are overridden in some of the operating-system configuration files. For
2137 example, in &_OS/Makefile-SunOS5_& there is
2138 .code
2139 X11=/usr/openwin
2140 XINCLUDE=-I$(X11)/include
2141 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2142 .endd
2143 If you need to override the default setting for your operating system, place a
2144 definition of all three of these variables into your
2145 &_Local/Makefile-<ostype>_& file.
2146
2147 .cindex "EXTRALIBS"
2148 If you need to add any extra libraries to the link steps, these can be put in a
2149 variable called EXTRALIBS, which appears in all the link commands, but by
2150 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2151 command for linking the main Exim binary, and not for any associated utilities.
2152
2153 .cindex "DBM libraries" "configuration for building"
2154 There is also DBMLIB, which appears in the link commands for binaries that
2155 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2156 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2157 binary, and which can be used, for example, to include additional X11
2158 libraries.
2159
2160 .cindex "configuration file" "editing"
2161 The make file copes with rebuilding Exim correctly if any of the configuration
2162 files are edited. However, if an optional configuration file is deleted, it is
2163 necessary to touch the associated non-optional file (that is,
2164 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2165
2166
2167 .section "OS-specific header files" "SECID30"
2168 .cindex "&_os.h_&"
2169 .cindex "building Exim" "OS-specific C header files"
2170 The &_OS_& directory contains a number of files with names of the form
2171 &_os.h-<ostype>_&. These are system-specific C header files that should not
2172 normally need to be changed. There is a list of macro settings that are
2173 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2174 are porting Exim to a new operating system.
2175
2176
2177
2178 .section "Overriding build-time options for the monitor" "SECID31"
2179 .cindex "building Eximon"
2180 A similar process is used for overriding things when building the Exim monitor,
2181 where the files that are involved are
2182 .display
2183 &_OS/eximon.conf-Default_&
2184 &_OS/eximon.conf-_&<&'ostype'&>
2185 &_Local/eximon.conf_&
2186 &_Local/eximon.conf-_&<&'ostype'&>
2187 &_Local/eximon.conf-_&<&'archtype'&>
2188 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2189 .endd
2190 .cindex "&_Local/eximon.conf_&"
2191 As with Exim itself, the final three files need not exist, and in this case the
2192 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2193 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2194 variables of the same name, preceded by EXIMON_. For example, setting
2195 EXIMON_LOG_DEPTH in the environment overrides the value of
2196 LOG_DEPTH at run time.
2197 .ecindex IIDbuex
2198
2199
2200 .section "Installing Exim binaries and scripts" "SECID32"
2201 .cindex "installing Exim"
2202 .cindex "BIN_DIRECTORY"
2203 The command &`make install`& runs the &(exim_install)& script with no
2204 arguments. The script copies binaries and utility scripts into the directory
2205 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2206 .cindex "setuid" "installing Exim with"
2207 The install script copies files only if they are newer than the files they are
2208 going to replace. The Exim binary is required to be owned by root and have the
2209 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2210 install`& as root so that it can set up the Exim binary in this way. However, in
2211 some special situations (for example, if a host is doing no local deliveries)
2212 it may be possible to run Exim without making the binary setuid root (see
2213 chapter &<<CHAPsecurity>>& for details).
2214
2215 .cindex "CONFIGURE_FILE"
2216 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2217 in &_Local/Makefile_&. If this names a single file, and the file does not
2218 exist, the default configuration file &_src/configure.default_& is copied there
2219 by the installation script. If a run time configuration file already exists, it
2220 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2221 alternative files, no default is installed.
2222
2223 .cindex "system aliases file"
2224 .cindex "&_/etc/aliases_&"
2225 One change is made to the default configuration file when it is installed: the
2226 default configuration contains a router that references a system aliases file.
2227 The path to this file is set to the value specified by
2228 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2229 If the system aliases file does not exist, the installation script creates it,
2230 and outputs a comment to the user.
2231
2232 The created file contains no aliases, but it does contain comments about the
2233 aliases a site should normally have. Mail aliases have traditionally been
2234 kept in &_/etc/aliases_&. However, some operating systems are now using
2235 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2236 Exim's configuration if necessary.
2237
2238 The default configuration uses the local host's name as the only local domain,
2239 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2240 running as the local user. System aliases and &_.forward_& files in users' home
2241 directories are supported, but no NIS or NIS+ support is configured. Domains
2242 other than the name of the local host are routed using the DNS, with delivery
2243 over SMTP.
2244
2245 It is possible to install Exim for special purposes (such as building a binary
2246 distribution) in a private part of the file system. You can do this by a
2247 command such as
2248 .code
2249 make DESTDIR=/some/directory/ install
2250 .endd
2251 This has the effect of pre-pending the specified directory to all the file
2252 paths, except the name of the system aliases file that appears in the default
2253 configuration. (If a default alias file is created, its name &'is'& modified.)
2254 For backwards compatibility, ROOT is used if DESTDIR is not set,
2255 but this usage is deprecated.
2256
2257 .cindex "installing Exim" "what is not installed"
2258 Running &'make install'& does not copy the Exim 4 conversion script
2259 &'convert4r4'&. You will probably run this only once if you are
2260 upgrading from Exim 3. None of the documentation files in the &_doc_&
2261 directory are copied, except for the info files when you have set
2262 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2263
2264 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2265 to their names. The Exim binary itself, however, is handled differently. It is
2266 installed under a name that includes the version number and the compile number,
2267 for example &_exim-&version;-1_&. The script then arranges for a symbolic link
2268 called &_exim_& to point to the binary. If you are updating a previous version
2269 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2270 from the directory (as seen by other processes).
2271
2272 .cindex "installing Exim" "testing the script"
2273 If you want to see what the &'make install'& will do before running it for
2274 real, you can pass the &%-n%& option to the installation script by this
2275 command:
2276 .code
2277 make INSTALL_ARG=-n install
2278 .endd
2279 The contents of the variable INSTALL_ARG are passed to the installation
2280 script. You do not need to be root to run this test. Alternatively, you can run
2281 the installation script directly, but this must be from within the build
2282 directory. For example, from the top-level Exim directory you could use this
2283 command:
2284 .code
2285 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2286 .endd
2287 .cindex "installing Exim" "install script options"
2288 There are two other options that can be supplied to the installation script.
2289
2290 .ilist
2291 &%-no_chown%& bypasses the call to change the owner of the installed binary
2292 to root, and the call to make it a setuid binary.
2293 .next
2294 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2295 installed binary.
2296 .endlist
2297
2298 INSTALL_ARG can be used to pass these options to the script. For example:
2299 .code
2300 make INSTALL_ARG=-no_symlink install
2301 .endd
2302 The installation script can also be given arguments specifying which files are
2303 to be copied. For example, to install just the Exim binary, and nothing else,
2304 without creating the symbolic link, you could use:
2305 .code
2306 make INSTALL_ARG='-no_symlink exim' install
2307 .endd
2308
2309
2310
2311 .section "Installing info documentation" "SECTinsinfdoc"
2312 .cindex "installing Exim" "&'info'& documentation"
2313 Not all systems use the GNU &'info'& system for documentation, and for this
2314 reason, the Texinfo source of Exim's documentation is not included in the main
2315 distribution. Instead it is available separately from the ftp site (see section
2316 &<<SECTavail>>&).
2317
2318 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2319 source of the documentation is found in the source tree, running &`make
2320 install`& automatically builds the info files and installs them.
2321
2322
2323
2324 .section "Setting up the spool directory" "SECID33"
2325 .cindex "spool directory" "creating"
2326 When it starts up, Exim tries to create its spool directory if it does not
2327 exist. The Exim uid and gid are used for the owner and group of the spool
2328 directory. Sub-directories are automatically created in the spool directory as
2329 necessary.
2330
2331
2332
2333
2334 .section "Testing" "SECID34"
2335 .cindex "testing" "installation"
2336 Having installed Exim, you can check that the run time configuration file is
2337 syntactically valid by running the following command, which assumes that the
2338 Exim binary directory is within your PATH environment variable:
2339 .code
2340 exim -bV
2341 .endd
2342 If there are any errors in the configuration file, Exim outputs error messages.
2343 Otherwise it outputs the version number and build date,
2344 the DBM library that is being used, and information about which drivers and
2345 other optional code modules are included in the binary.
2346 Some simple routing tests can be done by using the address testing option. For
2347 example,
2348 .display
2349 &`exim -bt`& <&'local username'&>
2350 .endd
2351 should verify that it recognizes a local mailbox, and
2352 .display
2353 &`exim -bt`& <&'remote address'&>
2354 .endd
2355 a remote one. Then try getting it to deliver mail, both locally and remotely.
2356 This can be done by passing messages directly to Exim, without going through a
2357 user agent. For example:
2358 .code
2359 exim -v postmaster@your.domain.example
2360 From: user@your.domain.example
2361 To: postmaster@your.domain.example
2362 Subject: Testing Exim
2363
2364 This is a test message.
2365 ^D
2366 .endd
2367 The &%-v%& option causes Exim to output some verification of what it is doing.
2368 In this case you should see copies of three log lines, one for the message's
2369 arrival, one for its delivery, and one containing &"Completed"&.
2370
2371 .cindex "delivery" "problems with"
2372 If you encounter problems, look at Exim's log files (&'mainlog'& and
2373 &'paniclog'&) to see if there is any relevant information there. Another source
2374 of information is running Exim with debugging turned on, by specifying the
2375 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2376 with debugging turned on by a command of the form
2377 .display
2378 &`exim -d -M`& <&'exim-message-id'&>
2379 .endd
2380 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2381 produces rather a lot of output, but you can cut this down to specific areas.
2382 For example, if you use &%-d-all+route%& only the debugging information
2383 relevant to routing is included. (See the &%-d%& option in chapter
2384 &<<CHAPcommandline>>& for more details.)
2385
2386 .cindex '&"sticky"& bit'
2387 .cindex "lock files"
2388 One specific problem that has shown up on some sites is the inability to do
2389 local deliveries into a shared mailbox directory, because it does not have the
2390 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2391 writing to a mailbox file, and if it cannot create the lock file, the delivery
2392 is deferred. You can get round this either by setting the &"sticky bit"& on the
2393 directory, or by setting a specific group for local deliveries and allowing
2394 that group to create files in the directory (see the comments above the
2395 &(local_delivery)& transport in the default configuration file). Another
2396 approach is to configure Exim not to use lock files, but just to rely on
2397 &[fcntl()]& locking instead. However, you should do this only if all user
2398 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2399 see chapter &<<CHAPappendfile>>&.
2400
2401 One thing that cannot be tested on a system that is already running an MTA is
2402 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2403 &%-oX%& option can be used to run an Exim daemon that listens on some other
2404 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2405 &'exim_checkaccess'& utility can be used to check out policy controls on
2406 incoming SMTP mail.
2407
2408 Testing a new version on a system that is already running Exim can most easily
2409 be done by building a binary with a different CONFIGURE_FILE setting. From
2410 within the run time configuration, all other file and directory names
2411 that Exim uses can be altered, in order to keep it entirely clear of the
2412 production version.
2413
2414
2415 .section "Replacing another MTA with Exim" "SECID35"
2416 .cindex "replacing another MTA"
2417 Building and installing Exim for the first time does not of itself put it in
2418 general use. The name by which the system's MTA is called by mail user agents
2419 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2420 operating system), and it is necessary to make this name point to the &'exim'&
2421 binary in order to get the user agents to pass messages to Exim. This is
2422 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2423 or &_/usr/lib/sendmail_&
2424 .cindex "symbolic link" "to &'exim'& binary"
2425 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2426 privilege and executable status from the old MTA. It is then necessary to stop
2427 and restart the mailer daemon, if one is running.
2428
2429 .cindex "FreeBSD, MTA indirection"
2430 .cindex "&_/etc/mail/mailer.conf_&"
2431 Some operating systems have introduced alternative ways of switching MTAs. For
2432 example, if you are running FreeBSD, you need to edit the file
2433 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2434 described. A typical example of the contents of this file for running Exim is
2435 as follows:
2436 .code
2437 sendmail            /usr/exim/bin/exim
2438 send-mail           /usr/exim/bin/exim
2439 mailq               /usr/exim/bin/exim -bp
2440 newaliases          /usr/bin/true
2441 .endd
2442 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2443 your Exim installation is &"live"&. Check it by sending a message from your
2444 favourite user agent.
2445
2446 You should consider what to tell your users about the change of MTA. Exim may
2447 have different capabilities to what was previously running, and there are
2448 various operational differences such as the text of messages produced by
2449 command line options and in bounce messages. If you allow your users to make
2450 use of Exim's filtering capabilities, you should make the document entitled
2451 &'Exim's interface to mail filtering'& available to them.
2452
2453
2454
2455 .section "Upgrading Exim" "SECID36"
2456 .cindex "upgrading Exim"
2457 If you are already running Exim on your host, building and installing a new
2458 version automatically makes it available to MUAs, or any other programs that
2459 call the MTA directly. However, if you are running an Exim daemon, you do need
2460 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2461 new binary. You do not need to stop processing mail in order to install a new
2462 version of Exim. The install script does not modify an existing runtime
2463 configuration file.
2464
2465
2466
2467
2468 .section "Stopping the Exim daemon on Solaris" "SECID37"
2469 .cindex "Solaris" "stopping Exim on"
2470 The standard command for stopping the mailer daemon on Solaris is
2471 .code
2472 /etc/init.d/sendmail stop
2473 .endd
2474 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2475 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2476 for the text &"sendmail"&; this is not present because the actual program name
2477 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2478 solution is to replace the line that finds the process id with something like
2479 .code
2480 pid=`cat /var/spool/exim/exim-daemon.pid`
2481 .endd
2482 to obtain the daemon's pid directly from the file that Exim saves it in.
2483
2484 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2485 still be received from local processes, and if automatic delivery is configured
2486 (the normal case), deliveries will still occur.
2487
2488
2489
2490
2491 . ////////////////////////////////////////////////////////////////////////////
2492 . ////////////////////////////////////////////////////////////////////////////
2493
2494 .chapter "The Exim command line" "CHAPcommandline"
2495 .scindex IIDclo1 "command line" "options"
2496 .scindex IIDclo2 "options" "command line"
2497 Exim's command line takes the standard Unix form of a sequence of options,
2498 each starting with a hyphen character, followed by a number of arguments. The
2499 options are compatible with the main options of Sendmail, and there are also
2500 some additional options, some of which are compatible with Smail 3. Certain
2501 combinations of options do not make sense, and provoke an error if used.
2502 The form of the arguments depends on which options are set.
2503
2504
2505 .section "Setting options by program name" "SECID38"
2506 .cindex "&'mailq'&"
2507 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2508 were present before any other options.
2509 The &%-bp%& option requests a listing of the contents of the mail queue on the
2510 standard output.
2511 This feature is for compatibility with some systems that contain a command of
2512 that name in one of the standard libraries, symbolically linked to
2513 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2514
2515 .cindex "&'rsmtp'&"
2516 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2517 were present before any other options, for compatibility with Smail. The
2518 &%-bS%& option is used for reading in a number of messages in batched SMTP
2519 format.
2520
2521 .cindex "&'rmail'&"
2522 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2523 &%-oee%& options were present before any other options, for compatibility with
2524 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2525
2526 .cindex "&'runq'&"
2527 .cindex "queue runner"
2528 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2529 were present before any other options, for compatibility with Smail. The &%-q%&
2530 option causes a single queue runner process to be started.
2531
2532 .cindex "&'newaliases'&"
2533 .cindex "alias file" "building"
2534 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2535 If Exim is called under the name &'newaliases'& it behaves as if the option
2536 &%-bi%& were present before any other options, for compatibility with Sendmail.
2537 This option is used for rebuilding Sendmail's alias file. Exim does not have
2538 the concept of a single alias file, but can be configured to run a given
2539 command if called with the &%-bi%& option.
2540
2541
2542 .section "Trusted and admin users" "SECTtrustedadmin"
2543 Some Exim options are available only to &'trusted users'& and others are
2544 available only to &'admin users'&. In the description below, the phrases &"Exim
2545 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2546 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2547 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2548
2549 .ilist
2550 .cindex "trusted users" "definition of"
2551 .cindex "user" "trusted definition of"
2552 The trusted users are root, the Exim user, any user listed in the
2553 &%trusted_users%& configuration option, and any user whose current group or any
2554 supplementary group is one of those listed in the &%trusted_groups%&
2555 configuration option. Note that the Exim group is not automatically trusted.
2556
2557 .cindex '&"From"& line'
2558 .cindex "envelope sender"
2559 Trusted users are always permitted to use the &%-f%& option or a leading
2560 &"From&~"& line to specify the envelope sender of a message that is passed to
2561 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2562 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2563 users to set envelope senders.
2564
2565 .cindex "&'From:'& header line"
2566 .cindex "&'Sender:'& header line"
2567 For a trusted user, there is never any check on the contents of the &'From:'&
2568 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2569 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2570
2571 Trusted users may also specify a host name, host address, interface address,
2572 protocol name, ident value, and authentication data when submitting a message
2573 locally. Thus, they are able to insert messages into Exim's queue locally that
2574 have the characteristics of messages received from a remote host. Untrusted
2575 users may in some circumstances use &%-f%&, but can never set the other values
2576 that are available to trusted users.
2577 .next
2578 .cindex "user" "admin definition of"
2579 .cindex "admin user" "definition of"
2580 The admin users are root, the Exim user, and any user that is a member of the
2581 Exim group or of any group listed in the &%admin_groups%& configuration option.
2582 The current group does not have to be one of these groups.
2583
2584 Admin users are permitted to list the queue, and to carry out certain
2585 operations on messages, for example, to force delivery failures. It is also
2586 necessary to be an admin user in order to see the full information provided by
2587 the Exim monitor, and full debugging output.
2588
2589 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2590 Exim to attempt delivery of messages on its queue is restricted to admin users.
2591 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2592 option false (that is, specifying &%no_prod_requires_admin%&).
2593
2594 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2595 is restricted to admin users unless &%queue_list_requires_admin%& is set
2596 false.
2597 .endlist
2598
2599
2600 &*Warning*&: If you configure your system so that admin users are able to
2601 edit Exim's configuration file, you are giving those users an easy way of
2602 getting root. There is further discussion of this issue at the start of chapter
2603 &<<CHAPconf>>&.
2604
2605
2606
2607
2608 .section "Command line options" "SECID39"
2609 Exim's command line options are described in alphabetical order below. If none
2610 of the options that specifies a specific action (such as starting the daemon or
2611 a queue runner, or testing an address, or receiving a message in a specific
2612 format, or listing the queue) are present, and there is at least one argument
2613 on the command line, &%-bm%& (accept a local message on the standard input,
2614 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2615 outputs a brief message about itself and exits.
2616
2617 . ////////////////////////////////////////////////////////////////////////////
2618 . Insert a stylized XML comment here, to identify the start of the command line
2619 . options. This is for the benefit of the Perl script that automatically
2620 . creates a man page for the options.
2621 . ////////////////////////////////////////////////////////////////////////////
2622
2623 .literal xml
2624 <!-- === Start of command line options === -->
2625 .literal off
2626
2627
2628 .vlist
2629 .vitem &%--%&
2630 .oindex "--"
2631 .cindex "options" "command line; terminating"
2632 This is a pseudo-option whose only purpose is to terminate the options and
2633 therefore to cause subsequent command line items to be treated as arguments
2634 rather than options, even if they begin with hyphens.
2635
2636 .vitem &%--help%&
2637 .oindex "&%--help%&"
2638 This option causes Exim to output a few sentences stating what it is.
2639 The same output is generated if the Exim binary is called with no options and
2640 no arguments.
2641
2642 .new
2643 .vitem &%--version%&
2644 .oindex "&%--version%&"
2645 This option is an alias for &%-bV%& and causes version information to be
2646 displayed.
2647 .wen
2648
2649 .vitem &%-B%&<&'type'&>
2650 .oindex "&%-B%&"
2651 .cindex "8-bit characters"
2652 .cindex "Sendmail compatibility" "8-bit characters"
2653 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2654 clean; it ignores this option.
2655
2656 .vitem &%-bd%&
2657 .oindex "&%-bd%&"
2658 .cindex "daemon"
2659 .cindex "SMTP" "listener"
2660 .cindex "queue runner"
2661 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2662 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2663 that the daemon should also initiate periodic queue runs.
2664
2665 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2666 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2667 disconnect from the controlling terminal. When running this way, it can be
2668 stopped by pressing ctrl-C.
2669
2670 By default, Exim listens for incoming connections to the standard SMTP port on
2671 all the host's running interfaces. However, it is possible to listen on other
2672 ports, on multiple ports, and only on specific interfaces. Chapter
2673 &<<CHAPinterfaces>>& contains a description of the options that control this.
2674
2675 When a listening daemon
2676 .cindex "daemon" "process id (pid)"
2677 .cindex "pid (process id)" "of daemon"
2678 is started without the use of &%-oX%& (that is, without overriding the normal
2679 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2680 in Exim's spool directory. This location can be overridden by setting
2681 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2682 running as root.
2683
2684 When &%-oX%& is used on the command line to start a listening daemon, the
2685 process id is not written to the normal pid file path. However, &%-oP%& can be
2686 used to specify a path on the command line if a pid file is required.
2687
2688 The SIGHUP signal
2689 .cindex "SIGHUP"
2690 .cindex "daemon" "restarting"
2691 can be used to cause the daemon to re-execute itself. This should be done
2692 whenever Exim's configuration file, or any file that is incorporated into it by
2693 means of the &%.include%& facility, is changed, and also whenever a new version
2694 of Exim is installed. It is not necessary to do this when other files that are
2695 referenced from the configuration (for example, alias files) are changed,
2696 because these are reread each time they are used.
2697
2698 .vitem &%-bdf%&
2699 .oindex "&%-bdf%&"
2700 This option has the same effect as &%-bd%& except that it never disconnects
2701 from the controlling terminal, even when no debugging is specified.
2702
2703 .vitem &%-be%&
2704 .oindex "&%-be%&"
2705 .cindex "testing" "string expansion"
2706 .cindex "expansion" "testing"
2707 Run Exim in expansion testing mode. Exim discards its root privilege, to
2708 prevent ordinary users from using this mode to read otherwise inaccessible
2709 files. If no arguments are given, Exim runs interactively, prompting for lines
2710 of data. Otherwise, it processes each argument in turn.
2711
2712 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2713 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2714 used without command line arguments. If successful, it uses the &[readline()]&
2715 function, which provides extensive line-editing facilities, for reading the
2716 test data. A line history is supported.
2717
2718 Long expansion expressions can be split over several lines by using backslash
2719 continuations. As in Exim's run time configuration, white space at the start of
2720 continuation lines is ignored. Each argument or data line is passed through the
2721 string expansion mechanism, and the result is output. Variable values from the
2722 configuration file (for example, &$qualify_domain$&) are available, but no
2723 message-specific values (such as &$sender_domain$&) are set, because no message
2724 is being processed (but see &%-bem%& and &%-Mset%&).
2725
2726 &*Note*&: If you use this mechanism to test lookups, and you change the data
2727 files or databases you are using, you must exit and restart Exim before trying
2728 the same lookup again. Otherwise, because each Exim process caches the results
2729 of lookups, you will just get the same result as before.
2730
2731 .vitem &%-bem%&&~<&'filename'&>
2732 .oindex "&%-bem%&"
2733 .cindex "testing" "string expansion"
2734 .cindex "expansion" "testing"
2735 This option operates like &%-be%& except that it must be followed by the name
2736 of a file. For example:
2737 .code
2738 exim -bem /tmp/testmessage
2739 .endd
2740 The file is read as a message (as if receiving a locally-submitted non-SMTP
2741 message) before any of the test expansions are done. Thus, message-specific
2742 variables such as &$message_size$& and &$header_from:$& are available. However,
2743 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2744 recipients are read from the headers in the normal way, and are shown in the
2745 &$recipients$& variable. Note that recipients cannot be given on the command
2746 line, because further arguments are taken as strings to expand (just like
2747 &%-be%&).
2748
2749 .vitem &%-bF%&&~<&'filename'&>
2750 .oindex "&%-bF%&"
2751 .cindex "system filter" "testing"
2752 .cindex "testing" "system filter"
2753 This option is the same as &%-bf%& except that it assumes that the filter being
2754 tested is a system filter. The additional commands that are available only in
2755 system filters are recognized.
2756
2757 .vitem &%-bf%&&~<&'filename'&>
2758 .oindex "&%-bf%&"
2759 .cindex "filter" "testing"
2760 .cindex "testing" "filter file"
2761 .cindex "forward file" "testing"
2762 .cindex "testing" "forward file"
2763 .cindex "Sieve filter" "testing"
2764 This option runs Exim in user filter testing mode; the file is the filter file
2765 to be tested, and a test message must be supplied on the standard input. If
2766 there are no message-dependent tests in the filter, an empty file can be
2767 supplied.
2768
2769 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2770 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2771 filter and a user filter in the same run. For example:
2772 .code
2773 exim -bF /system/filter -bf /user/filter </test/message
2774 .endd
2775 This is helpful when the system filter adds header lines or sets filter
2776 variables that are used by the user filter.
2777
2778 If the test filter file does not begin with one of the special lines
2779 .code
2780 # Exim filter
2781 # Sieve filter
2782 .endd
2783 it is taken to be a normal &_.forward_& file, and is tested for validity under
2784 that interpretation. See sections &<<SECTitenonfilred>>& to
2785 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2786 redirection lists.
2787
2788 The result of an Exim command that uses &%-bf%&, provided no errors are
2789 detected, is a list of the actions that Exim would try to take if presented
2790 with the message for real. More details of filter testing are given in the
2791 separate document entitled &'Exim's interfaces to mail filtering'&.
2792
2793 When testing a filter file,
2794 .cindex "&""From""& line"
2795 .cindex "envelope sender"
2796 .oindex "&%-f%&" "for filter testing"
2797 the envelope sender can be set by the &%-f%& option,
2798 or by a &"From&~"& line at the start of the test message. Various parameters
2799 that would normally be taken from the envelope recipient address of the message
2800 can be set by means of additional command line options (see the next four
2801 options).
2802
2803 .vitem &%-bfd%&&~<&'domain'&>
2804 .oindex "&%-bfd%&"
2805 .vindex "&$qualify_domain$&"
2806 This sets the domain of the recipient address when a filter file is being
2807 tested by means of the &%-bf%& option. The default is the value of
2808 &$qualify_domain$&.
2809
2810 .vitem &%-bfl%&&~<&'local&~part'&>
2811 .oindex "&%-bfl%&"
2812 This sets the local part of the recipient address when a filter file is being
2813 tested by means of the &%-bf%& option. The default is the username of the
2814 process that calls Exim. A local part should be specified with any prefix or
2815 suffix stripped, because that is how it appears to the filter when a message is
2816 actually being delivered.
2817
2818 .vitem &%-bfp%&&~<&'prefix'&>
2819 .oindex "&%-bfp%&"
2820 This sets the prefix of the local part of the recipient address when a filter
2821 file is being tested by means of the &%-bf%& option. The default is an empty
2822 prefix.
2823
2824 .vitem &%-bfs%&&~<&'suffix'&>
2825 .oindex "&%-bfs%&"
2826 This sets the suffix of the local part of the recipient address when a filter
2827 file is being tested by means of the &%-bf%& option. The default is an empty
2828 suffix.
2829
2830 .vitem &%-bh%&&~<&'IP&~address'&>
2831 .oindex "&%-bh%&"
2832 .cindex "testing" "incoming SMTP"
2833 .cindex "SMTP" "testing incoming"
2834 .cindex "testing" "relay control"
2835 .cindex "relaying" "testing configuration"
2836 .cindex "policy control" "testing"
2837 .cindex "debugging" "&%-bh%& option"
2838 This option runs a fake SMTP session as if from the given IP address, using the
2839 standard input and output. The IP address may include a port number at the end,
2840 after a full stop. For example:
2841 .code
2842 exim -bh 10.9.8.7.1234
2843 exim -bh fe80::a00:20ff:fe86:a061.5678
2844 .endd
2845 When an IPv6 address is given, it is converted into canonical form. In the case
2846 of the second example above, the value of &$sender_host_address$& after
2847 conversion to the canonical form is
2848 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2849
2850 Comments as to what is going on are written to the standard error file. These
2851 include lines beginning with &"LOG"& for anything that would have been logged.
2852 This facility is provided for testing configuration options for incoming
2853 messages, to make sure they implement the required policy. For example, you can
2854 test your relay controls using &%-bh%&.
2855
2856 &*Warning 1*&:
2857 .cindex "RFC 1413"
2858 You can test features of the configuration that rely on ident (RFC 1413)
2859 information by using the &%-oMt%& option. However, Exim cannot actually perform
2860 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2861 connection.
2862
2863 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2864 are also skipped when testing using &%-bh%&. If you want these callouts to
2865 occur, use &%-bhc%& instead.
2866
2867 Messages supplied during the testing session are discarded, and nothing is
2868 written to any of the real log files. There may be pauses when DNS (and other)
2869 lookups are taking place, and of course these may time out. The &%-oMi%& option
2870 can be used to specify a specific IP interface and port if this is important,
2871 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2872 session were authenticated.
2873
2874 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2875 output just states whether a given recipient address from a given host is
2876 acceptable or not. See section &<<SECTcheckaccess>>&.
2877
2878 Features such as authentication and encryption, where the client input is not
2879 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2880 specialized SMTP test program such as
2881 &url(http://jetmore.org/john/code/#swaks,swaks).
2882
2883 .vitem &%-bhc%&&~<&'IP&~address'&>
2884 .oindex "&%-bhc%&"
2885 This option operates in the same way as &%-bh%&, except that address
2886 verification callouts are performed if required. This includes consulting and
2887 updating the callout cache database.
2888
2889 .vitem &%-bi%&
2890 .oindex "&%-bi%&"
2891 .cindex "alias file" "building"
2892 .cindex "building alias file"
2893 .cindex "Sendmail compatibility" "&%-bi%& option"
2894 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2895 Exim does not have the concept of a single alias file, and so it cannot mimic
2896 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2897 tend to appear in various scripts such as NIS make files, so the option must be
2898 recognized.
2899
2900 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2901 configuration option is run, under the uid and gid of the caller of Exim. If
2902 the &%-oA%& option is used, its value is passed to the command as an argument.
2903 The command set by &%bi_command%& may not contain arguments. The command can
2904 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2905 if this is required. If the &%bi_command%& option is not set, calling Exim with
2906 &%-bi%& is a no-op.
2907
2908 .vitem &%-bm%&
2909 .oindex "&%-bm%&"
2910 .cindex "local message reception"
2911 This option runs an Exim receiving process that accepts an incoming,
2912 locally-generated message on the current input. The recipients are given as the
2913 command arguments (except when &%-t%& is also present &-- see below). Each
2914 argument can be a comma-separated list of RFC 2822 addresses. This is the
2915 default option for selecting the overall action of an Exim call; it is assumed
2916 if no other conflicting option is present.
2917
2918 If any addresses in the message are unqualified (have no domain), they are
2919 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
2920 options, as appropriate. The &%-bnq%& option (see below) provides a way of
2921 suppressing this for special cases.
2922
2923 Policy checks on the contents of local messages can be enforced by means of
2924 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
2925
2926 .cindex "return code" "for &%-bm%&"
2927 The return code is zero if the message is successfully accepted. Otherwise, the
2928 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
2929
2930 The format
2931 .cindex "message" "format"
2932 .cindex "format" "message"
2933 .cindex "&""From""& line"
2934 .cindex "UUCP" "&""From""& line"
2935 .cindex "Sendmail compatibility" "&""From""& line"
2936 of the message must be as defined in RFC 2822, except that, for
2937 compatibility with Sendmail and Smail, a line in one of the forms
2938 .code
2939 From sender Fri Jan  5 12:55 GMT 1997
2940 From sender Fri, 5 Jan 97 12:55:01
2941 .endd
2942 (with the weekday optional, and possibly with additional text after the date)
2943 is permitted to appear at the start of the message. There appears to be no
2944 authoritative specification of the format of this line. Exim recognizes it by
2945 matching against the regular expression defined by the &%uucp_from_pattern%&
2946 option, which can be changed if necessary.
2947
2948 .oindex "&%-f%&" "overriding &""From""& line"
2949 The specified sender is treated as if it were given as the argument to the
2950 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
2951 preference to the address taken from the message. The caller of Exim must be a
2952 trusted user for the sender of a message to be set in this way.
2953
2954 .vitem &%-bnq%&
2955 .oindex "&%-bnq%&"
2956 .cindex "address qualification, suppressing"
2957 By default, Exim automatically qualifies unqualified addresses (those
2958 without domains) that appear in messages that are submitted locally (that
2959 is, not over TCP/IP). This qualification applies both to addresses in
2960 envelopes, and addresses in header lines. Sender addresses are qualified using
2961 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
2962 defaults to the value of &%qualify_domain%&).
2963
2964 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
2965 being used to re-submit messages that originally came from remote hosts after
2966 content scanning, you probably do not want to qualify unqualified addresses in
2967 header lines. (Such lines will be present only if you have not enabled a header
2968 syntax check in the appropriate ACL.)
2969
2970 The &%-bnq%& option suppresses all qualification of unqualified addresses in
2971 messages that originate on the local host. When this is used, unqualified
2972 addresses in the envelope provoke errors (causing message rejection) and
2973 unqualified addresses in header lines are left alone.
2974
2975
2976 .vitem &%-bP%&
2977 .oindex "&%-bP%&"
2978 .cindex "configuration options" "extracting"
2979 .cindex "options" "configuration &-- extracting"
2980 If this option is given with no arguments, it causes the values of all Exim's
2981 main configuration options to be written to the standard output. The values
2982 of one or more specific options can be requested by giving their names as
2983 arguments, for example:
2984 .code
2985 exim -bP qualify_domain hold_domains
2986 .endd
2987 .cindex "hiding configuration option values"
2988 .cindex "configuration options" "hiding value of"
2989 .cindex "options" "hiding value of"
2990 However, any option setting that is preceded by the word &"hide"& in the
2991 configuration file is not shown in full, except to an admin user. For other
2992 users, the output is as in this example:
2993 .code
2994 mysql_servers = <value not displayable>
2995 .endd
2996 If &%configure_file%& is given as an argument, the name of the run time
2997 configuration file is output.
2998 If a list of configuration files was supplied, the value that is output here
2999 is the name of the file that was actually used.
3000
3001 .cindex "daemon" "process id (pid)"
3002 .cindex "pid (process id)" "of daemon"
3003 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3004 directories where log files and daemon pid files are written are output,
3005 respectively. If these values are unset, log files are written in a
3006 sub-directory of the spool directory called &%log%&, and the pid file is
3007 written directly into the spool directory.
3008
3009 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3010 .code
3011 exim -bP +local_domains
3012 .endd
3013 it searches for a matching named list of any type (domain, host, address, or
3014 local part) and outputs what it finds.
3015
3016 .cindex "options" "router &-- extracting"
3017 .cindex "options" "transport &-- extracting"
3018 .cindex "options" "authenticator &-- extracting"
3019 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3020 followed by the name of an appropriate driver instance, the option settings for
3021 that driver are output. For example:
3022 .code
3023 exim -bP transport local_delivery
3024 .endd
3025 The generic driver options are output first, followed by the driver's private
3026 options. A list of the names of drivers of a particular type can be obtained by
3027 using one of the words &%router_list%&, &%transport_list%&, or
3028 &%authenticator_list%&, and a complete list of all drivers with their option
3029 settings can be obtained by using &%routers%&, &%transports%&, or
3030 &%authenticators%&.
3031
3032 .cindex "options" "macro &-- extracting"
3033 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3034 are available, similarly to the drivers.  Because macros are sometimes used
3035 for storing passwords, this option is restricted.
3036 The output format is one item per line.
3037
3038 .vitem &%-bp%&
3039 .oindex "&%-bp%&"
3040 .cindex "queue" "listing messages on"
3041 .cindex "listing" "messages on the queue"
3042 This option requests a listing of the contents of the mail queue on the
3043 standard output. If the &%-bp%& option is followed by a list of message ids,
3044 just those messages are listed. By default, this option can be used only by an
3045 admin user. However, the &%queue_list_requires_admin%& option can be set false
3046 to allow any user to see the queue.
3047
3048 Each message on the queue is displayed as in the following example:
3049 .code
3050 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3051           red.king@looking-glass.fict.example
3052           <other addresses>
3053 .endd
3054 .cindex "message" "size in queue listing"
3055 .cindex "size" "of message"
3056 The first line contains the length of time the message has been on the queue
3057 (in this case 25 minutes), the size of the message (2.9K), the unique local
3058 identifier for the message, and the message sender, as contained in the
3059 envelope. For bounce messages, the sender address is empty, and appears as
3060 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3061 the default sender address, the user's login name is shown in parentheses
3062 before the sender address.
3063
3064 .cindex "frozen messages" "in queue listing"
3065 If the message is frozen (attempts to deliver it are suspended) then the text
3066 &"*** frozen ***"& is displayed at the end of this line.
3067
3068 The recipients of the message (taken from the envelope, not the headers) are
3069 displayed on subsequent lines. Those addresses to which the message has already
3070 been delivered are marked with the letter D. If an original address gets
3071 expanded into several addresses via an alias or forward file, the original is
3072 displayed with a D only when deliveries for all of its child addresses are
3073 complete.
3074
3075
3076 .vitem &%-bpa%&
3077 .oindex "&%-bpa%&"
3078 This option operates like &%-bp%&, but in addition it shows delivered addresses
3079 that were generated from the original top level address(es) in each message by
3080 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3081 of just &"D"&.
3082
3083
3084 .vitem &%-bpc%&
3085 .oindex "&%-bpc%&"
3086 .cindex "queue" "count of messages on"
3087 This option counts the number of messages on the queue, and writes the total
3088 to the standard output. It is restricted to admin users, unless
3089 &%queue_list_requires_admin%& is set false.
3090
3091
3092 .vitem &%-bpr%&
3093 .oindex "&%-bpr%&"
3094 This option operates like &%-bp%&, but the output is not sorted into
3095 chronological order of message arrival. This can speed it up when there are
3096 lots of messages on the queue, and is particularly useful if the output is
3097 going to be post-processed in a way that doesn't need the sorting.
3098
3099 .vitem &%-bpra%&
3100 .oindex "&%-bpra%&"
3101 This option is a combination of &%-bpr%& and &%-bpa%&.
3102
3103 .vitem &%-bpru%&
3104 .oindex "&%-bpru%&"
3105 This option is a combination of &%-bpr%& and &%-bpu%&.
3106
3107
3108 .vitem &%-bpu%&
3109 .oindex "&%-bpu%&"
3110 This option operates like &%-bp%& but shows only undelivered top-level
3111 addresses for each message displayed. Addresses generated by aliasing or
3112 forwarding are not shown, unless the message was deferred after processing by a
3113 router with the &%one_time%& option set.
3114
3115
3116 .vitem &%-brt%&
3117 .oindex "&%-brt%&"
3118 .cindex "testing" "retry configuration"
3119 .cindex "retry" "configuration testing"
3120 This option is for testing retry rules, and it must be followed by up to three
3121 arguments. It causes Exim to look for a retry rule that matches the values
3122 and to write it to the standard output. For example:
3123 .code
3124 exim -brt bach.comp.mus.example
3125 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3126 .endd
3127 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3128 argument, which is required, can be a complete address in the form
3129 &'local_part@domain'&, or it can be just a domain name. If the second argument
3130 contains a dot, it is interpreted as an optional second domain name; if no
3131 retry rule is found for the first argument, the second is tried. This ties in
3132 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3133 rule is found that matches the host, one that matches the mail domain is
3134 sought. Finally, an argument that is the name of a specific delivery error, as
3135 used in setting up retry rules, can be given. For example:
3136 .code
3137 exim -brt haydn.comp.mus.example quota_3d
3138 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3139 .endd
3140
3141 .vitem &%-brw%&
3142 .oindex "&%-brw%&"
3143 .cindex "testing" "rewriting"
3144 .cindex "rewriting" "testing"
3145 This option is for testing address rewriting rules, and it must be followed by
3146 a single argument, consisting of either a local part without a domain, or a
3147 complete address with a fully qualified domain. Exim outputs how this address
3148 would be rewritten for each possible place it might appear. See chapter
3149 &<<CHAPrewrite>>& for further details.
3150
3151 .vitem &%-bS%&
3152 .oindex "&%-bS%&"
3153 .cindex "SMTP" "batched incoming"
3154 .cindex "batched SMTP input"
3155 This option is used for batched SMTP input, which is an alternative interface
3156 for non-interactive local message submission. A number of messages can be
3157 submitted in a single run. However, despite its name, this is not really SMTP
3158 input. Exim reads each message's envelope from SMTP commands on the standard
3159 input, but generates no responses. If the caller is trusted, or
3160 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3161 believed; otherwise the sender is always the caller of Exim.
3162
3163 The message itself is read from the standard input, in SMTP format (leading
3164 dots doubled), terminated by a line containing just a single dot. An error is
3165 provoked if the terminating dot is missing. A further message may then follow.
3166
3167 As for other local message submissions, the contents of incoming batch SMTP
3168 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3169 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3170 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3171
3172 Some other SMTP commands are recognized in the input. HELO and EHLO act
3173 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3174 QUIT quits, ignoring the rest of the standard input.
3175
3176 .cindex "return code" "for &%-bS%&"
3177 If any error is encountered, reports are written to the standard output and
3178 error streams, and Exim gives up immediately. The return code is 0 if no error
3179 was detected; it is 1 if one or more messages were accepted before the error
3180 was detected; otherwise it is 2.
3181
3182 More details of input using batched SMTP are given in section
3183 &<<SECTincomingbatchedSMTP>>&.
3184
3185 .vitem &%-bs%&
3186 .oindex "&%-bs%&"
3187 .cindex "SMTP" "local input"
3188 .cindex "local SMTP input"
3189 This option causes Exim to accept one or more messages by reading SMTP commands
3190 on the standard input, and producing SMTP replies on the standard output. SMTP
3191 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3192 Some user agents use this interface as a way of passing locally-generated
3193 messages to the MTA.
3194
3195 In
3196 .cindex "sender" "source of"
3197 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3198 set, the senders of messages are taken from the SMTP MAIL commands.
3199 Otherwise the content of these commands is ignored and the sender is set up as
3200 the calling user. Unqualified addresses are automatically qualified using
3201 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3202 &%-bnq%& option is used.
3203
3204 .cindex "inetd"
3205 The
3206 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3207 using a listening daemon. Exim can distinguish the two cases by checking
3208 whether the standard input is a TCP/IP socket. When Exim is called from
3209 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3210 above concerning senders and qualification do not apply. In this situation,
3211 Exim behaves in exactly the same way as it does when receiving a message via
3212 the listening daemon.
3213
3214 .new
3215 .vitem &%-bmalware%&&~<&'filename'&>
3216 .oindex "&%-bmalware%&"
3217 .cindex "testing", "malware"
3218 .cindex "malware scan test"
3219 This debugging option causes Exim to scan the given file,
3220 using the malware scanning framework.  The option of &%av_scanner%& influences
3221 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3222 the expansion should have defaults which apply to this invocation.  ACLs are
3223 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3224 will never be populated and &%-bmalware%& will fail.
3225
3226 Exim will have changed working directory before resolving the filename, so
3227 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3228 user when it tries to open the file, rather than as the invoking user.
3229 This option requires admin privileges.
3230
3231 The &%-bmalware%& option will not be extended to be more generally useful,
3232 there are better tools for file-scanning.  This option exists to help
3233 administrators verify their Exim and AV scanner configuration.
3234 .wen
3235
3236 .vitem &%-bt%&
3237 .oindex "&%-bt%&"
3238 .cindex "testing" "addresses"
3239 .cindex "address" "testing"
3240 This option runs Exim in address testing mode, in which each argument is taken
3241 as a recipient address to be tested for deliverability. The results are
3242 written to the standard output. If a test fails, and the caller is not an admin
3243 user, no details of the failure are output, because these might contain
3244 sensitive information such as usernames and passwords for database lookups.
3245
3246 If no arguments are given, Exim runs in an interactive manner, prompting with a
3247 right angle bracket for addresses to be tested.
3248
3249 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3250 &[readline()]& function, because it is running as &'root'& and there are
3251 security issues.
3252
3253 Each address is handled as if it were the recipient address of a message
3254 (compare the &%-bv%& option). It is passed to the routers and the result is
3255 written to the standard output. However, any router that has
3256 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3257 genuine routing tests if your first router passes everything to a scanner
3258 program.
3259
3260 .cindex "return code" "for &%-bt%&"
3261 The return code is 2 if any address failed outright; it is 1 if no address
3262 failed outright but at least one could not be resolved for some reason. Return
3263 code 0 is given only when all addresses succeed.
3264
3265 .cindex "duplicate addresses"
3266 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3267 addresses after routing is complete, so that only one delivery takes place.
3268 This does not happen when testing with &%-bt%&; the full results of routing are
3269 always shown.
3270
3271 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3272 routers in the configuration makes any tests on the sender address of a
3273 message,
3274 .oindex "&%-f%&" "for address testing"
3275 you can use the &%-f%& option to set an appropriate sender when running
3276 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3277 default qualifying domain. However, if you have set up (for example) routers
3278 whose behaviour depends on the contents of an incoming message, you cannot test
3279 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3280 doing such tests.
3281
3282 .vitem &%-bV%&
3283 .oindex "&%-bV%&"
3284 .cindex "version number of Exim"
3285 This option causes Exim to write the current version number, compilation
3286 number, and compilation date of the &'exim'& binary to the standard output.
3287 It also lists the DBM library that is being used, the optional modules (such as
3288 specific lookup types), the drivers that are included in the binary, and the
3289 name of the run time configuration file that is in use.
3290
3291 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3292 configuration file. However, this is a static check only. It cannot check
3293 values that are to be expanded. For example, although a misspelt ACL verb is
3294 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3295 alone to discover (for example) all the typos in the configuration; some
3296 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3297 dynamic testing facilities.
3298
3299 .vitem &%-bv%&
3300 .oindex "&%-bv%&"
3301 .cindex "verifying address" "using &%-bv%&"
3302 .cindex "address" "verification"
3303 This option runs Exim in address verification mode, in which each argument is
3304 taken as a recipient address to be verified by the routers. (This does
3305 not involve any verification callouts). During normal operation, verification
3306 happens mostly as a consequence processing a &%verify%& condition in an ACL
3307 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3308 including callouts, see the &%-bh%& and &%-bhc%& options.
3309
3310 If verification fails, and the caller is not an admin user, no details of the
3311 failure are output, because these might contain sensitive information such as
3312 usernames and passwords for database lookups.
3313
3314 If no arguments are given, Exim runs in an interactive manner, prompting with a
3315 right angle bracket for addresses to be verified.
3316
3317 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3318 &[readline()]& function, because it is running as &'exim'& and there are
3319 security issues.
3320
3321 Verification differs from address testing (the &%-bt%& option) in that routers
3322 that have &%no_verify%& set are skipped, and if the address is accepted by a
3323 router that has &%fail_verify%& set, verification fails. The address is
3324 verified as a recipient if &%-bv%& is used; to test verification for a sender
3325 address, &%-bvs%& should be used.
3326
3327 If the &%-v%& option is not set, the output consists of a single line for each
3328 address, stating whether it was verified or not, and giving a reason in the
3329 latter case. Without &%-v%&, generating more than one address by redirection
3330 causes verification to end successfully, without considering the generated
3331 addresses. However, if just one address is generated, processing continues,
3332 and the generated address must verify successfully for the overall verification
3333 to succeed.
3334
3335 When &%-v%& is set, more details are given of how the address has been handled,
3336 and in the case of address redirection, all the generated addresses are also
3337 considered. Verification may succeed for some and fail for others.
3338
3339 The
3340 .cindex "return code" "for &%-bv%&"
3341 return code is 2 if any address failed outright; it is 1 if no address
3342 failed outright but at least one could not be resolved for some reason. Return
3343 code 0 is given only when all addresses succeed.
3344
3345 If any of the routers in the configuration makes any tests on the sender
3346 address of a message, you should use the &%-f%& option to set an appropriate
3347 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3348 calling user at the default qualifying domain.
3349
3350 .vitem &%-bvs%&
3351 .oindex "&%-bvs%&"
3352 This option acts like &%-bv%&, but verifies the address as a sender rather
3353 than a recipient address. This affects any rewriting and qualification that
3354 might happen.
3355
3356 .new
3357 .vitem &%-C%&&~<&'filelist'&>
3358 .oindex "&%-C%&"
3359 .cindex "configuration file" "alternate"
3360 .cindex "CONFIGURE_FILE"
3361 .cindex "alternate configuration file"
3362 This option causes Exim to find the run time configuration file from the given
3363 list instead of from the list specified by the CONFIGURE_FILE
3364 compile-time setting. Usually, the list will consist of just a single file
3365 name, but it can be a colon-separated list of names. In this case, the first
3366 file that exists is used. Failure to open an existing file stops Exim from
3367 proceeding any further along the list, and an error is generated.
3368
3369 When this option is used by a caller other than root, and the list is different
3370 from the compiled-in list, Exim gives up its root privilege immediately, and
3371 runs with the real and effective uid and gid set to those of the caller.
3372 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3373 file contains a list of full pathnames, one per line, for configuration files
3374 which are trusted. Root privilege is retained for any configuration file so
3375 listed, as long as the caller is the Exim user (or the user specified in the
3376 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3377 not writeable by inappropriate users or groups.
3378
3379 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3380 configuration using &%-C%& right through message reception and delivery,
3381 even if the caller is root. The reception works, but by that time, Exim is
3382 running as the Exim user, so when it re-executes to regain privilege for the
3383 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3384 test reception and delivery using two separate commands (one to put a message
3385 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3386
3387 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3388 prefix string with which any file named in a &%-C%& command line option
3389 must start. In addition, the file name must not contain the sequence &`/../`&.
3390 However, if the value of the &%-C%& option is identical to the value of
3391 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3392 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3393 unset, any file name can be used with &%-C%&.
3394
3395 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3396 to a directory to which only root has access. This prevents someone who has
3397 broken into the Exim account from running a privileged Exim with an arbitrary
3398 configuration file.
3399
3400 The &%-C%& facility is useful for ensuring that configuration files are
3401 syntactically correct, but cannot be used for test deliveries, unless the
3402 caller is privileged, or unless it is an exotic configuration that does not
3403 require privilege. No check is made on the owner or group of the files
3404 specified by this option.
3405 .wen
3406
3407 .new
3408 .vitem &%-D%&<&'macro'&>=<&'value'&>
3409 .oindex "&%-D%&"
3410 .cindex "macro" "setting on command line"
3411 This option can be used to override macro definitions in the configuration file
3412 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3413 unprivileged caller, it causes Exim to give up its root privilege.
3414 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3415 completely disabled, and its use causes an immediate error exit.
3416
3417 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3418 colon-separated list of macros which are considered safe and, if &%-D%& only
3419 supplies macros from this list, and the values are acceptable, then Exim will
3420 not give up root privilege if the caller is root, the Exim run-time user, or
3421 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3422 to be removed in the future.  Acceptable values for the macros satisfy the
3423 regexp: &`^[A-Za-z0-9_/.-]*$`&
3424
3425 The entire option (including equals sign if present) must all be within one
3426 command line item. &%-D%& can be used to set the value of a macro to the empty
3427 string, in which case the equals sign is optional. These two commands are
3428 synonymous:
3429 .code
3430 exim -DABC  ...
3431 exim -DABC= ...
3432 .endd
3433 To include spaces in a macro definition item, quotes must be used. If you use
3434 quotes, spaces are permitted around the macro name and the equals sign. For
3435 example:
3436 .code
3437 exim '-D ABC = something' ...
3438 .endd
3439 &%-D%& may be repeated up to 10 times on a command line.
3440 .wen
3441
3442 .vitem &%-d%&<&'debug&~options'&>
3443 .oindex "&%-d%&"
3444 .cindex "debugging" "list of selectors"
3445 .cindex "debugging" "&%-d%& option"
3446 This option causes debugging information to be written to the standard
3447 error stream. It is restricted to admin users because debugging output may show
3448 database queries that contain password information. Also, the details of users'
3449 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3450 writes an error message to the standard error stream and exits with a non-zero
3451 return code.
3452
3453 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3454 standard debugging data is output. This can be reduced, or increased to include
3455 some more rarely needed information, by directly following &%-d%& with a string
3456 made up of names preceded by plus or minus characters. These add or remove sets
3457 of debugging data, respectively. For example, &%-d+filter%& adds filter
3458 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3459 no spaces are allowed in the debug setting. The available debugging categories
3460 are:
3461 .display
3462 &`acl            `& ACL interpretation
3463 &`auth           `& authenticators
3464 &`deliver        `& general delivery logic
3465 &`dns            `& DNS lookups (see also resolver)
3466 &`dnsbl          `& DNS black list (aka RBL) code
3467 &`exec           `& arguments for &[execv()]& calls
3468 &`expand         `& detailed debugging for string expansions
3469 &`filter         `& filter handling
3470 &`hints_lookup   `& hints data lookups
3471 &`host_lookup    `& all types of name-to-IP address handling
3472 &`ident          `& ident lookup
3473 &`interface      `& lists of local interfaces
3474 &`lists          `& matching things in lists
3475 &`load           `& system load checks
3476 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3477                     &<<CHAPlocalscan>>&)
3478 &`lookup         `& general lookup code and all lookups
3479 &`memory         `& memory handling
3480 &`pid            `& add pid to debug output lines
3481 &`process_info   `& setting info for the process log
3482 &`queue_run      `& queue runs
3483 &`receive        `& general message reception logic
3484 &`resolver       `& turn on the DNS resolver's debugging output
3485 &`retry          `& retry handling
3486 &`rewrite        `& address rewriting
3487 &`route          `& address routing
3488 &`timestamp      `& add timestamp to debug output lines
3489 &`tls            `& TLS logic
3490 &`transport      `& transports
3491 &`uid            `& changes of uid/gid and looking up uid/gid
3492 &`verify         `& address verification logic
3493 &`all            `& almost all of the above (see below), and also &%-v%&
3494 .endd
3495 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3496 for &`-all`&. The reason for this is that &`+all`& is something that people
3497 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3498 is included, an awful lot of output that is very rarely of interest is
3499 generated, so it now has to be explicitly requested. However, &`-all`& does
3500 turn everything off.
3501
3502 .cindex "resolver, debugging output"
3503 .cindex "DNS resolver, debugging output"
3504 The &`resolver`& option produces output only if the DNS resolver was compiled
3505 with DEBUG enabled. This is not the case in some operating systems. Also,
3506 unfortunately, debugging output from the DNS resolver is written to stdout
3507 rather than stderr.
3508
3509 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3510 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3511 However, the &`pid`& selector is forced when debugging is turned on for a
3512 daemon, which then passes it on to any re-executed Exims. Exim also
3513 automatically adds the pid to debug lines when several remote deliveries are
3514 run in parallel.
3515
3516 The &`timestamp`& selector causes the current time to be inserted at the start
3517 of all debug output lines. This can be useful when trying to track down delays
3518 in processing.
3519
3520 If the &%debug_print%& option is set in any driver, it produces output whenever
3521 any debugging is selected, or if &%-v%& is used.
3522
3523 .vitem &%-dd%&<&'debug&~options'&>
3524 .oindex "&%-dd%&"
3525 This option behaves exactly like &%-d%& except when used on a command that
3526 starts a daemon process. In that case, debugging is turned off for the
3527 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3528 behaviour of the daemon without creating as much output as full debugging does.
3529
3530 .vitem &%-dropcr%&
3531 .oindex "&%-dropcr%&"
3532 This is an obsolete option that is now a no-op. It used to affect the way Exim
3533 handled CR and LF characters in incoming messages. What happens now is
3534 described in section &<<SECTlineendings>>&.
3535
3536 .vitem &%-E%&
3537 .oindex "&%-E%&"
3538 .cindex "bounce message" "generating"
3539 This option specifies that an incoming message is a locally-generated delivery
3540 failure report. It is used internally by Exim when handling delivery failures
3541 and is not intended for external use. Its only effect is to stop Exim
3542 generating certain messages to the postmaster, as otherwise message cascades
3543 could occur in some situations. As part of the same option, a message id may
3544 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3545 new message contains the id, following &"R="&, as a cross-reference.
3546
3547 .vitem &%-e%&&'x'&
3548 .oindex "&%-e%&&'x'&"
3549 There are a number of Sendmail options starting with &%-oe%& which seem to be
3550 called by various programs without the leading &%o%& in the option. For
3551 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3552 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3553
3554 .vitem &%-F%&&~<&'string'&>
3555 .oindex "&%-F%&"
3556 .cindex "sender" "name"
3557 .cindex "name" "of sender"
3558 This option sets the sender's full name for use when a locally-generated
3559 message is being accepted. In the absence of this option, the user's &'gecos'&
3560 entry from the password data is used. As users are generally permitted to alter
3561 their &'gecos'& entries, no security considerations are involved. White space
3562 between &%-F%& and the <&'string'&> is optional.
3563
3564 .vitem &%-f%&&~<&'address'&>
3565 .oindex "&%-f%&"
3566 .cindex "sender" "address"
3567 .cindex "address" "sender"
3568 .cindex "trusted users"
3569 .cindex "envelope sender"
3570 .cindex "user" "trusted"
3571 This option sets the address of the envelope sender of a locally-generated
3572 message (also known as the return path). The option can normally be used only
3573 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3574 users to use it.
3575
3576 Processes running as root or the Exim user are always trusted. Other
3577 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3578 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3579 of a local message is set to the caller's login name at the default qualify
3580 domain.
3581
3582 There is one exception to the restriction on the use of &%-f%&: an empty sender
3583 can be specified by any user, trusted or not, to create a message that can
3584 never provoke a bounce. An empty sender can be specified either as an empty
3585 string, or as a pair of angle brackets with nothing between them, as in these
3586 examples of shell commands:
3587 .code
3588 exim -f '<>' user@domain
3589 exim -f "" user@domain
3590 .endd
3591 In addition, the use of &%-f%& is not restricted when testing a filter file
3592 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3593 &%-bv%& options.
3594
3595 Allowing untrusted users to change the sender address does not of itself make
3596 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3597 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3598 though this can be overridden by setting &%no_local_from_check%&.
3599
3600 White
3601 .cindex "&""From""& line"
3602 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3603 given as two arguments or one combined argument). The sender of a
3604 locally-generated message can also be set (when permitted) by an initial
3605 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3606 if &%-f%& is also present, it overrides &"From&~"&.
3607
3608 .vitem &%-G%&
3609 .oindex "&%-G%&"
3610 .cindex "Sendmail compatibility" "&%-G%& option ignored"
3611 This is a Sendmail option which is ignored by Exim.
3612
3613 .vitem &%-h%&&~<&'number'&>
3614 .oindex "&%-h%&"
3615 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3616 This option is accepted for compatibility with Sendmail, but has no effect. (In
3617 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3618 headers.)
3619
3620 .vitem &%-i%&
3621 .oindex "&%-i%&"
3622 .cindex "Solaris" "&'mail'& command"
3623 .cindex "dot" "in incoming non-SMTP message"
3624 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3625 line by itself should not terminate an incoming, non-SMTP message. I can find
3626 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3627 command in Solaris 2.4 uses it. See also &%-ti%&.
3628
3629 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3630 .oindex "&%-M%&"
3631 .cindex "forcing delivery"
3632 .cindex "delivery" "forcing attempt"
3633 .cindex "frozen messages" "forcing delivery"
3634 This option requests Exim to run a delivery attempt on each message in turn. If
3635 any of the messages are frozen, they are automatically thawed before the
3636 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3637 and &%hold_domains%& are ignored.
3638
3639 Retry
3640 .cindex "hints database" "overriding retry hints"
3641 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3642 the normal retry time has not yet been reached. This option requires the caller
3643 to be an admin user. However, there is an option called &%prod_requires_admin%&
3644 which can be set false to relax this restriction (and also the same requirement
3645 for the &%-q%&, &%-R%&, and &%-S%& options).
3646
3647 The deliveries happen synchronously, that is, the original Exim process does
3648 not terminate until all the delivery attempts have finished. No output is
3649 produced unless there is a serious error. If you want to see what is happening,
3650 use the &%-v%& option as well, or inspect Exim's main log.
3651
3652 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3653 .oindex "&%-Mar%&"
3654 .cindex "message" "adding recipients"
3655 .cindex "recipient" "adding"
3656 This option requests Exim to add the addresses to the list of recipients of the
3657 message (&"ar"& for &"add recipients"&). The first argument must be a message
3658 id, and the remaining ones must be email addresses. However, if the message is
3659 active (in the middle of a delivery attempt), it is not altered. This option
3660 can be used only by an admin user.
3661
3662 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3663         &~<&'message&~id'&>"
3664 .oindex "&%-MC%&"
3665 .cindex "SMTP" "passed connection"
3666 .cindex "SMTP" "multiple deliveries"
3667 .cindex "multiple SMTP deliveries"
3668 This option is not intended for use by external callers. It is used internally
3669 by Exim to invoke another instance of itself to deliver a waiting message using
3670 an existing SMTP connection, which is passed as the standard input. Details are
3671 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3672 must be root or the Exim user in order to use it.
3673
3674 .vitem &%-MCA%&
3675 .oindex "&%-MCA%&"
3676 This option is not intended for use by external callers. It is used internally
3677 by Exim in conjunction with the &%-MC%& option. It signifies that the
3678 connection to the remote host has been authenticated.
3679
3680 .vitem &%-MCP%&
3681 .oindex "&%-MCP%&"
3682 This option is not intended for use by external callers. It is used internally
3683 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3684 which Exim is connected supports pipelining.
3685
3686 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3687 .oindex "&%-MCQ%&"
3688 This option is not intended for use by external callers. It is used internally
3689 by Exim in conjunction with the &%-MC%& option when the original delivery was
3690 started by a queue runner. It passes on the process id of the queue runner,
3691 together with the file descriptor number of an open pipe. Closure of the pipe
3692 signals the final completion of the sequence of processes that are passing
3693 messages through the same SMTP connection.
3694
3695 .vitem &%-MCS%&
3696 .oindex "&%-MCS%&"
3697 This option is not intended for use by external callers. It is used internally
3698 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3699 SMTP SIZE option should be used on messages delivered down the existing
3700 connection.
3701
3702 .vitem &%-MCT%&
3703 .oindex "&%-MCT%&"
3704 This option is not intended for use by external callers. It is used internally
3705 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3706 host to which Exim is connected supports TLS encryption.
3707
3708 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3709 .oindex "&%-Mc%&"
3710 .cindex "hints database" "not overridden by &%-Mc%&"
3711 .cindex "delivery" "manually started &-- not forced"
3712 This option requests Exim to run a delivery attempt on each message in turn,
3713 but unlike the &%-M%& option, it does check for retry hints, and respects any
3714 that are found. This option is not very useful to external callers. It is
3715 provided mainly for internal use by Exim when it needs to re-invoke itself in
3716 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3717 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3718 respects retry times and other options such as &%hold_domains%& that are
3719 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3720 If you want to run a specific delivery as if in a queue run, you should use
3721 &%-q%& with a message id argument. A distinction between queue run deliveries
3722 and other deliveries is made in one or two places.
3723
3724 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3725 .oindex "&%-Mes%&"
3726 .cindex "message" "changing sender"
3727 .cindex "sender" "changing"
3728 This option requests Exim to change the sender address in the message to the
3729 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3730 &"edit sender"&). There must be exactly two arguments. The first argument must
3731 be a message id, and the second one an email address. However, if the message
3732 is active (in the middle of a delivery attempt), its status is not altered.
3733 This option can be used only by an admin user.
3734
3735 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3736 .oindex "&%-Mf%&"
3737 .cindex "freezing messages"
3738 .cindex "message" "manually freezing"
3739 This option requests Exim to mark each listed message as &"frozen"&. This
3740 prevents any delivery attempts taking place until the message is &"thawed"&,
3741 either manually or as a result of the &%auto_thaw%& configuration option.
3742 However, if any of the messages are active (in the middle of a delivery
3743 attempt), their status is not altered. This option can be used only by an admin
3744 user.
3745
3746 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3747 .oindex "&%-Mg%&"
3748 .cindex "giving up on messages"
3749 .cindex "message" "abandoning delivery attempts"
3750 .cindex "delivery" "abandoning further attempts"
3751 This option requests Exim to give up trying to deliver the listed messages,
3752 including any that are frozen. However, if any of the messages are active,
3753 their status is not altered. For non-bounce messages, a delivery error message
3754 is sent to the sender, containing the text &"cancelled by administrator"&.
3755 Bounce messages are just discarded. This option can be used only by an admin
3756 user.
3757
3758 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3759 .oindex "&%-Mmad%&"
3760 .cindex "delivery" "cancelling all"
3761 This option requests Exim to mark all the recipient addresses in the messages
3762 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3763 message is active (in the middle of a delivery attempt), its status is not
3764 altered. This option can be used only by an admin user.
3765
3766 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3767 .oindex "&%-Mmd%&"
3768 .cindex "delivery" "cancelling by address"
3769 .cindex "recipient" "removing"
3770 .cindex "removing recipients"
3771 This option requests Exim to mark the given addresses as already delivered
3772 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3773 the remaining ones must be email addresses. These are matched to recipient
3774 addresses in the message in a case-sensitive manner. If the message is active
3775 (in the middle of a delivery attempt), its status is not altered. This option
3776 can be used only by an admin user.
3777
3778 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3779 .oindex "&%-Mrm%&"
3780 .cindex "removing messages"
3781 .cindex "abandoning mail"
3782 .cindex "message" "manually discarding"
3783 This option requests Exim to remove the given messages from the queue. No
3784 bounce messages are sent; each message is simply forgotten. However, if any of
3785 the messages are active, their status is not altered. This option can be used
3786 only by an admin user or by the user who originally caused the message to be
3787 placed on the queue.
3788
3789 .vitem &%-Mset%&&~<&'message&~id'&>
3790 .oindex "&%-Mset%&
3791 .cindex "testing" "string expansion"
3792 .cindex "expansion" "testing"
3793 This option is useful only in conjunction with &%-be%& (that is, when testing
3794 string expansions). Exim loads the given message from its spool before doing
3795 the test expansions, thus setting message-specific variables such as
3796 &$message_size$& and the header variables. The &$recipients$& variable is made
3797 available. This feature is provided to make it easier to test expansions that
3798 make use of these variables. However, this option can be used only by an admin
3799 user. See also &%-bem%&.
3800
3801 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3802 .oindex "&%-Mt%&"
3803 .cindex "thawing messages"
3804 .cindex "unfreezing messages"
3805 .cindex "frozen messages" "thawing"
3806 .cindex "message" "thawing frozen"
3807 This option requests Exim to &"thaw"& any of the listed messages that are
3808 &"frozen"&, so that delivery attempts can resume. However, if any of the
3809 messages are active, their status is not altered. This option can be used only
3810 by an admin user.
3811
3812 .vitem &%-Mvb%&&~<&'message&~id'&>
3813 .oindex "&%-Mvb%&"
3814 .cindex "listing" "message body"
3815 .cindex "message" "listing body of"
3816 This option causes the contents of the message body (-D) spool file to be
3817 written to the standard output. This option can be used only by an admin user.
3818
3819 .vitem &%-Mvc%&&~<&'message&~id'&>
3820 .oindex "&%-Mvc%&"
3821 .cindex "message" "listing in RFC 2822 format"
3822 .cindex "listing" "message in RFC 2822 format"
3823 This option causes a copy of the complete message (header lines plus body) to
3824 be written to the standard output in RFC 2822 format. This option can be used
3825 only by an admin user.
3826
3827 .vitem &%-Mvh%&&~<&'message&~id'&>
3828 .oindex "&%-Mvh%&"
3829 .cindex "listing" "message headers"
3830 .cindex "header lines" "listing"
3831 .cindex "message" "listing header lines"
3832 This option causes the contents of the message headers (-H) spool file to be
3833 written to the standard output. This option can be used only by an admin user.
3834
3835 .vitem &%-Mvl%&&~<&'message&~id'&>
3836 .oindex "&%-Mvl%&"
3837 .cindex "listing" "message log"
3838 .cindex "message" "listing message log"
3839 This option causes the contents of the message log spool file to be written to
3840 the standard output. This option can be used only by an admin user.
3841
3842 .vitem &%-m%&
3843 .oindex "&%-m%&"
3844 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3845 treats it that way too.
3846
3847 .vitem &%-N%&
3848 .oindex "&%-N%&"
3849 .cindex "debugging" "&%-N%& option"
3850 .cindex "debugging" "suppressing delivery"
3851 This is a debugging option that inhibits delivery of a message at the transport
3852 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3853 it just doesn't actually transport the message, but instead behaves as if it
3854 had successfully done so. However, it does not make any updates to the retry
3855 database, and the log entries for deliveries are flagged with &"*>"& rather
3856 than &"=>"&.
3857
3858 Because &%-N%& discards any message to which it applies, only root or the Exim
3859 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3860 words, an ordinary user can use it only when supplying an incoming message to
3861 which it will apply. Although transportation never fails when &%-N%& is set, an
3862 address may be deferred because of a configuration problem on a transport, or a
3863 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3864 the message, and applies to any subsequent delivery attempts that may happen
3865 for that message.
3866
3867 .vitem &%-n%&
3868 .oindex "&%-n%&"
3869 .cindex "Sendmail compatibility" "&%-n%& option ignored"
3870 This option is interpreted by Sendmail to mean &"no aliasing"&. It is ignored
3871 by Exim.
3872
3873 .vitem &%-O%&&~<&'data'&>
3874 .oindex "&%-O%&"
3875 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
3876 Exim.
3877
3878 .vitem &%-oA%&&~<&'file&~name'&>
3879 .oindex "&%-oA%&"
3880 .cindex "Sendmail compatibility" "&%-oA%& option"
3881 This option is used by Sendmail in conjunction with &%-bi%& to specify an
3882 alternative alias file name. Exim handles &%-bi%& differently; see the
3883 description above.
3884
3885 .vitem &%-oB%&&~<&'n'&>
3886 .oindex "&%-oB%&"
3887 .cindex "SMTP" "passed connection"
3888 .cindex "SMTP" "multiple deliveries"
3889 .cindex "multiple SMTP deliveries"
3890 This is a debugging option which limits the maximum number of messages that can
3891 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
3892 transport. If <&'n'&> is omitted, the limit is set to 1.
3893
3894 .vitem &%-odb%&
3895 .oindex "&%-odb%&"
3896 .cindex "background delivery"
3897 .cindex "delivery" "in the background"
3898 This option applies to all modes in which Exim accepts incoming messages,
3899 including the listening daemon. It requests &"background"& delivery of such
3900 messages, which means that the accepting process automatically starts a
3901 delivery process for each message received, but does not wait for the delivery
3902 processes to finish.
3903
3904 When all the messages have been received, the reception process exits,
3905 leaving the delivery processes to finish in their own time. The standard output
3906 and error streams are closed at the start of each delivery process.
3907 This is the default action if none of the &%-od%& options are present.
3908
3909 If one of the queueing options in the configuration file
3910 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
3911 overrides it if &%queue_only_override%& is set true, which is the default
3912 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
3913
3914 .vitem &%-odf%&
3915 .oindex "&%-odf%&"
3916 .cindex "foreground delivery"
3917 .cindex "delivery" "in the foreground"
3918 This option requests &"foreground"& (synchronous) delivery when Exim has
3919 accepted a locally-generated message. (For the daemon it is exactly the same as
3920 &%-odb%&.) A delivery process is automatically started to deliver the message,
3921 and Exim waits for it to complete before proceeding.
3922
3923 The original Exim reception process does not finish until the delivery
3924 process for the final message has ended. The standard error stream is left open
3925 during deliveries.
3926
3927 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
3928 false and one of the queueing options in the configuration file is in effect.
3929
3930 If there is a temporary delivery error during foreground delivery, the
3931 message is left on the queue for later delivery, and the original reception
3932 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
3933 restricted configuration that never queues messages.
3934
3935
3936 .vitem &%-odi%&
3937 .oindex "&%-odi%&"
3938 This option is synonymous with &%-odf%&. It is provided for compatibility with
3939 Sendmail.
3940
3941 .vitem &%-odq%&
3942 .oindex "&%-odq%&"
3943 .cindex "non-immediate delivery"
3944 .cindex "delivery" "suppressing immediate"
3945 .cindex "queueing incoming messages"
3946 This option applies to all modes in which Exim accepts incoming messages,
3947 including the listening daemon. It specifies that the accepting process should
3948 not automatically start a delivery process for each message received. Messages
3949 are placed on the queue, and remain there until a subsequent queue runner
3950 process encounters them. There are several configuration options (such as
3951 &%queue_only%&) that can be used to queue incoming messages under certain
3952 conditions. This option overrides all of them and also &%-odqs%&. It always
3953 forces queueing.
3954
3955 .vitem &%-odqs%&
3956 .oindex "&%-odqs%&"
3957 .cindex "SMTP" "delaying delivery"
3958 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
3959 However, like &%-odb%& and &%-odi%&, this option has no effect if
3960 &%queue_only_override%& is false and one of the queueing options in the
3961 configuration file is in effect.
3962
3963 When &%-odqs%& does operate, a delivery process is started for each incoming
3964 message, in the background by default, but in the foreground if &%-odi%& is
3965 also present. The recipient addresses are routed, and local deliveries are done
3966 in the normal way. However, if any SMTP deliveries are required, they are not
3967 done at this time, so the message remains on the queue until a subsequent queue
3968 runner process encounters it. Because routing was done, Exim knows which
3969 messages are waiting for which hosts, and so a number of messages for the same
3970 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
3971 configuration option has the same effect for specific domains. See also the
3972 &%-qq%& option.
3973
3974 .vitem &%-oee%&
3975 .oindex "&%-oee%&"
3976 .cindex "error" "reporting"
3977 If an error is detected while a non-SMTP message is being received (for
3978 example, a malformed address), the error is reported to the sender in a mail
3979 message.
3980
3981 .cindex "return code" "for &%-oee%&"
3982 Provided
3983 this error message is successfully sent, the Exim receiving process
3984 exits with a return code of zero. If not, the return code is 2 if the problem
3985 is that the original message has no recipients, or 1 any other error. This is
3986 the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
3987
3988 .vitem &%-oem%&
3989 .oindex "&%-oem%&"
3990 .cindex "error" "reporting"
3991 .cindex "return code" "for &%-oem%&"
3992 This is the same as &%-oee%&, except that Exim always exits with a non-zero
3993 return code, whether or not the error message was successfully sent.
3994 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
3995
3996 .vitem &%-oep%&
3997 .oindex "&%-oep%&"
3998 .cindex "error" "reporting"
3999 If an error is detected while a non-SMTP message is being received, the
4000 error is reported by writing a message to the standard error file (stderr).
4001 .cindex "return code" "for &%-oep%&"
4002 The return code is 1 for all errors.
4003
4004 .vitem &%-oeq%&
4005 .oindex "&%-oeq%&"
4006 .cindex "error" "reporting"
4007 This option is supported for compatibility with Sendmail, but has the same
4008 effect as &%-oep%&.
4009
4010 .vitem &%-oew%&
4011 .oindex "&%-oew%&"
4012 .cindex "error" "reporting"
4013 This option is supported for compatibility with Sendmail, but has the same
4014 effect as &%-oem%&.
4015
4016 .vitem &%-oi%&
4017 .oindex "&%-oi%&"
4018 .cindex "dot" "in incoming non-SMTP message"
4019 This option, which has the same effect as &%-i%&, specifies that a dot on a
4020 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4021 single dot does terminate, though Exim does no special processing for other
4022 lines that start with a dot. This option is set by default if Exim is called as
4023 &'rmail'&. See also &%-ti%&.
4024
4025 .vitem &%-oitrue%&
4026 .oindex "&%-oitrue%&"
4027 This option is treated as synonymous with &%-oi%&.
4028
4029 .vitem &%-oMa%&&~<&'host&~address'&>
4030 .oindex "&%-oMa%&"
4031 .cindex "sender" "host address, specifying for local message"
4032 A number of options starting with &%-oM%& can be used to set values associated
4033 with remote hosts on locally-submitted messages (that is, messages not received
4034 over TCP/IP). These options can be used by any caller in conjunction with the
4035 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4036 other circumstances, they are ignored unless the caller is trusted.
4037
4038 The &%-oMa%& option sets the sender host address. This may include a port
4039 number at the end, after a full stop (period). For example:
4040 .code
4041 exim -bs -oMa 10.9.8.7.1234
4042 .endd
4043 An alternative syntax is to enclose the IP address in square brackets,
4044 followed by a colon and the port number:
4045 .code
4046 exim -bs -oMa [10.9.8.7]:1234
4047 .endd
4048 The IP address is placed in the &$sender_host_address$& variable, and the
4049 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4050 are present on the command line, the sender host IP address is taken from
4051 whichever one is last.
4052
4053 .vitem &%-oMaa%&&~<&'name'&>
4054 .oindex "&%-oMaa%&"
4055 .cindex "authentication" "name, specifying for local message"
4056 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4057 option sets the value of &$sender_host_authenticated$& (the authenticator
4058 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4059 This option can be used with &%-bh%& and &%-bs%& to set up an
4060 authenticated SMTP session without actually using the SMTP AUTH command.
4061
4062 .vitem &%-oMai%&&~<&'string'&>
4063 .oindex "&%-oMai%&"
4064 .cindex "authentication" "id, specifying for local message"
4065 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4066 option sets the value of &$authenticated_id$& (the id that was authenticated).
4067 This overrides the default value (the caller's login id, except with &%-bh%&,
4068 where there is no default) for messages from local sources. See chapter
4069 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4070
4071 .vitem &%-oMas%&&~<&'address'&>
4072 .oindex "&%-oMas%&"
4073 .cindex "authentication" "sender, specifying for local message"
4074 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4075 option sets the authenticated sender value in &$authenticated_sender$&. It
4076 overrides the sender address that is created from the caller's login id for
4077 messages from local sources, except when &%-bh%& is used, when there is no
4078 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4079 specified on a MAIL command overrides this value. See chapter
4080 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4081
4082 .vitem &%-oMi%&&~<&'interface&~address'&>
4083 .oindex "&%-oMi%&"
4084 .cindex "interface" "address, specifying for local message"
4085 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4086 option sets the IP interface address value. A port number may be included,
4087 using the same syntax as for &%-oMa%&. The interface address is placed in
4088 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4089
4090 .vitem &%-oMr%&&~<&'protocol&~name'&>
4091 .oindex "&%-oMr%&"
4092 .cindex "protocol, specifying for local message"
4093 .vindex "&$received_protocol$&"
4094 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4095 option sets the received protocol value that is stored in
4096 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4097 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4098 SMTP protocol names (see the description of &$received_protocol$& in section
4099 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4100 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4101 be set by &%-oMr%&.
4102
4103 .vitem &%-oMs%&&~<&'host&~name'&>
4104 .oindex "&%-oMs%&"
4105 .cindex "sender" "host name, specifying for local message"
4106 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4107 option sets the sender host name in &$sender_host_name$&. When this option is
4108 present, Exim does not attempt to look up a host name from an IP address; it
4109 uses the name it is given.
4110
4111 .vitem &%-oMt%&&~<&'ident&~string'&>
4112 .oindex "&%-oMt%&"
4113 .cindex "sender" "ident string, specifying for local message"
4114 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4115 option sets the sender ident value in &$sender_ident$&. The default setting for
4116 local callers is the login id of the calling process, except when &%-bh%& is
4117 used, when there is no default.
4118
4119 .vitem &%-om%&
4120 .oindex "&%-om%&"
4121 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4122 In Sendmail, this option means &"me too"&, indicating that the sender of a
4123 message should receive a copy of the message if the sender appears in an alias
4124 expansion. Exim always does this, so the option does nothing.
4125
4126 .vitem &%-oo%&
4127 .oindex "&%-oo%&"
4128 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4129 This option is ignored. In Sendmail it specifies &"old style headers"&,
4130 whatever that means.
4131
4132 .vitem &%-oP%&&~<&'path'&>
4133 .oindex "&%-oP%&"
4134 .cindex "pid (process id)" "of daemon"
4135 .cindex "daemon" "process id (pid)"
4136 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4137 value. The option specifies the file to which the process id of the daemon is
4138 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4139 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4140 because in those cases, the normal pid file is not used.
4141
4142 .vitem &%-or%&&~<&'time'&>
4143 .oindex "&%-or%&"
4144 .cindex "timeout" "for non-SMTP input"
4145 This option sets a timeout value for incoming non-SMTP messages. If it is not
4146 set, Exim will wait forever for the standard input. The value can also be set
4147 by the &%receive_timeout%& option. The format used for specifying times is
4148 described in section &<<SECTtimeformat>>&.
4149
4150 .vitem &%-os%&&~<&'time'&>
4151 .oindex "&%-os%&"
4152 .cindex "timeout" "for SMTP input"
4153 .cindex "SMTP" "input timeout"
4154 This option sets a timeout value for incoming SMTP messages. The timeout
4155 applies to each SMTP command and block of data. The value can also be set by
4156 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4157 for specifying times is described in section &<<SECTtimeformat>>&.
4158
4159 .vitem &%-ov%&
4160 .oindex "&%-ov%&"
4161 This option has exactly the same effect as &%-v%&.
4162
4163 .vitem &%-oX%&&~<&'number&~or&~string'&>
4164 .oindex "&%-oX%&"
4165 .cindex "TCP/IP" "setting listening ports"
4166 .cindex "TCP/IP" "setting listening interfaces"
4167 .cindex "port" "receiving TCP/IP"
4168 This option is relevant only when the &%-bd%& (start listening daemon) option
4169 is also given. It controls which ports and interfaces the daemon uses. Details
4170 of the syntax, and how it interacts with configuration file options, are given
4171 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4172 file is written unless &%-oP%& is also present to specify a pid file name.
4173
4174 .vitem &%-pd%&
4175 .oindex "&%-pd%&"
4176 .cindex "Perl" "starting the interpreter"
4177 This option applies when an embedded Perl interpreter is linked with Exim (see
4178 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4179 option, forcing the starting of the interpreter to be delayed until it is
4180 needed.
4181
4182 .vitem &%-ps%&
4183 .oindex "&%-ps%&"
4184 .cindex "Perl" "starting the interpreter"
4185 This option applies when an embedded Perl interpreter is linked with Exim (see
4186 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4187 option, forcing the starting of the interpreter to occur as soon as Exim is
4188 started.
4189
4190 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4191 .oindex "&%-p%&"
4192 For compatibility with Sendmail, this option is equivalent to
4193 .display
4194 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4195 .endd
4196 It sets the incoming protocol and host name (for trusted callers). The
4197 host name and its colon can be omitted when only the protocol is to be set.
4198 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4199 to embedded Perl. It is therefore impossible to set a protocol value of &`p`&
4200 or &`s`& using this option (but that does not seem a real limitation).
4201
4202 .vitem &%-q%&
4203 .oindex "&%-q%&"
4204 .cindex "queue runner" "starting manually"
4205 This option is normally restricted to admin users. However, there is a
4206 configuration option called &%prod_requires_admin%& which can be set false to
4207 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4208 and &%-S%& options).
4209
4210 .cindex "queue runner" "description of operation"
4211 The &%-q%& option starts one queue runner process. This scans the queue of
4212 waiting messages, and runs a delivery process for each one in turn. It waits
4213 for each delivery process to finish before starting the next one. A delivery
4214 process may not actually do any deliveries if the retry times for the addresses
4215 have not been reached. Use &%-qf%& (see below) if you want to override this.
4216
4217 If
4218 .cindex "SMTP" "passed connection"
4219 .cindex "SMTP" "multiple deliveries"
4220 .cindex "multiple SMTP deliveries"
4221 the delivery process spawns other processes to deliver other messages down
4222 passed SMTP connections, the queue runner waits for these to finish before
4223 proceeding.
4224
4225 When all the queued messages have been considered, the original queue runner
4226 process terminates. In other words, a single pass is made over the waiting
4227 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4228 this to be repeated periodically.
4229
4230 Exim processes the waiting messages in an unpredictable order. It isn't very
4231 random, but it is likely to be different each time, which is all that matters.
4232 If one particular message screws up a remote MTA, other messages to the same
4233 MTA have a chance of getting through if they get tried first.
4234
4235 It is possible to cause the messages to be processed in lexical message id
4236 order, which is essentially the order in which they arrived, by setting the
4237 &%queue_run_in_order%& option, but this is not recommended for normal use.
4238
4239 .vitem &%-q%&<&'qflags'&>
4240 The &%-q%& option may be followed by one or more flag letters that change its
4241 behaviour. They are all optional, but if more than one is present, they must
4242 appear in the correct order. Each flag is described in a separate item below.
4243
4244 .vitem &%-qq...%&
4245 .oindex "&%-qq%&"
4246 .cindex "queue" "double scanning"
4247 .cindex "queue" "routing"
4248 .cindex "routing" "whole queue before delivery"
4249 An option starting with &%-qq%& requests a two-stage queue run. In the first
4250 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4251 every domain. Addresses are routed, local deliveries happen, but no remote
4252 transports are run.
4253
4254 .cindex "hints database" "remembering routing"
4255 The hints database that remembers which messages are waiting for specific hosts
4256 is updated, as if delivery to those hosts had been deferred. After this is
4257 complete, a second, normal queue scan happens, with routing and delivery taking
4258 place as normal. Messages that are routed to the same host should mostly be
4259 delivered down a single SMTP
4260 .cindex "SMTP" "passed connection"
4261 .cindex "SMTP" "multiple deliveries"
4262 .cindex "multiple SMTP deliveries"
4263 connection because of the hints that were set up during the first queue scan.
4264 This option may be useful for hosts that are connected to the Internet
4265 intermittently.
4266
4267 .vitem &%-q[q]i...%&
4268 .oindex "&%-qi%&"
4269 .cindex "queue" "initial delivery"
4270 If the &'i'& flag is present, the queue runner runs delivery processes only for
4271 those messages that haven't previously been tried. (&'i'& stands for &"initial
4272 delivery"&.) This can be helpful if you are putting messages on the queue using
4273 &%-odq%& and want a queue runner just to process the new messages.
4274
4275 .vitem &%-q[q][i]f...%&
4276 .oindex "&%-qf%&"
4277 .cindex "queue" "forcing delivery"
4278 .cindex "delivery" "forcing in queue run"
4279 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4280 message, whereas without &'f'& only those non-frozen addresses that have passed
4281 their retry times are tried.
4282
4283 .vitem &%-q[q][i]ff...%&
4284 .oindex "&%-qff%&"
4285 .cindex "frozen messages" "forcing delivery"
4286 If &'ff'& is present, a delivery attempt is forced for every message, whether
4287 frozen or not.
4288
4289 .vitem &%-q[q][i][f[f]]l%&
4290 .oindex "&%-ql%&"
4291 .cindex "queue" "local deliveries only"
4292 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4293 be done. If a message requires any remote deliveries, it remains on the queue
4294 for later delivery.
4295
4296 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4297 .cindex "queue" "delivering specific messages"
4298 When scanning the queue, Exim can be made to skip over messages whose ids are
4299 lexically less than a given value by following the &%-q%& option with a
4300 starting message id. For example:
4301 .code
4302 exim -q 0t5C6f-0000c8-00
4303 .endd
4304 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4305 second message id is given, messages whose ids are lexically greater than it
4306 are also skipped. If the same id is given twice, for example,
4307 .code
4308 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4309 .endd
4310 just one delivery process is started, for that message. This differs from
4311 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4312 that it counts as a delivery from a queue run. Note that the selection
4313 mechanism does not affect the order in which the messages are scanned. There
4314 are also other ways of selecting specific sets of messages for delivery in a
4315 queue run &-- see &%-R%& and &%-S%&.
4316
4317 .vitem &%-q%&<&'qflags'&><&'time'&>
4318 .cindex "queue runner" "starting periodically"
4319 .cindex "periodic queue running"
4320 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4321 starting a queue runner process at intervals specified by the given time value
4322 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4323 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4324 single daemon process handles both functions. A common way of starting up a
4325 combined daemon at system boot time is to use a command such as
4326 .code
4327 /usr/exim/bin/exim -bd -q30m
4328 .endd
4329 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4330 process every 30 minutes.
4331
4332 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4333 pid file is written unless one is explicitly requested by the &%-oP%& option.
4334
4335 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4336 .oindex "&%-qR%&"
4337 This option is synonymous with &%-R%&. It is provided for Sendmail
4338 compatibility.
4339
4340 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4341 .oindex "&%-qS%&"
4342 This option is synonymous with &%-S%&.
4343
4344 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4345 .oindex "&%-R%&"
4346 .cindex "queue runner" "for specific recipients"
4347 .cindex "delivery" "to given domain"
4348 .cindex "domain" "delivery to"
4349 The <&'rsflags'&> may be empty, in which case the white space before the string
4350 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4351 which are the possible values for <&'rsflags'&>. White space is required if
4352 <&'rsflags'&> is not empty.
4353
4354 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4355 perform a single queue run, except that, when scanning the messages on the
4356 queue, Exim processes only those that have at least one undelivered recipient
4357 address containing the given string, which is checked in a case-independent
4358 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4359 regular expression; otherwise it is a literal string.
4360
4361 If you want to do periodic queue runs for messages with specific recipients,
4362 you can combine &%-R%& with &%-q%& and a time value. For example:
4363 .code
4364 exim -q25m -R @special.domain.example
4365 .endd
4366 This example does a queue run for messages with recipients in the given domain
4367 every 25 minutes. Any additional flags that are specified with &%-q%& are
4368 applied to each queue run.
4369
4370 Once a message is selected for delivery by this mechanism, all its addresses
4371 are processed. For the first selected message, Exim overrides any retry
4372 information and forces a delivery attempt for each undelivered address. This
4373 means that if delivery of any address in the first message is successful, any
4374 existing retry information is deleted, and so delivery attempts for that
4375 address in subsequently selected messages (which are processed without forcing)
4376 will run. However, if delivery of any address does not succeed, the retry
4377 information is updated, and in subsequently selected messages, the failing
4378 address will be skipped.
4379
4380 .cindex "frozen messages" "forcing delivery"
4381 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4382 all selected messages, not just the first; frozen messages are included when
4383 &'ff'& is present.
4384
4385 The &%-R%& option makes it straightforward to initiate delivery of all messages
4386 to a given domain after a host has been down for some time. When the SMTP
4387 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4388 effect is to run Exim with the &%-R%& option, but it can be configured to run
4389 an arbitrary command instead.
4390
4391 .vitem &%-r%&
4392 .oindex "&%-r%&"
4393 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4394
4395 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4396 .oindex "&%-S%&"
4397 .cindex "delivery" "from given sender"
4398 .cindex "queue runner" "for specific senders"
4399 This option acts like &%-R%& except that it checks the string against each
4400 message's sender instead of against the recipients. If &%-R%& is also set, both
4401 conditions must be met for a message to be selected. If either of the options
4402 has &'f'& or &'ff'& in its flags, the associated action is taken.
4403
4404 .vitem &%-Tqt%&&~<&'times'&>
4405 .oindex "&%-Tqt%&"
4406 This an option that is exclusively for use by the Exim testing suite. It is not
4407 recognized when Exim is run normally. It allows for the setting up of explicit
4408 &"queue times"& so that various warning/retry features can be tested.
4409
4410 .vitem &%-t%&
4411 .oindex "&%-t%&"
4412 .cindex "recipient" "extracting from header lines"
4413 .cindex "&'Bcc:'& header line"
4414 .cindex "&'Cc:'& header line"
4415 .cindex "&'To:'& header line"
4416 When Exim is receiving a locally-generated, non-SMTP message on its standard
4417 input, the &%-t%& option causes the recipients of the message to be obtained
4418 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4419 from the command arguments. The addresses are extracted before any rewriting
4420 takes place and the &'Bcc:'& header line, if present, is then removed.
4421
4422 .cindex "Sendmail compatibility" "&%-t%& option"
4423 If the command has any arguments, they specify addresses to which the message
4424 is &'not'& to be delivered. That is, the argument addresses are removed from
4425 the recipients list obtained from the headers. This is compatible with Smail 3
4426 and in accordance with the documented behaviour of several versions of
4427 Sendmail, as described in man pages on a number of operating systems (e.g.
4428 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4429 argument addresses to those obtained from the headers, and the O'Reilly
4430 Sendmail book documents it that way. Exim can be made to add argument addresses
4431 instead of subtracting them by setting the option
4432 &%extract_addresses_remove_arguments%& false.
4433
4434 .cindex "&%Resent-%& header lines" "with &%-t%&"
4435 If there are any &%Resent-%& header lines in the message, Exim extracts
4436 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4437 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4438 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4439 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4440
4441 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4442 message is resent several times). The RFC also specifies that they should be
4443 added at the front of the message, and separated by &'Received:'& lines. It is
4444 not at all clear how &%-t%& should operate in the present of multiple sets,
4445 nor indeed exactly what constitutes a &"set"&.
4446 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4447 are often added at the end of the header, and if a message is resent more than
4448 once, it is common for the original set of &%Resent-%& headers to be renamed as
4449 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4450
4451 .vitem &%-ti%&
4452 .oindex "&%-ti%&"
4453 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4454 compatibility with Sendmail.
4455
4456 .vitem &%-tls-on-connect%&
4457 .oindex "&%-tls-on-connect%&"
4458 .cindex "TLS" "use without STARTTLS"
4459 .cindex "TLS" "automatic start"
4460 This option is available when Exim is compiled with TLS support. It forces all
4461 incoming SMTP connections to behave as if the incoming port is listed in the
4462 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4463 &<<CHAPTLS>>& for further details.
4464
4465
4466 .vitem &%-U%&
4467 .oindex "&%-U%&"
4468 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4469 Sendmail uses this option for &"initial message submission"&, and its
4470 documentation states that in future releases, it may complain about
4471 syntactically invalid messages rather than fixing them when this flag is not
4472 set. Exim ignores this option.
4473
4474 .vitem &%-v%&
4475 .oindex "&%-v%&"
4476 This option causes Exim to write information to the standard error stream,
4477 describing what it is doing. In particular, it shows the log lines for
4478 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4479 dialogue is shown. Some of the log lines shown may not actually be written to
4480 the log if the setting of &%log_selector%& discards them. Any relevant
4481 selectors are shown with each log line. If none are shown, the logging is
4482 unconditional.
4483
4484 .vitem &%-x%&
4485 .oindex "&%-x%&"
4486 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4487 National Language Support extended characters in the body of the mail item"&).
4488 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4489 this option.
4490 .endlist
4491
4492 .ecindex IIDclo1
4493 .ecindex IIDclo2
4494
4495
4496 . ////////////////////////////////////////////////////////////////////////////
4497 . Insert a stylized DocBook comment here, to identify the end of the command
4498 . line options. This is for the benefit of the Perl script that automatically
4499 . creates a man page for the options.
4500 . ////////////////////////////////////////////////////////////////////////////
4501
4502 .literal xml
4503 <!-- === End of command line options === -->
4504 .literal off
4505
4506
4507
4508
4509
4510 . ////////////////////////////////////////////////////////////////////////////
4511 . ////////////////////////////////////////////////////////////////////////////
4512
4513
4514 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4515          "The runtime configuration file"
4516
4517 .cindex "run time configuration"
4518 .cindex "configuration file" "general description"
4519 .cindex "CONFIGURE_FILE"
4520 .cindex "configuration file" "errors in"
4521 .cindex "error" "in configuration file"
4522 .cindex "return code" "for bad configuration"
4523 Exim uses a single run time configuration file that is read whenever an Exim
4524 binary is executed. Note that in normal operation, this happens frequently,
4525 because Exim is designed to operate in a distributed manner, without central
4526 control.
4527
4528 If a syntax error is detected while reading the configuration file, Exim
4529 writes a message on the standard error, and exits with a non-zero return code.
4530 The message is also written to the panic log. &*Note*&: Only simple syntax
4531 errors can be detected at this time. The values of any expanded options are
4532 not checked until the expansion happens, even when the expansion does not
4533 actually alter the string.
4534
4535 The name of the configuration file is compiled into the binary for security
4536 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4537 most configurations, this specifies a single file. However, it is permitted to
4538 give a colon-separated list of file names, in which case Exim uses the first
4539 existing file in the list.
4540
4541 .new
4542 .cindex "EXIM_USER"
4543 .cindex "EXIM_GROUP"
4544 .cindex "CONFIGURE_OWNER"
4545 .cindex "CONFIGURE_GROUP"
4546 .cindex "configuration file" "ownership"
4547 .cindex "ownership" "configuration file"
4548 The run time configuration file must be owned by root or by the user that is
4549 specified at compile time by the CONFIGURE_OWNER option (if set). The
4550 configuration file must not be world-writeable, or group-writeable unless its
4551 group is the root group or the one specified at compile time by the
4552 CONFIGURE_GROUP option.
4553
4554 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4555 to root, anybody who is able to edit the run time configuration file has an
4556 easy way to run commands as root. If you specify a user or group in the
4557 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4558 who are members of that group will trivially be able to obtain root privileges.
4559
4560 Up to Exim version 4.72, the run time configuration file was also permitted to
4561 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4562 since it offered a simple privilege escalation for any attacker who managed to
4563 compromise the Exim user account.
4564
4565 A default configuration file, which will work correctly in simple situations,
4566 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4567 defines just one file name, the installation process copies the default
4568 configuration to a new file of that name if it did not previously exist. If
4569 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4570 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4571 configuration.
4572 .wen
4573
4574
4575 .section "Using a different configuration file" "SECID40"
4576 .cindex "configuration file" "alternate"
4577 A one-off alternate configuration can be specified by the &%-C%& command line
4578 option, which may specify a single file or a list of files. However, when
4579 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4580 unless the argument for &%-C%& is identical to the built-in value from
4581 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4582 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4583 is useful mainly for checking the syntax of configuration files before
4584 installing them. No owner or group checks are done on a configuration file
4585 specified by &%-C%&, if root privilege has been dropped.
4586
4587 Even the Exim user is not trusted to specify an arbitrary configuration file
4588 with the &%-C%& option to be used with root privileges, unless that file is
4589 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4590 testing a configuration using &%-C%& right through message reception and
4591 delivery, even if the caller is root. The reception works, but by that time,
4592 Exim is running as the Exim user, so when it re-execs to regain privilege for
4593 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4594 can test reception and delivery using two separate commands (one to put a
4595 message on the queue, using &%-odq%&, and another to do the delivery, using
4596 &%-M%&).
4597
4598 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4599 prefix string with which any file named in a &%-C%& command line option must
4600 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4601 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4602 name can be used with &%-C%&.
4603
4604 One-off changes to a configuration can be specified by the &%-D%& command line
4605 option, which defines and overrides values for macros used inside the
4606 configuration file. However, like &%-C%&, the use of this option by a
4607 non-privileged user causes Exim to discard its root privilege.
4608 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4609 completely disabled, and its use causes an immediate error exit.
4610
4611 .new
4612 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4613 to declare certain macro names trusted, such that root privilege will not
4614 necessarily be discarded.
4615 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4616 considered safe and, if &%-D%& only supplies macros from this list, and the
4617 values are acceptable, then Exim will not give up root privilege if the caller
4618 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4619 transition mechanism and is expected to be removed in the future.  Acceptable
4620 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4621 .wen
4622
4623 Some sites may wish to use the same Exim binary on different machines that
4624 share a file system, but to use different configuration files on each machine.
4625 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4626 looks for a file whose name is the configuration file name followed by a dot
4627 and the machine's node name, as obtained from the &[uname()]& function. If this
4628 file does not exist, the standard name is tried. This processing occurs for
4629 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4630
4631 In some esoteric situations different versions of Exim may be run under
4632 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4633 help with this. See the comments in &_src/EDITME_& for details.
4634
4635
4636
4637 .section "Configuration file format" "SECTconffilfor"
4638 .cindex "configuration file" "format of"
4639 .cindex "format" "configuration file"
4640 Exim's configuration file is divided into a number of different parts. General
4641 option settings must always appear at the start of the file. The other parts
4642 are all optional, and may appear in any order. Each part other than the first
4643 is introduced by the word &"begin"& followed by the name of the part. The
4644 optional parts are:
4645
4646 .ilist
4647 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4648 &<<CHAPACL>>&).
4649 .next
4650 .cindex "AUTH" "configuration"
4651 &'authenticators'&: Configuration settings for the authenticator drivers. These
4652 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4653 .next
4654 &'routers'&: Configuration settings for the router drivers. Routers process
4655 addresses and determine how the message is to be delivered (see chapters
4656 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4657 .next
4658 &'transports'&: Configuration settings for the transport drivers. Transports
4659 define mechanisms for copying messages to destinations (see chapters
4660 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4661 .next
4662 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4663 If there is no retry section, or if it is empty (that is, no retry rules are
4664 defined), Exim will not retry deliveries. In this situation, temporary errors
4665 are treated the same as permanent errors. Retry rules are discussed in chapter
4666 &<<CHAPretry>>&.
4667 .next
4668 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4669 when new addresses are generated during delivery. Rewriting is discussed in
4670 chapter &<<CHAPrewrite>>&.
4671 .next
4672 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4673 want to use this feature, you must set
4674 .code
4675 LOCAL_SCAN_HAS_OPTIONS=yes
4676 .endd
4677 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4678 facility are given in chapter &<<CHAPlocalscan>>&.
4679 .endlist
4680
4681 .cindex "configuration file" "leading white space in"
4682 .cindex "configuration file" "trailing white space in"
4683 .cindex "white space" "in configuration file"
4684 Leading and trailing white space in configuration lines is always ignored.
4685
4686 Blank lines in the file, and lines starting with a # character (ignoring
4687 leading white space) are treated as comments and are ignored. &*Note*&: A
4688 # character other than at the beginning of a line is not treated specially,
4689 and does not introduce a comment.
4690
4691 Any non-comment line can be continued by ending it with a backslash. Note that
4692 the general rule for white space means that trailing white space after the
4693 backslash and leading white space at the start of continuation
4694 lines is ignored. Comment lines beginning with # (but not empty lines) may
4695 appear in the middle of a sequence of continuation lines.
4696
4697 A convenient way to create a configuration file is to start from the
4698 default, which is supplied in &_src/configure.default_&, and add, delete, or
4699 change settings as required.
4700
4701 The ACLs, retry rules, and rewriting rules have their own syntax which is
4702 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4703 respectively. The other parts of the configuration file have some syntactic
4704 items in common, and these are described below, from section &<<SECTcos>>&
4705 onwards. Before that, the inclusion, macro, and conditional facilities are
4706 described.
4707
4708
4709
4710 .section "File inclusions in the configuration file" "SECID41"
4711 .cindex "inclusions in configuration file"
4712 .cindex "configuration file" "including other files"
4713 .cindex "&`.include`& in configuration file"
4714 .cindex "&`.include_if_exists`& in configuration file"
4715 You can include other files inside Exim's run time configuration file by
4716 using this syntax:
4717 .display
4718 &`.include`& <&'file name'&>
4719 &`.include_if_exists`& <&'file name'&>
4720 .endd
4721 on a line by itself. Double quotes round the file name are optional. If you use
4722 the first form, a configuration error occurs if the file does not exist; the
4723 second form does nothing for non-existent files. In all cases, an absolute file
4724 name is required.
4725
4726 Includes may be nested to any depth, but remember that Exim reads its
4727 configuration file often, so it is a good idea to keep them to a minimum.
4728 If you change the contents of an included file, you must HUP the daemon,
4729 because an included file is read only when the configuration itself is read.
4730
4731 The processing of inclusions happens early, at a physical line level, so, like
4732 comment lines, an inclusion can be used in the middle of an option setting,
4733 for example:
4734 .code
4735 hosts_lookup = a.b.c \
4736                .include /some/file
4737 .endd
4738 Include processing happens after macro processing (see below). Its effect is to
4739 process the lines of the included file as if they occurred inline where the
4740 inclusion appears.
4741
4742
4743
4744 .section "Macros in the configuration file" "SECTmacrodefs"
4745 .cindex "macro" "description of"
4746 .cindex "configuration file" "macros"
4747 If a line in the main part of the configuration (that is, before the first
4748 &"begin"& line) begins with an upper case letter, it is taken as a macro
4749 definition, and must be of the form
4750 .display
4751 <&'name'&> = <&'rest of line'&>
4752 .endd
4753 The name must consist of letters, digits, and underscores, and need not all be
4754 in upper case, though that is recommended. The rest of the line, including any
4755 continuations, is the replacement text, and has leading and trailing white
4756 space removed. Quotes are not removed. The replacement text can never end with
4757 a backslash character, but this doesn't seem to be a serious limitation.
4758
4759 Macros may also be defined between router, transport, authenticator, or ACL
4760 definitions. They may not, however, be defined within an individual driver or
4761 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4762
4763 .section "Macro substitution" "SECID42"
4764 Once a macro is defined, all subsequent lines in the file (and any included
4765 files) are scanned for the macro name; if there are several macros, the line is
4766 scanned for each in turn, in the order in which the macros are defined. The
4767 replacement text is not re-scanned for the current macro, though it is scanned
4768 for subsequently defined macros. For this reason, a macro name may not contain
4769 the name of a previously defined macro as a substring. You could, for example,
4770 define
4771 .display
4772 &`ABCD_XYZ = `&<&'something'&>
4773 &`ABCD = `&<&'something else'&>
4774 .endd
4775 but putting the definitions in the opposite order would provoke a configuration
4776 error. Macro expansion is applied to individual physical lines from the file,
4777 before checking for line continuation or file inclusion (see above). If a line
4778 consists solely of a macro name, and the expansion of the macro is empty, the
4779 line is ignored. A macro at the start of a line may turn the line into a
4780 comment line or a &`.include`& line.
4781
4782
4783 .section "Redefining macros" "SECID43"
4784 Once defined, the value of a macro can be redefined later in the configuration
4785 (or in an included file). Redefinition is specified by using &'=='& instead of
4786 &'='&. For example:
4787 .code
4788 MAC =  initial value
4789 ...
4790 MAC == updated value
4791 .endd
4792 Redefinition does not alter the order in which the macros are applied to the
4793 subsequent lines of the configuration file. It is still the same order in which
4794 the macros were originally defined. All that changes is the macro's value.
4795 Redefinition makes it possible to accumulate values. For example:
4796 .code
4797 MAC =  initial value
4798 ...
4799 MAC == MAC and something added
4800 .endd
4801 This can be helpful in situations where the configuration file is built
4802 from a number of other files.
4803
4804 .section "Overriding macro values" "SECID44"
4805 The values set for macros in the configuration file can be overridden by the
4806 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4807 used, unless called by root or the Exim user. A definition on the command line
4808 using the &%-D%& option causes all definitions and redefinitions within the
4809 file to be ignored.
4810
4811
4812
4813 .section "Example of macro usage" "SECID45"
4814 As an example of macro usage, consider a configuration where aliases are looked
4815 up in a MySQL database. It helps to keep the file less cluttered if long
4816 strings such as SQL statements are defined separately as macros, for example:
4817 .code
4818 ALIAS_QUERY = select mailbox from user where \
4819               login='${quote_mysql:$local_part}';
4820 .endd
4821 This can then be used in a &(redirect)& router setting like this:
4822 .code
4823 data = ${lookup mysql{ALIAS_QUERY}}
4824 .endd
4825 In earlier versions of Exim macros were sometimes used for domain, host, or
4826 address lists. In Exim 4 these are handled better by named lists &-- see
4827 section &<<SECTnamedlists>>&.
4828
4829
4830 .section "Conditional skips in the configuration file" "SECID46"
4831 .cindex "configuration file" "conditional skips"
4832 .cindex "&`.ifdef`&"
4833 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4834 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4835 portions of the configuration file. The processing happens whenever the file is
4836 read (that is, when an Exim binary starts to run).
4837
4838 The implementation is very simple. Instances of the first four directives must
4839 be followed by text that includes the names of one or macros. The condition
4840 that is tested is whether or not any macro substitution has taken place in the
4841 line. Thus:
4842 .code
4843 .ifdef AAA
4844 message_size_limit = 50M
4845 .else
4846 message_size_limit = 100M
4847 .endif
4848 .endd
4849 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
4850 otherwise. If there is more than one macro named on the line, the condition
4851 is true if any of them are defined. That is, it is an &"or"& condition. To
4852 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
4853
4854 Although you can use a macro expansion to generate one of these directives,
4855 it is not very useful, because the condition &"there was a macro substitution
4856 in this line"& will always be true.
4857
4858 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
4859 to clarify complicated nestings.
4860
4861
4862
4863 .section "Common option syntax" "SECTcos"
4864 .cindex "common option syntax"
4865 .cindex "syntax of common options"
4866 .cindex "configuration file" "common option syntax"
4867 For the main set of options, driver options, and &[local_scan()]& options,
4868 each setting is on a line by itself, and starts with a name consisting of
4869 lower-case letters and underscores. Many options require a data value, and in
4870 these cases the name must be followed by an equals sign (with optional white
4871 space) and then the value. For example:
4872 .code
4873 qualify_domain = mydomain.example.com
4874 .endd
4875 .cindex "hiding configuration option values"
4876 .cindex "configuration options" "hiding value of"
4877 .cindex "options" "hiding value of"
4878 Some option settings may contain sensitive data, for example, passwords for
4879 accessing databases. To stop non-admin users from using the &%-bP%& command
4880 line option to read these values, you can precede the option settings with the
4881 word &"hide"&. For example:
4882 .code
4883 hide mysql_servers = localhost/users/admin/secret-password
4884 .endd
4885 For non-admin users, such options are displayed like this:
4886 .code
4887 mysql_servers = <value not displayable>
4888 .endd
4889 If &"hide"& is used on a driver option, it hides the value of that option on
4890 all instances of the same driver.
4891
4892 The following sections describe the syntax used for the different data types
4893 that are found in option settings.
4894
4895
4896 .section "Boolean options" "SECID47"
4897 .cindex "format" "boolean"
4898 .cindex "boolean configuration values"
4899 .oindex "&%no_%&&'xxx'&"
4900 .oindex "&%not_%&&'xxx'&"
4901 Options whose type is given as boolean are on/off switches. There are two
4902 different ways of specifying such options: with and without a data value. If
4903 the option name is specified on its own without data, the switch is turned on;
4904 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
4905 boolean options may be followed by an equals sign and one of the words
4906 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
4907 the following two settings have exactly the same effect:
4908 .code
4909 queue_only
4910 queue_only = true
4911 .endd
4912 The following two lines also have the same (opposite) effect:
4913 .code
4914 no_queue_only
4915 queue_only = false
4916 .endd
4917 You can use whichever syntax you prefer.
4918
4919
4920
4921
4922 .section "Integer values" "SECID48"
4923 .cindex "integer configuration values"
4924 .cindex "format" "integer"
4925 If an option's type is given as &"integer"&, the value can be given in decimal,
4926 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
4927 number is assumed. Otherwise, it is treated as an octal number unless it starts
4928 with the characters &"0x"&, in which case the remainder is interpreted as a
4929 hexadecimal number.
4930
4931 If an integer value is followed by the letter K, it is multiplied by 1024; if
4932 it is followed by the letter M, it is multiplied by 1024x1024. When the values
4933 of integer option settings are output, values which are an exact multiple of
4934 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
4935 and M. The printing style is independent of the actual input format that was
4936 used.
4937
4938
4939 .section "Octal integer values" "SECID49"
4940 .cindex "integer format"
4941 .cindex "format" "octal integer"
4942 If an option's type is given as &"octal integer"&, its value is always
4943 interpreted as an octal number, whether or not it starts with the digit zero.
4944 Such options are always output in octal.
4945
4946
4947 .section "Fixed point numbers" "SECID50"
4948 .cindex "fixed point configuration values"
4949 .cindex "format" "fixed point"
4950 If an option's type is given as &"fixed-point"&, its value must be a decimal
4951 integer, optionally followed by a decimal point and up to three further digits.
4952
4953
4954
4955 .section "Time intervals" "SECTtimeformat"
4956 .cindex "time interval" "specifying in configuration"
4957 .cindex "format" "time interval"
4958 A time interval is specified as a sequence of numbers, each followed by one of
4959 the following letters, with no intervening white space:
4960
4961 .table2 30pt
4962 .irow &%s%& seconds
4963 .irow &%m%& minutes
4964 .irow &%h%& hours
4965 .irow &%d%& days
4966 .irow &%w%& weeks
4967 .endtable
4968
4969 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
4970 intervals are output in the same format. Exim does not restrict the values; it
4971 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
4972
4973
4974
4975 .section "String values" "SECTstrings"
4976 .cindex "string" "format of configuration values"
4977 .cindex "format" "string"
4978 If an option's type is specified as &"string"&, the value can be specified with
4979 or without double-quotes. If it does not start with a double-quote, the value
4980 consists of the remainder of the line plus any continuation lines, starting at
4981 the first character after any leading white space, with trailing white space
4982 removed, and with no interpretation of the characters in the string. Because
4983 Exim removes comment lines (those beginning with #) at an early stage, they can
4984 appear in the middle of a multi-line string. The following two settings are
4985 therefore equivalent:
4986 .code
4987 trusted_users = uucp:mail
4988 trusted_users = uucp:\
4989                 # This comment line is ignored
4990                 mail
4991 .endd
4992 .cindex "string" "quoted"
4993 .cindex "escape characters in quoted strings"
4994 If a string does start with a double-quote, it must end with a closing
4995 double-quote, and any backslash characters other than those used for line
4996 continuation are interpreted as escape characters, as follows:
4997
4998 .table2 100pt
4999 .irow &`\\`&                     "single backslash"
5000 .irow &`\n`&                     "newline"
5001 .irow &`\r`&                     "carriage return"
5002 .irow &`\t`&                     "tab"
5003 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5004 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5005                                    character"
5006 .endtable
5007
5008 If a backslash is followed by some other character, including a double-quote
5009 character, that character replaces the pair.
5010
5011 Quoting is necessary only if you want to make use of the backslash escapes to
5012 insert special characters, or if you need to specify a value with leading or
5013 trailing spaces. These cases are rare, so quoting is almost never needed in
5014 current versions of Exim. In versions of Exim before 3.14, quoting was required
5015 in order to continue lines, so you may come across older configuration files
5016 and examples that apparently quote unnecessarily.
5017
5018
5019 .section "Expanded strings" "SECID51"
5020 .cindex "expansion" "definition of"
5021 Some strings in the configuration file are subjected to &'string expansion'&,
5022 by which means various parts of the string may be changed according to the
5023 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5024 is as just described; in particular, the handling of backslashes in quoted
5025 strings is done as part of the input process, before expansion takes place.
5026 However, backslash is also an escape character for the expander, so any
5027 backslashes that are required for that reason must be doubled if they are
5028 within a quoted configuration string.
5029
5030
5031 .section "User and group names" "SECID52"
5032 .cindex "user name" "format of"
5033 .cindex "format" "user name"
5034 .cindex "groups" "name format"
5035 .cindex "format" "group name"
5036 User and group names are specified as strings, using the syntax described
5037 above, but the strings are interpreted specially. A user or group name must
5038 either consist entirely of digits, or be a name that can be looked up using the
5039 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5040
5041
5042 .section "List construction" "SECTlistconstruct"
5043 .cindex "list" "syntax of in configuration"
5044 .cindex "format" "list item in configuration"
5045 .cindex "string" "list, definition of"
5046 The data for some configuration options is a list of items, with colon as the
5047 default separator. Many of these options are shown with type &"string list"& in
5048 the descriptions later in this document. Others are listed as &"domain list"&,
5049 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5050 are all the same; however, those other than &"string list"& are subject to
5051 particular kinds of interpretation, as described in chapter
5052 &<<CHAPdomhosaddlists>>&.
5053
5054 In all these cases, the entire list is treated as a single string as far as the
5055 input syntax is concerned. The &%trusted_users%& setting in section
5056 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5057 in a list, it must be entered as two colons. Leading and trailing white space
5058 on each item in a list is ignored. This makes it possible to include items that
5059 start with a colon, and in particular, certain forms of IPv6 address. For
5060 example, the list
5061 .code
5062 local_interfaces = 127.0.0.1 : ::::1
5063 .endd
5064 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5065
5066 &*Note*&: Although leading and trailing white space is ignored in individual
5067 list items, it is not ignored when parsing the list. The space after the first
5068 colon in the example above is necessary. If it were not there, the list would
5069 be interpreted as the two items 127.0.0.1:: and 1.
5070
5071 .section "Changing list separators" "SECID53"
5072 .cindex "list separator" "changing"
5073 .cindex "IPv6" "addresses in lists"
5074 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5075 introduced to allow the separator character to be changed. If a list begins
5076 with a left angle bracket, followed by any punctuation character, that
5077 character is used instead of colon as the list separator. For example, the list
5078 above can be rewritten to use a semicolon separator like this:
5079 .code
5080 local_interfaces = <; 127.0.0.1 ; ::1
5081 .endd
5082 This facility applies to all lists, with the exception of the list in
5083 &%log_file_path%&. It is recommended that the use of non-colon separators be
5084 confined to circumstances where they really are needed.
5085
5086 .cindex "list separator" "newline as"
5087 .cindex "newline" "as list separator"
5088 It is also possible to use newline and other control characters (those with
5089 code values less than 32, plus DEL) as separators in lists. Such separators
5090 must be provided literally at the time the list is processed. For options that
5091 are string-expanded, you can write the separator using a normal escape
5092 sequence. This will be processed by the expander before the string is
5093 interpreted as a list. For example, if a newline-separated list of domains is
5094 generated by a lookup, you can process it directly by a line such as this:
5095 .code
5096 domains = <\n ${lookup mysql{.....}}
5097 .endd
5098 This avoids having to change the list separator in such data. You are unlikely
5099 to want to use a control character as a separator in an option that is not
5100 expanded, because the value is literal text. However, it can be done by giving
5101 the value in quotes. For example:
5102 .code
5103 local_interfaces = "<\n 127.0.0.1 \n ::1"
5104 .endd
5105 Unlike printing character separators, which can be included in list items by
5106 doubling, it is not possible to include a control character as data when it is
5107 set as the separator. Two such characters in succession are interpreted as
5108 enclosing an empty list item.
5109
5110
5111
5112 .section "Empty items in lists" "SECTempitelis"
5113 .cindex "list" "empty item in"
5114 An empty item at the end of a list is always ignored. In other words, trailing
5115 separator characters are ignored. Thus, the list in
5116 .code
5117 senders = user@domain :
5118 .endd
5119 contains only a single item. If you want to include an empty string as one item
5120 in a list, it must not be the last item. For example, this list contains three
5121 items, the second of which is empty:
5122 .code
5123 senders = user1@domain : : user2@domain
5124 .endd
5125 &*Note*&: There must be white space between the two colons, as otherwise they
5126 are interpreted as representing a single colon data character (and the list
5127 would then contain just one item). If you want to specify a list that contains
5128 just one, empty item, you can do it as in this example:
5129 .code
5130 senders = :
5131 .endd
5132 In this case, the first item is empty, and the second is discarded because it
5133 is at the end of the list.
5134
5135
5136
5137
5138 .section "Format of driver configurations" "SECTfordricon"
5139 .cindex "drivers" "configuration format"
5140 There are separate parts in the configuration for defining routers, transports,
5141 and authenticators. In each part, you are defining a number of driver
5142 instances, each with its own set of options. Each driver instance is defined by
5143 a sequence of lines like this:
5144 .display
5145 <&'instance name'&>:
5146   <&'option'&>
5147   ...
5148   <&'option'&>
5149 .endd
5150 In the following example, the instance name is &(localuser)&, and it is
5151 followed by three options settings:
5152 .code
5153 localuser:
5154   driver = accept
5155   check_local_user
5156   transport = local_delivery
5157 .endd
5158 For each driver instance, you specify which Exim code module it uses &-- by the
5159 setting of the &%driver%& option &-- and (optionally) some configuration
5160 settings. For example, in the case of transports, if you want a transport to
5161 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5162 a local file you would use the &(appendfile)& driver. Each of the drivers is
5163 described in detail in its own separate chapter later in this manual.
5164
5165 You can have several routers, transports, or authenticators that are based on
5166 the same underlying driver (each must have a different instance name).
5167
5168 The order in which routers are defined is important, because addresses are
5169 passed to individual routers one by one, in order. The order in which
5170 transports are defined does not matter at all. The order in which
5171 authenticators are defined is used only when Exim, as a client, is searching
5172 them to find one that matches an authentication mechanism offered by the
5173 server.
5174
5175 .cindex "generic options"
5176 .cindex "options" "generic &-- definition of"
5177 Within a driver instance definition, there are two kinds of option: &'generic'&
5178 and &'private'&. The generic options are those that apply to all drivers of the
5179 same type (that is, all routers, all transports or all authenticators). The
5180 &%driver%& option is a generic option that must appear in every definition.
5181 .cindex "private options"
5182 The private options are special for each driver, and none need appear, because
5183 they all have default values.
5184
5185 The options may appear in any order, except that the &%driver%& option must
5186 precede any private options, since these depend on the particular driver. For
5187 this reason, it is recommended that &%driver%& always be the first option.
5188
5189 Driver instance names, which are used for reference in log entries and
5190 elsewhere, can be any sequence of letters, digits, and underscores (starting
5191 with a letter) and must be unique among drivers of the same type. A router and
5192 a transport (for example) can each have the same name, but no two router
5193 instances can have the same name. The name of a driver instance should not be
5194 confused with the name of the underlying driver module. For example, the
5195 configuration lines:
5196 .code
5197 remote_smtp:
5198   driver = smtp
5199 .endd
5200 create an instance of the &(smtp)& transport driver whose name is
5201 &(remote_smtp)&. The same driver code can be used more than once, with
5202 different instance names and different option settings each time. A second
5203 instance of the &(smtp)& transport, with different options, might be defined
5204 thus:
5205 .code
5206 special_smtp:
5207   driver = smtp
5208   port = 1234
5209   command_timeout = 10s
5210 .endd
5211 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5212 these transport instances from routers, and these names would appear in log
5213 lines.
5214
5215 Comment lines may be present in the middle of driver specifications. The full
5216 list of option settings for any particular driver instance, including all the
5217 defaulted values, can be extracted by making use of the &%-bP%& command line
5218 option.
5219
5220
5221
5222
5223
5224
5225 . ////////////////////////////////////////////////////////////////////////////
5226 . ////////////////////////////////////////////////////////////////////////////
5227
5228 .chapter "The default configuration file" "CHAPdefconfil"
5229 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5230 .cindex "default" "configuration file &""walk through""&"
5231 The default configuration file supplied with Exim as &_src/configure.default_&
5232 is sufficient for a host with simple mail requirements. As an introduction to
5233 the way Exim is configured, this chapter &"walks through"& the default
5234 configuration, giving brief explanations of the settings. Detailed descriptions
5235 of the options are given in subsequent chapters. The default configuration file
5236 itself contains extensive comments about ways you might want to modify the
5237 initial settings. However, note that there are many options that are not
5238 mentioned at all in the default configuration.
5239
5240
5241
5242 .section "Main configuration settings" "SECTdefconfmain"
5243 The main (global) configuration option settings must always come first in the
5244 file. The first thing you'll see in the file, after some initial comments, is
5245 the line
5246 .code
5247 # primary_hostname =
5248 .endd
5249 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5250 to know the official, fully qualified name of your host, and this is where you
5251 can specify it. However, in most cases you do not need to set this option. When
5252 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5253
5254 The first three non-comment configuration lines are as follows:
5255 .code
5256 domainlist local_domains = @
5257 domainlist relay_to_domains =
5258 hostlist   relay_from_hosts = 127.0.0.1
5259 .endd
5260 These are not, in fact, option settings. They are definitions of two named
5261 domain lists and one named host list. Exim allows you to give names to lists of
5262 domains, hosts, and email addresses, in order to make it easier to manage the
5263 configuration file (see section &<<SECTnamedlists>>&).
5264
5265 The first line defines a domain list called &'local_domains'&; this is used
5266 later in the configuration to identify domains that are to be delivered
5267 on the local host.
5268
5269 .cindex "@ in a domain list"
5270 There is just one item in this list, the string &"@"&. This is a special form
5271 of entry which means &"the name of the local host"&. Thus, if the local host is
5272 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5273 be delivered locally. Because the local host's name is referenced indirectly,
5274 the same configuration file can be used on different hosts.
5275
5276 The second line defines a domain list called &'relay_to_domains'&, but the
5277 list itself is empty. Later in the configuration we will come to the part that
5278 controls mail relaying through the local host; it allows relaying to any
5279 domains in this list. By default, therefore, no relaying on the basis of a mail
5280 domain is permitted.
5281
5282 The third line defines a host list called &'relay_from_hosts'&. This list is
5283 used later in the configuration to permit relaying from any host or IP address
5284 that matches the list. The default contains just the IP address of the IPv4
5285 loopback interface, which means that processes on the local host are able to
5286 submit mail for relaying by sending it over TCP/IP to that interface. No other
5287 hosts are permitted to submit messages for relaying.
5288
5289 Just to be sure there's no misunderstanding: at this point in the configuration
5290 we aren't actually setting up any controls. We are just defining some domains
5291 and hosts that will be used in the controls that are specified later.
5292
5293 The next two configuration lines are genuine option settings:
5294 .code
5295 acl_smtp_rcpt = acl_check_rcpt
5296 acl_smtp_data = acl_check_data
5297 .endd
5298 These options specify &'Access Control Lists'& (ACLs) that are to be used
5299 during an incoming SMTP session for every recipient of a message (every RCPT
5300 command), and after the contents of the message have been received,
5301 respectively. The names of the lists are &'acl_check_rcpt'& and
5302 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5303 section of the configuration. The RCPT ACL controls which recipients are
5304 accepted for an incoming message &-- if a configuration does not provide an ACL
5305 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5306 contents of a message to be checked.
5307
5308 Two commented-out option settings are next:
5309 .code
5310 # av_scanner = clamd:/tmp/clamd
5311 # spamd_address = 127.0.0.1 783
5312 .endd
5313 These are example settings that can be used when Exim is compiled with the
5314 content-scanning extension. The first specifies the interface to the virus
5315 scanner, and the second specifies the interface to SpamAssassin. Further
5316 details are given in chapter &<<CHAPexiscan>>&.
5317
5318 Three more commented-out option settings follow:
5319 .code
5320 # tls_advertise_hosts = *
5321 # tls_certificate = /etc/ssl/exim.crt
5322 # tls_privatekey = /etc/ssl/exim.pem
5323 .endd
5324 These are example settings that can be used when Exim is compiled with
5325 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5326 first one specifies the list of clients that are allowed to use TLS when
5327 connecting to this server; in this case the wildcard means all clients. The
5328 other options specify where Exim should find its TLS certificate and private
5329 key, which together prove the server's identity to any clients that connect.
5330 More details are given in chapter &<<CHAPTLS>>&.
5331
5332 Another two commented-out option settings follow:
5333 .code
5334 # daemon_smtp_ports = 25 : 465 : 587
5335 # tls_on_connect_ports = 465
5336 .endd
5337 .cindex "port" "465 and 587"
5338 .cindex "port" "for message submission"
5339 .cindex "message" "submission, ports for"
5340 .cindex "ssmtp protocol"
5341 .cindex "smtps protocol"
5342 .cindex "SMTP" "ssmtp protocol"
5343 .cindex "SMTP" "smtps protocol"
5344 These options provide better support for roaming users who wish to use this
5345 server for message submission. They are not much use unless you have turned on
5346 TLS (as described in the previous paragraph) and authentication (about which
5347 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5348 on end-user networks, so RFC 4409 specifies that message submission should use
5349 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5350 configured to use port 587 correctly, so these settings also enable the
5351 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5352 &<<SECTsupobssmt>>&).
5353
5354 Two more commented-out options settings follow:
5355 .code
5356 # qualify_domain =
5357 # qualify_recipient =
5358 .endd
5359 The first of these specifies a domain that Exim uses when it constructs a
5360 complete email address from a local login name. This is often needed when Exim
5361 receives a message from a local process. If you do not set &%qualify_domain%&,
5362 the value of &%primary_hostname%& is used. If you set both of these options,
5363 you can have different qualification domains for sender and recipient
5364 addresses. If you set only the first one, its value is used in both cases.
5365
5366 .cindex "domain literal" "recognizing format"
5367 The following line must be uncommented if you want Exim to recognize
5368 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5369 (an IP address within square brackets) instead of a named domain.
5370 .code
5371 # allow_domain_literals
5372 .endd
5373 The RFCs still require this form, but many people think that in the modern
5374 Internet it makes little sense to permit mail to be sent to specific hosts by
5375 quoting their IP addresses. This ancient format has been used by people who
5376 try to abuse hosts by using them for unwanted relaying. However, some
5377 people believe there are circumstances (for example, messages addressed to
5378 &'postmaster'&) where domain literals are still useful.
5379
5380 The next configuration line is a kind of trigger guard:
5381 .code
5382 never_users = root
5383 .endd
5384 It specifies that no delivery must ever be run as the root user. The normal
5385 convention is to set up &'root'& as an alias for the system administrator. This
5386 setting is a guard against slips in the configuration.
5387 The list of users specified by &%never_users%& is not, however, the complete
5388 list; the build-time configuration in &_Local/Makefile_& has an option called
5389 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5390 contents of &%never_users%& are added to this list. By default
5391 FIXED_NEVER_USERS also specifies root.
5392
5393 When a remote host connects to Exim in order to send mail, the only information
5394 Exim has about the host's identity is its IP address. The next configuration
5395 line,
5396 .code
5397 host_lookup = *
5398 .endd
5399 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5400 in order to get a host name. This improves the quality of the logging
5401 information, but if you feel it is too expensive, you can remove it entirely,
5402 or restrict the lookup to hosts on &"nearby"& networks.
5403 Note that it is not always possible to find a host name from an IP address,
5404 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5405 unreachable.
5406
5407 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5408 1413 (hence their names):
5409 .code
5410 rfc1413_hosts = *
5411 rfc1413_query_timeout = 5s
5412 .endd
5413 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5414 You can limit the hosts to which these calls are made, or change the timeout
5415 that is used. If you set the timeout to zero, all ident calls are disabled.
5416 Although they are cheap and can provide useful information for tracing problem
5417 messages, some hosts and firewalls have problems with ident calls. This can
5418 result in a timeout instead of an immediate refused connection, leading to
5419 delays on starting up an incoming SMTP session.
5420
5421 When Exim receives messages over SMTP connections, it expects all addresses to
5422 be fully qualified with a domain, as required by the SMTP definition. However,
5423 if you are running a server to which simple clients submit messages, you may
5424 find that they send unqualified addresses. The two commented-out options:
5425 .code
5426 # sender_unqualified_hosts =
5427 # recipient_unqualified_hosts =
5428 .endd
5429 show how you can specify hosts that are permitted to send unqualified sender
5430 and recipient addresses, respectively.
5431
5432 The &%percent_hack_domains%& option is also commented out:
5433 .code
5434 # percent_hack_domains =
5435 .endd
5436 It provides a list of domains for which the &"percent hack"& is to operate.
5437 This is an almost obsolete form of explicit email routing. If you do not know
5438 anything about it, you can safely ignore this topic.
5439
5440 The last two settings in the main part of the default configuration are
5441 concerned with messages that have been &"frozen"& on Exim's queue. When a
5442 message is frozen, Exim no longer continues to try to deliver it. Freezing
5443 occurs when a bounce message encounters a permanent failure because the sender
5444 address of the original message that caused the bounce is invalid, so the
5445 bounce cannot be delivered. This is probably the most common case, but there
5446 are also other conditions that cause freezing, and frozen messages are not
5447 always bounce messages.
5448 .code
5449 ignore_bounce_errors_after = 2d
5450 timeout_frozen_after = 7d
5451 .endd
5452 The first of these options specifies that failing bounce messages are to be
5453 discarded after 2 days on the queue. The second specifies that any frozen
5454 message (whether a bounce message or not) is to be timed out (and discarded)
5455 after a week. In this configuration, the first setting ensures that no failing
5456 bounce message ever lasts a week.
5457
5458
5459
5460 .section "ACL configuration" "SECID54"
5461 .cindex "default" "ACLs"
5462 .cindex "&ACL;" "default configuration"
5463 In the default configuration, the ACL section follows the main configuration.
5464 It starts with the line
5465 .code
5466 begin acl
5467 .endd
5468 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5469 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5470 and &%acl_smtp_data%& above.
5471
5472 .cindex "RCPT" "ACL for"
5473 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5474 RCPT command specifies one of the message's recipients. The ACL statements
5475 are considered in order, until the recipient address is either accepted or
5476 rejected. The RCPT command is then accepted or rejected, according to the
5477 result of the ACL processing.
5478 .code
5479 acl_check_rcpt:
5480 .endd
5481 This line, consisting of a name terminated by a colon, marks the start of the
5482 ACL, and names it.
5483 .code
5484 accept  hosts = :
5485 .endd
5486 This ACL statement accepts the recipient if the sending host matches the list.
5487 But what does that strange list mean? It doesn't actually contain any host
5488 names or IP addresses. The presence of the colon puts an empty item in the
5489 list; Exim matches this only if the incoming message did not come from a remote
5490 host, because in that case, the remote hostname is empty. The colon is
5491 important. Without it, the list itself is empty, and can never match anything.
5492
5493 What this statement is doing is to accept unconditionally all recipients in
5494 messages that are submitted by SMTP from local processes using the standard
5495 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5496 manner.
5497 .code
5498 deny    message       = Restricted characters in address
5499         domains       = +local_domains
5500         local_parts   = ^[.] : ^.*[@%!/|]
5501
5502 deny    message       = Restricted characters in address
5503         domains       = !+local_domains
5504         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5505 .endd
5506 These statements are concerned with local parts that contain any of the
5507 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5508 Although these characters are entirely legal in local parts (in the case of
5509 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5510 in Internet mail addresses.
5511
5512 The first three have in the past been associated with explicitly routed
5513 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5514 option). Addresses containing these characters are regularly tried by spammers
5515 in an attempt to bypass relaying restrictions, and also by open relay testing
5516 programs. Unless you really need them it is safest to reject these characters
5517 at this early stage. This configuration is heavy-handed in rejecting these
5518 characters for all messages it accepts from remote hosts. This is a deliberate
5519 policy of being as safe as possible.
5520
5521 The first rule above is stricter, and is applied to messages that are addressed
5522 to one of the local domains handled by this host. This is implemented by the
5523 first condition, which restricts it to domains that are listed in the
5524 &'local_domains'& domain list. The &"+"& character is used to indicate a
5525 reference to a named list. In this configuration, there is just one domain in
5526 &'local_domains'&, but in general there may be many.
5527
5528 The second condition on the first statement uses two regular expressions to
5529 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5530 or &"|"&. If you have local accounts that include these characters, you will
5531 have to modify this rule.
5532
5533 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5534 allows them because they have been encountered in practice. (Consider the
5535 common convention of local parts constructed as
5536 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5537 the author of Exim, who has no second initial.) However, a local part starting
5538 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5539 file name (for example, for a mailing list). This is also true for local parts
5540 that contain slashes. A pipe symbol can also be troublesome if the local part
5541 is incorporated unthinkingly into a shell command line.
5542
5543 The second rule above applies to all other domains, and is less strict. This
5544 allows your own users to send outgoing messages to sites that use slashes
5545 and vertical bars in their local parts. It blocks local parts that begin
5546 with a dot, slash, or vertical bar, but allows these characters within the
5547 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5548 and &"!"& is blocked, as before. The motivation here is to prevent your users
5549 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5550 .code
5551 accept  local_parts   = postmaster
5552         domains       = +local_domains
5553 .endd
5554 This statement, which has two conditions, accepts an incoming address if the
5555 local part is &'postmaster'& and the domain is one of those listed in the
5556 &'local_domains'& domain list. The &"+"& character is used to indicate a
5557 reference to a named list. In this configuration, there is just one domain in
5558 &'local_domains'&, but in general there may be many.
5559
5560 The presence of this statement means that mail to postmaster is never blocked
5561 by any of the subsequent tests. This can be helpful while sorting out problems
5562 in cases where the subsequent tests are incorrectly denying access.
5563 .code
5564 require verify        = sender
5565 .endd
5566 This statement requires the sender address to be verified before any subsequent
5567 ACL statement can be used. If verification fails, the incoming recipient
5568 address is refused. Verification consists of trying to route the address, to
5569 see if a bounce message could be delivered to it. In the case of remote
5570 addresses, basic verification checks only the domain, but &'callouts'& can be
5571 used for more verification if required. Section &<<SECTaddressverification>>&
5572 discusses the details of address verification.
5573 .code
5574 accept  hosts         = +relay_from_hosts
5575         control       = submission
5576 .endd
5577 This statement accepts the address if the message is coming from one of the
5578 hosts that are defined as being allowed to relay through this host. Recipient
5579 verification is omitted here, because in many cases the clients are dumb MUAs
5580 that do not cope well with SMTP error responses. For the same reason, the
5581 second line specifies &"submission mode"& for messages that are accepted. This
5582 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5583 messages that are deficient in some way, for example, because they lack a
5584 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5585 probably add recipient verification here, and disable submission mode.
5586 .code
5587 accept  authenticated = *
5588         control       = submission
5589 .endd
5590 This statement accepts the address if the client host has authenticated itself.
5591 Submission mode is again specified, on the grounds that such messages are most
5592 likely to come from MUAs. The default configuration does not define any
5593 authenticators, though it does include some nearly complete commented-out
5594 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5595 fact authenticate until you complete the authenticator definitions.
5596 .code
5597 require message = relay not permitted
5598         domains = +local_domains : +relay_domains
5599 .endd
5600 This statement rejects the address if its domain is neither a local domain nor
5601 one of the domains for which this host is a relay.
5602 .code
5603 require verify = recipient
5604 .endd
5605 This statement requires the recipient address to be verified; if verification
5606 fails, the address is rejected.
5607 .code
5608 # deny    message     = rejected because $sender_host_address \
5609 #                       is in a black list at $dnslist_domain\n\
5610 #                       $dnslist_text
5611 #         dnslists    = black.list.example
5612 #
5613 # warn    dnslists    = black.list.example
5614 #         add_header  = X-Warning: $sender_host_address is in \
5615 #                       a black list at $dnslist_domain
5616 #         log_message = found in $dnslist_domain
5617 .endd
5618 These commented-out lines are examples of how you could configure Exim to check
5619 sending hosts against a DNS black list. The first statement rejects messages
5620 from blacklisted hosts, whereas the second just inserts a warning header
5621 line.
5622 .code
5623 # require verify = csa
5624 .endd
5625 This commented-out line is an example of how you could turn on client SMTP
5626 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5627 records.
5628 .code
5629 accept
5630 .endd
5631 The final statement in the first ACL unconditionally accepts any recipient
5632 address that has successfully passed all the previous tests.
5633 .code
5634 acl_check_data:
5635 .endd
5636 This line marks the start of the second ACL, and names it. Most of the contents
5637 of this ACL are commented out:
5638 .code
5639 # deny    malware   = *
5640 #         message   = This message contains a virus \
5641 #                     ($malware_name).
5642 .endd
5643 These lines are examples of how to arrange for messages to be scanned for
5644 viruses when Exim has been compiled with the content-scanning extension, and a
5645 suitable virus scanner is installed. If the message is found to contain a
5646 virus, it is rejected with the given custom error message.
5647 .code
5648 # warn    spam      = nobody
5649 #         message   = X-Spam_score: $spam_score\n\
5650 #                     X-Spam_score_int: $spam_score_int\n\
5651 #                     X-Spam_bar: $spam_bar\n\
5652 #                     X-Spam_report: $spam_report
5653 .endd
5654 These lines are an example of how to arrange for messages to be scanned by
5655 SpamAssassin when Exim has been compiled with the content-scanning extension,
5656 and SpamAssassin has been installed. The SpamAssassin check is run with
5657 &`nobody`& as its user parameter, and the results are added to the message as a
5658 series of extra header line. In this case, the message is not rejected,
5659 whatever the spam score.
5660 .code
5661 accept
5662 .endd
5663 This final line in the DATA ACL accepts the message unconditionally.
5664
5665
5666 .section "Router configuration" "SECID55"
5667 .cindex "default" "routers"
5668 .cindex "routers" "default"
5669 The router configuration comes next in the default configuration, introduced
5670 by the line
5671 .code
5672 begin routers
5673 .endd
5674 Routers are the modules in Exim that make decisions about where to send
5675 messages. An address is passed to each router in turn, until it is either
5676 accepted, or failed. This means that the order in which you define the routers
5677 matters. Each router is fully described in its own chapter later in this
5678 manual. Here we give only brief overviews.
5679 .code
5680 # domain_literal:
5681 #   driver = ipliteral
5682 #   domains = !+local_domains
5683 #   transport = remote_smtp
5684 .endd
5685 .cindex "domain literal" "default router"
5686 This router is commented out because the majority of sites do not want to
5687 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5688 you uncomment this router, you also need to uncomment the setting of
5689 &%allow_domain_literals%& in the main part of the configuration.
5690 .code
5691 dnslookup:
5692   driver = dnslookup
5693   domains = ! +local_domains
5694   transport = remote_smtp
5695   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5696   no_more
5697 .endd
5698 The first uncommented router handles addresses that do not involve any local
5699 domains. This is specified by the line
5700 .code
5701 domains = ! +local_domains
5702 .endd
5703 The &%domains%& option lists the domains to which this router applies, but the
5704 exclamation mark is a negation sign, so the router is used only for domains
5705 that are not in the domain list called &'local_domains'& (which was defined at
5706 the start of the configuration). The plus sign before &'local_domains'&
5707 indicates that it is referring to a named list. Addresses in other domains are
5708 passed on to the following routers.
5709
5710 The name of the router driver is &(dnslookup)&,
5711 and is specified by the &%driver%& option. Do not be confused by the fact that
5712 the name of this router instance is the same as the name of the driver. The
5713 instance name is arbitrary, but the name set in the &%driver%& option must be
5714 one of the driver modules that is in the Exim binary.
5715
5716 The &(dnslookup)& router routes addresses by looking up their domains in the
5717 DNS in order to obtain a list of hosts to which the address is routed. If the
5718 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5719 specified by the &%transport%& option. If the router does not find the domain
5720 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5721 the address fails and is bounced.
5722
5723 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5724 be entirely ignored. This option is present because a number of cases have been
5725 encountered where MX records in the DNS point to host names
5726 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5727 Completely ignoring these IP addresses causes Exim to fail to route the
5728 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5729 continue to try to deliver the message periodically until the address timed
5730 out.
5731 .code
5732 system_aliases:
5733   driver = redirect
5734   allow_fail
5735   allow_defer
5736   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5737 # user = exim
5738   file_transport = address_file
5739   pipe_transport = address_pipe
5740 .endd
5741 Control reaches this and subsequent routers only for addresses in the local
5742 domains. This router checks to see whether the local part is defined as an
5743 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5744 data that it looks up from that file. If no data is found for the local part,
5745 the value of the &%data%& option is empty, causing the address to be passed to
5746 the next router.
5747
5748 &_/etc/aliases_& is a conventional name for the system aliases file that is
5749 often used. That is why it is referenced by from the default configuration
5750 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5751 &_Local/Makefile_& before building Exim.
5752 .code
5753 userforward:
5754   driver = redirect
5755   check_local_user
5756 # local_part_suffix = +* : -*
5757 # local_part_suffix_optional
5758   file = $home/.forward
5759 # allow_filter
5760   no_verify
5761   no_expn
5762   check_ancestor
5763   file_transport = address_file
5764   pipe_transport = address_pipe
5765   reply_transport = address_reply
5766 .endd
5767 This is the most complicated router in the default configuration. It is another
5768 redirection router, but this time it is looking for forwarding data set up by
5769 individual users. The &%check_local_user%& setting specifies a check that the
5770 local part of the address is the login name of a local user. If it is not, the
5771 router is skipped. The two commented options that follow &%check_local_user%&,
5772 namely:
5773 .code
5774 # local_part_suffix = +* : -*
5775 # local_part_suffix_optional
5776 .endd
5777 .vindex "&$local_part_suffix$&"
5778 show how you can specify the recognition of local part suffixes. If the first
5779 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5780 by any sequence of characters, is removed from the local part and placed in the
5781 variable &$local_part_suffix$&. The second suffix option specifies that the
5782 presence of a suffix in the local part is optional. When a suffix is present,
5783 the check for a local login uses the local part with the suffix removed.
5784
5785 When a local user account is found, the file called &_.forward_& in the user's
5786 home directory is consulted. If it does not exist, or is empty, the router
5787 declines. Otherwise, the contents of &_.forward_& are interpreted as
5788 redirection data (see chapter &<<CHAPredirect>>& for more details).
5789
5790 .cindex "Sieve filter" "enabling in default router"
5791 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5792 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5793 is commented out by default), the contents of the file are interpreted as a set
5794 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5795 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5796 separate document entitled &'Exim's interfaces to mail filtering'&.
5797
5798 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5799 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5800 There are two reasons for doing this:
5801
5802 .olist
5803 Whether or not a local user has a &_.forward_& file is not really relevant when
5804 checking an address for validity; it makes sense not to waste resources doing
5805 unnecessary work.
5806 .next
5807 More importantly, when Exim is verifying addresses or handling an EXPN
5808 command during an SMTP session, it is running as the Exim user, not as root.
5809 The group is the Exim group, and no additional groups are set up.
5810 It may therefore not be possible for Exim to read users' &_.forward_& files at
5811 this time.
5812 .endlist
5813
5814 The setting of &%check_ancestor%& prevents the router from generating a new
5815 address that is the same as any previous address that was redirected. (This
5816 works round a problem concerning a bad interaction between aliasing and
5817 forwarding &-- see section &<<SECTredlocmai>>&).
5818
5819 The final three option settings specify the transports that are to be used when
5820 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5821 auto-reply, respectively. For example, if a &_.forward_& file contains
5822 .code
5823 a.nother@elsewhere.example, /home/spqr/archive
5824 .endd
5825 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5826 transport.
5827 .code
5828 localuser:
5829   driver = accept
5830   check_local_user
5831 # local_part_suffix = +* : -*
5832 # local_part_suffix_optional
5833   transport = local_delivery
5834 .endd
5835 The final router sets up delivery into local mailboxes, provided that the local
5836 part is the name of a local login, by accepting the address and assigning it to
5837 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5838 routers, so the address is bounced. The commented suffix settings fulfil the
5839 same purpose as they do for the &(userforward)& router.
5840
5841
5842 .section "Transport configuration" "SECID56"
5843 .cindex "default" "transports"
5844 .cindex "transports" "default"
5845 Transports define mechanisms for actually delivering messages. They operate
5846 only when referenced from routers, so the order in which they are defined does
5847 not matter. The transports section of the configuration starts with
5848 .code
5849 begin transports
5850 .endd
5851 One remote transport and four local transports are defined.
5852 .code
5853 remote_smtp:
5854   driver = smtp
5855 .endd
5856 This transport is used for delivering messages over SMTP connections. All its
5857 options are defaulted. The list of remote hosts comes from the router.
5858 .code
5859 local_delivery:
5860   driver = appendfile
5861   file = /var/mail/$local_part
5862   delivery_date_add
5863   envelope_to_add
5864   return_path_add
5865 # group = mail
5866 # mode = 0660
5867 .endd
5868 This &(appendfile)& transport is used for local delivery to user mailboxes in
5869 traditional BSD mailbox format. By default it runs under the uid and gid of the
5870 local user, which requires the sticky bit to be set on the &_/var/mail_&
5871 directory. Some systems use the alternative approach of running mail deliveries
5872 under a particular group instead of using the sticky bit. The commented options
5873 show how this can be done.
5874
5875 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
5876 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
5877 similarly-named options above.
5878 .code
5879 address_pipe:
5880   driver = pipe
5881   return_output
5882 .endd
5883 This transport is used for handling deliveries to pipes that are generated by
5884 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
5885 option specifies that any output generated by the pipe is to be returned to the
5886 sender.
5887 .code
5888 address_file:
5889   driver = appendfile
5890   delivery_date_add
5891   envelope_to_add
5892   return_path_add
5893 .endd
5894 This transport is used for handling deliveries to files that are generated by
5895 redirection. The name of the file is not specified in this instance of
5896 &(appendfile)&, because it comes from the &(redirect)& router.
5897 .code
5898 address_reply:
5899   driver = autoreply
5900 .endd
5901 This transport is used for handling automatic replies generated by users'
5902 filter files.
5903
5904
5905
5906 .section "Default retry rule" "SECID57"
5907 .cindex "retry" "default rule"
5908 .cindex "default" "retry rule"
5909 The retry section of the configuration file contains rules which affect the way
5910 Exim retries deliveries that cannot be completed at the first attempt. It is
5911 introduced by the line
5912 .code
5913 begin retry
5914 .endd
5915 In the default configuration, there is just one rule, which applies to all
5916 errors:
5917 .code
5918 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
5919 .endd
5920 This causes any temporarily failing address to be retried every 15 minutes for
5921 2 hours, then at intervals starting at one hour and increasing by a factor of
5922 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
5923 is not delivered after 4 days of temporary failure, it is bounced.
5924
5925 If the retry section is removed from the configuration, or is empty (that is,
5926 if no retry rules are defined), Exim will not retry deliveries. This turns
5927 temporary errors into permanent errors.
5928
5929
5930 .section "Rewriting configuration" "SECID58"
5931 The rewriting section of the configuration, introduced by
5932 .code
5933 begin rewrite
5934 .endd
5935 contains rules for rewriting addresses in messages as they arrive. There are no
5936 rewriting rules in the default configuration file.
5937
5938
5939
5940 .section "Authenticators configuration" "SECTdefconfauth"
5941 .cindex "AUTH" "configuration"
5942 The authenticators section of the configuration, introduced by
5943 .code
5944 begin authenticators
5945 .endd
5946 defines mechanisms for the use of the SMTP AUTH command. The default
5947 configuration file contains two commented-out example authenticators
5948 which support plaintext username/password authentication using the
5949 standard PLAIN mechanism and the traditional but non-standard LOGIN
5950 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
5951 to support most MUA software.
5952
5953 The example PLAIN authenticator looks like this:
5954 .code
5955 #PLAIN:
5956 #  driver                  = plaintext
5957 #  server_set_id           = $auth2
5958 #  server_prompts          = :
5959 #  server_condition        = Authentication is not yet configured
5960 #  server_advertise_condition = ${if def:tls_cipher }
5961 .endd
5962 And the example LOGIN authenticator looks like this:
5963 .code
5964 #LOGIN:
5965 #  driver                  = plaintext
5966 #  server_set_id           = $auth1
5967 #  server_prompts          = <| Username: | Password:
5968 #  server_condition        = Authentication is not yet configured
5969 #  server_advertise_condition = ${if def:tls_cipher }
5970 .endd
5971
5972 The &%server_set_id%& option makes Exim remember the authenticated username
5973 in &$authenticated_id$&, which can be used later in ACLs or routers. The
5974 &%server_prompts%& option configures the &(plaintext)& authenticator so
5975 that it implements the details of the specific authentication mechanism,
5976 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
5977 when Exim offers authentication to clients; in the examples, this is only
5978 when TLS or SSL has been started, so to enable the authenticators you also
5979 need to add support for TLS as described in &<<SECTdefconfmain>>&.
5980
5981 The &%server_condition%& setting defines how to verify that the username and
5982 password are correct. In the examples it just produces an error message.
5983 To make the authenticators work, you can use a string expansion
5984 expression like one of the examples in &<<CHAPplaintext>>&.
5985
5986 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
5987 usercode and password are in different positions.  &<<CHAPplaintext>>&
5988 covers both.
5989
5990 .ecindex IIDconfiwal
5991
5992
5993
5994 . ////////////////////////////////////////////////////////////////////////////
5995 . ////////////////////////////////////////////////////////////////////////////
5996
5997 .chapter "Regular expressions" "CHAPregexp"
5998
5999 .cindex "regular expressions" "library"
6000 .cindex "PCRE"
6001 Exim supports the use of regular expressions in many of its options. It
6002 uses the PCRE regular expression library; this provides regular expression
6003 matching that is compatible with Perl 5. The syntax and semantics of
6004 regular expressions is discussed in many Perl reference books, and also in
6005 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6006 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6007
6008 The documentation for the syntax and semantics of the regular expressions that
6009 are supported by PCRE is included in the PCRE distribution, and no further
6010 description is included here. The PCRE functions are called from Exim using
6011 the default option settings (that is, with no PCRE options set), except that
6012 the PCRE_CASELESS option is set when the matching is required to be
6013 case-insensitive.
6014
6015 In most cases, when a regular expression is required in an Exim configuration,
6016 it has to start with a circumflex, in order to distinguish it from plain text
6017 or an &"ends with"& wildcard. In this example of a configuration setting, the
6018 second item in the colon-separated list is a regular expression.
6019 .code
6020 domains = a.b.c : ^\\d{3} : *.y.z : ...
6021 .endd
6022 The doubling of the backslash is required because of string expansion that
6023 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6024 of this issue, and a way of avoiding the need for doubling backslashes. The
6025 regular expression that is eventually used in this example contains just one
6026 backslash. The circumflex is included in the regular expression, and has the
6027 normal effect of &"anchoring"& it to the start of the string that is being
6028 matched.
6029
6030 There are, however, two cases where a circumflex is not required for the
6031 recognition of a regular expression: these are the &%match%& condition in a
6032 string expansion, and the &%matches%& condition in an Exim filter file. In
6033 these cases, the relevant string is always treated as a regular expression; if
6034 it does not start with a circumflex, the expression is not anchored, and can
6035 match anywhere in the subject string.
6036
6037 In all cases, if you want a regular expression to match at the end of a string,
6038 you must code the $ metacharacter to indicate this. For example:
6039 .code
6040 domains = ^\\d{3}\\.example
6041 .endd
6042 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6043 You need to use:
6044 .code
6045 domains = ^\\d{3}\\.example\$
6046 .endd
6047 if you want &'example'& to be the top-level domain. The backslash before the
6048 $ is needed because string expansion also interprets dollar characters.
6049
6050
6051
6052 . ////////////////////////////////////////////////////////////////////////////
6053 . ////////////////////////////////////////////////////////////////////////////
6054
6055 .chapter "File and database lookups" "CHAPfdlookup"
6056 .scindex IIDfidalo1 "file" "lookups"
6057 .scindex IIDfidalo2 "database" "lookups"
6058 .cindex "lookup" "description of"
6059 Exim can be configured to look up data in files or databases as it processes
6060 messages. Two different kinds of syntax are used:
6061
6062 .olist
6063 A string that is to be expanded may contain explicit lookup requests. These
6064 cause parts of the string to be replaced by data that is obtained from the
6065 lookup. Lookups of this type are conditional expansion items. Different results
6066 can be defined for the cases of lookup success and failure. See chapter
6067 &<<CHAPexpand>>&, where string expansions are described in detail.
6068 .next
6069 Lists of domains, hosts, and email addresses can contain lookup requests as a
6070 way of avoiding excessively long linear lists. In this case, the data that is
6071 returned by the lookup is often (but not always) discarded; whether the lookup
6072 succeeds or fails is what really counts. These kinds of list are described in
6073 chapter &<<CHAPdomhosaddlists>>&.
6074 .endlist
6075
6076 String expansions, lists, and lookups interact with each other in such a way
6077 that there is no order in which to describe any one of them that does not
6078 involve references to the others. Each of these three chapters makes more sense
6079 if you have read the other two first. If you are reading this for the first
6080 time, be aware that some of it will make a lot more sense after you have read
6081 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6082
6083 .section "Examples of different lookup syntax" "SECID60"
6084 It is easy to confuse the two different kinds of lookup, especially as the
6085 lists that may contain the second kind are always expanded before being
6086 processed as lists. Therefore, they may also contain lookups of the first kind.
6087 Be careful to distinguish between the following two examples:
6088 .code
6089 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6090 domains = lsearch;/some/file
6091 .endd
6092 The first uses a string expansion, the result of which must be a domain list.
6093 No strings have been specified for a successful or a failing lookup; the
6094 defaults in this case are the looked-up data and an empty string, respectively.
6095 The expansion takes place before the string is processed as a list, and the
6096 file that is searched could contain lines like this:
6097 .code
6098 192.168.3.4: domain1:domain2:...
6099 192.168.1.9: domain3:domain4:...
6100 .endd
6101 When the lookup succeeds, the result of the expansion is a list of domains (and
6102 possibly other types of item that are allowed in domain lists).
6103
6104 In the second example, the lookup is a single item in a domain list. It causes
6105 Exim to use a lookup to see if the domain that is being processed can be found
6106 in the file. The file could contains lines like this:
6107 .code
6108 domain1:
6109 domain2:
6110 .endd
6111 Any data that follows the keys is not relevant when checking that the domain
6112 matches the list item.
6113
6114 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6115 Consider a file containing lines like this:
6116 .code
6117 192.168.5.6: lsearch;/another/file
6118 .endd
6119 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6120 first &%domains%& setting above generates the second setting, which therefore
6121 causes a second lookup to occur.
6122
6123 The rest of this chapter describes the different lookup types that are
6124 available. Any of them can be used in any part of the configuration where a
6125 lookup is permitted.
6126
6127
6128 .section "Lookup types" "SECID61"
6129 .cindex "lookup" "types of"
6130 .cindex "single-key lookup" "definition of"
6131 Two different types of data lookup are implemented:
6132
6133 .ilist
6134 The &'single-key'& type requires the specification of a file in which to look,
6135 and a single key to search for. The key must be a non-empty string for the
6136 lookup to succeed. The lookup type determines how the file is searched.
6137 .next
6138 .cindex "query-style lookup" "definition of"
6139 The &'query-style'& type accepts a generalized database query. No particular
6140 key value is assumed by Exim for query-style lookups. You can use whichever
6141 Exim variables you need to construct the database query.
6142 .endlist
6143
6144 The code for each lookup type is in a separate source file that is included in
6145 the binary of Exim only if the corresponding compile-time option is set. The
6146 default settings in &_src/EDITME_& are:
6147 .code
6148 LOOKUP_DBM=yes
6149 LOOKUP_LSEARCH=yes
6150 .endd
6151 which means that only linear searching and DBM lookups are included by default.
6152 For some types of lookup (e.g. SQL databases), you need to install appropriate
6153 libraries and header files before building Exim.
6154
6155
6156
6157
6158 .section "Single-key lookup types" "SECTsinglekeylookups"
6159 .cindex "lookup" "single-key types"
6160 .cindex "single-key lookup" "list of types"
6161 The following single-key lookup types are implemented:
6162
6163 .ilist
6164 .cindex "cdb" "description of"
6165 .cindex "lookup" "cdb"
6166 .cindex "binary zero" "in lookup key"
6167 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6168 string without a terminating binary zero. The cdb format is designed for
6169 indexed files that are read frequently and never updated, except by total
6170 re-creation. As such, it is particularly suitable for large files containing
6171 aliases or other indexed data referenced by an MTA. Information about cdb can
6172 be found in several places:
6173 .display
6174 &url(http://www.pobox.com/~djb/cdb.html)
6175 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6176 &url(http://packages.debian.org/stable/utils/freecdb.html)
6177 .endd
6178 A cdb distribution is not needed in order to build Exim with cdb support,
6179 because the code for reading cdb files is included directly in Exim itself.
6180 However, no means of building or testing cdb files is provided with Exim, so
6181 you need to obtain a cdb distribution in order to do this.
6182 .next
6183 .cindex "DBM" "lookup type"
6184 .cindex "lookup" "dbm"
6185 .cindex "binary zero" "in lookup key"
6186 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6187 DBM file by looking up the record with the given key. A terminating binary
6188 zero is included in the key that is passed to the DBM library. See section
6189 &<<SECTdb>>& for a discussion of DBM libraries.
6190
6191 .cindex "Berkeley DB library" "file format"
6192 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6193 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6194 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6195 the DB_UNKNOWN option. This enables it to handle any of the types of database
6196 that the library supports, and can be useful for accessing DBM files created by
6197 other applications. (For earlier DB versions, DB_HASH is always used.)
6198 .next
6199 .cindex "lookup" "dbmnz"
6200 .cindex "lookup" "dbm &-- terminating zero"
6201 .cindex "binary zero" "in lookup key"
6202 .cindex "Courier"
6203 .cindex "&_/etc/userdbshadow.dat_&"
6204 .cindex "dmbnz lookup type"
6205 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6206 is not included in the key that is passed to the DBM library. You may need this
6207 if you want to look up data in files that are created by or shared with some
6208 other application that does not use terminating zeros. For example, you need to
6209 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6210 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6211 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6212 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6213 .next
6214 .cindex "lookup" "dsearch"
6215 .cindex "dsearch lookup type"
6216 &(dsearch)&: The given file must be a directory; this is searched for an entry
6217 whose name is the key by calling the &[lstat()]& function. The key may not
6218 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6219 the lookup is the name of the entry, which may be a file, directory,
6220 symbolic link, or any other kind of directory entry. An example of how this
6221 lookup can be used to support virtual domains is given in section
6222 &<<SECTvirtualdomains>>&.
6223 .next
6224 .cindex "lookup" "iplsearch"
6225 .cindex "iplsearch lookup type"
6226 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6227 terminated by a colon or white space or the end of the line. The keys in the
6228 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6229 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6230 being interpreted as a key terminator. For example:
6231 .code
6232 1.2.3.4:           data for 1.2.3.4
6233 192.168.0.0/16:    data for 192.168.0.0/16
6234 "abcd::cdab":      data for abcd::cdab
6235 "abcd:abcd::/32"   data for abcd:abcd::/32
6236 .endd
6237 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6238 file is searched linearly, using the CIDR masks where present, until a matching
6239 key is found. The first key that matches is used; there is no attempt to find a
6240 &"best"& match. Apart from the way the keys are matched, the processing for
6241 &(iplsearch)& is the same as for &(lsearch)&.
6242
6243 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6244 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6245 lookup types support only literal keys.
6246
6247 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6248 the implicit key is the host's IP address rather than its name (see section
6249 &<<SECThoslispatsikey>>&).
6250 .next
6251 .cindex "linear search"
6252 .cindex "lookup" "lsearch"
6253 .cindex "lsearch lookup type"
6254 .cindex "case sensitivity" "in lsearch lookup"
6255 &(lsearch)&: The given file is a text file that is searched linearly for a
6256 line beginning with the search key, terminated by a colon or white space or the
6257 end of the line. The search is case-insensitive; that is, upper and lower case
6258 letters are treated as the same. The first occurrence of the key that is found
6259 in the file is used.
6260
6261 White space between the key and the colon is permitted. The remainder of the
6262 line, with leading and trailing white space removed, is the data. This can be
6263 continued onto subsequent lines by starting them with any amount of white
6264 space, but only a single space character is included in the data at such a
6265 junction. If the data begins with a colon, the key must be terminated by a
6266 colon, for example:
6267 .code
6268 baduser:  :fail:
6269 .endd
6270 Empty lines and lines beginning with # are ignored, even if they occur in the
6271 middle of an item. This is the traditional textual format of alias files. Note
6272 that the keys in an &(lsearch)& file are literal strings. There is no
6273 wildcarding of any kind.
6274
6275 .cindex "lookup" "lsearch &-- colons in keys"
6276 .cindex "white space" "in lsearch key"
6277 In most &(lsearch)& files, keys are not required to contain colons or #
6278 characters, or white space. However, if you need this feature, it is available.
6279 If a key begins with a doublequote character, it is terminated only by a
6280 matching quote (or end of line), and the normal escaping rules apply to its
6281 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6282 quoted keys (exactly as for unquoted keys). There is no special handling of
6283 quotes for the data part of an &(lsearch)& line.
6284
6285 .next
6286 .cindex "NIS lookup type"
6287 .cindex "lookup" "NIS"
6288 .cindex "binary zero" "in lookup key"
6289 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6290 the given key, without a terminating binary zero. There is a variant called
6291 &(nis0)& which does include the terminating binary zero in the key. This is
6292 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6293 aliases; the full map names must be used.
6294
6295 .next
6296 .cindex "wildlsearch lookup type"
6297 .cindex "lookup" "wildlsearch"
6298 .cindex "nwildlsearch lookup type"
6299 .cindex "lookup" "nwildlsearch"
6300 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6301 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6302 the file may be wildcarded. The difference between these two lookup types is
6303 that for &(wildlsearch)&, each key in the file is string-expanded before being
6304 used, whereas for &(nwildlsearch)&, no expansion takes place.
6305
6306 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6307 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6308 file that are regular expressions can be made case-sensitive by the use of
6309 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6310
6311 . ==== As this is a nested list, any displays it contains must be indented
6312 . ==== as otherwise they are too far to the left.
6313
6314 .olist
6315 The string may begin with an asterisk to mean &"ends with"&. For example:
6316 .code
6317     *.a.b.c       data for anything.a.b.c
6318     *fish         data for anythingfish
6319 .endd
6320 .next
6321 The string may begin with a circumflex to indicate a regular expression. For
6322 example, for &(wildlsearch)&:
6323 .code
6324     ^\N\d+\.a\.b\N    data for <digits>.a.b
6325 .endd
6326 Note the use of &`\N`& to disable expansion of the contents of the regular
6327 expression. If you are using &(nwildlsearch)&, where the keys are not
6328 string-expanded, the equivalent entry is:
6329 .code
6330     ^\d+\.a\.b        data for <digits>.a.b
6331 .endd
6332 The case-insensitive flag is set at the start of compiling the regular
6333 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6334 For example, to make the entire pattern case-sensitive:
6335 .code
6336     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6337 .endd
6338
6339 If the regular expression contains white space or colon characters, you must
6340 either quote it (see &(lsearch)& above), or represent these characters in other
6341 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6342 colon. This may be easier than quoting, because if you quote, you have to
6343 escape all the backslashes inside the quotes.
6344
6345 &*Note*&: It is not possible to capture substrings in a regular expression
6346 match for later use, because the results of all lookups are cached. If a lookup
6347 is repeated, the result is taken from the cache, and no actual pattern matching
6348 takes place. The values of all the numeric variables are unset after a
6349 &((n)wildlsearch)& match.
6350
6351 .next
6352 Although I cannot see it being of much use, the general matching function that
6353 is used to implement &((n)wildlsearch)& means that the string may begin with a
6354 lookup name terminated by a semicolon, and followed by lookup data. For
6355 example:
6356 .code
6357     cdb;/some/file  data for keys that match the file
6358 .endd
6359 The data that is obtained from the nested lookup is discarded.
6360 .endlist olist
6361
6362 Keys that do not match any of these patterns are interpreted literally. The
6363 continuation rules for the data are the same as for &(lsearch)&, and keys may
6364 be followed by optional colons.
6365
6366 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6367 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6368 lookup types support only literal keys.
6369 .endlist ilist
6370
6371
6372 .section "Query-style lookup types" "SECID62"
6373 .cindex "lookup" "query-style types"
6374 .cindex "query-style lookup" "list of types"
6375 The supported query-style lookup types are listed below. Further details about
6376 many of them are given in later sections.
6377
6378 .ilist
6379 .cindex "DNS" "as a lookup type"
6380 .cindex "lookup" "DNS"
6381 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6382 are given in the supplied query. The resulting data is the contents of the
6383 records. See section &<<SECTdnsdb>>&.
6384 .next
6385 .cindex "InterBase lookup type"
6386 .cindex "lookup" "InterBase"
6387 &(ibase)&: This does a lookup in an InterBase database.
6388 .next
6389 .cindex "LDAP" "lookup type"
6390 .cindex "lookup" "LDAP"
6391 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6392 returns attributes from a single entry. There is a variant called &(ldapm)&
6393 that permits values from multiple entries to be returned. A third variant
6394 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6395 any attribute values. See section &<<SECTldap>>&.
6396 .next
6397 .cindex "MySQL" "lookup type"
6398 .cindex "lookup" "MySQL"
6399 &(mysql)&: The format of the query is an SQL statement that is passed to a
6400 MySQL database. See section &<<SECTsql>>&.
6401 .next
6402 .cindex "NIS+ lookup type"
6403 .cindex "lookup" "NIS+"
6404 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6405 the field to be returned. See section &<<SECTnisplus>>&.
6406 .next
6407 .cindex "Oracle" "lookup type"
6408 .cindex "lookup" "Oracle"
6409 &(oracle)&: The format of the query is an SQL statement that is passed to an
6410 Oracle database. See section &<<SECTsql>>&.
6411 .next
6412 .cindex "lookup" "passwd"
6413 .cindex "passwd lookup type"
6414 .cindex "&_/etc/passwd_&"
6415 &(passwd)& is a query-style lookup with queries that are just user names. The
6416 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6417 success, the result string is the same as you would get from an &(lsearch)&
6418 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6419 password value. For example:
6420 .code
6421 *:42:42:King Rat:/home/kr:/bin/bash
6422 .endd
6423 .next
6424 .cindex "PostgreSQL lookup type"
6425 .cindex "lookup" "PostgreSQL"
6426 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6427 PostgreSQL database. See section &<<SECTsql>>&.
6428
6429 .next
6430 .cindex "sqlite lookup type"
6431 .cindex "lookup" "sqlite"
6432 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6433 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6434
6435 .next
6436 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6437 not likely to be useful in normal operation.
6438 .next
6439 .cindex "whoson lookup type"
6440 .cindex "lookup" "whoson"
6441 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6442 allows a server to check whether a particular (dynamically allocated) IP
6443 address is currently allocated to a known (trusted) user and, optionally, to
6444 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6445 at one time for &"POP before SMTP"& authentication, but that approach has been
6446 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6447 &"POP before SMTP"& checking using ACL statements such as
6448 .code
6449 require condition = \
6450   ${lookup whoson {$sender_host_address}{yes}{no}}
6451 .endd
6452 The query consists of a single IP address. The value returned is the name of
6453 the authenticated user, which is stored in the variable &$value$&. However, in
6454 this example, the data in &$value$& is not used; the result of the lookup is
6455 one of the fixed strings &"yes"& or &"no"&.
6456 .endlist
6457
6458
6459
6460 .section "Temporary errors in lookups" "SECID63"
6461 .cindex "lookup" "temporary error in"
6462 Lookup functions can return temporary error codes if the lookup cannot be
6463 completed. For example, an SQL or LDAP database might be unavailable. For this
6464 reason, it is not advisable to use a lookup that might do this for critical
6465 options such as a list of local domains.
6466
6467 When a lookup cannot be completed in a router or transport, delivery
6468 of the message (to the relevant address) is deferred, as for any other
6469 temporary error. In other circumstances Exim may assume the lookup has failed,
6470 or may give up altogether.
6471
6472
6473
6474 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6475 .cindex "wildcard lookups"
6476 .cindex "lookup" "default values"
6477 .cindex "lookup" "wildcard"
6478 .cindex "lookup" "* added to type"
6479 .cindex "default" "in single-key lookups"
6480 In this context, a &"default value"& is a value specified by the administrator
6481 that is to be used if a lookup fails.
6482
6483 &*Note:*& This section applies only to single-key lookups. For query-style
6484 lookups, the facilities of the query language must be used. An attempt to
6485 specify a default for a query-style lookup provokes an error.
6486
6487 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6488 and the initial lookup fails, the key &"*"& is looked up in the file to
6489 provide a default value. See also the section on partial matching below.
6490
6491 .cindex "*@ with single-key lookup"
6492 .cindex "lookup" "*@ added to type"
6493 .cindex "alias file" "per-domain default"
6494 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6495 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6496 character, a second lookup is done with everything before the last @ replaced
6497 by *. This makes it possible to provide per-domain defaults in alias files
6498 that include the domains in the keys. If the second lookup fails (or doesn't
6499 take place because there is no @ in the key), &"*"& is looked up.
6500 For example, a &(redirect)& router might contain:
6501 .code
6502 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6503 .endd
6504 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6505 looks up these keys, in this order:
6506 .code
6507 jane@eyre.example
6508 *@eyre.example
6509 *
6510 .endd
6511 The data is taken from whichever key it finds first. &*Note*&: In an
6512 &(lsearch)& file, this does not mean the first of these keys in the file. A
6513 complete scan is done for each key, and only if it is not found at all does
6514 Exim move on to try the next key.
6515
6516
6517
6518 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6519 .cindex "partial matching"
6520 .cindex "wildcard lookups"
6521 .cindex "lookup" "partial matching"
6522 .cindex "lookup" "wildcard"
6523 .cindex "asterisk" "in search type"
6524 The normal operation of a single-key lookup is to search the file for an exact
6525 match with the given key. However, in a number of situations where domains are
6526 being looked up, it is useful to be able to do partial matching. In this case,
6527 information in the file that has a key starting with &"*."& is matched by any
6528 domain that ends with the components that follow the full stop. For example, if
6529 a key in a DBM file is
6530 .code
6531 *.dates.fict.example
6532 .endd
6533 then when partial matching is enabled this is matched by (amongst others)
6534 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6535 by &'dates.fict.example'&, if that does not appear as a separate key in the
6536 file.
6537
6538 &*Note*&: Partial matching is not available for query-style lookups. It is
6539 also not available for any lookup items in address lists (see section
6540 &<<SECTaddresslist>>&).
6541
6542 Partial matching is implemented by doing a series of separate lookups using
6543 keys constructed by modifying the original subject key. This means that it can
6544 be used with any of the single-key lookup types, provided that
6545 partial matching keys
6546 beginning with a special prefix (default &"*."&) are included in the data file.
6547 Keys in the file that do not begin with the prefix are matched only by
6548 unmodified subject keys when partial matching is in use.
6549
6550 Partial matching is requested by adding the string &"partial-"& to the front of
6551 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6552 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6553 is added at the start of the subject key, and it is looked up again. If that
6554 fails, further lookups are tried with dot-separated components removed from the
6555 start of the subject key, one-by-one, and &"*."& added on the front of what
6556 remains.
6557
6558 A minimum number of two non-* components are required. This can be adjusted
6559 by including a number before the hyphen in the search type. For example,
6560 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6561 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6562 subject key is &'2250.dates.fict.example'& then the following keys are looked
6563 up when the minimum number of non-* components is two:
6564 .code
6565 2250.dates.fict.example
6566 *.2250.dates.fict.example
6567 *.dates.fict.example
6568 *.fict.example
6569 .endd
6570 As soon as one key in the sequence is successfully looked up, the lookup
6571 finishes.
6572
6573 .cindex "lookup" "partial matching &-- changing prefix"
6574 .cindex "prefix" "for partial matching"
6575 The use of &"*."& as the partial matching prefix is a default that can be
6576 changed. The motivation for this feature is to allow Exim to operate with file
6577 formats that are used by other MTAs. A different prefix can be supplied in
6578 parentheses instead of the hyphen after &"partial"&. For example:
6579 .code
6580 domains = partial(.)lsearch;/some/file
6581 .endd
6582 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6583 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6584 components is unchanged). The prefix may consist of any punctuation characters
6585 other than a closing parenthesis. It may be empty, for example:
6586 .code
6587 domains = partial1()cdb;/some/file
6588 .endd
6589 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6590 &`a.b.c`&, &`b.c`&, and &`c`&.
6591
6592 If &"partial0"& is specified, what happens at the end (when the lookup with
6593 just one non-wild component has failed, and the original key is shortened right
6594 down to the null string) depends on the prefix:
6595
6596 .ilist
6597 If the prefix has zero length, the whole lookup fails.
6598 .next
6599 If the prefix has length 1, a lookup for just the prefix is done. For
6600 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6601 .next
6602 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6603 remainder is looked up. With the default prefix, therefore, the final lookup is
6604 for &"*"& on its own.
6605 .next
6606 Otherwise, the whole prefix is looked up.
6607 .endlist
6608
6609
6610 If the search type ends in &"*"& or &"*@"& (see section
6611 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6612 this implies happens after all partial lookups have failed. If &"partial0"& is
6613 specified, adding &"*"& to the search type has no effect with the default
6614 prefix, because the &"*"& key is already included in the sequence of partial
6615 lookups. However, there might be a use for lookup types such as
6616 &"partial0(.)lsearch*"&.
6617
6618 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6619 in domain lists and the like. Partial matching works only in terms of
6620 dot-separated components; a key such as &`*fict.example`&
6621 in a database file is useless, because the asterisk in a partial matching
6622 subject key is always followed by a dot.
6623
6624
6625
6626
6627 .section "Lookup caching" "SECID64"
6628 .cindex "lookup" "caching"
6629 .cindex "caching" "lookup data"
6630 Exim caches all lookup results in order to avoid needless repetition of
6631 lookups. However, because (apart from the daemon) Exim operates as a collection
6632 of independent, short-lived processes, this caching applies only within a
6633 single Exim process. There is no inter-process lookup caching facility.
6634
6635 For single-key lookups, Exim keeps the relevant files open in case there is
6636 another lookup that needs them. In some types of configuration this can lead to
6637 many files being kept open for messages with many recipients. To avoid hitting
6638 the operating system limit on the number of simultaneously open files, Exim
6639 closes the least recently used file when it needs to open more files than its
6640 own internal limit, which can be changed via the &%lookup_open_max%& option.
6641
6642 The single-key lookup files are closed and the lookup caches are flushed at
6643 strategic points during delivery &-- for example, after all routing is
6644 complete.
6645
6646
6647
6648
6649 .section "Quoting lookup data" "SECID65"
6650 .cindex "lookup" "quoting"
6651 .cindex "quoting" "in lookups"
6652 When data from an incoming message is included in a query-style lookup, there
6653 is the possibility of special characters in the data messing up the syntax of
6654 the query. For example, a NIS+ query that contains
6655 .code
6656 [name=$local_part]
6657 .endd
6658 will be broken if the local part happens to contain a closing square bracket.
6659 For NIS+, data can be enclosed in double quotes like this:
6660 .code
6661 [name="$local_part"]
6662 .endd
6663 but this still leaves the problem of a double quote in the data. The rule for
6664 NIS+ is that double quotes must be doubled. Other lookup types have different
6665 rules, and to cope with the differing requirements, an expansion operator
6666 of the following form is provided:
6667 .code
6668 ${quote_<lookup-type>:<string>}
6669 .endd
6670 For example, the safest way to write the NIS+ query is
6671 .code
6672 [name="${quote_nisplus:$local_part}"]
6673 .endd
6674 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6675 operator can be used for all lookup types, but has no effect for single-key
6676 lookups, since no quoting is ever needed in their key strings.
6677
6678
6679
6680
6681 .section "More about dnsdb" "SECTdnsdb"
6682 .cindex "dnsdb lookup"
6683 .cindex "lookup" "dnsdb"
6684 .cindex "DNS" "as a lookup type"
6685 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6686 of a record type and a domain name, separated by an equals sign. For example,
6687 an expansion string could contain:
6688 .code
6689 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6690 .endd
6691 If the lookup succeeds, the result is placed in &$value$&, which in this case
6692 is used on its own as the result. If the lookup does not succeed, the
6693 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6694 &<<SECTforexpfai>>& for an explanation of what this means.
6695
6696 The supported DNS record types are A, CNAME, MX, NS, PTR, SRV, and TXT, and,
6697 when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6698 configured). If no type is given, TXT is assumed. When the type is PTR,
6699 the data can be an IP address, written as normal; inversion and the addition of
6700 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6701 .code
6702 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6703 .endd
6704 If the data for a PTR record is not a syntactically valid IP address, it is not
6705 altered and nothing is added.
6706
6707 .cindex "MX record" "in &(dnsdb)& lookup"
6708 .cindex "SRV record" "in &(dnsdb)& lookup"
6709 For an MX lookup, both the preference value and the host name are returned for
6710 each record, separated by a space. For an SRV lookup, the priority, weight,
6711 port, and host name are returned for each record, separated by spaces.
6712
6713 For any record type, if multiple records are found (or, for A6 lookups, if a
6714 single record leads to multiple addresses), the data is returned as a
6715 concatenation, with newline as the default separator. The order, of course,
6716 depends on the DNS resolver. You can specify a different separator character
6717 between multiple records by putting a right angle-bracket followed immediately
6718 by the new separator at the start of the query. For example:
6719 .code
6720 ${lookup dnsdb{>: a=host1.example}}
6721 .endd
6722 It is permitted to specify a space as the separator character. Further
6723 white space is ignored.
6724
6725 .cindex "TXT record" "in &(dnsdb)& lookup"
6726 For TXT records with multiple items of data, only the first item is returned,
6727 unless a separator for them is specified using a comma after the separator
6728 character followed immediately by the TXT record item separator. To concatenate
6729 items without a separator, use a semicolon instead.
6730 .code
6731 ${lookup dnsdb{>\n,: txt=a.b.example}}
6732 ${lookup dnsdb{>\n; txt=a.b.example}}
6733 .endd
6734 It is permitted to specify a space as the separator character. Further
6735 white space is ignored.
6736
6737 .section "Pseudo dnsdb record types" "SECID66"
6738 .cindex "MX record" "in &(dnsdb)& lookup"
6739 By default, both the preference value and the host name are returned for
6740 each MX record, separated by a space. If you want only host names, you can use
6741 the pseudo-type MXH:
6742 .code
6743 ${lookup dnsdb{mxh=a.b.example}}
6744 .endd
6745 In this case, the preference values are omitted, and just the host names are
6746 returned.
6747
6748 .cindex "name server for enclosing domain"
6749 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6750 records on the given domain, but if none are found, it removes the first
6751 component of the domain name, and tries again. This process continues until NS
6752 records are found or there are no more components left (or there is a DNS
6753 error). In other words, it may return the name servers for a top-level domain,
6754 but it never returns the root name servers. If there are no NS records for the
6755 top-level domain, the lookup fails. Consider these examples:
6756 .code
6757 ${lookup dnsdb{zns=xxx.quercite.com}}
6758 ${lookup dnsdb{zns=xxx.edu}}
6759 .endd
6760 Assuming that in each case there are no NS records for the full domain name,
6761 the first returns the name servers for &%quercite.com%&, and the second returns
6762 the name servers for &%edu%&.
6763
6764 You should be careful about how you use this lookup because, unless the
6765 top-level domain does not exist, the lookup always returns some host names. The
6766 sort of use to which this might be put is for seeing if the name servers for a
6767 given domain are on a blacklist. You can probably assume that the name servers
6768 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6769 such a list.
6770
6771 .cindex "CSA" "in &(dnsdb)& lookup"
6772 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6773 records according to the CSA rules, which are described in section
6774 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6775 not sufficient because of the extra parent domain search behaviour of CSA. The
6776 result of a successful lookup such as:
6777 .code
6778 ${lookup dnsdb {csa=$sender_helo_name}}
6779 .endd
6780 has two space-separated fields: an authorization code and a target host name.
6781 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6782 authorization required but absent, or &"?"& for unknown.
6783
6784
6785 .section "Multiple dnsdb lookups" "SECID67"
6786 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6787 However, you can specify a list of domains or IP addresses in a single
6788 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6789 the default separator, but with the ability to change this. For example:
6790 .code
6791 ${lookup dnsdb{one.domain.com:two.domain.com}}
6792 ${lookup dnsdb{a=one.host.com:two.host.com}}
6793 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6794 .endd
6795 In order to retain backwards compatibility, there is one special case: if
6796 the lookup type is PTR and no change of separator is specified, Exim looks
6797 to see if the rest of the string is precisely one IPv6 address. In this
6798 case, it does not treat it as a list.
6799
6800 The data from each lookup is concatenated, with newline separators by default,
6801 in the same way that multiple DNS records for a single item are handled. A
6802 different separator can be specified, as described above.
6803
6804 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6805 temporary DNS error for any of them, the behaviour is controlled by
6806 an optional keyword followed by a comma that may appear before the record
6807 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6808 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6809 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6810 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6811 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6812 error causes the whole lookup to defer only if none of the other lookups
6813 succeed. The default is &"lax"&, so the following lookups are equivalent:
6814 .code
6815 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6816 ${lookup dnsdb{a=one.host.com:two.host.com}}
6817 .endd
6818 Thus, in the default case, as long as at least one of the DNS lookups
6819 yields some data, the lookup succeeds.
6820
6821
6822
6823
6824 .section "More about LDAP" "SECTldap"
6825 .cindex "LDAP" "lookup, more about"
6826 .cindex "lookup" "LDAP"
6827 .cindex "Solaris" "LDAP"
6828 The original LDAP implementation came from the University of Michigan; this has
6829 become &"Open LDAP"&, and there are now two different releases. Another
6830 implementation comes from Netscape, and Solaris 7 and subsequent releases
6831 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
6832 the lookup function level, their error handling is different. For this reason
6833 it is necessary to set a compile-time variable when building Exim with LDAP, to
6834 indicate which LDAP library is in use. One of the following should appear in
6835 your &_Local/Makefile_&:
6836 .code
6837 LDAP_LIB_TYPE=UMICHIGAN
6838 LDAP_LIB_TYPE=OPENLDAP1
6839 LDAP_LIB_TYPE=OPENLDAP2
6840 LDAP_LIB_TYPE=NETSCAPE
6841 LDAP_LIB_TYPE=SOLARIS
6842 .endd
6843 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
6844 same interface as the University of Michigan version.
6845
6846 There are three LDAP lookup types in Exim. These behave slightly differently in
6847 the way they handle the results of a query:
6848
6849 .ilist
6850 &(ldap)& requires the result to contain just one entry; if there are more, it
6851 gives an error.
6852 .next
6853 &(ldapdn)& also requires the result to contain just one entry, but it is the
6854 Distinguished Name that is returned rather than any attribute values.
6855 .next
6856 &(ldapm)& permits the result to contain more than one entry; the attributes
6857 from all of them are returned.
6858 .endlist
6859
6860
6861 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
6862 Exim behaves as if the entry did not exist, and the lookup fails. The format of
6863 the data returned by a successful lookup is described in the next section.
6864 First we explain how LDAP queries are coded.
6865
6866
6867 .section "Format of LDAP queries" "SECTforldaque"
6868 .cindex "LDAP" "query format"
6869 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
6870 the configuration of a &(redirect)& router one might have this setting:
6871 .code
6872 data = ${lookup ldap \
6873   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
6874   c=UK?mailbox?base?}}
6875 .endd
6876 .cindex "LDAP" "with TLS"
6877 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
6878 secure (encrypted) LDAP connections. The second of these ensures that an
6879 encrypted TLS connection is used.
6880
6881
6882 .section "LDAP quoting" "SECID68"
6883 .cindex "LDAP" "quoting"
6884 Two levels of quoting are required in LDAP queries, the first for LDAP itself
6885 and the second because the LDAP query is represented as a URL. Furthermore,
6886 within an LDAP query, two different kinds of quoting are required. For this
6887 reason, there are two different LDAP-specific quoting operators.
6888
6889 The &%quote_ldap%& operator is designed for use on strings that are part of
6890 filter specifications. Conceptually, it first does the following conversions on
6891 the string:
6892 .code
6893 *   =>   \2A
6894 (   =>   \28
6895 )   =>   \29
6896 \   =>   \5C
6897 .endd
6898 in accordance with RFC 2254. The resulting string is then quoted according
6899 to the rules for URLs, that is, all non-alphanumeric characters except
6900 .code
6901 ! $ ' - . _ ( ) * +
6902 .endd
6903 are converted to their hex values, preceded by a percent sign. For example:
6904 .code
6905 ${quote_ldap: a(bc)*, a<yz>; }
6906 .endd
6907 yields
6908 .code
6909 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
6910 .endd
6911 Removing the URL quoting, this is (with a leading and a trailing space):
6912 .code
6913 a\28bc\29\2A, a<yz>;
6914 .endd
6915 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
6916 base DN specifications in queries. Conceptually, it first converts the string
6917 by inserting a backslash in front of any of the following characters:
6918 .code
6919 , + " \ < > ;
6920 .endd
6921 It also inserts a backslash before any leading spaces or # characters, and
6922 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
6923 is then quoted according to the rules for URLs. For example:
6924 .code
6925 ${quote_ldap_dn: a(bc)*, a<yz>; }
6926 .endd
6927 yields
6928 .code
6929 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
6930 .endd
6931 Removing the URL quoting, this is (with a trailing space):
6932 .code
6933 \ a(bc)*\, a\<yz\>\;\
6934 .endd
6935 There are some further comments about quoting in the section on LDAP
6936 authentication below.
6937
6938
6939 .section "LDAP connections" "SECID69"
6940 .cindex "LDAP" "connections"
6941 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
6942 is in use, via a Unix domain socket. The example given above does not specify
6943 an LDAP server. A server that is reached by TCP/IP can be specified in a query
6944 by starting it with
6945 .code
6946 ldap://<hostname>:<port>/...
6947 .endd
6948 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
6949 used. When no server is specified in a query, a list of default servers is
6950 taken from the &%ldap_default_servers%& configuration option. This supplies a
6951 colon-separated list of servers which are tried in turn until one successfully
6952 handles a query, or there is a serious error. Successful handling either
6953 returns the requested data, or indicates that it does not exist. Serious errors
6954 are syntactical, or multiple values when only a single value is expected.
6955 Errors which cause the next server to be tried are connection failures, bind
6956 failures, and timeouts.
6957
6958 For each server name in the list, a port number can be given. The standard way
6959 of specifying a host and port is to use a colon separator (RFC 1738). Because
6960 &%ldap_default_servers%& is a colon-separated list, such colons have to be
6961 doubled. For example
6962 .code
6963 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
6964 .endd
6965 If &%ldap_default_servers%& is unset, a URL with no server name is passed
6966 to the LDAP library with no server name, and the library's default (normally
6967 the local host) is used.
6968
6969 If you are using the OpenLDAP library, you can connect to an LDAP server using
6970 a Unix domain socket instead of a TCP/IP connection. This is specified by using
6971 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
6972 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
6973 not available.
6974
6975 For this type of connection, instead of a host name for the server, a pathname
6976 for the socket is required, and the port number is not relevant. The pathname
6977 can be specified either as an item in &%ldap_default_servers%&, or inline in
6978 the query. In the former case, you can have settings such as
6979 .code
6980 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
6981 .endd
6982 When the pathname is given in the query, you have to escape the slashes as
6983 &`%2F`& to fit in with the LDAP URL syntax. For example:
6984 .code
6985 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
6986 .endd
6987 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
6988 a pathname, it uses the Unix domain socket code, even if the query actually
6989 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
6990 socket connection. This behaviour means that you can use a setting of
6991 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
6992 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
6993 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
6994 backup host.
6995
6996 If an explicit &`ldapi`& type is given in a query when a host name is
6997 specified, an error is diagnosed. However, if there are more items in
6998 &%ldap_default_servers%&, they are tried. In other words:
6999
7000 .ilist
7001 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7002 interface.
7003 .next
7004 Using &`ldapi`& with a host name causes an error.
7005 .endlist
7006
7007
7008 Using &`ldapi`& with no host or path in the query, and no setting of
7009 &%ldap_default_servers%&, does whatever the library does by default.
7010
7011
7012
7013 .section "LDAP authentication and control information" "SECID70"
7014 .cindex "LDAP" "authentication"
7015 The LDAP URL syntax provides no way of passing authentication and other control
7016 information to the server. To make this possible, the URL in an LDAP query may
7017 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7018 spaces. If a value contains spaces it must be enclosed in double quotes, and
7019 when double quotes are used, backslash is interpreted in the usual way inside
7020 them. The following names are recognized:
7021 .display
7022 &`DEREFERENCE`&  set the dereferencing parameter
7023 &`NETTIME    `&  set a timeout for a network operation
7024 &`USER       `&  set the DN, for authenticating the LDAP bind
7025 &`PASS       `&  set the password, likewise
7026 &`REFERRALS  `&  set the referrals parameter
7027 &`SIZE       `&  set the limit for the number of entries returned
7028 &`TIME       `&  set the maximum waiting time for a query
7029 .endd
7030 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7031 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7032 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7033 library from trying to follow referrals issued by the LDAP server.
7034
7035 The name CONNECT is an obsolete name for NETTIME, retained for
7036 backwards compatibility. This timeout (specified as a number of seconds) is
7037 enforced from the client end for operations that can be carried out over a
7038 network. Specifically, it applies to network connections and calls to the
7039 &'ldap_result()'& function. If the value is greater than zero, it is used if
7040 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7041 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7042 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7043 Netscape SDK; for OpenLDAP no action is taken.
7044
7045 The TIME parameter (also a number of seconds) is passed to the server to
7046 set a server-side limit on the time taken to complete a search.
7047
7048
7049 Here is an example of an LDAP query in an Exim lookup that uses some of these
7050 values. This is a single line, folded to fit on the page:
7051 .code
7052 ${lookup ldap
7053   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7054   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7055   {$value}fail}
7056 .endd
7057 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7058 any of the auxiliary data. Exim configuration settings that include lookups
7059 which contain password information should be preceded by &"hide"& to prevent
7060 non-admin users from using the &%-bP%& option to see their values.
7061
7062 The auxiliary data items may be given in any order. The default is no
7063 connection timeout (the system timeout is used), no user or password, no limit
7064 on the number of entries returned, and no time limit on queries.
7065
7066 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7067 removes any URL quoting that it may contain before passing it LDAP. Apparently
7068 some libraries do this for themselves, but some do not. Removing the URL
7069 quoting has two advantages:
7070
7071 .ilist
7072 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7073 DNs as with DNs inside actual queries.
7074 .next
7075 It permits spaces inside USER= DNs.
7076 .endlist
7077
7078 For example, a setting such as
7079 .code
7080 USER=cn=${quote_ldap_dn:$1}
7081 .endd
7082 should work even if &$1$& contains spaces.
7083
7084 Expanded data for the PASS= value should be quoted using the &%quote%&
7085 expansion operator, rather than the LDAP quote operators. The only reason this
7086 field needs quoting is to ensure that it conforms to the Exim syntax, which
7087 does not allow unquoted spaces. For example:
7088 .code
7089 PASS=${quote:$3}
7090 .endd
7091 The LDAP authentication mechanism can be used to check passwords as part of
7092 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7093 &<<CHAPexpand>>&.
7094
7095
7096
7097 .section "Format of data returned by LDAP" "SECID71"
7098 .cindex "LDAP" "returned data formats"
7099 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7100 as a sequence of values, for example
7101 .code
7102 cn=manager, o=University of Cambridge, c=UK
7103 .endd
7104 The &(ldap)& lookup type generates an error if more than one entry matches the
7105 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7106 the result between the data from different entries. It is possible for multiple
7107 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7108 you know that whatever values are returned all came from a single entry in the
7109 directory.
7110
7111 In the common case where you specify a single attribute in your LDAP query, the
7112 result is not quoted, and does not contain the attribute name. If the attribute
7113 has multiple values, they are separated by commas.
7114
7115 If you specify multiple attributes, the result contains space-separated, quoted
7116 strings, each preceded by the attribute name and an equals sign. Within the
7117 quotes, the quote character, backslash, and newline are escaped with
7118 backslashes, and commas are used to separate multiple values for the attribute.
7119 Apart from the escaping, the string within quotes takes the same form as the
7120 output when a single attribute is requested. Specifying no attributes is the
7121 same as specifying all of an entry's attributes.
7122
7123 Here are some examples of the output format. The first line of each pair is an
7124 LDAP query, and the second is the data that is returned. The attribute called
7125 &%attr1%& has two values, whereas &%attr2%& has only one value:
7126 .code
7127 ldap:///o=base?attr1?sub?(uid=fred)
7128 value1.1, value1.2
7129
7130 ldap:///o=base?attr2?sub?(uid=fred)
7131 value two
7132
7133 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7134 attr1="value1.1, value1.2" attr2="value two"
7135
7136 ldap:///o=base??sub?(uid=fred)
7137 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7138 .endd
7139 The &%extract%& operator in string expansions can be used to pick out
7140 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7141 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7142 results of LDAP lookups.
7143
7144
7145
7146
7147 .section "More about NIS+" "SECTnisplus"
7148 .cindex "NIS+ lookup type"
7149 .cindex "lookup" "NIS+"
7150 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7151 and field name. If this is given, the result of a successful query is the
7152 contents of the named field; otherwise the result consists of a concatenation
7153 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7154 values containing spaces are quoted. For example, the query
7155 .code
7156 [name=mg1456],passwd.org_dir
7157 .endd
7158 might return the string
7159 .code
7160 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7161 home=/home/mg1456 shell=/bin/bash shadow=""
7162 .endd
7163 (split over two lines here to fit on the page), whereas
7164 .code
7165 [name=mg1456],passwd.org_dir:gcos
7166 .endd
7167 would just return
7168 .code
7169 Martin Guerre
7170 .endd
7171 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7172 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7173 operator is to double any quote characters within the text.
7174
7175
7176
7177 .section "SQL lookups" "SECTsql"
7178 .cindex "SQL lookup types"
7179 .cindex "MySQL" "lookup type"
7180 .cindex "PostgreSQL lookup type"
7181 .cindex "lookup" "MySQL"
7182 .cindex "lookup" "PostgreSQL"
7183 .cindex "Oracle" "lookup type"
7184 .cindex "lookup" "Oracle"
7185 .cindex "InterBase lookup type"
7186 .cindex "lookup" "InterBase"
7187 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7188 databases. Queries for these databases contain SQL statements, so an example
7189 might be
7190 .code
7191 ${lookup mysql{select mailbox from users where id='userx'}\
7192   {$value}fail}
7193 .endd
7194 If the result of the query contains more than one field, the data for each
7195 field in the row is returned, preceded by its name, so the result of
7196 .code
7197 ${lookup pgsql{select home,name from users where id='userx'}\
7198   {$value}}
7199 .endd
7200 might be
7201 .code
7202 home=/home/userx name="Mister X"
7203 .endd
7204 Empty values and values containing spaces are double quoted, with embedded
7205 quotes escaped by a backslash. If the result of the query contains just one
7206 field, the value is passed back verbatim, without a field name, for example:
7207 .code
7208 Mister X
7209 .endd
7210 If the result of the query yields more than one row, it is all concatenated,
7211 with a newline between the data for each row.
7212
7213
7214 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7215 .cindex "MySQL" "lookup type"
7216 .cindex "PostgreSQL lookup type"
7217 .cindex "lookup" "MySQL"
7218 .cindex "lookup" "PostgreSQL"
7219 .cindex "Oracle" "lookup type"
7220 .cindex "lookup" "Oracle"
7221 .cindex "InterBase lookup type"
7222 .cindex "lookup" "InterBase"
7223 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7224 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7225 option (as appropriate) must be set to a colon-separated list of server
7226 information.
7227 (For MySQL and PostgreSQL only, the global option need not be set if all
7228 queries contain their own server information &-- see section
7229 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7230 items: host name, database name, user name, and password. In the case of
7231 Oracle, the host name field is used for the &"service name"&, and the database
7232 name field is not used and should be empty. For example:
7233 .code
7234 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7235 .endd
7236 Because password data is sensitive, you should always precede the setting with
7237 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7238 option. Here is an example where two MySQL servers are listed:
7239 .code
7240 hide mysql_servers = localhost/users/root/secret:\
7241                      otherhost/users/root/othersecret
7242 .endd
7243 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7244 because this is a colon-separated list, the colon has to be doubled. For each
7245 query, these parameter groups are tried in order until a connection is made and
7246 a query is successfully processed. The result of a query may be that no data is
7247 found, but that is still a successful query. In other words, the list of
7248 servers provides a backup facility, not a list of different places to look.
7249
7250 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7251 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7252 respectively, and the characters single-quote, double-quote, and backslash
7253 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7254 addition, escapes the percent and underscore characters. This cannot be done
7255 for MySQL because these escapes are not recognized in contexts where these
7256 characters are not special.
7257
7258 .section "Specifying the server in the query" "SECTspeserque"
7259 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7260 it is possible to specify a list of servers with an individual query. This is
7261 done by starting the query with
7262 .display
7263 &`servers=`&&'server1:server2:server3:...'&&`;`&
7264 .endd
7265 Each item in the list may take one of two forms:
7266 .olist
7267 If it contains no slashes it is assumed to be just a host name. The appropriate
7268 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7269 of the same name, and the remaining parameters (database, user, password) are
7270 taken from there.
7271 .next
7272 If it contains any slashes, it is taken as a complete parameter set.
7273 .endlist
7274 The list of servers is used in exactly the same way as the global list.
7275 Once a connection to a server has happened and a query has been
7276 successfully executed, processing of the lookup ceases.
7277
7278 This feature is intended for use in master/slave situations where updates
7279 are occurring and you want to update the master rather than a slave. If the
7280 master is in the list as a backup for reading, you might have a global setting
7281 like this:
7282 .code
7283 mysql_servers = slave1/db/name/pw:\
7284                 slave2/db/name/pw:\
7285                 master/db/name/pw
7286 .endd
7287 In an updating lookup, you could then write:
7288 .code
7289 ${lookup mysql{servers=master; UPDATE ...} }
7290 .endd
7291 That query would then be sent only to the master server. If, on the other hand,
7292 the master is not to be used for reading, and so is not present in the global
7293 option, you can still update it by a query of this form:
7294 .code
7295 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7296 .endd
7297
7298
7299 .section "Special MySQL features" "SECID73"
7300 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7301 causes a connection to the server on the local host by means of a Unix domain
7302 socket. An alternate socket can be specified in parentheses. The full syntax of
7303 each item in &%mysql_servers%& is:
7304 .display
7305 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7306   <&'user'&>/<&'password'&>
7307 .endd
7308 Any of the three sub-parts of the first field can be omitted. For normal use on
7309 the local host it can be left blank or set to just &"localhost"&.
7310
7311 No database need be supplied &-- but if it is absent here, it must be given in
7312 the queries.
7313
7314 If a MySQL query is issued that does not request any data (an insert, update,
7315 or delete command), the result of the lookup is the number of rows affected.
7316
7317 &*Warning*&: This can be misleading. If an update does not actually change
7318 anything (for example, setting a field to the value it already has), the result
7319 is zero because no rows are affected.
7320
7321
7322 .section "Special PostgreSQL features" "SECID74"
7323 PostgreSQL lookups can also use Unix domain socket connections to the database.
7324 This is usually faster and costs less CPU time than a TCP/IP connection.
7325 However it can be used only if the mail server runs on the same machine as the
7326 database server. A configuration line for PostgreSQL via Unix domain sockets
7327 looks like this:
7328 .code
7329 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7330 .endd
7331 In other words, instead of supplying a host name, a path to the socket is
7332 given. The path name is enclosed in parentheses so that its slashes aren't
7333 visually confused with the delimiters for the other server parameters.
7334
7335 If a PostgreSQL query is issued that does not request any data (an insert,
7336 update, or delete command), the result of the lookup is the number of rows
7337 affected.
7338
7339 .section "More about SQLite" "SECTsqlite"
7340 .cindex "lookup" "SQLite"
7341 .cindex "sqlite lookup type"
7342 SQLite is different to the other SQL lookups because a file name is required in
7343 addition to the SQL query. An SQLite database is a single file, and there is no
7344 daemon as in the other SQL databases. The interface to Exim requires the name
7345 of the file, as an absolute path, to be given at the start of the query. It is
7346 separated from the query by white space. This means that the path name cannot
7347 contain white space. Here is a lookup expansion example:
7348 .code
7349 ${lookup sqlite {/some/thing/sqlitedb \
7350   select name from aliases where id='userx';}}
7351 .endd
7352 In a list, the syntax is similar. For example:
7353 .code
7354 domainlist relay_domains = sqlite;/some/thing/sqlitedb \
7355    select * from relays where ip='$sender_host_address';
7356 .endd
7357 The only character affected by the &%quote_sqlite%& operator is a single
7358 quote, which it doubles.
7359
7360 The SQLite library handles multiple simultaneous accesses to the database
7361 internally. Multiple readers are permitted, but only one process can
7362 update at once. Attempts to access the database while it is being updated
7363 are rejected after a timeout period, during which the SQLite library
7364 waits for the lock to be released. In Exim, the default timeout is set
7365 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7366 option.
7367 .ecindex IIDfidalo1
7368 .ecindex IIDfidalo2
7369
7370
7371 . ////////////////////////////////////////////////////////////////////////////
7372 . ////////////////////////////////////////////////////////////////////////////
7373
7374 .chapter "Domain, host, address, and local part lists" &&&
7375          "CHAPdomhosaddlists" &&&
7376          "Domain, host, and address lists"
7377 .scindex IIDdohoadli "lists of domains; hosts; etc."
7378 A number of Exim configuration options contain lists of domains, hosts,
7379 email addresses, or local parts. For example, the &%hold_domains%& option
7380 contains a list of domains whose delivery is currently suspended. These lists
7381 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7382 arguments to expansion conditions such as &%match_domain%&.
7383
7384 Each item in one of these lists is a pattern to be matched against a domain,
7385 host, email address, or local part, respectively. In the sections below, the
7386 different types of pattern for each case are described, but first we cover some
7387 general facilities that apply to all four kinds of list.
7388
7389
7390
7391 .section "Expansion of lists" "SECID75"
7392 .cindex "expansion" "of lists"
7393 Each list is expanded as a single string before it is used. The result of
7394 expansion must be a list, possibly containing empty items, which is split up
7395 into separate items for matching. By default, colon is the separator character,
7396 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7397 &<<SECTempitelis>>& for details of the list syntax; the second of these
7398 discusses the way to specify empty list items.
7399
7400
7401 If the string expansion is forced to fail, Exim behaves as if the item it is
7402 testing (domain, host, address, or local part) is not in the list. Other
7403 expansion failures cause temporary errors.
7404
7405 If an item in a list is a regular expression, backslashes, dollars and possibly
7406 other special characters in the expression must be protected against
7407 misinterpretation by the string expander. The easiest way to do this is to use
7408 the &`\N`& expansion feature to indicate that the contents of the regular
7409 expression should not be expanded. For example, in an ACL you might have:
7410 .code
7411 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7412                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7413 .endd
7414 The first item is a regular expression that is protected from expansion by
7415 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7416 senders based on the receiving domain.
7417
7418
7419
7420
7421 .section "Negated items in lists" "SECID76"
7422 .cindex "list" "negation"
7423 .cindex "negation" "in lists"
7424 Items in a list may be positive or negative. Negative items are indicated by a
7425 leading exclamation mark, which may be followed by optional white space. A list
7426 defines a set of items (domains, etc). When Exim processes one of these lists,
7427 it is trying to find out whether a domain, host, address, or local part
7428 (respectively) is in the set that is defined by the list. It works like this:
7429
7430 The list is scanned from left to right. If a positive item is matched, the
7431 subject that is being checked is in the set; if a negative item is matched, the
7432 subject is not in the set. If the end of the list is reached without the
7433 subject having matched any of the patterns, it is in the set if the last item
7434 was a negative one, but not if it was a positive one. For example, the list in
7435 .code
7436 domainlist relay_domains = !a.b.c : *.b.c
7437 .endd
7438 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7439 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7440 list is positive. However, if the setting were
7441 .code
7442 domainlist relay_domains = !a.b.c
7443 .endd
7444 then all domains other than &'a.b.c'& would match because the last item in the
7445 list is negative. In other words, a list that ends with a negative item behaves
7446 as if it had an extra item &`:*`& on the end.
7447
7448 Another way of thinking about positive and negative items in lists is to read
7449 the connector as &"or"& after a positive item and as &"and"& after a negative
7450 item.
7451
7452
7453
7454 .section "File names in lists" "SECTfilnamlis"
7455 .cindex "list" "file name in"
7456 If an item in a domain, host, address, or local part list is an absolute file
7457 name (beginning with a slash character), each line of the file is read and
7458 processed as if it were an independent item in the list, except that further
7459 file names are not allowed,
7460 and no expansion of the data from the file takes place.
7461 Empty lines in the file are ignored, and the file may also contain comment
7462 lines:
7463
7464 .ilist
7465 For domain and host lists, if a # character appears anywhere in a line of the
7466 file, it and all following characters are ignored.
7467 .next
7468 Because local parts may legitimately contain # characters, a comment in an
7469 address list or local part list file is recognized only if # is preceded by
7470 white space or the start of the line. For example:
7471 .code
7472 not#comment@x.y.z   # but this is a comment
7473 .endd
7474 .endlist
7475
7476 Putting a file name in a list has the same effect as inserting each line of the
7477 file as an item in the list (blank lines and comments excepted). However, there
7478 is one important difference: the file is read each time the list is processed,
7479 so if its contents vary over time, Exim's behaviour changes.
7480
7481 If a file name is preceded by an exclamation mark, the sense of any match
7482 within the file is inverted. For example, if
7483 .code
7484 hold_domains = !/etc/nohold-domains
7485 .endd
7486 and the file contains the lines
7487 .code
7488 !a.b.c
7489 *.b.c
7490 .endd
7491 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7492 any domain matching &`*.b.c`& is not.
7493
7494
7495
7496 .section "An lsearch file is not an out-of-line list" "SECID77"
7497 As will be described in the sections that follow, lookups can be used in lists
7498 to provide indexed methods of checking list membership. There has been some
7499 confusion about the way &(lsearch)& lookups work in lists. Because
7500 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7501 sometimes thought that it is allowed to contain wild cards and other kinds of
7502 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7503 always fixed strings, just as for any other single-key lookup type.
7504
7505 If you want to use a file to contain wild-card patterns that form part of a
7506 list, just give the file name on its own, without a search type, as described
7507 in the previous section. You could also use the &(wildlsearch)& or
7508 &(nwildlsearch)&, but there is no advantage in doing this.
7509
7510
7511
7512
7513 .section "Named lists" "SECTnamedlists"
7514 .cindex "named lists"
7515 .cindex "list" "named"
7516 A list of domains, hosts, email addresses, or local parts can be given a name
7517 which is then used to refer to the list elsewhere in the configuration. This is
7518 particularly convenient if the same list is required in several different
7519 places. It also allows lists to be given meaningful names, which can improve
7520 the readability of the configuration. For example, it is conventional to define
7521 a domain list called &'local_domains'& for all the domains that are handled
7522 locally on a host, using a configuration line such as
7523 .code
7524 domainlist local_domains = localhost:my.dom.example
7525 .endd
7526 Named lists are referenced by giving their name preceded by a plus sign, so,
7527 for example, a router that is intended to handle local domains would be
7528 configured with the line
7529 .code
7530 domains = +local_domains
7531 .endd
7532 The first router in a configuration is often one that handles all domains
7533 except the local ones, using a configuration with a negated item like this:
7534 .code
7535 dnslookup:
7536   driver = dnslookup
7537   domains = ! +local_domains
7538   transport = remote_smtp
7539   no_more
7540 .endd
7541 The four kinds of named list are created by configuration lines starting with
7542 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7543 respectively. Then there follows the name that you are defining, followed by an
7544 equals sign and the list itself. For example:
7545 .code
7546 hostlist    relay_hosts = 192.168.23.0/24 : my.friend.example
7547 addresslist bad_senders = cdb;/etc/badsenders
7548 .endd
7549 A named list may refer to other named lists:
7550 .code
7551 domainlist  dom1 = first.example : second.example
7552 domainlist  dom2 = +dom1 : third.example
7553 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7554 .endd
7555 &*Warning*&: If the last item in a referenced list is a negative one, the
7556 effect may not be what you intended, because the negation does not propagate
7557 out to the higher level. For example, consider:
7558 .code
7559 domainlist  dom1 = !a.b
7560 domainlist  dom2 = +dom1 : *.b
7561 .endd
7562 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7563 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7564 means it matches the second list as well. The effect is not the same as
7565 .code
7566 domainlist  dom2 = !a.b : *.b
7567 .endd
7568 where &'x.y'& does not match. It's best to avoid negation altogether in
7569 referenced lists if you can.
7570
7571 Named lists may have a performance advantage. When Exim is routing an
7572 address or checking an incoming message, it caches the result of tests on named
7573 lists. So, if you have a setting such as
7574 .code
7575 domains = +local_domains
7576 .endd
7577 on several of your routers
7578 or in several ACL statements,
7579 the actual test is done only for the first one. However, the caching works only
7580 if there are no expansions within the list itself or any sublists that it
7581 references. In other words, caching happens only for lists that are known to be
7582 the same each time they are referenced.
7583
7584 By default, there may be up to 16 named lists of each type. This limit can be
7585 extended by changing a compile-time variable. The use of domain and host lists
7586 is recommended for concepts such as local domains, relay domains, and relay
7587 hosts. The default configuration is set up like this.
7588
7589
7590
7591 .section "Named lists compared with macros" "SECID78"
7592 .cindex "list" "named compared with macro"
7593 .cindex "macro" "compared with named list"
7594 At first sight, named lists might seem to be no different from macros in the
7595 configuration file. However, macros are just textual substitutions. If you
7596 write
7597 .code
7598 ALIST = host1 : host2
7599 auth_advertise_hosts = !ALIST
7600 .endd
7601 it probably won't do what you want, because that is exactly the same as
7602 .code
7603 auth_advertise_hosts = !host1 : host2
7604 .endd
7605 Notice that the second host name is not negated. However, if you use a host
7606 list, and write
7607 .code
7608 hostlist alist = host1 : host2
7609 auth_advertise_hosts = ! +alist
7610 .endd
7611 the negation applies to the whole list, and so that is equivalent to
7612 .code
7613 auth_advertise_hosts = !host1 : !host2
7614 .endd
7615
7616
7617 .section "Named list caching" "SECID79"
7618 .cindex "list" "caching of named"
7619 .cindex "caching" "named lists"
7620 While processing a message, Exim caches the result of checking a named list if
7621 it is sure that the list is the same each time. In practice, this means that
7622 the cache operates only if the list contains no $ characters, which guarantees
7623 that it will not change when it is expanded. Sometimes, however, you may have
7624 an expanded list that you know will be the same each time within a given
7625 message. For example:
7626 .code
7627 domainlist special_domains = \
7628            ${lookup{$sender_host_address}cdb{/some/file}}
7629 .endd
7630 This provides a list of domains that depends only on the sending host's IP
7631 address. If this domain list is referenced a number of times (for example,
7632 in several ACL lines, or in several routers) the result of the check is not
7633 cached by default, because Exim does not know that it is going to be the
7634 same list each time.
7635
7636 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7637 cache the result anyway. For example:
7638 .code
7639 domainlist_cache special_domains = ${lookup{...
7640 .endd
7641 If you do this, you should be absolutely sure that caching is going to do
7642 the right thing in all cases. When in doubt, leave it out.
7643
7644
7645
7646 .section "Domain lists" "SECTdomainlist"
7647 .cindex "domain list" "patterns for"
7648 .cindex "list" "domain list"
7649 Domain lists contain patterns that are to be matched against a mail domain.
7650 The following types of item may appear in domain lists:
7651
7652 .ilist
7653 .cindex "primary host name"
7654 .cindex "host name" "matched in domain list"
7655 .oindex "&%primary_hostname%&"
7656 .cindex "domain list" "matching primary host name"
7657 .cindex "@ in a domain list"
7658 If a pattern consists of a single @ character, it matches the local host name,
7659 as set by the &%primary_hostname%& option (or defaulted). This makes it
7660 possible to use the same configuration file on several different hosts that
7661 differ only in their names.
7662 .next
7663 .cindex "@[] in a domain list"
7664 .cindex "domain list" "matching local IP interfaces"
7665 .cindex "domain literal"
7666 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7667 in square brackets (as in an email address that contains a domain literal), but
7668 only if that IP address is recognized as local for email routing purposes. The
7669 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7670 control which of a host's several IP addresses are treated as local.
7671 In today's Internet, the use of domain literals is controversial.
7672 .next
7673 .cindex "@mx_any"
7674 .cindex "@mx_primary"
7675 .cindex "@mx_secondary"
7676 .cindex "domain list" "matching MX pointers to local host"
7677 If a pattern consists of the string &`@mx_any`& it matches any domain that
7678 has an MX record pointing to the local host or to any host that is listed in
7679 .oindex "&%hosts_treat_as_local%&"
7680 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7681 are similar, except that the first matches only when a primary MX target is the
7682 local host, and the second only when no primary MX target is the local host,
7683 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7684 preference value &-- there may of course be more than one of them.
7685
7686 The MX lookup that takes place when matching a pattern of this type is
7687 performed with the resolver options for widening names turned off. Thus, for
7688 example, a single-component domain will &'not'& be expanded by adding the
7689 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7690 options of the &(dnslookup)& router for a discussion of domain widening.
7691
7692 Sometimes you may want to ignore certain IP addresses when using one of these
7693 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7694 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7695 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7696 on a router). For example:
7697 .code
7698 domains = @mx_any/ignore=127.0.0.1
7699 .endd
7700 This example matches any domain that has an MX record pointing to one of
7701 the local host's IP addresses other than 127.0.0.1.
7702
7703 The list of IP addresses is in fact processed by the same code that processes
7704 host lists, so it may contain CIDR-coded network specifications and it may also
7705 contain negative items.
7706
7707 Because the list of IP addresses is a sublist within a domain list, you have to
7708 be careful about delimiters if there is more than one address. Like any other
7709 list, the default delimiter can be changed. Thus, you might have:
7710 .code
7711 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7712           an.other.domain : ...
7713 .endd
7714 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7715 involved, it is easiest to change the delimiter for the main list as well:
7716 .code
7717 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7718           an.other.domain ? ...
7719 .endd
7720 .next
7721 .cindex "asterisk" "in domain list"
7722 .cindex "domain list" "asterisk in"
7723 .cindex "domain list" "matching &""ends with""&"
7724 If a pattern starts with an asterisk, the remaining characters of the pattern
7725 are compared with the terminating characters of the domain. The use of &"*"& in
7726 domain lists differs from its use in partial matching lookups. In a domain
7727 list, the character following the asterisk need not be a dot, whereas partial
7728 matching works only in terms of dot-separated components. For example, a domain
7729 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7730 &'cipher.key.ex'&.
7731
7732 .next
7733 .cindex "regular expressions" "in domain list"
7734 .cindex "domain list" "matching regular expression"
7735 If a pattern starts with a circumflex character, it is treated as a regular
7736 expression, and matched against the domain using a regular expression matching
7737 function. The circumflex is treated as part of the regular expression.
7738 Email domains are case-independent, so this regular expression match is by
7739 default case-independent, but you can make it case-dependent by starting it
7740 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7741 are given in chapter &<<CHAPregexp>>&.
7742
7743 &*Warning*&: Because domain lists are expanded before being processed, you
7744 must escape any backslash and dollar characters in the regular expression, or
7745 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7746 it is not to be expanded (unless you really do want to build a regular
7747 expression by expansion, of course).
7748 .next
7749 .cindex "lookup" "in domain list"
7750 .cindex "domain list" "matching by lookup"
7751 If a pattern starts with the name of a single-key lookup type followed by a
7752 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7753 must be a file name in a suitable format for the lookup type. For example, for
7754 &"cdb;"& it must be an absolute path:
7755 .code
7756 domains = cdb;/etc/mail/local_domains.cdb
7757 .endd
7758 The appropriate type of lookup is done on the file using the domain name as the
7759 key. In most cases, the data that is looked up is not used; Exim is interested
7760 only in whether or not the key is present in the file. However, when a lookup
7761 is used for the &%domains%& option on a router
7762 or a &%domains%& condition in an ACL statement, the data is preserved in the
7763 &$domain_data$& variable and can be referred to in other router options or
7764 other statements in the same ACL.
7765
7766 .next
7767 Any of the single-key lookup type names may be preceded by
7768 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7769 .code
7770 domains = partial-dbm;/partial/domains
7771 .endd
7772 This causes partial matching logic to be invoked; a description of how this
7773 works is given in section &<<SECTpartiallookup>>&.
7774
7775 .next
7776 .cindex "asterisk" "in lookup type"
7777 Any of the single-key lookup types may be followed by an asterisk. This causes
7778 a default lookup for a key consisting of a single asterisk to be done if the
7779 original lookup fails. This is not a useful feature when using a domain list to
7780 select particular domains (because any domain would match), but it might have
7781 value if the result of the lookup is being used via the &$domain_data$&
7782 expansion variable.
7783 .next
7784 If the pattern starts with the name of a query-style lookup type followed by a
7785 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7786 pattern must be an appropriate query for the lookup type, as described in
7787 chapter &<<CHAPfdlookup>>&. For example:
7788 .code
7789 hold_domains = mysql;select domain from holdlist \
7790   where domain = '$domain';
7791 .endd
7792 In most cases, the data that is looked up is not used (so for an SQL query, for
7793 example, it doesn't matter what field you select). Exim is interested only in
7794 whether or not the query succeeds. However, when a lookup is used for the
7795 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7796 variable and can be referred to in other options.
7797 .next
7798 .cindex "domain list" "matching literal domain name"
7799 If none of the above cases apply, a caseless textual comparison is made
7800 between the pattern and the domain.
7801 .endlist
7802
7803 Here is an example that uses several different kinds of pattern:
7804 .code
7805 domainlist funny_domains = \
7806   @ : \
7807   lib.unseen.edu : \
7808   *.foundation.fict.example : \
7809   \N^[1-2]\d{3}\.fict\.example$\N : \
7810   partial-dbm;/opt/data/penguin/book : \
7811   nis;domains.byname : \
7812   nisplus;[name=$domain,status=local],domains.org_dir
7813 .endd
7814 There are obvious processing trade-offs among the various matching modes. Using
7815 an asterisk is faster than a regular expression, and listing a few names
7816 explicitly probably is too. The use of a file or database lookup is expensive,
7817 but may be the only option if hundreds of names are required. Because the
7818 patterns are tested in order, it makes sense to put the most commonly matched
7819 patterns earlier.
7820
7821
7822
7823 .section "Host lists" "SECThostlist"
7824 .cindex "host list" "patterns in"
7825 .cindex "list" "host list"
7826 Host lists are used to control what remote hosts are allowed to do. For
7827 example, some hosts may be allowed to use the local host as a relay, and some
7828 may be permitted to use the SMTP ETRN command. Hosts can be identified in
7829 two different ways, by name or by IP address. In a host list, some types of
7830 pattern are matched to a host name, and some are matched to an IP address.
7831 You need to be particularly careful with this when single-key lookups are
7832 involved, to ensure that the right value is being used as the key.
7833
7834
7835 .section "Special host list patterns" "SECID80"
7836 .cindex "empty item in hosts list"
7837 .cindex "host list" "empty string in"
7838 If a host list item is the empty string, it matches only when no remote host is
7839 involved. This is the case when a message is being received from a local
7840 process using SMTP on the standard input, that is, when a TCP/IP connection is
7841 not used.
7842
7843 .cindex "asterisk" "in host list"
7844 The special pattern &"*"& in a host list matches any host or no host. Neither
7845 the IP address nor the name is actually inspected.
7846
7847
7848
7849 .section "Host list patterns that match by IP address" "SECThoslispatip"
7850 .cindex "host list" "matching IP addresses"
7851 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
7852 the incoming address actually appears in the IPv6 host as
7853 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
7854 list, it is converted into a traditional IPv4 address first. (Not all operating
7855 systems accept IPv4 calls on IPv6 sockets, as there have been some security
7856 concerns.)
7857
7858 The following types of pattern in a host list check the remote host by
7859 inspecting its IP address:
7860
7861 .ilist
7862 If the pattern is a plain domain name (not a regular expression, not starting
7863 with *, not a lookup of any kind), Exim calls the operating system function
7864 to find the associated IP address(es). Exim uses the newer
7865 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
7866 This typically causes a forward DNS lookup of the name. The result is compared
7867 with the IP address of the subject host.
7868
7869 If there is a temporary problem (such as a DNS timeout) with the host name
7870 lookup, a temporary error occurs. For example, if the list is being used in an
7871 ACL condition, the ACL gives a &"defer"& response, usually leading to a
7872 temporary SMTP error code. If no IP address can be found for the host name,
7873 what happens is described in section &<<SECTbehipnot>>& below.
7874
7875 .next
7876 .cindex "@ in a host list"
7877 If the pattern is &"@"&, the primary host name is substituted and used as a
7878 domain name, as just described.
7879
7880 .next
7881 If the pattern is an IP address, it is matched against the IP address of the
7882 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
7883 IPv6 addresses can be given in colon-separated format, but the colons have to
7884 be doubled so as not to be taken as item separators when the default list
7885 separator is used. IPv6 addresses are recognized even when Exim is compiled
7886 without IPv6 support. This means that if they appear in a host list on an
7887 IPv4-only host, Exim will not treat them as host names. They are just addresses
7888 that can never match a client host.
7889
7890 .next
7891 .cindex "@[] in a host list"
7892 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
7893 the local host. For example, if the local host is an IPv4 host with one
7894 interface address 10.45.23.56, these two ACL statements have the same effect:
7895 .code
7896 accept hosts = 127.0.0.1 : 10.45.23.56
7897 accept hosts = @[]
7898 .endd
7899 .next
7900 .cindex "CIDR notation"
7901 If the pattern is an IP address followed by a slash and a mask length (for
7902 example 10.11.42.0/24), it is matched against the IP address of the subject
7903 host under the given mask. This allows, an entire network of hosts to be
7904 included (or excluded) by a single item. The mask uses CIDR notation; it
7905 specifies the number of address bits that must match, starting from the most
7906 significant end of the address.
7907
7908 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
7909 of a range of addresses. It is the number of bits in the network portion of the
7910 address. The above example specifies a 24-bit netmask, so it matches all 256
7911 addresses in the 10.11.42.0 network. An item such as
7912 .code
7913 192.168.23.236/31
7914 .endd
7915 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
7916 32 for an IPv4 address is the same as no mask at all; just a single address
7917 matches.
7918
7919 Here is another example which shows an IPv4 and an IPv6 network:
7920 .code
7921 recipient_unqualified_hosts = 192.168.0.0/16: \
7922                               3ffe::ffff::836f::::/48
7923 .endd
7924 The doubling of list separator characters applies only when these items
7925 appear inline in a host list. It is not required when indirecting via a file.
7926 For example:
7927 .code
7928 recipient_unqualified_hosts = /opt/exim/unqualnets
7929 .endd
7930 could make use of a file containing
7931 .code
7932 172.16.0.0/12
7933 3ffe:ffff:836f::/48
7934 .endd
7935 to have exactly the same effect as the previous example. When listing IPv6
7936 addresses inline, it is usually more convenient to use the facility for
7937 changing separator characters. This list contains the same two networks:
7938 .code
7939 recipient_unqualified_hosts = <; 172.16.0.0/12; \
7940                                  3ffe:ffff:836f::/48
7941 .endd
7942 The separator is changed to semicolon by the leading &"<;"& at the start of the
7943 list.
7944 .endlist
7945
7946
7947
7948 .section "Host list patterns for single-key lookups by host address" &&&
7949          "SECThoslispatsikey"
7950 .cindex "host list" "lookup of IP address"
7951 When a host is to be identified by a single-key lookup of its complete IP
7952 address, the pattern takes this form:
7953 .display
7954 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
7955 .endd
7956 For example:
7957 .code
7958 hosts_lookup = net-cdb;/hosts-by-ip.db
7959 .endd
7960 The text form of the IP address of the subject host is used as the lookup key.
7961 IPv6 addresses are converted to an unabbreviated form, using lower case
7962 letters, with dots as separators because colon is the key terminator in
7963 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
7964 quoting the keys, but this is a facility that was added later.] The data
7965 returned by the lookup is not used.
7966
7967 .cindex "IP address" "masking"
7968 .cindex "host list" "masked IP address"
7969 Single-key lookups can also be performed using masked IP addresses, using
7970 patterns of this form:
7971 .display
7972 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
7973 .endd
7974 For example:
7975 .code
7976 net24-dbm;/networks.db
7977 .endd
7978 The IP address of the subject host is masked using <&'number'&> as the mask
7979 length. A textual string is constructed from the masked value, followed by the
7980 mask, and this is used as the lookup key. For example, if the host's IP address
7981 is 192.168.34.6, the key that is looked up for the above example is
7982 &"192.168.34.0/24"&.
7983
7984 When an IPv6 address is converted to a string, dots are normally used instead
7985 of colons, so that keys in &(lsearch)& files need not contain colons (which
7986 terminate &(lsearch)& keys). This was implemented some time before the ability
7987 to quote keys was made available in &(lsearch)& files. However, the more
7988 recently implemented &(iplsearch)& files do require colons in IPv6 keys
7989 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
7990 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
7991 converted using colons and not dots. In all cases, full, unabbreviated IPv6
7992 addresses are always used.
7993
7994 Ideally, it would be nice to tidy up this anomalous situation by changing to
7995 colons in all cases, given that quoting is now available for &(lsearch)&.
7996 However, this would be an incompatible change that might break some existing
7997 configurations.
7998
7999 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8000 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8001 the former case the key strings include the mask value, whereas in the latter
8002 case the IP address is used on its own.
8003
8004
8005
8006 .section "Host list patterns that match by host name" "SECThoslispatnam"
8007 .cindex "host" "lookup failures"
8008 .cindex "unknown host name"
8009 .cindex "host list" "matching host name"
8010 There are several types of pattern that require Exim to know the name of the
8011 remote host. These are either wildcard patterns or lookups by name. (If a
8012 complete hostname is given without any wildcarding, it is used to find an IP
8013 address to match against, as described in the section &<<SECThoslispatip>>&
8014 above.)
8015
8016 If the remote host name is not already known when Exim encounters one of these
8017 patterns, it has to be found from the IP address.
8018 Although many sites on the Internet are conscientious about maintaining reverse
8019 DNS data for their hosts, there are also many that do not do this.
8020 Consequently, a name cannot always be found, and this may lead to unwanted
8021 effects. Take care when configuring host lists with wildcarded name patterns.
8022 Consider what will happen if a name cannot be found.
8023
8024 Because of the problems of determining host names from IP addresses, matching
8025 against host names is not as common as matching against IP addresses.
8026
8027 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8028 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8029 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8030 are done can be changed by setting the &%host_lookup_order%& option. For
8031 security, once Exim has found one or more names, it looks up the IP addresses
8032 for these names and compares them with the IP address that it started with.
8033 Only those names whose IP addresses match are accepted. Any other names are
8034 discarded. If no names are left, Exim behaves as if the host name cannot be
8035 found. In the most common case there is only one name and one IP address.
8036
8037 There are some options that control what happens if a host name cannot be
8038 found. These are described in section &<<SECTbehipnot>>& below.
8039
8040 .cindex "host" "alias for"
8041 .cindex "alias for host"
8042 As a result of aliasing, hosts may have more than one name. When processing any
8043 of the following types of pattern, all the host's names are checked:
8044
8045 .ilist
8046 .cindex "asterisk" "in host list"
8047 If a pattern starts with &"*"& the remainder of the item must match the end of
8048 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8049 &'.b.c'&. This special simple form is provided because this is a very common
8050 requirement. Other kinds of wildcarding require the use of a regular
8051 expression.
8052 .next
8053 .cindex "regular expressions" "in host list"
8054 .cindex "host list" "regular expression in"
8055 If the item starts with &"^"& it is taken to be a regular expression which is
8056 matched against the host name. Host names are case-independent, so this regular
8057 expression match is by default case-independent, but you can make it
8058 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8059 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8060 example,
8061 .code
8062 ^(a|b)\.c\.d$
8063 .endd
8064 is a regular expression that matches either of the two hosts &'a.c.d'& or
8065 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8066 that backslash and dollar characters are not misinterpreted as part of the
8067 string expansion. The simplest way to do this is to use &`\N`& to mark that
8068 part of the string as non-expandable. For example:
8069 .code
8070 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8071 .endd
8072 &*Warning*&: If you want to match a complete host name, you must include the
8073 &`$`& terminating metacharacter in the regular expression, as in the above
8074 example. Without it, a match at the start of the host name is all that is
8075 required.
8076 .endlist
8077
8078
8079
8080
8081 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8082 .cindex "host" "lookup failures, permanent"
8083 While processing a host list, Exim may need to look up an IP address from a
8084 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8085 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8086 behaviour when it fails to find the information it is seeking is the same.
8087
8088 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8089 apply to temporary DNS errors, whose handling is described in the next section.
8090
8091 .cindex "&`+include_unknown`&"
8092 .cindex "&`+ignore_unknown`&"
8093 By default, Exim behaves as if the host does not match the list. This may not
8094 always be what you want to happen. To change Exim's behaviour, the special
8095 items &`+include_unknown`& or &`+ignore_unknown`& may appear in the list (at
8096 top level &-- they are not recognized in an indirected file).
8097
8098 .ilist
8099 If any item that follows &`+include_unknown`& requires information that
8100 cannot found, Exim behaves as if the host does match the list. For example,
8101 .code
8102 host_reject_connection = +include_unknown:*.enemy.ex
8103 .endd
8104 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8105 any hosts whose name it cannot find.
8106
8107 .next
8108 If any item that follows &`+ignore_unknown`& requires information that cannot
8109 be found, Exim ignores that item and proceeds to the rest of the list. For
8110 example:
8111 .code
8112 accept hosts = +ignore_unknown : friend.example : \
8113                192.168.4.5
8114 .endd
8115 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8116 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8117 name can be found for 192.168.4.5, it is rejected.
8118 .endlist
8119
8120 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8121 list. The effect of each one lasts until the next, or until the end of the
8122 list.
8123
8124
8125 .section "Temporary DNS errors when looking up host information" &&&
8126          "SECTtemdnserr"
8127 .cindex "host" "lookup failures, temporary"
8128 .cindex "&`+include_defer`&"
8129 .cindex "&`+ignore_defer`&"
8130 A temporary DNS lookup failure normally causes a defer action (except when
8131 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8132 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8133 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8134 section. These options should be used with care, probably only in non-critical
8135 host lists such as whitelists.
8136
8137
8138
8139 .section "Host list patterns for single-key lookups by host name" &&&
8140          "SECThoslispatnamsk"
8141 .cindex "unknown host name"
8142 .cindex "host list" "matching host name"
8143 If a pattern is of the form
8144 .display
8145 <&'single-key-search-type'&>;<&'search-data'&>
8146 .endd
8147 for example
8148 .code
8149 dbm;/host/accept/list
8150 .endd
8151 a single-key lookup is performed, using the host name as its key. If the
8152 lookup succeeds, the host matches the item. The actual data that is looked up
8153 is not used.
8154
8155 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8156 keys in the file, not IP addresses. If you want to do lookups based on IP
8157 addresses, you must precede the search type with &"net-"& (see section
8158 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8159 two items in the same list, one doing an address lookup and one doing a name
8160 lookup, both using the same file.
8161
8162
8163
8164 .section "Host list patterns for query-style lookups" "SECID81"
8165 If a pattern is of the form
8166 .display
8167 <&'query-style-search-type'&>;<&'query'&>
8168 .endd
8169 the query is obeyed, and if it succeeds, the host matches the item. The actual
8170 data that is looked up is not used. The variables &$sender_host_address$& and
8171 &$sender_host_name$& can be used in the query. For example:
8172 .code
8173 hosts_lookup = pgsql;\
8174   select ip from hostlist where ip='$sender_host_address'
8175 .endd
8176 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8177 can use the &%sg%& expansion item to change this if you need to. If you want to
8178 use masked IP addresses in database queries, you can use the &%mask%& expansion
8179 operator.
8180
8181 If the query contains a reference to &$sender_host_name$&, Exim automatically
8182 looks up the host name if has not already done so. (See section
8183 &<<SECThoslispatnam>>& for comments on finding host names.)
8184
8185 Historical note: prior to release 4.30, Exim would always attempt to find a
8186 host name before running the query, unless the search type was preceded by
8187 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8188 still recognized for query-style lookups, but its presence or absence has no
8189 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8190 See section &<<SECThoslispatsikey>>&.)
8191
8192
8193
8194 .section "Mixing wildcarded host names and addresses in host lists" &&&
8195          "SECTmixwilhos"
8196 .cindex "host list" "mixing names and addresses in"
8197 If you have name lookups or wildcarded host names and IP addresses in the same
8198 host list, you should normally put the IP addresses first. For example, in an
8199 ACL you could have:
8200 .code
8201 accept hosts = 10.9.8.7 : *.friend.example
8202 .endd
8203 The reason for this lies in the left-to-right way that Exim processes lists.
8204 It can test IP addresses without doing any DNS lookups, but when it reaches an
8205 item that requires a host name, it fails if it cannot find a host name to
8206 compare with the pattern. If the above list is given in the opposite order, the
8207 &%accept%& statement fails for a host whose name cannot be found, even if its
8208 IP address is 10.9.8.7.
8209
8210 If you really do want to do the name check first, and still recognize the IP
8211 address, you can rewrite the ACL like this:
8212 .code
8213 accept hosts = *.friend.example
8214 accept hosts = 10.9.8.7
8215 .endd
8216 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8217 &<<CHAPACL>>& for details of ACLs.
8218
8219
8220
8221
8222
8223 .section "Address lists" "SECTaddresslist"
8224 .cindex "list" "address list"
8225 .cindex "address list" "empty item"
8226 .cindex "address list" "patterns"
8227 Address lists contain patterns that are matched against mail addresses. There
8228 is one special case to be considered: the sender address of a bounce message is
8229 always empty. You can test for this by providing an empty item in an address
8230 list. For example, you can set up a router to process bounce messages by
8231 using this option setting:
8232 .code
8233 senders = :
8234 .endd
8235 The presence of the colon creates an empty item. If you do not provide any
8236 data, the list is empty and matches nothing. The empty sender can also be
8237 detected by a regular expression that matches an empty string,
8238 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8239
8240 Non-empty items in an address list can be straightforward email addresses. For
8241 example:
8242 .code
8243 senders = jbc@askone.example : hs@anacreon.example
8244 .endd
8245 A certain amount of wildcarding is permitted. If a pattern contains an @
8246 character, but is not a regular expression and does not begin with a
8247 semicolon-terminated lookup type (described below), the local part of the
8248 subject address is compared with the local part of the pattern, which may start
8249 with an asterisk. If the local parts match, the domain is checked in exactly
8250 the same way as for a pattern in a domain list. For example, the domain can be
8251 wildcarded, refer to a named list, or be a lookup:
8252 .code
8253 deny senders = *@*.spamming.site:\
8254                *@+hostile_domains:\
8255                bozo@partial-lsearch;/list/of/dodgy/sites:\
8256                *@dbm;/bad/domains.db
8257 .endd
8258 .cindex "local part" "starting with !"
8259 .cindex "address list" "local part starting with !"
8260 If a local part that begins with an exclamation mark is required, it has to be
8261 specified using a regular expression, because otherwise the exclamation mark is
8262 treated as a sign of negation, as is standard in lists.
8263
8264 If a non-empty pattern that is not a regular expression or a lookup does not
8265 contain an @ character, it is matched against the domain part of the subject
8266 address. The only two formats that are recognized this way are a literal
8267 domain, or a domain pattern that starts with *. In both these cases, the effect
8268 is the same as if &`*@`& preceded the pattern. For example:
8269 .code
8270 deny senders = enemy.domain : *.enemy.domain
8271 .endd
8272
8273 The following kinds of more complicated address list pattern can match any
8274 address, including the empty address that is characteristic of bounce message
8275 senders:
8276
8277 .ilist
8278 .cindex "regular expressions" "in address list"
8279 .cindex "address list" "regular expression in"
8280 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8281 done against the complete address, with the pattern as the regular expression.
8282 You must take care that backslash and dollar characters are not misinterpreted
8283 as part of the string expansion. The simplest way to do this is to use &`\N`&
8284 to mark that part of the string as non-expandable. For example:
8285 .code
8286 deny senders = \N^.*this.*@example\.com$\N : \
8287                \N^\d{8}.+@spamhaus.example$\N : ...
8288 .endd
8289 The &`\N`& sequences are removed by the expansion, so these items do indeed
8290 start with &"^"& by the time they are being interpreted as address patterns.
8291
8292 .next
8293 .cindex "address list" "lookup for complete address"
8294 Complete addresses can be looked up by using a pattern that starts with a
8295 lookup type terminated by a semicolon, followed by the data for the lookup. For
8296 example:
8297 .code
8298 deny senders = cdb;/etc/blocked.senders : \
8299   mysql;select address from blocked where \
8300   address='${quote_mysql:$sender_address}'
8301 .endd
8302 Both query-style and single-key lookup types can be used. For a single-key
8303 lookup type, Exim uses the complete address as the key. However, empty keys are
8304 not supported for single-key lookups, so a match against the empty address
8305 always fails. This restriction does not apply to query-style lookups.
8306
8307 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8308 cannot be used, and is ignored if specified, with an entry being written to the
8309 panic log.
8310 .cindex "*@ with single-key lookup"
8311 However, you can configure lookup defaults, as described in section
8312 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8313 default. For example, with this lookup:
8314 .code
8315 accept senders = lsearch*@;/some/file
8316 .endd
8317 the file could contains lines like this:
8318 .code
8319 user1@domain1.example
8320 *@domain2.example
8321 .endd
8322 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8323 that are tried is:
8324 .code
8325 nimrod@jaeger.example
8326 *@jaeger.example
8327 *
8328 .endd
8329 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8330 would mean that every address matches, thus rendering the test useless.
8331
8332 &*Warning 2*&: Do not confuse these two kinds of item:
8333 .code
8334 deny recipients = dbm*@;/some/file
8335 deny recipients = *@dbm;/some/file
8336 .endd
8337 The first does a whole address lookup, with defaulting, as just described,
8338 because it starts with a lookup type. The second matches the local part and
8339 domain independently, as described in a bullet point below.
8340 .endlist
8341
8342
8343 The following kinds of address list pattern can match only non-empty addresses.
8344 If the subject address is empty, a match against any of these pattern types
8345 always fails.
8346
8347
8348 .ilist
8349 .cindex "@@ with single-key lookup"
8350 .cindex "address list" "@@ lookup type"
8351 .cindex "address list" "split local part and domain"
8352 If a pattern starts with &"@@"& followed by a single-key lookup item
8353 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8354 split into a local part and a domain. The domain is looked up in the file. If
8355 it is not found, there is no match. If it is found, the data that is looked up
8356 from the file is treated as a colon-separated list of local part patterns, each
8357 of which is matched against the subject local part in turn.
8358
8359 .cindex "asterisk" "in address list"
8360 The lookup may be a partial one, and/or one involving a search for a default
8361 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8362 patterns that are looked up can be regular expressions or begin with &"*"&, or
8363 even be further lookups. They may also be independently negated. For example,
8364 with
8365 .code
8366 deny senders = @@dbm;/etc/reject-by-domain
8367 .endd
8368 the data from which the DBM file is built could contain lines like
8369 .code
8370 baddomain.com:  !postmaster : *
8371 .endd
8372 to reject all senders except &%postmaster%& from that domain.
8373
8374 .cindex "local part" "starting with !"
8375 If a local part that actually begins with an exclamation mark is required, it
8376 has to be specified using a regular expression. In &(lsearch)& files, an entry
8377 may be split over several lines by indenting the second and subsequent lines,
8378 but the separating colon must still be included at line breaks. White space
8379 surrounding the colons is ignored. For example:
8380 .code
8381 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8382 spammer3 : spammer4
8383 .endd
8384 As in all colon-separated lists in Exim, a colon can be included in an item by
8385 doubling.
8386
8387 If the last item in the list starts with a right angle-bracket, the remainder
8388 of the item is taken as a new key to look up in order to obtain a continuation
8389 list of local parts. The new key can be any sequence of characters. Thus one
8390 might have entries like
8391 .code
8392 aol.com: spammer1 : spammer 2 : >*
8393 xyz.com: spammer3 : >*
8394 *:       ^\d{8}$
8395 .endd
8396 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8397 local parts for all domains, in addition to the specific local parts listed for
8398 each domain. Of course, using this feature costs another lookup each time a
8399 chain is followed, but the effort needed to maintain the data is reduced.
8400
8401 .cindex "loop" "in lookups"
8402 It is possible to construct loops using this facility, and in order to catch
8403 them, the chains may be no more than fifty items long.
8404
8405 .next
8406 The @@<&'lookup'&> style of item can also be used with a query-style
8407 lookup, but in this case, the chaining facility is not available. The lookup
8408 can only return a single list of local parts.
8409 .endlist
8410
8411 &*Warning*&: There is an important difference between the address list items
8412 in these two examples:
8413 .code
8414 senders = +my_list
8415 senders = *@+my_list
8416 .endd
8417 In the first one, &`my_list`& is a named address list, whereas in the second
8418 example it is a named domain list.
8419
8420
8421
8422
8423 .section "Case of letters in address lists" "SECTcasletadd"
8424 .cindex "case of local parts"
8425 .cindex "address list" "case forcing"
8426 .cindex "case forcing in address lists"
8427 Domains in email addresses are always handled caselessly, but for local parts
8428 case may be significant on some systems (see &%caseful_local_part%& for how
8429 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8430 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8431 blocking lists should be done in a case-independent manner. Since most address
8432 lists in Exim are used for this kind of control, Exim attempts to do this by
8433 default.
8434
8435 The domain portion of an address is always lowercased before matching it to an
8436 address list. The local part is lowercased by default, and any string
8437 comparisons that take place are done caselessly. This means that the data in
8438 the address list itself, in files included as plain file names, and in any file
8439 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8440 keys in files that are looked up by a search type other than &(lsearch)& (which
8441 works caselessly) must be in lower case, because these lookups are not
8442 case-independent.
8443
8444 .cindex "&`+caseful`&"
8445 To allow for the possibility of caseful address list matching, if an item in
8446 an address list is the string &"+caseful"&, the original case of the local
8447 part is restored for any comparisons that follow, and string comparisons are no
8448 longer case-independent. This does not affect the domain, which remains in
8449 lower case. However, although independent matches on the domain alone are still
8450 performed caselessly, regular expressions that match against an entire address
8451 become case-sensitive after &"+caseful"& has been seen.
8452
8453
8454
8455 .section "Local part lists" "SECTlocparlis"
8456 .cindex "list" "local part list"
8457 .cindex "local part" "list"
8458 Case-sensitivity in local part lists is handled in the same way as for address
8459 lists, as just described. The &"+caseful"& item can be used if required. In a
8460 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8461 set false, the subject is lowercased and the matching is initially
8462 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8463 matching in the local part list, but not elsewhere in the router. If
8464 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8465 option is case-sensitive from the start.
8466
8467 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8468 comments are handled in the same way as address lists &-- they are recognized
8469 only if the # is preceded by white space or the start of the line.
8470 Otherwise, local part lists are matched in the same way as domain lists, except
8471 that the special items that refer to the local host (&`@`&, &`@[]`&,
8472 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8473 Refer to section &<<SECTdomainlist>>& for details of the other available item
8474 types.
8475 .ecindex IIDdohoadli
8476
8477
8478
8479
8480 . ////////////////////////////////////////////////////////////////////////////
8481 . ////////////////////////////////////////////////////////////////////////////
8482
8483 .chapter "String expansions" "CHAPexpand"
8484 .scindex IIDstrexp "expansion" "of strings"
8485 Many strings in Exim's run time configuration are expanded before use. Some of
8486 them are expanded every time they are used; others are expanded only once.
8487
8488 When a string is being expanded it is copied verbatim from left to right except
8489 when a dollar or backslash character is encountered. A dollar specifies the
8490 start of a portion of the string that is interpreted and replaced as described
8491 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8492 escape character, as described in the following section.
8493
8494
8495
8496 .section "Literal text in expanded strings" "SECTlittext"
8497 .cindex "expansion" "including literal text"
8498 An uninterpreted dollar can be included in an expanded string by putting a
8499 backslash in front of it. A backslash can be used to prevent any special
8500 character being treated specially in an expansion, including backslash itself.
8501 If the string appears in quotes in the configuration file, two backslashes are
8502 required because the quotes themselves cause interpretation of backslashes when
8503 the string is read in (see section &<<SECTstrings>>&).
8504
8505 .cindex "expansion" "non-expandable substrings"
8506 A portion of the string can specified as non-expandable by placing it between
8507 two occurrences of &`\N`&. This is particularly useful for protecting regular
8508 expressions, which often contain backslashes and dollar signs. For example:
8509 .code
8510 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8511 .endd
8512 On encountering the first &`\N`&, the expander copies subsequent characters
8513 without interpretation until it reaches the next &`\N`& or the end of the
8514 string.
8515
8516
8517
8518 .section "Character escape sequences in expanded strings" "SECID82"
8519 .cindex "expansion" "escape sequences"
8520 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8521 expanded string is recognized as an escape sequence for the character newline,
8522 carriage return, or tab, respectively. A backslash followed by up to three
8523 octal digits is recognized as an octal encoding for a single character, and a
8524 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8525 encoding.
8526
8527 These escape sequences are also recognized in quoted strings when they are read
8528 in. Their interpretation in expansions as well is useful for unquoted strings,
8529 and for other cases such as looked-up strings that are then expanded.
8530
8531
8532 .section "Testing string expansions" "SECID83"
8533 .cindex "expansion" "testing"
8534 .cindex "testing" "string expansion"
8535 .oindex "&%-be%&"
8536 Many expansions can be tested by calling Exim with the &%-be%& option. This
8537 takes the command arguments, or lines from the standard input if there are no
8538 arguments, runs them through the string expansion code, and writes the results
8539 to the standard output. Variables based on configuration values are set up, but
8540 since no message is being processed, variables such as &$local_part$& have no
8541 value. Nevertheless the &%-be%& option can be useful for checking out file and
8542 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8543 and &%nhash%&.
8544
8545 Exim gives up its root privilege when it is called with the &%-be%& option, and
8546 instead runs under the uid and gid it was called with, to prevent users from
8547 using &%-be%& for reading files to which they do not have access.
8548
8549 .oindex "&%-bem%&"
8550 If you want to test expansions that include variables whose values are taken
8551 from a message, there are two other options that can be used. The &%-bem%&
8552 option is like &%-be%& except that it is followed by a file name. The file is
8553 read as a message before doing the test expansions. For example:
8554 .code
8555 exim -bem /tmp/test.message '$h_subject:'
8556 .endd
8557 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8558 Exim message identifier. For example:
8559 .code
8560 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8561 .endd
8562 This loads the message from Exim's spool before doing the test expansions, and
8563 is therefore restricted to admin users.
8564
8565
8566 .section "Forced expansion failure" "SECTforexpfai"
8567 .cindex "expansion" "forced failure"
8568 A number of expansions that are described in the following section have
8569 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8570 (which are sometimes called &"curly brackets"&). Which of the two strings is
8571 used depends on some condition that is evaluated as part of the expansion. If,
8572 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8573 the entire string expansion fails in a way that can be detected by the code
8574 that requested the expansion. This is called &"forced expansion failure"&, and
8575 its consequences depend on the circumstances. In some cases it is no different
8576 from any other expansion failure, but in others a different action may be
8577 taken. Such variations are mentioned in the documentation of the option that is
8578 being expanded.
8579
8580
8581
8582
8583 .section "Expansion items" "SECTexpansionitems"
8584 The following items are recognized in expanded strings. White space may be used
8585 between sub-items that are keywords or substrings enclosed in braces inside an
8586 outer set of braces, to improve readability. &*Warning*&: Within braces,
8587 white space is significant.
8588
8589 .vlist
8590 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8591 .cindex "expansion" "variables"
8592 Substitute the contents of the named variable, for example:
8593 .code
8594 $local_part
8595 ${domain}
8596 .endd
8597 The second form can be used to separate the name from subsequent alphanumeric
8598 characters. This form (using braces) is available only for variables; it does
8599 &'not'& apply to message headers. The names of the variables are given in
8600 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8601 given, the expansion fails.
8602
8603 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8604 .cindex "expansion" "operators"
8605 The string is first itself expanded, and then the operation specified by
8606 <&'op'&> is applied to it. For example:
8607 .code
8608 ${lc:$local_part}
8609 .endd
8610 The string starts with the first character after the colon, which may be
8611 leading white space. A list of operators is given in section &<<SECTexpop>>&
8612 below. The operator notation is used for simple expansion items that have just
8613 one argument, because it reduces the number of braces and therefore makes the
8614 string easier to understand.
8615
8616 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8617 This item inserts &"basic"& header lines. It is described with the &%header%&
8618 expansion item below.
8619
8620 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8621        {*&<&'arg'&>&*}...}*&"
8622 .cindex &%dlfunc%&
8623 This expansion dynamically loads and then calls a locally-written C function.
8624 This functionality is available only if Exim is compiled with
8625 .code
8626 EXPAND_DLFUNC=yes
8627 .endd
8628 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8629 object so that it doesn't reload the same object file in the same Exim process
8630 (but of course Exim does start new processes frequently).
8631
8632 There may be from zero to eight arguments to the function. When compiling
8633 a local function that is to be called in this way, &_local_scan.h_& should be
8634 included. The Exim variables and functions that are defined by that API
8635 are also available for dynamically loaded functions. The function itself
8636 must have the following type:
8637 .code
8638 int dlfunction(uschar **yield, int argc, uschar *argv[])
8639 .endd
8640 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8641 function should return one of the following values:
8642
8643 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8644 into the expanded string that is being built.
8645
8646 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8647 from &'yield'&, if it is set.
8648
8649 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8650 taken from &'yield'& if it is set.
8651
8652 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8653
8654 When compiling a function that is to be used in this way with gcc,
8655 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8656 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8657
8658 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8659        {*&<&'string3'&>&*}}*&"
8660 .cindex "expansion" "extracting substrings by key"
8661 .cindex "&%extract%&" "substrings by key"
8662 The key and <&'string1'&> are first expanded separately. Leading and trailing
8663 white space is removed from the key (but not from any of the strings). The key
8664 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8665 form:
8666 .display
8667 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8668 .endd
8669 .vindex "&$value$&"
8670 where the equals signs and spaces (but not both) are optional. If any of the
8671 values contain white space, they must be enclosed in double quotes, and any
8672 values that are enclosed in double quotes are subject to escape processing as
8673 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8674 for the value that corresponds to the key. The search is case-insensitive. If
8675 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8676 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8677 variable &$value$& contains the value that has been extracted. Afterwards, it
8678 is restored to any previous value it might have had.
8679
8680 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8681 key is not found. If {<&'string2'&>} is also omitted, the value that was
8682 extracted is used. Thus, for example, these two expansions are identical, and
8683 yield &"2001"&:
8684 .code
8685 ${extract{gid}{uid=1984 gid=2001}}
8686 ${extract{gid}{uid=1984 gid=2001}{$value}}
8687 .endd
8688 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8689 appear, for example:
8690 .code
8691 ${extract{Z}{A=... B=...}{$value} fail }
8692 .endd
8693 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8694 {<&'string2'&>} must be present for &"fail"& to be recognized.
8695
8696
8697 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8698         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8699 .cindex "expansion" "extracting substrings by number"
8700 .cindex "&%extract%&" "substrings by number"
8701 The <&'number'&> argument must consist entirely of decimal digits,
8702 apart from leading and trailing white space, which is ignored.
8703 This is what distinguishes this form of &%extract%& from the previous kind. It
8704 behaves in the same way, except that, instead of extracting a named field, it
8705 extracts from <&'string1'&> the field whose number is given as the first
8706 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8707 <&'string3'&> as before.
8708
8709 The fields in the string are separated by any one of the characters in the
8710 separator string. These may include space or tab characters.
8711 The first field is numbered one. If the number is negative, the fields are
8712 counted from the end of the string, with the rightmost one numbered -1. If the
8713 number given is zero, the entire string is returned. If the modulus of the
8714 number is greater than the number of fields in the string, the result is the
8715 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8716 provided. For example:
8717 .code
8718 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8719 .endd
8720 yields &"42"&, and
8721 .code
8722 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8723 .endd
8724 yields &"99"&. Two successive separators mean that the field between them is
8725 empty (for example, the fifth field above).
8726
8727
8728 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8729 .cindex "list" "selecting by condition"
8730 .cindex "expansion" "selecting from list by condition"
8731 .vindex "&$item$&"
8732 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8733 default, but the separator can be changed in the usual way. For each item
8734 in this list, its value is place in &$item$&, and then the condition is
8735 evaluated. If the condition is true, &$item$& is added to the output as an
8736 item in a new list; if the condition is false, the item is discarded. The
8737 separator used for the output list is the same as the one used for the
8738 input, but a separator setting is not included in the output. For example:
8739 .code
8740 ${filter{a:b:c}{!eq{$item}{b}}
8741 .endd
8742 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8743 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8744
8745
8746 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8747 .cindex "hash function" "textual"
8748 .cindex "expansion" "textual hash"
8749 This is a textual hashing function, and was the first to be implemented in
8750 early versions of Exim. In current releases, there are other hashing functions
8751 (numeric, MD5, and SHA-1), which are described below.
8752
8753 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
8754 <&'n'&>. If you are using fixed values for these numbers, that is, if
8755 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
8756 use the simpler operator notation that avoids some of the braces:
8757 .code
8758 ${hash_<n>_<m>:<string>}
8759 .endd
8760 The second number is optional (in both notations). If <&'n'&> is greater than
8761 or equal to the length of the string, the expansion item returns the string.
8762 Otherwise it computes a new string of length <&'n'&> by applying a hashing
8763 function to the string. The new string consists of characters taken from the
8764 first <&'m'&> characters of the string
8765 .code
8766 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
8767 .endd
8768 If <&'m'&> is not present the value 26 is used, so that only lower case
8769 letters appear. For example:
8770 .display
8771 &`$hash{3}{monty}}           `&   yields  &`jmg`&
8772 &`$hash{5}{monty}}           `&   yields  &`monty`&
8773 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
8774 .endd
8775
8776 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
8777         &*$h_*&<&'header&~name'&>&*:*&" &&&
8778        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8779         &*$bh_*&<&'header&~name'&>&*:*&" &&&
8780        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8781         &*$rh_*&<&'header&~name'&>&*:*&"
8782 .cindex "expansion" "header insertion"
8783 .vindex "&$header_$&"
8784 .vindex "&$bheader_$&"
8785 .vindex "&$rheader_$&"
8786 .cindex "header lines" "in expansion strings"
8787 .cindex "header lines" "character sets"
8788 .cindex "header lines" "decoding"
8789 Substitute the contents of the named message header line, for example
8790 .code
8791 $header_reply-to:
8792 .endd
8793 The newline that terminates a header line is not included in the expansion, but
8794 internal newlines (caused by splitting the header line over several physical
8795 lines) may be present.
8796
8797 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
8798 the data in the header line is interpreted.
8799
8800 .ilist
8801 .cindex "white space" "in header lines"
8802 &%rheader%& gives the original &"raw"& content of the header line, with no
8803 processing at all, and without the removal of leading and trailing white space.
8804
8805 .next
8806 .cindex "base64 encoding" "in header lines"
8807 &%bheader%& removes leading and trailing white space, and then decodes base64
8808 or quoted-printable MIME &"words"& within the header text, but does no
8809 character set translation. If decoding of what looks superficially like a MIME
8810 &"word"& fails, the raw string is returned. If decoding
8811 .cindex "binary zero" "in header line"
8812 produces a binary zero character, it is replaced by a question mark &-- this is
8813 what Exim does for binary zeros that are actually received in header lines.
8814
8815 .next
8816 &%header%& tries to translate the string as decoded by &%bheader%& to a
8817 standard character set. This is an attempt to produce the same string as would
8818 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
8819 returned. Translation is attempted only on operating systems that support the
8820 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
8821 a system Makefile or in &_Local/Makefile_&.
8822 .endlist ilist
8823
8824 In a filter file, the target character set for &%header%& can be specified by a
8825 command of the following form:
8826 .code
8827 headers charset "UTF-8"
8828 .endd
8829 This command affects all references to &$h_$& (or &$header_$&) expansions in
8830 subsequently obeyed filter commands. In the absence of this command, the target
8831 character set in a filter is taken from the setting of the &%headers_charset%&
8832 option in the runtime configuration. The value of this option defaults to the
8833 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
8834 ISO-8859-1.
8835
8836 Header names follow the syntax of RFC 2822, which states that they may contain
8837 any printing characters except space and colon. Consequently, curly brackets
8838 &'do not'& terminate header names, and should not be used to enclose them as
8839 if they were variables. Attempting to do so causes a syntax error.
8840
8841 Only header lines that are common to all copies of a message are visible to
8842 this mechanism. These are the original header lines that are received with the
8843 message, and any that are added by an ACL statement or by a system
8844 filter. Header lines that are added to a particular copy of a message by a
8845 router or transport are not accessible.
8846
8847 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
8848 before the DATA ACL, because the header structure is not set up until the
8849 message is received. Header lines that are added in a RCPT ACL (for example)
8850 are saved until the message's incoming header lines are available, at which
8851 point they are added. When a DATA ACL is running, however, header lines added
8852 by earlier ACLs are visible.
8853
8854 Upper case and lower case letters are synonymous in header names. If the
8855 following character is white space, the terminating colon may be omitted, but
8856 this is not recommended, because you may then forget it when it is needed. When
8857 white space terminates the header name, it is included in the expanded string.
8858 If the message does not contain the given header, the expansion item is
8859 replaced by an empty string. (See the &%def%& condition in section
8860 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
8861
8862 If there is more than one header with the same name, they are all concatenated
8863 to form the substitution string, up to a maximum length of 64K. Unless
8864 &%rheader%& is being used, leading and trailing white space is removed from
8865 each header before concatenation, and a completely empty header is ignored. A
8866 newline character is then inserted between non-empty headers, but there is no
8867 newline at the very end. For the &%header%& and &%bheader%& expansion, for
8868 those headers that contain lists of addresses, a comma is also inserted at the
8869 junctions between headers. This does not happen for the &%rheader%& expansion.
8870
8871
8872 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
8873 .cindex "expansion" "hmac hashing"
8874 .cindex &%hmac%&
8875 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
8876 shared secret and some text into a message authentication code, as specified in
8877 RFC 2104. This differs from &`${md5:secret_text...}`& or
8878 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
8879 cryptographic hash, allowing for authentication that is not possible with MD5
8880 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
8881 present. For example:
8882 .code
8883 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
8884 .endd
8885 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
8886 produces:
8887 .code
8888 dd97e3ba5d1a61b5006108f8c8252953
8889 .endd
8890 As an example of how this might be used, you might put in the main part of
8891 an Exim configuration:
8892 .code
8893 SPAMSCAN_SECRET=cohgheeLei2thahw
8894 .endd
8895 In a router or a transport you could then have:
8896 .code
8897 headers_add = \
8898   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
8899   ${hmac{md5}{SPAMSCAN_SECRET}\
8900   {${primary_hostname},${message_exim_id},$h_message-id:}}
8901 .endd
8902 Then given a message, you can check where it was scanned by looking at the
8903 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
8904 this header line is authentic by recomputing the authentication code from the
8905 host name, message ID and the &'Message-id:'& header line. This can be done
8906 using Exim's &%-be%& option, or by other means, for example by using the
8907 &'hmac_md5_hex()'& function in Perl.
8908
8909
8910 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8911 .cindex "expansion" "conditional"
8912 .cindex "&%if%&, expansion item"
8913 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
8914 item; otherwise <&'string2'&> is used. The available conditions are described
8915 in section &<<SECTexpcond>>& below. For example:
8916 .code
8917 ${if eq {$local_part}{postmaster} {yes}{no} }
8918 .endd
8919 The second string need not be present; if it is not and the condition is not
8920 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
8921 be present instead of the second string (without any curly brackets). In this
8922 case, the expansion is forced to fail if the condition is not true (see section
8923 &<<SECTforexpfai>>&).
8924
8925 If both strings are omitted, the result is the string &`true`& if the condition
8926 is true, and the empty string if the condition is false. This makes it less
8927 cumbersome to write custom ACL and router conditions. For example, instead of
8928 .code
8929 condition = ${if >{$acl_m4}{3}{true}{false}}
8930 .endd
8931 you can use
8932 .code
8933 condition = ${if >{$acl_m4}{3}}
8934 .endd
8935
8936 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8937 .cindex "expansion" "string truncation"
8938 .cindex "&%length%& expansion item"
8939 The &%length%& item is used to extract the initial portion of a string. Both
8940 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
8941 you are using a fixed value for the number, that is, if <&'string1'&> does not
8942 change when expanded, you can use the simpler operator notation that avoids
8943 some of the braces:
8944 .code
8945 ${length_<n>:<string>}
8946 .endd
8947 The result of this item is either the first <&'n'&> characters or the whole
8948 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
8949 &%strlen%&, which gives the length of a string.
8950
8951
8952 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
8953         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
8954 This is the first of one of two different types of lookup item, which are both
8955 described in the next item.
8956
8957 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
8958         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
8959 .cindex "expansion" "lookup in"
8960 .cindex "file" "lookups"
8961 .cindex "lookup" "in expanded string"
8962 The two forms of lookup item specify data lookups in files and databases, as
8963 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
8964 lookups, and the second is used for query-style lookups. The <&'key'&>,
8965 <&'file'&>, and <&'query'&> strings are expanded before use.
8966
8967 If there is any white space in a lookup item which is part of a filter command,
8968 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
8969 other place where white space is significant, the lookup item must be enclosed
8970 in double quotes. The use of data lookups in users' filter files may be locked
8971 out by the system administrator.
8972
8973 .vindex "&$value$&"
8974 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
8975 During its expansion, the variable &$value$& contains the data returned by the
8976 lookup. Afterwards it reverts to the value it had previously (at the outer
8977 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
8978 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
8979 string on failure. If <&'string2'&> is provided, it can itself be a nested
8980 lookup, thus providing a mechanism for looking up a default value when the
8981 original lookup fails.
8982
8983 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
8984 data for the outer lookup while the parameters of the second lookup are
8985 expanded, and also while <&'string2'&> of the second lookup is expanded, should
8986 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
8987 appear, and in this case, if the lookup fails, the entire expansion is forced
8988 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
8989 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
8990 successful lookup, and nothing in the case of failure.
8991
8992 For single-key lookups, the string &"partial"& is permitted to precede the
8993 search type in order to do partial matching, and * or *@ may follow a search
8994 type to request default lookups if the key does not match (see sections
8995 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
8996
8997 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
8998 If a partial search is used, the variables &$1$& and &$2$& contain the wild
8999 and non-wild parts of the key during the expansion of the replacement text.
9000 They return to their previous values at the end of the lookup item.
9001
9002 This example looks up the postmaster alias in the conventional alias file:
9003 .code
9004 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9005 .endd
9006 This example uses NIS+ to look up the full name of the user corresponding to
9007 the local part of an address, forcing the expansion to fail if it is not found:
9008 .code
9009 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9010   {$value}fail}
9011 .endd
9012
9013
9014 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9015 .cindex "expansion" "list creation"
9016 .vindex "&$item$&"
9017 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9018 default, but the separator can be changed in the usual way. For each item
9019 in this list, its value is place in &$item$&, and then <&'string2'&> is
9020 expanded and added to the output as an item in a new list. The separator used
9021 for the output list is the same as the one used for the input, but a separator
9022 setting is not included in the output. For example:
9023 .code
9024 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9025 .endd
9026 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9027 value of &$item$& is restored to what it was before. See also the &*filter*&
9028 and &*reduce*& expansion items.
9029
9030 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9031 .cindex "expansion" "numeric hash"
9032 .cindex "hash function" "numeric"
9033 The three strings are expanded; the first two must yield numbers. Call them
9034 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9035 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9036 can use the simpler operator notation that avoids some of the braces:
9037 .code
9038 ${nhash_<n>_<m>:<string>}
9039 .endd
9040 The second number is optional (in both notations). If there is only one number,
9041 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9042 processed by a div/mod hash function that returns two numbers, separated by a
9043 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9044 example,
9045 .code
9046 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9047 .endd
9048 returns the string &"6/33"&.
9049
9050
9051
9052 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9053 .cindex "Perl" "use in expanded string"
9054 .cindex "expansion" "calling Perl from"
9055 This item is available only if Exim has been built to include an embedded Perl
9056 interpreter. The subroutine name and the arguments are first separately
9057 expanded, and then the Perl subroutine is called with those arguments. No
9058 additional arguments need be given; the maximum number permitted, including the
9059 name of the subroutine, is nine.
9060
9061 The return value of the subroutine is inserted into the expanded string, unless
9062 the return value is &%undef%&. In that case, the expansion fails in the same
9063 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9064 Whatever you return is evaluated in a scalar context. For example, if you
9065 return the name of a Perl vector, the return value is the size of the vector,
9066 not its contents.
9067
9068 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9069 with the error message that was passed to &%die%&. More details of the embedded
9070 Perl facility are given in chapter &<<CHAPperl>>&.
9071
9072 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9073 out the use of this expansion item in filter files.
9074
9075
9076 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9077 .cindex "&%prvs%& expansion item"
9078 The first argument is a complete email address and the second is secret
9079 keystring. The third argument, specifying a key number, is optional. If absent,
9080 it defaults to 0. The result of the expansion is a prvs-signed email address,
9081 to be typically used with the &%return_path%& option on an &(smtp)& transport
9082 as part of a bounce address tag validation (BATV) scheme. For more discussion
9083 and an example, see section &<<SECTverifyPRVS>>&.
9084
9085 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9086         {*&<&'string'&>&*}}*&"
9087 .cindex "&%prvscheck%& expansion item"
9088 This expansion item is the complement of the &%prvs%& item. It is used for
9089 checking prvs-signed addresses. If the expansion of the first argument does not
9090 yield a syntactically valid prvs-signed address, the whole item expands to the
9091 empty string. When the first argument does expand to a syntactically valid
9092 prvs-signed address, the second argument is expanded, with the prvs-decoded
9093 version of the address and the key number extracted from the address in the
9094 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9095
9096 These two variables can be used in the expansion of the second argument to
9097 retrieve the secret. The validity of the prvs-signed address is then checked
9098 against the secret. The result is stored in the variable &$prvscheck_result$&,
9099 which is empty for failure or &"1"& for success.
9100
9101 The third argument is optional; if it is missing, it defaults to an empty
9102 string. This argument is now expanded. If the result is an empty string, the
9103 result of the expansion is the decoded version of the address. This is the case
9104 whether or not the signature was valid. Otherwise, the result of the expansion
9105 is the expansion of the third argument.
9106
9107 All three variables can be used in the expansion of the third argument.
9108 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9109 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9110
9111 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9112 .cindex "expansion" "inserting an entire file"
9113 .cindex "file" "inserting into expansion"
9114 .cindex "&%readfile%& expansion item"
9115 The file name and end-of-line string are first expanded separately. The file is
9116 then read, and its contents replace the entire item. All newline characters in
9117 the file are replaced by the end-of-line string if it is present. Otherwise,
9118 newlines are left in the string.
9119 String expansion is not applied to the contents of the file. If you want this,
9120 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9121 the string expansion fails.
9122
9123 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9124 locks out the use of this expansion item in filter files.
9125
9126
9127
9128 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9129         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9130 .cindex "expansion" "inserting from a socket"
9131 .cindex "socket, use of in expansion"
9132 .cindex "&%readsocket%& expansion item"
9133 This item inserts data from a Unix domain or Internet socket into the expanded
9134 string. The minimal way of using it uses just two arguments, as in these
9135 examples:
9136 .code
9137 ${readsocket{/socket/name}{request string}}
9138 ${readsocket{inet:some.host:1234}{request string}}
9139 .endd
9140 For a Unix domain socket, the first substring must be the path to the socket.
9141 For an Internet socket, the first substring must contain &`inet:`& followed by
9142 a host name or IP address, followed by a colon and a port, which can be a
9143 number or the name of a TCP port in &_/etc/services_&. An IP address may
9144 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9145 example:
9146 .code
9147 ${readsocket{inet:[::1]:1234}{request string}}
9148 .endd
9149 Only a single host name may be given, but if looking it up yields more than
9150 one IP address, they are each tried in turn until a connection is made. For
9151 both kinds of socket, Exim makes a connection, writes the request string
9152 (unless it is an empty string) and reads from the socket until an end-of-file
9153 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9154 extend what can be done. Firstly, you can vary the timeout. For example:
9155 .code
9156 ${readsocket{/socket/name}{request string}{3s}}
9157 .endd
9158 A fourth argument allows you to change any newlines that are in the data
9159 that is read, in the same way as for &%readfile%& (see above). This example
9160 turns them into spaces:
9161 .code
9162 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9163 .endd
9164 As with all expansions, the substrings are expanded before the processing
9165 happens. Errors in these sub-expansions cause the expansion to fail. In
9166 addition, the following errors can occur:
9167
9168 .ilist
9169 Failure to create a socket file descriptor;
9170 .next
9171 Failure to connect the socket;
9172 .next
9173 Failure to write the request string;
9174 .next
9175 Timeout on reading from the socket.
9176 .endlist
9177
9178 By default, any of these errors causes the expansion to fail. However, if
9179 you supply a fifth substring, it is expanded and used when any of the above
9180 errors occurs. For example:
9181 .code
9182 ${readsocket{/socket/name}{request string}{3s}{\n}\
9183   {socket failure}}
9184 .endd
9185 You can test for the existence of a Unix domain socket by wrapping this
9186 expansion in &`${if exists`&, but there is a race condition between that test
9187 and the actual opening of the socket, so it is safer to use the fifth argument
9188 if you want to be absolutely sure of avoiding an expansion error for a
9189 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9190
9191 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9192 locks out the use of this expansion item in filter files.
9193
9194
9195 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9196 .cindex "expansion" "reducing a list to a scalar"
9197 .cindex "list" "reducing to a scalar"
9198 .vindex "&$value$&"
9199 .vindex "&$item$&"
9200 This operation reduces a list to a single, scalar string. After expansion,
9201 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9202 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9203 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9204 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9205 them. The result of that expansion is assigned to &$value$& before the next
9206 iteration. When the end of the list is reached, the final value of &$value$& is
9207 added to the expansion output. The &*reduce*& expansion item can be used in a
9208 number of ways. For example, to add up a list of numbers:
9209 .code
9210 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9211 .endd
9212 The result of that expansion would be &`6`&. The maximum of a list of numbers
9213 can be found:
9214 .code
9215 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9216 .endd
9217 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9218 restored to what they were before. See also the &*filter*& and &*map*&
9219 expansion items.
9220
9221 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9222 This item inserts &"raw"& header lines. It is described with the &%header%&
9223 expansion item above.
9224
9225 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9226         {*&<&'string2'&>&*}}*&"
9227 .cindex "expansion" "running a command"
9228 .cindex "&%run%& expansion item"
9229 The command and its arguments are first expanded separately, and then the
9230 command is run in a separate process, but under the same uid and gid. As in
9231 other command executions from Exim, a shell is not used by default. If you want
9232 a shell, you must explicitly code it.
9233
9234 The standard input for the command exists, but is empty. The standard output
9235 and standard error are set to the same file descriptor.
9236 .cindex "return code" "from &%run%& expansion"
9237 .vindex "&$value$&"
9238 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9239 and replaces the entire item; during this expansion, the standard output/error
9240 from the command is in the variable &$value$&. If the command fails,
9241 <&'string2'&>, if present, is expanded and used. Once again, during the
9242 expansion, the standard output/error from the command is in the variable
9243 &$value$&.
9244
9245 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9246 can be the word &"fail"& (not in braces) to force expansion failure if the
9247 command does not succeed. If both strings are omitted, the result is contents
9248 of the standard output/error on success, and nothing on failure.
9249
9250 .vindex "&$runrc$&"
9251 The return code from the command is put in the variable &$runrc$&, and this
9252 remains set afterwards, so in a filter file you can do things like this:
9253 .code
9254 if "${run{x y z}{}}$runrc" is 1 then ...
9255   elif $runrc is 2 then ...
9256   ...
9257 endif
9258 .endd
9259 If execution of the command fails (for example, the command does not exist),
9260 the return code is 127 &-- the same code that shells use for non-existent
9261 commands.
9262
9263 &*Warning*&: In a router or transport, you cannot assume the order in which
9264 option values are expanded, except for those preconditions whose order of
9265 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9266 by the expansion of one option, and use it in another.
9267
9268 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9269 out the use of this expansion item in filter files.
9270
9271
9272 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9273 .cindex "expansion" "string substitution"
9274 .cindex "&%sg%& expansion item"
9275 This item works like Perl's substitution operator (s) with the global (/g)
9276 option; hence its name. However, unlike the Perl equivalent, Exim does not
9277 modify the subject string; instead it returns the modified string for insertion
9278 into the overall expansion. The item takes three arguments: the subject string,
9279 a regular expression, and a substitution string. For example:
9280 .code
9281 ${sg{abcdefabcdef}{abc}{xyz}}
9282 .endd
9283 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9284 if any $ or \ characters are required in the regular expression or in the
9285 substitution string, they have to be escaped. For example:
9286 .code
9287 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9288 .endd
9289 yields &"defabc"&, and
9290 .code
9291 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9292 .endd
9293 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9294 the regular expression from string expansion.
9295
9296
9297
9298 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9299 .cindex "&%substr%& expansion item"
9300 .cindex "substring extraction"
9301 .cindex "expansion" "substring extraction"
9302 The three strings are expanded; the first two must yield numbers. Call them
9303 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9304 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9305 can use the simpler operator notation that avoids some of the braces:
9306 .code
9307 ${substr_<n>_<m>:<string>}
9308 .endd
9309 The second number is optional (in both notations).
9310 If it is absent in the simpler format, the preceding underscore must also be
9311 omitted.
9312
9313 The &%substr%& item can be used to extract more general substrings than
9314 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9315 length required. For example
9316 .code
9317 ${substr{3}{2}{$local_part}}
9318 .endd
9319 If the starting offset is greater than the string length the result is the
9320 null string; if the length plus starting offset is greater than the string
9321 length, the result is the right-hand part of the string, starting from the
9322 given offset. The first character in the string has offset zero.
9323
9324 The &%substr%& expansion item can take negative offset values to count
9325 from the right-hand end of its operand. The last character is offset -1, the
9326 second-last is offset -2, and so on. Thus, for example,
9327 .code
9328 ${substr{-5}{2}{1234567}}
9329 .endd
9330 yields &"34"&. If the absolute value of a negative offset is greater than the
9331 length of the string, the substring starts at the beginning of the string, and
9332 the length is reduced by the amount of overshoot. Thus, for example,
9333 .code
9334 ${substr{-5}{2}{12}}
9335 .endd
9336 yields an empty string, but
9337 .code
9338 ${substr{-3}{2}{12}}
9339 .endd
9340 yields &"1"&.
9341
9342 When the second number is omitted from &%substr%&, the remainder of the string
9343 is taken if the offset is positive. If it is negative, all characters in the
9344 string preceding the offset point are taken. For example, an offset of -1 and
9345 no length, as in these semantically identical examples:
9346 .code
9347 ${substr_-1:abcde}
9348 ${substr{-1}{abcde}}
9349 .endd
9350 yields all but the last character of the string, that is, &"abcd"&.
9351
9352
9353
9354 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9355         {*&<&'replacements'&>&*}}*&"
9356 .cindex "expansion" "character translation"
9357 .cindex "&%tr%& expansion item"
9358 This item does single-character translation on its subject string. The second
9359 argument is a list of characters to be translated in the subject string. Each
9360 matching character is replaced by the corresponding character from the
9361 replacement list. For example
9362 .code
9363 ${tr{abcdea}{ac}{13}}
9364 .endd
9365 yields &`1b3de1`&. If there are duplicates in the second character string, the
9366 last occurrence is used. If the third string is shorter than the second, its
9367 last character is replicated. However, if it is empty, no translation takes
9368 place.
9369 .endlist
9370
9371
9372
9373 .section "Expansion operators" "SECTexpop"
9374 .cindex "expansion" "operators"
9375 For expansion items that perform transformations on a single argument string,
9376 the &"operator"& notation is used because it is simpler and uses fewer braces.
9377 The substring is first expanded before the operation is applied to it. The
9378 following operations can be performed:
9379
9380 .vlist
9381 .vitem &*${address:*&<&'string'&>&*}*&
9382 .cindex "expansion" "RFC 2822 address handling"
9383 .cindex "&%address%& expansion item"
9384 The string is interpreted as an RFC 2822 address, as it might appear in a
9385 header line, and the effective address is extracted from it. If the string does
9386 not parse successfully, the result is empty.
9387
9388
9389 .vitem &*${addresses:*&<&'string'&>&*}*&
9390 .cindex "expansion" "RFC 2822 address handling"
9391 .cindex "&%addresses%& expansion item"
9392 The string (after expansion) is interpreted as a list of addresses in RFC
9393 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9394 operative address (&'local-part@domain'&) is extracted from each item, and the
9395 result of the expansion is a colon-separated list, with appropriate
9396 doubling of colons should any happen to be present in the email addresses.
9397 Syntactically invalid RFC2822 address items are omitted from the output.
9398
9399 It is possible to specify a character other than colon for the output
9400 separator by starting the string with > followed by the new separator
9401 character. For example:
9402 .code
9403 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9404 .endd
9405 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9406 expansion item, which extracts the working address from a single RFC2822
9407 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9408 processing lists.
9409
9410
9411 .vitem &*${base62:*&<&'digits'&>&*}*&
9412 .cindex "&%base62%& expansion item"
9413 .cindex "expansion" "conversion to base 62"
9414 The string must consist entirely of decimal digits. The number is converted to
9415 base 62 and output as a string of six characters, including leading zeros. In
9416 the few operating environments where Exim uses base 36 instead of base 62 for
9417 its message identifiers (because those systems do not have case-sensitive file
9418 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9419 be absolutely clear: this is &'not'& base64 encoding.
9420
9421 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9422 .cindex "&%base62d%& expansion item"
9423 .cindex "expansion" "conversion to base 62"
9424 The string must consist entirely of base-62 digits, or, in operating
9425 environments where Exim uses base 36 instead of base 62 for its message
9426 identifiers, base-36 digits. The number is converted to decimal and output as a
9427 string.
9428
9429 .vitem &*${domain:*&<&'string'&>&*}*&
9430 .cindex "domain" "extraction"
9431 .cindex "expansion" "domain extraction"
9432 The string is interpreted as an RFC 2822 address and the domain is extracted
9433 from it. If the string does not parse successfully, the result is empty.
9434
9435
9436 .vitem &*${escape:*&<&'string'&>&*}*&
9437 .cindex "expansion" "escaping non-printing characters"
9438 .cindex "&%escape%& expansion item"
9439 If the string contains any non-printing characters, they are converted to
9440 escape sequences starting with a backslash. Whether characters with the most
9441 significant bit set (so-called &"8-bit characters"&) count as printing or not
9442 is controlled by the &%print_topbitchars%& option.
9443
9444
9445 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9446 .cindex "expansion" "expression evaluation"
9447 .cindex "expansion" "arithmetic expression"
9448 .cindex "&%eval%& expansion item"
9449 These items supports simple arithmetic and bitwise logical operations in
9450 expansion strings. The string (after expansion) must be a conventional
9451 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9452 logical operators, and parentheses. All operations are carried out using
9453 integer arithmetic. The operator priorities are as follows (the same as in the
9454 C programming language):
9455 .table2 70pt 300pt
9456 .irow &'highest:'& "not (~), negate (-)"
9457 .irow ""   "multiply (*), divide (/), remainder (%)"
9458 .irow ""   "plus (+), minus (-)"
9459 .irow ""   "shift-left (<<), shift-right (>>)"
9460 .irow ""   "and (&&)"
9461 .irow ""   "xor (^)"
9462 .irow &'lowest:'&  "or (|)"
9463 .endtable
9464 Binary operators with the same priority are evaluated from left to right. White
9465 space is permitted before or after operators.
9466
9467 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9468 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9469 decimal, even if they start with a leading zero; hexadecimal numbers are not
9470 permitted. This can be useful when processing numbers extracted from dates or
9471 times, which often do have leading zeros.
9472
9473 A number may be followed by &"K"& or &"M"& to multiply it by 1024 or 1024*1024,
9474 respectively. Negative numbers are supported. The result of the computation is
9475 a decimal representation of the answer (without &"K"& or &"M"&). For example:
9476
9477 .display
9478 &`${eval:1+1}            `&  yields 2
9479 &`${eval:1+2*3}          `&  yields 7
9480 &`${eval:(1+2)*3}        `&  yields 9
9481 &`${eval:2+42%5}         `&  yields 4
9482 &`${eval:0xc&amp;5}          `&  yields 4
9483 &`${eval:0xc|5}          `&  yields 13
9484 &`${eval:0xc^5}          `&  yields 9
9485 &`${eval:0xc>>1}         `&  yields 6
9486 &`${eval:0xc<<1}         `&  yields 24
9487 &`${eval:~255&amp;0x1234}    `&  yields 4608
9488 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9489 .endd
9490
9491 As a more realistic example, in an ACL you might have
9492 .code
9493 deny   message = Too many bad recipients
9494        condition =                    \
9495          ${if and {                   \
9496            {>{$rcpt_count}{10}}       \
9497            {                          \
9498            <                          \
9499              {$recipients_count}      \
9500              {${eval:$rcpt_count/2}}  \
9501            }                          \
9502          }{yes}{no}}
9503 .endd
9504 The condition is true if there have been more than 10 RCPT commands and
9505 fewer than half of them have resulted in a valid recipient.
9506
9507
9508 .vitem &*${expand:*&<&'string'&>&*}*&
9509 .cindex "expansion" "re-expansion of substring"
9510 The &%expand%& operator causes a string to be expanded for a second time. For
9511 example,
9512 .code
9513 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9514 .endd
9515 first looks up a string in a file while expanding the operand for &%expand%&,
9516 and then re-expands what it has found.
9517
9518
9519 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9520 .cindex "Unicode"
9521 .cindex "UTF-8" "conversion from"
9522 .cindex "expansion" "UTF-8 conversion"
9523 .cindex "&%from_utf8%& expansion item"
9524 The world is slowly moving towards Unicode, although there are no standards for
9525 email yet. However, other applications (including some databases) are starting
9526 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9527 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9528 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9529 the result is an undefined sequence of bytes.
9530
9531 Unicode code points with values less than 256 are compatible with ASCII and
9532 ISO-8859-1 (also known as Latin-1).
9533 For example, character 169 is the copyright symbol in both cases, though the
9534 way it is encoded is different. In UTF-8, more than one byte is needed for
9535 characters with code values greater than 127, whereas ISO-8859-1 is a
9536 single-byte encoding (but thereby limited to 256 characters). This makes
9537 translation from UTF-8 to ISO-8859-1 straightforward.
9538
9539
9540 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9541 .cindex "hash function" "textual"
9542 .cindex "expansion" "textual hash"
9543 The &%hash%& operator is a simpler interface to the hashing function that can
9544 be used when the two parameters are fixed numbers (as opposed to strings that
9545 change when expanded). The effect is the same as
9546 .code
9547 ${hash{<n>}{<m>}{<string>}}
9548 .endd
9549 See the description of the general &%hash%& item above for details. The
9550 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9551
9552
9553
9554 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9555 .cindex "base64 encoding" "conversion from hex"
9556 .cindex "expansion" "hex to base64"
9557 .cindex "&%hex2b64%& expansion item"
9558 This operator converts a hex string into one that is base64 encoded. This can
9559 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9560
9561
9562 .vitem &*${lc:*&<&'string'&>&*}*&
9563 .cindex "case forcing in strings"
9564 .cindex "string" "case forcing"
9565 .cindex "lower casing"
9566 .cindex "expansion" "case forcing"
9567 .cindex "&%lc%& expansion item"
9568 This forces the letters in the string into lower-case, for example:
9569 .code
9570 ${lc:$local_part}
9571 .endd
9572
9573 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9574 .cindex "expansion" "string truncation"
9575 .cindex "&%length%& expansion item"
9576 The &%length%& operator is a simpler interface to the &%length%& function that
9577 can be used when the parameter is a fixed number (as opposed to a string that
9578 changes when expanded). The effect is the same as
9579 .code
9580 ${length{<number>}{<string>}}
9581 .endd
9582 See the description of the general &%length%& item above for details. Note that
9583 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9584 when &%length%& is used as an operator.
9585
9586
9587 .vitem &*${local_part:*&<&'string'&>&*}*&
9588 .cindex "expansion" "local part extraction"
9589 .cindex "&%local_part%& expansion item"
9590 The string is interpreted as an RFC 2822 address and the local part is
9591 extracted from it. If the string does not parse successfully, the result is
9592 empty.
9593
9594
9595 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9596 .cindex "masked IP address"
9597 .cindex "IP address" "masking"
9598 .cindex "CIDR notation"
9599 .cindex "expansion" "IP address masking"
9600 .cindex "&%mask%& expansion item"
9601 If the form of the string to be operated on is not an IP address followed by a
9602 slash and an integer (that is, a network address in CIDR notation), the
9603 expansion fails. Otherwise, this operator converts the IP address to binary,
9604 masks off the least significant bits according to the bit count, and converts
9605 the result back to text, with mask appended. For example,
9606 .code
9607 ${mask:10.111.131.206/28}
9608 .endd
9609 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9610 be mostly used for looking up masked addresses in files, the result for an IPv6
9611 address uses dots to separate components instead of colons, because colon
9612 terminates a key string in lsearch files. So, for example,
9613 .code
9614 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9615 .endd
9616 returns the string
9617 .code
9618 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9619 .endd
9620 Letters in IPv6 addresses are always output in lower case.
9621
9622
9623 .vitem &*${md5:*&<&'string'&>&*}*&
9624 .cindex "MD5 hash"
9625 .cindex "expansion" "MD5 hash"
9626 .cindex "&%md5%& expansion item"
9627 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9628 as a 32-digit hexadecimal number, in which any letters are in lower case.
9629
9630
9631 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9632 .cindex "expansion" "numeric hash"
9633 .cindex "hash function" "numeric"
9634 The &%nhash%& operator is a simpler interface to the numeric hashing function
9635 that can be used when the two parameters are fixed numbers (as opposed to
9636 strings that change when expanded). The effect is the same as
9637 .code
9638 ${nhash{<n>}{<m>}{<string>}}
9639 .endd
9640 See the description of the general &%nhash%& item above for details.
9641
9642
9643 .vitem &*${quote:*&<&'string'&>&*}*&
9644 .cindex "quoting" "in string expansions"
9645 .cindex "expansion" "quoting"
9646 .cindex "&%quote%& expansion item"
9647 The &%quote%& operator puts its argument into double quotes if it
9648 is an empty string or
9649 contains anything other than letters, digits, underscores, dots, and hyphens.
9650 Any occurrences of double quotes and backslashes are escaped with a backslash.
9651 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9652 respectively For example,
9653 .code
9654 ${quote:ab"*"cd}
9655 .endd
9656 becomes
9657 .code
9658 "ab\"*\"cd"
9659 .endd
9660 The place where this is useful is when the argument is a substitution from a
9661 variable or a message header.
9662
9663 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9664 .cindex "&%quote_local_part%& expansion item"
9665 This operator is like &%quote%&, except that it quotes the string only if
9666 required to do so by the rules of RFC 2822 for quoting local parts. For
9667 example, a plus sign would not cause quoting (but it would for &%quote%&).
9668 If you are creating a new email address from the contents of &$local_part$&
9669 (or any other unknown data), you should always use this operator.
9670
9671
9672 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9673 .cindex "quoting" "lookup-specific"
9674 This operator applies lookup-specific quoting rules to the string. Each
9675 query-style lookup type has its own quoting rules which are described with
9676 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9677 .code
9678 ${quote_ldap:two * two}
9679 .endd
9680 returns
9681 .code
9682 two%20%5C2A%20two
9683 .endd
9684 For single-key lookup types, no quoting is ever necessary and this operator
9685 yields an unchanged string.
9686
9687
9688 .vitem &*${randint:*&<&'n'&>&*}*&
9689 .cindex "random number"
9690 This operator returns a somewhat random number which is less than the
9691 supplied number and is at least 0.  The quality of this randomness depends
9692 on how Exim was built; the values are not suitable for keying material.
9693 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
9694 Otherwise, the implementation may be arc4random(), random() seeded by
9695 srandomdev() or srandom(), or a custom implementation even weaker than
9696 random().
9697
9698
9699 .new
9700 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
9701 .cindex "expansion" "IP address"
9702 This operator reverses an IP address; for IPv4 addresses, the result is in
9703 dotted-quad decimal form, while for IPv6 addreses the result is in
9704 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
9705 for DNS.  For example,
9706 .code
9707 ${reverse_ip:192.0.2.4} and ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.3}
9708 .endd
9709 returns
9710 .code
9711 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
9712 .endd
9713 .wen
9714
9715
9716 .vitem &*${rfc2047:*&<&'string'&>&*}*&
9717 .cindex "expansion" "RFC 2047"
9718 .cindex "RFC 2047" "expansion operator"
9719 .cindex "&%rfc2047%& expansion item"
9720 This operator encodes text according to the rules of RFC 2047. This is an
9721 encoding that is used in header lines to encode non-ASCII characters. It is
9722 assumed that the input string is in the encoding specified by the
9723 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
9724 contains only characters in the range 33&--126, and no instances of the
9725 characters
9726 .code
9727 ? = ( ) < > @ , ; : \ " . [ ] _
9728 .endd
9729 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
9730 string, using as many &"encoded words"& as necessary to encode all the
9731 characters.
9732
9733
9734 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
9735 .cindex "expansion" "RFC 2047"
9736 .cindex "RFC 2047" "decoding"
9737 .cindex "&%rfc2047d%& expansion item"
9738 This operator decodes strings that are encoded as per RFC 2047. Binary zero
9739 bytes are replaced by question marks. Characters are converted into the
9740 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
9741 not recognized unless &%check_rfc2047_length%& is set false.
9742
9743 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
9744 access a header line, RFC 2047 decoding is done automatically. You do not need
9745 to use this operator as well.
9746
9747
9748
9749 .vitem &*${rxquote:*&<&'string'&>&*}*&
9750 .cindex "quoting" "in regular expressions"
9751 .cindex "regular expressions" "quoting"
9752 .cindex "&%rxquote%& expansion item"
9753 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
9754 characters in its argument. This is useful when substituting the values of
9755 variables or headers inside regular expressions.
9756
9757
9758 .vitem &*${sha1:*&<&'string'&>&*}*&
9759 .cindex "SHA-1 hash"
9760 .cindex "expansion" "SHA-1 hashing"
9761 .cindex "&%sha2%& expansion item"
9762 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
9763 it as a 40-digit hexadecimal number, in which any letters are in upper case.
9764
9765
9766 .vitem &*${stat:*&<&'string'&>&*}*&
9767 .cindex "expansion" "statting a file"
9768 .cindex "file" "extracting characteristics"
9769 .cindex "&%stat%& expansion item"
9770 The string, after expansion, must be a file path. A call to the &[stat()]&
9771 function is made for this path. If &[stat()]& fails, an error occurs and the
9772 expansion fails. If it succeeds, the data from the stat replaces the item, as a
9773 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
9774 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
9775 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
9776 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
9777 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
9778 can extract individual fields using the &%extract%& expansion item.
9779
9780 The use of the &%stat%& expansion in users' filter files can be locked out by
9781 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
9782 systems for files larger than 2GB.
9783
9784 .vitem &*${str2b64:*&<&'string'&>&*}*&
9785 .cindex "expansion" "base64 encoding"
9786 .cindex "base64 encoding" "in string expansion"
9787 .cindex "&%str2b64%& expansion item"
9788 This operator converts a string into one that is base64 encoded.
9789
9790
9791
9792 .vitem &*${strlen:*&<&'string'&>&*}*&
9793 .cindex "expansion" "string length"
9794 .cindex "string" "length in expansion"
9795 .cindex "&%strlen%& expansion item"
9796 The item is replace by the length of the expanded string, expressed as a
9797 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
9798
9799
9800 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
9801 .cindex "&%substr%& expansion item"
9802 .cindex "substring extraction"
9803 .cindex "expansion" "substring expansion"
9804 The &%substr%& operator is a simpler interface to the &%substr%& function that
9805 can be used when the two parameters are fixed numbers (as opposed to strings
9806 that change when expanded). The effect is the same as
9807 .code
9808 ${substr{<start>}{<length>}{<string>}}
9809 .endd
9810 See the description of the general &%substr%& item above for details. The
9811 abbreviation &%s%& can be used when &%substr%& is used as an operator.
9812
9813 .vitem &*${time_eval:*&<&'string'&>&*}*&
9814 .cindex "&%time_eval%& expansion item"
9815 .cindex "time interval" "decoding"
9816 This item converts an Exim time interval such as &`2d4h5m`& into a number of
9817 seconds.
9818
9819 .vitem &*${time_interval:*&<&'string'&>&*}*&
9820 .cindex "&%time_interval%& expansion item"
9821 .cindex "time interval" "formatting"
9822 The argument (after sub-expansion) must be a sequence of decimal digits that
9823 represents an interval of time as a number of seconds. It is converted into a
9824 number of larger units and output in Exim's normal time format, for example,
9825 &`1w3d4h2m6s`&.
9826
9827 .vitem &*${uc:*&<&'string'&>&*}*&
9828 .cindex "case forcing in strings"
9829 .cindex "string" "case forcing"
9830 .cindex "upper casing"
9831 .cindex "expansion" "case forcing"
9832 .cindex "&%uc%& expansion item"
9833 This forces the letters in the string into upper-case.
9834 .endlist
9835
9836
9837
9838
9839
9840
9841 .section "Expansion conditions" "SECTexpcond"
9842 .scindex IIDexpcond "expansion" "conditions"
9843 The following conditions are available for testing by the &%${if%& construct
9844 while expanding strings:
9845
9846 .vlist
9847 .vitem &*!*&<&'condition'&>
9848 .cindex "expansion" "negating a condition"
9849 .cindex "negation" "in expansion condition"
9850 Preceding any condition with an exclamation mark negates the result of the
9851 condition.
9852
9853 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9854 .cindex "numeric comparison"
9855 .cindex "expansion" "numeric comparison"
9856 There are a number of symbolic operators for doing numeric comparisons. They
9857 are:
9858 .display
9859 &`=   `&   equal
9860 &`==  `&   equal
9861 &`>   `&   greater
9862 &`>=  `&   greater or equal
9863 &`<   `&   less
9864 &`<=  `&   less or equal
9865 .endd
9866 For example:
9867 .code
9868 ${if >{$message_size}{10M} ...
9869 .endd
9870 Note that the general negation operator provides for inequality testing. The
9871 two strings must take the form of optionally signed decimal integers,
9872 optionally followed by one of the letters &"K"& or &"M"& (in either upper or
9873 lower case), signifying multiplication by 1024 or 1024*1024, respectively.
9874 As a special case, the numerical value of an empty string is taken as
9875 zero.
9876
9877
9878 .new
9879 .vitem &*bool&~{*&<&'string'&>&*}*&
9880 .cindex "expansion" "boolean parsing"
9881 .cindex "&%bool%& expansion condition"
9882 This condition turns a string holding a true or false representation into
9883 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
9884 (case-insensitively); also positive integer numbers map to true if non-zero,
9885 false if zero.  Leading and trailing whitespace is ignored.
9886 All other string values will result in expansion failure.
9887
9888 When combined with ACL variables, this expansion condition will let you
9889 make decisions in one place and act on those decisions in another place.
9890 For example:
9891 .code
9892 ${if bool{$acl_m_privileged_sender} ...
9893 .endd
9894 .wen
9895
9896
9897 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
9898 .cindex "expansion" "boolean parsing"
9899 .cindex "&%bool_lax%& expansion condition"
9900 Like &%bool%&, this condition turns a string into a boolean state.  But
9901 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
9902 loose definition that the Router &%condition%& option uses.  The empty string
9903 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
9904 true.  Leading and trailing whitespace is ignored.
9905
9906 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
9907
9908 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9909 .cindex "expansion" "encrypted comparison"
9910 .cindex "encrypted strings, comparing"
9911 .cindex "&%crypteq%& expansion condition"
9912 This condition is included in the Exim binary if it is built to support any
9913 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
9914 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
9915 included in the binary.
9916
9917 The &%crypteq%& condition has two arguments. The first is encrypted and
9918 compared against the second, which is already encrypted. The second string may
9919 be in the LDAP form for storing encrypted strings, which starts with the
9920 encryption type in curly brackets, followed by the data. If the second string
9921 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
9922 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
9923 Typically this will be a field from a password file. An example of an encrypted
9924 string in LDAP form is:
9925 .code
9926 {md5}CY9rzUYh03PK3k6DJie09g==
9927 .endd
9928 If such a string appears directly in an expansion, the curly brackets have to
9929 be quoted, because they are part of the expansion syntax. For example:
9930 .code
9931 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
9932 .endd
9933 The following encryption types (whose names are matched case-independently) are
9934 supported:
9935
9936 .ilist
9937 .cindex "MD5 hash"
9938 .cindex "base64 encoding" "in encrypted password"
9939 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
9940 printable characters to compare with the remainder of the second string. If the
9941 length of the comparison string is 24, Exim assumes that it is base64 encoded
9942 (as in the above example). If the length is 32, Exim assumes that it is a
9943 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
9944 comparison fails.
9945
9946 .next
9947 .cindex "SHA-1 hash"
9948 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
9949 printable characters to compare with the remainder of the second string. If the
9950 length of the comparison string is 28, Exim assumes that it is base64 encoded.
9951 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
9952 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
9953
9954 .next
9955 .cindex "&[crypt()]&"
9956 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
9957 only the first eight characters of the password. However, in modern operating
9958 systems this is no longer true, and in many cases the entire password is used,
9959 whatever its length.
9960
9961 .next
9962 .cindex "&[crypt16()]&"
9963 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
9964 use up to 16 characters of the password in some operating systems. Again, in
9965 modern operating systems, more characters may be used.
9966 .endlist
9967 Exim has its own version of &[crypt16()]&, which is just a double call to
9968 &[crypt()]&. For operating systems that have their own version, setting
9969 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
9970 operating system version instead of its own. This option is set by default in
9971 the OS-dependent &_Makefile_& for those operating systems that are known to
9972 support &[crypt16()]&.
9973
9974 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
9975 it was not using the same algorithm as some operating systems' versions. It
9976 turns out that as well as &[crypt16()]& there is a function called
9977 &[bigcrypt()]& in some operating systems. This may or may not use the same
9978 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
9979
9980 However, since there is now a move away from the traditional &[crypt()]&
9981 functions towards using SHA1 and other algorithms, tidying up this area of
9982 Exim is seen as very low priority.
9983
9984 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
9985 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
9986 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
9987 default is &`{crypt}`&. Whatever the default, you can always use either
9988 function by specifying it explicitly in curly brackets.
9989
9990 .vitem &*def:*&<&'variable&~name'&>
9991 .cindex "expansion" "checking for empty variable"
9992 .cindex "&%def%& expansion condition"
9993 The &%def%& condition must be followed by the name of one of the expansion
9994 variables defined in section &<<SECTexpvar>>&. The condition is true if the
9995 variable does not contain the empty string. For example:
9996 .code
9997 ${if def:sender_ident {from $sender_ident}}
9998 .endd
9999 Note that the variable name is given without a leading &%$%& character. If the
10000 variable does not exist, the expansion fails.
10001
10002 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10003         &~&*def:h_*&<&'header&~name'&>&*:*&"
10004 .cindex "expansion" "checking header line existence"
10005 This condition is true if a message is being processed and the named header
10006 exists in the message. For example,
10007 .code
10008 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10009 .endd
10010 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10011 the header name must be terminated by a colon if white space does not follow.
10012
10013 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10014        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10015 .cindex "string" "comparison"
10016 .cindex "expansion" "string comparison"
10017 .cindex "&%eq%& expansion condition"
10018 .cindex "&%eqi%& expansion condition"
10019 The two substrings are first expanded. The condition is true if the two
10020 resulting strings are identical. For &%eq%& the comparison includes the case of
10021 letters, whereas for &%eqi%& the comparison is case-independent.
10022
10023 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10024 .cindex "expansion" "file existence test"
10025 .cindex "file" "existence test"
10026 .cindex "&%exists%&, expansion condition"
10027 The substring is first expanded and then interpreted as an absolute path. The
10028 condition is true if the named file (or directory) exists. The existence test
10029 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10030 users' filter files may be locked out by the system administrator.
10031
10032 .vitem &*first_delivery*&
10033 .cindex "delivery" "first"
10034 .cindex "first delivery"
10035 .cindex "expansion" "first delivery test"
10036 .cindex "&%first_delivery%& expansion condition"
10037 This condition, which has no data, is true during a message's first delivery
10038 attempt. It is false during any subsequent delivery attempts.
10039
10040
10041 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10042        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10043 .cindex "list" "iterative conditions"
10044 .cindex "expansion" "&*forall*& condition"
10045 .cindex "expansion" "&*forany*& condition"
10046 .vindex "&$item$&"
10047 These conditions iterate over a list. The first argument is expanded to form
10048 the list. By default, the list separator is a colon, but it can be changed by
10049 the normal method. The second argument is interpreted as a condition that is to
10050 be applied to each item in the list in turn. During the interpretation of the
10051 condition, the current list item is placed in a variable called &$item$&.
10052 .ilist
10053 For &*forany*&, interpretation stops if the condition is true for any item, and
10054 the result of the whole condition is true. If the condition is false for all
10055 items in the list, the overall condition is false.
10056 .next
10057 For &*forall*&, interpretation stops if the condition is false for any item,
10058 and the result of the whole condition is false. If the condition is true for
10059 all items in the list, the overall condition is true.
10060 .endlist
10061 Note that negation of &*forany*& means that the condition must be false for all
10062 items for the overall condition to succeed, and negation of &*forall*& means
10063 that the condition must be false for at least one item. In this example, the
10064 list separator is changed to a comma:
10065 .code
10066 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10067 .endd
10068 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10069 being processed, to enable these expansion items to be nested.
10070
10071
10072 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10073        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10074 .cindex "string" "comparison"
10075 .cindex "expansion" "string comparison"
10076 .cindex "&%ge%& expansion condition"
10077 .cindex "&%gei%& expansion condition"
10078 The two substrings are first expanded. The condition is true if the first
10079 string is lexically greater than or equal to the second string. For &%ge%& the
10080 comparison includes the case of letters, whereas for &%gei%& the comparison is
10081 case-independent.
10082
10083 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10084        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10085 .cindex "string" "comparison"
10086 .cindex "expansion" "string comparison"
10087 .cindex "&%gt%& expansion condition"
10088 .cindex "&%gti%& expansion condition"
10089 The two substrings are first expanded. The condition is true if the first
10090 string is lexically greater than the second string. For &%gt%& the comparison
10091 includes the case of letters, whereas for &%gti%& the comparison is
10092 case-independent.
10093
10094 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10095        &*isip4&~{*&<&'string'&>&*}*& &&&
10096        &*isip6&~{*&<&'string'&>&*}*&
10097 .cindex "IP address" "testing string format"
10098 .cindex "string" "testing for IP address"
10099 .cindex "&%isip%& expansion condition"
10100 .cindex "&%isip4%& expansion condition"
10101 .cindex "&%isip6%& expansion condition"
10102 The substring is first expanded, and then tested to see if it has the form of
10103 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10104 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10105
10106 For an IPv4 address, the test is for four dot-separated components, each of
10107 which consists of from one to three digits. For an IPv6 address, up to eight
10108 colon-separated components are permitted, each containing from one to four
10109 hexadecimal digits. There may be fewer than eight components if an empty
10110 component (adjacent colons) is present. Only one empty component is permitted.
10111
10112 &*Note*&: The checks are just on the form of the address; actual numerical
10113 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10114 check. The main use of these tests is to distinguish between IP addresses and
10115 host names, or between IPv4 and IPv6 addresses. For example, you could use
10116 .code
10117 ${if isip4{$sender_host_address}...
10118 .endd
10119 to test which IP version an incoming SMTP connection is using.
10120
10121 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10122 .cindex "LDAP" "use for authentication"
10123 .cindex "expansion" "LDAP authentication test"
10124 .cindex "&%ldapauth%& expansion condition"
10125 This condition supports user authentication using LDAP. See section
10126 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10127 queries. For this use, the query must contain a user name and password. The
10128 query itself is not used, and can be empty. The condition is true if the
10129 password is not empty, and the user name and password are accepted by the LDAP
10130 server. An empty password is rejected without calling LDAP because LDAP binds
10131 with an empty password are considered anonymous regardless of the username, and
10132 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10133 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10134 this can be used.
10135
10136
10137 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10138        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10139 .cindex "string" "comparison"
10140 .cindex "expansion" "string comparison"
10141 .cindex "&%le%& expansion condition"
10142 .cindex "&%lei%& expansion condition"
10143 The two substrings are first expanded. The condition is true if the first
10144 string is lexically less than or equal to the second string. For &%le%& the
10145 comparison includes the case of letters, whereas for &%lei%& the comparison is
10146 case-independent.
10147
10148 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10149        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10150 .cindex "string" "comparison"
10151 .cindex "expansion" "string comparison"
10152 .cindex "&%lt%& expansion condition"
10153 .cindex "&%lti%& expansion condition"
10154 The two substrings are first expanded. The condition is true if the first
10155 string is lexically less than the second string. For &%lt%& the comparison
10156 includes the case of letters, whereas for &%lti%& the comparison is
10157 case-independent.
10158
10159
10160 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10161 .cindex "expansion" "regular expression comparison"
10162 .cindex "regular expressions" "match in expanded string"
10163 .cindex "&%match%& expansion condition"
10164 The two substrings are first expanded. The second is then treated as a regular
10165 expression and applied to the first. Because of the pre-expansion, if the
10166 regular expression contains dollar, or backslash characters, they must be
10167 escaped. Care must also be taken if the regular expression contains braces
10168 (curly brackets). A closing brace must be escaped so that it is not taken as a
10169 premature termination of <&'string2'&>. The easiest approach is to use the
10170 &`\N`& feature to disable expansion of the regular expression.
10171 For example,
10172 .code
10173 ${if match {$local_part}{\N^\d{3}\N} ...
10174 .endd
10175 If the whole expansion string is in double quotes, further escaping of
10176 backslashes is also required.
10177
10178 The condition is true if the regular expression match succeeds.
10179 The regular expression is not required to begin with a circumflex
10180 metacharacter, but if there is no circumflex, the expression is not anchored,
10181 and it may match anywhere in the subject, not just at the start. If you want
10182 the pattern to match at the end of the subject, you must include the &`$`&
10183 metacharacter at an appropriate point.
10184
10185 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10186 At the start of an &%if%& expansion the values of the numeric variable
10187 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10188 succeeds causes them to be reset to the substrings of that condition and they
10189 will have these values during the expansion of the success string. At the end
10190 of the &%if%& expansion, the previous values are restored. After testing a
10191 combination of conditions using &%or%&, the subsequent values of the numeric
10192 variables are those of the condition that succeeded.
10193
10194 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10195 .cindex "&%match_address%& expansion condition"
10196 See &*match_local_part*&.
10197
10198 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10199 .cindex "&%match_domain%& expansion condition"
10200 See &*match_local_part*&.
10201
10202 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10203 .cindex "&%match_ip%& expansion condition"
10204 This condition matches an IP address to a list of IP address patterns. It must
10205 be followed by two argument strings. The first (after expansion) must be an IP
10206 address or an empty string. The second (after expansion) is a restricted host
10207 list that can match only an IP address, not a host name. For example:
10208 .code
10209 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10210 .endd
10211 The specific types of host list item that are permitted in the list are:
10212
10213 .ilist
10214 An IP address, optionally with a CIDR mask.
10215 .next
10216 A single asterisk, which matches any IP address.
10217 .next
10218 An empty item, which matches only if the IP address is empty. This could be
10219 useful for testing for a locally submitted message or one from specific hosts
10220 in a single test such as
10221 . ==== As this is a nested list, any displays it contains must be indented
10222 . ==== as otherwise they are too far to the left. This comment applies to
10223 . ==== the use of xmlto plus fop. There's no problem when formatting with
10224 . ==== sdop, with or without the extra indent.
10225 .code
10226   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10227 .endd
10228 where the first item in the list is the empty string.
10229 .next
10230 The item @[] matches any of the local host's interface addresses.
10231 .next
10232 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10233 even if &`net-`& is not specified. There is never any attempt to turn the IP
10234 address into a host name. The most common type of linear search for
10235 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10236 masks. For example:
10237 .code
10238   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10239 .endd
10240 It is of course possible to use other kinds of lookup, and in such a case, you
10241 do need to specify the &`net-`& prefix if you want to specify a specific
10242 address mask, for example:
10243 .code
10244   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10245 .endd
10246 However, unless you are combining a &%match_ip%& condition with others, it is
10247 just as easy to use the fact that a lookup is itself a condition, and write:
10248 .code
10249   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10250 .endd
10251 .endlist ilist
10252
10253 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10254
10255 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10256 .cindex "domain list" "in expansion condition"
10257 .cindex "address list" "in expansion condition"
10258 .cindex "local part" "list, in expansion condition"
10259 .cindex "&%match_local_part%& expansion condition"
10260 This condition, together with &%match_address%& and &%match_domain%&, make it
10261 possible to test domain, address, and local part lists within expansions. Each
10262 condition requires two arguments: an item and a list to match. A trivial
10263 example is:
10264 .code
10265 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10266 .endd
10267 In each case, the second argument may contain any of the allowable items for a
10268 list of the appropriate type. Also, because the second argument (after
10269 expansion) is a standard form of list, it is possible to refer to a named list.
10270 Thus, you can use conditions like this:
10271 .code
10272 ${if match_domain{$domain}{+local_domains}{...
10273 .endd
10274 .cindex "&`+caseful`&"
10275 For address lists, the matching starts off caselessly, but the &`+caseful`&
10276 item can be used, as in all address lists, to cause subsequent items to
10277 have their local parts matched casefully. Domains are always matched
10278 caselessly.
10279
10280 &*Note*&: Host lists are &'not'& supported in this way. This is because
10281 hosts have two identities: a name and an IP address, and it is not clear
10282 how to specify cleanly how such a test would work. However, IP addresses can be
10283 matched using &%match_ip%&.
10284
10285 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10286 .cindex "PAM authentication"
10287 .cindex "AUTH" "with PAM"
10288 .cindex "Solaris" "PAM support"
10289 .cindex "expansion" "PAM authentication test"
10290 .cindex "&%pam%& expansion condition"
10291 &'Pluggable Authentication Modules'&
10292 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10293 available in the latest releases of Solaris and in some GNU/Linux
10294 distributions. The Exim support, which is intended for use in conjunction with
10295 the SMTP AUTH command, is available only if Exim is compiled with
10296 .code
10297 SUPPORT_PAM=yes
10298 .endd
10299 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10300 in some releases of GNU/Linux &%-ldl%& is also needed.
10301
10302 The argument string is first expanded, and the result must be a
10303 colon-separated list of strings. Leading and trailing white space is ignored.
10304 The PAM module is initialized with the service name &"exim"& and the user name
10305 taken from the first item in the colon-separated data string (<&'string1'&>).
10306 The remaining items in the data string are passed over in response to requests
10307 from the authentication function. In the simple case there will only be one
10308 request, for a password, so the data consists of just two strings.
10309
10310 There can be problems if any of the strings are permitted to contain colon
10311 characters. In the usual way, these have to be doubled to avoid being taken as
10312 separators. If the data is being inserted from a variable, the &%sg%& expansion
10313 item can be used to double any existing colons. For example, the configuration
10314 of a LOGIN authenticator might contain this setting:
10315 .code
10316 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10317 .endd
10318 For a PLAIN authenticator you could use:
10319 .code
10320 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10321 .endd
10322 In some operating systems, PAM authentication can be done only from a process
10323 running as root. Since Exim is running as the Exim user when receiving
10324 messages, this means that PAM cannot be used directly in those systems.
10325 A patched version of the &'pam_unix'& module that comes with the
10326 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10327 The patched module allows one special uid/gid combination, in addition to root,
10328 to authenticate. If you build the patched module to allow the Exim user and
10329 group, PAM can then be used from an Exim authenticator.
10330
10331
10332 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10333 .cindex "&'pwcheck'& daemon"
10334 .cindex "Cyrus"
10335 .cindex "expansion" "&'pwcheck'& authentication test"
10336 .cindex "&%pwcheck%& expansion condition"
10337 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10338 This is one way of making it possible for passwords to be checked by a process
10339 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10340 deprecated. Its replacement is &'saslauthd'& (see below).
10341
10342 The pwcheck support is not included in Exim by default. You need to specify
10343 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10344 building Exim. For example:
10345 .code
10346 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10347 .endd
10348 You do not need to install the full Cyrus software suite in order to use
10349 the pwcheck daemon. You can compile and install just the daemon alone
10350 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10351 access to the &_/var/pwcheck_& directory.
10352
10353 The &%pwcheck%& condition takes one argument, which must be the user name and
10354 password, separated by a colon. For example, in a LOGIN authenticator
10355 configuration, you might have this:
10356 .code
10357 server_condition = ${if pwcheck{$auth1:$auth2}}
10358 .endd
10359 Again, for a PLAIN authenticator configuration, this would be:
10360 .code
10361 server_condition = ${if pwcheck{$auth2:$auth3}}
10362 .endd
10363 .vitem &*queue_running*&
10364 .cindex "queue runner" "detecting when delivering from"
10365 .cindex "expansion" "queue runner test"
10366 .cindex "&%queue_running%& expansion condition"
10367 This condition, which has no data, is true during delivery attempts that are
10368 initiated by queue runner processes, and false otherwise.
10369
10370
10371 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10372 .cindex "Radius"
10373 .cindex "expansion" "Radius authentication"
10374 .cindex "&%radius%& expansion condition"
10375 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10376 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10377 the Radius client configuration file in order to build Exim with Radius
10378 support.
10379
10380 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10381 library, using the original API. If you are using release 0.4.0 or later of
10382 this library, you need to set
10383 .code
10384 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10385 .endd
10386 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10387 &%libradius%& library that comes with FreeBSD. To do this, set
10388 .code
10389 RADIUS_LIB_TYPE=RADLIB
10390 .endd
10391 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10392 You may also have to supply a suitable setting in EXTRALIBS so that the
10393 Radius library can be found when Exim is linked.
10394
10395 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10396 Radius client library, which calls the Radius server. The condition is true if
10397 the authentication is successful. For example:
10398 .code
10399 server_condition = ${if radius{<arguments>}}
10400 .endd
10401
10402
10403 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10404         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10405 .cindex "&'saslauthd'& daemon"
10406 .cindex "Cyrus"
10407 .cindex "expansion" "&'saslauthd'& authentication test"
10408 .cindex "&%saslauthd%& expansion condition"
10409 This condition supports user authentication using the Cyrus &'saslauthd'&
10410 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10411 Using this daemon is one way of making it possible for passwords to be checked
10412 by a process that is not running as root.
10413
10414 The saslauthd support is not included in Exim by default. You need to specify
10415 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10416 building Exim. For example:
10417 .code
10418 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10419 .endd
10420 You do not need to install the full Cyrus software suite in order to use
10421 the saslauthd daemon. You can compile and install just the daemon alone
10422 from the Cyrus SASL library.
10423
10424 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10425 two are mandatory. For example:
10426 .code
10427 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10428 .endd
10429 The service and the realm are optional (which is why the arguments are enclosed
10430 in their own set of braces). For details of the meaning of the service and
10431 realm, and how to run the daemon, consult the Cyrus documentation.
10432 .endlist vlist
10433
10434
10435
10436 .section "Combining expansion conditions" "SECID84"
10437 .cindex "expansion" "combining conditions"
10438 Several conditions can be tested at once by combining them using the &%and%&
10439 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10440 conditions on their own, and precede their lists of sub-conditions. Each
10441 sub-condition must be enclosed in braces within the overall braces that contain
10442 the list. No repetition of &%if%& is used.
10443
10444
10445 .vlist
10446 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10447 .cindex "&""or""& expansion condition"
10448 .cindex "expansion" "&""or""& of conditions"
10449 The sub-conditions are evaluated from left to right. The condition is true if
10450 any one of the sub-conditions is true.
10451 For example,
10452 .code
10453 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10454 .endd
10455 When a true sub-condition is found, the following ones are parsed but not
10456 evaluated. If there are several &"match"& sub-conditions the values of the
10457 numeric variables afterwards are taken from the first one that succeeds.
10458
10459 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10460 .cindex "&""and""& expansion condition"
10461 .cindex "expansion" "&""and""& of conditions"
10462 The sub-conditions are evaluated from left to right. The condition is true if
10463 all of the sub-conditions are true. If there are several &"match"&
10464 sub-conditions, the values of the numeric variables afterwards are taken from
10465 the last one. When a false sub-condition is found, the following ones are
10466 parsed but not evaluated.
10467 .endlist
10468 .ecindex IIDexpcond
10469
10470
10471
10472
10473 .section "Expansion variables" "SECTexpvar"
10474 .cindex "expansion" "variables, list of"
10475 This section contains an alphabetical list of all the expansion variables. Some
10476 of them are available only when Exim is compiled with specific options such as
10477 support for TLS or the content scanning extension.
10478
10479 .vlist
10480 .vitem "&$0$&, &$1$&, etc"
10481 .cindex "numerical variables (&$1$& &$2$& etc)"
10482 When a &%match%& expansion condition succeeds, these variables contain the
10483 captured substrings identified by the regular expression during subsequent
10484 processing of the success string of the containing &%if%& expansion item.
10485 However, they do not retain their values afterwards; in fact, their previous
10486 values are restored at the end of processing an &%if%& item. The numerical
10487 variables may also be set externally by some other matching process which
10488 precedes the expansion of the string. For example, the commands available in
10489 Exim filter files include an &%if%& command with its own regular expression
10490 matching condition.
10491
10492 .vitem "&$acl_c...$&"
10493 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10494 can be given any name that starts with &$acl_c$& and is at least six characters
10495 long, but the sixth character must be either a digit or an underscore. For
10496 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10497 variables persist throughout the lifetime of an SMTP connection. They can be
10498 used to pass information between ACLs and between different invocations of the
10499 same ACL. When a message is received, the values of these variables are saved
10500 with the message, and can be accessed by filters, routers, and transports
10501 during subsequent delivery.
10502
10503 .vitem "&$acl_m...$&"
10504 These variables are like the &$acl_c...$& variables, except that their values
10505 are reset after a message has been received. Thus, if several messages are
10506 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10507 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10508 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10509 message is received, the values of these variables are saved with the message,
10510 and can be accessed by filters, routers, and transports during subsequent
10511 delivery.
10512
10513 .vitem &$acl_verify_message$&
10514 .vindex "&$acl_verify_message$&"
10515 After an address verification has failed, this variable contains the failure
10516 message. It retains its value for use in subsequent modifiers. The message can
10517 be preserved by coding like this:
10518 .code
10519 warn !verify = sender
10520      set acl_m0 = $acl_verify_message
10521 .endd
10522 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10523 &%log_message%& modifiers, to include information about the verification
10524 failure.
10525
10526 .vitem &$address_data$&
10527 .vindex "&$address_data$&"
10528 This variable is set by means of the &%address_data%& option in routers. The
10529 value then remains with the address while it is processed by subsequent routers
10530 and eventually a transport. If the transport is handling multiple addresses,
10531 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10532 for more details. &*Note*&: The contents of &$address_data$& are visible in
10533 user filter files.
10534
10535 If &$address_data$& is set when the routers are called from an ACL to verify
10536 a recipient address, the final value is still in the variable for subsequent
10537 conditions and modifiers of the ACL statement. If routing the address caused it
10538 to be redirected to just one address, the child address is also routed as part
10539 of the verification, and in this case the final value of &$address_data$& is
10540 from the child's routing.
10541
10542 If &$address_data$& is set when the routers are called from an ACL to verify a
10543 sender address, the final value is also preserved, but this time in
10544 &$sender_address_data$&, to distinguish it from data from a recipient
10545 address.
10546
10547 In both cases (recipient and sender verification), the value does not persist
10548 after the end of the current ACL statement. If you want to preserve
10549 these values for longer, you can save them in ACL variables.
10550
10551 .vitem &$address_file$&
10552 .vindex "&$address_file$&"
10553 When, as a result of aliasing, forwarding, or filtering, a message is directed
10554 to a specific file, this variable holds the name of the file when the transport
10555 is running. At other times, the variable is empty. For example, using the
10556 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10557 .code
10558 /home/r2d2/savemail
10559 .endd
10560 then when the &(address_file)& transport is running, &$address_file$&
10561 contains the text string &`/home/r2d2/savemail`&.
10562 .cindex "Sieve filter" "value of &$address_file$&"
10563 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10564 then up to the transport configuration to generate an appropriate absolute path
10565 to the relevant file.
10566
10567 .vitem &$address_pipe$&
10568 .vindex "&$address_pipe$&"
10569 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10570 this variable holds the pipe command when the transport is running.
10571
10572 .vitem "&$auth1$& &-- &$auth3$&"
10573 .vindex "&$auth1$&, &$auth2$&, etc"
10574 These variables are used in SMTP authenticators (see chapters
10575 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10576
10577 .vitem &$authenticated_id$&
10578 .cindex "authentication" "id"
10579 .vindex "&$authenticated_id$&"
10580 When a server successfully authenticates a client it may be configured to
10581 preserve some of the authentication information in the variable
10582 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10583 user/password authenticator configuration might preserve the user name for use
10584 in the routers. Note that this is not the same information that is saved in
10585 &$sender_host_authenticated$&.
10586 When a message is submitted locally (that is, not over a TCP connection)
10587 the value of &$authenticated_id$& is normally the login name of the calling
10588 process. However, a trusted user can override this by means of the &%-oMai%&
10589 command line option.
10590
10591
10592
10593
10594 .vitem &$authenticated_sender$&
10595 .cindex "sender" "authenticated"
10596 .cindex "authentication" "sender"
10597 .cindex "AUTH" "on MAIL command"
10598 .vindex "&$authenticated_sender$&"
10599 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10600 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10601 described in section &<<SECTauthparamail>>&. Unless the data is the string
10602 &"<>"&, it is set as the authenticated sender of the message, and the value is
10603 available during delivery in the &$authenticated_sender$& variable. If the
10604 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10605
10606 .vindex "&$qualify_domain$&"
10607 When a message is submitted locally (that is, not over a TCP connection), the
10608 value of &$authenticated_sender$& is an address constructed from the login
10609 name of the calling process and &$qualify_domain$&, except that a trusted user
10610 can override this by means of the &%-oMas%& command line option.
10611
10612
10613 .vitem &$authentication_failed$&
10614 .cindex "authentication" "failure"
10615 .vindex "&$authentication_failed$&"
10616 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10617 command that does not succeed. Otherwise it is set to &"0"&. This makes it
10618 possible to distinguish between &"did not try to authenticate"&
10619 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
10620 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
10621 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
10622 negative response to an AUTH command, including (for example) an attempt to use
10623 an undefined mechanism.
10624
10625 .vitem &$body_linecount$&
10626 .cindex "message body" "line count"
10627 .cindex "body of message" "line count"
10628 .vindex "&$body_linecount$&"
10629 When a message is being received or delivered, this variable contains the
10630 number of lines in the message's body. See also &$message_linecount$&.
10631
10632 .vitem &$body_zerocount$&
10633 .cindex "message body" "binary zero count"
10634 .cindex "body of message" "binary zero count"
10635 .cindex "binary zero" "in message body"
10636 .vindex "&$body_zerocount$&"
10637 When a message is being received or delivered, this variable contains the
10638 number of binary zero bytes in the message's body.
10639
10640 .vitem &$bounce_recipient$&
10641 .vindex "&$bounce_recipient$&"
10642 This is set to the recipient address of a bounce message while Exim is creating
10643 it. It is useful if a customized bounce message text file is in use (see
10644 chapter &<<CHAPemsgcust>>&).
10645
10646 .vitem &$bounce_return_size_limit$&
10647 .vindex "&$bounce_return_size_limit$&"
10648 This contains the value set in the &%bounce_return_size_limit%& option, rounded
10649 up to a multiple of 1000. It is useful when a customized error message text
10650 file is in use (see chapter &<<CHAPemsgcust>>&).
10651
10652 .vitem &$caller_gid$&
10653 .cindex "gid (group id)" "caller"
10654 .vindex "&$caller_gid$&"
10655 The real group id under which the process that called Exim was running. This is
10656 not the same as the group id of the originator of a message (see
10657 &$originator_gid$&). If Exim re-execs itself, this variable in the new
10658 incarnation normally contains the Exim gid.
10659
10660 .vitem &$caller_uid$&
10661 .cindex "uid (user id)" "caller"
10662 .vindex "&$caller_uid$&"
10663 The real user id under which the process that called Exim was running. This is
10664 not the same as the user id of the originator of a message (see
10665 &$originator_uid$&). If Exim re-execs itself, this variable in the new
10666 incarnation normally contains the Exim uid.
10667
10668 .vitem &$compile_date$&
10669 .vindex "&$compile_date$&"
10670 The date on which the Exim binary was compiled.
10671
10672 .vitem &$compile_number$&
10673 .vindex "&$compile_number$&"
10674 The building process for Exim keeps a count of the number
10675 of times it has been compiled. This serves to distinguish different
10676 compilations of the same version of the program.
10677
10678 .vitem &$demime_errorlevel$&
10679 .vindex "&$demime_errorlevel$&"
10680 This variable is available when Exim is compiled with
10681 the content-scanning extension and the obsolete &%demime%& condition. For
10682 details, see section &<<SECTdemimecond>>&.
10683
10684 .vitem &$demime_reason$&
10685 .vindex "&$demime_reason$&"
10686 This variable is available when Exim is compiled with the
10687 content-scanning extension and the obsolete &%demime%& condition. For details,
10688 see section &<<SECTdemimecond>>&.
10689
10690 .vitem &$dnslist_domain$& &&&
10691        &$dnslist_matched$& &&&
10692        &$dnslist_text$& &&&
10693        &$dnslist_value$&
10694 .vindex "&$dnslist_domain$&"
10695 .vindex "&$dnslist_matched$&"
10696 .vindex "&$dnslist_text$&"
10697 .vindex "&$dnslist_value$&"
10698 .cindex "black list (DNS)"
10699 When a DNS (black) list lookup succeeds, these variables are set to contain
10700 the following data from the lookup: the list's domain name, the key that was
10701 looked up, the contents of any associated TXT record, and the value from the
10702 main A record. See section &<<SECID204>>& for more details.
10703
10704 .vitem &$domain$&
10705 .vindex "&$domain$&"
10706 When an address is being routed, or delivered on its own, this variable
10707 contains the domain. Uppercase letters in the domain are converted into lower
10708 case for &$domain$&.
10709
10710 Global address rewriting happens when a message is received, so the value of
10711 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
10712 is set during user filtering, but not during system filtering, because a
10713 message may have many recipients and the system filter is called just once.
10714
10715 When more than one address is being delivered at once (for example, several
10716 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
10717 have the same domain. Transports can be restricted to handling only one domain
10718 at a time if the value of &$domain$& is required at transport time &-- this is
10719 the default for local transports. For further details of the environment in
10720 which local transports are run, see chapter &<<CHAPenvironment>>&.
10721
10722 .oindex "&%delay_warning_condition%&"
10723 At the end of a delivery, if all deferred addresses have the same domain, it is
10724 set in &$domain$& during the expansion of &%delay_warning_condition%&.
10725
10726 The &$domain$& variable is also used in some other circumstances:
10727
10728 .ilist
10729 When an ACL is running for a RCPT command, &$domain$& contains the domain of
10730 the recipient address. The domain of the &'sender'& address is in
10731 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
10732 normally set during the running of the MAIL ACL. However, if the sender address
10733 is verified with a callout during the MAIL ACL, the sender domain is placed in
10734 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
10735 the &(smtp)& transport.
10736
10737 .next
10738 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10739 &$domain$& contains the domain portion of the address that is being rewritten;
10740 it can be used in the expansion of the replacement address, for example, to
10741 rewrite domains by file lookup.
10742
10743 .next
10744 With one important exception, whenever a domain list is being scanned,
10745 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
10746 a &%sender_domains%& condition in an ACL is being processed, the subject domain
10747 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
10748 that, in a RCPT ACL, the sender domain list can be dependent on the
10749 recipient domain (which is what is in &$domain$& at this time).
10750
10751 .next
10752 .cindex "ETRN" "value of &$domain$&"
10753 .oindex "&%smtp_etrn_command%&"
10754 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
10755 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
10756 .endlist
10757
10758
10759 .vitem &$domain_data$&
10760 .vindex "&$domain_data$&"
10761 When the &%domains%& option on a router matches a domain by
10762 means of a lookup, the data read by the lookup is available during the running
10763 of the router as &$domain_data$&. In addition, if the driver routes the
10764 address to a transport, the value is available in that transport. If the
10765 transport is handling multiple addresses, the value from the first address is
10766 used.
10767
10768 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
10769 domain by means of a lookup. The data read by the lookup is available during
10770 the rest of the ACL statement. In all other situations, this variable expands
10771 to nothing.
10772
10773 .vitem &$exim_gid$&
10774 .vindex "&$exim_gid$&"
10775 This variable contains the numerical value of the Exim group id.
10776
10777 .vitem &$exim_path$&
10778 .vindex "&$exim_path$&"
10779 This variable contains the path to the Exim binary.
10780
10781 .vitem &$exim_uid$&
10782 .vindex "&$exim_uid$&"
10783 This variable contains the numerical value of the Exim user id.
10784
10785 .vitem &$found_extension$&
10786 .vindex "&$found_extension$&"
10787 This variable is available when Exim is compiled with the
10788 content-scanning extension and the obsolete &%demime%& condition. For details,
10789 see section &<<SECTdemimecond>>&.
10790
10791 .vitem &$header_$&<&'name'&>
10792 This is not strictly an expansion variable. It is expansion syntax for
10793 inserting the message header line with the given name. Note that the name must
10794 be terminated by colon or white space, because it may contain a wide variety of
10795 characters. Note also that braces must &'not'& be used.
10796
10797 .vitem &$home$&
10798 .vindex "&$home$&"
10799 When the &%check_local_user%& option is set for a router, the user's home
10800 directory is placed in &$home$& when the check succeeds. In particular, this
10801 means it is set during the running of users' filter files. A router may also
10802 explicitly set a home directory for use by a transport; this can be overridden
10803 by a setting on the transport itself.
10804
10805 When running a filter test via the &%-bf%& option, &$home$& is set to the value
10806 of the environment variable HOME.
10807
10808 .vitem &$host$&
10809 .vindex "&$host$&"
10810 If a router assigns an address to a transport (any transport), and passes a
10811 list of hosts with the address, the value of &$host$& when the transport starts
10812 to run is the name of the first host on the list. Note that this applies both
10813 to local and remote transports.
10814
10815 .cindex "transport" "filter"
10816 .cindex "filter" "transport filter"
10817 For the &(smtp)& transport, if there is more than one host, the value of
10818 &$host$& changes as the transport works its way through the list. In
10819 particular, when the &(smtp)& transport is expanding its options for encryption
10820 using TLS, or for specifying a transport filter (see chapter
10821 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
10822 is connected.
10823
10824 When used in the client part of an authenticator configuration (see chapter
10825 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
10826 client is connected.
10827
10828
10829 .vitem &$host_address$&
10830 .vindex "&$host_address$&"
10831 This variable is set to the remote host's IP address whenever &$host$& is set
10832 for a remote connection. It is also set to the IP address that is being checked
10833 when the &%ignore_target_hosts%& option is being processed.
10834
10835 .vitem &$host_data$&
10836 .vindex "&$host_data$&"
10837 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
10838 result of the lookup is made available in the &$host_data$& variable. This
10839 allows you, for example, to do things like this:
10840 .code
10841 deny  hosts = net-lsearch;/some/file
10842 message = $host_data
10843 .endd
10844 .vitem &$host_lookup_deferred$&
10845 .cindex "host name" "lookup, failure of"
10846 .vindex "&$host_lookup_deferred$&"
10847 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
10848 message comes from a remote host and there is an attempt to look up the host's
10849 name from its IP address, and the attempt is not successful, one of these
10850 variables is set to &"1"&.
10851
10852 .ilist
10853 If the lookup receives a definite negative response (for example, a DNS lookup
10854 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
10855
10856 .next
10857 If there is any kind of problem during the lookup, such that Exim cannot
10858 tell whether or not the host name is defined (for example, a timeout for a DNS
10859 lookup), &$host_lookup_deferred$& is set to &"1"&.
10860 .endlist ilist
10861
10862 Looking up a host's name from its IP address consists of more than just a
10863 single reverse lookup. Exim checks that a forward lookup of at least one of the
10864 names it receives from a reverse lookup yields the original IP address. If this
10865 is not the case, Exim does not accept the looked up name(s), and
10866 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
10867 IP address (for example, the existence of a PTR record in the DNS) is not
10868 sufficient on its own for the success of a host name lookup. If the reverse
10869 lookup succeeds, but there is a lookup problem such as a timeout when checking
10870 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
10871 &"1"&. See also &$sender_host_name$&.
10872
10873 .vitem &$host_lookup_failed$&
10874 .vindex "&$host_lookup_failed$&"
10875 See &$host_lookup_deferred$&.
10876
10877
10878 .vitem &$inode$&
10879 .vindex "&$inode$&"
10880 The only time this variable is set is while expanding the &%directory_file%&
10881 option in the &(appendfile)& transport. The variable contains the inode number
10882 of the temporary file which is about to be renamed. It can be used to construct
10883 a unique name for the file.
10884
10885 .vitem &$interface_address$&
10886 .vindex "&$interface_address$&"
10887 This is an obsolete name for &$received_ip_address$&.
10888
10889 .vitem &$interface_port$&
10890 .vindex "&$interface_port$&"
10891 This is an obsolete name for &$received_port$&.
10892
10893 .vitem &$item$&
10894 .vindex "&$item$&"
10895 This variable is used during the expansion of &*forall*& and &*forany*&
10896 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
10897 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
10898 empty.
10899
10900 .vitem &$ldap_dn$&
10901 .vindex "&$ldap_dn$&"
10902 This variable, which is available only when Exim is compiled with LDAP support,
10903 contains the DN from the last entry in the most recently successful LDAP
10904 lookup.
10905
10906 .vitem &$load_average$&
10907 .vindex "&$load_average$&"
10908 This variable contains the system load average, multiplied by 1000 so that it
10909 is an integer. For example, if the load average is 0.21, the value of the
10910 variable is 210. The value is recomputed every time the variable is referenced.
10911
10912 .vitem &$local_part$&
10913 .vindex "&$local_part$&"
10914 When an address is being routed, or delivered on its own, this
10915 variable contains the local part. When a number of addresses are being
10916 delivered together (for example, multiple RCPT commands in an SMTP
10917 session), &$local_part$& is not set.
10918
10919 Global address rewriting happens when a message is received, so the value of
10920 &$local_part$& during routing and delivery is the value after rewriting.
10921 &$local_part$& is set during user filtering, but not during system filtering,
10922 because a message may have many recipients and the system filter is called just
10923 once.
10924
10925 .vindex "&$local_part_prefix$&"
10926 .vindex "&$local_part_suffix$&"
10927 If a local part prefix or suffix has been recognized, it is not included in the
10928 value of &$local_part$& during routing and subsequent delivery. The values of
10929 any prefix or suffix are in &$local_part_prefix$& and
10930 &$local_part_suffix$&, respectively.
10931
10932 When a message is being delivered to a file, pipe, or autoreply transport as a
10933 result of aliasing or forwarding, &$local_part$& is set to the local part of
10934 the parent address, not to the file name or command (see &$address_file$& and
10935 &$address_pipe$&).
10936
10937 When an ACL is running for a RCPT command, &$local_part$& contains the
10938 local part of the recipient address.
10939
10940 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10941 &$local_part$& contains the local part of the address that is being rewritten;
10942 it can be used in the expansion of the replacement address, for example.
10943
10944 In all cases, all quoting is removed from the local part. For example, for both
10945 the addresses
10946 .code
10947 "abc:xyz"@test.example
10948 abc\:xyz@test.example
10949 .endd
10950 the value of &$local_part$& is
10951 .code
10952 abc:xyz
10953 .endd
10954 If you use &$local_part$& to create another address, you should always wrap it
10955 inside a quoting operator. For example, in a &(redirect)& router you could
10956 have:
10957 .code
10958 data = ${quote_local_part:$local_part}@new.domain.example
10959 .endd
10960 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
10961 to process local parts in a case-dependent manner in a router, you can set the
10962 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
10963
10964 .vitem &$local_part_data$&
10965 .vindex "&$local_part_data$&"
10966 When the &%local_parts%& option on a router matches a local part by means of a
10967 lookup, the data read by the lookup is available during the running of the
10968 router as &$local_part_data$&. In addition, if the driver routes the address
10969 to a transport, the value is available in that transport. If the transport is
10970 handling multiple addresses, the value from the first address is used.
10971
10972 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
10973 matches a local part by means of a lookup. The data read by the lookup is
10974 available during the rest of the ACL statement. In all other situations, this
10975 variable expands to nothing.
10976
10977 .vitem &$local_part_prefix$&
10978 .vindex "&$local_part_prefix$&"
10979 When an address is being routed or delivered, and a
10980 specific prefix for the local part was recognized, it is available in this
10981 variable, having been removed from &$local_part$&.
10982
10983 .vitem &$local_part_suffix$&
10984 .vindex "&$local_part_suffix$&"
10985 When an address is being routed or delivered, and a
10986 specific suffix for the local part was recognized, it is available in this
10987 variable, having been removed from &$local_part$&.
10988
10989 .vitem &$local_scan_data$&
10990 .vindex "&$local_scan_data$&"
10991 This variable contains the text returned by the &[local_scan()]& function when
10992 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
10993
10994 .vitem &$local_user_gid$&
10995 .vindex "&$local_user_gid$&"
10996 See &$local_user_uid$&.
10997
10998 .vitem &$local_user_uid$&
10999 .vindex "&$local_user_uid$&"
11000 This variable and &$local_user_gid$& are set to the uid and gid after the
11001 &%check_local_user%& router precondition succeeds. This means that their values
11002 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11003 and &%condition%&), for the &%address_data%& expansion, and for any
11004 router-specific expansions. At all other times, the values in these variables
11005 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11006
11007 .vitem &$localhost_number$&
11008 .vindex "&$localhost_number$&"
11009 This contains the expanded value of the
11010 &%localhost_number%& option. The expansion happens after the main options have
11011 been read.
11012
11013 .vitem &$log_inodes$&
11014 .vindex "&$log_inodes$&"
11015 The number of free inodes in the disk partition where Exim's
11016 log files are being written. The value is recalculated whenever the variable is
11017 referenced. If the relevant file system does not have the concept of inodes,
11018 the value of is -1. See also the &%check_log_inodes%& option.
11019
11020 .vitem &$log_space$&
11021 .vindex "&$log_space$&"
11022 The amount of free space (as a number of kilobytes) in the disk
11023 partition where Exim's log files are being written. The value is recalculated
11024 whenever the variable is referenced. If the operating system does not have the
11025 ability to find the amount of free space (only true for experimental systems),
11026 the space value is -1. See also the &%check_log_space%& option.
11027
11028
11029 .vitem &$mailstore_basename$&
11030 .vindex "&$mailstore_basename$&"
11031 This variable is set only when doing deliveries in &"mailstore"& format in the
11032 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11033 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11034 contains the basename of the files that are being written, that is, the name
11035 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11036 variable is empty.
11037
11038 .vitem &$malware_name$&
11039 .vindex "&$malware_name$&"
11040 This variable is available when Exim is compiled with the
11041 content-scanning extension. It is set to the name of the virus that was found
11042 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11043
11044 .vitem &$max_received_linelength$&
11045 .vindex "&$max_received_linelength$&"
11046 .cindex "maximum" "line length"
11047 .cindex "line length" "maximum"
11048 This variable contains the number of bytes in the longest line that was
11049 received as part of the message, not counting the line termination
11050 character(s).
11051
11052 .vitem &$message_age$&
11053 .cindex "message" "age of"
11054 .vindex "&$message_age$&"
11055 This variable is set at the start of a delivery attempt to contain the number
11056 of seconds since the message was received. It does not change during a single
11057 delivery attempt.
11058
11059 .vitem &$message_body$&
11060 .cindex "body of message" "expansion variable"
11061 .cindex "message body" "in expansion"
11062 .cindex "binary zero" "in message body"
11063 .vindex "&$message_body$&"
11064 .oindex "&%message_body_visible%&"
11065 This variable contains the initial portion of a message's body while it is
11066 being delivered, and is intended mainly for use in filter files. The maximum
11067 number of characters of the body that are put into the variable is set by the
11068 &%message_body_visible%& configuration option; the default is 500.
11069
11070 .oindex "&%message_body_newlines%&"
11071 By default, newlines are converted into spaces in &$message_body$&, to make it
11072 easier to search for phrases that might be split over a line break. However,
11073 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11074 zeros are always converted into spaces.
11075
11076 .vitem &$message_body_end$&
11077 .cindex "body of message" "expansion variable"
11078 .cindex "message body" "in expansion"
11079 .vindex "&$message_body_end$&"
11080 This variable contains the final portion of a message's
11081 body while it is being delivered. The format and maximum size are as for
11082 &$message_body$&.
11083
11084 .vitem &$message_body_size$&
11085 .cindex "body of message" "size"
11086 .cindex "message body" "size"
11087 .vindex "&$message_body_size$&"
11088 When a message is being delivered, this variable contains the size of the body
11089 in bytes. The count starts from the character after the blank line that
11090 separates the body from the header. Newlines are included in the count. See
11091 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11092
11093 .vitem &$message_exim_id$&
11094 .vindex "&$message_exim_id$&"
11095 When a message is being received or delivered, this variable contains the
11096 unique message id that is generated and used by Exim to identify the message.
11097 An id is not created for a message until after its header has been successfully
11098 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11099 line; it is the local id that Exim assigns to the message, for example:
11100 &`1BXTIK-0001yO-VA`&.
11101
11102 .vitem &$message_headers$&
11103 .vindex &$message_headers$&
11104 This variable contains a concatenation of all the header lines when a message
11105 is being processed, except for lines added by routers or transports. The header
11106 lines are separated by newline characters. Their contents are decoded in the
11107 same way as a header line that is inserted by &%bheader%&.
11108
11109 .vitem &$message_headers_raw$&
11110 .vindex &$message_headers_raw$&
11111 This variable is like &$message_headers$& except that no processing of the
11112 contents of header lines is done.
11113
11114 .vitem &$message_id$&
11115 This is an old name for &$message_exim_id$&, which is now deprecated.
11116
11117 .vitem &$message_linecount$&
11118 .vindex "&$message_linecount$&"
11119 This variable contains the total number of lines in the header and body of the
11120 message. Compare &$body_linecount$&, which is the count for the body only.
11121 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11122 number of lines received. Before delivery happens (that is, before filters,
11123 routers, and transports run) the count is increased to include the
11124 &'Received:'& header line that Exim standardly adds, and also any other header
11125 lines that are added by ACLs. The blank line that separates the message header
11126 from the body is not counted. Here is an example of the use of this variable in
11127 a DATA ACL:
11128 .code
11129 deny message   = Too many lines in message header
11130      condition = \
11131       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11132 .endd
11133 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11134 message has not yet been received.
11135
11136 .vitem &$message_size$&
11137 .cindex "size" "of message"
11138 .cindex "message" "size"
11139 .vindex "&$message_size$&"
11140 When a message is being processed, this variable contains its size in bytes. In
11141 most cases, the size includes those headers that were received with the
11142 message, but not those (such as &'Envelope-to:'&) that are added to individual
11143 deliveries as they are written. However, there is one special case: during the
11144 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11145 doing a delivery in maildir format, the value of &$message_size$& is the
11146 precise size of the file that has been written. See also
11147 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11148
11149 .cindex "RCPT" "value of &$message_size$&"
11150 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11151 contains the size supplied on the MAIL command, or -1 if no size was given. The
11152 value may not, of course, be truthful.
11153
11154 .vitem &$mime_$&&'xxx'&
11155 A number of variables whose names start with &$mime$& are
11156 available when Exim is compiled with the content-scanning extension. For
11157 details, see section &<<SECTscanmimepart>>&.
11158
11159 .vitem "&$n0$& &-- &$n9$&"
11160 These variables are counters that can be incremented by means
11161 of the &%add%& command in filter files.
11162
11163 .vitem &$original_domain$&
11164 .vindex "&$domain$&"
11165 .vindex "&$original_domain$&"
11166 When a top-level address is being processed for delivery, this contains the
11167 same value as &$domain$&. However, if a &"child"& address (for example,
11168 generated by an alias, forward, or filter file) is being processed, this
11169 variable contains the domain of the original address (lower cased). This
11170 differs from &$parent_domain$& only when there is more than one level of
11171 aliasing or forwarding. When more than one address is being delivered in a
11172 single transport run, &$original_domain$& is not set.
11173
11174 If a new address is created by means of a &%deliver%& command in a system
11175 filter, it is set up with an artificial &"parent"& address. This has the local
11176 part &'system-filter'& and the default qualify domain.
11177
11178 .vitem &$original_local_part$&
11179 .vindex "&$local_part$&"
11180 .vindex "&$original_local_part$&"
11181 When a top-level address is being processed for delivery, this contains the
11182 same value as &$local_part$&, unless a prefix or suffix was removed from the
11183 local part, because &$original_local_part$& always contains the full local
11184 part. When a &"child"& address (for example, generated by an alias, forward, or
11185 filter file) is being processed, this variable contains the full local part of
11186 the original address.
11187
11188 If the router that did the redirection processed the local part
11189 case-insensitively, the value in &$original_local_part$& is in lower case.
11190 This variable differs from &$parent_local_part$& only when there is more than
11191 one level of aliasing or forwarding. When more than one address is being
11192 delivered in a single transport run, &$original_local_part$& is not set.
11193
11194 If a new address is created by means of a &%deliver%& command in a system
11195 filter, it is set up with an artificial &"parent"& address. This has the local
11196 part &'system-filter'& and the default qualify domain.
11197
11198 .vitem &$originator_gid$&
11199 .cindex "gid (group id)" "of originating user"
11200 .cindex "sender" "gid"
11201 .vindex "&$caller_gid$&"
11202 .vindex "&$originator_gid$&"
11203 This variable contains the value of &$caller_gid$& that was set when the
11204 message was received. For messages received via the command line, this is the
11205 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11206 normally the gid of the Exim user.
11207
11208 .vitem &$originator_uid$&
11209 .cindex "uid (user id)" "of originating user"
11210 .cindex "sender" "uid"
11211 .vindex "&$caller_uid$&"
11212 .vindex "&$originaltor_uid$&"
11213 The value of &$caller_uid$& that was set when the message was received. For
11214 messages received via the command line, this is the uid of the sending user.
11215 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11216 user.
11217
11218 .vitem &$parent_domain$&
11219 .vindex "&$parent_domain$&"
11220 This variable is similar to &$original_domain$& (see
11221 above), except that it refers to the immediately preceding parent address.
11222
11223 .vitem &$parent_local_part$&
11224 .vindex "&$parent_local_part$&"
11225 This variable is similar to &$original_local_part$&
11226 (see above), except that it refers to the immediately preceding parent address.
11227
11228 .vitem &$pid$&
11229 .cindex "pid (process id)" "of current process"
11230 .vindex "&$pid$&"
11231 This variable contains the current process id.
11232
11233 .vitem &$pipe_addresses$&
11234 .cindex "filter" "transport filter"
11235 .cindex "transport" "filter"
11236 .vindex "&$pipe_addresses$&"
11237 This is not an expansion variable, but is mentioned here because the string
11238 &`$pipe_addresses`& is handled specially in the command specification for the
11239 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11240 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11241 It cannot be used in general expansion strings, and provokes an &"unknown
11242 variable"& error if encountered.
11243
11244 .vitem &$primary_hostname$&
11245 .vindex "&$primary_hostname$&"
11246 This variable contains the value set by &%primary_hostname%& in the
11247 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11248 a single-component name, Exim calls &[gethostbyname()]& (or
11249 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11250 qualified host name. See also &$smtp_active_hostname$&.
11251
11252
11253 .vitem &$prvscheck_address$&
11254 This variable is used in conjunction with the &%prvscheck%& expansion item,
11255 which is described in sections &<<SECTexpansionitems>>& and
11256 &<<SECTverifyPRVS>>&.
11257
11258 .vitem &$prvscheck_keynum$&
11259 This variable is used in conjunction with the &%prvscheck%& expansion item,
11260 which is described in sections &<<SECTexpansionitems>>& and
11261 &<<SECTverifyPRVS>>&.
11262
11263 .vitem &$prvscheck_result$&
11264 This variable is used in conjunction with the &%prvscheck%& expansion item,
11265 which is described in sections &<<SECTexpansionitems>>& and
11266 &<<SECTverifyPRVS>>&.
11267
11268 .vitem &$qualify_domain$&
11269 .vindex "&$qualify_domain$&"
11270 The value set for the &%qualify_domain%& option in the configuration file.
11271
11272 .vitem &$qualify_recipient$&
11273 .vindex "&$qualify_recipient$&"
11274 The value set for the &%qualify_recipient%& option in the configuration file,
11275 or if not set, the value of &$qualify_domain$&.
11276
11277 .vitem &$rcpt_count$&
11278 .vindex "&$rcpt_count$&"
11279 When a message is being received by SMTP, this variable contains the number of
11280 RCPT commands received for the current message. If this variable is used in a
11281 RCPT ACL, its value includes the current command.
11282
11283 .vitem &$rcpt_defer_count$&
11284 .vindex "&$rcpt_defer_count$&"
11285 .cindex "4&'xx'& responses" "count of"
11286 When a message is being received by SMTP, this variable contains the number of
11287 RCPT commands in the current message that have previously been rejected with a
11288 temporary (4&'xx'&) response.
11289
11290 .vitem &$rcpt_fail_count$&
11291 .vindex "&$rcpt_fail_count$&"
11292 When a message is being received by SMTP, this variable contains the number of
11293 RCPT commands in the current message that have previously been rejected with a
11294 permanent (5&'xx'&) response.
11295
11296 .vitem &$received_count$&
11297 .vindex "&$received_count$&"
11298 This variable contains the number of &'Received:'& header lines in the message,
11299 including the one added by Exim (so its value is always greater than zero). It
11300 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11301 delivering.
11302
11303 .vitem &$received_for$&
11304 .vindex "&$received_for$&"
11305 If there is only a single recipient address in an incoming message, this
11306 variable contains that address when the &'Received:'& header line is being
11307 built. The value is copied after recipient rewriting has happened, but before
11308 the &[local_scan()]& function is run.
11309
11310 .vitem &$received_ip_address$&
11311 .vindex "&$received_ip_address$&"
11312 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11313 variable is set to the address of the local IP interface, and &$received_port$&
11314 is set to the local port number. (The remote IP address and port are in
11315 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11316 the port value is -1 unless it has been set using the &%-oMi%& command line
11317 option.
11318
11319 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11320 could be used, for example, to make the file name for a TLS certificate depend
11321 on which interface and/or port is being used for the incoming connection. The
11322 values of &$received_ip_address$& and &$received_port$& are saved with any
11323 messages that are received, thus making these variables available at delivery
11324 time.
11325
11326 &*Note:*& There are no equivalent variables for outgoing connections, because
11327 the values are unknown (unless they are explicitly set by options of the
11328 &(smtp)& transport).
11329
11330 .vitem &$received_port$&
11331 .vindex "&$received_port$&"
11332 See &$received_ip_address$&.
11333
11334 .vitem &$received_protocol$&
11335 .vindex "&$received_protocol$&"
11336 When a message is being processed, this variable contains the name of the
11337 protocol by which it was received. Most of the names used by Exim are defined
11338 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11339 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11340 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11341 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11342 connection and the client was successfully authenticated.
11343
11344 Exim uses the protocol name &"smtps"& for the case when encryption is
11345 automatically set up on connection without the use of STARTTLS (see
11346 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11347 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11348 where the client initially uses EHLO, sets up an encrypted connection using
11349 STARTTLS, and then uses HELO afterwards.
11350
11351 The &%-oMr%& option provides a way of specifying a custom protocol name for
11352 messages that are injected locally by trusted callers. This is commonly used to
11353 identify messages that are being re-injected after some kind of scanning.
11354
11355 .vitem &$received_time$&
11356 .vindex "&$received_time$&"
11357 This variable contains the date and time when the current message was received,
11358 as a number of seconds since the start of the Unix epoch.
11359
11360 .vitem &$recipient_data$&
11361 .vindex "&$recipient_data$&"
11362 This variable is set after an indexing lookup success in an ACL &%recipients%&
11363 condition. It contains the data from the lookup, and the value remains set
11364 until the next &%recipients%& test. Thus, you can do things like this:
11365 .display
11366 &`require recipients  = cdb*@;/some/file`&
11367 &`deny    `&&'some further test involving'& &`$recipient_data`&
11368 .endd
11369 &*Warning*&: This variable is set only when a lookup is used as an indexing
11370 method in the address list, using the semicolon syntax as in the example above.
11371 The variable is not set for a lookup that is used as part of the string
11372 expansion that all such lists undergo before being interpreted.
11373
11374 .vitem &$recipient_verify_failure$&
11375 .vindex "&$recipient_verify_failure$&"
11376 In an ACL, when a recipient verification fails, this variable contains
11377 information about the failure. It is set to one of the following words:
11378
11379 .ilist
11380 &"qualify"&: The address was unqualified (no domain), and the message
11381 was neither local nor came from an exempted host.
11382
11383 .next
11384 &"route"&: Routing failed.
11385
11386 .next
11387 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11388 or before the MAIL command (that is, on initial connection, HELO, or
11389 MAIL).
11390
11391 .next
11392 &"recipient"&: The RCPT command in a callout was rejected.
11393 .next
11394
11395 &"postmaster"&: The postmaster check in a callout was rejected.
11396 .endlist
11397
11398 The main use of this variable is expected to be to distinguish between
11399 rejections of MAIL and rejections of RCPT.
11400
11401 .vitem &$recipients$&
11402 .vindex "&$recipients$&"
11403 This variable contains a list of envelope recipients for a message. A comma and
11404 a space separate the addresses in the replacement text. However, the variable
11405 is not generally available, to prevent exposure of Bcc recipients in
11406 unprivileged users' filter files. You can use &$recipients$& only in these
11407 cases:
11408
11409 .olist
11410 In a system filter file.
11411 .next
11412 In the ACLs associated with the DATA command and with non-SMTP messages, that
11413 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11414 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11415 &%acl_not_smtp_mime%&.
11416 .next
11417 From within a &[local_scan()]& function.
11418 .endlist
11419
11420
11421 .vitem &$recipients_count$&
11422 .vindex "&$recipients_count$&"
11423 When a message is being processed, this variable contains the number of
11424 envelope recipients that came with the message. Duplicates are not excluded
11425 from the count. While a message is being received over SMTP, the number
11426 increases for each accepted recipient. It can be referenced in an ACL.
11427
11428
11429 .vitem &$regex_match_string$&
11430 .vindex "&$regex_match_string$&"
11431 This variable is set to contain the matching regular expression after a
11432 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11433
11434
11435 .vitem &$reply_address$&
11436 .vindex "&$reply_address$&"
11437 When a message is being processed, this variable contains the contents of the
11438 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11439 contents of the &'From:'& header line. Apart from the removal of leading
11440 white space, the value is not processed in any way. In particular, no RFC 2047
11441 decoding or character code translation takes place.
11442
11443 .vitem &$return_path$&
11444 .vindex "&$return_path$&"
11445 When a message is being delivered, this variable contains the return path &--
11446 the sender field that will be sent as part of the envelope. It is not enclosed
11447 in <> characters. At the start of routing an address, &$return_path$& has the
11448 same value as &$sender_address$&, but if, for example, an incoming message to a
11449 mailing list has been expanded by a router which specifies a different address
11450 for bounce messages, &$return_path$& subsequently contains the new bounce
11451 address, whereas &$sender_address$& always contains the original sender address
11452 that was received with the message. In other words, &$sender_address$& contains
11453 the incoming envelope sender, and &$return_path$& contains the outgoing
11454 envelope sender.
11455
11456 .vitem &$return_size_limit$&
11457 .vindex "&$return_size_limit$&"
11458 This is an obsolete name for &$bounce_return_size_limit$&.
11459
11460 .vitem &$runrc$&
11461 .cindex "return code" "from &%run%& expansion"
11462 .vindex "&$runrc$&"
11463 This variable contains the return code from a command that is run by the
11464 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11465 assume the order in which option values are expanded, except for those
11466 preconditions whose order of testing is documented. Therefore, you cannot
11467 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11468 another.
11469
11470 .vitem &$self_hostname$&
11471 .oindex "&%self%&" "value of host name"
11472 .vindex "&$self_hostname$&"
11473 When an address is routed to a supposedly remote host that turns out to be the
11474 local host, what happens is controlled by the &%self%& generic router option.
11475 One of its values causes the address to be passed to another router. When this
11476 happens, &$self_hostname$& is set to the name of the local host that the
11477 original router encountered. In other circumstances its contents are null.
11478
11479 .vitem &$sender_address$&
11480 .vindex "&$sender_address$&"
11481 When a message is being processed, this variable contains the sender's address
11482 that was received in the message's envelope. The case of letters in the address
11483 is retained, in both the local part and the domain. For bounce messages, the
11484 value of this variable is the empty string. See also &$return_path$&.
11485
11486 .vitem &$sender_address_data$&
11487 .vindex "&$address_data$&"
11488 .vindex "&$sender_address_data$&"
11489 If &$address_data$& is set when the routers are called from an ACL to verify a
11490 sender address, the final value is preserved in &$sender_address_data$&, to
11491 distinguish it from data from a recipient address. The value does not persist
11492 after the end of the current ACL statement. If you want to preserve it for
11493 longer, you can save it in an ACL variable.
11494
11495 .vitem &$sender_address_domain$&
11496 .vindex "&$sender_address_domain$&"
11497 The domain portion of &$sender_address$&.
11498
11499 .vitem &$sender_address_local_part$&
11500 .vindex "&$sender_address_local_part$&"
11501 The local part portion of &$sender_address$&.
11502
11503 .vitem &$sender_data$&
11504 .vindex "&$sender_data$&"
11505 This variable is set after a lookup success in an ACL &%senders%& condition or
11506 in a router &%senders%& option. It contains the data from the lookup, and the
11507 value remains set until the next &%senders%& test. Thus, you can do things like
11508 this:
11509 .display
11510 &`require senders      = cdb*@;/some/file`&
11511 &`deny    `&&'some further test involving'& &`$sender_data`&
11512 .endd
11513 &*Warning*&: This variable is set only when a lookup is used as an indexing
11514 method in the address list, using the semicolon syntax as in the example above.
11515 The variable is not set for a lookup that is used as part of the string
11516 expansion that all such lists undergo before being interpreted.
11517
11518 .vitem &$sender_fullhost$&
11519 .vindex "&$sender_fullhost$&"
11520 When a message is received from a remote host, this variable contains the host
11521 name and IP address in a single string. It ends with the IP address in square
11522 brackets, followed by a colon and a port number if the logging of ports is
11523 enabled. The format of the rest of the string depends on whether the host
11524 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11525 looking up its IP address. (Looking up the IP address can be forced by the
11526 &%host_lookup%& option, independent of verification.) A plain host name at the
11527 start of the string is a verified host name; if this is not present,
11528 verification either failed or was not requested. A host name in parentheses is
11529 the argument of a HELO or EHLO command. This is omitted if it is identical to
11530 the verified host name or to the host's IP address in square brackets.
11531
11532 .vitem &$sender_helo_name$&
11533 .vindex "&$sender_helo_name$&"
11534 When a message is received from a remote host that has issued a HELO or EHLO
11535 command, the argument of that command is placed in this variable. It is also
11536 set if HELO or EHLO is used when a message is received using SMTP locally via
11537 the &%-bs%& or &%-bS%& options.
11538
11539 .vitem &$sender_host_address$&
11540 .vindex "&$sender_host_address$&"
11541 When a message is received from a remote host, this variable contains that
11542 host's IP address. For locally submitted messages, it is empty.
11543
11544 .vitem &$sender_host_authenticated$&
11545 .vindex "&$sender_host_authenticated$&"
11546 This variable contains the name (not the public name) of the authenticator
11547 driver that successfully authenticated the client from which the message was
11548 received. It is empty if there was no successful authentication. See also
11549 &$authenticated_id$&.
11550
11551 .vitem &$sender_host_name$&
11552 .vindex "&$sender_host_name$&"
11553 When a message is received from a remote host, this variable contains the
11554 host's name as obtained by looking up its IP address. For messages received by
11555 other means, this variable is empty.
11556
11557 .vindex "&$host_lookup_failed$&"
11558 If the host name has not previously been looked up, a reference to
11559 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11560 A looked up name is accepted only if it leads back to the original IP address
11561 via a forward lookup. If either the reverse or the forward lookup fails to find
11562 any data, or if the forward lookup does not yield the original IP address,
11563 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11564
11565 .vindex "&$host_lookup_deferred$&"
11566 However, if either of the lookups cannot be completed (for example, there is a
11567 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11568 &$host_lookup_failed$& remains set to &"0"&.
11569
11570 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
11571 host name again if there is a subsequent reference to &$sender_host_name$&
11572 in the same Exim process, but it does try again if &$host_lookup_deferred$&
11573 is set to &"1"&.
11574
11575 Exim does not automatically look up every calling host's name. If you want
11576 maximum efficiency, you should arrange your configuration so that it avoids
11577 these lookups altogether. The lookup happens only if one or more of the
11578 following are true:
11579
11580 .ilist
11581 A string containing &$sender_host_name$& is expanded.
11582 .next
11583 The calling host matches the list in &%host_lookup%&. In the default
11584 configuration, this option is set to *, so it must be changed if lookups are
11585 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
11586 .next
11587 Exim needs the host name in order to test an item in a host list. The items
11588 that require this are described in sections &<<SECThoslispatnam>>& and
11589 &<<SECThoslispatnamsk>>&.
11590 .next
11591 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
11592 In this case, the host name is required to compare with the name quoted in any
11593 EHLO or HELO commands that the client issues.
11594 .next
11595 The remote host issues a EHLO or HELO command that quotes one of the
11596 domains in &%helo_lookup_domains%&. The default value of this option is
11597 . ==== As this is a nested list, any displays it contains must be indented
11598 . ==== as otherwise they are too far to the left.
11599 .code
11600   helo_lookup_domains = @ : @[]
11601 .endd
11602 which causes a lookup if a remote host (incorrectly) gives the server's name or
11603 IP address in an EHLO or HELO command.
11604 .endlist
11605
11606
11607 .vitem &$sender_host_port$&
11608 .vindex "&$sender_host_port$&"
11609 When a message is received from a remote host, this variable contains the port
11610 number that was used on the remote host.
11611
11612 .vitem &$sender_ident$&
11613 .vindex "&$sender_ident$&"
11614 When a message is received from a remote host, this variable contains the
11615 identification received in response to an RFC 1413 request. When a message has
11616 been received locally, this variable contains the login name of the user that
11617 called Exim.
11618
11619 .vitem &$sender_rate_$&&'xxx'&
11620 A number of variables whose names begin &$sender_rate_$& are set as part of the
11621 &%ratelimit%& ACL condition. Details are given in section
11622 &<<SECTratelimiting>>&.
11623
11624 .vitem &$sender_rcvhost$&
11625 .cindex "DNS" "reverse lookup"
11626 .cindex "reverse DNS lookup"
11627 .vindex "&$sender_rcvhost$&"
11628 This is provided specifically for use in &'Received:'& headers. It starts with
11629 either the verified host name (as obtained from a reverse DNS lookup) or, if
11630 there is no verified host name, the IP address in square brackets. After that
11631 there may be text in parentheses. When the first item is a verified host name,
11632 the first thing in the parentheses is the IP address in square brackets,
11633 followed by a colon and a port number if port logging is enabled. When the
11634 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
11635 the parentheses.
11636
11637 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
11638 was used and its argument was not identical to the real host name or IP
11639 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
11640 all three items are present in the parentheses, a newline and tab are inserted
11641 into the string, to improve the formatting of the &'Received:'& header.
11642
11643 .vitem &$sender_verify_failure$&
11644 .vindex "&$sender_verify_failure$&"
11645 In an ACL, when a sender verification fails, this variable contains information
11646 about the failure. The details are the same as for
11647 &$recipient_verify_failure$&.
11648
11649 .vitem &$sending_ip_address$&
11650 .vindex "&$sending_ip_address$&"
11651 This variable is set whenever an outgoing SMTP connection to another host has
11652 been set up. It contains the IP address of the local interface that is being
11653 used. This is useful if a host that has more than one IP address wants to take
11654 on different personalities depending on which one is being used. For incoming
11655 connections, see &$received_ip_address$&.
11656
11657 .vitem &$sending_port$&
11658 .vindex "&$sending_port$&"
11659 This variable is set whenever an outgoing SMTP connection to another host has
11660 been set up. It contains the local port that is being used. For incoming
11661 connections, see &$received_port$&.
11662
11663 .vitem &$smtp_active_hostname$&
11664 .vindex "&$smtp_active_hostname$&"
11665 During an incoming SMTP session, this variable contains the value of the active
11666 host name, as specified by the &%smtp_active_hostname%& option. The value of
11667 &$smtp_active_hostname$& is saved with any message that is received, so its
11668 value can be consulted during routing and delivery.
11669
11670 .vitem &$smtp_command$&
11671 .vindex "&$smtp_command$&"
11672 During the processing of an incoming SMTP command, this variable contains the
11673 entire command. This makes it possible to distinguish between HELO and EHLO in
11674 the HELO ACL, and also to distinguish between commands such as these:
11675 .code
11676 MAIL FROM:<>
11677 MAIL FROM: <>
11678 .endd
11679 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
11680 command, the address in &$smtp_command$& is the original address before any
11681 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
11682 the address after SMTP-time rewriting.
11683
11684 .vitem &$smtp_command_argument$&
11685 .cindex "SMTP" "command, argument for"
11686 .vindex "&$smtp_command_argument$&"
11687 While an ACL is running to check an SMTP command, this variable contains the
11688 argument, that is, the text that follows the command name, with leading white
11689 space removed. Following the introduction of &$smtp_command$&, this variable is
11690 somewhat redundant, but is retained for backwards compatibility.
11691
11692 .vitem &$smtp_count_at_connection_start$&
11693 .vindex "&$smtp_count_at_connection_start$&"
11694 This variable is set greater than zero only in processes spawned by the Exim
11695 daemon for handling incoming SMTP connections. The name is deliberately long,
11696 in order to emphasize what the contents are. When the daemon accepts a new
11697 connection, it increments this variable. A copy of the variable is passed to
11698 the child process that handles the connection, but its value is fixed, and
11699 never changes. It is only an approximation of how many incoming connections
11700 there actually are, because many other connections may come and go while a
11701 single connection is being processed. When a child process terminates, the
11702 daemon decrements its copy of the variable.
11703
11704 .vitem "&$sn0$& &-- &$sn9$&"
11705 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
11706 that were current at the end of the system filter file. This allows a system
11707 filter file to set values that can be tested in users' filter files. For
11708 example, a system filter could set a value indicating how likely it is that a
11709 message is junk mail.
11710
11711 .vitem &$spam_$&&'xxx'&
11712 A number of variables whose names start with &$spam$& are available when Exim
11713 is compiled with the content-scanning extension. For details, see section
11714 &<<SECTscanspamass>>&.
11715
11716
11717 .vitem &$spool_directory$&
11718 .vindex "&$spool_directory$&"
11719 The name of Exim's spool directory.
11720
11721 .vitem &$spool_inodes$&
11722 .vindex "&$spool_inodes$&"
11723 The number of free inodes in the disk partition where Exim's spool files are
11724 being written. The value is recalculated whenever the variable is referenced.
11725 If the relevant file system does not have the concept of inodes, the value of
11726 is -1. See also the &%check_spool_inodes%& option.
11727
11728 .vitem &$spool_space$&
11729 .vindex "&$spool_space$&"
11730 The amount of free space (as a number of kilobytes) in the disk partition where
11731 Exim's spool files are being written. The value is recalculated whenever the
11732 variable is referenced. If the operating system does not have the ability to
11733 find the amount of free space (only true for experimental systems), the space
11734 value is -1. For example, to check in an ACL that there is at least 50
11735 megabytes free on the spool, you could write:
11736 .code
11737 condition = ${if > {$spool_space}{50000}}
11738 .endd
11739 See also the &%check_spool_space%& option.
11740
11741
11742 .vitem &$thisaddress$&
11743 .vindex "&$thisaddress$&"
11744 This variable is set only during the processing of the &%foranyaddress%&
11745 command in a filter file. Its use is explained in the description of that
11746 command, which can be found in the separate document entitled &'Exim's
11747 interfaces to mail filtering'&.
11748
11749 .vitem &$tls_certificate_verified$&
11750 .vindex "&$tls_certificate_verified$&"
11751 This variable is set to &"1"& if a TLS certificate was verified when the
11752 message was received, and &"0"& otherwise.
11753
11754 .vitem &$tls_cipher$&
11755 .vindex "&$tls_cipher$&"
11756 When a message is received from a remote host over an encrypted SMTP
11757 connection, this variable is set to the cipher suite that was negotiated, for
11758 example DES-CBC3-SHA. In other circumstances, in particular, for message
11759 received over unencrypted connections, the variable is empty. Testing
11760 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
11761 non-encrypted connections during ACL processing.
11762
11763 The &$tls_cipher$& variable retains its value during message delivery, except
11764 when an outward SMTP delivery takes place via the &(smtp)& transport. In this
11765 case, &$tls_cipher$& is cleared before any outgoing SMTP connection is made,
11766 and then set to the outgoing cipher suite if one is negotiated. See chapter
11767 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
11768 details of the &(smtp)& transport.
11769
11770 .vitem &$tls_peerdn$&
11771 .vindex "&$tls_peerdn$&"
11772 When a message is received from a remote host over an encrypted SMTP
11773 connection, and Exim is configured to request a certificate from the client,
11774 the value of the Distinguished Name of the certificate is made available in the
11775 &$tls_peerdn$& during subsequent processing. Like &$tls_cipher$&, the
11776 value is retained during message delivery, except during outbound SMTP
11777 deliveries.
11778
11779 .vitem &$tod_bsdinbox$&
11780 .vindex "&$tod_bsdinbox$&"
11781 The time of day and the date, in the format required for BSD-style mailbox
11782 files, for example: Thu Oct 17 17:14:09 1995.
11783
11784 .vitem &$tod_epoch$&
11785 .vindex "&$tod_epoch$&"
11786 The time and date as a number of seconds since the start of the Unix epoch.
11787
11788 .vitem &$tod_full$&
11789 .vindex "&$tod_full$&"
11790 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
11791 +0100. The timezone is always given as a numerical offset from UTC, with
11792 positive values used for timezones that are ahead (east) of UTC, and negative
11793 values for those that are behind (west).
11794
11795 .vitem &$tod_log$&
11796 .vindex "&$tod_log$&"
11797 The time and date in the format used for writing Exim's log files, for example:
11798 1995-10-12 15:32:29, but without a timezone.
11799
11800 .vitem &$tod_logfile$&
11801 .vindex "&$tod_logfile$&"
11802 This variable contains the date in the format yyyymmdd. This is the format that
11803 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
11804 flag.
11805
11806 .vitem &$tod_zone$&
11807 .vindex "&$tod_zone$&"
11808 This variable contains the numerical value of the local timezone, for example:
11809 -0500.
11810
11811 .vitem &$tod_zulu$&
11812 .vindex "&$tod_zulu$&"
11813 This variable contains the UTC date and time in &"Zulu"& format, as specified
11814 by ISO 8601, for example: 20030221154023Z.
11815
11816 .vitem &$value$&
11817 .vindex "&$value$&"
11818 This variable contains the result of an expansion lookup, extraction operation,
11819 or external command, as described above. It is also used during a
11820 &*reduce*& expansion.
11821
11822 .vitem &$version_number$&
11823 .vindex "&$version_number$&"
11824 The version number of Exim.
11825
11826 .vitem &$warn_message_delay$&
11827 .vindex "&$warn_message_delay$&"
11828 This variable is set only during the creation of a message warning about a
11829 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11830
11831 .vitem &$warn_message_recipients$&
11832 .vindex "&$warn_message_recipients$&"
11833 This variable is set only during the creation of a message warning about a
11834 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11835 .endlist
11836 .ecindex IIDstrexp
11837
11838
11839
11840 . ////////////////////////////////////////////////////////////////////////////
11841 . ////////////////////////////////////////////////////////////////////////////
11842
11843 .chapter "Embedded Perl" "CHAPperl"
11844 .scindex IIDperl "Perl" "calling from Exim"
11845 Exim can be built to include an embedded Perl interpreter. When this is done,
11846 Perl subroutines can be called as part of the string expansion process. To make
11847 use of the Perl support, you need version 5.004 or later of Perl installed on
11848 your system. To include the embedded interpreter in the Exim binary, include
11849 the line
11850 .code
11851 EXIM_PERL = perl.o
11852 .endd
11853 in your &_Local/Makefile_& and then build Exim in the normal way.
11854
11855
11856 .section "Setting up so Perl can be used" "SECID85"
11857 .oindex "&%perl_startup%&"
11858 Access to Perl subroutines is via a global configuration option called
11859 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
11860 no &%perl_startup%& option in the Exim configuration file then no Perl
11861 interpreter is started and there is almost no overhead for Exim (since none of
11862 the Perl library will be paged in unless used). If there is a &%perl_startup%&
11863 option then the associated value is taken to be Perl code which is executed in
11864 a newly created Perl interpreter.
11865
11866 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
11867 need backslashes before any characters to escape special meanings. The option
11868 should usually be something like
11869 .code
11870 perl_startup = do '/etc/exim.pl'
11871 .endd
11872 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
11873 use from Exim. Exim can be configured either to start up a Perl interpreter as
11874 soon as it is entered, or to wait until the first time it is needed. Starting
11875 the interpreter at the beginning ensures that it is done while Exim still has
11876 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
11877 fact used in a particular run. Also, note that this does not mean that Exim is
11878 necessarily running as root when Perl is called at a later time. By default,
11879 the interpreter is started only when it is needed, but this can be changed in
11880 two ways:
11881
11882 .ilist
11883 .oindex "&%perl_at_start%&"
11884 Setting &%perl_at_start%& (a boolean option) in the configuration requests
11885 a startup when Exim is entered.
11886 .next
11887 The command line option &%-ps%& also requests a startup when Exim is entered,
11888 overriding the setting of &%perl_at_start%&.
11889 .endlist
11890
11891 There is also a command line option &%-pd%& (for delay) which suppresses the
11892 initial startup, even if &%perl_at_start%& is set.
11893
11894
11895 .section "Calling Perl subroutines" "SECID86"
11896 When the configuration file includes a &%perl_startup%& option you can make use
11897 of the string expansion item to call the Perl subroutines that are defined
11898 by the &%perl_startup%& code. The operator is used in any of the following
11899 forms:
11900 .code
11901 ${perl{foo}}
11902 ${perl{foo}{argument}}
11903 ${perl{foo}{argument1}{argument2} ... }
11904 .endd
11905 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
11906 arguments may be passed. Passing more than this results in an expansion failure
11907 with an error message of the form
11908 .code
11909 Too many arguments passed to Perl subroutine "foo" (max is 8)
11910 .endd
11911 The return value of the Perl subroutine is evaluated in a scalar context before
11912 it is passed back to Exim to be inserted into the expanded string. If the
11913 return value is &'undef'&, the expansion is forced to fail in the same way as
11914 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
11915 by obeying Perl's &%die%& function, the expansion fails with the error message
11916 that was passed to &%die%&.
11917
11918
11919 .section "Calling Exim functions from Perl" "SECID87"
11920 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
11921 is available to call back into Exim's string expansion function. For example,
11922 the Perl code
11923 .code
11924 my $lp = Exim::expand_string('$local_part');
11925 .endd
11926 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
11927 Note those are single quotes and not double quotes to protect against
11928 &$local_part$& being interpolated as a Perl variable.
11929
11930 If the string expansion is forced to fail by a &"fail"& item, the result of
11931 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
11932 expansion string, the Perl call from the original expansion string fails with
11933 an appropriate error message, in the same way as if &%die%& were used.
11934
11935 .cindex "debugging" "from embedded Perl"
11936 .cindex "log" "writing from embedded Perl"
11937 Two other Exim functions are available for use from within Perl code.
11938 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
11939 debugging is enabled. If you want a newline at the end, you must supply it.
11940 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
11941 timestamp. In this case, you should not supply a terminating newline.
11942
11943
11944 .section "Use of standard output and error by Perl" "SECID88"
11945 .cindex "Perl" "standard output and error"
11946 You should not write to the standard error or output streams from within your
11947 Perl code, as it is not defined how these are set up. In versions of Exim
11948 before 4.50, it is possible for the standard output or error to refer to the
11949 SMTP connection during message reception via the daemon. Writing to this stream
11950 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
11951 error streams are connected to &_/dev/null_& in the daemon. The chaos is
11952 avoided, but the output is lost.
11953
11954 .cindex "Perl" "use of &%warn%&"
11955 The Perl &%warn%& statement writes to the standard error stream by default.
11956 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
11957 you have no control. When Exim starts up the Perl interpreter, it arranges for
11958 output from the &%warn%& statement to be written to the Exim main log. You can
11959 change this by including appropriate Perl magic somewhere in your Perl code.
11960 For example, to discard &%warn%& output completely, you need this:
11961 .code
11962 $SIG{__WARN__} = sub { };
11963 .endd
11964 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
11965 example, the code for the subroutine is empty, so it does nothing, but you can
11966 include any Perl code that you like. The text of the &%warn%& message is passed
11967 as the first subroutine argument.
11968 .ecindex IIDperl
11969
11970
11971 . ////////////////////////////////////////////////////////////////////////////
11972 . ////////////////////////////////////////////////////////////////////////////
11973
11974 .chapter "Starting the daemon and the use of network interfaces" &&&
11975          "CHAPinterfaces" &&&
11976          "Starting the daemon"
11977 .cindex "daemon" "starting"
11978 .cindex "interface" "listening"
11979 .cindex "network interface"
11980 .cindex "interface" "network"
11981 .cindex "IP address" "for listening"
11982 .cindex "daemon" "listening IP addresses"
11983 .cindex "TCP/IP" "setting listening interfaces"
11984 .cindex "TCP/IP" "setting listening ports"
11985 A host that is connected to a TCP/IP network may have one or more physical
11986 hardware network interfaces. Each of these interfaces may be configured as one
11987 or more &"logical"& interfaces, which are the entities that a program actually
11988 works with. Each of these logical interfaces is associated with an IP address.
11989 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
11990 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
11991 knowledge about the host's interfaces for use in three different circumstances:
11992
11993 .olist
11994 When a listening daemon is started, Exim needs to know which interfaces
11995 and ports to listen on.
11996 .next
11997 When Exim is routing an address, it needs to know which IP addresses
11998 are associated with local interfaces. This is required for the correct
11999 processing of MX lists by removing the local host and others with the
12000 same or higher priority values. Also, Exim needs to detect cases
12001 when an address is routed to an IP address that in fact belongs to the
12002 local host. Unless the &%self%& router option or the &%allow_localhost%&
12003 option of the smtp transport is set (as appropriate), this is treated
12004 as an error situation.
12005 .next
12006 When Exim connects to a remote host, it may need to know which interface to use
12007 for the outgoing connection.
12008 .endlist
12009
12010
12011 Exim's default behaviour is likely to be appropriate in the vast majority
12012 of cases. If your host has only one interface, and you want all its IP
12013 addresses to be treated in the same way, and you are using only the
12014 standard SMTP port, you should not need to take any special action. The
12015 rest of this chapter does not apply to you.
12016
12017 In a more complicated situation you may want to listen only on certain
12018 interfaces, or on different ports, and for this reason there are a number of
12019 options that can be used to influence Exim's behaviour. The rest of this
12020 chapter describes how they operate.
12021
12022 When a message is received over TCP/IP, the interface and port that were
12023 actually used are set in &$received_ip_address$& and &$received_port$&.
12024
12025
12026
12027 .section "Starting a listening daemon" "SECID89"
12028 When a listening daemon is started (by means of the &%-bd%& command line
12029 option), the interfaces and ports on which it listens are controlled by the
12030 following options:
12031
12032 .ilist
12033 &%daemon_smtp_ports%& contains a list of default ports. (For backward
12034 compatibility, this option can also be specified in the singular.)
12035 .next
12036 &%local_interfaces%& contains list of interface IP addresses on which to
12037 listen. Each item may optionally also specify a port.
12038 .endlist
12039
12040 The default list separator in both cases is a colon, but this can be changed as
12041 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12042 it is usually best to change the separator to avoid having to double all the
12043 colons. For example:
12044 .code
12045 local_interfaces = <; 127.0.0.1 ; \
12046                       192.168.23.65 ; \
12047                       ::1 ; \
12048                       3ffe:ffff:836f::fe86:a061
12049 .endd
12050 There are two different formats for specifying a port along with an IP address
12051 in &%local_interfaces%&:
12052
12053 .olist
12054 The port is added onto the address with a dot separator. For example, to listen
12055 on port 1234 on two different IP addresses:
12056 .code
12057 local_interfaces = <; 192.168.23.65.1234 ; \
12058                       3ffe:ffff:836f::fe86:a061.1234
12059 .endd
12060 .next
12061 The IP address is enclosed in square brackets, and the port is added
12062 with a colon separator, for example:
12063 .code
12064 local_interfaces = <; [192.168.23.65]:1234 ; \
12065                       [3ffe:ffff:836f::fe86:a061]:1234
12066 .endd
12067 .endlist
12068
12069 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12070 default setting contains just one port:
12071 .code
12072 daemon_smtp_ports = smtp
12073 .endd
12074 If more than one port is listed, each interface that does not have its own port
12075 specified listens on all of them. Ports that are listed in
12076 &%daemon_smtp_ports%& can be identified either by name (defined in
12077 &_/etc/services_&) or by number. However, when ports are given with individual
12078 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12079
12080
12081
12082 .section "Special IP listening addresses" "SECID90"
12083 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12084 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12085 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12086 instead of setting up separate listening sockets for each interface. The
12087 default value of &%local_interfaces%& is
12088 .code
12089 local_interfaces = 0.0.0.0
12090 .endd
12091 when Exim is built without IPv6 support; otherwise it is:
12092 .code
12093 local_interfaces = <; ::0 ; 0.0.0.0
12094 .endd
12095 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12096
12097
12098
12099 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12100 The &%-oX%& command line option can be used to override the values of
12101 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12102 instance. Another way of doing this would be to use macros and the &%-D%&
12103 option. However, &%-oX%& can be used by any admin user, whereas modification of
12104 the runtime configuration by &%-D%& is allowed only when the caller is root or
12105 exim.
12106
12107 The value of &%-oX%& is a list of items. The default colon separator can be
12108 changed in the usual way if required. If there are any items that do not
12109 contain dots or colons (that is, are not IP addresses), the value of
12110 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12111 items that do contain dots or colons, the value of &%local_interfaces%& is
12112 replaced by those items. Thus, for example,
12113 .code
12114 -oX 1225
12115 .endd
12116 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12117 whereas
12118 .code
12119 -oX 192.168.34.5.1125
12120 .endd
12121 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12122 (However, since &%local_interfaces%& now contains no items without ports, the
12123 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12124
12125
12126
12127 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12128 .cindex "ssmtp protocol"
12129 .cindex "smtps protocol"
12130 .cindex "SMTP" "ssmtp protocol"
12131 .cindex "SMTP" "smtps protocol"
12132 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12133 before the STARTTLS command was standardized for SMTP. Some legacy clients
12134 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12135 list of port numbers, connections to those ports must use SSMTP. The most
12136 common use of this option is expected to be
12137 .code
12138 tls_on_connect_ports = 465
12139 .endd
12140 because 465 is the usual port number used by the legacy clients. There is also
12141 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12142 this way when a daemon is started.
12143
12144 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12145 daemon to listen on those ports. You must still specify them in
12146 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12147 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12148 connections via the daemon.)
12149
12150
12151
12152
12153 .section "IPv6 address scopes" "SECID92"
12154 .cindex "IPv6" "address scopes"
12155 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12156 can, in principle, have the same link-local IPv6 address on different
12157 interfaces. Thus, additional information is needed, over and above the IP
12158 address, to distinguish individual interfaces. A convention of using a
12159 percent sign followed by something (often the interface name) has been
12160 adopted in some cases, leading to addresses like this:
12161 .code
12162 fe80::202:b3ff:fe03:45c1%eth0
12163 .endd
12164 To accommodate this usage, a percent sign followed by an arbitrary string is
12165 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12166 to convert a textual IPv6 address for actual use. This function recognizes the
12167 percent convention in operating systems that support it, and it processes the
12168 address appropriately. Unfortunately, some older libraries have problems with
12169 &[getaddrinfo()]&. If
12170 .code
12171 IPV6_USE_INET_PTON=yes
12172 .endd
12173 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12174 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12175 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12176 function.) Of course, this means that the additional functionality of
12177 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12178
12179 .section "Disabling IPv6" "SECID93"
12180 .cindex "IPv6" "disabling"
12181 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12182 run on a host whose kernel does not support IPv6. The binary will fall back to
12183 using IPv4, but it may waste resources looking up AAAA records, and trying to
12184 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12185 .oindex "&%disable_ipv6%&"
12186 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12187 activities take place. AAAA records are never looked up, and any IPv6 addresses
12188 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12189 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12190 to handle IPv6 literal addresses.
12191
12192 On the other hand, when IPv6 is in use, there may be times when you want to
12193 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12194 option to globally suppress the lookup of AAAA records for specified domains,
12195 and you can use the &%ignore_target_hosts%& generic router option to ignore
12196 IPv6 addresses in an individual router.
12197
12198
12199
12200 .section "Examples of starting a listening daemon" "SECID94"
12201 The default case in an IPv6 environment is
12202 .code
12203 daemon_smtp_ports = smtp
12204 local_interfaces = <; ::0 ; 0.0.0.0
12205 .endd
12206 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12207 Either one or two sockets may be used, depending on the characteristics of
12208 the TCP/IP stack. (This is complicated and messy; for more information,
12209 read the comments in the &_daemon.c_& source file.)
12210
12211 To specify listening on ports 25 and 26 on all interfaces:
12212 .code
12213 daemon_smtp_ports = 25 : 26
12214 .endd
12215 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12216 .code
12217 local_interfaces = <; ::0.25     ; ::0.26 \
12218                       0.0.0.0.25 ; 0.0.0.0.26
12219 .endd
12220 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12221 IPv4 loopback address only:
12222 .code
12223 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12224 .endd
12225 To specify listening on the default port on specific interfaces only:
12226 .code
12227 local_interfaces = 192.168.34.67 : 192.168.34.67
12228 .endd
12229 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12230
12231
12232
12233 .section "Recognizing the local host" "SECTreclocipadd"
12234 The &%local_interfaces%& option is also used when Exim needs to determine
12235 whether or not an IP address refers to the local host. That is, the IP
12236 addresses of all the interfaces on which a daemon is listening are always
12237 treated as local.
12238
12239 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12240 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12241 available interfaces from the operating system, and extracts the relevant
12242 (that is, IPv4 or IPv6) addresses to use for checking.
12243
12244 Some systems set up large numbers of virtual interfaces in order to provide
12245 many virtual web servers. In this situation, you may want to listen for
12246 email on only a few of the available interfaces, but nevertheless treat all
12247 interfaces as local when routing. You can do this by setting
12248 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12249 &"all"& wildcard values. These addresses are recognized as local, but are not
12250 used for listening. Consider this example:
12251 .code
12252 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12253                       192.168.53.235 ; \
12254                       3ffe:2101:12:1:a00:20ff:fe86:a061
12255
12256 extra_local_interfaces = <; ::0 ; 0.0.0.0
12257 .endd
12258 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12259 address, but all available interface addresses are treated as local when
12260 Exim is routing.
12261
12262 In some environments the local host name may be in an MX list, but with an IP
12263 address that is not assigned to any local interface. In other cases it may be
12264 desirable to treat other host names as if they referred to the local host. Both
12265 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12266 This contains host names rather than IP addresses. When a host is referenced
12267 during routing, either via an MX record or directly, it is treated as the local
12268 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12269 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12270
12271
12272
12273 .section "Delivering to a remote host" "SECID95"
12274 Delivery to a remote host is handled by the smtp transport. By default, it
12275 allows the system's TCP/IP functions to choose which interface to use (if
12276 there is more than one) when connecting to a remote host. However, the
12277 &%interface%& option can be set to specify which interface is used. See the
12278 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12279 details.
12280
12281
12282
12283
12284 . ////////////////////////////////////////////////////////////////////////////
12285 . ////////////////////////////////////////////////////////////////////////////
12286
12287 .chapter "Main configuration" "CHAPmainconfig"
12288 .scindex IIDconfima "configuration file" "main section"
12289 .scindex IIDmaiconf "main configuration"
12290 The first part of the run time configuration file contains three types of item:
12291
12292 .ilist
12293 Macro definitions: These lines start with an upper case letter. See section
12294 &<<SECTmacrodefs>>& for details of macro processing.
12295 .next
12296 Named list definitions: These lines start with one of the words &"domainlist"&,
12297 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12298 section &<<SECTnamedlists>>&.
12299 .next
12300 Main configuration settings: Each setting occupies one line of the file
12301 (with possible continuations). If any setting is preceded by the word
12302 &"hide"&, the &%-bP%& command line option displays its value to admin users
12303 only. See section &<<SECTcos>>& for a description of the syntax of these option
12304 settings.
12305 .endlist
12306
12307 This chapter specifies all the main configuration options, along with their
12308 types and default values. For ease of finding a particular option, they appear
12309 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12310 are now so many options, they are first listed briefly in functional groups, as
12311 an aid to finding the name of the option you are looking for. Some options are
12312 listed in more than one group.
12313
12314 .section "Miscellaneous" "SECID96"
12315 .table2
12316 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12317 .row &%disable_ipv6%&                "do no IPv6 processing"
12318 .row &%keep_malformed%&              "for broken files &-- should not happen"
12319 .row &%localhost_number%&            "for unique message ids in clusters"
12320 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12321 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12322 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12323 .row &%print_topbitchars%&           "top-bit characters are printing"
12324 .row &%timezone%&                    "force time zone"
12325 .endtable
12326
12327
12328 .section "Exim parameters" "SECID97"
12329 .table2
12330 .row &%exim_group%&                  "override compiled-in value"
12331 .row &%exim_path%&                   "override compiled-in value"
12332 .row &%exim_user%&                   "override compiled-in value"
12333 .row &%primary_hostname%&            "default from &[uname()]&"
12334 .row &%split_spool_directory%&       "use multiple directories"
12335 .row &%spool_directory%&             "override compiled-in value"
12336 .endtable
12337
12338
12339
12340 .section "Privilege controls" "SECID98"
12341 .table2
12342 .row &%admin_groups%&                "groups that are Exim admin users"
12343 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12344 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12345 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12346 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12347 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12348 .row &%never_users%&                 "do not run deliveries as these"
12349 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12350 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12351 .row &%trusted_groups%&              "groups that are trusted"
12352 .row &%trusted_users%&               "users that are trusted"
12353 .endtable
12354
12355
12356
12357 .section "Logging" "SECID99"
12358 .table2
12359 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12360 .row &%log_file_path%&               "override compiled-in value"
12361 .row &%log_selector%&                "set/unset optional logging"
12362 .row &%log_timezone%&                "add timezone to log lines"
12363 .row &%message_logs%&                "create per-message logs"
12364 .row &%preserve_message_logs%&       "after message completion"
12365 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12366 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12367 .row &%syslog_facility%&             "set syslog &""facility""& field"
12368 .row &%syslog_processname%&          "set syslog &""ident""& field"
12369 .row &%syslog_timestamp%&            "timestamp syslog lines"
12370 .row &%write_rejectlog%&             "control use of message log"
12371 .endtable
12372
12373
12374
12375 .section "Frozen messages" "SECID100"
12376 .table2
12377 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12378 .row &%freeze_tell%&                 "send message when freezing"
12379 .row &%move_frozen_messages%&        "to another directory"
12380 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12381 .endtable
12382
12383
12384
12385 .section "Data lookups" "SECID101"
12386 .table2
12387 .row &%ibase_servers%&               "InterBase servers"
12388 .row &%ldap_default_servers%&        "used if no server in query"
12389 .row &%ldap_version%&                "set protocol version"
12390 .row &%lookup_open_max%&             "lookup files held open"
12391 .row &%mysql_servers%&               "default MySQL servers"
12392 .row &%oracle_servers%&              "Oracle servers"
12393 .row &%pgsql_servers%&               "default PostgreSQL servers"
12394 .row &%sqlite_lock_timeout%&         "as it says"
12395 .endtable
12396
12397
12398
12399 .section "Message ids" "SECID102"
12400 .table2
12401 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12402 .row &%message_id_header_text%&      "ditto"
12403 .endtable
12404
12405
12406
12407 .section "Embedded Perl Startup" "SECID103"
12408 .table2
12409 .row &%perl_at_start%&               "always start the interpreter"
12410 .row &%perl_startup%&                "code to obey when starting Perl"
12411 .endtable
12412
12413
12414
12415 .section "Daemon" "SECID104"
12416 .table2
12417 .row &%daemon_smtp_ports%&           "default ports"
12418 .row &%daemon_startup_retries%&      "number of times to retry"
12419 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12420 .row &%extra_local_interfaces%&      "not necessarily listened on"
12421 .row &%local_interfaces%&            "on which to listen, with optional ports"
12422 .row &%pid_file_path%&               "override compiled-in value"
12423 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12424 .endtable
12425
12426
12427
12428 .section "Resource control" "SECID105"
12429 .table2
12430 .row &%check_log_inodes%&            "before accepting a message"
12431 .row &%check_log_space%&             "before accepting a message"
12432 .row &%check_spool_inodes%&          "before accepting a message"
12433 .row &%check_spool_space%&           "before accepting a message"
12434 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12435 .row &%queue_only_load%&             "queue incoming if load high"
12436 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12437 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12438 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12439 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12440 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12441 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12442 .row &%smtp_accept_max_per_connection%& "messages per connection"
12443 .row &%smtp_accept_max_per_host%&    "connections from one host"
12444 .row &%smtp_accept_queue%&           "queue mail if more connections"
12445 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12446                                            connection"
12447 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12448 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12449 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12450 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12451 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12452 .endtable
12453
12454
12455
12456 .section "Policy controls" "SECID106"
12457 .table2
12458 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12459 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12460 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12461 .row &%acl_smtp_auth%&               "ACL for AUTH"
12462 .row &%acl_smtp_connect%&            "ACL for connection"
12463 .row &%acl_smtp_data%&               "ACL for DATA"
12464 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12465 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12466 .row &%acl_smtp_expn%&               "ACL for EXPN"
12467 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12468 .row &%acl_smtp_mail%&               "ACL for MAIL"
12469 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12470 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12471 .row &%acl_smtp_predata%&            "ACL for start of data"
12472 .row &%acl_smtp_quit%&               "ACL for QUIT"
12473 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12474 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
12475 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
12476 .row &%av_scanner%&                  "specify virus scanner"
12477 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12478                                       words""&"
12479 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
12480 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
12481 .row &%header_maxsize%&              "total size of message header"
12482 .row &%header_line_maxsize%&         "individual header line limit"
12483 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
12484 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
12485 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
12486 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
12487 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
12488 .row &%host_lookup%&                 "host name looked up for these hosts"
12489 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12490 .row &%host_reject_connection%&      "reject connection from these hosts"
12491 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
12492 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
12493 .row &%message_size_limit%&          "for all messages"
12494 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12495 .row &%spamd_address%&               "set interface to SpamAssassin"
12496 .row &%strict_acl_vars%&             "object to unset ACL variables"
12497 .endtable
12498
12499
12500
12501 .section "Callout cache" "SECID107"
12502 .table2
12503 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
12504                                          item"
12505 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
12506                                          item"
12507 .row &%callout_negative_expire%&     "timeout for negative address cache item"
12508 .row &%callout_positive_expire%&     "timeout for positive address cache item"
12509 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
12510 .endtable
12511
12512
12513
12514 .section "TLS" "SECID108"
12515 .table2
12516 .row &%gnutls_require_kx%&           "control GnuTLS key exchanges"
12517 .row &%gnutls_require_mac%&          "control GnuTLS MAC algorithms"
12518 .row &%gnutls_require_protocols%&    "control GnuTLS protocols"
12519 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
12520 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
12521 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12522 .row &%tls_certificate%&             "location of server certificate"
12523 .row &%tls_crl%&                     "certificate revocation list"
12524 .row &%tls_dhparam%&                 "DH parameters for server"
12525 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
12526 .row &%tls_privatekey%&              "location of server private key"
12527 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
12528 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
12529 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
12530 .row &%tls_verify_certificates%&     "expected client certificates"
12531 .row &%tls_verify_hosts%&            "insist on client certificate verify"
12532 .endtable
12533
12534
12535
12536 .section "Local user handling" "SECID109"
12537 .table2
12538 .row &%finduser_retries%&            "useful in NIS environments"
12539 .row &%gecos_name%&                  "used when creating &'Sender:'&"
12540 .row &%gecos_pattern%&               "ditto"
12541 .row &%max_username_length%&         "for systems that truncate"
12542 .row &%unknown_login%&               "used when no login name found"
12543 .row &%unknown_username%&            "ditto"
12544 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
12545 .row &%uucp_from_sender%&            "ditto"
12546 .endtable
12547
12548
12549
12550 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
12551 .table2
12552 .row &%header_maxsize%&              "total size of message header"
12553 .row &%header_line_maxsize%&         "individual header line limit"
12554 .row &%message_size_limit%&          "applies to all messages"
12555 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12556 .row &%received_header_text%&        "expanded to make &'Received:'&"
12557 .row &%received_headers_max%&        "for mail loop detection"
12558 .row &%recipients_max%&              "limit per message"
12559 .row &%recipients_max_reject%&       "permanently reject excess recipients"
12560 .endtable
12561
12562
12563
12564
12565 .section "Non-SMTP incoming messages" "SECID111"
12566 .table2
12567 .row &%receive_timeout%&             "for non-SMTP messages"
12568 .endtable
12569
12570
12571
12572
12573
12574 .section "Incoming SMTP messages" "SECID112"
12575 See also the &'Policy controls'& section above.
12576
12577 .table2
12578 .row &%host_lookup%&                 "host name looked up for these hosts"
12579 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12580 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
12581 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
12582 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
12583 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
12584 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
12585 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12586 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12587 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12588 .row &%smtp_accept_max_per_connection%& "messages per connection"
12589 .row &%smtp_accept_max_per_host%&    "connections from one host"
12590 .row &%smtp_accept_queue%&           "queue mail if more connections"
12591 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12592                                            connection"
12593 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12594 .row &%smtp_active_hostname%&        "host name to use in messages"
12595 .row &%smtp_banner%&                 "text for welcome banner"
12596 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12597 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12598 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
12599 .row &%smtp_etrn_command%&           "what to run for ETRN"
12600 .row &%smtp_etrn_serialize%&         "only one at once"
12601 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
12602 .row &%smtp_max_unknown_commands%&   "before dropping connection"
12603 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
12604 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
12605 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
12606 .row &%smtp_receive_timeout%&        "per command or data line"
12607 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12608 .row &%smtp_return_error_details%&   "give detail on rejections"
12609 .endtable
12610
12611
12612
12613 .section "SMTP extensions" "SECID113"
12614 .table2
12615 .row &%accept_8bitmime%&             "advertise 8BITMIME"
12616 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
12617 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
12618 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
12619 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
12620 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12621 .endtable
12622
12623
12624
12625 .section "Processing messages" "SECID114"
12626 .table2
12627 .row &%allow_domain_literals%&       "recognize domain literal syntax"
12628 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
12629 .row &%allow_utf8_domains%&          "in addresses"
12630 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12631                                       words""&"
12632 .row &%delivery_date_remove%&        "from incoming messages"
12633 .row &%envelope_to_remove%&          "from incoming messages"
12634 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
12635 .row &%headers_charset%&             "default for translations"
12636 .row &%qualify_domain%&              "default for senders"
12637 .row &%qualify_recipient%&           "default for recipients"
12638 .row &%return_path_remove%&          "from incoming messages"
12639 .row &%strip_excess_angle_brackets%& "in addresses"
12640 .row &%strip_trailing_dot%&          "at end of addresses"
12641 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
12642 .endtable
12643
12644
12645
12646 .section "System filter" "SECID115"
12647 .table2
12648 .row &%system_filter%&               "locate system filter"
12649 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
12650                                             directory"
12651 .row &%system_filter_file_transport%& "transport for delivery to a file"
12652 .row &%system_filter_group%&         "group for filter running"
12653 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
12654 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
12655 .row &%system_filter_user%&          "user for filter running"
12656 .endtable
12657
12658
12659
12660 .section "Routing and delivery" "SECID116"
12661 .table2
12662 .row &%disable_ipv6%&                "do no IPv6 processing"
12663 .row &%dns_again_means_nonexist%&    "for broken domains"
12664 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
12665 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
12666 .row &%dns_retrans%&                 "parameter for resolver"
12667 .row &%dns_retry%&                   "parameter for resolver"
12668 .row &%hold_domains%&                "hold delivery for these domains"
12669 .row &%local_interfaces%&            "for routing checks"
12670 .row &%queue_domains%&               "no immediate delivery for these"
12671 .row &%queue_only%&                  "no immediate delivery at all"
12672 .row &%queue_only_file%&             "no immediate delivery if file exists"
12673 .row &%queue_only_load%&             "no immediate delivery if load is high"
12674 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12675 .row &%queue_only_override%&         "allow command line to override"
12676 .row &%queue_run_in_order%&          "order of arrival"
12677 .row &%queue_run_max%&               "of simultaneous queue runners"
12678 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
12679 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12680 .row &%remote_sort_domains%&         "order of remote deliveries"
12681 .row &%retry_data_expire%&           "timeout for retry data"
12682 .row &%retry_interval_max%&          "safety net for retry rules"
12683 .endtable
12684
12685
12686
12687 .section "Bounce and warning messages" "SECID117"
12688 .table2
12689 .row &%bounce_message_file%&         "content of bounce"
12690 .row &%bounce_message_text%&         "content of bounce"
12691 .row &%bounce_return_body%&          "include body if returning message"
12692 .row &%bounce_return_message%&       "include original message in bounce"
12693 .row &%bounce_return_size_limit%&    "limit on returned message"
12694 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
12695 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
12696 .row &%errors_copy%&                 "copy bounce messages"
12697 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
12698 .row &%delay_warning%&               "time schedule"
12699 .row &%delay_warning_condition%&     "condition for warning messages"
12700 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
12701 .row &%smtp_return_error_details%&   "give detail on rejections"
12702 .row &%warn_message_file%&           "content of warning message"
12703 .endtable
12704
12705
12706
12707 .section "Alphabetical list of main options" "SECTalomo"
12708 Those options that undergo string expansion before use are marked with
12709 &dagger;.
12710
12711 .option accept_8bitmime main boolean false
12712 .cindex "8BITMIME"
12713 .cindex "8-bit characters"
12714 This option causes Exim to send 8BITMIME in its response to an SMTP
12715 EHLO command, and to accept the BODY= parameter on MAIL commands.
12716 However, though Exim is 8-bit clean, it is not a protocol converter, and it
12717 takes no steps to do anything special with messages received by this route.
12718 Consequently, this option is turned off by default.
12719
12720 .option acl_not_smtp main string&!! unset
12721 .cindex "&ACL;" "for non-SMTP messages"
12722 .cindex "non-SMTP messages" "ACLs for"
12723 This option defines the ACL that is run when a non-SMTP message has been
12724 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
12725 further details.
12726
12727 .option acl_not_smtp_mime main string&!! unset
12728 This option defines the ACL that is run for individual MIME parts of non-SMTP
12729 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
12730 SMTP messages.
12731
12732 .option acl_not_smtp_start main string&!! unset
12733 .cindex "&ACL;" "at start of non-SMTP message"
12734 .cindex "non-SMTP messages" "ACLs for"
12735 This option defines the ACL that is run before Exim starts reading a
12736 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
12737
12738 .option acl_smtp_auth main string&!! unset
12739 .cindex "&ACL;" "setting up for SMTP commands"
12740 .cindex "AUTH" "ACL for"
12741 This option defines the ACL that is run when an SMTP AUTH command is
12742 received. See chapter &<<CHAPACL>>& for further details.
12743
12744 .option acl_smtp_connect main string&!! unset
12745 .cindex "&ACL;" "on SMTP connection"
12746 This option defines the ACL that is run when an SMTP connection is received.
12747 See chapter &<<CHAPACL>>& for further details.
12748
12749 .option acl_smtp_data main string&!! unset
12750 .cindex "DATA" "ACL for"
12751 This option defines the ACL that is run after an SMTP DATA command has been
12752 processed and the message itself has been received, but before the final
12753 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
12754
12755 .option acl_smtp_etrn main string&!! unset
12756 .cindex "ETRN" "ACL for"
12757 This option defines the ACL that is run when an SMTP ETRN command is
12758 received. See chapter &<<CHAPACL>>& for further details.
12759
12760 .option acl_smtp_expn main string&!! unset
12761 .cindex "EXPN" "ACL for"
12762 This option defines the ACL that is run when an SMTP EXPN command is
12763 received. See chapter &<<CHAPACL>>& for further details.
12764
12765 .option acl_smtp_helo main string&!! unset
12766 .cindex "EHLO" "ACL for"
12767 .cindex "HELO" "ACL for"
12768 This option defines the ACL that is run when an SMTP EHLO or HELO
12769 command is received. See chapter &<<CHAPACL>>& for further details.
12770
12771
12772 .option acl_smtp_mail main string&!! unset
12773 .cindex "MAIL" "ACL for"
12774 This option defines the ACL that is run when an SMTP MAIL command is
12775 received. See chapter &<<CHAPACL>>& for further details.
12776
12777 .option acl_smtp_mailauth main string&!! unset
12778 .cindex "AUTH" "on MAIL command"
12779 This option defines the ACL that is run when there is an AUTH parameter on
12780 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
12781 &<<CHAPSMTPAUTH>>& for details of authentication.
12782
12783 .option acl_smtp_mime main string&!! unset
12784 .cindex "MIME content scanning" "ACL for"
12785 This option is available when Exim is built with the content-scanning
12786 extension. It defines the ACL that is run for each MIME part in a message. See
12787 section &<<SECTscanmimepart>>& for details.
12788
12789 .option acl_smtp_predata main string&!! unset
12790 This option defines the ACL that is run when an SMTP DATA command is
12791 received, before the message itself is received. See chapter &<<CHAPACL>>& for
12792 further details.
12793
12794 .option acl_smtp_quit main string&!! unset
12795 .cindex "QUIT, ACL for"
12796 This option defines the ACL that is run when an SMTP QUIT command is
12797 received. See chapter &<<CHAPACL>>& for further details.
12798
12799 .option acl_smtp_rcpt main string&!! unset
12800 .cindex "RCPT" "ACL for"
12801 This option defines the ACL that is run when an SMTP RCPT command is
12802 received. See chapter &<<CHAPACL>>& for further details.
12803
12804 .option acl_smtp_starttls main string&!! unset
12805 .cindex "STARTTLS, ACL for"
12806 This option defines the ACL that is run when an SMTP STARTTLS command is
12807 received. See chapter &<<CHAPACL>>& for further details.
12808
12809 .option acl_smtp_vrfy main string&!! unset
12810 .cindex "VRFY" "ACL for"
12811 This option defines the ACL that is run when an SMTP VRFY command is
12812 received. See chapter &<<CHAPACL>>& for further details.
12813
12814 .option admin_groups main "string list&!!" unset
12815 .cindex "admin user"
12816 This option is expanded just once, at the start of Exim's processing. If the
12817 current group or any of the supplementary groups of an Exim caller is in this
12818 colon-separated list, the caller has admin privileges. If all your system
12819 programmers are in a specific group, for example, you can give them all Exim
12820 admin privileges by putting that group in &%admin_groups%&. However, this does
12821 not permit them to read Exim's spool files (whose group owner is the Exim gid).
12822 To permit this, you have to add individuals to the Exim group.
12823
12824 .option allow_domain_literals main boolean false
12825 .cindex "domain literal"
12826 If this option is set, the RFC 2822 domain literal format is permitted in
12827 email addresses. The option is not set by default, because the domain literal
12828 format is not normally required these days, and few people know about it. It
12829 has, however, been exploited by mail abusers.
12830
12831 Unfortunately, it seems that some DNS black list maintainers are using this
12832 format to report black listing to postmasters. If you want to accept messages
12833 addressed to your hosts by IP address, you need to set
12834 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
12835 domains (defined in the named domain list &%local_domains%& in the default
12836 configuration). This &"magic string"& matches the domain literal form of all
12837 the local host's IP addresses.
12838
12839
12840 .option allow_mx_to_ip main boolean false
12841 .cindex "MX record" "pointing to IP address"
12842 It appears that more and more DNS zone administrators are breaking the rules
12843 and putting domain names that look like IP addresses on the right hand side of
12844 MX records. Exim follows the rules and rejects this, giving an error message
12845 that explains the mis-configuration. However, some other MTAs support this
12846 practice, so to avoid &"Why can't Exim do this?"& complaints,
12847 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
12848 recommended, except when you have no other choice.
12849
12850 .option allow_utf8_domains main boolean false
12851 .cindex "domain" "UTF-8 characters in"
12852 .cindex "UTF-8" "in domain name"
12853 Lots of discussion is going on about internationalized domain names. One
12854 camp is strongly in favour of just using UTF-8 characters, and it seems
12855 that at least two other MTAs permit this. This option allows Exim users to
12856 experiment if they wish.
12857
12858 If it is set true, Exim's domain parsing function allows valid
12859 UTF-8 multicharacters to appear in domain name components, in addition to
12860 letters, digits, and hyphens. However, just setting this option is not
12861 enough; if you want to look up these domain names in the DNS, you must also
12862 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
12863 suitable setting is:
12864 .code
12865 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
12866   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
12867 .endd
12868 Alternatively, you can just disable this feature by setting
12869 .code
12870 dns_check_names_pattern =
12871 .endd
12872 That is, set the option to an empty string so that no check is done.
12873
12874
12875 .option auth_advertise_hosts main "host list&!!" *
12876 .cindex "authentication" "advertising"
12877 .cindex "AUTH" "advertising"
12878 If any server authentication mechanisms are configured, Exim advertises them in
12879 response to an EHLO command only if the calling host matches this list.
12880 Otherwise, Exim does not advertise AUTH.
12881 Exim does not accept AUTH commands from clients to which it has not
12882 advertised the availability of AUTH. The advertising of individual
12883 authentication mechanisms can be controlled by the use of the
12884 &%server_advertise_condition%& generic authenticator option on the individual
12885 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
12886
12887 Certain mail clients (for example, Netscape) require the user to provide a name
12888 and password for authentication if AUTH is advertised, even though it may
12889 not be needed (the host may accept messages from hosts on its local LAN without
12890 authentication, for example). The &%auth_advertise_hosts%& option can be used
12891 to make these clients more friendly by excluding them from the set of hosts to
12892 which Exim advertises AUTH.
12893
12894 .cindex "AUTH" "advertising when encrypted"
12895 If you want to advertise the availability of AUTH only when the connection
12896 is encrypted using TLS, you can make use of the fact that the value of this
12897 option is expanded, with a setting like this:
12898 .code
12899 auth_advertise_hosts = ${if eq{$tls_cipher}{}{}{*}}
12900 .endd
12901 .vindex "&$tls_cipher$&"
12902 If &$tls_cipher$& is empty, the session is not encrypted, and the result of
12903 the expansion is empty, thus matching no hosts. Otherwise, the result of the
12904 expansion is *, which matches all hosts.
12905
12906
12907 .option auto_thaw main time 0s
12908 .cindex "thawing messages"
12909 .cindex "unfreezing messages"
12910 If this option is set to a time greater than zero, a queue runner will try a
12911 new delivery attempt on any frozen message, other than a bounce message, if
12912 this much time has passed since it was frozen. This may result in the message
12913 being re-frozen if nothing has changed since the last attempt. It is a way of
12914 saying &"keep on trying, even though there are big problems"&.
12915
12916 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
12917 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
12918 thought to be very useful any more, and its use should probably be avoided.
12919
12920 .option av_scanner main string "see below"
12921 This option is available if Exim is built with the content-scanning extension.
12922 It specifies which anti-virus scanner to use. The default value is:
12923 .code
12924 sophie:/var/run/sophie
12925 .endd
12926 If the value of &%av_scanner%& starts with a dollar character, it is expanded
12927 before use. See section &<<SECTscanvirus>>& for further details.
12928
12929
12930
12931 .option bi_command main string unset
12932 .oindex "&%-bi%&"
12933 This option supplies the name of a command that is run when Exim is called with
12934 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
12935 just the command name, it is not a complete command line. If an argument is
12936 required, it must come from the &%-oA%& command line option.
12937
12938
12939 .option bounce_message_file main string unset
12940 .cindex "bounce message" "customizing"
12941 .cindex "customizing" "bounce message"
12942 This option defines a template file containing paragraphs of text to be used
12943 for constructing bounce messages.  Details of the file's contents are given in
12944 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
12945
12946
12947 .option bounce_message_text main string unset
12948 When this option is set, its contents are included in the default bounce
12949 message immediately after &"This message was created automatically by mail
12950 delivery software."& It is not used if &%bounce_message_file%& is set.
12951
12952 .option bounce_return_body main boolean true
12953 .cindex "bounce message" "including body"
12954 This option controls whether the body of an incoming message is included in a
12955 bounce message when &%bounce_return_message%& is true. The default setting
12956 causes the entire message, both header and body, to be returned (subject to the
12957 value of &%bounce_return_size_limit%&). If this option is false, only the
12958 message header is included. In the case of a non-SMTP message containing an
12959 error that is detected during reception, only those header lines preceding the
12960 point at which the error was detected are returned.
12961 .cindex "bounce message" "including original"
12962
12963 .option bounce_return_message main boolean true
12964 If this option is set false, none of the original message is included in
12965 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
12966 &%bounce_return_body%&.
12967
12968
12969 .option bounce_return_size_limit main integer 100K
12970 .cindex "size" "of bounce, limit"
12971 .cindex "bounce message" "size limit"
12972 .cindex "limit" "bounce message size"
12973 This option sets a limit in bytes on the size of messages that are returned to
12974 senders as part of bounce messages when &%bounce_return_message%& is true. The
12975 limit should be less than the value of the global &%message_size_limit%& and of
12976 any &%message_size_limit%& settings on transports, to allow for the bounce text
12977 that Exim generates. If this option is set to zero there is no limit.
12978
12979 When the body of any message that is to be included in a bounce message is
12980 greater than the limit, it is truncated, and a comment pointing this out is
12981 added at the top. The actual cutoff may be greater than the value given, owing
12982 to the use of buffering for transferring the message in chunks (typically 8K in
12983 size). The idea is to save bandwidth on those undeliverable 15-megabyte
12984 messages.
12985
12986 .option bounce_sender_authentication main string unset
12987 .cindex "bounce message" "sender authentication"
12988 .cindex "authentication" "bounce message"
12989 .cindex "AUTH" "on bounce message"
12990 This option provides an authenticated sender address that is sent with any
12991 bounce messages generated by Exim that are sent over an authenticated SMTP
12992 connection. A typical setting might be:
12993 .code
12994 bounce_sender_authentication = mailer-daemon@my.domain.example
12995 .endd
12996 which would cause bounce messages to be sent using the SMTP command:
12997 .code
12998 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
12999 .endd
13000 The value of &%bounce_sender_authentication%& must always be a complete email
13001 address.
13002
13003 .option callout_domain_negative_expire main time 3h
13004 .cindex "caching" "callout timeouts"
13005 .cindex "callout" "caching timeouts"
13006 This option specifies the expiry time for negative callout cache data for a
13007 domain. See section &<<SECTcallver>>& for details of callout verification, and
13008 section &<<SECTcallvercache>>& for details of the caching.
13009
13010
13011 .option callout_domain_positive_expire main time 7d
13012 This option specifies the expiry time for positive callout cache data for a
13013 domain. See section &<<SECTcallver>>& for details of callout verification, and
13014 section &<<SECTcallvercache>>& for details of the caching.
13015
13016
13017 .option callout_negative_expire main time 2h
13018 This option specifies the expiry time for negative callout cache data for an
13019 address. See section &<<SECTcallver>>& for details of callout verification, and
13020 section &<<SECTcallvercache>>& for details of the caching.
13021
13022
13023 .option callout_positive_expire main time 24h
13024 This option specifies the expiry time for positive callout cache data for an
13025 address. See section &<<SECTcallver>>& for details of callout verification, and
13026 section &<<SECTcallvercache>>& for details of the caching.
13027
13028
13029 .option callout_random_local_part main string&!! "see below"
13030 This option defines the &"random"& local part that can be used as part of
13031 callout verification. The default value is
13032 .code
13033 $primary_host_name-$tod_epoch-testing
13034 .endd
13035 See section &<<CALLaddparcall>>& for details of how this value is used.
13036
13037
13038 .option check_log_inodes main integer 0
13039 See &%check_spool_space%& below.
13040
13041
13042 .option check_log_space main integer 0
13043 See &%check_spool_space%& below.
13044
13045 .oindex "&%check_rfc2047_length%&"
13046 .cindex "RFC 2047" "disabling length check"
13047 .option check_rfc2047_length main boolean true
13048 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13049 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13050 word; strings to be encoded that exceed this length are supposed to use
13051 multiple encoded words. By default, Exim does not recognize encoded words that
13052 exceed the maximum length. However, it seems that some software, in violation
13053 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13054 set false, Exim recognizes encoded words of any length.
13055
13056
13057 .option check_spool_inodes main integer 0
13058 See &%check_spool_space%& below.
13059
13060
13061 .option check_spool_space main integer 0
13062 .cindex "checking disk space"
13063 .cindex "disk space, checking"
13064 .cindex "spool directory" "checking space"
13065 The four &%check_...%& options allow for checking of disk resources before a
13066 message is accepted.
13067
13068 .vindex "&$log_inodes$&"
13069 .vindex "&$log_space$&"
13070 .vindex "&$spool_inodes$&"
13071 .vindex "&$spool_space$&"
13072 When any of these options are set, they apply to all incoming messages. If you
13073 want to apply different checks to different kinds of message, you can do so by
13074 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13075 &$spool_space$& in an ACL with appropriate additional conditions.
13076
13077
13078 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13079 either value is greater than zero, for example:
13080 .code
13081 check_spool_space = 10M
13082 check_spool_inodes = 100
13083 .endd
13084 The spool partition is the one that contains the directory defined by
13085 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13086 transit.
13087
13088 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13089 files are written if either is greater than zero. These should be set only if
13090 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13091
13092 If there is less space or fewer inodes than requested, Exim refuses to accept
13093 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13094 error response to the MAIL command. If ESMTP is in use and there was a
13095 SIZE parameter on the MAIL command, its value is added to the
13096 &%check_spool_space%& value, and the check is performed even if
13097 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13098
13099 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13100 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13101
13102 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13103 failure a message is written to stderr and Exim exits with a non-zero code, as
13104 it obviously cannot send an error message of any kind.
13105
13106 .option daemon_smtp_ports main string &`smtp`&
13107 .cindex "port" "for daemon"
13108 .cindex "TCP/IP" "setting listening ports"
13109 This option specifies one or more default SMTP ports on which the Exim daemon
13110 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13111 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13112
13113 .option daemon_startup_retries main integer 9
13114 .cindex "daemon startup, retrying"
13115 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13116 the daemon at startup when it cannot immediately bind a listening socket
13117 (typically because the socket is already in use): &%daemon_startup_retries%&
13118 defines the number of retries after the first failure, and
13119 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13120
13121 .option daemon_startup_sleep main time 30s
13122 See &%daemon_startup_retries%&.
13123
13124 .option delay_warning main "time list" 24h
13125 .cindex "warning of delay"
13126 .cindex "delay warning, specifying"
13127 When a message is delayed, Exim sends a warning message to the sender at
13128 intervals specified by this option. The data is a colon-separated list of times
13129 after which to send warning messages. If the value of the option is an empty
13130 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13131 message has been on the queue for longer than the last time, the last interval
13132 between the times is used to compute subsequent warning times. For example,
13133 with
13134 .code
13135 delay_warning = 4h:8h:24h
13136 .endd
13137 the first message is sent after 4 hours, the second after 8 hours, and
13138 the third one after 24 hours. After that, messages are sent every 16 hours,
13139 because that is the interval between the last two times on the list. If you set
13140 just one time, it specifies the repeat interval. For example, with:
13141 .code
13142 delay_warning = 6h
13143 .endd
13144 messages are repeated every six hours. To stop warnings after a given time, set
13145 a very large time at the end of the list. For example:
13146 .code
13147 delay_warning = 2h:12h:99d
13148 .endd
13149
13150 .option delay_warning_condition main string&!! "see below"
13151 .vindex "&$domain$&"
13152 The string is expanded at the time a warning message might be sent. If all the
13153 deferred addresses have the same domain, it is set in &$domain$& during the
13154 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13155 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13156 &"false"& (the comparison being done caselessly) then the warning message is
13157 not sent. The default is:
13158 .code
13159 delay_warning_condition = ${if or {\
13160   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13161   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13162   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13163   } {no}{yes}}
13164 .endd
13165 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13166 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13167 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13168 &"auto-replied"& in an &'Auto-Submitted:'& header.
13169
13170 .option deliver_drop_privilege main boolean false
13171 .cindex "unprivileged delivery"
13172 .cindex "delivery" "unprivileged"
13173 If this option is set true, Exim drops its root privilege at the start of a
13174 delivery process, and runs as the Exim user throughout. This severely restricts
13175 the kinds of local delivery that are possible, but is viable in certain types
13176 of configuration. There is a discussion about the use of root privilege in
13177 chapter &<<CHAPsecurity>>&.
13178
13179 .option deliver_queue_load_max main fixed-point unset
13180 .cindex "load average"
13181 .cindex "queue runner" "abandoning"
13182 When this option is set, a queue run is abandoned if the system load average
13183 becomes greater than the value of the option. The option has no effect on
13184 ancient operating systems on which Exim cannot determine the load average.
13185 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13186
13187
13188 .option delivery_date_remove main boolean true
13189 .cindex "&'Delivery-date:'& header line"
13190 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13191 message when it is delivered, in exactly the same way as &'Return-path:'& is
13192 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13193 should not be present in incoming messages, and this option causes them to be
13194 removed at the time the message is received, to avoid any problems that might
13195 occur when a delivered message is subsequently sent on to some other recipient.
13196
13197 .option disable_fsync main boolean false
13198 .cindex "&[fsync()]&, disabling"
13199 This option is available only if Exim was built with the compile-time option
13200 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13201 a runtime configuration generates an &"unknown option"& error. You should not
13202 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13203 really, really, really understand what you are doing. &'No pre-compiled
13204 distributions of Exim should ever make this option available.'&
13205
13206 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13207 updated files' data to be written to disc before continuing. Unexpected events
13208 such as crashes and power outages may cause data to be lost or scrambled.
13209 Here be Dragons. &*Beware.*&
13210
13211
13212 .option disable_ipv6 main boolean false
13213 .cindex "IPv6" "disabling"
13214 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13215 activities take place. AAAA records are never looked up, and any IPv6 addresses
13216 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13217 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13218 to handle IPv6 literal addresses.
13219
13220
13221 .option dns_again_means_nonexist main "domain list&!!" unset
13222 .cindex "DNS" "&""try again""& response; overriding"
13223 DNS lookups give a &"try again"& response for the DNS errors
13224 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13225 keep trying to deliver a message, or to give repeated temporary errors to
13226 incoming mail. Sometimes the effect is caused by a badly set up name server and
13227 may persist for a long time. If a domain which exhibits this problem matches
13228 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13229 This option should be used with care. You can make it apply to reverse lookups
13230 by a setting such as this:
13231 .code
13232 dns_again_means_nonexist = *.in-addr.arpa
13233 .endd
13234 This option applies to all DNS lookups that Exim does. It also applies when the
13235 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13236 since these are most likely to be caused by DNS lookup problems. The
13237 &(dnslookup)& router has some options of its own for controlling what happens
13238 when lookups for MX or SRV records give temporary errors. These more specific
13239 options are applied after this global option.
13240
13241 .option dns_check_names_pattern main string "see below"
13242 .cindex "DNS" "pre-check of name syntax"
13243 When this option is set to a non-empty string, it causes Exim to check domain
13244 names for characters that are not allowed in host names before handing them to
13245 the DNS resolver, because some resolvers give temporary errors for names that
13246 contain unusual characters. If a domain name contains any unwanted characters,
13247 a &"not found"& result is forced, and the resolver is not called. The check is
13248 done by matching the domain name against a regular expression, which is the
13249 value of this option. The default pattern is
13250 .code
13251 dns_check_names_pattern = \
13252   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13253 .endd
13254 which permits only letters, digits, slashes, and hyphens in components, but
13255 they must start and end with a letter or digit. Slashes are not, in fact,
13256 permitted in host names, but they are found in certain NS records (which can be
13257 accessed in Exim by using a &%dnsdb%& lookup). If you set
13258 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13259 empty string.
13260
13261 .option dns_csa_search_limit main integer 5
13262 This option controls the depth of parental searching for CSA SRV records in the
13263 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13264
13265 .option dns_csa_use_reverse main boolean true
13266 This option controls whether or not an IP address, given as a CSA domain, is
13267 reversed and looked up in the reverse DNS, as described in more detail in
13268 section &<<SECTverifyCSA>>&.
13269
13270 .option dns_ipv4_lookup main "domain list&!!" unset
13271 .cindex "IPv6" "DNS lookup for AAAA records"
13272 .cindex "DNS" "IPv6 lookup for AAAA records"
13273 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13274 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13275 (A records) when trying to find IP addresses for hosts, unless the host's
13276 domain matches this list.
13277
13278 This is a fudge to help with name servers that give big delays or otherwise do
13279 not work for the AAAA record type. In due course, when the world's name
13280 servers have all been upgraded, there should be no need for this option.
13281
13282
13283 .option dns_retrans main time 0s
13284 .cindex "DNS" "resolver options"
13285 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13286 retransmission and retry parameters for DNS lookups. Values of zero (the
13287 defaults) leave the system default settings unchanged. The first value is the
13288 time between retries, and the second is the number of retries. It isn't
13289 totally clear exactly how these settings affect the total time a DNS lookup may
13290 take. I haven't found any documentation about timeouts on DNS lookups; these
13291 parameter values are available in the external resolver interface structure,
13292 but nowhere does it seem to describe how they are used or what you might want
13293 to set in them.
13294
13295
13296 .option dns_retry main integer 0
13297 See &%dns_retrans%& above.
13298
13299
13300 .option drop_cr main boolean false
13301 This is an obsolete option that is now a no-op. It used to affect the way Exim
13302 handled CR and LF characters in incoming messages. What happens now is
13303 described in section &<<SECTlineendings>>&.
13304
13305 .option dsn_from main "string&!!" "see below"
13306 .cindex "&'From:'& header line" "in bounces"
13307 .cindex "bounce messages" "&'From:'& line, specifying"
13308 This option can be used to vary the contents of &'From:'& header lines in
13309 bounces and other automatically generated messages (&"Delivery Status
13310 Notifications"& &-- hence the name of the option). The default setting is:
13311 .code
13312 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13313 .endd
13314 The value is expanded every time it is needed. If the expansion fails, a
13315 panic is logged, and the default value is used.
13316
13317 .option envelope_to_remove main boolean true
13318 .cindex "&'Envelope-to:'& header line"
13319 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13320 message when it is delivered, in exactly the same way as &'Return-path:'& is
13321 handled. &'Envelope-to:'& records the original recipient address from the
13322 messages's envelope that caused the delivery to happen. Such headers should not
13323 be present in incoming messages, and this option causes them to be removed at
13324 the time the message is received, to avoid any problems that might occur when a
13325 delivered message is subsequently sent on to some other recipient.
13326
13327
13328 .option errors_copy main "string list&!!" unset
13329 .cindex "bounce message" "copy to other address"
13330 .cindex "copy of bounce message"
13331 Setting this option causes Exim to send bcc copies of bounce messages that it
13332 generates to other addresses. &*Note*&: This does not apply to bounce messages
13333 coming from elsewhere. The value of the option is a colon-separated list of
13334 items. Each item consists of a pattern, terminated by white space, followed by
13335 a comma-separated list of email addresses. If a pattern contains spaces, it
13336 must be enclosed in double quotes.
13337
13338 Each pattern is processed in the same way as a single item in an address list
13339 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13340 the bounce message, the message is copied to the addresses on the list. The
13341 items are scanned in order, and once a matching one is found, no further items
13342 are examined. For example:
13343 .code
13344 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13345               rqps@mydomain   hostmaster@mydomain.example,\
13346                               postmaster@mydomain.example
13347 .endd
13348 .vindex "&$domain$&"
13349 .vindex "&$local_part$&"
13350 The address list is expanded before use. The expansion variables &$local_part$&
13351 and &$domain$& are set from the original recipient of the error message, and if
13352 there was any wildcard matching in the pattern, the expansion
13353 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13354 variables &$0$&, &$1$&, etc. are set in the normal way.
13355
13356
13357 .option errors_reply_to main string unset
13358 .cindex "bounce message" "&'Reply-to:'& in"
13359 By default, Exim's bounce and delivery warning messages contain the header line
13360 .display
13361 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13362 .endd
13363 .oindex &%quota_warn_message%&
13364 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13365 A warning message that is generated by the &%quota_warn_message%& option in an
13366 &(appendfile)& transport may contain its own &'From:'& header line that
13367 overrides the default.
13368
13369 Experience shows that people reply to bounce messages. If the
13370 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13371 and warning messages. For example:
13372 .code
13373 errors_reply_to = postmaster@my.domain.example
13374 .endd
13375 The value of the option is not expanded. It must specify a valid RFC 2822
13376 address. However, if a warning message that is generated by the
13377 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13378 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13379 not used.
13380
13381
13382 .option exim_group main string "compile-time configured"
13383 .cindex "gid (group id)" "Exim's own"
13384 .cindex "Exim group"
13385 This option changes the gid under which Exim runs when it gives up root
13386 privilege. The default value is compiled into the binary. The value of this
13387 option is used only when &%exim_user%& is also set. Unless it consists entirely
13388 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13389 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13390 security issues.
13391
13392
13393 .option exim_path main string "see below"
13394 .cindex "Exim binary, path name"
13395 This option specifies the path name of the Exim binary, which is used when Exim
13396 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13397 the directory configured at compile time by the BIN_DIRECTORY setting. It
13398 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13399 other place.
13400 &*Warning*&: Do not use a macro to define the value of this option, because
13401 you will break those Exim utilities that scan the configuration file to find
13402 where the binary is. (They then use the &%-bP%& option to extract option
13403 settings such as the value of &%spool_directory%&.)
13404
13405
13406 .option exim_user main string "compile-time configured"
13407 .cindex "uid (user id)" "Exim's own"
13408 .cindex "Exim user"
13409 This option changes the uid under which Exim runs when it gives up root
13410 privilege. The default value is compiled into the binary. Ownership of the run
13411 time configuration file and the use of the &%-C%& and &%-D%& command line
13412 options is checked against the values in the binary, not what is set here.
13413
13414 Unless it consists entirely of digits, the string is looked up using
13415 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13416 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13417 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13418
13419
13420 .option extra_local_interfaces main "string list" unset
13421 This option defines network interfaces that are to be considered local when
13422 routing, but which are not used for listening by the daemon. See section
13423 &<<SECTreclocipadd>>& for details.
13424
13425
13426 . Allow this long option name to split; give it unsplit as a fifth argument
13427 . for the automatic .oindex that is generated by .option.
13428
13429 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13430          extract_addresses_remove_arguments
13431 .oindex "&%-t%&"
13432 .cindex "command line" "addresses with &%-t%&"
13433 .cindex "Sendmail compatibility" "&%-t%& option"
13434 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13435 are present on the command line when the &%-t%& option is used to build an
13436 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13437 line addresses are removed from the recipients list. This is also how Smail
13438 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13439 command line addresses are added to those obtained from the header lines. When
13440 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13441 argument headers. If it is set false, Exim adds rather than removes argument
13442 addresses.
13443
13444
13445 .option finduser_retries main integer 0
13446 .cindex "NIS, retrying user lookups"
13447 On systems running NIS or other schemes in which user and group information is
13448 distributed from a remote system, there can be times when &[getpwnam()]& and
13449 related functions fail, even when given valid data, because things time out.
13450 Unfortunately these failures cannot be distinguished from genuine &"not found"&
13451 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
13452 many extra times to find a user or a group, waiting for one second between
13453 retries.
13454
13455 .cindex "&_/etc/passwd_&" "multiple reading of"
13456 You should not set this option greater than zero if your user information is in
13457 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
13458 search the file multiple times for non-existent users, and also cause delay.
13459
13460
13461
13462 .option freeze_tell main "string list, comma separated" unset
13463 .cindex "freezing messages" "sending a message when freezing"
13464 On encountering certain errors, or when configured to do so in a system filter,
13465 ACL, or special router, Exim freezes a message. This means that no further
13466 delivery attempts take place until an administrator thaws the message, or the
13467 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
13468 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
13469 warning message whenever it freezes something, unless the message it is
13470 freezing is a locally-generated bounce message. (Without this exception there
13471 is the possibility of looping.) The warning message is sent to the addresses
13472 supplied as the comma-separated value of this option. If several of the
13473 message's addresses cause freezing, only a single message is sent. If the
13474 freezing was automatic, the reason(s) for freezing can be found in the message
13475 log. If you configure freezing in a filter or ACL, you must arrange for any
13476 logging that you require.
13477
13478
13479 .option gecos_name main string&!! unset
13480 .cindex "HP-UX"
13481 .cindex "&""gecos""& field, parsing"
13482 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
13483 password file to hold other information in addition to users' real names. Exim
13484 looks up this field for use when it is creating &'Sender:'& or &'From:'&
13485 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
13486 of the field are used unchanged, except that, if an ampersand is encountered,
13487 it is replaced by the user's login name with the first character forced to
13488 upper case, since this is a convention that is observed on many systems.
13489
13490 When these options are set, &%gecos_pattern%& is treated as a regular
13491 expression that is to be applied to the field (again with && replaced by the
13492 login name), and if it matches, &%gecos_name%& is expanded and used as the
13493 user's name.
13494
13495 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
13496 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
13497 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
13498 name terminates at the first comma, the following can be used:
13499 .code
13500 gecos_pattern = ([^,]*)
13501 gecos_name = $1
13502 .endd
13503
13504 .option gecos_pattern main string unset
13505 See &%gecos_name%& above.
13506
13507
13508 .option gnutls_require_kx main string unset
13509 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
13510 server. For details, see section &<<SECTreqciphgnu>>&.
13511
13512 .option gnutls_require_mac main string unset
13513 This option controls the MAC algorithms when GnuTLS is used in an Exim
13514 server. For details, see section &<<SECTreqciphgnu>>&.
13515
13516 .option gnutls_require_protocols main string unset
13517 This option controls the protocols when GnuTLS is used in an Exim
13518 server. For details, see section &<<SECTreqciphgnu>>&.
13519
13520 .option gnutls_compat_mode main boolean unset
13521 This option controls whether GnuTLS is used in compatibility mode in an Exim
13522 server. This reduces security slightly, but improves interworking with older
13523 implementations of TLS.
13524
13525 .option headers_charset main string "see below"
13526 This option sets a default character set for translating from encoded MIME
13527 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
13528 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
13529 ultimate default is ISO-8859-1. For more details see the description of header
13530 insertions in section &<<SECTexpansionitems>>&.
13531
13532
13533
13534 .option header_maxsize main integer "see below"
13535 .cindex "header section" "maximum size of"
13536 .cindex "limit" "size of message header section"
13537 This option controls the overall maximum size of a message's header
13538 section. The default is the value of HEADER_MAXSIZE in
13539 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
13540 sections are rejected.
13541
13542
13543 .option header_line_maxsize main integer 0
13544 .cindex "header lines" "maximum size of"
13545 .cindex "limit" "size of one header line"
13546 This option limits the length of any individual header line in a message, after
13547 all the continuations have been joined together. Messages with individual
13548 header lines that are longer than the limit are rejected. The default value of
13549 zero means &"no limit"&.
13550
13551
13552
13553
13554 .option helo_accept_junk_hosts main "host list&!!" unset
13555 .cindex "HELO" "accepting junk data"
13556 .cindex "EHLO" "accepting junk data"
13557 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
13558 mail, and gives an error response for invalid data. Unfortunately, there are
13559 some SMTP clients that send syntactic junk. They can be accommodated by setting
13560 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
13561 if you want to do semantic checking.
13562 See also &%helo_allow_chars%& for a way of extending the permitted character
13563 set.
13564
13565
13566 .option helo_allow_chars main string unset
13567 .cindex "HELO" "underscores in"
13568 .cindex "EHLO" "underscores in"
13569 .cindex "underscore in EHLO/HELO"
13570 This option can be set to a string of rogue characters that are permitted in
13571 all EHLO and HELO names in addition to the standard letters, digits,
13572 hyphens, and dots. If you really must allow underscores, you can set
13573 .code
13574 helo_allow_chars = _
13575 .endd
13576 Note that the value is one string, not a list.
13577
13578
13579 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
13580 .cindex "HELO" "forcing reverse lookup"
13581 .cindex "EHLO" "forcing reverse lookup"
13582 If the domain given by a client in a HELO or EHLO command matches this
13583 list, a reverse lookup is done in order to establish the host's true name. The
13584 default forces a lookup if the client host gives the server's name or any of
13585 its IP addresses (in brackets), something that broken clients have been seen to
13586 do.
13587
13588
13589 .option helo_try_verify_hosts main "host list&!!" unset
13590 .cindex "HELO verifying" "optional"
13591 .cindex "EHLO" "verifying, optional"
13592 By default, Exim just checks the syntax of HELO and EHLO commands (see
13593 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
13594 to do more extensive checking of the data supplied by these commands. The ACL
13595 condition &`verify = helo`& is provided to make this possible.
13596 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
13597 to force the check to occur. From release 4.53 onwards, this is no longer
13598 necessary. If the check has not been done before &`verify = helo`& is
13599 encountered, it is done at that time. Consequently, this option is obsolete.
13600 Its specification is retained here for backwards compatibility.
13601
13602 When an EHLO or HELO command is received, if the calling host matches
13603 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
13604 EHLO command either:
13605
13606 .ilist
13607 is an IP literal matching the calling address of the host, or
13608 .next
13609 .cindex "DNS" "reverse lookup"
13610 .cindex "reverse DNS lookup"
13611 matches the host name that Exim obtains by doing a reverse lookup of the
13612 calling host address, or
13613 .next
13614 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
13615 available) yields the calling host address.
13616 .endlist
13617
13618 However, the EHLO or HELO command is not rejected if any of the checks
13619 fail. Processing continues, but the result of the check is remembered, and can
13620 be detected later in an ACL by the &`verify = helo`& condition.
13621
13622 .option helo_verify_hosts main "host list&!!" unset
13623 .cindex "HELO verifying" "mandatory"
13624 .cindex "EHLO" "verifying, mandatory"
13625 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
13626 backwards compatibility. For hosts that match this option, Exim checks the host
13627 name given in the HELO or EHLO in the same way as for
13628 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
13629 rejected with a 550 error, and entries are written to the main and reject logs.
13630 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
13631 error.
13632
13633 .option hold_domains main "domain list&!!" unset
13634 .cindex "domain" "delaying delivery"
13635 .cindex "delivery" "delaying certain domains"
13636 This option allows mail for particular domains to be held on the queue
13637 manually. The option is overridden if a message delivery is forced with the
13638 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
13639 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
13640 item in &%hold_domains%&, no routing or delivery for that address is done, and
13641 it is deferred every time the message is looked at.
13642
13643 This option is intended as a temporary operational measure for delaying the
13644 delivery of mail while some problem is being sorted out, or some new
13645 configuration tested. If you just want to delay the processing of some
13646 domains until a queue run occurs, you should use &%queue_domains%& or
13647 &%queue_smtp_domains%&, not &%hold_domains%&.
13648
13649 A setting of &%hold_domains%& does not override Exim's code for removing
13650 messages from the queue if they have been there longer than the longest retry
13651 time in any retry rule. If you want to hold messages for longer than the normal
13652 retry times, insert a dummy retry rule with a long retry time.
13653
13654
13655 .option host_lookup main "host list&!!" unset
13656 .cindex "host name" "lookup, forcing"
13657 Exim does not look up the name of a calling host from its IP address unless it
13658 is required to compare against some host list, or the host matches
13659 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
13660 option (which normally contains IP addresses rather than host names). The
13661 default configuration file contains
13662 .code
13663 host_lookup = *
13664 .endd
13665 which causes a lookup to happen for all hosts. If the expense of these lookups
13666 is felt to be too great, the setting can be changed or removed.
13667
13668 After a successful reverse lookup, Exim does a forward lookup on the name it
13669 has obtained, to verify that it yields the IP address that it started with. If
13670 this check fails, Exim behaves as if the name lookup failed.
13671
13672 .vindex "&$host_lookup_failed$&"
13673 .vindex "&$sender_host_name$&"
13674 After any kind of failure, the host name (in &$sender_host_name$&) remains
13675 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
13676 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
13677 &`verify = reverse_host_lookup`& in ACLs.
13678
13679
13680 .option host_lookup_order main "string list" &`bydns:byaddr`&
13681 This option specifies the order of different lookup methods when Exim is trying
13682 to find a host name from an IP address. The default is to do a DNS lookup
13683 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
13684 if that fails. You can change the order of these lookups, or omit one entirely,
13685 if you want.
13686
13687 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
13688 multiple PTR records in the DNS and the IP address is not listed in
13689 &_/etc/hosts_&. Different operating systems give different results in this
13690 case. That is why the default tries a DNS lookup first.
13691
13692
13693
13694 .option host_reject_connection main "host list&!!" unset
13695 .cindex "host" "rejecting connections from"
13696 If this option is set, incoming SMTP calls from the hosts listed are rejected
13697 as soon as the connection is made.
13698 This option is obsolete, and retained only for backward compatibility, because
13699 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
13700 connections immediately.
13701
13702 The ability to give an immediate rejection (either by this option or using an
13703 ACL) is provided for use in unusual cases. Many hosts will just try again,
13704 sometimes without much delay. Normally, it is better to use an ACL to reject
13705 incoming messages at a later stage, such as after RCPT commands. See
13706 chapter &<<CHAPACL>>&.
13707
13708
13709 .option hosts_connection_nolog main "host list&!!" unset
13710 .cindex "host" "not logging connections from"
13711 This option defines a list of hosts for which connection logging does not
13712 happen, even though the &%smtp_connection%& log selector is set. For example,
13713 you might want not to log SMTP connections from local processes, or from
13714 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
13715 the daemon; you should therefore strive to restrict its value to a short inline
13716 list of IP addresses and networks. To disable logging SMTP connections from
13717 local processes, you must create a host list with an empty item. For example:
13718 .code
13719 hosts_connection_nolog = :
13720 .endd
13721 If the &%smtp_connection%& log selector is not set, this option has no effect.
13722
13723
13724
13725 .option hosts_treat_as_local main "domain list&!!" unset
13726 .cindex "local host" "domains treated as"
13727 .cindex "host" "treated as local"
13728 If this option is set, any host names that match the domain list are treated as
13729 if they were the local host when Exim is scanning host lists obtained from MX
13730 records
13731 or other sources. Note that the value of this option is a domain list, not a
13732 host list, because it is always used to check host names, not IP addresses.
13733
13734 This option also applies when Exim is matching the special items
13735 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
13736 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
13737 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
13738 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
13739 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
13740 interfaces and recognizing the local host.
13741
13742
13743 .option ibase_servers main "string list" unset
13744 .cindex "InterBase" "server list"
13745 This option provides a list of InterBase servers and associated connection data,
13746 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
13747 The option is available only if Exim has been built with InterBase support.
13748
13749
13750
13751 .option ignore_bounce_errors_after main time 10w
13752 .cindex "bounce message" "discarding"
13753 .cindex "discarding bounce message"
13754 This option affects the processing of bounce messages that cannot be delivered,
13755 that is, those that suffer a permanent delivery failure. (Bounce messages that
13756 suffer temporary delivery failures are of course retried in the usual way.)
13757
13758 After a permanent delivery failure, bounce messages are frozen,
13759 because there is no sender to whom they can be returned. When a frozen bounce
13760 message has been on the queue for more than the given time, it is unfrozen at
13761 the next queue run, and a further delivery is attempted. If delivery fails
13762 again, the bounce message is discarded. This makes it possible to keep failed
13763 bounce messages around for a shorter time than the normal maximum retry time
13764 for frozen messages. For example,
13765 .code
13766 ignore_bounce_errors_after = 12h
13767 .endd
13768 retries failed bounce message deliveries after 12 hours, discarding any further
13769 failures. If the value of this option is set to a zero time period, bounce
13770 failures are discarded immediately. Setting a very long time (as in the default
13771 value) has the effect of disabling this option. For ways of automatically
13772 dealing with other kinds of frozen message, see &%auto_thaw%& and
13773 &%timeout_frozen_after%&.
13774
13775
13776 .option ignore_fromline_hosts main "host list&!!" unset
13777 .cindex "&""From""& line"
13778 .cindex "UUCP" "&""From""& line"
13779 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
13780 the headers of a message. By default this is treated as the start of the
13781 message's body, which means that any following headers are not recognized as
13782 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
13783 match those hosts that insist on sending it. If the sender is actually a local
13784 process rather than a remote host, and is using &%-bs%& to inject the messages,
13785 &%ignore_fromline_local%& must be set to achieve this effect.
13786
13787
13788 .option ignore_fromline_local main boolean false
13789 See &%ignore_fromline_hosts%& above.
13790
13791
13792 .option keep_malformed main time 4d
13793 This option specifies the length of time to keep messages whose spool files
13794 have been corrupted in some way. This should, of course, never happen. At the
13795 next attempt to deliver such a message, it gets removed. The incident is
13796 logged.
13797
13798
13799 .option ldap_default_servers main "string list" unset
13800 .cindex "LDAP" "default servers"
13801 This option provides a list of LDAP servers which are tried in turn when an
13802 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
13803 details of LDAP queries. This option is available only when Exim has been built
13804 with LDAP support.
13805
13806
13807 .option ldap_version main integer unset
13808 .cindex "LDAP" "protocol version, forcing"
13809 This option can be used to force Exim to set a specific protocol version for
13810 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
13811 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
13812 the LDAP headers; otherwise it is 2. This option is available only when Exim
13813 has been built with LDAP support.
13814
13815
13816
13817 .option local_from_check main boolean true
13818 .cindex "&'Sender:'& header line" "disabling addition of"
13819 .cindex "&'From:'& header line" "disabling checking of"
13820 When a message is submitted locally (that is, not over a TCP/IP connection) by
13821 an untrusted user, Exim removes any existing &'Sender:'& header line, and
13822 checks that the &'From:'& header line matches the login of the calling user and
13823 the domain specified by &%qualify_domain%&.
13824
13825 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
13826 locally submitted message is automatically qualified by Exim, unless the
13827 &%-bnq%& command line option is used.
13828
13829 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
13830 on the local part. If the &'From:'& header line does not match, Exim adds a
13831 &'Sender:'& header with an address constructed from the calling user's login
13832 and the default qualify domain.
13833
13834 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
13835 and no &'Sender:'& header is ever added. If, in addition, you want to retain
13836 &'Sender:'& header lines supplied by untrusted users, you must also set
13837 &%local_sender_retain%& to be true.
13838
13839 .cindex "envelope sender"
13840 These options affect only the header lines in the message. The envelope sender
13841 is still forced to be the login id at the qualify domain unless
13842 &%untrusted_set_sender%& permits the user to supply an envelope sender.
13843
13844 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
13845 request similar header line checking. See section &<<SECTthesenhea>>&, which
13846 has more details about &'Sender:'& processing.
13847
13848
13849
13850
13851 .option local_from_prefix main string unset
13852 When Exim checks the &'From:'& header line of locally submitted messages for
13853 matching the login id (see &%local_from_check%& above), it can be configured to
13854 ignore certain prefixes and suffixes in the local part of the address. This is
13855 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
13856 appropriate lists, in the same form as the &%local_part_prefix%& and
13857 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
13858 example, if
13859 .code
13860 local_from_prefix = *-
13861 .endd
13862 is set, a &'From:'& line containing
13863 .code
13864 From: anything-user@your.domain.example
13865 .endd
13866 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
13867 matches the actual sender address that is constructed from the login name and
13868 qualify domain.
13869
13870
13871 .option local_from_suffix main string unset
13872 See &%local_from_prefix%& above.
13873
13874
13875 .option local_interfaces main "string list" "see below"
13876 This option controls which network interfaces are used by the daemon for
13877 listening; they are also used to identify the local host when routing. Chapter
13878 &<<CHAPinterfaces>>& contains a full description of this option and the related
13879 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
13880 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
13881 &%local_interfaces%& is
13882 .code
13883 local_interfaces = 0.0.0.0
13884 .endd
13885 when Exim is built without IPv6 support; otherwise it is
13886 .code
13887 local_interfaces = <; ::0 ; 0.0.0.0
13888 .endd
13889
13890 .option local_scan_timeout main time 5m
13891 .cindex "timeout" "for &[local_scan()]& function"
13892 .cindex "&[local_scan()]& function" "timeout"
13893 This timeout applies to the &[local_scan()]& function (see chapter
13894 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
13895 the incoming message is rejected with a temporary error if it is an SMTP
13896 message. For a non-SMTP message, the message is dropped and Exim ends with a
13897 non-zero code. The incident is logged on the main and reject logs.
13898
13899
13900
13901 .option local_sender_retain main boolean false
13902 .cindex "&'Sender:'& header line" "retaining from local submission"
13903 When a message is submitted locally (that is, not over a TCP/IP connection) by
13904 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
13905 do not want this to happen, you must set &%local_sender_retain%&, and you must
13906 also set &%local_from_check%& to be false (Exim will complain if you do not).
13907 See also the ACL modifier &`control = suppress_local_fixups`&. Section
13908 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
13909
13910
13911
13912
13913 .option localhost_number main string&!! unset
13914 .cindex "host" "locally unique number for"
13915 .cindex "message ids" "with multiple hosts"
13916 .vindex "&$localhost_number$&"
13917 Exim's message ids are normally unique only within the local host. If
13918 uniqueness among a set of hosts is required, each host must set a different
13919 value for the &%localhost_number%& option. The string is expanded immediately
13920 after reading the configuration file (so that a number can be computed from the
13921 host name, for example) and the result of the expansion must be a number in the
13922 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
13923 systems). This is available in subsequent string expansions via the variable
13924 &$localhost_number$&. When &%localhost_number is set%&, the final two
13925 characters of the message id, instead of just being a fractional part of the
13926 time, are computed from the time and the local host number as described in
13927 section &<<SECTmessiden>>&.
13928
13929
13930
13931 .option log_file_path main "string list&!!" "set at compile time"
13932 .cindex "log" "file path for"
13933 This option sets the path which is used to determine the names of Exim's log
13934 files, or indicates that logging is to be to syslog, or both. It is expanded
13935 when Exim is entered, so it can, for example, contain a reference to the host
13936 name. If no specific path is set for the log files at compile or run time, they
13937 are written in a sub-directory called &_log_& in Exim's spool directory.
13938 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
13939 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
13940 used. If this string is fixed at your installation (contains no expansion
13941 variables) it is recommended that you do not set this option in the
13942 configuration file, but instead supply the path using LOG_FILE_PATH in
13943 &_Local/Makefile_& so that it is available to Exim for logging errors detected
13944 early on &-- in particular, failure to read the configuration file.
13945
13946
13947 .option log_selector main string unset
13948 .cindex "log" "selectors"
13949 This option can be used to reduce or increase the number of things that Exim
13950 writes to its log files. Its argument is made up of names preceded by plus or
13951 minus characters. For example:
13952 .code
13953 log_selector = +arguments -retry_defer
13954 .endd
13955 A list of possible names and what they control is given in the chapter on
13956 logging, in section &<<SECTlogselector>>&.
13957
13958
13959 .option log_timezone main boolean false
13960 .cindex "log" "timezone for entries"
13961 .vindex "&$tod_log$&"
13962 .vindex "&$tod_zone$&"
13963 By default, the timestamps on log lines are in local time without the
13964 timezone. This means that if your timezone changes twice a year, the timestamps
13965 in log lines are ambiguous for an hour when the clocks go back. One way of
13966 avoiding this problem is to set the timezone to UTC. An alternative is to set
13967 &%log_timezone%& true. This turns on the addition of the timezone offset to
13968 timestamps in log lines. Turning on this option can add quite a lot to the size
13969 of log files because each line is extended by 6 characters. Note that the
13970 &$tod_log$& variable contains the log timestamp without the zone, but there is
13971 another variable called &$tod_zone$& that contains just the timezone offset.
13972
13973
13974 .option lookup_open_max main integer 25
13975 .cindex "too many open files"
13976 .cindex "open files, too many"
13977 .cindex "file" "too many open"
13978 .cindex "lookup" "maximum open files"
13979 .cindex "limit" "open files for lookups"
13980 This option limits the number of simultaneously open files for single-key
13981 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
13982 Exim normally keeps these files open during routing, because often the same
13983 file is required several times. If the limit is reached, Exim closes the least
13984 recently used file. Note that if you are using the &'ndbm'& library, it
13985 actually opens two files for each logical DBM database, though it still counts
13986 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
13987 open files"& errors with NDBM, you need to reduce the value of
13988 &%lookup_open_max%&.
13989
13990
13991 .option max_username_length main integer 0
13992 .cindex "length of login name"
13993 .cindex "user name" "maximum length"
13994 .cindex "limit" "user name length"
13995 Some operating systems are broken in that they truncate long arguments to
13996 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
13997 this option is set greater than zero, any attempt to call &[getpwnam()]& with
13998 an argument that is longer behaves as if &[getpwnam()]& failed.
13999
14000
14001 .option message_body_newlines main bool false
14002 .cindex "message body" "newlines in variables"
14003 .cindex "newline" "in message body variables"
14004 .vindex "&$message_body$&"
14005 .vindex "&$message_body_end$&"
14006 By default, newlines in the message body are replaced by spaces when setting
14007 the &$message_body$& and &$message_body_end$& expansion variables. If this
14008 option is set true, this no longer happens.
14009
14010
14011 .option message_body_visible main integer 500
14012 .cindex "body of message" "visible size"
14013 .cindex "message body" "visible size"
14014 .vindex "&$message_body$&"
14015 .vindex "&$message_body_end$&"
14016 This option specifies how much of a message's body is to be included in the
14017 &$message_body$& and &$message_body_end$& expansion variables.
14018
14019
14020 .option message_id_header_domain main string&!! unset
14021 .cindex "&'Message-ID:'& header line"
14022 If this option is set, the string is expanded and used as the right hand side
14023 (domain) of the &'Message-ID:'& header that Exim creates if a
14024 locally-originated incoming message does not have one. &"Locally-originated"&
14025 means &"not received over TCP/IP."&
14026 Otherwise, the primary host name is used.
14027 Only letters, digits, dot and hyphen are accepted; any other characters are
14028 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14029 empty string, the option is ignored.
14030
14031
14032 .option message_id_header_text main string&!! unset
14033 If this variable is set, the string is expanded and used to augment the text of
14034 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14035 message does not have one. The text of this header is required by RFC 2822 to
14036 take the form of an address. By default, Exim uses its internal message id as
14037 the local part, and the primary host name as the domain. If this option is set,
14038 it is expanded, and provided the expansion is not forced to fail, and does not
14039 yield an empty string, the result is inserted into the header immediately
14040 before the @, separated from the internal message id by a dot. Any characters
14041 that are illegal in an address are automatically converted into hyphens. This
14042 means that variables such as &$tod_log$& can be used, because the spaces and
14043 colons will become hyphens.
14044
14045
14046 .option message_logs main boolean true
14047 .cindex "message logs" "disabling"
14048 .cindex "log" "message log; disabling"
14049 If this option is turned off, per-message log files are not created in the
14050 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14051 Exim, by reducing the number of files involved in handling a message from a
14052 minimum of four (header spool file, body spool file, delivery journal, and
14053 per-message log) to three. The other major I/O activity is Exim's main log,
14054 which is not affected by this option.
14055
14056
14057 .option message_size_limit main string&!! 50M
14058 .cindex "message" "size limit"
14059 .cindex "limit" "message size"
14060 .cindex "size" "of message, limit"
14061 This option limits the maximum size of message that Exim will process. The
14062 value is expanded for each incoming connection so, for example, it can be made
14063 to depend on the IP address of the remote host for messages arriving via
14064 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14065 optionally followed by K or M.
14066
14067 &*Note*&: This limit cannot be made to depend on a message's sender or any
14068 other properties of an individual message, because it has to be advertised in
14069 the server's response to EHLO. String expansion failure causes a temporary
14070 error. A value of zero means no limit, but its use is not recommended. See also
14071 &%bounce_return_size_limit%&.
14072
14073 Incoming SMTP messages are failed with a 552 error if the limit is
14074 exceeded; locally-generated messages either get a stderr message or a delivery
14075 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14076 an oversized message is logged in both the main and the reject logs. See also
14077 the generic transport option &%message_size_limit%&, which limits the size of
14078 message that an individual transport can process.
14079
14080 .new
14081 If you use a virus-scanner and set this option to to a value larger than the
14082 maximum size that your virus-scanner is configured to support, you may get
14083 failures triggered by large mails.  The right size to configure for the
14084 virus-scanner depends upon what data is passed and the options in use but it's
14085 probably safest to just set it to a little larger than this value.  Eg, with a
14086 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14087 some problems may result.
14088 .wen
14089
14090
14091 .option move_frozen_messages main boolean false
14092 .cindex "frozen messages" "moving"
14093 This option, which is available only if Exim has been built with the setting
14094 .code
14095 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14096 .endd
14097 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14098 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14099 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14100 standard utilities for handling such moved messages, and they do not show up in
14101 lists generated by &%-bp%& or by the Exim monitor.
14102
14103
14104 .option mua_wrapper main boolean false
14105 Setting this option true causes Exim to run in a very restrictive mode in which
14106 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14107 contains a full description of this facility.
14108
14109
14110
14111 .option mysql_servers main "string list" unset
14112 .cindex "MySQL" "server list"
14113 This option provides a list of MySQL servers and associated connection data, to
14114 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14115 option is available only if Exim has been built with MySQL support.
14116
14117
14118 .option never_users main "string list&!!" unset
14119 This option is expanded just once, at the start of Exim's processing. Local
14120 message deliveries are normally run in processes that are setuid to the
14121 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14122 It is usually desirable to prevent any deliveries from running as root, as a
14123 safety precaution.
14124
14125 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14126 list of users that must not be used for local deliveries. This list is fixed in
14127 the binary and cannot be overridden by the configuration file. By default, it
14128 contains just the single user name &"root"&. The &%never_users%& runtime option
14129 can be used to add more users to the fixed list.
14130
14131 If a message is to be delivered as one of the users on the fixed list or the
14132 &%never_users%& list, an error occurs, and delivery is deferred. A common
14133 example is
14134 .code
14135 never_users = root:daemon:bin
14136 .endd
14137 Including root is redundant if it is also on the fixed list, but it does no
14138 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14139 transport driver.
14140
14141
14142 .new
14143 .option openssl_options main "string list" +dont_insert_empty_fragments
14144 .cindex "OpenSSL "compatibility options"
14145 This option allows an administrator to adjust the SSL options applied
14146 by OpenSSL to connections.  It is given as a space-separated list of items,
14147 each one to be +added or -subtracted from the current value.  The default
14148 value is one option which happens to have been set historically.  You can
14149 remove all options with:
14150 .code
14151 openssl_options = -all
14152 .endd
14153 This option is only available if Exim is built against OpenSSL.  The values
14154 available for this option vary according to the age of your OpenSSL install.
14155 The &"all"& value controls a subset of flags which are available, typically
14156 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14157 list the values known on your system and Exim should support all the
14158 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14159 names lose the leading &"SSL_OP_"& and are lower-cased.
14160
14161 Note that adjusting the options can have severe impact upon the security of
14162 SSL as used by Exim.  It is possible to disable safety checks and shoot
14163 yourself in the foot in various unpleasant ways.  This option should not be
14164 adjusted lightly.  An unrecognised item will be detected at by invoking Exim
14165 with the &%-bV%& flag.
14166
14167 An example:
14168 .code
14169 openssl_options = -all +microsoft_big_sslv3_buffer
14170 .endd
14171 .wen
14172
14173
14174 .option oracle_servers main "string list" unset
14175 .cindex "Oracle" "server list"
14176 This option provides a list of Oracle servers and associated connection data,
14177 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14178 The option is available only if Exim has been built with Oracle support.
14179
14180
14181 .option percent_hack_domains main "domain list&!!" unset
14182 .cindex "&""percent hack""&"
14183 .cindex "source routing" "in email address"
14184 .cindex "address" "source-routed"
14185 The &"percent hack"& is the convention whereby a local part containing a
14186 percent sign is re-interpreted as a new email address, with the percent
14187 replaced by @. This is sometimes called &"source routing"&, though that term is
14188 also applied to RFC 2822 addresses that begin with an @ character. If this
14189 option is set, Exim implements the percent facility for those domains listed,
14190 but no others. This happens before an incoming SMTP address is tested against
14191 an ACL.
14192
14193 &*Warning*&: The &"percent hack"& has often been abused by people who are
14194 trying to get round relaying restrictions. For this reason, it is best avoided
14195 if at all possible. Unfortunately, a number of less security-conscious MTAs
14196 implement it unconditionally. If you are running Exim on a gateway host, and
14197 routing mail through to internal MTAs without processing the local parts, it is
14198 a good idea to reject recipient addresses with percent characters in their
14199 local parts. Exim's default configuration does this.
14200
14201
14202 .option perl_at_start main boolean false
14203 This option is available only when Exim is built with an embedded Perl
14204 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14205
14206
14207 .option perl_startup main string unset
14208 This option is available only when Exim is built with an embedded Perl
14209 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14210
14211
14212 .option pgsql_servers main "string list" unset
14213 .cindex "PostgreSQL lookup type" "server list"
14214 This option provides a list of PostgreSQL servers and associated connection
14215 data, to be used in conjunction with &(pgsql)& lookups (see section
14216 &<<SECID72>>&). The option is available only if Exim has been built with
14217 PostgreSQL support.
14218
14219
14220 .option pid_file_path main string&!! "set at compile time"
14221 .cindex "daemon" "pid file path"
14222 .cindex "pid file, path for"
14223 This option sets the name of the file to which the Exim daemon writes its
14224 process id. The string is expanded, so it can contain, for example, references
14225 to the host name:
14226 .code
14227 pid_file_path = /var/log/$primary_hostname/exim.pid
14228 .endd
14229 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14230 spool directory.
14231 The value set by the option can be overridden by the &%-oP%& command line
14232 option. A pid file is not written if a &"non-standard"& daemon is run by means
14233 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14234
14235
14236 .option pipelining_advertise_hosts main "host list&!!" *
14237 .cindex "PIPELINING" "suppressing advertising"
14238 This option can be used to suppress the advertisement of the SMTP
14239 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14240 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14241 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14242 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14243 that clients will use it; &"out of order"& commands that are &"expected"& do
14244 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14245
14246
14247 .option preserve_message_logs main boolean false
14248 .cindex "message logs" "preserving"
14249 If this option is set, message log files are not deleted when messages are
14250 completed. Instead, they are moved to a sub-directory of the spool directory
14251 called &_msglog.OLD_&, where they remain available for statistical or debugging
14252 purposes. This is a dangerous option to set on systems with any appreciable
14253 volume of mail. Use with care!
14254
14255
14256 .option primary_hostname main string "see below"
14257 .cindex "name" "of local host"
14258 .cindex "host" "name of local"
14259 .cindex "local host" "name of"
14260 .vindex "&$primary_hostname$&"
14261 This specifies the name of the current host. It is used in the default EHLO or
14262 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14263 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14264 The value is also used by default in some SMTP response messages from an Exim
14265 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14266
14267 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14268 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14269 contains only one component, Exim passes it to &[gethostbyname()]& (or
14270 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14271 version. The variable &$primary_hostname$& contains the host name, whether set
14272 explicitly by this option, or defaulted.
14273
14274
14275 .option print_topbitchars main boolean false
14276 .cindex "printing characters"
14277 .cindex "8-bit characters"
14278 By default, Exim considers only those characters whose codes lie in the range
14279 32&--126 to be printing characters. In a number of circumstances (for example,
14280 when writing log entries) non-printing characters are converted into escape
14281 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14282 is set, code values of 128 and above are also considered to be printing
14283 characters.
14284
14285 This option also affects the header syntax checks performed by the
14286 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14287 the user's full name when constructing From: and Sender: addresses (as
14288 described in section &<<SECTconstr>>&). Setting this option can cause
14289 Exim to generate eight bit message headers that do not conform to the
14290 standards.
14291
14292
14293 .option process_log_path main string unset
14294 .cindex "process log path"
14295 .cindex "log" "process log"
14296 .cindex "&'exiwhat'&"
14297 This option sets the name of the file to which an Exim process writes its
14298 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14299 utility script. If this option is unset, the file called &_exim-process.info_&
14300 in Exim's spool directory is used. The ability to specify the name explicitly
14301 can be useful in environments where two different Exims are running, using
14302 different spool directories.
14303
14304
14305 .option prod_requires_admin main boolean true
14306 .oindex "&%-M%&"
14307 .oindex "&%-R%&"
14308 .oindex "&%-q%&"
14309 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14310 admin user unless &%prod_requires_admin%& is set false. See also
14311 &%queue_list_requires_admin%&.
14312
14313
14314 .option qualify_domain main string "see below"
14315 .cindex "domain" "for qualifying addresses"
14316 .cindex "address" "qualification"
14317 This option specifies the domain name that is added to any envelope sender
14318 addresses that do not have a domain qualification. It also applies to
14319 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
14320 are accepted by default only for locally-generated messages. Qualification is
14321 also applied to addresses in header lines such as &'From:'& and &'To:'& for
14322 locally-generated messages, unless the &%-bnq%& command line option is used.
14323
14324 Messages from external sources must always contain fully qualified addresses,
14325 unless the sending host matches &%sender_unqualified_hosts%& or
14326 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
14327 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
14328 necessary. Internally, Exim always works with fully qualified envelope
14329 addresses. If &%qualify_domain%& is not set, it defaults to the
14330 &%primary_hostname%& value.
14331
14332
14333 .option qualify_recipient main string "see below"
14334 This option allows you to specify a different domain for qualifying recipient
14335 addresses to the one that is used for senders. See &%qualify_domain%& above.
14336
14337
14338
14339 .option queue_domains main "domain list&!!" unset
14340 .cindex "domain" "specifying non-immediate delivery"
14341 .cindex "queueing incoming messages"
14342 .cindex "message" "queueing certain domains"
14343 This option lists domains for which immediate delivery is not required.
14344 A delivery process is started whenever a message is received, but only those
14345 domains that do not match are processed. All other deliveries wait until the
14346 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
14347
14348
14349 .option queue_list_requires_admin main boolean true
14350 .oindex "&%-bp%&"
14351 The &%-bp%& command-line option, which lists the messages that are on the
14352 queue, requires the caller to be an admin user unless
14353 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
14354
14355
14356 .option queue_only main boolean false
14357 .cindex "queueing incoming messages"
14358 .cindex "message" "queueing unconditionally"
14359 If &%queue_only%& is set, a delivery process is not automatically started
14360 whenever a message is received. Instead, the message waits on the queue for the
14361 next queue run. Even if &%queue_only%& is false, incoming messages may not get
14362 delivered immediately when certain conditions (such as heavy load) occur.
14363
14364 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
14365 and &%-odi%& command line options override &%queue_only%& unless
14366 &%queue_only_override%& is set false. See also &%queue_only_file%&,
14367 &%queue_only_load%&, and &%smtp_accept_queue%&.
14368
14369
14370 .option queue_only_file main string unset
14371 .cindex "queueing incoming messages"
14372 .cindex "message" "queueing by file existence"
14373 This option can be set to a colon-separated list of absolute path names, each
14374 one optionally preceded by &"smtp"&. When Exim is receiving a message,
14375 it tests for the existence of each listed path using a call to &[stat()]&. For
14376 each path that exists, the corresponding queueing option is set.
14377 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
14378 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
14379 .code
14380 queue_only_file = smtp/some/file
14381 .endd
14382 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
14383 &_/some/file_& exists.
14384
14385
14386 .option queue_only_load main fixed-point unset
14387 .cindex "load average"
14388 .cindex "queueing incoming messages"
14389 .cindex "message" "queueing by load"
14390 If the system load average is higher than this value, incoming messages from
14391 all sources are queued, and no automatic deliveries are started. If this
14392 happens during local or remote SMTP input, all subsequent messages received on
14393 the same SMTP connection are queued by default, whatever happens to the load in
14394 the meantime, but this can be changed by setting &%queue_only_load_latch%&
14395 false.
14396
14397 Deliveries will subsequently be performed by queue runner processes. This
14398 option has no effect on ancient operating systems on which Exim cannot
14399 determine the load average. See also &%deliver_queue_load_max%& and
14400 &%smtp_load_reserve%&.
14401
14402
14403 .option queue_only_load_latch main boolean true
14404 .cindex "load average" "re-evaluating per message"
14405 When this option is true (the default), once one message has been queued
14406 because the load average is higher than the value set by &%queue_only_load%&,
14407 all subsequent messages received on the same SMTP connection are also queued.
14408 This is a deliberate choice; even though the load average may fall below the
14409 threshold, it doesn't seem right to deliver later messages on the same
14410 connection when not delivering earlier ones. However, there are special
14411 circumstances such as very long-lived connections from scanning appliances
14412 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
14413 should be set false. This causes the value of the load average to be
14414 re-evaluated for each message.
14415
14416
14417 .option queue_only_override main boolean true
14418 .cindex "queueing incoming messages"
14419 When this option is true, the &%-od%&&'x'& command line options override the
14420 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
14421 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
14422 to override; they are accepted, but ignored.
14423
14424
14425 .option queue_run_in_order main boolean false
14426 .cindex "queue runner" "processing messages in order"
14427 If this option is set, queue runs happen in order of message arrival instead of
14428 in an arbitrary order. For this to happen, a complete list of the entire queue
14429 must be set up before the deliveries start. When the queue is all held in a
14430 single directory (the default), a single list is created for both the ordered
14431 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
14432 single list is not created when &%queue_run_in_order%& is false. In this case,
14433 the sub-directories are processed one at a time (in a random order), and this
14434 avoids setting up one huge list for the whole queue. Thus, setting
14435 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
14436 when the queue is large, because of the extra work in setting up the single,
14437 large list. In most situations, &%queue_run_in_order%& should not be set.
14438
14439
14440
14441 .option queue_run_max main integer 5
14442 .cindex "queue runner" "maximum number of"
14443 This controls the maximum number of queue runner processes that an Exim daemon
14444 can run simultaneously. This does not mean that it starts them all at once,
14445 but rather that if the maximum number are still running when the time comes to
14446 start another one, it refrains from starting another one. This can happen with
14447 very large queues and/or very sluggish deliveries. This option does not,
14448 however, interlock with other processes, so additional queue runners can be
14449 started by other means, or by killing and restarting the daemon.
14450
14451 Setting this option to zero does not suppress queue runs; rather, it disables
14452 the limit, allowing any number of simultaneous queue runner processes to be
14453 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
14454 the daemon's command line.
14455
14456 .option queue_smtp_domains main "domain list&!!" unset
14457 .cindex "queueing incoming messages"
14458 .cindex "message" "queueing remote deliveries"
14459 When this option is set, a delivery process is started whenever a message is
14460 received, routing is performed, and local deliveries take place.
14461 However, if any SMTP deliveries are required for domains that match
14462 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
14463 message waits on the queue for the next queue run. Since routing of the message
14464 has taken place, Exim knows to which remote hosts it must be delivered, and so
14465 when the queue run happens, multiple messages for the same host are delivered
14466 over a single SMTP connection. The &%-odqs%& command line option causes all
14467 SMTP deliveries to be queued in this way, and is equivalent to setting
14468 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
14469 &%queue_domains%&.
14470
14471
14472 .option receive_timeout main time 0s
14473 .cindex "timeout" "for non-SMTP input"
14474 This option sets the timeout for accepting a non-SMTP message, that is, the
14475 maximum time that Exim waits when reading a message on the standard input. If
14476 the value is zero, it will wait for ever. This setting is overridden by the
14477 &%-or%& command line option. The timeout for incoming SMTP messages is
14478 controlled by &%smtp_receive_timeout%&.
14479
14480 .option received_header_text main string&!! "see below"
14481 .cindex "customizing" "&'Received:'& header"
14482 .cindex "&'Received:'& header line" "customizing"
14483 This string defines the contents of the &'Received:'& message header that is
14484 added to each message, except for the timestamp, which is automatically added
14485 on at the end (preceded by a semicolon). The string is expanded each time it is
14486 used. If the expansion yields an empty string, no &'Received:'& header line is
14487 added to the message. Otherwise, the string should start with the text
14488 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
14489 header lines. The default setting is:
14490
14491 .code
14492 received_header_text = Received: \
14493   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
14494   {${if def:sender_ident \
14495   {from ${quote_local_part:$sender_ident} }}\
14496   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
14497   by $primary_hostname \
14498   ${if def:received_protocol {with $received_protocol}} \
14499   ${if def:tls_cipher {($tls_cipher)\n\t}}\
14500   (Exim $version_number)\n\t\
14501   ${if def:sender_address \
14502   {(envelope-from <$sender_address>)\n\t}}\
14503   id $message_exim_id\
14504   ${if def:received_for {\n\tfor $received_for}}
14505 .endd
14506
14507 The reference to the TLS cipher is omitted when Exim is built without TLS
14508 support. The use of conditional expansions ensures that this works for both
14509 locally generated messages and messages received from remote hosts, giving
14510 header lines such as the following:
14511 .code
14512 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
14513 by marley.carol.example with esmtp (Exim 4.00)
14514 (envelope-from <bob@carol.example>)
14515 id 16IOWa-00019l-00
14516 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
14517 Received: by scrooge.carol.example with local (Exim 4.00)
14518 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
14519 .endd
14520 Until the body of the message has been received, the timestamp is the time when
14521 the message started to be received. Once the body has arrived, and all policy
14522 checks have taken place, the timestamp is updated to the time at which the
14523 message was accepted.
14524
14525
14526 .option received_headers_max main integer 30
14527 .cindex "loop" "prevention"
14528 .cindex "mail loop prevention"
14529 .cindex "&'Received:'& header line" "counting"
14530 When a message is to be delivered, the number of &'Received:'& headers is
14531 counted, and if it is greater than this parameter, a mail loop is assumed to
14532 have occurred, the delivery is abandoned, and an error message is generated.
14533 This applies to both local and remote deliveries.
14534
14535
14536 .option recipient_unqualified_hosts main "host list&!!" unset
14537 .cindex "unqualified addresses"
14538 .cindex "host" "unqualified addresses from"
14539 This option lists those hosts from which Exim is prepared to accept unqualified
14540 recipient addresses in message envelopes. The addresses are made fully
14541 qualified by the addition of the &%qualify_recipient%& value. This option also
14542 affects message header lines. Exim does not reject unqualified recipient
14543 addresses in headers, but it qualifies them only if the message came from a
14544 host that matches &%recipient_unqualified_hosts%&,
14545 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
14546 option was not set.
14547
14548
14549 .option recipients_max main integer 0
14550 .cindex "limit" "number of recipients"
14551 .cindex "recipient" "maximum number"
14552 If this option is set greater than zero, it specifies the maximum number of
14553 original recipients for any message. Additional recipients that are generated
14554 by aliasing or forwarding do not count. SMTP messages get a 452 response for
14555 all recipients over the limit; earlier recipients are delivered as normal.
14556 Non-SMTP messages with too many recipients are failed, and no deliveries are
14557 done.
14558
14559 .cindex "RCPT" "maximum number of incoming"
14560 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
14561 RCPT commands in a single message.
14562
14563
14564 .option recipients_max_reject main boolean false
14565 If this option is set true, Exim rejects SMTP messages containing too many
14566 recipients by giving 552 errors to the surplus RCPT commands, and a 554
14567 error to the eventual DATA command. Otherwise (the default) it gives a 452
14568 error to the surplus RCPT commands and accepts the message on behalf of the
14569 initial set of recipients. The remote server should then re-send the message
14570 for the remaining recipients at a later time.
14571
14572
14573 .option remote_max_parallel main integer 2
14574 .cindex "delivery" "parallelism for remote"
14575 This option controls parallel delivery of one message to a number of remote
14576 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
14577 does all the remote deliveries for a message one by one. Otherwise, if a single
14578 message has to be delivered to more than one remote host, or if several copies
14579 have to be sent to the same remote host, up to &%remote_max_parallel%&
14580 deliveries are done simultaneously. If more than &%remote_max_parallel%&
14581 deliveries are required, the maximum number of processes are started, and as
14582 each one finishes, another is begun. The order of starting processes is the
14583 same as if sequential delivery were being done, and can be controlled by the
14584 &%remote_sort_domains%& option. If parallel delivery takes place while running
14585 with debugging turned on, the debugging output from each delivery process is
14586 tagged with its process id.
14587
14588 This option controls only the maximum number of parallel deliveries for one
14589 message in one Exim delivery process. Because Exim has no central queue
14590 manager, there is no way of controlling the total number of simultaneous
14591 deliveries if the configuration allows a delivery attempt as soon as a message
14592 is received.
14593
14594 .cindex "number of deliveries"
14595 .cindex "delivery" "maximum number of"
14596 If you want to control the total number of deliveries on the system, you
14597 need to set the &%queue_only%& option. This ensures that all incoming messages
14598 are added to the queue without starting a delivery process. Then set up an Exim
14599 daemon to start queue runner processes at appropriate intervals (probably
14600 fairly often, for example, every minute), and limit the total number of queue
14601 runners by setting the &%queue_run_max%& parameter. Because each queue runner
14602 delivers only one message at a time, the maximum number of deliveries that can
14603 then take place at once is &%queue_run_max%& multiplied by
14604 &%remote_max_parallel%&.
14605
14606 If it is purely remote deliveries you want to control, use
14607 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
14608 doing the SMTP routing before queueing, so that several messages for the same
14609 host will eventually get delivered down the same connection.
14610
14611
14612 .option remote_sort_domains main "domain list&!!" unset
14613 .cindex "sorting remote deliveries"
14614 .cindex "delivery" "sorting remote"
14615 When there are a number of remote deliveries for a message, they are sorted by
14616 domain into the order given by this list. For example,
14617 .code
14618 remote_sort_domains = *.cam.ac.uk:*.uk
14619 .endd
14620 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
14621 then to those in the &%uk%& domain, then to any others.
14622
14623
14624 .option retry_data_expire main time 7d
14625 .cindex "hints database" "data expiry"
14626 This option sets a &"use before"& time on retry information in Exim's hints
14627 database. Any older retry data is ignored. This means that, for example, once a
14628 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
14629 past failures.
14630
14631
14632 .option retry_interval_max main time 24h
14633 .cindex "retry" "limit on interval"
14634 .cindex "limit" "on retry interval"
14635 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
14636 intervals between delivery attempts for messages that cannot be delivered
14637 straight away. This option sets an overall limit to the length of time between
14638 retries. It cannot be set greater than 24 hours; any attempt to do so forces
14639 the default value.
14640
14641
14642 .option return_path_remove main boolean true
14643 .cindex "&'Return-path:'& header line" "removing"
14644 RFC 2821, section 4.4, states that an SMTP server must insert a
14645 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
14646 The &'Return-path:'& header preserves the sender address as received in the
14647 MAIL command. This description implies that this header should not be present
14648 in an incoming message. If &%return_path_remove%& is true, any existing
14649 &'Return-path:'& headers are removed from messages at the time they are
14650 received. Exim's transports have options for adding &'Return-path:'& headers at
14651 the time of delivery. They are normally used only for final local deliveries.
14652
14653
14654 .option return_size_limit main integer 100K
14655 This option is an obsolete synonym for &%bounce_return_size_limit%&.
14656
14657
14658 .option rfc1413_hosts main "host list&!!" *
14659 .cindex "RFC 1413"
14660 .cindex "host" "for RFC 1413 calls"
14661 RFC 1413 identification calls are made to any client host which matches an item
14662 in the list.
14663
14664 .option rfc1413_query_timeout main time 5s
14665 .cindex "RFC 1413" "query timeout"
14666 .cindex "timeout" "for RFC 1413 call"
14667 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
14668 no RFC 1413 calls are ever made.
14669
14670
14671 .option sender_unqualified_hosts main "host list&!!" unset
14672 .cindex "unqualified addresses"
14673 .cindex "host" "unqualified addresses from"
14674 This option lists those hosts from which Exim is prepared to accept unqualified
14675 sender addresses. The addresses are made fully qualified by the addition of
14676 &%qualify_domain%&. This option also affects message header lines. Exim does
14677 not reject unqualified addresses in headers that contain sender addresses, but
14678 it qualifies them only if the message came from a host that matches
14679 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
14680 using TCP/IP), and the &%-bnq%& option was not set.
14681
14682
14683 .option smtp_accept_keepalive main boolean true
14684 .cindex "keepalive" "on incoming connection"
14685 This option controls the setting of the SO_KEEPALIVE option on incoming
14686 TCP/IP socket connections. When set, it causes the kernel to probe idle
14687 connections periodically, by sending packets with &"old"& sequence numbers. The
14688 other end of the connection should send an acknowledgment if the connection is
14689 still okay or a reset if the connection has been aborted. The reason for doing
14690 this is that it has the beneficial effect of freeing up certain types of
14691 connection that can get stuck when the remote host is disconnected without
14692 tidying up the TCP/IP call properly. The keepalive mechanism takes several
14693 hours to detect unreachable hosts.
14694
14695
14696
14697 .option smtp_accept_max main integer 20
14698 .cindex "limit" "incoming SMTP connections"
14699 .cindex "SMTP" "incoming connection count"
14700 .cindex "inetd"
14701 This option specifies the maximum number of simultaneous incoming SMTP calls
14702 that Exim will accept. It applies only to the listening daemon; there is no
14703 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
14704 value is set to zero, no limit is applied. However, it is required to be
14705 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
14706 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
14707
14708 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
14709 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
14710 that limit has not been reached for the client host, &%smtp_accept_reserve%&
14711 and &%smtp_load_reserve%& are then checked before accepting the connection.
14712
14713
14714 .option smtp_accept_max_nonmail main integer 10
14715 .cindex "limit" "non-mail SMTP commands"
14716 .cindex "SMTP" "limiting non-mail commands"
14717 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
14718 the connection if there are too many. This option defines &"too many"&. The
14719 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
14720 client looping sending EHLO, for example. The check is applied only if the
14721 client host matches &%smtp_accept_max_nonmail_hosts%&.
14722
14723 When a new message is expected, one occurrence of RSET is not counted. This
14724 allows a client to send one RSET between messages (this is not necessary,
14725 but some clients do it). Exim also allows one uncounted occurrence of HELO
14726 or EHLO, and one occurrence of STARTTLS between messages. After
14727 starting up a TLS session, another EHLO is expected, and so it too is not
14728 counted. The first occurrence of AUTH in a connection, or immediately
14729 following STARTTLS is not counted. Otherwise, all commands other than
14730 MAIL, RCPT, DATA, and QUIT are counted.
14731
14732
14733 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
14734 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
14735 check by setting this option. The default value makes it apply to all hosts. By
14736 changing the value, you can exclude any badly-behaved hosts that you have to
14737 live with.
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_max_per_ &~&~connection" main integer 1000 &&&
14744          smtp_accept_max_per_connection
14745 .cindex "SMTP" "limiting incoming message count"
14746 .cindex "limit" "messages per SMTP connection"
14747 The value of this option limits the number of MAIL commands that Exim is
14748 prepared to accept over a single SMTP connection, whether or not each command
14749 results in the transfer of a message. After the limit is reached, a 421
14750 response is given to subsequent MAIL commands. This limit is a safety
14751 precaution against a client that goes mad (incidents of this type have been
14752 seen).
14753
14754
14755 .option smtp_accept_max_per_host main string&!! unset
14756 .cindex "limit" "SMTP connections from one host"
14757 .cindex "host" "limiting SMTP connections from"
14758 This option restricts the number of simultaneous IP connections from a single
14759 host (strictly, from a single IP address) to the Exim daemon. The option is
14760 expanded, to enable different limits to be applied to different hosts by
14761 reference to &$sender_host_address$&. Once the limit is reached, additional
14762 connection attempts from the same host are rejected with error code 421. This
14763 is entirely independent of &%smtp_accept_reserve%&. The option's default value
14764 of zero imposes no limit. If this option is set greater than zero, it is
14765 required that &%smtp_accept_max%& be non-zero.
14766
14767 &*Warning*&: When setting this option you should not use any expansion
14768 constructions that take an appreciable amount of time. The expansion and test
14769 happen in the main daemon loop, in order to reject additional connections
14770 without forking additional processes (otherwise a denial-of-service attack
14771 could cause a vast number or processes to be created). While the daemon is
14772 doing this processing, it cannot accept any other incoming connections.
14773
14774
14775
14776 .option smtp_accept_queue main integer 0
14777 .cindex "SMTP" "incoming connection count"
14778 .cindex "queueing incoming messages"
14779 .cindex "message" "queueing by SMTP connection count"
14780 If the number of simultaneous incoming SMTP connections being handled via the
14781 listening daemon exceeds this value, messages received by SMTP are just placed
14782 on the queue; no delivery processes are started automatically. The count is
14783 fixed at the start of an SMTP connection. It cannot be updated in the
14784 subprocess that receives messages, and so the queueing or not queueing applies
14785 to all messages received in the same connection.
14786
14787 A value of zero implies no limit, and clearly any non-zero value is useful only
14788 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
14789 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
14790 various &%-od%&&'x'& command line options.
14791
14792
14793 . Allow this long option name to split; give it unsplit as a fifth argument
14794 . for the automatic .oindex that is generated by .option.
14795
14796 .option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&&
14797          smtp_accept_queue_per_connection
14798 .cindex "queueing incoming messages"
14799 .cindex "message" "queueing by message count"
14800 This option limits the number of delivery processes that Exim starts
14801 automatically when receiving messages via SMTP, whether via the daemon or by
14802 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
14803 and the number of messages received in a single SMTP session exceeds this
14804 number, subsequent messages are placed on the queue, but no delivery processes
14805 are started. This helps to limit the number of Exim processes when a server
14806 restarts after downtime and there is a lot of mail waiting for it on other
14807 systems. On large systems, the default should probably be increased, and on
14808 dial-in client systems it should probably be set to zero (that is, disabled).
14809
14810
14811 .option smtp_accept_reserve main integer 0
14812 .cindex "SMTP" "incoming call count"
14813 .cindex "host" "reserved"
14814 When &%smtp_accept_max%& is set greater than zero, this option specifies a
14815 number of SMTP connections that are reserved for connections from the hosts
14816 that are specified in &%smtp_reserve_hosts%&. The value set in
14817 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
14818 restricted to this number of connections; the option specifies a minimum number
14819 of connection slots for them, not a maximum. It is a guarantee that this group
14820 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
14821 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
14822 individual host.
14823
14824 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
14825 set to 5, once there are 45 active connections (from any hosts), new
14826 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
14827 provided the other criteria for acceptance are met.
14828
14829
14830 .option smtp_active_hostname main string&!! unset
14831 .cindex "host" "name in SMTP responses"
14832 .cindex "SMTP" "host name in responses"
14833 .vindex "&$primary_hostname$&"
14834 This option is provided for multi-homed servers that want to masquerade as
14835 several different hosts. At the start of an incoming SMTP connection, its value
14836 is expanded and used instead of the value of &$primary_hostname$& in SMTP
14837 responses. For example, it is used as domain name in the response to an
14838 incoming HELO or EHLO command.
14839
14840 .vindex "&$smtp_active_hostname$&"
14841 The active hostname is placed in the &$smtp_active_hostname$& variable, which
14842 is saved with any messages that are received. It is therefore available for use
14843 in routers and transports when the message is later delivered.
14844
14845 If this option is unset, or if its expansion is forced to fail, or if the
14846 expansion results in an empty string, the value of &$primary_hostname$& is
14847 used. Other expansion failures cause a message to be written to the main and
14848 panic logs, and the SMTP command receives a temporary error. Typically, the
14849 value of &%smtp_active_hostname%& depends on the incoming interface address.
14850 For example:
14851 .code
14852 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
14853   {cox.mydomain}{box.mydomain}}
14854 .endd
14855
14856 Although &$smtp_active_hostname$& is primarily concerned with incoming
14857 messages, it is also used as the default for HELO commands in callout
14858 verification if there is no remote transport from which to obtain a
14859 &%helo_data%& value.
14860
14861 .option smtp_banner main string&!! "see below"
14862 .cindex "SMTP" "welcome banner"
14863 .cindex "banner for SMTP"
14864 .cindex "welcome banner for SMTP"
14865 .cindex "customizing" "SMTP banner"
14866 This string, which is expanded every time it is used, is output as the initial
14867 positive response to an SMTP connection. The default setting is:
14868 .code
14869 smtp_banner = $smtp_active_hostname ESMTP Exim \
14870   $version_number $tod_full
14871 .endd
14872 Failure to expand the string causes a panic error. If you want to create a
14873 multiline response to the initial SMTP connection, use &"\n"& in the string at
14874 appropriate points, but not at the end. Note that the 220 code is not included
14875 in this string. Exim adds it automatically (several times in the case of a
14876 multiline response).
14877
14878
14879 .option smtp_check_spool_space main boolean true
14880 .cindex "checking disk space"
14881 .cindex "disk space, checking"
14882 .cindex "spool directory" "checking space"
14883 When this option is set, if an incoming SMTP session encounters the SIZE
14884 option on a MAIL command, it checks that there is enough space in the
14885 spool directory's partition to accept a message of that size, while still
14886 leaving free the amount specified by &%check_spool_space%& (even if that value
14887 is zero). If there isn't enough space, a temporary error code is returned.
14888
14889
14890 .option smtp_connect_backlog main integer 20
14891 .cindex "connection backlog"
14892 .cindex "SMTP" "connection backlog"
14893 .cindex "backlog of connections"
14894 This option specifies a maximum number of waiting SMTP connections. Exim passes
14895 this value to the TCP/IP system when it sets up its listener. Once this number
14896 of connections are waiting for the daemon's attention, subsequent connection
14897 attempts are refused at the TCP/IP level. At least, that is what the manuals
14898 say; in some circumstances such connection attempts have been observed to time
14899 out instead. For large systems it is probably a good idea to increase the
14900 value (to 50, say). It also gives some protection against denial-of-service
14901 attacks by SYN flooding.
14902
14903
14904 .option smtp_enforce_sync main boolean true
14905 .cindex "SMTP" "synchronization checking"
14906 .cindex "synchronization checking in SMTP"
14907 The SMTP protocol specification requires the client to wait for a response from
14908 the server at certain points in the dialogue. Without PIPELINING these
14909 synchronization points are after every command; with PIPELINING they are
14910 fewer, but they still exist.
14911
14912 Some spamming sites send out a complete set of SMTP commands without waiting
14913 for any response. Exim protects against this by rejecting a message if the
14914 client has sent further input when it should not have. The error response &"554
14915 SMTP synchronization error"& is sent, and the connection is dropped. Testing
14916 for this error cannot be perfect because of transmission delays (unexpected
14917 input may be on its way but not yet received when Exim checks). However, it
14918 does detect many instances.
14919
14920 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
14921 If you want to disable the check selectively (for example, only for certain
14922 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
14923 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
14924
14925
14926
14927 .option smtp_etrn_command main string&!! unset
14928 .cindex "ETRN" "command to be run"
14929 .vindex "&$domain$&"
14930 If this option is set, the given command is run whenever an SMTP ETRN
14931 command is received from a host that is permitted to issue such commands (see
14932 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
14933 are independently expanded. The expansion variable &$domain$& is set to the
14934 argument of the ETRN command, and no syntax checking is done on it. For
14935 example:
14936 .code
14937 smtp_etrn_command = /etc/etrn_command $domain \
14938                     $sender_host_address
14939 .endd
14940 A new process is created to run the command, but Exim does not wait for it to
14941 complete. Consequently, its status cannot be checked. If the command cannot be
14942 run, a line is written to the panic log, but the ETRN caller still receives
14943 a 250 success response. Exim is normally running under its own uid when
14944 receiving SMTP, so it is not possible for it to change the uid before running
14945 the command.
14946
14947
14948 .option smtp_etrn_serialize main boolean true
14949 .cindex "ETRN" "serializing"
14950 When this option is set, it prevents the simultaneous execution of more than
14951 one identical command as a result of ETRN in an SMTP connection. See
14952 section &<<SECTETRN>>& for details.
14953
14954
14955 .option smtp_load_reserve main fixed-point unset
14956 .cindex "load average"
14957 If the system load average ever gets higher than this, incoming SMTP calls are
14958 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
14959 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
14960 the load is over the limit. The option has no effect on ancient operating
14961 systems on which Exim cannot determine the load average. See also
14962 &%deliver_queue_load_max%& and &%queue_only_load%&.
14963
14964
14965
14966 .option smtp_max_synprot_errors main integer 3
14967 .cindex "SMTP" "limiting syntax and protocol errors"
14968 .cindex "limit" "SMTP syntax and protocol errors"
14969 Exim rejects SMTP commands that contain syntax or protocol errors. In
14970 particular, a syntactically invalid email address, as in this command:
14971 .code
14972 RCPT TO:<abc xyz@a.b.c>
14973 .endd
14974 causes immediate rejection of the command, before any other tests are done.
14975 (The ACL cannot be run if there is no valid address to set up for it.) An
14976 example of a protocol error is receiving RCPT before MAIL. If there are
14977 too many syntax or protocol errors in one SMTP session, the connection is
14978 dropped. The limit is set by this option.
14979
14980 .cindex "PIPELINING" "expected errors"
14981 When the PIPELINING extension to SMTP is in use, some protocol errors are
14982 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
14983 Exim assumes that PIPELINING will be used if it advertises it (see
14984 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
14985 not count towards the limit.
14986
14987
14988
14989 .option smtp_max_unknown_commands main integer 3
14990 .cindex "SMTP" "limiting unknown commands"
14991 .cindex "limit" "unknown SMTP commands"
14992 If there are too many unrecognized commands in an incoming SMTP session, an
14993 Exim server drops the connection. This is a defence against some kinds of abuse
14994 that subvert web
14995 clients
14996 into making connections to SMTP ports; in these circumstances, a number of
14997 non-SMTP command lines are sent first.
14998
14999
15000
15001 .option smtp_ratelimit_hosts main "host list&!!" unset
15002 .cindex "SMTP" "rate limiting"
15003 .cindex "limit" "rate of message arrival"
15004 .cindex "RCPT" "rate limiting"
15005 Some sites find it helpful to be able to limit the rate at which certain hosts
15006 can send them messages, and the rate at which an individual message can specify
15007 recipients.
15008
15009 Exim has two rate-limiting facilities. This section describes the older
15010 facility, which can limit rates within a single connection. The newer
15011 &%ratelimit%& ACL condition can limit rates across all connections. See section
15012 &<<SECTratelimiting>>& for details of the newer facility.
15013
15014 When a host matches &%smtp_ratelimit_hosts%&, the values of
15015 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15016 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15017 respectively. Each option, if set, must contain a set of four comma-separated
15018 values:
15019
15020 .ilist
15021 A threshold, before which there is no rate limiting.
15022 .next
15023 An initial time delay. Unlike other times in Exim, numbers with decimal
15024 fractional parts are allowed here.
15025 .next
15026 A factor by which to increase the delay each time.
15027 .next
15028 A maximum value for the delay. This should normally be less than 5 minutes,
15029 because after that time, the client is liable to timeout the SMTP command.
15030 .endlist
15031
15032 For example, these settings have been used successfully at the site which
15033 first suggested this feature, for controlling mail from their customers:
15034 .code
15035 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15036 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15037 .endd
15038 The first setting specifies delays that are applied to MAIL commands after
15039 two have been received over a single connection. The initial delay is 0.5
15040 seconds, increasing by a factor of 1.05 each time. The second setting applies
15041 delays to RCPT commands when more than four occur in a single message.
15042
15043
15044 .option smtp_ratelimit_mail main string unset
15045 See &%smtp_ratelimit_hosts%& above.
15046
15047
15048 .option smtp_ratelimit_rcpt main string unset
15049 See &%smtp_ratelimit_hosts%& above.
15050
15051
15052 .option smtp_receive_timeout main time 5m
15053 .cindex "timeout" "for SMTP input"
15054 .cindex "SMTP" "input timeout"
15055 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15056 input, including batch SMTP. If a line of input (either an SMTP command or a
15057 data line) is not received within this time, the SMTP connection is dropped and
15058 the message is abandoned.
15059 A line is written to the log containing one of the following messages:
15060 .code
15061 SMTP command timeout on connection from...
15062 SMTP data timeout on connection from...
15063 .endd
15064 The former means that Exim was expecting to read an SMTP command; the latter
15065 means that it was in the DATA phase, reading the contents of a message.
15066
15067
15068 .oindex "&%-os%&"
15069 The value set by this option can be overridden by the
15070 &%-os%& command-line option. A setting of zero time disables the timeout, but
15071 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15072 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15073 timeout is controlled by &%receive_timeout%& and &%-or%&.
15074
15075
15076 .option smtp_reserve_hosts main "host list&!!" unset
15077 This option defines hosts for which SMTP connections are reserved; see
15078 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15079
15080
15081 .option smtp_return_error_details main boolean false
15082 .cindex "SMTP" "details policy failures"
15083 .cindex "policy control" "rejection, returning details"
15084 In the default state, Exim uses bland messages such as
15085 &"Administrative prohibition"& when it rejects SMTP commands for policy
15086 reasons. Many sysadmins like this because it gives away little information
15087 to spammers. However, some other sysadmins who are applying strict checking
15088 policies want to give out much fuller information about failures. Setting
15089 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15090 example, instead of &"Administrative prohibition"&, it might give:
15091 .code
15092 550-Rejected after DATA: '>' missing at end of address:
15093 550 failing address in "From" header is: <user@dom.ain
15094 .endd
15095
15096 .option spamd_address main string "see below"
15097 This option is available when Exim is compiled with the content-scanning
15098 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15099 The default value is
15100 .code
15101 127.0.0.1 783
15102 .endd
15103 See section &<<SECTscanspamass>>& for more details.
15104
15105
15106
15107 .option split_spool_directory main boolean false
15108 .cindex "multiple spool directories"
15109 .cindex "spool directory" "split"
15110 .cindex "directories, multiple"
15111 If this option is set, it causes Exim to split its input directory into 62
15112 subdirectories, each with a single alphanumeric character as its name. The
15113 sixth character of the message id is used to allocate messages to
15114 subdirectories; this is the least significant base-62 digit of the time of
15115 arrival of the message.
15116
15117 Splitting up the spool in this way may provide better performance on systems
15118 where there are long mail queues, by reducing the number of files in any one
15119 directory. The msglog directory is also split up in a similar way to the input
15120 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15121 are still placed in the single directory &_msglog.OLD_&.
15122
15123 It is not necessary to take any special action for existing messages when
15124 changing &%split_spool_directory%&. Exim notices messages that are in the
15125 &"wrong"& place, and continues to process them. If the option is turned off
15126 after a period of being on, the subdirectories will eventually empty and be
15127 automatically deleted.
15128
15129 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15130 changes. Instead of creating a list of all messages in the queue, and then
15131 trying to deliver each one in turn, it constructs a list of those in one
15132 sub-directory and tries to deliver them, before moving on to the next
15133 sub-directory. The sub-directories are processed in a random order. This
15134 spreads out the scanning of the input directories, and uses less memory. It is
15135 particularly beneficial when there are lots of messages on the queue. However,
15136 if &%queue_run_in_order%& is set, none of this new processing happens. The
15137 entire queue has to be scanned and sorted before any deliveries can start.
15138
15139
15140 .option spool_directory main string&!! "set at compile time"
15141 .cindex "spool directory" "path to"
15142 This defines the directory in which Exim keeps its spool, that is, the messages
15143 it is waiting to deliver. The default value is taken from the compile-time
15144 configuration setting, if there is one. If not, this option must be set. The
15145 string is expanded, so it can contain, for example, a reference to
15146 &$primary_hostname$&.
15147
15148 If the spool directory name is fixed on your installation, it is recommended
15149 that you set it at build time rather than from this option, particularly if the
15150 log files are being written to the spool directory (see &%log_file_path%&).
15151 Otherwise log files cannot be used for errors that are detected early on, such
15152 as failures in the configuration file.
15153
15154 By using this option to override the compiled-in path, it is possible to run
15155 tests of Exim without using the standard spool.
15156
15157 .option sqlite_lock_timeout main time 5s
15158 .cindex "sqlite lookup type" "lock timeout"
15159 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15160 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15161
15162 .option strict_acl_vars main boolean false
15163 .cindex "&ACL;" "variables, handling unset"
15164 This option controls what happens if a syntactically valid but undefined ACL
15165 variable is referenced. If it is false (the default), an empty string
15166 is substituted; if it is true, an error is generated. See section
15167 &<<SECTaclvariables>>& for details of ACL variables.
15168
15169 .option strip_excess_angle_brackets main boolean false
15170 .cindex "angle brackets, excess"
15171 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15172 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15173 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15174 passed on to another MTA, the excess angle brackets are not passed on. If this
15175 option is not set, multiple pairs of angle brackets cause a syntax error.
15176
15177
15178 .option strip_trailing_dot main boolean false
15179 .cindex "trailing dot on domain"
15180 .cindex "dot" "trailing on domain"
15181 If this option is set, a trailing dot at the end of a domain in an address is
15182 ignored. If this is in the envelope and the message is passed on to another
15183 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15184 domain causes a syntax error.
15185 However, addresses in header lines are checked only when an ACL requests header
15186 syntax checking.
15187
15188
15189 .option syslog_duplication main boolean true
15190 .cindex "syslog" "duplicate log lines; suppressing"
15191 When Exim is logging to syslog, it writes the log lines for its three
15192 separate logs at different syslog priorities so that they can in principle
15193 be separated on the logging hosts. Some installations do not require this
15194 separation, and in those cases, the duplication of certain log lines is a
15195 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15196 particular log line is written to syslog. For lines that normally go to
15197 both the main log and the reject log, the reject log version (possibly
15198 containing message header lines) is written, at LOG_NOTICE priority.
15199 Lines that normally go to both the main and the panic log are written at
15200 the LOG_ALERT priority.
15201
15202
15203 .option syslog_facility main string unset
15204 .cindex "syslog" "facility; setting"
15205 This option sets the syslog &"facility"& name, used when Exim is logging to
15206 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15207 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15208 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15209 details of Exim's logging.
15210
15211
15212
15213 .option syslog_processname main string &`exim`&
15214 .cindex "syslog" "process name; setting"
15215 This option sets the syslog &"ident"& name, used when Exim is logging to
15216 syslog. The value must be no longer than 32 characters. See chapter
15217 &<<CHAPlog>>& for details of Exim's logging.
15218
15219
15220
15221 .option syslog_timestamp main boolean true
15222 .cindex "syslog" "timestamps"
15223 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15224 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15225 details of Exim's logging.
15226
15227
15228 .option system_filter main string&!! unset
15229 .cindex "filter" "system filter"
15230 .cindex "system filter" "specifying"
15231 .cindex "Sieve filter" "not available for system filter"
15232 This option specifies an Exim filter file that is applied to all messages at
15233 the start of each delivery attempt, before any routing is done. System filters
15234 must be Exim filters; they cannot be Sieve filters. If the system filter
15235 generates any deliveries to files or pipes, or any new mail messages, the
15236 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15237 which transports are to be used. Details of this facility are given in chapter
15238 &<<CHAPsystemfilter>>&.
15239
15240
15241 .option system_filter_directory_transport main string&!! unset
15242 .vindex "&$address_file$&"
15243 This sets the name of the transport driver that is to be used when the
15244 &%save%& command in a system message filter specifies a path ending in &"/"&,
15245 implying delivery of each message into a separate file in some directory.
15246 During the delivery, the variable &$address_file$& contains the path name.
15247
15248
15249 .option system_filter_file_transport main string&!! unset
15250 .cindex "file" "transport for system filter"
15251 This sets the name of the transport driver that is to be used when the &%save%&
15252 command in a system message filter specifies a path not ending in &"/"&. During
15253 the delivery, the variable &$address_file$& contains the path name.
15254
15255 .option system_filter_group main string unset
15256 .cindex "gid (group id)" "system filter"
15257 This option is used only when &%system_filter_user%& is also set. It sets the
15258 gid under which the system filter is run, overriding any gid that is associated
15259 with the user. The value may be numerical or symbolic.
15260
15261 .option system_filter_pipe_transport main string&!! unset
15262 .cindex "&(pipe)& transport" "for system filter"
15263 .vindex "&$address_pipe$&"
15264 This specifies the transport driver that is to be used when a &%pipe%& command
15265 is used in a system filter. During the delivery, the variable &$address_pipe$&
15266 contains the pipe command.
15267
15268
15269 .option system_filter_reply_transport main string&!! unset
15270 .cindex "&(autoreply)& transport" "for system filter"
15271 This specifies the transport driver that is to be used when a &%mail%& command
15272 is used in a system filter.
15273
15274 .new
15275 .option system_filter_user main string unset
15276 .cindex "uid (user id)" "system filter"
15277 If this option is set to root, the system filter is run in the main Exim
15278 delivery process, as root.  Otherwise, the system filter runs in a separate
15279 process, as the given user, defaulting to the Exim run-time user.
15280 Unless the string consists entirely of digits, it
15281 is looked up in the password data. Failure to find the named user causes a
15282 configuration error. The gid is either taken from the password data, or
15283 specified by &%system_filter_group%&. When the uid is specified numerically,
15284 &%system_filter_group%& is required to be set.
15285
15286 If the system filter generates any pipe, file, or reply deliveries, the uid
15287 under which the filter is run is used when transporting them, unless a
15288 transport option overrides.
15289 .wen
15290
15291
15292 .option tcp_nodelay main boolean true
15293 .cindex "daemon" "TCP_NODELAY on sockets"
15294 .cindex "Nagle algorithm"
15295 .cindex "TCP_NODELAY on listening sockets"
15296 If this option is set false, it stops the Exim daemon setting the
15297 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15298 turns off the &"Nagle algorithm"&, which is a way of improving network
15299 performance in interactive (character-by-character) situations. Turning it off
15300 should improve Exim's performance a bit, so that is what happens by default.
15301 However, it appears that some broken clients cannot cope, and time out. Hence
15302 this option. It affects only those sockets that are set up for listening by the
15303 daemon. Sockets created by the smtp transport for delivering mail always set
15304 TCP_NODELAY.
15305
15306
15307 .option timeout_frozen_after main time 0s
15308 .cindex "frozen messages" "timing out"
15309 .cindex "timeout" "frozen messages"
15310 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15311 message of any kind that has been on the queue for longer than the given time
15312 is automatically cancelled at the next queue run. If the frozen message is a
15313 bounce message, it is just discarded; otherwise, a bounce is sent to the
15314 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
15315 If you want to timeout frozen bounce messages earlier than other kinds of
15316 frozen message, see &%ignore_bounce_errors_after%&.
15317
15318 &*Note:*& the default value of zero means no timeouts; with this setting,
15319 frozen messages remain on the queue forever (except for any frozen bounce
15320 messages that are released by &%ignore_bounce_errors_after%&).
15321
15322
15323 .option timezone main string unset
15324 .cindex "timezone, setting"
15325 The value of &%timezone%& is used to set the environment variable TZ while
15326 running Exim (if it is different on entry). This ensures that all timestamps
15327 created by Exim are in the required timezone. If you want all your timestamps
15328 to be in UTC (aka GMT) you should set
15329 .code
15330 timezone = UTC
15331 .endd
15332 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
15333 or, if that is not set, from the value of the TZ environment variable when Exim
15334 is built. If &%timezone%& is set to the empty string, either at build or run
15335 time, any existing TZ variable is removed from the environment when Exim
15336 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
15337 unfortunately not all, operating systems.
15338
15339
15340 .option tls_advertise_hosts main "host list&!!" unset
15341 .cindex "TLS" "advertising"
15342 .cindex "encryption" "on SMTP connection"
15343 .cindex "SMTP" "encrypted connection"
15344 When Exim is built with support for TLS encrypted connections, the availability
15345 of the STARTTLS command to set up an encrypted session is advertised in
15346 response to EHLO only to those client hosts that match this option. See
15347 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
15348
15349
15350 .option tls_certificate main string&!! unset
15351 .cindex "TLS" "server certificate; location of"
15352 .cindex "certificate" "server, location of"
15353 The value of this option is expanded, and must then be the absolute path to a
15354 file which contains the server's certificates. The server's private key is also
15355 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
15356 &<<CHAPTLS>>& for further details.
15357
15358 &*Note*&: The certificates defined by this option are used only when Exim is
15359 receiving incoming messages as a server. If you want to supply certificates for
15360 use when sending messages as a client, you must set the &%tls_certificate%&
15361 option in the relevant &(smtp)& transport.
15362
15363
15364 .option tls_crl main string&!! unset
15365 .cindex "TLS" "server certificate revocation list"
15366 .cindex "certificate" "revocation list for server"
15367 This option specifies a certificate revocation list. The expanded value must
15368 be the name of a file that contains a CRL in PEM format.
15369
15370
15371 .option tls_dhparam main string&!! unset
15372 .cindex "TLS" "D-H parameters for server"
15373 The value of this option is expanded, and must then be the absolute path to
15374 a file which contains the server's DH parameter values.
15375 This is used only for OpenSSL. When Exim is linked with GnuTLS, this option is
15376 ignored. See section &<<SECTopenvsgnu>>& for further details.
15377
15378
15379 .option tls_on_connect_ports main "string list" unset
15380 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
15381 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
15382 set up without waiting for the client to issue a STARTTLS command. For
15383 further details, see section &<<SECTsupobssmt>>&.
15384
15385
15386
15387 .option tls_privatekey main string&!! unset
15388 .cindex "TLS" "server private key; location of"
15389 The value of this option is expanded, and must then be the absolute path to a
15390 file which contains the server's private key. If this option is unset, or if
15391 the expansion is forced to fail, or the result is an empty string, the private
15392 key is assumed to be in the same file as the server's certificates. See chapter
15393 &<<CHAPTLS>>& for further details.
15394
15395
15396 .option tls_remember_esmtp main boolean false
15397 .cindex "TLS" "esmtp state; remembering"
15398 .cindex "TLS" "broken clients"
15399 If this option is set true, Exim violates the RFCs by remembering that it is in
15400 &"esmtp"& state after successfully negotiating a TLS session. This provides
15401 support for broken clients that fail to send a new EHLO after starting a
15402 TLS session.
15403
15404
15405 .option tls_require_ciphers main string&!! unset
15406 .cindex "TLS" "requiring specific ciphers"
15407 .cindex "cipher" "requiring specific"
15408 This option controls which ciphers can be used for incoming TLS connections.
15409 The &(smtp)& transport has an option of the same name for controlling outgoing
15410 connections. This option is expanded for each connection, so can be varied for
15411 different clients if required. The value of this option must be a list of
15412 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
15413 in somewhat different ways. If GnuTLS is being used, the client controls the
15414 preference order of the available ciphers. Details are given in sections
15415 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
15416
15417
15418 .option tls_try_verify_hosts main "host list&!!" unset
15419 .cindex "TLS" "client certificate verification"
15420 .cindex "certificate" "verification of client"
15421 See &%tls_verify_hosts%& below.
15422
15423
15424 .option tls_verify_certificates main string&!! unset
15425 .cindex "TLS" "client certificate verification"
15426 .cindex "certificate" "verification of client"
15427 The value of this option is expanded, and must then be the absolute path to
15428 a file containing permitted certificates for clients that
15429 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
15430 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
15431 directory containing certificate files. This does not work with GnuTLS; the
15432 option must be set to the name of a single file if you are using GnuTLS.
15433
15434
15435 .option tls_verify_hosts main "host list&!!" unset
15436 .cindex "TLS" "client certificate verification"
15437 .cindex "certificate" "verification of client"
15438 This option, along with &%tls_try_verify_hosts%&, controls the checking of
15439 certificates from clients. The expected certificates are defined by
15440 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
15441 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
15442 &%tls_verify_certificates%& is not set.
15443
15444 Any client that matches &%tls_verify_hosts%& is constrained by
15445 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
15446 present one of the listed certificates. If it does not, the connection is
15447 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
15448 the host to use TLS. It can still send SMTP commands through unencrypted
15449 connections. Forcing a client to use TLS has to be done separately using an
15450 ACL to reject inappropriate commands when the connection is not encrypted.
15451
15452 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
15453 matches this option (but not &%tls_verify_hosts%&), Exim requests a
15454 certificate and checks it against &%tls_verify_certificates%&, but does not
15455 abort the connection if there is no certificate or if it does not match. This
15456 state can be detected in an ACL, which makes it possible to implement policies
15457 such as &"accept for relay only if a verified certificate has been received,
15458 but accept for local delivery if encrypted, even without a verified
15459 certificate"&.
15460
15461 Client hosts that match neither of these lists are not asked to present
15462 certificates.
15463
15464
15465 .option trusted_groups main "string list&!!" unset
15466 .cindex "trusted groups"
15467 .cindex "groups" "trusted"
15468 This option is expanded just once, at the start of Exim's processing. If this
15469 option is set, any process that is running in one of the listed groups, or
15470 which has one of them as a supplementary group, is trusted. The groups can be
15471 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
15472 details of what trusted callers are permitted to do. If neither
15473 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
15474 are trusted.
15475
15476 .option trusted_users main "string list&!!" unset
15477 .cindex "trusted users"
15478 .cindex "user" "trusted"
15479 This option is expanded just once, at the start of Exim's processing. If this
15480 option is set, any process that is running as one of the listed users is
15481 trusted. The users can be specified numerically or by name. See section
15482 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
15483 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
15484 Exim user are trusted.
15485
15486 .option unknown_login main string&!! unset
15487 .cindex "uid (user id)" "unknown caller"
15488 .vindex "&$caller_uid$&"
15489 This is a specialized feature for use in unusual configurations. By default, if
15490 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
15491 gives up. The &%unknown_login%& option can be used to set a login name to be
15492 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
15493 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
15494 is used for the user's real name (gecos field), unless this has been set by the
15495 &%-F%& option.
15496
15497 .option unknown_username main string unset
15498 See &%unknown_login%&.
15499
15500 .option untrusted_set_sender main "address list&!!" unset
15501 .cindex "trusted users"
15502 .cindex "sender" "setting by untrusted user"
15503 .cindex "untrusted user setting sender"
15504 .cindex "user" "untrusted setting sender"
15505 .cindex "envelope sender"
15506 When an untrusted user submits a message to Exim using the standard input, Exim
15507 normally creates an envelope sender address from the user's login and the
15508 default qualification domain. Data from the &%-f%& option (for setting envelope
15509 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
15510 is used) is ignored.
15511
15512 However, untrusted users are permitted to set an empty envelope sender address,
15513 to declare that a message should never generate any bounces. For example:
15514 .code
15515 exim -f '<>' user@domain.example
15516 .endd
15517 .vindex "&$sender_ident$&"
15518 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
15519 other envelope sender addresses in a controlled way. When it is set, untrusted
15520 users are allowed to set envelope sender addresses that match any of the
15521 patterns in the list. Like all address lists, the string is expanded. The
15522 identity of the user is in &$sender_ident$&, so you can, for example, restrict
15523 users to setting senders that start with their login ids
15524 followed by a hyphen
15525 by a setting like this:
15526 .code
15527 untrusted_set_sender = ^$sender_ident-
15528 .endd
15529 If you want to allow untrusted users to set envelope sender addresses without
15530 restriction, you can use
15531 .code
15532 untrusted_set_sender = *
15533 .endd
15534 The &%untrusted_set_sender%& option applies to all forms of local input, but
15535 only to the setting of the envelope sender. It does not permit untrusted users
15536 to use the other options which trusted user can use to override message
15537 parameters. Furthermore, it does not stop Exim from removing an existing
15538 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
15539 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
15540 overriding these actions. The handling of the &'Sender:'& header is also
15541 described in section &<<SECTthesenhea>>&.
15542
15543 The log line for a message's arrival shows the envelope sender following
15544 &"<="&. For local messages, the user's login always follows, after &"U="&. In
15545 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
15546 envelope sender address, the user's login is shown in parentheses after the
15547 sender address.
15548
15549
15550 .option uucp_from_pattern main string "see below"
15551 .cindex "&""From""& line"
15552 .cindex "UUCP" "&""From""& line"
15553 Some applications that pass messages to an MTA via a command line interface use
15554 an initial line starting with &"From&~"& to pass the envelope sender. In
15555 particular, this is used by UUCP software. Exim recognizes such a line by means
15556 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
15557 matches, the sender address is constructed by expanding the contents of
15558 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
15559 default pattern recognizes lines in the following two forms:
15560 .code
15561 From ph10 Fri Jan  5 12:35 GMT 1996
15562 From ph10 Fri, 7 Jan 97 14:00:00 GMT
15563 .endd
15564 The pattern can be seen by running
15565 .code
15566 exim -bP uucp_from_pattern
15567 .endd
15568 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
15569 year in the second case. The first word after &"From&~"& is matched in the
15570 regular expression by a parenthesized subpattern. The default value for
15571 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
15572 (&"ph10"& in the example above) as the message's sender. See also
15573 &%ignore_fromline_hosts%&.
15574
15575
15576 .option uucp_from_sender main string&!! &`$1`&
15577 See &%uucp_from_pattern%& above.
15578
15579
15580 .option warn_message_file main string unset
15581 .cindex "warning of delay" "customizing the message"
15582 .cindex "customizing" "warning message"
15583 This option defines a template file containing paragraphs of text to be used
15584 for constructing the warning message which is sent by Exim when a message has
15585 been on the queue for a specified amount of time, as specified by
15586 &%delay_warning%&. Details of the file's contents are given in chapter
15587 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
15588
15589
15590 .option write_rejectlog main boolean true
15591 .cindex "reject log" "disabling"
15592 If this option is set false, Exim no longer writes anything to the reject log.
15593 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
15594 .ecindex IIDconfima
15595 .ecindex IIDmaiconf
15596
15597
15598
15599
15600 . ////////////////////////////////////////////////////////////////////////////
15601 . ////////////////////////////////////////////////////////////////////////////
15602
15603 .chapter "Generic options for routers" "CHAProutergeneric"
15604 .scindex IIDgenoprou1 "options" "generic; for routers"
15605 .scindex IIDgenoprou2 "generic options" "router"
15606 This chapter describes the generic options that apply to all routers.
15607 Those that are preconditions are marked with &Dagger; in the &"use"& field.
15608
15609 For a general description of how a router operates, see sections
15610 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
15611 which the preconditions are tested. The order of expansion of the options that
15612 provide data for a transport is: &%errors_to%&, &%headers_add%&,
15613 &%headers_remove%&, &%transport%&.
15614
15615
15616
15617 .option address_data routers string&!! unset
15618 .cindex "router" "data attached to address"
15619 The string is expanded just before the router is run, that is, after all the
15620 precondition tests have succeeded. If the expansion is forced to fail, the
15621 router declines, the value of &%address_data%& remains unchanged, and the
15622 &%more%& option controls what happens next. Other expansion failures cause
15623 delivery of the address to be deferred.
15624
15625 .vindex "&$address_data$&"
15626 When the expansion succeeds, the value is retained with the address, and can be
15627 accessed using the variable &$address_data$& in the current router, subsequent
15628 routers, and the eventual transport.
15629
15630 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
15631 that runs a user's filter file, the contents of &$address_data$& are accessible
15632 in the filter. This is not normally a problem, because such data is usually
15633 either not confidential or it &"belongs"& to the current user, but if you do
15634 put confidential data into &$address_data$& you need to remember this point.
15635
15636 Even if the router declines or passes, the value of &$address_data$& remains
15637 with the address, though it can be changed by another &%address_data%& setting
15638 on a subsequent router. If a router generates child addresses, the value of
15639 &$address_data$& propagates to them. This also applies to the special kind of
15640 &"child"& that is generated by a router with the &%unseen%& option.
15641
15642 The idea of &%address_data%& is that you can use it to look up a lot of data
15643 for the address once, and then pick out parts of the data later. For example,
15644 you could use a single LDAP lookup to return a string of the form
15645 .code
15646 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
15647 .endd
15648 In the transport you could pick out the mailbox by a setting such as
15649 .code
15650 file = ${extract{mailbox}{$address_data}}
15651 .endd
15652 This makes the configuration file less messy, and also reduces the number of
15653 lookups (though Exim does cache lookups).
15654
15655 .vindex "&$sender_address_data$&"
15656 .vindex "&$address_data$&"
15657 The &%address_data%& facility is also useful as a means of passing information
15658 from one router to another, and from a router to a transport. In addition, if
15659 &$address_data$& is set by a router when verifying a recipient address from an
15660 ACL, it remains available for use in the rest of the ACL statement. After
15661 verifying a sender, the value is transferred to &$sender_address_data$&.
15662
15663
15664
15665 .option address_test routers&!? boolean true
15666 .oindex "&%-bt%&"
15667 .cindex "router" "skipping when address testing"
15668 If this option is set false, the router is skipped when routing is being tested
15669 by means of the &%-bt%& command line option. This can be a convenience when
15670 your first router sends messages to an external scanner, because it saves you
15671 having to set the &"already scanned"& indicator when testing real address
15672 routing.
15673
15674
15675
15676 .option cannot_route_message routers string&!! unset
15677 .cindex "router" "customizing &""cannot route""& message"
15678 .cindex "customizing" "&""cannot route""& message"
15679 This option specifies a text message that is used when an address cannot be
15680 routed because Exim has run out of routers. The default message is
15681 &"Unrouteable address"&. This option is useful only on routers that have
15682 &%more%& set false, or on the very last router in a configuration, because the
15683 value that is used is taken from the last router that is considered. This
15684 includes a router that is skipped because its preconditions are not met, as
15685 well as a router that declines. For example, using the default configuration,
15686 you could put:
15687 .code
15688 cannot_route_message = Remote domain not found in DNS
15689 .endd
15690 on the first router, which is a &(dnslookup)& router with &%more%& set false,
15691 and
15692 .code
15693 cannot_route_message = Unknown local user
15694 .endd
15695 on the final router that checks for local users. If string expansion fails for
15696 this option, the default message is used. Unless the expansion failure was
15697 explicitly forced, a message about the failure is written to the main and panic
15698 logs, in addition to the normal message about the routing failure.
15699
15700
15701 .option caseful_local_part routers boolean false
15702 .cindex "case of local parts"
15703 .cindex "router" "case of local parts"
15704 By default, routers handle the local parts of addresses in a case-insensitive
15705 manner, though the actual case is preserved for transmission with the message.
15706 If you want the case of letters to be significant in a router, you must set
15707 this option true. For individual router options that contain address or local
15708 part lists (for example, &%local_parts%&), case-sensitive matching can be
15709 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
15710 more details.
15711
15712 .vindex "&$local_part$&"
15713 .vindex "&$original_local_part$&"
15714 .vindex "&$parent_local_part$&"
15715 The value of the &$local_part$& variable is forced to lower case while a
15716 router is running unless &%caseful_local_part%& is set. When a router assigns
15717 an address to a transport, the value of &$local_part$& when the transport runs
15718 is the same as it was in the router. Similarly, when a router generates child
15719 addresses by aliasing or forwarding, the values of &$original_local_part$&
15720 and &$parent_local_part$& are those that were used by the redirecting router.
15721
15722 This option applies to the processing of an address by a router. When a
15723 recipient address is being processed in an ACL, there is a separate &%control%&
15724 modifier that can be used to specify case-sensitive processing within the ACL
15725 (see section &<<SECTcontrols>>&).
15726
15727
15728
15729 .option check_local_user routers&!? boolean false
15730 .cindex "local user, checking in router"
15731 .cindex "router" "checking for local user"
15732 .cindex "&_/etc/passwd_&"
15733 .vindex "&$home$&"
15734 When this option is true, Exim checks that the local part of the recipient
15735 address (with affixes removed if relevant) is the name of an account on the
15736 local system. The check is done by calling the &[getpwnam()]& function rather
15737 than trying to read &_/etc/passwd_& directly. This means that other methods of
15738 holding password data (such as NIS) are supported. If the local part is a local
15739 user, &$home$& is set from the password data, and can be tested in other
15740 preconditions that are evaluated after this one (the order of evaluation is
15741 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
15742 overridden by &%router_home_directory%&. If the local part is not a local user,
15743 the router is skipped.
15744
15745 If you want to check that the local part is either the name of a local user
15746 or matches something else, you cannot combine &%check_local_user%& with a
15747 setting of &%local_parts%&, because that specifies the logical &'and'& of the
15748 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
15749 setting to achieve this. For example:
15750 .code
15751 local_parts = passwd;$local_part : lsearch;/etc/other/users
15752 .endd
15753 Note, however, that the side effects of &%check_local_user%& (such as setting
15754 up a home directory) do not occur when a &(passwd)& lookup is used in a
15755 &%local_parts%& (or any other) precondition.
15756
15757
15758
15759 .option condition routers&!? string&!! unset
15760 .cindex "router" "customized precondition"
15761 This option specifies a general precondition test that has to succeed for the
15762 router to be called. The &%condition%& option is the last precondition to be
15763 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
15764 result is a forced failure, or an empty string, or one of the strings &"0"& or
15765 &"no"& or &"false"& (checked without regard to the case of the letters), the
15766 router is skipped, and the address is offered to the next one.
15767
15768 If the result is any other value, the router is run (as this is the last
15769 precondition to be evaluated, all the other preconditions must be true).
15770
15771 .new
15772 This option is unique in that multiple &%condition%& options may be present.
15773 All &%condition%& options must succeed.
15774 .wen
15775
15776 The &%condition%& option provides a means of applying custom conditions to the
15777 running of routers. Note that in the case of a simple conditional expansion,
15778 the default expansion values are exactly what is wanted. For example:
15779 .code
15780 condition = ${if >{$message_age}{600}}
15781 .endd
15782 Because of the default behaviour of the string expansion, this is equivalent to
15783 .code
15784 condition = ${if >{$message_age}{600}{true}{}}
15785 .endd
15786 .new
15787 A multiple condition example, which succeeds:
15788 .code
15789 condition = ${if >{$message_age}{600}}
15790 condition = ${if !eq{${lc:$local_part}}{postmaster}}
15791 condition = foobar
15792 .endd
15793 .wen
15794 If the expansion fails (other than forced failure) delivery is deferred. Some
15795 of the other precondition options are common special cases that could in fact
15796 be specified using &%condition%&.
15797
15798
15799
15800 .option debug_print routers string&!! unset
15801 .cindex "testing" "variables in drivers"
15802 If this option is set and debugging is enabled (see the &%-d%& command line
15803 option), the string is expanded and included in the debugging output.
15804 If expansion of the string fails, the error message is written to the debugging
15805 output, and Exim carries on processing.
15806 This option is provided to help with checking out the values of variables and
15807 so on when debugging router configurations. For example, if a &%condition%&
15808 option appears not to be working, &%debug_print%& can be used to output the
15809 variables it references. The output happens after checks for &%domains%&,
15810 &%local_parts%&, and &%check_local_user%& but before any other preconditions
15811 are tested. A newline is added to the text if it does not end with one.
15812
15813
15814
15815 .option disable_logging routers boolean false
15816 If this option is set true, nothing is logged for any routing errors
15817 or for any deliveries caused by this router. You should not set this option
15818 unless you really, really know what you are doing. See also the generic
15819 transport option of the same name.
15820
15821
15822 .option domains routers&!? "domain list&!!" unset
15823 .cindex "router" "restricting to specific domains"
15824 .vindex "&$domain_data$&"
15825 If this option is set, the router is skipped unless the current domain matches
15826 the list. If the match is achieved by means of a file lookup, the data that the
15827 lookup returned for the domain is placed in &$domain_data$& for use in string
15828 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
15829 a list of the order in which preconditions are evaluated.
15830
15831
15832
15833 .option driver routers string unset
15834 This option must always be set. It specifies which of the available routers is
15835 to be used.
15836
15837
15838
15839 .option errors_to routers string&!! unset
15840 .cindex "envelope sender"
15841 .cindex "router" "changing address for errors"
15842 If a router successfully handles an address, it may assign the address to a
15843 transport for delivery or it may generate child addresses. In both cases, if
15844 there is a delivery problem during later processing, the resulting bounce
15845 message is sent to the address that results from expanding this string,
15846 provided that the address verifies successfully. The &%errors_to%& option is
15847 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
15848
15849 The &%errors_to%& setting associated with an address can be overridden if it
15850 subsequently passes through other routers that have their own &%errors_to%&
15851 settings, or if the message is delivered by a transport with a &%return_path%&
15852 setting.
15853
15854 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
15855 the expansion fails to verify, the errors address associated with the incoming
15856 address is used. At top level, this is the envelope sender. A non-forced
15857 expansion failure causes delivery to be deferred.
15858
15859 If an address for which &%errors_to%& has been set ends up being delivered over
15860 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
15861 any bounces that are generated by other MTAs on the delivery route are also
15862 sent there. You can set &%errors_to%& to the empty string by either of these
15863 settings:
15864 .code
15865 errors_to =
15866 errors_to = ""
15867 .endd
15868 An expansion item that yields an empty string has the same effect. If you do
15869 this, a locally detected delivery error for addresses processed by this router
15870 no longer gives rise to a bounce message; the error is discarded. If the
15871 address is delivered to a remote host, the return path is set to &`<>`&, unless
15872 overridden by the &%return_path%& option on the transport.
15873
15874 .vindex "&$address_data$&"
15875 If for some reason you want to discard local errors, but use a non-empty
15876 MAIL command for remote delivery, you can preserve the original return
15877 path in &$address_data$& in the router, and reinstate it in the transport by
15878 setting &%return_path%&.
15879
15880 The most common use of &%errors_to%& is to direct mailing list bounces to the
15881 manager of the list, as described in section &<<SECTmailinglists>>&, or to
15882 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
15883
15884
15885
15886 .option expn routers&!? boolean true
15887 .cindex "address" "testing"
15888 .cindex "testing" "addresses"
15889 .cindex "EXPN" "router skipping"
15890 .cindex "router" "skipping for EXPN"
15891 If this option is turned off, the router is skipped when testing an address
15892 as a result of processing an SMTP EXPN command. You might, for example,
15893 want to turn it off on a router for users' &_.forward_& files, while leaving it
15894 on for the system alias file.
15895 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
15896 are evaluated.
15897
15898 The use of the SMTP EXPN command is controlled by an ACL (see chapter
15899 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
15900 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
15901
15902
15903
15904 .option fail_verify routers boolean false
15905 .cindex "router" "forcing verification failure"
15906 Setting this option has the effect of setting both &%fail_verify_sender%& and
15907 &%fail_verify_recipient%& to the same value.
15908
15909
15910
15911 .option fail_verify_recipient routers boolean false
15912 If this option is true and an address is accepted by this router when
15913 verifying a recipient, verification fails.
15914
15915
15916
15917 .option fail_verify_sender routers boolean false
15918 If this option is true and an address is accepted by this router when
15919 verifying a sender, verification fails.
15920
15921
15922
15923 .option fallback_hosts routers "string list" unset
15924 .cindex "router" "fallback hosts"
15925 .cindex "fallback" "hosts specified on router"
15926 String expansion is not applied to this option. The argument must be a
15927 colon-separated list of host names or IP addresses. The list separator can be
15928 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
15929 each name or address. In fact, the format of each item is exactly the same as
15930 defined for the list of hosts in a &(manualroute)& router (see section
15931 &<<SECTformatonehostitem>>&).
15932
15933 If a router queues an address for a remote transport, this host list is
15934 associated with the address, and used instead of the transport's fallback host
15935 list. If &%hosts_randomize%& is set on the transport, the order of the list is
15936 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
15937 transport for further details.
15938
15939
15940 .option group routers string&!! "see below"
15941 .cindex "gid (group id)" "local delivery"
15942 .cindex "local transports" "uid and gid"
15943 .cindex "transport" "local"
15944 .cindex "router" "setting group"
15945 When a router queues an address for a transport, and the transport does not
15946 specify a group, the group given here is used when running the delivery
15947 process.
15948 The group may be specified numerically or by name. If expansion fails, the
15949 error is logged and delivery is deferred.
15950 The default is unset, unless &%check_local_user%& is set, when the default
15951 is taken from the password information. See also &%initgroups%& and &%user%&
15952 and the discussion in chapter &<<CHAPenvironment>>&.
15953
15954
15955
15956 .option headers_add routers string&!! unset
15957 .cindex "header lines" "adding"
15958 .cindex "router" "adding header lines"
15959 This option specifies a string of text that is expanded at routing time, and
15960 associated with any addresses that are accepted by the router. However, this
15961 option has no effect when an address is just being verified. The way in which
15962 the text is used to add header lines at transport time is described in section
15963 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
15964 message is in the process of being transported. This means that references to
15965 header lines in string expansions in the transport's configuration do not
15966 &"see"& the added header lines.
15967
15968 The &%headers_add%& option is expanded after &%errors_to%&, but before
15969 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
15970 the expansion is forced to fail, the option has no effect. Other expansion
15971 failures are treated as configuration errors.
15972
15973 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
15974 router that has the &%one_time%& option set.
15975
15976 .cindex "duplicate addresses"
15977 .oindex "&%unseen%&"
15978 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
15979 additions are deleted when the address is passed on to subsequent routers.
15980 For a &%redirect%& router, if a generated address is the same as the incoming
15981 address, this can lead to duplicate addresses with different header
15982 modifications. Exim does not do duplicate deliveries (except, in certain
15983 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
15984 which of the duplicates is discarded, so this ambiguous situation should be
15985 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
15986
15987
15988
15989 .option headers_remove routers string&!! unset
15990 .cindex "header lines" "removing"
15991 .cindex "router" "removing header lines"
15992 This option specifies a string of text that is expanded at routing time, and
15993 associated with any addresses that are accepted by the router. However, this
15994 option has no effect when an address is just being verified. The way in which
15995 the text is used to remove header lines at transport time is described in
15996 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
15997 the message is in the process of being transported. This means that references
15998 to header lines in string expansions in the transport's configuration still
15999 &"see"& the original header lines.
16000
16001 The &%headers_remove%& option is expanded after &%errors_to%& and
16002 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
16003 the option has no effect. Other expansion failures are treated as configuration
16004 errors.
16005
16006 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
16007 router that has the &%one_time%& option set.
16008
16009 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16010 removal requests are deleted when the address is passed on to subsequent
16011 routers, and this can lead to problems with duplicates -- see the similar
16012 warning for &%headers_add%& above.
16013
16014
16015 .option ignore_target_hosts routers "host list&!!" unset
16016 .cindex "IP address" "discarding"
16017 .cindex "router" "discarding IP addresses"
16018 Although this option is a host list, it should normally contain IP address
16019 entries rather than names. If any host that is looked up by the router has an
16020 IP address that matches an item in this list, Exim behaves as if that IP
16021 address did not exist. This option allows you to cope with rogue DNS entries
16022 like
16023 .code
16024 remote.domain.example.  A  127.0.0.1
16025 .endd
16026 by setting
16027 .code
16028 ignore_target_hosts = 127.0.0.1
16029 .endd
16030 on the relevant router. If all the hosts found by a &(dnslookup)& router are
16031 discarded in this way, the router declines. In a conventional configuration, an
16032 attempt to mail to such a domain would normally provoke the &"unrouteable
16033 domain"& error, and an attempt to verify an address in the domain would fail.
16034 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
16035 router declines if presented with one of the listed addresses.
16036
16037 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
16038 means of the first or the second of the following settings, respectively:
16039 .code
16040 ignore_target_hosts = 0.0.0.0/0
16041 ignore_target_hosts = <; 0::0/0
16042 .endd
16043 The pattern in the first line matches all IPv4 addresses, whereas the pattern
16044 in the second line matches all IPv6 addresses.
16045
16046 This option may also be useful for ignoring link-local and site-local IPv6
16047 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
16048 is expanded before use as a list, it is possible to make it dependent on the
16049 domain that is being routed.
16050
16051 .vindex "&$host_address$&"
16052 During its expansion, &$host_address$& is set to the IP address that is being
16053 checked.
16054
16055 .option initgroups routers boolean false
16056 .cindex "additional groups"
16057 .cindex "groups" "additional"
16058 .cindex "local transports" "uid and gid"
16059 .cindex "transport" "local"
16060 If the router queues an address for a transport, and this option is true, and
16061 the uid supplied by the router is not overridden by the transport, the
16062 &[initgroups()]& function is called when running the transport to ensure that
16063 any additional groups associated with the uid are set up. See also &%group%&
16064 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16065
16066
16067
16068 .option local_part_prefix routers&!? "string list" unset
16069 .cindex "router" "prefix for local part"
16070 .cindex "prefix" "for local part, used in router"
16071 If this option is set, the router is skipped unless the local part starts with
16072 one of the given strings, or &%local_part_prefix_optional%& is true. See
16073 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16074 evaluated.
16075
16076 The list is scanned from left to right, and the first prefix that matches is
16077 used. A limited form of wildcard is available; if the prefix begins with an
16078 asterisk, it matches the longest possible sequence of arbitrary characters at
16079 the start of the local part. An asterisk should therefore always be followed by
16080 some character that does not occur in normal local parts.
16081 .cindex "multiple mailboxes"
16082 .cindex "mailbox" "multiple"
16083 Wildcarding can be used to set up multiple user mailboxes, as described in
16084 section &<<SECTmulbox>>&.
16085
16086 .vindex "&$local_part$&"
16087 .vindex "&$local_part_prefix$&"
16088 During the testing of the &%local_parts%& option, and while the router is
16089 running, the prefix is removed from the local part, and is available in the
16090 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16091 the router accepts the address, this remains true during subsequent delivery by
16092 a transport. In particular, the local part that is transmitted in the RCPT
16093 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16094 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16095 the relevant transport.
16096
16097 When an address is being verified, &%local_part_prefix%& affects only the
16098 behaviour of the router. If the callout feature of verification is in use, this
16099 means that the full address, including the prefix, will be used during the
16100 callout.
16101
16102 The prefix facility is commonly used to handle local parts of the form
16103 &%owner-something%&. Another common use is to support local parts of the form
16104 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16105 to tell a user their forwarding is broken &-- by placing a router like this one
16106 immediately before the router that handles &_.forward_& files:
16107 .code
16108 real_localuser:
16109   driver = accept
16110   local_part_prefix = real-
16111   check_local_user
16112   transport = local_delivery
16113 .endd
16114 For security, it would probably be a good idea to restrict the use of this
16115 router to locally-generated messages, using a condition such as this:
16116 .code
16117   condition = ${if match {$sender_host_address}\
16118                          {\N^(|127\.0\.0\.1)$\N}}
16119 .endd
16120
16121 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16122 both conditions must be met if not optional. Care must be taken if wildcards
16123 are used in both a prefix and a suffix on the same router. Different
16124 separator characters must be used to avoid ambiguity.
16125
16126
16127 .option local_part_prefix_optional routers boolean false
16128 See &%local_part_prefix%& above.
16129
16130
16131
16132 .option local_part_suffix routers&!? "string list" unset
16133 .cindex "router" "suffix for local part"
16134 .cindex "suffix for local part" "used in router"
16135 This option operates in the same way as &%local_part_prefix%&, except that the
16136 local part must end (rather than start) with the given string, the
16137 &%local_part_suffix_optional%& option determines whether the suffix is
16138 mandatory, and the wildcard * character, if present, must be the last
16139 character of the suffix. This option facility is commonly used to handle local
16140 parts of the form &%something-request%& and multiple user mailboxes of the form
16141 &%username-foo%&.
16142
16143
16144 .option local_part_suffix_optional routers boolean false
16145 See &%local_part_suffix%& above.
16146
16147
16148
16149 .option local_parts routers&!? "local part list&!!" unset
16150 .cindex "router" "restricting to specific local parts"
16151 .cindex "local part" "checking in router"
16152 The router is run only if the local part of the address matches the list.
16153 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16154 are evaluated, and
16155 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16156 string is expanded, it is possible to make it depend on the domain, for
16157 example:
16158 .code
16159 local_parts = dbm;/usr/local/specials/$domain
16160 .endd
16161 .vindex "&$local_part_data$&"
16162 If the match is achieved by a lookup, the data that the lookup returned
16163 for the local part is placed in the variable &$local_part_data$& for use in
16164 expansions of the router's private options. You might use this option, for
16165 example, if you have a large number of local virtual domains, and you want to
16166 send all postmaster mail to the same place without having to set up an alias in
16167 each virtual domain:
16168 .code
16169 postmaster:
16170   driver = redirect
16171   local_parts = postmaster
16172   data = postmaster@real.domain.example
16173 .endd
16174
16175
16176 .option log_as_local routers boolean "see below"
16177 .cindex "log" "delivery line"
16178 .cindex "delivery" "log line format"
16179 Exim has two logging styles for delivery, the idea being to make local
16180 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16181 recipient address is given just as the local part, without a domain. The use of
16182 this style is controlled by this option. It defaults to true for the &(accept)&
16183 router, and false for all the others. This option applies only when a
16184 router assigns an address to a transport. It has no effect on routers that
16185 redirect addresses.
16186
16187
16188
16189 .option more routers boolean&!! true
16190 The result of string expansion for this option must be a valid boolean value,
16191 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16192 result causes an error, and delivery is deferred. If the expansion is forced to
16193 fail, the default value for the option (true) is used. Other failures cause
16194 delivery to be deferred.
16195
16196 If this option is set false, and the router declines to handle the address, no
16197 further routers are tried, routing fails, and the address is bounced.
16198 .oindex "&%self%&"
16199 However, if the router explicitly passes an address to the following router by
16200 means of the setting
16201 .code
16202 self = pass
16203 .endd
16204 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16205 does not affect the behaviour if one of the precondition tests fails. In that
16206 case, the address is always passed to the next router.
16207
16208 Note that &%address_data%& is not considered to be a precondition. If its
16209 expansion is forced to fail, the router declines, and the value of &%more%&
16210 controls what happens next.
16211
16212
16213 .option pass_on_timeout routers boolean false
16214 .cindex "timeout" "of router"
16215 .cindex "router" "timeout"
16216 If a router times out during a host lookup, it normally causes deferral of the
16217 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16218 router, overriding &%no_more%&. This may be helpful for systems that are
16219 intermittently connected to the Internet, or those that want to pass to a smart
16220 host any messages that cannot immediately be delivered.
16221
16222 There are occasional other temporary errors that can occur while doing DNS
16223 lookups. They are treated in the same way as a timeout, and this option
16224 applies to all of them.
16225
16226
16227
16228 .option pass_router routers string unset
16229 .cindex "router" "go to after &""pass""&"
16230 Routers that recognize the generic &%self%& option (&(dnslookup)&,
16231 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
16232 routing to continue, and overriding a false setting of &%more%&. When one of
16233 these routers returns &"pass"&, the address is normally handed on to the next
16234 router in sequence. This can be changed by setting &%pass_router%& to the name
16235 of another router. However (unlike &%redirect_router%&) the named router must
16236 be below the current router, to avoid loops. Note that this option applies only
16237 to the special case of &"pass"&. It does not apply when a router returns
16238 &"decline"& because it cannot handle an address.
16239
16240
16241
16242 .option redirect_router routers string unset
16243 .cindex "router" "start at after redirection"
16244 Sometimes an administrator knows that it is pointless to reprocess addresses
16245 generated from alias or forward files with the same router again. For
16246 example, if an alias file translates real names into login ids there is no
16247 point searching the alias file a second time, especially if it is a large file.
16248
16249 The &%redirect_router%& option can be set to the name of any router instance.
16250 It causes the routing of any generated addresses to start at the named router
16251 instead of at the first router. This option has no effect if the router in
16252 which it is set does not generate new addresses.
16253
16254
16255
16256 .option require_files routers&!? "string list&!!" unset
16257 .cindex "file" "requiring for router"
16258 .cindex "router" "requiring file existence"
16259 This option provides a general mechanism for predicating the running of a
16260 router on the existence or non-existence of certain files or directories.
16261 Before running a router, as one of its precondition tests, Exim works its way
16262 through the &%require_files%& list, expanding each item separately.
16263
16264 Because the list is split before expansion, any colons in expansion items must
16265 be doubled, or the facility for using a different list separator must be used.
16266 If any expansion is forced to fail, the item is ignored. Other expansion
16267 failures cause routing of the address to be deferred.
16268
16269 If any expanded string is empty, it is ignored. Otherwise, except as described
16270 below, each string must be a fully qualified file path, optionally preceded by
16271 &"!"&. The paths are passed to the &[stat()]& function to test for the
16272 existence of the files or directories. The router is skipped if any paths not
16273 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
16274
16275 .cindex "NFS"
16276 If &[stat()]& cannot determine whether a file exists or not, delivery of
16277 the message is deferred. This can happen when NFS-mounted filesystems are
16278 unavailable.
16279
16280 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
16281 options, so you cannot use it to check for the existence of a file in which to
16282 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
16283 full list of the order in which preconditions are evaluated.) However, as
16284 these options are all expanded, you can use the &%exists%& expansion condition
16285 to make such tests. The &%require_files%& option is intended for checking files
16286 that the router may be going to use internally, or which are needed by a
16287 transport (for example &_.procmailrc_&).
16288
16289 During delivery, the &[stat()]& function is run as root, but there is a
16290 facility for some checking of the accessibility of a file by another user.
16291 This is not a proper permissions check, but just a &"rough"& check that
16292 operates as follows:
16293
16294 If an item in a &%require_files%& list does not contain any forward slash
16295 characters, it is taken to be the user (and optional group, separated by a
16296 comma) to be checked for subsequent files in the list. If no group is specified
16297 but the user is specified symbolically, the gid associated with the uid is
16298 used. For example:
16299 .code
16300 require_files = mail:/some/file
16301 require_files = $local_part:$home/.procmailrc
16302 .endd
16303 If a user or group name in a &%require_files%& list does not exist, the
16304 &%require_files%& condition fails.
16305
16306 Exim performs the check by scanning along the components of the file path, and
16307 checking the access for the given uid and gid. It checks for &"x"& access on
16308 directories, and &"r"& access on the final file. Note that this means that file
16309 access control lists, if the operating system has them, are ignored.
16310
16311 &*Warning 1*&: When the router is being run to verify addresses for an
16312 incoming SMTP message, Exim is not running as root, but under its own uid. This
16313 may affect the result of a &%require_files%& check. In particular, &[stat()]&
16314 may yield the error EACCES (&"Permission denied"&). This means that the Exim
16315 user is not permitted to read one of the directories on the file's path.
16316
16317 &*Warning 2*&: Even when Exim is running as root while delivering a message,
16318 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
16319 without root access. In this case, if a check for access by a particular user
16320 is requested, Exim creates a subprocess that runs as that user, and tries the
16321 check again in that process.
16322
16323 The default action for handling an unresolved EACCES is to consider it to
16324 be caused by a configuration error, and routing is deferred because the
16325 existence or non-existence of the file cannot be determined. However, in some
16326 circumstances it may be desirable to treat this condition as if the file did
16327 not exist. If the file name (or the exclamation mark that precedes the file
16328 name for non-existence) is preceded by a plus sign, the EACCES error is treated
16329 as if the file did not exist. For example:
16330 .code
16331 require_files = +/some/file
16332 .endd
16333 If the router is not an essential part of verification (for example, it
16334 handles users' &_.forward_& files), another solution is to set the &%verify%&
16335 option false so that the router is skipped when verifying.
16336
16337
16338
16339 .option retry_use_local_part routers boolean "see below"
16340 .cindex "hints database" "retry keys"
16341 .cindex "local part" "in retry keys"
16342 When a delivery suffers a temporary routing failure, a retry record is created
16343 in Exim's hints database. For addresses whose routing depends only on the
16344 domain, the key for the retry record should not involve the local part, but for
16345 other addresses, both the domain and the local part should be included.
16346 Usually, remote routing is of the former kind, and local routing is of the
16347 latter kind.
16348
16349 This option controls whether the local part is used to form the key for retry
16350 hints for addresses that suffer temporary errors while being handled by this
16351 router. The default value is true for any router that has &%check_local_user%&
16352 set, and false otherwise. Note that this option does not apply to hints keys
16353 for transport delays; they are controlled by a generic transport option of the
16354 same name.
16355
16356 The setting of &%retry_use_local_part%& applies only to the router on which it
16357 appears. If the router generates child addresses, they are routed
16358 independently; this setting does not become attached to them.
16359
16360
16361
16362 .option router_home_directory routers string&!! unset
16363 .cindex "router" "home directory for"
16364 .cindex "home directory" "for router"
16365 .vindex "&$home$&"
16366 This option sets a home directory for use while the router is running. (Compare
16367 &%transport_home_directory%&, which sets a home directory for later
16368 transporting.) In particular, if used on a &(redirect)& router, this option
16369 sets a value for &$home$& while a filter is running. The value is expanded;
16370 forced expansion failure causes the option to be ignored &-- other failures
16371 cause the router to defer.
16372
16373 Expansion of &%router_home_directory%& happens immediately after the
16374 &%check_local_user%& test (if configured), before any further expansions take
16375 place.
16376 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16377 are evaluated.)
16378 While the router is running, &%router_home_directory%& overrides the value of
16379 &$home$& that came from &%check_local_user%&.
16380
16381 When a router accepts an address and assigns it to a local transport (including
16382 the cases when a &(redirect)& router generates a pipe, file, or autoreply
16383 delivery), the home directory setting for the transport is taken from the first
16384 of these values that is set:
16385
16386 .ilist
16387 The &%home_directory%& option on the transport;
16388 .next
16389 The &%transport_home_directory%& option on the router;
16390 .next
16391 The password data if &%check_local_user%& is set on the router;
16392 .next
16393 The &%router_home_directory%& option on the router.
16394 .endlist
16395
16396 In other words, &%router_home_directory%& overrides the password data for the
16397 router, but not for the transport.
16398
16399
16400
16401 .option self routers string freeze
16402 .cindex "MX record" "pointing to local host"
16403 .cindex "local host" "MX pointing to"
16404 This option applies to those routers that use a recipient address to find a
16405 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
16406 and &(manualroute)& routers.
16407 Certain configurations of the &(queryprogram)& router can also specify a list
16408 of remote hosts.
16409 Usually such routers are configured to send the message to a remote host via an
16410 &(smtp)& transport. The &%self%& option specifies what happens when the first
16411 host on the list turns out to be the local host.
16412 The way in which Exim checks for the local host is described in section
16413 &<<SECTreclocipadd>>&.
16414
16415 Normally this situation indicates either an error in Exim's configuration (for
16416 example, the router should be configured not to process this domain), or an
16417 error in the DNS (for example, the MX should not point to this host). For this
16418 reason, the default action is to log the incident, defer the address, and
16419 freeze the message. The following alternatives are provided for use in special
16420 cases:
16421
16422 .vlist
16423 .vitem &%defer%&
16424 Delivery of the message is tried again later, but the message is not frozen.
16425
16426 .vitem "&%reroute%&: <&'domain'&>"
16427 The domain is changed to the given domain, and the address is passed back to
16428 be reprocessed by the routers. No rewriting of headers takes place. This
16429 behaviour is essentially a redirection.
16430
16431 .vitem "&%reroute: rewrite:%& <&'domain'&>"
16432 The domain is changed to the given domain, and the address is passed back to be
16433 reprocessed by the routers. Any headers that contain the original domain are
16434 rewritten.
16435
16436 .vitem &%pass%&
16437 .oindex "&%more%&"
16438 .vindex "&$self_hostname$&"
16439 The router passes the address to the next router, or to the router named in the
16440 &%pass_router%& option if it is set. This overrides &%no_more%&. During
16441 subsequent routing and delivery, the variable &$self_hostname$& contains the
16442 name of the local host that the router encountered. This can be used to
16443 distinguish between different cases for hosts with multiple names. The
16444 combination
16445 .code
16446 self = pass
16447 no_more
16448 .endd
16449 ensures that only those addresses that routed to the local host are passed on.
16450 Without &%no_more%&, addresses that were declined for other reasons would also
16451 be passed to the next router.
16452
16453 .vitem &%fail%&
16454 Delivery fails and an error report is generated.
16455
16456 .vitem &%send%&
16457 .cindex "local host" "sending to"
16458 The anomaly is ignored and the address is queued for the transport. This
16459 setting should be used with extreme caution. For an &(smtp)& transport, it
16460 makes sense only in cases where the program that is listening on the SMTP port
16461 is not this version of Exim. That is, it must be some other MTA, or Exim with a
16462 different configuration file that handles the domain in another way.
16463 .endlist
16464
16465
16466
16467 .option senders routers&!? "address list&!!" unset
16468 .cindex "router" "checking senders"
16469 If this option is set, the router is skipped unless the message's sender
16470 address matches something on the list.
16471 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16472 are evaluated.
16473
16474 There are issues concerning verification when the running of routers is
16475 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
16476 setting, it sets the sender to the null string. When using the &%-bt%& option
16477 to check a configuration file, it is necessary also to use the &%-f%& option to
16478 set an appropriate sender. For incoming mail, the sender is unset when
16479 verifying the sender, but is available when verifying any recipients. If the
16480 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
16481 matters.
16482
16483
16484 .option translate_ip_address routers string&!! unset
16485 .cindex "IP address" "translating"
16486 .cindex "packet radio"
16487 .cindex "router" "IP address translation"
16488 There exist some rare networking situations (for example, packet radio) where
16489 it is helpful to be able to translate IP addresses generated by normal routing
16490 mechanisms into other IP addresses, thus performing a kind of manual IP
16491 routing. This should be done only if the normal IP routing of the TCP/IP stack
16492 is inadequate or broken. Because this is an extremely uncommon requirement, the
16493 code to support this option is not included in the Exim binary unless
16494 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
16495
16496 .vindex "&$host_address$&"
16497 The &%translate_ip_address%& string is expanded for every IP address generated
16498 by the router, with the generated address set in &$host_address$&. If the
16499 expansion is forced to fail, no action is taken.
16500 For any other expansion error, delivery of the message is deferred.
16501 If the result of the expansion is an IP address, that replaces the original
16502 address; otherwise the result is assumed to be a host name &-- this is looked
16503 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
16504 produce one or more replacement IP addresses. For example, to subvert all IP
16505 addresses in some specific networks, this could be added to a router:
16506 .code
16507 translate_ip_address = \
16508   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
16509     {$value}fail}}
16510 .endd
16511 The file would contain lines like
16512 .code
16513 10.2.3.128/26    some.host
16514 10.8.4.34/26     10.44.8.15
16515 .endd
16516 You should not make use of this facility unless you really understand what you
16517 are doing.
16518
16519
16520
16521 .option transport routers string&!! unset
16522 This option specifies the transport to be used when a router accepts an address
16523 and sets it up for delivery. A transport is never needed if a router is used
16524 only for verification. The value of the option is expanded at routing time,
16525 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
16526 and result must be the name of one of the configured transports. If it is not,
16527 delivery is deferred.
16528
16529 The &%transport%& option is not used by the &(redirect)& router, but it does
16530 have some private options that set up transports for pipe and file deliveries
16531 (see chapter &<<CHAPredirect>>&).
16532
16533
16534
16535 .option transport_current_directory routers string&!! unset
16536 .cindex "current directory for local transport"
16537 This option associates a current directory with any address that is routed
16538 to a local transport. This can happen either because a transport is
16539 explicitly configured for the router, or because it generates a delivery to a
16540 file or a pipe. During the delivery process (that is, at transport time), this
16541 option string is expanded and is set as the current directory, unless
16542 overridden by a setting on the transport.
16543 If the expansion fails for any reason, including forced failure, an error is
16544 logged, and delivery is deferred.
16545 See chapter &<<CHAPenvironment>>& for details of the local delivery
16546 environment.
16547
16548
16549
16550
16551 .option transport_home_directory routers string&!! "see below"
16552 .cindex "home directory" "for local transport"
16553 This option associates a home directory with any address that is routed to a
16554 local transport. This can happen either because a transport is explicitly
16555 configured for the router, or because it generates a delivery to a file or a
16556 pipe. During the delivery process (that is, at transport time), the option
16557 string is expanded and is set as the home directory, unless overridden by a
16558 setting of &%home_directory%& on the transport.
16559 If the expansion fails for any reason, including forced failure, an error is
16560 logged, and delivery is deferred.
16561
16562 If the transport does not specify a home directory, and
16563 &%transport_home_directory%& is not set for the router, the home directory for
16564 the transport is taken from the password data if &%check_local_user%& is set for
16565 the router. Otherwise it is taken from &%router_home_directory%& if that option
16566 is set; if not, no home directory is set for the transport.
16567
16568 See chapter &<<CHAPenvironment>>& for further details of the local delivery
16569 environment.
16570
16571
16572
16573
16574 .option unseen routers boolean&!! false
16575 .cindex "router" "carrying on after success"
16576 The result of string expansion for this option must be a valid boolean value,
16577 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16578 result causes an error, and delivery is deferred. If the expansion is forced to
16579 fail, the default value for the option (false) is used. Other failures cause
16580 delivery to be deferred.
16581
16582 When this option is set true, routing does not cease if the router accepts the
16583 address. Instead, a copy of the incoming address is passed to the next router,
16584 overriding a false setting of &%more%&. There is little point in setting
16585 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
16586 the value of &%unseen%& contains expansion items (and therefore, presumably, is
16587 sometimes true and sometimes false).
16588
16589 .cindex "copy of message (&%unseen%& option)"
16590 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
16591 qualifier in filter files. It can be used to cause copies of messages to be
16592 delivered to some other destination, while also carrying out a normal delivery.
16593 In effect, the current address is made into a &"parent"& that has two children
16594 &-- one that is delivered as specified by this router, and a clone that goes on
16595 to be routed further. For this reason, &%unseen%& may not be combined with the
16596 &%one_time%& option in a &(redirect)& router.
16597
16598 &*Warning*&: Header lines added to the address (or specified for removal) by
16599 this router or by previous routers affect the &"unseen"& copy of the message
16600 only. The clone that continues to be processed by further routers starts with
16601 no added headers and none specified for removal. For a &%redirect%& router, if
16602 a generated address is the same as the incoming address, this can lead to
16603 duplicate addresses with different header modifications. Exim does not do
16604 duplicate deliveries (except, in certain circumstances, to pipes -- see section
16605 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
16606 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
16607 &%redirect%& router may be of help.
16608
16609 Unlike the handling of header modifications, any data that was set by the
16610 &%address_data%& option in the current or previous routers &'is'& passed on to
16611 subsequent routers.
16612
16613
16614 .option user routers string&!! "see below"
16615 .cindex "uid (user id)" "local delivery"
16616 .cindex "local transports" "uid and gid"
16617 .cindex "transport" "local"
16618 .cindex "router" "user for filter processing"
16619 .cindex "filter" "user for processing"
16620 When a router queues an address for a transport, and the transport does not
16621 specify a user, the user given here is used when running the delivery process.
16622 The user may be specified numerically or by name. If expansion fails, the
16623 error is logged and delivery is deferred.
16624 This user is also used by the &(redirect)& router when running a filter file.
16625 The default is unset, except when &%check_local_user%& is set. In this case,
16626 the default is taken from the password information. If the user is specified as
16627 a name, and &%group%& is not set, the group associated with the user is used.
16628 See also &%initgroups%& and &%group%& and the discussion in chapter
16629 &<<CHAPenvironment>>&.
16630
16631
16632
16633 .option verify routers&!? boolean true
16634 Setting this option has the effect of setting &%verify_sender%& and
16635 &%verify_recipient%& to the same value.
16636
16637
16638 .option verify_only routers&!? boolean false
16639 .cindex "EXPN" "with &%verify_only%&"
16640 .oindex "&%-bv%&"
16641 .cindex "router" "used only when verifying"
16642 If this option is set, the router is used only when verifying an address or
16643 testing with the &%-bv%& option, not when actually doing a delivery, testing
16644 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
16645 restricted to verifying only senders or recipients by means of
16646 &%verify_sender%& and &%verify_recipient%&.
16647
16648 &*Warning*&: When the router is being run to verify addresses for an incoming
16649 SMTP message, Exim is not running as root, but under its own uid. If the router
16650 accesses any files, you need to make sure that they are accessible to the Exim
16651 user or group.
16652
16653
16654 .option verify_recipient routers&!? boolean true
16655 If this option is false, the router is skipped when verifying recipient
16656 addresses
16657 or testing recipient verification using &%-bv%&.
16658 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16659 are evaluated.
16660
16661
16662 .option verify_sender routers&!? boolean true
16663 If this option is false, the router is skipped when verifying sender addresses
16664 or testing sender verification using &%-bvs%&.
16665 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16666 are evaluated.
16667 .ecindex IIDgenoprou1
16668 .ecindex IIDgenoprou2
16669
16670
16671
16672
16673
16674
16675 . ////////////////////////////////////////////////////////////////////////////
16676 . ////////////////////////////////////////////////////////////////////////////
16677
16678 .chapter "The accept router" "CHID4"
16679 .cindex "&(accept)& router"
16680 .cindex "routers" "&(accept)&"
16681 The &(accept)& router has no private options of its own. Unless it is being
16682 used purely for verification (see &%verify_only%&) a transport is required to
16683 be defined by the generic &%transport%& option. If the preconditions that are
16684 specified by generic options are met, the router accepts the address and queues
16685 it for the given transport. The most common use of this router is for setting
16686 up deliveries to local mailboxes. For example:
16687 .code
16688 localusers:
16689   driver = accept
16690   domains = mydomain.example
16691   check_local_user
16692   transport = local_delivery
16693 .endd
16694 The &%domains%& condition in this example checks the domain of the address, and
16695 &%check_local_user%& checks that the local part is the login of a local user.
16696 When both preconditions are met, the &(accept)& router runs, and queues the
16697 address for the &(local_delivery)& transport.
16698
16699
16700
16701
16702
16703
16704 . ////////////////////////////////////////////////////////////////////////////
16705 . ////////////////////////////////////////////////////////////////////////////
16706
16707 .chapter "The dnslookup router" "CHAPdnslookup"
16708 .scindex IIDdnsrou1 "&(dnslookup)& router"
16709 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
16710 The &(dnslookup)& router looks up the hosts that handle mail for the
16711 recipient's domain in the DNS. A transport must always be set for this router,
16712 unless &%verify_only%& is set.
16713
16714 If SRV support is configured (see &%check_srv%& below), Exim first searches for
16715 SRV records. If none are found, or if SRV support is not configured,
16716 MX records are looked up. If no MX records exist, address records are sought.
16717 However, &%mx_domains%& can be set to disable the direct use of address
16718 records.
16719
16720 MX records of equal priority are sorted by Exim into a random order. Exim then
16721 looks for address records for the host names obtained from MX or SRV records.
16722 When a host has more than one IP address, they are sorted into a random order,
16723 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
16724 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
16725 generic option, the router declines.
16726
16727 Unless they have the highest priority (lowest MX value), MX records that point
16728 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
16729 are discarded, together with any other MX records of equal or lower priority.
16730
16731 .cindex "MX record" "pointing to local host"
16732 .cindex "local host" "MX pointing to"
16733 .oindex "&%self%&" "in &(dnslookup)& router"
16734 If the host pointed to by the highest priority MX record, or looked up as an
16735 address record, is the local host, or matches &%hosts_treat_as_local%&, what
16736 happens is controlled by the generic &%self%& option.
16737
16738
16739 .section "Problems with DNS lookups" "SECTprowitdnsloo"
16740 There have been problems with DNS servers when SRV records are looked up.
16741 Some mis-behaving servers return a DNS error or timeout when a non-existent
16742 SRV record is sought. Similar problems have in the past been reported for
16743 MX records. The global &%dns_again_means_nonexist%& option can help with this
16744 problem, but it is heavy-handed because it is a global option.
16745
16746 For this reason, there are two options, &%srv_fail_domains%& and
16747 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
16748 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
16749 an attempt to look up an SRV or MX record causes one of these results, and the
16750 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
16751 such record"&. In the case of an SRV lookup, this means that the router
16752 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
16753 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
16754 case routing fails.
16755
16756
16757
16758
16759 .section "Private options for dnslookup" "SECID118"
16760 .cindex "options" "&(dnslookup)& router"
16761 The private options for the &(dnslookup)& router are as follows:
16762
16763 .option check_secondary_mx dnslookup boolean false
16764 .cindex "MX record" "checking for secondary"
16765 If this option is set, the router declines unless the local host is found in
16766 (and removed from) the list of hosts obtained by MX lookup. This can be used to
16767 process domains for which the local host is a secondary mail exchanger
16768 differently to other domains. The way in which Exim decides whether a host is
16769 the local host is described in section &<<SECTreclocipadd>>&.
16770
16771
16772 .option check_srv dnslookup string&!! unset
16773 .cindex "SRV record" "enabling use of"
16774 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
16775 addition to MX and address records. The support is disabled by default. To
16776 enable SRV support, set the &%check_srv%& option to the name of the service
16777 required. For example,
16778 .code
16779 check_srv = smtp
16780 .endd
16781 looks for SRV records that refer to the normal smtp service. The option is
16782 expanded, so the service name can vary from message to message or address
16783 to address. This might be helpful if SRV records are being used for a
16784 submission service. If the expansion is forced to fail, the &%check_srv%&
16785 option is ignored, and the router proceeds to look for MX records in the
16786 normal way.
16787
16788 When the expansion succeeds, the router searches first for SRV records for
16789 the given service (it assumes TCP protocol). A single SRV record with a
16790 host name that consists of just a single dot indicates &"no such service for
16791 this domain"&; if this is encountered, the router declines. If other kinds of
16792 SRV record are found, they are used to construct a host list for delivery
16793 according to the rules of RFC 2782. MX records are not sought in this case.
16794
16795 When no SRV records are found, MX records (and address records) are sought in
16796 the traditional way. In other words, SRV records take precedence over MX
16797 records, just as MX records take precedence over address records. Note that
16798 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
16799 defined it. It is apparently believed that MX records are sufficient for email
16800 and that SRV records should not be used for this purpose. However, SRV records
16801 have an additional &"weight"& feature which some people might find useful when
16802 trying to split an SMTP load between hosts of different power.
16803
16804 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
16805 when there is a DNS lookup error.
16806
16807
16808
16809 .option mx_domains dnslookup "domain list&!!" unset
16810 .cindex "MX record" "required to exist"
16811 .cindex "SRV record" "required to exist"
16812 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
16813 record in order to be recognized. (The name of this option could be improved.)
16814 For example, if all the mail hosts in &'fict.example'& are known to have MX
16815 records, except for those in &'discworld.fict.example'&, you could use this
16816 setting:
16817 .code
16818 mx_domains = ! *.discworld.fict.example : *.fict.example
16819 .endd
16820 This specifies that messages addressed to a domain that matches the list but
16821 has no MX record should be bounced immediately instead of being routed using
16822 the address record.
16823
16824
16825 .option mx_fail_domains dnslookup "domain list&!!" unset
16826 If the DNS lookup for MX records for one of the domains in this list causes a
16827 DNS lookup error, Exim behaves as if no MX records were found. See section
16828 &<<SECTprowitdnsloo>>& for more discussion.
16829
16830
16831
16832
16833 .option qualify_single dnslookup boolean true
16834 .cindex "DNS" "resolver options"
16835 .cindex "DNS" "qualifying single-component names"
16836 When this option is true, the resolver option RES_DEFNAMES is set for DNS
16837 lookups. Typically, but not standardly, this causes the resolver to qualify
16838 single-component names with the default domain. For example, on a machine
16839 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
16840 &'thesaurus.ref.example'& inside the resolver. For details of what your
16841 resolver actually does, consult your man pages for &'resolver'& and
16842 &'resolv.conf'&.
16843
16844
16845
16846 .option rewrite_headers dnslookup boolean true
16847 .cindex "rewriting" "header lines"
16848 .cindex "header lines" "rewriting"
16849 If the domain name in the address that is being processed is not fully
16850 qualified, it may be expanded to its full form by a DNS lookup. For example, if
16851 an address is specified as &'dormouse@teaparty'&, the domain might be
16852 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
16853 occur as a result of setting the &%widen_domains%& option. If
16854 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
16855 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
16856 header lines of the message are rewritten with the full domain name.
16857
16858 This option should be turned off only when it is known that no message is
16859 ever going to be sent outside an environment where the abbreviation makes
16860 sense.
16861
16862 When an MX record is looked up in the DNS and matches a wildcard record, name
16863 servers normally return a record containing the name that has been looked up,
16864 making it impossible to detect whether a wildcard was present or not. However,
16865 some name servers have recently been seen to return the wildcard entry. If the
16866 name returned by a DNS lookup begins with an asterisk, it is not used for
16867 header rewriting.
16868
16869
16870 .option same_domain_copy_routing dnslookup boolean false
16871 .cindex "address" "copying routing"
16872 Addresses with the same domain are normally routed by the &(dnslookup)& router
16873 to the same list of hosts. However, this cannot be presumed, because the router
16874 options and preconditions may refer to the local part of the address. By
16875 default, therefore, Exim routes each address in a message independently. DNS
16876 servers run caches, so repeated DNS lookups are not normally expensive, and in
16877 any case, personal messages rarely have more than a few recipients.
16878
16879 If you are running mailing lists with large numbers of subscribers at the same
16880 domain, and you are using a &(dnslookup)& router which is independent of the
16881 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
16882 lookups for identical domains in one message. In this case, when &(dnslookup)&
16883 routes an address to a remote transport, any other unrouted addresses in the
16884 message that have the same domain are automatically given the same routing
16885 without processing them independently,
16886 provided the following conditions are met:
16887
16888 .ilist
16889 No router that processed the address specified &%headers_add%& or
16890 &%headers_remove%&.
16891 .next
16892 The router did not change the address in any way, for example, by &"widening"&
16893 the domain.
16894 .endlist
16895
16896
16897
16898
16899 .option search_parents dnslookup boolean false
16900 .cindex "DNS" "resolver options"
16901 When this option is true, the resolver option RES_DNSRCH is set for DNS
16902 lookups. This is different from the &%qualify_single%& option in that it
16903 applies to domains containing dots. Typically, but not standardly, it causes
16904 the resolver to search for the name in the current domain and in parent
16905 domains. For example, on a machine in the &'fict.example'& domain, if looking
16906 up &'teaparty.wonderland'& failed, the resolver would try
16907 &'teaparty.wonderland.fict.example'&. For details of what your resolver
16908 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
16909
16910 Setting this option true can cause problems in domains that have a wildcard MX
16911 record, because any domain that does not have its own MX record matches the
16912 local wildcard.
16913
16914
16915
16916 .option srv_fail_domains dnslookup "domain list&!!" unset
16917 If the DNS lookup for SRV records for one of the domains in this list causes a
16918 DNS lookup error, Exim behaves as if no SRV records were found. See section
16919 &<<SECTprowitdnsloo>>& for more discussion.
16920
16921
16922
16923
16924 .option widen_domains dnslookup "string list" unset
16925 .cindex "domain" "partial; widening"
16926 If a DNS lookup fails and this option is set, each of its strings in turn is
16927 added onto the end of the domain, and the lookup is tried again. For example,
16928 if
16929 .code
16930 widen_domains = fict.example:ref.example
16931 .endd
16932 is set and a lookup of &'klingon.dictionary'& fails,
16933 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
16934 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
16935 and &%search_parents%& options can cause some widening to be undertaken inside
16936 the DNS resolver. &%widen_domains%& is not applied to sender addresses
16937 when verifying, unless &%rewrite_headers%& is false (not the default).
16938
16939
16940 .section "Effect of qualify_single and search_parents" "SECID119"
16941 When a domain from an envelope recipient is changed by the resolver as a result
16942 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
16943 corresponding address in the message's header lines unless &%rewrite_headers%&
16944 is set false. Exim then re-routes the address, using the full domain.
16945
16946 These two options affect only the DNS lookup that takes place inside the router
16947 for the domain of the address that is being routed. They do not affect lookups
16948 such as that implied by
16949 .code
16950 domains = @mx_any
16951 .endd
16952 that may happen while processing a router precondition before the router is
16953 entered. No widening ever takes place for these lookups.
16954 .ecindex IIDdnsrou1
16955 .ecindex IIDdnsrou2
16956
16957
16958
16959
16960
16961
16962
16963
16964
16965 . ////////////////////////////////////////////////////////////////////////////
16966 . ////////////////////////////////////////////////////////////////////////////
16967
16968 .chapter "The ipliteral router" "CHID5"
16969 .cindex "&(ipliteral)& router"
16970 .cindex "domain literal" "routing"
16971 .cindex "routers" "&(ipliteral)&"
16972 This router has no private options. Unless it is being used purely for
16973 verification (see &%verify_only%&) a transport is required to be defined by the
16974 generic &%transport%& option. The router accepts the address if its domain part
16975 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
16976 router handles the address
16977 .code
16978 root@[192.168.1.1]
16979 .endd
16980 by setting up delivery to the host with that IP address. IPv4 domain literals
16981 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
16982 are similar, but the address is preceded by &`ipv6:`&. For example:
16983 .code
16984 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
16985 .endd
16986 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
16987 grounds that sooner or later somebody will try it.
16988
16989 .oindex "&%self%&" "in &(ipliteral)& router"
16990 If the IP address matches something in &%ignore_target_hosts%&, the router
16991 declines. If an IP literal turns out to refer to the local host, the generic
16992 &%self%& option determines what happens.
16993
16994 The RFCs require support for domain literals; however, their use is
16995 controversial in today's Internet. If you want to use this router, you must
16996 also set the main configuration option &%allow_domain_literals%&. Otherwise,
16997 Exim will not recognize the domain literal syntax in addresses.
16998
16999
17000
17001 . ////////////////////////////////////////////////////////////////////////////
17002 . ////////////////////////////////////////////////////////////////////////////
17003
17004 .chapter "The iplookup router" "CHID6"
17005 .cindex "&(iplookup)& router"
17006 .cindex "routers" "&(iplookup)&"
17007 The &(iplookup)& router was written to fulfil a specific requirement in
17008 Cambridge University (which in fact no longer exists). For this reason, it is
17009 not included in the binary of Exim by default. If you want to include it, you
17010 must set
17011 .code
17012 ROUTER_IPLOOKUP=yes
17013 .endd
17014 in your &_Local/Makefile_& configuration file.
17015
17016 The &(iplookup)& router routes an address by sending it over a TCP or UDP
17017 connection to one or more specific hosts. The host can then return the same or
17018 a different address &-- in effect rewriting the recipient address in the
17019 message's envelope. The new address is then passed on to subsequent routers. If
17020 this process fails, the address can be passed on to other routers, or delivery
17021 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
17022 must not be specified for it.
17023
17024 .cindex "options" "&(iplookup)& router"
17025 .option hosts iplookup string unset
17026 This option must be supplied. Its value is a colon-separated list of host
17027 names. The hosts are looked up using &[gethostbyname()]&
17028 (or &[getipnodebyname()]& when available)
17029 and are tried in order until one responds to the query. If none respond, what
17030 happens is controlled by &%optional%&.
17031
17032
17033 .option optional iplookup boolean false
17034 If &%optional%& is true, if no response is obtained from any host, the address
17035 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
17036 delivery to the address is deferred.
17037
17038
17039 .option port iplookup integer 0
17040 .cindex "port" "&(iplookup)& router"
17041 This option must be supplied. It specifies the port number for the TCP or UDP
17042 call.
17043
17044
17045 .option protocol iplookup string udp
17046 This option can be set to &"udp"& or &"tcp"& to specify which of the two
17047 protocols is to be used.
17048
17049
17050 .option query iplookup string&!! "see below"
17051 This defines the content of the query that is sent to the remote hosts. The
17052 default value is:
17053 .code
17054 $local_part@$domain $local_part@$domain
17055 .endd
17056 The repetition serves as a way of checking that a response is to the correct
17057 query in the default case (see &%response_pattern%& below).
17058
17059
17060 .option reroute iplookup string&!! unset
17061 If this option is not set, the rerouted address is precisely the byte string
17062 returned by the remote host, up to the first white space, if any. If set, the
17063 string is expanded to form the rerouted address. It can include parts matched
17064 in the response by &%response_pattern%& by means of numeric variables such as
17065 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17066 whether or not a pattern is in use. In all cases, the rerouted address must end
17067 up in the form &'local_part@domain'&.
17068
17069
17070 .option response_pattern iplookup string unset
17071 This option can be set to a regular expression that is applied to the string
17072 returned from the remote host. If the pattern does not match the response, the
17073 router declines. If &%response_pattern%& is not set, no checking of the
17074 response is done, unless the query was defaulted, in which case there is a
17075 check that the text returned after the first white space is the original
17076 address. This checks that the answer that has been received is in response to
17077 the correct question. For example, if the response is just a new domain, the
17078 following could be used:
17079 .code
17080 response_pattern = ^([^@]+)$
17081 reroute = $local_part@$1
17082 .endd
17083
17084 .option timeout iplookup time 5s
17085 This specifies the amount of time to wait for a response from the remote
17086 machine. The same timeout is used for the &[connect()]& function for a TCP
17087 call. It does not apply to UDP.
17088
17089
17090
17091
17092 . ////////////////////////////////////////////////////////////////////////////
17093 . ////////////////////////////////////////////////////////////////////////////
17094
17095 .chapter "The manualroute router" "CHID7"
17096 .scindex IIDmanrou1 "&(manualroute)& router"
17097 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17098 .cindex "domain" "manually routing"
17099 The &(manualroute)& router is so-called because it provides a way of manually
17100 routing an address according to its domain. It is mainly used when you want to
17101 route addresses to remote hosts according to your own rules, bypassing the
17102 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17103 route to local transports, a facility that may be useful if you want to save
17104 messages for dial-in hosts in local files.
17105
17106 The &(manualroute)& router compares a list of domain patterns with the domain
17107 it is trying to route. If there is no match, the router declines. Each pattern
17108 has associated with it a list of hosts and some other optional data, which may
17109 include a transport. The combination of a pattern and its data is called a
17110 &"routing rule"&. For patterns that do not have an associated transport, the
17111 generic &%transport%& option must specify a transport, unless the router is
17112 being used purely for verification (see &%verify_only%&).
17113
17114 .vindex "&$host$&"
17115 In the case of verification, matching the domain pattern is sufficient for the
17116 router to accept the address. When actually routing an address for delivery,
17117 an address that matches a domain pattern is queued for the associated
17118 transport. If the transport is not a local one, a host list must be associated
17119 with the pattern; IP addresses are looked up for the hosts, and these are
17120 passed to the transport along with the mail address. For local transports, a
17121 host list is optional. If it is present, it is passed in &$host$& as a single
17122 text string.
17123
17124 The list of routing rules can be provided as an inline string in
17125 &%route_list%&, or the data can be obtained by looking up the domain in a file
17126 or database by setting &%route_data%&. Only one of these settings may appear in
17127 any one instance of &(manualroute)&. The format of routing rules is described
17128 below, following the list of private options.
17129
17130
17131 .section "Private options for manualroute" "SECTprioptman"
17132
17133 .cindex "options" "&(manualroute)& router"
17134 The private options for the &(manualroute)& router are as follows:
17135
17136 .option host_all_ignored manualroute string defer
17137 See &%host_find_failed%&.
17138
17139 .option host_find_failed manualroute string freeze
17140 This option controls what happens when &(manualroute)& tries to find an IP
17141 address for a host, and the host does not exist. The option can be set to one
17142 of the following values:
17143 .code
17144 decline
17145 defer
17146 fail
17147 freeze
17148 ignore
17149 pass
17150 .endd
17151 The default (&"freeze"&) assumes that this state is a serious configuration
17152 error. The difference between &"pass"& and &"decline"& is that the former
17153 forces the address to be passed to the next router (or the router defined by
17154 &%pass_router%&),
17155 .oindex "&%more%&"
17156 overriding &%no_more%&, whereas the latter passes the address to the next
17157 router only if &%more%& is true.
17158
17159 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17160 cannot be found. If all the hosts in the list are ignored, the behaviour is
17161 controlled by the &%host_all_ignored%& option. This takes the same values
17162 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17163
17164 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17165 state; if a host lookup gets a temporary error, delivery is deferred unless the
17166 generic &%pass_on_timeout%& option is set.
17167
17168
17169 .option hosts_randomize manualroute boolean false
17170 .cindex "randomized host list"
17171 .cindex "host" "list of; randomized"
17172 If this option is set, the order of the items in a host list in a routing rule
17173 is randomized each time the list is used, unless an option in the routing rule
17174 overrides (see below). Randomizing the order of a host list can be used to do
17175 crude load sharing. However, if more than one mail address is routed by the
17176 same router to the same host list, the host lists are considered to be the same
17177 (even though they may be randomized into different orders) for the purpose of
17178 deciding whether to batch the deliveries into a single SMTP transaction.
17179
17180 When &%hosts_randomize%& is true, a host list may be split
17181 into groups whose order is separately randomized. This makes it possible to
17182 set up MX-like behaviour. The boundaries between groups are indicated by an
17183 item that is just &`+`& in the host list. For example:
17184 .code
17185 route_list = * host1:host2:host3:+:host4:host5
17186 .endd
17187 The order of the first three hosts and the order of the last two hosts is
17188 randomized for each use, but the first three always end up before the last two.
17189 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
17190 randomized host list is passed to an &(smtp)& transport that also has
17191 &%hosts_randomize set%&, the list is not re-randomized.
17192
17193
17194 .option route_data manualroute string&!! unset
17195 If this option is set, it must expand to yield the data part of a routing rule.
17196 Typically, the expansion string includes a lookup based on the domain. For
17197 example:
17198 .code
17199 route_data = ${lookup{$domain}dbm{/etc/routes}}
17200 .endd
17201 If the expansion is forced to fail, or the result is an empty string, the
17202 router declines. Other kinds of expansion failure cause delivery to be
17203 deferred.
17204
17205
17206 .option route_list manualroute "string list" unset
17207 This string is a list of routing rules, in the form defined below. Note that,
17208 unlike most string lists, the items are separated by semicolons. This is so
17209 that they may contain colon-separated host lists.
17210
17211
17212 .option same_domain_copy_routing manualroute boolean false
17213 .cindex "address" "copying routing"
17214 Addresses with the same domain are normally routed by the &(manualroute)&
17215 router to the same list of hosts. However, this cannot be presumed, because the
17216 router options and preconditions may refer to the local part of the address. By
17217 default, therefore, Exim routes each address in a message independently. DNS
17218 servers run caches, so repeated DNS lookups are not normally expensive, and in
17219 any case, personal messages rarely have more than a few recipients.
17220
17221 If you are running mailing lists with large numbers of subscribers at the same
17222 domain, and you are using a &(manualroute)& router which is independent of the
17223 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17224 lookups for identical domains in one message. In this case, when
17225 &(manualroute)& routes an address to a remote transport, any other unrouted
17226 addresses in the message that have the same domain are automatically given the
17227 same routing without processing them independently. However, this is only done
17228 if &%headers_add%& and &%headers_remove%& are unset.
17229
17230
17231
17232
17233 .section "Routing rules in route_list" "SECID120"
17234 The value of &%route_list%& is a string consisting of a sequence of routing
17235 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
17236 entered as two semicolons. Alternatively, the list separator can be changed as
17237 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
17238 Empty rules are ignored. The format of each rule is
17239 .display
17240 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
17241 .endd
17242 The following example contains two rules, each with a simple domain pattern and
17243 no options:
17244 .code
17245 route_list = \
17246   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
17247   thes.ref.example  mail-3.ref.example:mail-4.ref.example
17248 .endd
17249 The three parts of a rule are separated by white space. The pattern and the
17250 list of hosts can be enclosed in quotes if necessary, and if they are, the
17251 usual quoting rules apply. Each rule in a &%route_list%& must start with a
17252 single domain pattern, which is the only mandatory item in the rule. The
17253 pattern is in the same format as one item in a domain list (see section
17254 &<<SECTdomainlist>>&),
17255 except that it may not be the name of an interpolated file.
17256 That is, it may be wildcarded, or a regular expression, or a file or database
17257 lookup (with semicolons doubled, because of the use of semicolon as a separator
17258 in a &%route_list%&).
17259
17260 The rules in &%route_list%& are searched in order until one of the patterns
17261 matches the domain that is being routed. The list of hosts and then options are
17262 then used as described below. If there is no match, the router declines. When
17263 &%route_list%& is set, &%route_data%& must not be set.
17264
17265
17266
17267 .section "Routing rules in route_data" "SECID121"
17268 The use of &%route_list%& is convenient when there are only a small number of
17269 routing rules. For larger numbers, it is easier to use a file or database to
17270 hold the routing information, and use the &%route_data%& option instead.
17271 The value of &%route_data%& is a list of hosts, followed by (optional) options.
17272 Most commonly, &%route_data%& is set as a string that contains an
17273 expansion lookup. For example, suppose we place two routing rules in a file
17274 like this:
17275 .code
17276 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
17277 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
17278 .endd
17279 This data can be accessed by setting
17280 .code
17281 route_data = ${lookup{$domain}lsearch{/the/file/name}}
17282 .endd
17283 Failure of the lookup results in an empty string, causing the router to
17284 decline. However, you do not have to use a lookup in &%route_data%&. The only
17285 requirement is that the result of expanding the string is a list of hosts,
17286 possibly followed by options, separated by white space. The list of hosts must
17287 be enclosed in quotes if it contains white space.
17288
17289
17290
17291
17292 .section "Format of the list of hosts" "SECID122"
17293 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
17294 always separately expanded before use. If the expansion fails, the router
17295 declines. The result of the expansion must be a colon-separated list of names
17296 and/or IP addresses, optionally also including ports. The format of each item
17297 in the list is described in the next section. The list separator can be changed
17298 as described in section &<<SECTlistconstruct>>&.
17299
17300 If the list of hosts was obtained from a &%route_list%& item, the following
17301 variables are set during its expansion:
17302
17303 .ilist
17304 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
17305 If the domain was matched against a regular expression, the numeric variables
17306 &$1$&, &$2$&, etc. may be set. For example:
17307 .code
17308 route_list = ^domain(\d+)   host-$1.text.example
17309 .endd
17310 .next
17311 &$0$& is always set to the entire domain.
17312 .next
17313 &$1$& is also set when partial matching is done in a file lookup.
17314
17315 .next
17316 .vindex "&$value$&"
17317 If the pattern that matched the domain was a lookup item, the data that was
17318 looked up is available in the expansion variable &$value$&. For example:
17319 .code
17320 route_list = lsearch;;/some/file.routes  $value
17321 .endd
17322 .endlist
17323
17324 Note the doubling of the semicolon in the pattern that is necessary because
17325 semicolon is the default route list separator.
17326
17327
17328
17329 .section "Format of one host item" "SECTformatonehostitem"
17330 Each item in the list of hosts is either a host name or an IP address,
17331 optionally with an attached port number. When no port is given, an IP address
17332 is not enclosed in brackets. When a port is specified, it overrides the port
17333 specification on the transport. The port is separated from the name or address
17334 by a colon. This leads to some complications:
17335
17336 .ilist
17337 Because colon is the default separator for the list of hosts, either
17338 the colon that specifies a port must be doubled, or the list separator must
17339 be changed. The following two examples have the same effect:
17340 .code
17341 route_list = * "host1.tld::1225 : host2.tld::1226"
17342 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
17343 .endd
17344 .next
17345 When IPv6 addresses are involved, it gets worse, because they contain
17346 colons of their own. To make this case easier, it is permitted to
17347 enclose an IP address (either v4 or v6) in square brackets if a port
17348 number follows. For example:
17349 .code
17350 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
17351 .endd
17352 .endlist
17353
17354 .section "How the list of hosts is used" "SECThostshowused"
17355 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
17356 the hosts is tried, in the order specified, when carrying out the SMTP
17357 delivery. However, the order can be changed by setting the &%hosts_randomize%&
17358 option, either on the router (see section &<<SECTprioptman>>& above), or on the
17359 transport.
17360
17361 Hosts may be listed by name or by IP address. An unadorned name in the list of
17362 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
17363 interpreted as an indirection to a sublist of hosts obtained by looking up MX
17364 records in the DNS. For example:
17365 .code
17366 route_list = *  x.y.z:p.q.r/MX:e.f.g
17367 .endd
17368 If this feature is used with a port specifier, the port must come last. For
17369 example:
17370 .code
17371 route_list = *  dom1.tld/mx::1225
17372 .endd
17373 If the &%hosts_randomize%& option is set, the order of the items in the list is
17374 randomized before any lookups are done. Exim then scans the list; for any name
17375 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
17376 be an interface on the local host and the item is not the first in the list,
17377 Exim discards it and any subsequent items. If it is the first item, what
17378 happens is controlled by the
17379 .oindex "&%self%&" "in &(manualroute)& router"
17380 &%self%& option of the router.
17381
17382 A name on the list that is followed by &`/MX`& is replaced with the list of
17383 hosts obtained by looking up MX records for the name. This is always a DNS
17384 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
17385 below) are not relevant here. The order of these hosts is determined by the
17386 preference values in the MX records, according to the usual rules. Because
17387 randomizing happens before the MX lookup, it does not affect the order that is
17388 defined by MX preferences.
17389
17390 If the local host is present in the sublist obtained from MX records, but is
17391 not the most preferred host in that list, it and any equally or less
17392 preferred hosts are removed before the sublist is inserted into the main list.
17393
17394 If the local host is the most preferred host in the MX list, what happens
17395 depends on where in the original list of hosts the &`/MX`& item appears. If it
17396 is not the first item (that is, there are previous hosts in the main list),
17397 Exim discards this name and any subsequent items in the main list.
17398
17399 If the MX item is first in the list of hosts, and the local host is the
17400 most preferred host, what happens is controlled by the &%self%& option of the
17401 router.
17402
17403 DNS failures when lookup up the MX records are treated in the same way as DNS
17404 failures when looking up IP addresses: &%pass_on_timeout%& and
17405 &%host_find_failed%& are used when relevant.
17406
17407 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
17408 whether obtained from an MX lookup or not.
17409
17410
17411
17412 .section "How the options are used" "SECThowoptused"
17413 The options are a sequence of words; in practice no more than three are ever
17414 present. One of the words can be the name of a transport; this overrides the
17415 &%transport%& option on the router for this particular routing rule only. The
17416 other words (if present) control randomization of the list of hosts on a
17417 per-rule basis, and how the IP addresses of the hosts are to be found when
17418 routing to a remote transport. These options are as follows:
17419
17420 .ilist
17421 &%randomize%&: randomize the order of the hosts in this list, overriding the
17422 setting of &%hosts_randomize%& for this routing rule only.
17423 .next
17424 &%no_randomize%&: do not randomize the order of the hosts in this list,
17425 overriding the setting of &%hosts_randomize%& for this routing rule only.
17426 .next
17427 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
17428 find IP addresses. This function may ultimately cause a DNS lookup, but it may
17429 also look in &_/etc/hosts_& or other sources of information.
17430 .next
17431 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
17432 no address records are found. If there is a temporary DNS error (such as a
17433 timeout), delivery is deferred.
17434 .endlist
17435
17436 For example:
17437 .code
17438 route_list = domain1  host1:host2:host3  randomize bydns;\
17439              domain2  host4:host5
17440 .endd
17441 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
17442 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
17443 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
17444 or &[gethostbyname()]&, and the result of the lookup is the result of that
17445 call.
17446
17447 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
17448 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
17449 instead of TRY_AGAIN. That is why the default action is to try a DNS
17450 lookup first. Only if that gives a definite &"no such host"& is the local
17451 function called.
17452
17453
17454
17455 If no IP address for a host can be found, what happens is controlled by the
17456 &%host_find_failed%& option.
17457
17458 .vindex "&$host$&"
17459 When an address is routed to a local transport, IP addresses are not looked up.
17460 The host list is passed to the transport in the &$host$& variable.
17461
17462
17463
17464 .section "Manualroute examples" "SECID123"
17465 In some of the examples that follow, the presence of the &%remote_smtp%&
17466 transport, as defined in the default configuration file, is assumed:
17467
17468 .ilist
17469 .cindex "smart host" "example router"
17470 The &(manualroute)& router can be used to forward all external mail to a
17471 &'smart host'&. If you have set up, in the main part of the configuration, a
17472 named domain list that contains your local domains, for example:
17473 .code
17474 domainlist local_domains = my.domain.example
17475 .endd
17476 You can arrange for all other domains to be routed to a smart host by making
17477 your first router something like this:
17478 .code
17479 smart_route:
17480   driver = manualroute
17481   domains = !+local_domains
17482   transport = remote_smtp
17483   route_list = * smarthost.ref.example
17484 .endd
17485 This causes all non-local addresses to be sent to the single host
17486 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
17487 they are tried in order
17488 (but you can use &%hosts_randomize%& to vary the order each time).
17489 Another way of configuring the same thing is this:
17490 .code
17491 smart_route:
17492   driver = manualroute
17493   transport = remote_smtp
17494   route_list = !+local_domains  smarthost.ref.example
17495 .endd
17496 There is no difference in behaviour between these two routers as they stand.
17497 However, they behave differently if &%no_more%& is added to them. In the first
17498 example, the router is skipped if the domain does not match the &%domains%&
17499 precondition; the following router is always tried. If the router runs, it
17500 always matches the domain and so can never decline. Therefore, &%no_more%&
17501 would have no effect. In the second case, the router is never skipped; it
17502 always runs. However, if it doesn't match the domain, it declines. In this case
17503 &%no_more%& would prevent subsequent routers from running.
17504
17505 .next
17506 .cindex "mail hub example"
17507 A &'mail hub'& is a host which receives mail for a number of domains via MX
17508 records in the DNS and delivers it via its own private routing mechanism. Often
17509 the final destinations are behind a firewall, with the mail hub being the one
17510 machine that can connect to machines both inside and outside the firewall. The
17511 &(manualroute)& router is usually used on a mail hub to route incoming messages
17512 to the correct hosts. For a small number of domains, the routing can be inline,
17513 using the &%route_list%& option, but for a larger number a file or database
17514 lookup is easier to manage.
17515
17516 If the domain names are in fact the names of the machines to which the mail is
17517 to be sent by the mail hub, the configuration can be quite simple. For
17518 example:
17519 .code
17520 hub_route:
17521   driver = manualroute
17522   transport = remote_smtp
17523   route_list = *.rhodes.tvs.example  $domain
17524 .endd
17525 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
17526 whose names are the same as the mail domains. A similar approach can be taken
17527 if the host name can be obtained from the domain name by a string manipulation
17528 that the expansion facilities can handle. Otherwise, a lookup based on the
17529 domain can be used to find the host:
17530 .code
17531 through_firewall:
17532   driver = manualroute
17533   transport = remote_smtp
17534   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
17535 .endd
17536 The result of the lookup must be the name or IP address of the host (or
17537 hosts) to which the address is to be routed. If the lookup fails, the route
17538 data is empty, causing the router to decline. The address then passes to the
17539 next router.
17540
17541 .next
17542 .cindex "batched SMTP output example"
17543 .cindex "SMTP" "batched outgoing; example"
17544 You can use &(manualroute)& to deliver messages to pipes or files in batched
17545 SMTP format for onward transportation by some other means. This is one way of
17546 storing mail for a dial-up host when it is not connected. The route list entry
17547 can be as simple as a single domain name in a configuration like this:
17548 .code
17549 save_in_file:
17550   driver = manualroute
17551   transport = batchsmtp_appendfile
17552   route_list = saved.domain.example
17553 .endd
17554 though often a pattern is used to pick up more than one domain. If there are
17555 several domains or groups of domains with different transport requirements,
17556 different transports can be listed in the routing information:
17557 .code
17558 save_in_file:
17559   driver = manualroute
17560   route_list = \
17561     *.saved.domain1.example  $domain  batch_appendfile; \
17562     *.saved.domain2.example  \
17563       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
17564       batch_pipe
17565 .endd
17566 .vindex "&$domain$&"
17567 .vindex "&$host$&"
17568 The first of these just passes the domain in the &$host$& variable, which
17569 doesn't achieve much (since it is also in &$domain$&), but the second does a
17570 file lookup to find a value to pass, causing the router to decline to handle
17571 the address if the lookup fails.
17572
17573 .next
17574 .cindex "UUCP" "example of router for"
17575 Routing mail directly to UUCP software is a specific case of the use of
17576 &(manualroute)& in a gateway to another mail environment. This is an example of
17577 one way it can be done:
17578 .code
17579 # Transport
17580 uucp:
17581   driver = pipe
17582   user = nobody
17583   command = /usr/local/bin/uux -r - \
17584     ${substr_-5:$host}!rmail ${local_part}
17585   return_fail_output = true
17586
17587 # Router
17588 uucphost:
17589   transport = uucp
17590   driver = manualroute
17591   route_data = \
17592     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
17593 .endd
17594 The file &_/usr/local/exim/uucphosts_& contains entries like
17595 .code
17596 darksite.ethereal.example:           darksite.UUCP
17597 .endd
17598 It can be set up more simply without adding and removing &".UUCP"& but this way
17599 makes clear the distinction between the domain name
17600 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
17601 .endlist
17602 .ecindex IIDmanrou1
17603 .ecindex IIDmanrou2
17604
17605
17606
17607
17608
17609
17610
17611
17612 . ////////////////////////////////////////////////////////////////////////////
17613 . ////////////////////////////////////////////////////////////////////////////
17614
17615 .chapter "The queryprogram router" "CHAPdriverlast"
17616 .scindex IIDquerou1 "&(queryprogram)& router"
17617 .scindex IIDquerou2 "routers" "&(queryprogram)&"
17618 .cindex "routing" "by external program"
17619 The &(queryprogram)& router routes an address by running an external command
17620 and acting on its output. This is an expensive way to route, and is intended
17621 mainly for use in lightly-loaded systems, or for performing experiments.
17622 However, if it is possible to use the precondition options (&%domains%&,
17623 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
17624 be used in special cases, even on a busy host. There are the following private
17625 options:
17626 .cindex "options" "&(queryprogram)& router"
17627
17628 .option command queryprogram string&!! unset
17629 This option must be set. It specifies the command that is to be run. The
17630 command is split up into a command name and arguments, and then each is
17631 expanded separately (exactly as for a &(pipe)& transport, described in chapter
17632 &<<CHAPpipetransport>>&).
17633
17634
17635 .option command_group queryprogram string unset
17636 .cindex "gid (group id)" "in &(queryprogram)& router"
17637 This option specifies a gid to be set when running the command while routing an
17638 address for deliver. It must be set if &%command_user%& specifies a numerical
17639 uid. If it begins with a digit, it is interpreted as the numerical value of the
17640 gid. Otherwise it is looked up using &[getgrnam()]&.
17641
17642
17643 .option command_user queryprogram string unset
17644 .cindex "uid (user id)" "for &(queryprogram)&"
17645 This option must be set. It specifies the uid which is set when running the
17646 command while routing an address for delivery. If the value begins with a digit,
17647 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
17648 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
17649 not set, a value for the gid also.
17650
17651 &*Warning:*& Changing uid and gid is possible only when Exim is running as
17652 root, which it does during a normal delivery in a conventional configuration.
17653 However, when an address is being verified during message reception, Exim is
17654 usually running as the Exim user, not as root. If the &(queryprogram)& router
17655 is called from a non-root process, Exim cannot change uid or gid before running
17656 the command. In this circumstance the command runs under the current uid and
17657 gid.
17658
17659
17660 .option current_directory queryprogram string /
17661 This option specifies an absolute path which is made the current directory
17662 before running the command.
17663
17664
17665 .option timeout queryprogram time 1h
17666 If the command does not complete within the timeout period, its process group
17667 is killed and the message is frozen. A value of zero time specifies no
17668 timeout.
17669
17670
17671 The standard output of the command is connected to a pipe, which is read when
17672 the command terminates. It should consist of a single line of output,
17673 containing up to five fields, separated by white space. The maximum length of
17674 the line is 1023 characters. Longer lines are silently truncated. The first
17675 field is one of the following words (case-insensitive):
17676
17677 .ilist
17678 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
17679 below).
17680 .next
17681 &'Decline'&: the router declines; pass the address to the next router, unless
17682 &%no_more%& is set.
17683 .next
17684 &'Fail'&: routing failed; do not pass the address to any more routers. Any
17685 subsequent text on the line is an error message. If the router is run as part
17686 of address verification during an incoming SMTP message, the message is
17687 included in the SMTP response.
17688 .next
17689 &'Defer'&: routing could not be completed at this time; try again later. Any
17690 subsequent text on the line is an error message which is logged. It is not
17691 included in any SMTP response.
17692 .next
17693 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
17694 .next
17695 &'Pass'&: pass the address to the next router (or the router specified by
17696 &%pass_router%&), overriding &%no_more%&.
17697 .next
17698 &'Redirect'&: the message is redirected. The remainder of the line is a list of
17699 new addresses, which are routed independently, starting with the first router,
17700 or the router specified by &%redirect_router%&, if set.
17701 .endlist
17702
17703 When the first word is &'accept'&, the remainder of the line consists of a
17704 number of keyed data values, as follows (split into two lines here, to fit on
17705 the page):
17706 .code
17707 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
17708 LOOKUP=byname|bydns DATA=<text>
17709 .endd
17710 The data items can be given in any order, and all are optional. If no transport
17711 is included, the transport specified by the generic &%transport%& option is
17712 used. The list of hosts and the lookup type are needed only if the transport is
17713 an &(smtp)& transport that does not itself supply a list of hosts.
17714
17715 The format of the list of hosts is the same as for the &(manualroute)& router.
17716 As well as host names and IP addresses with optional port numbers, as described
17717 in section &<<SECTformatonehostitem>>&, it may contain names followed by
17718 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
17719 (see section &<<SECThostshowused>>&).
17720
17721 If the lookup type is not specified, Exim behaves as follows when trying to
17722 find an IP address for each host: First, a DNS lookup is done. If this yields
17723 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
17724 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
17725 result of the lookup is the result of that call.
17726
17727 .vindex "&$address_data$&"
17728 If the DATA field is set, its value is placed in the &$address_data$&
17729 variable. For example, this return line
17730 .code
17731 accept hosts=x1.y.example:x2.y.example data="rule1"
17732 .endd
17733 routes the address to the default transport, passing a list of two hosts. When
17734 the transport runs, the string &"rule1"& is in &$address_data$&.
17735 .ecindex IIDquerou1
17736 .ecindex IIDquerou2
17737
17738
17739
17740
17741 . ////////////////////////////////////////////////////////////////////////////
17742 . ////////////////////////////////////////////////////////////////////////////
17743
17744 .chapter "The redirect router" "CHAPredirect"
17745 .scindex IIDredrou1 "&(redirect)& router"
17746 .scindex IIDredrou2 "routers" "&(redirect)&"
17747 .cindex "alias file" "in a &(redirect)& router"
17748 .cindex "address redirection" "&(redirect)& router"
17749 The &(redirect)& router handles several kinds of address redirection. Its most
17750 common uses are for resolving local part aliases from a central alias file
17751 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
17752 files, but it has many other potential uses. The incoming address can be
17753 redirected in several different ways:
17754
17755 .ilist
17756 It can be replaced by one or more new addresses which are themselves routed
17757 independently.
17758 .next
17759 It can be routed to be delivered to a given file or directory.
17760 .next
17761 It can be routed to be delivered to a specified pipe command.
17762 .next
17763 It can cause an automatic reply to be generated.
17764 .next
17765 It can be forced to fail, optionally with a custom error message.
17766 .next
17767 It can be temporarily deferred, optionally with a custom message.
17768 .next
17769 It can be discarded.
17770 .endlist
17771
17772 The generic &%transport%& option must not be set for &(redirect)& routers.
17773 However, there are some private options which define transports for delivery to
17774 files and pipes, and for generating autoreplies. See the &%file_transport%&,
17775 &%pipe_transport%& and &%reply_transport%& descriptions below.
17776
17777
17778
17779 .section "Redirection data" "SECID124"
17780 The router operates by interpreting a text string which it obtains either by
17781 expanding the contents of the &%data%& option, or by reading the entire
17782 contents of a file whose name is given in the &%file%& option. These two
17783 options are mutually exclusive. The first is commonly used for handling system
17784 aliases, in a configuration like this:
17785 .code
17786 system_aliases:
17787   driver = redirect
17788   data = ${lookup{$local_part}lsearch{/etc/aliases}}
17789 .endd
17790 If the lookup fails, the expanded string in this example is empty. When the
17791 expansion of &%data%& results in an empty string, the router declines. A forced
17792 expansion failure also causes the router to decline; other expansion failures
17793 cause delivery to be deferred.
17794
17795 A configuration using &%file%& is commonly used for handling users'
17796 &_.forward_& files, like this:
17797 .code
17798 userforward:
17799   driver = redirect
17800   check_local_user
17801   file = $home/.forward
17802   no_verify
17803 .endd
17804 If the file does not exist, or causes no action to be taken (for example, it is
17805 empty or consists only of comments), the router declines. &*Warning*&: This
17806 is not the case when the file contains syntactically valid items that happen to
17807 yield empty addresses, for example, items containing only RFC 2822 address
17808 comments.
17809
17810
17811
17812 .section "Forward files and address verification" "SECID125"
17813 .cindex "address redirection" "while verifying"
17814 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
17815 &_.forward_& files, as in the example above. There are two reasons for this:
17816
17817 .ilist
17818 When Exim is receiving an incoming SMTP message from a remote host, it is
17819 running under the Exim uid, not as root. Exim is unable to change uid to read
17820 the file as the user, and it may not be able to read it as the Exim user. So in
17821 practice the router may not be able to operate.
17822 .next
17823 However, even when the router can operate, the existence of a &_.forward_& file
17824 is unimportant when verifying an address. What should be checked is whether the
17825 local part is a valid user name or not. Cutting out the redirection processing
17826 saves some resources.
17827 .endlist
17828
17829
17830
17831
17832
17833
17834 .section "Interpreting redirection data" "SECID126"
17835 .cindex "Sieve filter" "specifying in redirection data"
17836 .cindex "filter" "specifying in redirection data"
17837 The contents of the data string, whether obtained from &%data%& or &%file%&,
17838 can be interpreted in two different ways:
17839
17840 .ilist
17841 If the &%allow_filter%& option is set true, and the data begins with the text
17842 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
17843 &'filtering'& instructions in the form of an Exim or Sieve filter file,
17844 respectively. Details of the syntax and semantics of filter files are described
17845 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
17846 document is intended for use by end users.
17847 .next
17848 Otherwise, the data must be a comma-separated list of redirection items, as
17849 described in the next section.
17850 .endlist
17851
17852 When a message is redirected to a file (a &"mail folder"&), the file name given
17853 in a non-filter redirection list must always be an absolute path. A filter may
17854 generate a relative path &-- how this is handled depends on the transport's
17855 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
17856 for the &(appendfile)& transport.
17857
17858
17859
17860 .section "Items in a non-filter redirection list" "SECTitenonfilred"
17861 .cindex "address redirection" "non-filter list items"
17862 When the redirection data is not an Exim or Sieve filter, for example, if it
17863 comes from a conventional alias or forward file, it consists of a list of
17864 addresses, file names, pipe commands, or certain special items (see section
17865 &<<SECTspecitredli>>& below). The special items can be individually enabled or
17866 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
17867 depending on their default values. The items in the list are separated by
17868 commas or newlines.
17869 If a comma is required in an item, the entire item must be enclosed in double
17870 quotes.
17871
17872 Lines starting with a # character are comments, and are ignored, and # may
17873 also appear following a comma, in which case everything between the # and the
17874 next newline character is ignored.
17875
17876 If an item is entirely enclosed in double quotes, these are removed. Otherwise
17877 double quotes are retained because some forms of mail address require their use
17878 (but never to enclose the entire address). In the following description,
17879 &"item"& refers to what remains after any surrounding double quotes have been
17880 removed.
17881
17882 .vindex "&$local_part$&"
17883 &*Warning*&: If you use an Exim expansion to construct a redirection address,
17884 and the expansion contains a reference to &$local_part$&, you should make use
17885 of the &%quote_local_part%& expansion operator, in case the local part contains
17886 special characters. For example, to redirect all mail for the domain
17887 &'obsolete.example'&, retaining the existing local part, you could use this
17888 setting:
17889 .code
17890 data = ${quote_local_part:$local_part}@newdomain.example
17891 .endd
17892
17893
17894 .section "Redirecting to a local mailbox" "SECTredlocmai"
17895 .cindex "routing" "loops in"
17896 .cindex "loop" "while routing, avoidance of"
17897 .cindex "address redirection" "to local mailbox"
17898 A redirection item may safely be the same as the address currently under
17899 consideration. This does not cause a routing loop, because a router is
17900 automatically skipped if any ancestor of the address that is being processed
17901 is the same as the current address and was processed by the current router.
17902 Such an address is therefore passed to the following routers, so it is handled
17903 as if there were no redirection. When making this loop-avoidance test, the
17904 complete local part, including any prefix or suffix, is used.
17905
17906 .cindex "address redirection" "local part without domain"
17907 Specifying the same local part without a domain is a common usage in personal
17908 filter files when the user wants to have messages delivered to the local
17909 mailbox and also forwarded elsewhere. For example, the user whose login is
17910 &'cleo'& might have a &_.forward_& file containing this:
17911 .code
17912 cleo, cleopatra@egypt.example
17913 .endd
17914 .cindex "backslash in alias file"
17915 .cindex "alias file" "backslash in"
17916 For compatibility with other MTAs, such unqualified local parts may be
17917 preceded by &"\"&, but this is not a requirement for loop prevention. However,
17918 it does make a difference if more than one domain is being handled
17919 synonymously.
17920
17921 If an item begins with &"\"& and the rest of the item parses as a valid RFC
17922 2822 address that does not include a domain, the item is qualified using the
17923 domain of the incoming address. In the absence of a leading &"\"&, unqualified
17924 addresses are qualified using the value in &%qualify_recipient%&, but you can
17925 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
17926
17927 Care must be taken if there are alias names for local users.
17928 Consider an MTA handling a single local domain where the system alias file
17929 contains:
17930 .code
17931 Sam.Reman: spqr
17932 .endd
17933 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
17934 messages in the local mailbox, and also forward copies elsewhere. He creates
17935 this forward file:
17936 .code
17937 Sam.Reman, spqr@reme.elsewhere.example
17938 .endd
17939 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
17940 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
17941 second time round, because it has previously routed it,
17942 and the following routers presumably cannot handle the alias. The forward file
17943 should really contain
17944 .code
17945 spqr, spqr@reme.elsewhere.example
17946 .endd
17947 but because this is such a common error, the &%check_ancestor%& option (see
17948 below) exists to provide a way to get round it. This is normally set on a
17949 &(redirect)& router that is handling users' &_.forward_& files.
17950
17951
17952
17953 .section "Special items in redirection lists" "SECTspecitredli"
17954 In addition to addresses, the following types of item may appear in redirection
17955 lists (that is, in non-filter redirection data):
17956
17957 .ilist
17958 .cindex "pipe" "in redirection list"
17959 .cindex "address redirection" "to pipe"
17960 An item is treated as a pipe command if it begins with &"|"& and does not parse
17961 as a valid RFC 2822 address that includes a domain. A transport for running the
17962 command must be specified by the &%pipe_transport%& option.
17963 Normally, either the router or the transport specifies a user and a group under
17964 which to run the delivery. The default is to use the Exim user and group.
17965
17966 Single or double quotes can be used for enclosing the individual arguments of
17967 the pipe command; no interpretation of escapes is done for single quotes. If
17968 the command contains a comma character, it is necessary to put the whole item
17969 in double quotes, for example:
17970 .code
17971 "|/some/command ready,steady,go"
17972 .endd
17973 since items in redirection lists are terminated by commas. Do not, however,
17974 quote just the command. An item such as
17975 .code
17976 |"/some/command ready,steady,go"
17977 .endd
17978 is interpreted as a pipe with a rather strange command name, and no arguments.
17979
17980 .next
17981 .cindex "file" "in redirection list"
17982 .cindex "address redirection" "to file"
17983 An item is interpreted as a path name if it begins with &"/"& and does not
17984 parse as a valid RFC 2822 address that includes a domain. For example,
17985 .code
17986 /home/world/minbari
17987 .endd
17988 is treated as a file name, but
17989 .code
17990 /s=molari/o=babylon/@x400gate.way
17991 .endd
17992 is treated as an address. For a file name, a transport must be specified using
17993 the &%file_transport%& option. However, if the generated path name ends with a
17994 forward slash character, it is interpreted as a directory name rather than a
17995 file name, and &%directory_transport%& is used instead.
17996
17997 Normally, either the router or the transport specifies a user and a group under
17998 which to run the delivery. The default is to use the Exim user and group.
17999
18000 .cindex "&_/dev/null_&"
18001 However, if a redirection item is the path &_/dev/null_&, delivery to it is
18002 bypassed at a high level, and the log entry shows &"**bypassed**"&
18003 instead of a transport name. In this case the user and group are not used.
18004
18005 .next
18006 .cindex "included address list"
18007 .cindex "address redirection" "included external list"
18008 If an item is of the form
18009 .code
18010 :include:<path name>
18011 .endd
18012 a list of further items is taken from the given file and included at that
18013 point. &*Note*&: Such a file can not be a filter file; it is just an
18014 out-of-line addition to the list. The items in the included list are separated
18015 by commas or newlines and are not subject to expansion. If this is the first
18016 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
18017 the alias name. This example is incorrect:
18018 .code
18019 list1    :include:/opt/lists/list1
18020 .endd
18021 It must be given as
18022 .code
18023 list1:   :include:/opt/lists/list1
18024 .endd
18025 .next
18026 .cindex "address redirection" "to black hole"
18027 Sometimes you want to throw away mail to a particular local part. Making the
18028 &%data%& option expand to an empty string does not work, because that causes
18029 the router to decline. Instead, the alias item
18030 .cindex "black hole"
18031 .cindex "abandoning mail"
18032 &':blackhole:'& can be used. It does what its name implies. No delivery is
18033 done, and no error message is generated. This has the same effect as specifing
18034 &_/dev/null_& as a destination, but it can be independently disabled.
18035
18036 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
18037 delivery is done for the original local part, even if other redirection items
18038 are present. If you are generating a multi-item list (for example, by reading a
18039 database) and need the ability to provide a no-op item, you must use
18040 &_/dev/null_&.
18041
18042 .next
18043 .cindex "delivery" "forcing failure"
18044 .cindex "delivery" "forcing deferral"
18045 .cindex "failing delivery" "forcing"
18046 .cindex "deferred delivery, forcing"
18047 .cindex "customizing" "failure message"
18048 An attempt to deliver a particular address can be deferred or forced to fail by
18049 redirection items of the form
18050 .code
18051 :defer:
18052 :fail:
18053 .endd
18054 respectively. When a redirection list contains such an item, it applies
18055 to the entire redirection; any other items in the list are ignored. Any
18056 text following &':fail:'& or &':defer:'& is placed in the error text
18057 associated with the failure. For example, an alias file might contain:
18058 .code
18059 X.Employee:  :fail: Gone away, no forwarding address
18060 .endd
18061 In the case of an address that is being verified from an ACL or as the subject
18062 of a
18063 .cindex "VRFY" "error text, display of"
18064 VRFY command, the text is included in the SMTP error response by
18065 default.
18066 .cindex "EXPN" "error text, display of"
18067 The text is not included in the response to an EXPN command. In non-SMTP cases
18068 the text is included in the error message that Exim generates.
18069
18070 .cindex "SMTP" "error codes"
18071 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18072 &':fail:'&. However, if the message starts with three digits followed by a
18073 space, optionally followed by an extended code of the form &'n.n.n'&, also
18074 followed by a space, and the very first digit is the same as the default error
18075 code, the code from the message is used instead. If the very first digit is
18076 incorrect, a panic error is logged, and the default code is used. You can
18077 suppress the use of the supplied code in a redirect router by setting the
18078 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18079 ignored.
18080
18081 .vindex "&$acl_verify_message$&"
18082 In an ACL, an explicitly provided message overrides the default, but the
18083 default message is available in the variable &$acl_verify_message$& and can
18084 therefore be included in a custom message if this is desired.
18085
18086 Normally the error text is the rest of the redirection list &-- a comma does
18087 not terminate it &-- but a newline does act as a terminator. Newlines are not
18088 normally present in alias expansions. In &(lsearch)& lookups they are removed
18089 as part of the continuation process, but they may exist in other kinds of
18090 lookup and in &':include:'& files.
18091
18092 During routing for message delivery (as opposed to verification), a redirection
18093 containing &':fail:'& causes an immediate failure of the incoming address,
18094 whereas &':defer:'& causes the message to remain on the queue so that a
18095 subsequent delivery attempt can happen at a later time. If an address is
18096 deferred for too long, it will ultimately fail, because the normal retry
18097 rules still apply.
18098
18099 .next
18100 .cindex "alias file" "exception to default"
18101 Sometimes it is useful to use a single-key search type with a default (see
18102 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18103 for exceptions to the default. These can be handled by aliasing them to
18104 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18105 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18106 results in an empty redirection list has the same effect.
18107 .endlist
18108
18109
18110 .section "Duplicate addresses" "SECTdupaddr"
18111 .cindex "duplicate addresses"
18112 .cindex "address duplicate, discarding"
18113 .cindex "pipe" "duplicated"
18114 Exim removes duplicate addresses from the list to which it is delivering, so as
18115 to deliver just one copy to each address. This does not apply to deliveries
18116 routed to pipes by different immediate parent addresses, but an indirect
18117 aliasing scheme of the type
18118 .code
18119 pipe:       |/some/command $local_part
18120 localpart1: pipe
18121 localpart2: pipe
18122 .endd
18123 does not work with a message that is addressed to both local parts, because
18124 when the second is aliased to the intermediate local part &"pipe"& it gets
18125 discarded as being the same as a previously handled address. However, a scheme
18126 such as
18127 .code
18128 localpart1: |/some/command $local_part
18129 localpart2: |/some/command $local_part
18130 .endd
18131 does result in two different pipe deliveries, because the immediate parents of
18132 the pipes are distinct.
18133
18134
18135
18136 .section "Repeated redirection expansion" "SECID128"
18137 .cindex "repeated redirection expansion"
18138 .cindex "address redirection" "repeated for each delivery attempt"
18139 When a message cannot be delivered to all of its recipients immediately,
18140 leading to two or more delivery attempts, redirection expansion is carried out
18141 afresh each time for those addresses whose children were not all previously
18142 delivered. If redirection is being used as a mailing list, this can lead to new
18143 members of the list receiving copies of old messages. The &%one_time%& option
18144 can be used to avoid this.
18145
18146
18147 .section "Errors in redirection lists" "SECID129"
18148 .cindex "address redirection" "errors"
18149 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18150 error is skipped, and an entry is written to the main log. This may be useful
18151 for mailing lists that are automatically managed. Otherwise, if an error is
18152 detected while generating the list of new addresses, the original address is
18153 deferred. See also &%syntax_errors_to%&.
18154
18155
18156
18157 .section "Private options for the redirect router" "SECID130"
18158
18159 .cindex "options" "&(redirect)& router"
18160 The private options for the &(redirect)& router are as follows:
18161
18162
18163 .option allow_defer redirect boolean false
18164 Setting this option allows the use of &':defer:'& in non-filter redirection
18165 data, or the &%defer%& command in an Exim filter file.
18166
18167
18168 .option allow_fail redirect boolean false
18169 .cindex "failing delivery" "from filter"
18170 If this option is true, the &':fail:'& item can be used in a redirection list,
18171 and the &%fail%& command may be used in an Exim filter file.
18172
18173
18174 .option allow_filter redirect boolean false
18175 .cindex "filter" "enabling use of"
18176 .cindex "Sieve filter" "enabling use of"
18177 Setting this option allows Exim to interpret redirection data that starts with
18178 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
18179 are some features of Exim filter files that some administrators may wish to
18180 lock out; see the &%forbid_filter_%&&'xxx'& options below.
18181
18182 It is also possible to lock out Exim filters or Sieve filters while allowing
18183 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
18184
18185
18186 The filter is run using the uid and gid set by the generic &%user%& and
18187 &%group%& options. These take their defaults from the password data if
18188 &%check_local_user%& is set, so in the normal case of users' personal filter
18189 files, the filter is run as the relevant user. When &%allow_filter%& is set
18190 true, Exim insists that either &%check_local_user%& or &%user%& is set.
18191
18192
18193
18194 .option allow_freeze redirect boolean false
18195 .cindex "freezing messages" "allowing in filter"
18196 Setting this option allows the use of the &%freeze%& command in an Exim filter.
18197 This command is more normally encountered in system filters, and is disabled by
18198 default for redirection filters because it isn't something you usually want to
18199 let ordinary users do.
18200
18201
18202
18203 .option check_ancestor redirect boolean false
18204 This option is concerned with handling generated addresses that are the same
18205 as some address in the list of redirection ancestors of the current address.
18206 Although it is turned off by default in the code, it is set in the default
18207 configuration file for handling users' &_.forward_& files. It is recommended
18208 for this use of the &(redirect)& router.
18209
18210 When &%check_ancestor%& is set, if a generated address (including the domain)
18211 is the same as any ancestor of the current address, it is replaced by a copy of
18212 the current address. This helps in the case where local part A is aliased to B,
18213 and B has a &_.forward_& file pointing back to A. For example, within a single
18214 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
18215 &_&~jb/.forward_& contains:
18216 .code
18217 \Joe.Bloggs, <other item(s)>
18218 .endd
18219 Without the &%check_ancestor%& setting, either local part (&"jb"& or
18220 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
18221 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
18222 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
18223 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
18224 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
18225 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
18226 original address. See also the &%repeat_use%& option below.
18227
18228
18229 .option check_group redirect boolean "see below"
18230 When the &%file%& option is used, the group owner of the file is checked only
18231 when this option is set. The permitted groups are those listed in the
18232 &%owngroups%& option, together with the user's default group if
18233 &%check_local_user%& is set. If the file has the wrong group, routing is
18234 deferred. The default setting for this option is true if &%check_local_user%&
18235 is set and the &%modemask%& option permits the group write bit, or if the
18236 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
18237
18238
18239
18240 .option check_owner redirect boolean "see below"
18241 When the &%file%& option is used, the owner of the file is checked only when
18242 this option is set. If &%check_local_user%& is set, the local user is
18243 permitted; otherwise the owner must be one of those listed in the &%owners%&
18244 option. The default value for this option is true if &%check_local_user%& or
18245 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
18246
18247
18248 .option data redirect string&!! unset
18249 This option is mutually exclusive with &%file%&. One or other of them must be
18250 set, but not both. The contents of &%data%& are expanded, and then used as the
18251 list of forwarding items, or as a set of filtering instructions. If the
18252 expansion is forced to fail, or the result is an empty string or a string that
18253 has no effect (consists entirely of comments), the router declines.
18254
18255 When filtering instructions are used, the string must begin with &"#Exim
18256 filter"&, and all comments in the string, including this initial one, must be
18257 terminated with newline characters. For example:
18258 .code
18259 data = #Exim filter\n\
18260        if $h_to: contains Exim then save $home/mail/exim endif
18261 .endd
18262 If you are reading the data from a database where newlines cannot be included,
18263 you can use the &${sg}$& expansion item to turn the escape string of your
18264 choice into a newline.
18265
18266
18267 .option directory_transport redirect string&!! unset
18268 A &(redirect)& router sets up a direct delivery to a directory when a path name
18269 ending with a slash is specified as a new &"address"&. The transport used is
18270 specified by this option, which, after expansion, must be the name of a
18271 configured transport. This should normally be an &(appendfile)& transport.
18272
18273
18274 .option file redirect string&!! unset
18275 This option specifies the name of a file that contains the redirection data. It
18276 is mutually exclusive with the &%data%& option. The string is expanded before
18277 use; if the expansion is forced to fail, the router declines. Other expansion
18278 failures cause delivery to be deferred. The result of a successful expansion
18279 must be an absolute path. The entire file is read and used as the redirection
18280 data. If the data is an empty string or a string that has no effect (consists
18281 entirely of comments), the router declines.
18282
18283 .cindex "NFS" "checking for file existence"
18284 If the attempt to open the file fails with a &"does not exist"& error, Exim
18285 runs a check on the containing directory,
18286 unless &%ignore_enotdir%& is true (see below).
18287 If the directory does not appear to exist, delivery is deferred. This can
18288 happen when users' &_.forward_& files are in NFS-mounted directories, and there
18289 is a mount problem. If the containing directory does exist, but the file does
18290 not, the router declines.
18291
18292
18293 .option file_transport redirect string&!! unset
18294 .vindex "&$address_file$&"
18295 A &(redirect)& router sets up a direct delivery to a file when a path name not
18296 ending in a slash is specified as a new &"address"&. The transport used is
18297 specified by this option, which, after expansion, must be the name of a
18298 configured transport. This should normally be an &(appendfile)& transport. When
18299 it is running, the file name is in &$address_file$&.
18300
18301
18302 .option filter_prepend_home redirect boolean true
18303 When this option is true, if a &(save)& command in an Exim filter specifies a
18304 relative path, and &$home$& is defined, it is automatically prepended to the
18305 relative path. If this option is set false, this action does not happen. The
18306 relative path is then passed to the transport unmodified.
18307
18308
18309 .option forbid_blackhole redirect boolean false
18310 If this option is true, the &':blackhole:'& item may not appear in a
18311 redirection list.
18312
18313
18314 .option forbid_exim_filter redirect boolean false
18315 If this option is set true, only Sieve filters are permitted when
18316 &%allow_filter%& is true.
18317
18318
18319
18320
18321 .option forbid_file redirect boolean false
18322 .cindex "delivery" "to file; forbidding"
18323 .cindex "Sieve filter" "forbidding delivery to a file"
18324 .cindex "Sieve filter" "&""keep""& facility; disabling"
18325 If this option is true, this router may not generate a new address that
18326 specifies delivery to a local file or directory, either from a filter or from a
18327 conventional forward file. This option is forced to be true if &%one_time%& is
18328 set. It applies to Sieve filters as well as to Exim filters, but if true, it
18329 locks out the Sieve's &"keep"& facility.
18330
18331
18332 .option forbid_filter_dlfunc redirect boolean false
18333 .cindex "filter" "locking out certain features"
18334 If this option is true, string expansions in Exim filters are not allowed to
18335 make use of the &%dlfunc%& expansion facility to run dynamically loaded
18336 functions.
18337
18338 .option forbid_filter_existstest redirect boolean false
18339 .cindex "expansion" "statting a file"
18340 If this option is true, string expansions in Exim filters are not allowed to
18341 make use of the &%exists%& condition or the &%stat%& expansion item.
18342
18343 .option forbid_filter_logwrite redirect boolean false
18344 If this option is true, use of the logging facility in Exim filters is not
18345 permitted. Logging is in any case available only if the filter is being run
18346 under some unprivileged uid (which is normally the case for ordinary users'
18347 &_.forward_& files).
18348
18349
18350 .option forbid_filter_lookup redirect boolean false
18351 If this option is true, string expansions in Exim filter files are not allowed
18352 to make use of &%lookup%& items.
18353
18354
18355 .option forbid_filter_perl redirect boolean false
18356 This option has an effect only if Exim is built with embedded Perl support. If
18357 it is true, string expansions in Exim filter files are not allowed to make use
18358 of the embedded Perl support.
18359
18360
18361 .option forbid_filter_readfile redirect boolean false
18362 If this option is true, string expansions in Exim filter files are not allowed
18363 to make use of &%readfile%& items.
18364
18365
18366 .option forbid_filter_readsocket redirect boolean false
18367 If this option is true, string expansions in Exim filter files are not allowed
18368 to make use of &%readsocket%& items.
18369
18370
18371 .option forbid_filter_reply redirect boolean false
18372 If this option is true, this router may not generate an automatic reply
18373 message. Automatic replies can be generated only from Exim or Sieve filter
18374 files, not from traditional forward files. This option is forced to be true if
18375 &%one_time%& is set.
18376
18377
18378 .option forbid_filter_run redirect boolean false
18379 If this option is true, string expansions in Exim filter files are not allowed
18380 to make use of &%run%& items.
18381
18382
18383 .option forbid_include redirect boolean false
18384 If this option is true, items of the form
18385 .code
18386 :include:<path name>
18387 .endd
18388 are not permitted in non-filter redirection lists.
18389
18390
18391 .option forbid_pipe redirect boolean false
18392 .cindex "delivery" "to pipe; forbidding"
18393 If this option is true, this router may not generate a new address which
18394 specifies delivery to a pipe, either from an Exim filter or from a conventional
18395 forward file. This option is forced to be true if &%one_time%& is set.
18396
18397
18398 .option forbid_sieve_filter redirect boolean false
18399 If this option is set true, only Exim filters are permitted when
18400 &%allow_filter%& is true.
18401
18402
18403 .cindex "SMTP" "error codes"
18404 .option forbid_smtp_code redirect boolean false
18405 If this option is set true, any SMTP error codes that are present at the start
18406 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
18407 the default codes (451 and 550, respectively) are always used.
18408
18409
18410
18411
18412 .option hide_child_in_errmsg redirect boolean false
18413 .cindex "bounce message" "redirection details; suppressing"
18414 If this option is true, it prevents Exim from quoting a child address if it
18415 generates a bounce or delay message for it. Instead it says &"an address
18416 generated from <&'the top level address'&>"&. Of course, this applies only to
18417 bounces generated locally. If a message is forwarded to another host, &'its'&
18418 bounce may well quote the generated address.
18419
18420
18421 .option ignore_eacces redirect boolean false
18422 .cindex "EACCES"
18423 If this option is set and an attempt to open a redirection file yields the
18424 EACCES error (permission denied), the &(redirect)& router behaves as if the
18425 file did not exist.
18426
18427
18428 .option ignore_enotdir redirect boolean false
18429 .cindex "ENOTDIR"
18430 If this option is set and an attempt to open a redirection file yields the
18431 ENOTDIR error (something on the path is not a directory), the &(redirect)&
18432 router behaves as if the file did not exist.
18433
18434 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
18435 router that has the &%file%& option set discovers that the file does not exist
18436 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
18437 against unmounted NFS directories. If the parent can not be statted, delivery
18438 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
18439 is set, because that option tells Exim to ignore &"something on the path is not
18440 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
18441 that some operating systems give ENOENT where others give ENOTDIR.
18442
18443
18444
18445 .option include_directory redirect string unset
18446 If this option is set, the path names of any &':include:'& items in a
18447 redirection list must start with this directory.
18448
18449
18450 .option modemask redirect "octal integer" 022
18451 This specifies mode bits which must not be set for a file specified by the
18452 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
18453
18454
18455 .option one_time redirect boolean false
18456 .cindex "one-time aliasing/forwarding expansion"
18457 .cindex "alias file" "one-time expansion"
18458 .cindex "forward file" "one-time expansion"
18459 .cindex "mailing lists" "one-time expansion"
18460 .cindex "address redirection" "one-time expansion"
18461 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
18462 files each time it tries to deliver a message causes a problem when one or more
18463 of the generated addresses fails be delivered at the first attempt. The problem
18464 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
18465 but of what happens when the redirection list changes during the time that the
18466 message is on Exim's queue. This is particularly true in the case of mailing
18467 lists, where new subscribers might receive copies of messages that were posted
18468 before they subscribed.
18469
18470 If &%one_time%& is set and any addresses generated by the router fail to
18471 deliver at the first attempt, the failing addresses are added to the message as
18472 &"top level"& addresses, and the parent address that generated them is marked
18473 &"delivered"&. Thus, redirection does not happen again at the next delivery
18474 attempt.
18475
18476 &*Warning 1*&: Any header line addition or removal that is specified by this
18477 router would be lost if delivery did not succeed at the first attempt. For this
18478 reason, the &%headers_add%& and &%headers_remove%& generic options are not
18479 permitted when &%one_time%& is set.
18480
18481 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
18482 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
18483 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
18484
18485 &*Warning 3*&: The &%unseen%& generic router option may not be set with
18486 &%one_time%&.
18487
18488 The original top-level address is remembered with each of the generated
18489 addresses, and is output in any log messages. However, any intermediate parent
18490 addresses are not recorded. This makes a difference to the log only if
18491 &%all_parents%& log selector is set. It is expected that &%one_time%& will
18492 typically be used for mailing lists, where there is normally just one level of
18493 expansion.
18494
18495
18496 .option owners redirect "string list" unset
18497 .cindex "ownership" "alias file"
18498 .cindex "ownership" "forward file"
18499 .cindex "alias file" "ownership"
18500 .cindex "forward file" "ownership"
18501 This specifies a list of permitted owners for the file specified by &%file%&.
18502 This list is in addition to the local user when &%check_local_user%& is set.
18503 See &%check_owner%& above.
18504
18505
18506 .option owngroups redirect "string list" unset
18507 This specifies a list of permitted groups for the file specified by &%file%&.
18508 The list is in addition to the local user's primary group when
18509 &%check_local_user%& is set. See &%check_group%& above.
18510
18511
18512 .option pipe_transport redirect string&!! unset
18513 .vindex "&$address_pipe$&"
18514 A &(redirect)& router sets up a direct delivery to a pipe when a string
18515 starting with a vertical bar character is specified as a new &"address"&. The
18516 transport used is specified by this option, which, after expansion, must be the
18517 name of a configured transport. This should normally be a &(pipe)& transport.
18518 When the transport is run, the pipe command is in &$address_pipe$&.
18519
18520
18521 .option qualify_domain redirect string&!! unset
18522 .vindex "&$qualify_recipient$&"
18523 If this option is set, and an unqualified address (one without a domain) is
18524 generated, and that address would normally be qualified by the global setting
18525 in &%qualify_recipient%&, it is instead qualified with the domain specified by
18526 expanding this string. If the expansion fails, the router declines. If you want
18527 to revert to the default, you can have the expansion generate
18528 &$qualify_recipient$&.
18529
18530 This option applies to all unqualified addresses generated by Exim filters,
18531 but for traditional &_.forward_& files, it applies only to addresses that are
18532 not preceded by a backslash. Sieve filters cannot generate unqualified
18533 addresses.
18534
18535 .option qualify_preserve_domain redirect boolean false
18536 .cindex "domain" "in redirection; preserving"
18537 .cindex "preserving domain in redirection"
18538 .cindex "address redirection" "domain; preserving"
18539 If this option is set, the router's local &%qualify_domain%& option must not be
18540 set (a configuration error occurs if it is). If an unqualified address (one
18541 without a domain) is generated, it is qualified with the domain of the parent
18542 address (the immediately preceding ancestor) instead of the global
18543 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
18544 this applies whether or not the address is preceded by a backslash.
18545
18546
18547 .option repeat_use redirect boolean true
18548 If this option is set false, the router is skipped for a child address that has
18549 any ancestor that was routed by this router. This test happens before any of
18550 the other preconditions are tested. Exim's default anti-looping rules skip
18551 only when the ancestor is the same as the current address. See also
18552 &%check_ancestor%& above and the generic &%redirect_router%& option.
18553
18554
18555 .option reply_transport redirect string&!! unset
18556 A &(redirect)& router sets up an automatic reply when a &%mail%& or
18557 &%vacation%& command is used in a filter file. The transport used is specified
18558 by this option, which, after expansion, must be the name of a configured
18559 transport. This should normally be an &(autoreply)& transport. Other transports
18560 are unlikely to do anything sensible or useful.
18561
18562
18563 .option rewrite redirect boolean true
18564 .cindex "address redirection" "disabling rewriting"
18565 If this option is set false, addresses generated by the router are not
18566 subject to address rewriting. Otherwise, they are treated like new addresses
18567 and are rewritten according to the global rewriting rules.
18568
18569
18570 .option sieve_subaddress redirect string&!! unset
18571 The value of this option is passed to a Sieve filter to specify the
18572 :subaddress part of an address.
18573
18574 .option sieve_useraddress redirect string&!! unset
18575 The value of this option is passed to a Sieve filter to specify the :user part
18576 of an address. However, if it is unset, the entire original local part
18577 (including any prefix or suffix) is used for :user.
18578
18579
18580 .option sieve_vacation_directory redirect string&!! unset
18581 .cindex "Sieve filter" "vacation directory"
18582 To enable the &"vacation"& extension for Sieve filters, you must set
18583 &%sieve_vacation_directory%& to the directory where vacation databases are held
18584 (do not put anything else in that directory), and ensure that the
18585 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
18586 needs their own directory; Exim will create it if necessary.
18587
18588
18589
18590 .option skip_syntax_errors redirect boolean false
18591 .cindex "forward file" "broken"
18592 .cindex "address redirection" "broken files"
18593 .cindex "alias file" "broken"
18594 .cindex "broken alias or forward files"
18595 .cindex "ignoring faulty addresses"
18596 .cindex "skipping faulty addresses"
18597 .cindex "error" "skipping bad syntax"
18598 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
18599 non-filter redirection data are skipped, and each failing address is logged. If
18600 &%syntax_errors_to%& is set, a message is sent to the address it defines,
18601 giving details of the failures. If &%syntax_errors_text%& is set, its contents
18602 are expanded and placed at the head of the error message generated by
18603 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
18604 be the same address as the generic &%errors_to%& option. The
18605 &%skip_syntax_errors%& option is often used when handling mailing lists.
18606
18607 If all the addresses in a redirection list are skipped because of syntax
18608 errors, the router declines to handle the original address, and it is passed to
18609 the following routers.
18610
18611 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
18612 error in the filter causes filtering to be abandoned without any action being
18613 taken. The incident is logged, and the router declines to handle the address,
18614 so it is passed to the following routers.
18615
18616 .cindex "Sieve filter" "syntax errors in"
18617 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
18618 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
18619 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
18620
18621 &%skip_syntax_errors%& can be used to specify that errors in users' forward
18622 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
18623 option, used with an address that does not get redirected, can be used to
18624 notify users of these errors, by means of a router like this:
18625 .code
18626 userforward:
18627   driver = redirect
18628   allow_filter
18629   check_local_user
18630   file = $home/.forward
18631   file_transport = address_file
18632   pipe_transport = address_pipe
18633   reply_transport = address_reply
18634   no_verify
18635   skip_syntax_errors
18636   syntax_errors_to = real-$local_part@$domain
18637   syntax_errors_text = \
18638    This is an automatically generated message. An error has\n\
18639    been found in your .forward file. Details of the error are\n\
18640    reported below. While this error persists, you will receive\n\
18641    a copy of this message for every message that is addressed\n\
18642    to you. If your .forward file is a filter file, or if it is\n\
18643    a non-filter file containing no valid forwarding addresses,\n\
18644    a copy of each incoming message will be put in your normal\n\
18645    mailbox. If a non-filter file contains at least one valid\n\
18646    forwarding address, forwarding to the valid addresses will\n\
18647    happen, and those will be the only deliveries that occur.
18648 .endd
18649 You also need a router to ensure that local addresses that are prefixed by
18650 &`real-`& are recognized, but not forwarded or filtered. For example, you could
18651 put this immediately before the &(userforward)& router:
18652 .code
18653 real_localuser:
18654   driver = accept
18655   check_local_user
18656   local_part_prefix = real-
18657   transport = local_delivery
18658 .endd
18659 For security, it would probably be a good idea to restrict the use of this
18660 router to locally-generated messages, using a condition such as this:
18661 .code
18662   condition = ${if match {$sender_host_address}\
18663                          {\N^(|127\.0\.0\.1)$\N}}
18664 .endd
18665
18666
18667 .option syntax_errors_text redirect string&!! unset
18668 See &%skip_syntax_errors%& above.
18669
18670
18671 .option syntax_errors_to redirect string unset
18672 See &%skip_syntax_errors%& above.
18673 .ecindex IIDredrou1
18674 .ecindex IIDredrou2
18675
18676
18677
18678
18679
18680
18681 . ////////////////////////////////////////////////////////////////////////////
18682 . ////////////////////////////////////////////////////////////////////////////
18683
18684 .chapter "Environment for running local transports" "CHAPenvironment" &&&
18685          "Environment for local transports"
18686 .scindex IIDenvlotra1 "local transports" "environment for"
18687 .scindex IIDenvlotra2 "environment for local transports"
18688 .scindex IIDenvlotra3 "transport" "local; environment for"
18689 Local transports handle deliveries to files and pipes. (The &(autoreply)&
18690 transport can be thought of as similar to a pipe.) Exim always runs transports
18691 in subprocesses, under specified uids and gids. Typical deliveries to local
18692 mailboxes run under the uid and gid of the local user.
18693
18694 Exim also sets a specific current directory while running the transport; for
18695 some transports a home directory setting is also relevant. The &(pipe)&
18696 transport is the only one that sets up environment variables; see section
18697 &<<SECTpipeenv>>& for details.
18698
18699 The values used for the uid, gid, and the directories may come from several
18700 different places. In many cases, the router that handles the address associates
18701 settings with that address as a result of its &%check_local_user%&, &%group%&,
18702 or &%user%& options. However, values may also be given in the transport's own
18703 configuration, and these override anything that comes from the router.
18704
18705
18706
18707 .section "Concurrent deliveries" "SECID131"
18708 .cindex "concurrent deliveries"
18709 .cindex "simultaneous deliveries"
18710 If two different messages for the same local recipient arrive more or less
18711 simultaneously, the two delivery processes are likely to run concurrently. When
18712 the &(appendfile)& transport is used to write to a file, Exim applies locking
18713 rules to stop concurrent processes from writing to the same file at the same
18714 time.
18715
18716 However, when you use a &(pipe)& transport, it is up to you to arrange any
18717 locking that is needed. Here is a silly example:
18718 .code
18719 my_transport:
18720   driver = pipe
18721   command = /bin/sh -c 'cat >>/some/file'
18722 .endd
18723 This is supposed to write the message at the end of the file. However, if two
18724 messages arrive at the same time, the file will be scrambled. You can use the
18725 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
18726 file using the same algorithm that Exim itself uses.
18727
18728
18729
18730
18731 .section "Uids and gids" "SECTenvuidgid"
18732 .cindex "local transports" "uid and gid"
18733 .cindex "transport" "local; uid and gid"
18734 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
18735 overrides any group that the router set in the address, even if &%user%& is not
18736 set for the transport. This makes it possible, for example, to run local mail
18737 delivery under the uid of the recipient (set by the router), but in a special
18738 group (set by the transport). For example:
18739 .code
18740 # Routers ...
18741 # User/group are set by check_local_user in this router
18742 local_users:
18743   driver = accept
18744   check_local_user
18745   transport = group_delivery
18746
18747 # Transports ...
18748 # This transport overrides the group
18749 group_delivery:
18750   driver = appendfile
18751   file = /var/spool/mail/$local_part
18752   group = mail
18753 .endd
18754 If &%user%& is set for a transport, its value overrides what is set in the
18755 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
18756 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
18757 set.
18758
18759 .oindex "&%initgroups%&"
18760 When the uid is taken from the transport's configuration, the &[initgroups()]&
18761 function is called for the groups associated with that uid if the
18762 &%initgroups%& option is set for the transport. When the uid is not specified
18763 by the transport, but is associated with the address by a router, the option
18764 for calling &[initgroups()]& is taken from the router configuration.
18765
18766 .cindex "&(pipe)& transport" "uid for"
18767 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
18768 is set and &%user%& is not set, the uid of the process that called Exim to
18769 receive the message is used, and if &%group%& is not set, the corresponding
18770 original gid is also used.
18771
18772 This is the detailed preference order for obtaining a gid; the first of the
18773 following that is set is used:
18774
18775 .ilist
18776 A &%group%& setting of the transport;
18777 .next
18778 A &%group%& setting of the router;
18779 .next
18780 A gid associated with a user setting of the router, either as a result of
18781 &%check_local_user%& or an explicit non-numeric &%user%& setting;
18782 .next
18783 The group associated with a non-numeric &%user%& setting of the transport;
18784 .next
18785 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
18786 the uid is the creator's uid;
18787 .next
18788 The Exim gid if the Exim uid is being used as a default.
18789 .endlist
18790
18791 If, for example, the user is specified numerically on the router and there are
18792 no group settings, no gid is available. In this situation, an error occurs.
18793 This is different for the uid, for which there always is an ultimate default.
18794 The first of the following that is set is used:
18795
18796 .ilist
18797 A &%user%& setting of the transport;
18798 .next
18799 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
18800 .next
18801 A &%user%& setting of the router;
18802 .next
18803 A &%check_local_user%& setting of the router;
18804 .next
18805 The Exim uid.
18806 .endlist
18807
18808 Of course, an error will still occur if the uid that is chosen is on the
18809 &%never_users%& list.
18810
18811
18812
18813
18814
18815 .section "Current and home directories" "SECID132"
18816 .cindex "current directory for local transport"
18817 .cindex "home directory" "for local transport"
18818 .cindex "transport" "local; home directory for"
18819 .cindex "transport" "local; current directory for"
18820 Routers may set current and home directories for local transports by means of
18821 the &%transport_current_directory%& and &%transport_home_directory%& options.
18822 However, if the transport's &%current_directory%& or &%home_directory%& options
18823 are set, they override the router's values. In detail, the home directory
18824 for a local transport is taken from the first of these values that is set:
18825
18826 .ilist
18827 The &%home_directory%& option on the transport;
18828 .next
18829 The &%transport_home_directory%& option on the router;
18830 .next
18831 The password data if &%check_local_user%& is set on the router;
18832 .next
18833 The &%router_home_directory%& option on the router.
18834 .endlist
18835
18836 The current directory is taken from the first of these values that is set:
18837
18838 .ilist
18839 The &%current_directory%& option on the transport;
18840 .next
18841 The &%transport_current_directory%& option on the router.
18842 .endlist
18843
18844
18845 If neither the router nor the transport sets a current directory, Exim uses the
18846 value of the home directory, if it is set. Otherwise it sets the current
18847 directory to &_/_& before running a local transport.
18848
18849
18850
18851 .section "Expansion variables derived from the address" "SECID133"
18852 .vindex "&$domain$&"
18853 .vindex "&$local_part$&"
18854 .vindex "&$original_domain$&"
18855 Normally a local delivery is handling a single address, and in that case the
18856 variables such as &$domain$& and &$local_part$& are set during local
18857 deliveries. However, in some circumstances more than one address may be handled
18858 at once (for example, while writing batch SMTP for onward transmission by some
18859 other means). In this case, the variables associated with the local part are
18860 never set, &$domain$& is set only if all the addresses have the same domain,
18861 and &$original_domain$& is never set.
18862 .ecindex IIDenvlotra1
18863 .ecindex IIDenvlotra2
18864 .ecindex IIDenvlotra3
18865
18866
18867
18868
18869
18870
18871
18872 . ////////////////////////////////////////////////////////////////////////////
18873 . ////////////////////////////////////////////////////////////////////////////
18874
18875 .chapter "Generic options for transports" "CHAPtransportgeneric"
18876 .scindex IIDgenoptra1 "generic options" "transport"
18877 .scindex IIDgenoptra2 "options" "generic; for transports"
18878 .scindex IIDgenoptra3 "transport" "generic options for"
18879 The following generic options apply to all transports:
18880
18881
18882 .option body_only transports boolean false
18883 .cindex "transport" "body only"
18884 .cindex "message" "transporting body only"
18885 .cindex "body of message" "transporting"
18886 If this option is set, the message's headers are not transported. It is
18887 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
18888 or &(pipe)& transports, the settings of &%message_prefix%& and
18889 &%message_suffix%& should be checked, because this option does not
18890 automatically suppress them.
18891
18892
18893 .option current_directory transports string&!! unset
18894 .cindex "transport" "current directory for"
18895 This specifies the current directory that is to be set while running the
18896 transport, overriding any value that may have been set by the router.
18897 If the expansion fails for any reason, including forced failure, an error is
18898 logged, and delivery is deferred.
18899
18900
18901 .option disable_logging transports boolean false
18902 If this option is set true, nothing is logged for any
18903 deliveries by the transport or for any
18904 transport errors. You should not set this option unless you really, really know
18905 what you are doing.
18906
18907
18908 .option debug_print transports string&!! unset
18909 .cindex "testing" "variables in drivers"
18910 If this option is set and debugging is enabled (see the &%-d%& command line
18911 option), the string is expanded and included in the debugging output when the
18912 transport is run.
18913 If expansion of the string fails, the error message is written to the debugging
18914 output, and Exim carries on processing.
18915 This facility is provided to help with checking out the values of variables and
18916 so on when debugging driver configurations. For example, if a &%headers_add%&
18917 option is not working properly, &%debug_print%& could be used to output the
18918 variables it references. A newline is added to the text if it does not end with
18919 one.
18920
18921
18922 .option delivery_date_add transports boolean false
18923 .cindex "&'Delivery-date:'& header line"
18924 If this option is true, a &'Delivery-date:'& header is added to the message.
18925 This gives the actual time the delivery was made. As this is not a standard
18926 header, Exim has a configuration option (&%delivery_date_remove%&) which
18927 requests its removal from incoming messages, so that delivered messages can
18928 safely be resent to other recipients.
18929
18930
18931 .option driver transports string unset
18932 This specifies which of the available transport drivers is to be used.
18933 There is no default, and this option must be set for every transport.
18934
18935
18936 .option envelope_to_add transports boolean false
18937 .cindex "&'Envelope-to:'& header line"
18938 If this option is true, an &'Envelope-to:'& header is added to the message.
18939 This gives the original address(es) in the incoming envelope that caused this
18940 delivery to happen. More than one address may be present if the transport is
18941 configured to handle several addresses at once, or if more than one original
18942 address was redirected to the same final address. As this is not a standard
18943 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
18944 its removal from incoming messages, so that delivered messages can safely be
18945 resent to other recipients.
18946
18947
18948 .option group transports string&!! "Exim group"
18949 .cindex "transport" "group; specifying"
18950 This option specifies a gid for running the transport process, overriding any
18951 value that the router supplies, and also overriding any value associated with
18952 &%user%& (see below).
18953
18954
18955 .option headers_add transports string&!! unset
18956 .cindex "header lines" "adding in transport"
18957 .cindex "transport" "header lines; adding"
18958 This option specifies a string of text that is expanded and added to the header
18959 portion of a message as it is transported, as described in section
18960 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
18961 routers. If the result of the expansion is an empty string, or if the expansion
18962 is forced to fail, no action is taken. Other expansion failures are treated as
18963 errors and cause the delivery to be deferred.
18964
18965
18966
18967 .option headers_only transports boolean false
18968 .cindex "transport" "header lines only"
18969 .cindex "message" "transporting headers only"
18970 .cindex "header lines" "transporting"
18971 If this option is set, the message's body is not transported. It is mutually
18972 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
18973 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
18974 checked, since this option does not automatically suppress them.
18975
18976
18977 .option headers_remove transports string&!! unset
18978 .cindex "header lines" "removing"
18979 .cindex "transport" "header lines; removing"
18980 This option specifies a string that is expanded into a list of header names;
18981 these headers are omitted from the message as it is transported, as described
18982 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
18983 routers. If the result of the expansion is an empty string, or if the expansion
18984 is forced to fail, no action is taken. Other expansion failures are treated as
18985 errors and cause the delivery to be deferred.
18986
18987
18988
18989 .option headers_rewrite transports string unset
18990 .cindex "transport" "header lines; rewriting"
18991 .cindex "rewriting" "at transport time"
18992 This option allows addresses in header lines to be rewritten at transport time,
18993 that is, as the message is being copied to its destination. The contents of the
18994 option are a colon-separated list of rewriting rules. Each rule is in exactly
18995 the same form as one of the general rewriting rules that are applied when a
18996 message is received. These are described in chapter &<<CHAPrewrite>>&. For
18997 example,
18998 .code
18999 headers_rewrite = a@b c@d f : \
19000                   x@y w@z
19001 .endd
19002 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
19003 &'w@z'& in all address-bearing header lines. The rules are applied to the
19004 header lines just before they are written out at transport time, so they affect
19005 only those copies of the message that pass through the transport. However, only
19006 the message's original header lines, and any that were added by a system
19007 filter, are rewritten. If a router or transport adds header lines, they are not
19008 affected by this option. These rewriting rules are &'not'& applied to the
19009 envelope. You can change the return path using &%return_path%&, but you cannot
19010 change envelope recipients at this time.
19011
19012
19013 .option home_directory transports string&!! unset
19014 .cindex "transport" "home directory for"
19015 .vindex "&$home$&"
19016 This option specifies a home directory setting for a local transport,
19017 overriding any value that may be set by the router. The home directory is
19018 placed in &$home$& while expanding the transport's private options. It is also
19019 used as the current directory if no current directory is set by the
19020 &%current_directory%& option on the transport or the
19021 &%transport_current_directory%& option on the router. If the expansion fails
19022 for any reason, including forced failure, an error is logged, and delivery is
19023 deferred.
19024
19025
19026 .option initgroups transports boolean false
19027 .cindex "additional groups"
19028 .cindex "groups" "additional"
19029 .cindex "transport" "group; additional"
19030 If this option is true and the uid for the delivery process is provided by the
19031 transport, the &[initgroups()]& function is called when running the transport
19032 to ensure that any additional groups associated with the uid are set up.
19033
19034
19035 .option message_size_limit transports string&!! 0
19036 .cindex "limit" "message size per transport"
19037 .cindex "size" "of message, limit"
19038 .cindex "transport" "message size; limiting"
19039 This option controls the size of messages passed through the transport. It is
19040 expanded before use; the result of the expansion must be a sequence of decimal
19041 digits, optionally followed by K or M. If the expansion fails for any reason,
19042 including forced failure, or if the result is not of the required form,
19043 delivery is deferred. If the value is greater than zero and the size of a
19044 message exceeds this limit, the address is failed. If there is any chance that
19045 the resulting bounce message could be routed to the same transport, you should
19046 ensure that &%return_size_limit%& is less than the transport's
19047 &%message_size_limit%&, as otherwise the bounce message will fail to get
19048 delivered.
19049
19050
19051
19052 .option rcpt_include_affixes transports boolean false
19053 .cindex "prefix" "for local part, including in envelope"
19054 .cindex "suffix for local part" "including in envelope"
19055 .cindex "local part" "prefix"
19056 .cindex "local part" "suffix"
19057 When this option is false (the default), and an address that has had any
19058 affixes (prefixes or suffixes) removed from the local part is delivered by any
19059 form of SMTP or LMTP, the affixes are not included. For example, if a router
19060 that contains
19061 .code
19062 local_part_prefix = *-
19063 .endd
19064 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19065 is delivered with
19066 .code
19067 RCPT TO:<xyz@some.domain>
19068 .endd
19069 This is also the case when an ACL-time callout is being used to verify a
19070 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19071 whole local part is included in the RCPT command. This option applies to BSMTP
19072 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19073 &(lmtp)& and &(smtp)& transports.
19074
19075
19076 .option retry_use_local_part transports boolean "see below"
19077 .cindex "hints database" "retry keys"
19078 When a delivery suffers a temporary failure, a retry record is created
19079 in Exim's hints database. For remote deliveries, the key for the retry record
19080 is based on the name and/or IP address of the failing remote host. For local
19081 deliveries, the key is normally the entire address, including both the local
19082 part and the domain. This is suitable for most common cases of local delivery
19083 temporary failure &-- for example, exceeding a mailbox quota should delay only
19084 deliveries to that mailbox, not to the whole domain.
19085
19086 However, in some special cases you may want to treat a temporary local delivery
19087 as a failure associated with the domain, and not with a particular local part.
19088 (For example, if you are storing all mail for some domain in files.) You can do
19089 this by setting &%retry_use_local_part%& false.
19090
19091 For all the local transports, its default value is true. For remote transports,
19092 the default value is false for tidiness, but changing the value has no effect
19093 on a remote transport in the current implementation.
19094
19095
19096 .option return_path transports string&!! unset
19097 .cindex "envelope sender"
19098 .cindex "transport" "return path; changing"
19099 .cindex "return path" "changing in transport"
19100 If this option is set, the string is expanded at transport time and replaces
19101 the existing return path (envelope sender) value in the copy of the message
19102 that is being delivered. An empty return path is permitted. This feature is
19103 designed for remote deliveries, where the value of this option is used in the
19104 SMTP MAIL command. If you set &%return_path%& for a local transport, the
19105 only effect is to change the address that is placed in the &'Return-path:'&
19106 header line, if one is added to the message (see the next option).
19107
19108 &*Note:*& A changed return path is not logged unless you add
19109 &%return_path_on_delivery%& to the log selector.
19110
19111 .vindex "&$return_path$&"
19112 The expansion can refer to the existing value via &$return_path$&. This is
19113 either the message's envelope sender, or an address set by the
19114 &%errors_to%& option on a router. If the expansion is forced to fail, no
19115 replacement occurs; if it fails for another reason, delivery is deferred. This
19116 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19117 section &<<SECTverp>>&.
19118
19119 &*Note*&: If a delivery error is detected locally, including the case when a
19120 remote server rejects a message at SMTP time, the bounce message is not sent to
19121 the value of this option. It is sent to the previously set errors address.
19122 This defaults to the incoming sender address, but can be changed by setting
19123 &%errors_to%& in a router.
19124
19125
19126
19127 .option return_path_add transports boolean false
19128 .cindex "&'Return-path:'& header line"
19129 If this option is true, a &'Return-path:'& header is added to the message.
19130 Although the return path is normally available in the prefix line of BSD
19131 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19132 have easy access to it.
19133
19134 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19135 the delivery SMTP server makes the final delivery"&. This implies that this
19136 header should not be present in incoming messages. Exim has a configuration
19137 option, &%return_path_remove%&, which requests removal of this header from
19138 incoming messages, so that delivered messages can safely be resent to other
19139 recipients.
19140
19141
19142 .option shadow_condition transports string&!! unset
19143 See &%shadow_transport%& below.
19144
19145
19146 .option shadow_transport transports string unset
19147 .cindex "shadow transport"
19148 .cindex "transport" "shadow"
19149 A local transport may set the &%shadow_transport%& option to the name of
19150 another local transport. Shadow remote transports are not supported.
19151
19152 Whenever a delivery to the main transport succeeds, and either
19153 &%shadow_condition%& is unset, or its expansion does not result in the empty
19154 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
19155 passed to the shadow transport, with the same delivery address or addresses. If
19156 expansion fails, no action is taken except that non-forced expansion failures
19157 cause a log line to be written.
19158
19159 The result of the shadow transport is discarded and does not affect the
19160 subsequent processing of the message. Only a single level of shadowing is
19161 provided; the &%shadow_transport%& option is ignored on any transport when it
19162 is running as a shadow. Options concerned with output from pipes are also
19163 ignored. The log line for the successful delivery has an item added on the end,
19164 of the form
19165 .code
19166 ST=<shadow transport name>
19167 .endd
19168 If the shadow transport did not succeed, the error message is put in
19169 parentheses afterwards. Shadow transports can be used for a number of different
19170 purposes, including keeping more detailed log information than Exim normally
19171 provides, and implementing automatic acknowledgment policies based on message
19172 headers that some sites insist on.
19173
19174
19175 .option transport_filter transports string&!! unset
19176 .cindex "transport" "filter"
19177 .cindex "filter" "transport filter"
19178 This option sets up a filtering (in the Unix shell sense) process for messages
19179 at transport time. It should not be confused with mail filtering as set up by
19180 individual users or via a system filter.
19181
19182 When the message is about to be written out, the command specified by
19183 &%transport_filter%& is started up in a separate, parallel process, and
19184 the entire message, including the header lines, is passed to it on its standard
19185 input (this in fact is done from a third process, to avoid deadlock). The
19186 command must be specified as an absolute path.
19187
19188 The lines of the message that are written to the transport filter are
19189 terminated by newline (&"\n"&). The message is passed to the filter before any
19190 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
19191 lines beginning with a dot, and also before any processing implied by the
19192 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
19193 &(pipe)& transports.
19194
19195 The standard error for the filter process is set to the same destination as its
19196 standard output; this is read and written to the message's ultimate
19197 destination. The process that writes the message to the filter, the
19198 filter itself, and the original process that reads the result and delivers it
19199 are all run in parallel, like a shell pipeline.
19200
19201 The filter can perform any transformations it likes, but of course should take
19202 care not to break RFC 2822 syntax. Exim does not check the result, except to
19203 test for a final newline when SMTP is in use. All messages transmitted over
19204 SMTP must end with a newline, so Exim supplies one if it is missing.
19205
19206 .cindex "content scanning" "per user"
19207 A transport filter can be used to provide content-scanning on a per-user basis
19208 at delivery time if the only required effect of the scan is to modify the
19209 message. For example, a content scan could insert a new header line containing
19210 a spam score. This could be interpreted by a filter in the user's MUA. It is
19211 not possible to discard a message at this stage.
19212
19213 .cindex "SMTP" "SIZE"
19214 A problem might arise if the filter increases the size of a message that is
19215 being sent down an SMTP connection. If the receiving SMTP server has indicated
19216 support for the SIZE parameter, Exim will have sent the size of the message
19217 at the start of the SMTP session. If what is actually sent is substantially
19218 more, the server might reject the message. This can be worked round by setting
19219 the &%size_addition%& option on the &(smtp)& transport, either to allow for
19220 additions to the message, or to disable the use of SIZE altogether.
19221
19222 .vindex "&$pipe_addresses$&"
19223 The value of the &%transport_filter%& option is the command string for starting
19224 the filter, which is run directly from Exim, not under a shell. The string is
19225 parsed by Exim in the same way as a command string for the &(pipe)& transport:
19226 Exim breaks it up into arguments and then expands each argument separately (see
19227 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
19228 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
19229 of arguments, one for each address that applies to this delivery. (This isn't
19230 an ideal name for this feature here, but as it was already implemented for the
19231 &(pipe)& transport, it seemed sensible not to change it.)
19232
19233 .vindex "&$host$&"
19234 .vindex "&$host_address$&"
19235 The expansion variables &$host$& and &$host_address$& are available when the
19236 transport is a remote one. They contain the name and IP address of the host to
19237 which the message is being sent. For example:
19238 .code
19239 transport_filter = /some/directory/transport-filter.pl \
19240   $host $host_address $sender_address $pipe_addresses
19241 .endd
19242
19243 Two problems arise if you want to use more complicated expansion items to
19244 generate transport filter commands, both of which due to the fact that the
19245 command is split up &'before'& expansion.
19246 .ilist
19247 If an expansion item contains white space, you must quote it, so that it is all
19248 part of the same command item. If the entire option setting is one such
19249 expansion item, you have to take care what kind of quoting you use. For
19250 example:
19251 .code
19252 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
19253 .endd
19254 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
19255 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
19256 stripped by Exim when it read the option's value. When the value is used, if
19257 the single quotes were missing, the line would be split into two items,
19258 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
19259 Exim tried to expand the first one.
19260 .next
19261 Except for the special case of &$pipe_addresses$& that is mentioned above, an
19262 expansion cannot generate multiple arguments, or a command name followed by
19263 arguments. Consider this example:
19264 .code
19265 transport_filter = ${lookup{$host}lsearch{/a/file}\
19266                     {$value}{/bin/cat}}
19267 .endd
19268 The result of the lookup is interpreted as the name of the command, even
19269 if it contains white space. The simplest way round this is to use a shell:
19270 .code
19271 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
19272                                {$value}{/bin/cat}}
19273 .endd
19274 .endlist
19275
19276 The filter process is run under the same uid and gid as the normal delivery.
19277 For remote deliveries this is the Exim uid/gid by default. The command should
19278 normally yield a zero return code. Transport filters are not supposed to fail.
19279 A non-zero code is taken to mean that the transport filter encountered some
19280 serious problem. Delivery of the message is deferred; the message remains on
19281 the queue and is tried again later. It is not possible to cause a message to be
19282 bounced from a transport filter.
19283
19284 If a transport filter is set on an autoreply transport, the original message is
19285 passed through the filter as it is being copied into the newly generated
19286 message, which happens if the &%return_message%& option is set.
19287
19288
19289 .option transport_filter_timeout transports time 5m
19290 .cindex "transport" "filter, timeout"
19291 When Exim is reading the output of a transport filter, it a applies a timeout
19292 that can be set by this option. Exceeding the timeout is normally treated as a
19293 temporary delivery failure. However, if a transport filter is used with a
19294 &(pipe)& transport, a timeout in the transport filter is treated in the same
19295 way as a timeout in the pipe command itself. By default, a timeout is a hard
19296 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
19297 becomes a temporary error.
19298
19299
19300 .option user transports string&!! "Exim user"
19301 .cindex "uid (user id)" "local delivery"
19302 .cindex "transport" "user, specifying"
19303 This option specifies the user under whose uid the delivery process is to be
19304 run, overriding any uid that may have been set by the router. If the user is
19305 given as a name, the uid is looked up from the password data, and the
19306 associated group is taken as the value of the gid to be used if the &%group%&
19307 option is not set.
19308
19309 For deliveries that use local transports, a user and group are normally
19310 specified explicitly or implicitly (for example, as a result of
19311 &%check_local_user%&) by the router or transport.
19312
19313 .cindex "hints database" "access by remote transport"
19314 For remote transports, you should leave this option unset unless you really are
19315 sure you know what you are doing. When a remote transport is running, it needs
19316 to be able to access Exim's hints databases, because each host may have its own
19317 retry data.
19318 .ecindex IIDgenoptra1
19319 .ecindex IIDgenoptra2
19320 .ecindex IIDgenoptra3
19321
19322
19323
19324
19325
19326
19327 . ////////////////////////////////////////////////////////////////////////////
19328 . ////////////////////////////////////////////////////////////////////////////
19329
19330 .chapter "Address batching in local transports" "CHAPbatching" &&&
19331          "Address batching"
19332 .cindex "transport" "local; address batching in"
19333 The only remote transport (&(smtp)&) is normally configured to handle more than
19334 one address at a time, so that when several addresses are routed to the same
19335 remote host, just one copy of the message is sent. Local transports, however,
19336 normally handle one address at a time. That is, a separate instance of the
19337 transport is run for each address that is routed to the transport. A separate
19338 copy of the message is delivered each time.
19339
19340 .cindex "batched local delivery"
19341 .oindex "&%batch_max%&"
19342 .oindex "&%batch_id%&"
19343 In special cases, it may be desirable to handle several addresses at once in a
19344 local transport, for example:
19345
19346 .ilist
19347 In an &(appendfile)& transport, when storing messages in files for later
19348 delivery by some other means, a single copy of the message with multiple
19349 recipients saves space.
19350 .next
19351 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
19352 a single copy saves time, and is the normal way LMTP is expected to work.
19353 .next
19354 In a &(pipe)& transport, when passing the message
19355 to a scanner program or
19356 to some other delivery mechanism such as UUCP, multiple recipients may be
19357 acceptable.
19358 .endlist
19359
19360 These three local transports all have the same options for controlling multiple
19361 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
19362 repeating the information for each transport, these options are described here.
19363
19364 The &%batch_max%& option specifies the maximum number of addresses that can be
19365 delivered together in a single run of the transport. Its default value is one
19366 (no batching). When more than one address is routed to a transport that has a
19367 &%batch_max%& value greater than one, the addresses are delivered in a batch
19368 (that is, in a single run of the transport with multiple recipients), subject
19369 to certain conditions:
19370
19371 .ilist
19372 .vindex "&$local_part$&"
19373 If any of the transport's options contain a reference to &$local_part$&, no
19374 batching is possible.
19375 .next
19376 .vindex "&$domain$&"
19377 If any of the transport's options contain a reference to &$domain$&, only
19378 addresses with the same domain are batched.
19379 .next
19380 .cindex "customizing" "batching condition"
19381 If &%batch_id%& is set, it is expanded for each address, and only those
19382 addresses with the same expanded value are batched. This allows you to specify
19383 customized batching conditions. Failure of the expansion for any reason,
19384 including forced failure, disables batching, but it does not stop the delivery
19385 from taking place.
19386 .next
19387 Batched addresses must also have the same errors address (where to send
19388 delivery errors), the same header additions and removals, the same user and
19389 group for the transport, and if a host list is present, the first host must
19390 be the same.
19391 .endlist
19392
19393 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
19394 both when the file or pipe command is specified in the transport, and when it
19395 is specified by a &(redirect)& router, but all the batched addresses must of
19396 course be routed to the same file or pipe command. These two transports have an
19397 option called &%use_bsmtp%&, which causes them to deliver the message in
19398 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
19399 &%check_string%& and &%escape_string%& options are forced to the values
19400 .code
19401 check_string = "."
19402 escape_string = ".."
19403 .endd
19404 when batched SMTP is in use. A full description of the batch SMTP mechanism is
19405 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
19406 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
19407
19408 .cindex "&'Envelope-to:'& header line"
19409 If the generic &%envelope_to_add%& option is set for a batching transport, the
19410 &'Envelope-to:'& header that is added to the message contains all the addresses
19411 that are being processed together. If you are using a batching &(appendfile)&
19412 transport without &%use_bsmtp%&, the only way to preserve the recipient
19413 addresses is to set the &%envelope_to_add%& option.
19414
19415 .cindex "&(pipe)& transport" "with multiple addresses"
19416 .vindex "&$pipe_addresses$&"
19417 If you are using a &(pipe)& transport without BSMTP, and setting the
19418 transport's &%command%& option, you can include &$pipe_addresses$& as part of
19419 the command. This is not a true variable; it is a bit of magic that causes each
19420 of the recipient addresses to be inserted into the command as a separate
19421 argument. This provides a way of accessing all the addresses that are being
19422 delivered in the batch. &*Note:*& This is not possible for pipe commands that
19423 are specified by a &(redirect)& router.
19424
19425
19426
19427
19428 . ////////////////////////////////////////////////////////////////////////////
19429 . ////////////////////////////////////////////////////////////////////////////
19430
19431 .chapter "The appendfile transport" "CHAPappendfile"
19432 .scindex IIDapptra1 "&(appendfile)& transport"
19433 .scindex IIDapptra2 "transports" "&(appendfile)&"
19434 .cindex "directory creation"
19435 .cindex "creating directories"
19436 The &(appendfile)& transport delivers a message by appending it to an existing
19437 file, or by creating an entirely new file in a specified directory. Single
19438 files to which messages are appended can be in the traditional Unix mailbox
19439 format, or optionally in the MBX format supported by the Pine MUA and
19440 University of Washington IMAP daemon, &'inter alia'&. When each message is
19441 being delivered as a separate file, &"maildir"& format can optionally be used
19442 to give added protection against failures that happen part-way through the
19443 delivery. A third form of separate-file delivery known as &"mailstore"& is also
19444 supported. For all file formats, Exim attempts to create as many levels of
19445 directory as necessary, provided that &%create_directory%& is set.
19446
19447 The code for the optional formats is not included in the Exim binary by
19448 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
19449 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
19450 included.
19451
19452 .cindex "quota" "system"
19453 Exim recognizes system quota errors, and generates an appropriate message. Exim
19454 also supports its own quota control within the transport, for use when the
19455 system facility is unavailable or cannot be used for some reason.
19456
19457 If there is an error while appending to a file (for example, quota exceeded or
19458 partition filled), Exim attempts to reset the file's length and last
19459 modification time back to what they were before. If there is an error while
19460 creating an entirely new file, the new file is removed.
19461
19462 Before appending to a file, a number of security checks are made, and the
19463 file is locked. A detailed description is given below, after the list of
19464 private options.
19465
19466 The &(appendfile)& transport is most commonly used for local deliveries to
19467 users' mailboxes. However, it can also be used as a pseudo-remote transport for
19468 putting messages into files for remote delivery by some means other than Exim.
19469 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
19470 option).
19471
19472
19473
19474 .section "The file and directory options" "SECTfildiropt"
19475 The &%file%& option specifies a single file, to which the message is appended;
19476 the &%directory%& option specifies a directory, in which a new file containing
19477 the message is created. Only one of these two options can be set, and for
19478 normal deliveries to mailboxes, one of them &'must'& be set.
19479
19480 .vindex "&$address_file$&"
19481 .vindex "&$local_part$&"
19482 However, &(appendfile)& is also used for delivering messages to files or
19483 directories whose names (or parts of names) are obtained from alias,
19484 forwarding, or filtering operations (for example, a &%save%& command in a
19485 user's Exim filter). When such a transport is running, &$local_part$& contains
19486 the local part that was aliased or forwarded, and &$address_file$& contains the
19487 name (or partial name) of the file or directory generated by the redirection
19488 operation. There are two cases:
19489
19490 .ilist
19491 If neither &%file%& nor &%directory%& is set, the redirection operation
19492 must specify an absolute path (one that begins with &`/`&). This is the most
19493 common case when users with local accounts use filtering to sort mail into
19494 different folders. See for example, the &(address_file)& transport in the
19495 default configuration. If the path ends with a slash, it is assumed to be the
19496 name of a directory. A delivery to a directory can also be forced by setting
19497 &%maildir_format%& or &%mailstore_format%&.
19498 .next
19499 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
19500 used to determine the file or directory name for the delivery. Normally, the
19501 contents of &$address_file$& are used in some way in the string expansion.
19502 .endlist
19503
19504
19505 .cindex "Sieve filter" "configuring &(appendfile)&"
19506 .cindex "Sieve filter" "relative mailbox path handling"
19507 As an example of the second case, consider an environment where users do not
19508 have home directories. They may be permitted to use Exim filter commands of the
19509 form:
19510 .code
19511 save folder23
19512 .endd
19513 or Sieve filter commands of the form:
19514 .code
19515 require "fileinto";
19516 fileinto "folder23";
19517 .endd
19518 In this situation, the expansion of &%file%& or &%directory%& in the transport
19519 must transform the relative path into an appropriate absolute file name. In the
19520 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
19521 is used as a result of a &"keep"& action in the filter. This example shows one
19522 way of handling this requirement:
19523 .code
19524 file = ${if eq{$address_file}{inbox} \
19525             {/var/mail/$local_part} \
19526             {${if eq{${substr_0_1:$address_file}}{/} \
19527                   {$address_file} \
19528                   {$home/mail/$address_file} \
19529             }} \
19530        }
19531 .endd
19532 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
19533 location, absolute paths are used without change, and other folders are in the
19534 &_mail_& directory within the home directory.
19535
19536 &*Note 1*&: While processing an Exim filter, a relative path such as
19537 &_folder23_& is turned into an absolute path if a home directory is known to
19538 the router. In particular, this is the case if &%check_local_user%& is set. If
19539 you want to prevent this happening at routing time, you can set
19540 &%router_home_directory%& empty. This forces the router to pass the relative
19541 path to the transport.
19542
19543 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
19544 the &%file%& or &%directory%& option is still used if it is set.
19545
19546
19547
19548
19549 .section "Private options for appendfile" "SECID134"
19550 .cindex "options" "&(appendfile)& transport"
19551
19552
19553
19554 .option allow_fifo appendfile boolean false
19555 .cindex "fifo (named pipe)"
19556 .cindex "named pipe (fifo)"
19557 .cindex "pipe" "named (fifo)"
19558 Setting this option permits delivery to named pipes (FIFOs) as well as to
19559 regular files. If no process is reading the named pipe at delivery time, the
19560 delivery is deferred.
19561
19562
19563 .option allow_symlink appendfile boolean false
19564 .cindex "symbolic link" "to mailbox"
19565 .cindex "mailbox" "symbolic link"
19566 By default, &(appendfile)& will not deliver if the path name for the file is
19567 that of a symbolic link. Setting this option relaxes that constraint, but there
19568 are security issues involved in the use of symbolic links. Be sure you know
19569 what you are doing if you set this. Details of exactly what this option affects
19570 are included in the discussion which follows this list of options.
19571
19572
19573 .option batch_id appendfile string&!! unset
19574 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19575 However, batching is automatically disabled for &(appendfile)& deliveries that
19576 happen as a result of forwarding or aliasing or other redirection directly to a
19577 file.
19578
19579
19580 .option batch_max appendfile integer 1
19581 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19582
19583
19584 .option check_group appendfile boolean false
19585 When this option is set, the group owner of the file defined by the &%file%&
19586 option is checked to see that it is the same as the group under which the
19587 delivery process is running. The default setting is false because the default
19588 file mode is 0600, which means that the group is irrelevant.
19589
19590
19591 .option check_owner appendfile boolean true
19592 When this option is set, the owner of the file defined by the &%file%& option
19593 is checked to ensure that it is the same as the user under which the delivery
19594 process is running.
19595
19596
19597 .option check_string appendfile string "see below"
19598 .cindex "&""From""& line"
19599 As &(appendfile)& writes the message, the start of each line is tested for
19600 matching &%check_string%&, and if it does, the initial matching characters are
19601 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
19602 a literal string, not a regular expression, and the case of any letters it
19603 contains is significant.
19604
19605 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
19606 are forced to &"."& and &".."& respectively, and any settings in the
19607 configuration are ignored. Otherwise, they default to &"From&~"& and
19608 &">From&~"& when the &%file%& option is set, and unset when any of the
19609 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
19610
19611 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
19612 suitable for traditional &"BSD"& mailboxes, where a line beginning with
19613 &"From&~"& indicates the start of a new message. All four options need changing
19614 if another format is used. For example, to deliver to mailboxes in MMDF format:
19615 .cindex "MMDF format mailbox"
19616 .cindex "mailbox" "MMDF format"
19617 .code
19618 check_string = "\1\1\1\1\n"
19619 escape_string = "\1\1\1\1 \n"
19620 message_prefix = "\1\1\1\1\n"
19621 message_suffix = "\1\1\1\1\n"
19622 .endd
19623 .option create_directory appendfile boolean true
19624 .cindex "directory creation"
19625 When this option is true, Exim attempts to create any missing superior
19626 directories for the file that it is about to write. A created directory's mode
19627 is given by the &%directory_mode%& option.
19628
19629 The group ownership of a newly created directory is highly dependent on the
19630 operating system (and possibly the file system) that is being used. For
19631 example, in Solaris, if the parent directory has the setgid bit set, its group
19632 is propagated to the child; if not, the currently set group is used. However,
19633 in FreeBSD, the parent's group is always used.
19634
19635
19636
19637 .option create_file appendfile string anywhere
19638 This option constrains the location of files and directories that are created
19639 by this transport. It applies to files defined by the &%file%& option and
19640 directories defined by the &%directory%& option. In the case of maildir
19641 delivery, it applies to the top level directory, not the maildir directories
19642 beneath.
19643
19644 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
19645 &"belowhome"&. In the second and third cases, a home directory must have been
19646 set for the transport. This option is not useful when an explicit file name is
19647 given for normal mailbox deliveries. It is intended for the case when file
19648 names are generated from users' &_.forward_& files. These are usually handled
19649 by an &(appendfile)& transport called &%address_file%&. See also
19650 &%file_must_exist%&.
19651
19652
19653 .option directory appendfile string&!! unset
19654 This option is mutually exclusive with the &%file%& option, but one of &%file%&
19655 or &%directory%& must be set, unless the delivery is the direct result of a
19656 redirection (see section &<<SECTfildiropt>>&).
19657
19658 When &%directory%& is set, the string is expanded, and the message is delivered
19659 into a new file or files in or below the given directory, instead of being
19660 appended to a single mailbox file. A number of different formats are provided
19661 (see &%maildir_format%& and &%mailstore_format%&), and see section
19662 &<<SECTopdir>>& for further details of this form of delivery.
19663
19664
19665 .option directory_file appendfile string&!! "see below"
19666 .cindex "base62"
19667 .vindex "&$inode$&"
19668 When &%directory%& is set, but neither &%maildir_format%& nor
19669 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
19670 whose name is obtained by expanding this string. The default value is:
19671 .code
19672 q${base62:$tod_epoch}-$inode
19673 .endd
19674 This generates a unique name from the current time, in base 62 form, and the
19675 inode of the file. The variable &$inode$& is available only when expanding this
19676 option.
19677
19678
19679 .option directory_mode appendfile "octal integer" 0700
19680 If &(appendfile)& creates any directories as a result of the
19681 &%create_directory%& option, their mode is specified by this option.
19682
19683
19684 .option escape_string appendfile string "see description"
19685 See &%check_string%& above.
19686
19687
19688 .option file appendfile string&!! unset
19689 This option is mutually exclusive with the &%directory%& option, but one of
19690 &%file%& or &%directory%& must be set, unless the delivery is the direct result
19691 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
19692 specifies a single file, to which the message is appended. One or more of
19693 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
19694 &%file%&.
19695
19696 .cindex "NFS" "lock file"
19697 .cindex "locking files"
19698 .cindex "lock files"
19699 If you are using more than one host to deliver over NFS into the same
19700 mailboxes, you should always use lock files.
19701
19702 The string value is expanded for each delivery, and must yield an absolute
19703 path. The most common settings of this option are variations on one of these
19704 examples:
19705 .code
19706 file = /var/spool/mail/$local_part
19707 file = /home/$local_part/inbox
19708 file = $home/inbox
19709 .endd
19710 .cindex "&""sticky""& bit"
19711 In the first example, all deliveries are done into the same directory. If Exim
19712 is configured to use lock files (see &%use_lockfile%& below) it must be able to
19713 create a file in the directory, so the &"sticky"& bit must be turned on for
19714 deliveries to be possible, or alternatively the &%group%& option can be used to
19715 run the delivery under a group id which has write access to the directory.
19716
19717
19718
19719 .option file_format appendfile string unset
19720 .cindex "file" "mailbox; checking existing format"
19721 This option requests the transport to check the format of an existing file
19722 before adding to it. The check consists of matching a specific string at the
19723 start of the file. The value of the option consists of an even number of
19724 colon-separated strings. The first of each pair is the test string, and the
19725 second is the name of a transport. If the transport associated with a matched
19726 string is not the current transport, control is passed over to the other
19727 transport. For example, suppose the standard &(local_delivery)& transport has
19728 this added to it:
19729 .code
19730 file_format = "From       : local_delivery :\
19731                \1\1\1\1\n : local_mmdf_delivery"
19732 .endd
19733 Mailboxes that begin with &"From"& are still handled by this transport, but if
19734 a mailbox begins with four binary ones followed by a newline, control is passed
19735 to a transport called &%local_mmdf_delivery%&, which presumably is configured
19736 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
19737 is assumed to match the current transport. If the start of a mailbox doesn't
19738 match any string, or if the transport named for a given string is not defined,
19739 delivery is deferred.
19740
19741
19742 .option file_must_exist appendfile boolean false
19743 If this option is true, the file specified by the &%file%& option must exist.
19744 A temporary error occurs if it does not, causing delivery to be deferred.
19745 If this option is false, the file is created if it does not exist.
19746
19747
19748 .option lock_fcntl_timeout appendfile time 0s
19749 .cindex "timeout" "mailbox locking"
19750 .cindex "mailbox" "locking, blocking and non-blocking"
19751 .cindex "locking files"
19752 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
19753 when locking an open mailbox file. If the call fails, the delivery process
19754 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
19755 Non-blocking calls are used so that the file is not kept open during the wait
19756 for the lock; the reason for this is to make it as safe as possible for
19757 deliveries over NFS in the case when processes might be accessing an NFS
19758 mailbox without using a lock file. This should not be done, but
19759 misunderstandings and hence misconfigurations are not unknown.
19760
19761 On a busy system, however, the performance of a non-blocking lock approach is
19762 not as good as using a blocking lock with a timeout. In this case, the waiting
19763 is done inside the system call, and Exim's delivery process acquires the lock
19764 and can proceed as soon as the previous lock holder releases it.
19765
19766 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
19767 timeout, are used. There may still be some retrying: the maximum number of
19768 retries is
19769 .code
19770 (lock_retries * lock_interval) / lock_fcntl_timeout
19771 .endd
19772 rounded up to the next whole number. In other words, the total time during
19773 which &(appendfile)& is trying to get a lock is roughly the same, unless
19774 &%lock_fcntl_timeout%& is set very large.
19775
19776 You should consider setting this option if you are getting a lot of delayed
19777 local deliveries because of errors of the form
19778 .code
19779 failed to lock mailbox /some/file (fcntl)
19780 .endd
19781
19782 .option lock_flock_timeout appendfile time 0s
19783 This timeout applies to file locking when using &[flock()]& (see
19784 &%use_flock%&); the timeout operates in a similar manner to
19785 &%lock_fcntl_timeout%&.
19786
19787
19788 .option lock_interval appendfile time 3s
19789 This specifies the time to wait between attempts to lock the file. See below
19790 for details of locking.
19791
19792
19793 .option lock_retries appendfile integer 10
19794 This specifies the maximum number of attempts to lock the file. A value of zero
19795 is treated as 1. See below for details of locking.
19796
19797
19798 .option lockfile_mode appendfile "octal integer" 0600
19799 This specifies the mode of the created lock file, when a lock file is being
19800 used (see &%use_lockfile%& and &%use_mbx_lock%&).
19801
19802
19803 .option lockfile_timeout appendfile time 30m
19804 .cindex "timeout" "mailbox locking"
19805 When a lock file is being used (see &%use_lockfile%&), if a lock file already
19806 exists and is older than this value, it is assumed to have been left behind by
19807 accident, and Exim attempts to remove it.
19808
19809
19810 .option mailbox_filecount appendfile string&!! unset
19811 .cindex "mailbox" "specifying size of"
19812 .cindex "size" "of mailbox"
19813 If this option is set, it is expanded, and the result is taken as the current
19814 number of files in the mailbox. It must be a decimal number, optionally
19815 followed by K or M. This provides a way of obtaining this information from an
19816 external source that maintains the data.
19817
19818
19819 .option mailbox_size appendfile string&!! unset
19820 .cindex "mailbox" "specifying size of"
19821 .cindex "size" "of mailbox"
19822 If this option is set, it is expanded, and the result is taken as the current
19823 size the mailbox. It must be a decimal number, optionally followed by K or M.
19824 This provides a way of obtaining this information from an external source that
19825 maintains the data. This is likely to be helpful for maildir deliveries where
19826 it is computationally expensive to compute the size of a mailbox.
19827
19828
19829
19830 .option maildir_format appendfile boolean false
19831 .cindex "maildir format" "specifying"
19832 If this option is set with the &%directory%& option, the delivery is into a new
19833 file, in the &"maildir"& format that is used by other mail software. When the
19834 transport is activated directly from a &(redirect)& router (for example, the
19835 &(address_file)& transport in the default configuration), setting
19836 &%maildir_format%& causes the path received from the router to be treated as a
19837 directory, whether or not it ends with &`/`&. This option is available only if
19838 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
19839 &<<SECTmaildirdelivery>>& below for further details.
19840
19841
19842 .option maildir_quota_directory_regex appendfile string "See below"
19843 .cindex "maildir format" "quota; directories included in"
19844 .cindex "quota" "maildir; directories included in"
19845 This option is relevant only when &%maildir_use_size_file%& is set. It defines
19846 a regular expression for specifying directories, relative to the quota
19847 directory (see &%quota_directory%&), that should be included in the quota
19848 calculation. The default value is:
19849 .code
19850 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
19851 .endd
19852 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
19853 (directories whose names begin with a dot). If you want to exclude the
19854 &_Trash_&
19855 folder from the count (as some sites do), you need to change this setting to
19856 .code
19857 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
19858 .endd
19859 This uses a negative lookahead in the regular expression to exclude the
19860 directory whose name is &_.Trash_&. When a directory is excluded from quota
19861 calculations, quota processing is bypassed for any messages that are delivered
19862 directly into that directory.
19863
19864
19865 .option maildir_retries appendfile integer 10
19866 This option specifies the number of times to retry when writing a file in
19867 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
19868
19869
19870 .option maildir_tag appendfile string&!! unset
19871 This option applies only to deliveries in maildir format, and is described in
19872 section &<<SECTmaildirdelivery>>& below.
19873
19874
19875 .option maildir_use_size_file appendfile boolean false
19876 .cindex "maildir format" "&_maildirsize_& file"
19877 Setting this option true enables support for &_maildirsize_& files. Exim
19878 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
19879 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
19880 value is zero. See &%maildir_quota_directory_regex%& above and section
19881 &<<SECTmaildirdelivery>>& below for further details.
19882
19883 .option maildirfolder_create_regex appendfile string unset
19884 .cindex "maildir format" "&_maildirfolder_& file"
19885 .cindex "&_maildirfolder_&, creating"
19886 The value of this option is a regular expression. If it is unset, it has no
19887 effect. Otherwise, before a maildir delivery takes place, the pattern is
19888 matched against the name of the maildir directory, that is, the directory
19889 containing the &_new_& and &_tmp_& subdirectories that will be used for the
19890 delivery. If there is a match, Exim checks for the existence of a file called
19891 &_maildirfolder_& in the directory, and creates it if it does not exist.
19892 See section &<<SECTmaildirdelivery>>& for more details.
19893
19894
19895 .option mailstore_format appendfile boolean false
19896 .cindex "mailstore format" "specifying"
19897 If this option is set with the &%directory%& option, the delivery is into two
19898 new files in  &"mailstore"& format. The option is available only if
19899 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
19900 below for further details.
19901
19902
19903 .option mailstore_prefix appendfile string&!! unset
19904 This option applies only to deliveries in mailstore format, and is described in
19905 section &<<SECTopdir>>& below.
19906
19907
19908 .option mailstore_suffix appendfile string&!! unset
19909 This option applies only to deliveries in mailstore format, and is described in
19910 section &<<SECTopdir>>& below.
19911
19912
19913 .option mbx_format appendfile boolean false
19914 .cindex "locking files"
19915 .cindex "file" "locking"
19916 .cindex "file" "MBX format"
19917 .cindex "MBX format, specifying"
19918 This option is available only if Exim has been compiled with SUPPORT_MBX
19919 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
19920 the message is appended to the mailbox file in MBX format instead of
19921 traditional Unix format. This format is supported by Pine4 and its associated
19922 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
19923
19924 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
19925 automatically changed by the use of &%mbx_format%&. They should normally be set
19926 empty when using MBX format, so this option almost always appears in this
19927 combination:
19928 .code
19929 mbx_format = true
19930 message_prefix =
19931 message_suffix =
19932 .endd
19933 If none of the locking options are mentioned in the configuration,
19934 &%use_mbx_lock%& is assumed and the other locking options default to false. It
19935 is possible to specify the other kinds of locking with &%mbx_format%&, but
19936 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
19937 interworks with &'c-client'&, providing for shared access to the mailbox. It
19938 should not be used if any program that does not use this form of locking is
19939 going to access the mailbox, nor should it be used if the mailbox file is NFS
19940 mounted, because it works only when the mailbox is accessed from a single host.
19941
19942 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
19943 the standard version of &'c-client'&, because as long as it has a mailbox open
19944 (this means for the whole of a Pine or IMAP session), Exim will not be able to
19945 append messages to it.
19946
19947
19948 .option message_prefix appendfile string&!! "see below"
19949 .cindex "&""From""& line"
19950 The string specified here is expanded and output at the start of every message.
19951 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
19952 in which case it is:
19953 .code
19954 message_prefix = "From ${if def:return_path{$return_path}\
19955   {MAILER-DAEMON}} $tod_bsdinbox\n"
19956 .endd
19957 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
19958 &`\n`& to &`\r\n`& in &%message_prefix%&.
19959
19960 .option message_suffix appendfile string&!! "see below"
19961 The string specified here is expanded and output at the end of every message.
19962 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
19963 in which case it is a single newline character. The suffix can be suppressed by
19964 setting
19965 .code
19966 message_suffix =
19967 .endd
19968 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
19969 &`\n`& to &`\r\n`& in &%message_suffix%&.
19970
19971 .option mode appendfile "octal integer" 0600
19972 If the output file is created, it is given this mode. If it already exists and
19973 has wider permissions, they are reduced to this mode. If it has narrower
19974 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
19975 if the delivery is the result of a &%save%& command in a filter file specifying
19976 a particular mode, the mode of the output file is always forced to take that
19977 value, and this option is ignored.
19978
19979
19980 .option mode_fail_narrower appendfile boolean true
19981 This option applies in the case when an existing mailbox file has a narrower
19982 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
19983 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
19984 continues with the delivery attempt, using the existing mode of the file.
19985
19986
19987 .option notify_comsat appendfile boolean false
19988 If this option is true, the &'comsat'& daemon is notified after every
19989 successful delivery to a user mailbox. This is the daemon that notifies logged
19990 on users about incoming mail.
19991
19992
19993 .option quota appendfile string&!! unset
19994 .cindex "quota" "imposed by Exim"
19995 This option imposes a limit on the size of the file to which Exim is appending,
19996 or to the total space used in the directory tree when the &%directory%& option
19997 is set. In the latter case, computation of the space used is expensive, because
19998 all the files in the directory (and any sub-directories) have to be
19999 individually inspected and their sizes summed. (See &%quota_size_regex%& and
20000 &%maildir_use_size_file%& for ways to avoid this in environments where users
20001 have no shell access to their mailboxes).
20002
20003 As there is no interlock against two simultaneous deliveries into a
20004 multi-file mailbox, it is possible for the quota to be overrun in this case.
20005 For single-file mailboxes, of course, an interlock is a necessity.
20006
20007 A file's size is taken as its &'used'& value. Because of blocking effects, this
20008 may be a lot less than the actual amount of disk space allocated to the file.
20009 If the sizes of a number of files are being added up, the rounding effect can
20010 become quite noticeable, especially on systems that have large block sizes.
20011 Nevertheless, it seems best to stick to the &'used'& figure, because this is
20012 the obvious value which users understand most easily.
20013
20014 The value of the option is expanded, and must then be a numerical value
20015 (decimal point allowed), optionally followed by one of the letters K, M, or G,
20016 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
20017 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
20018 be handled.
20019
20020 &*Note*&: A value of zero is interpreted as &"no quota"&.
20021
20022 The expansion happens while Exim is running as root, before it changes uid for
20023 the delivery. This means that files that are inaccessible to the end user can
20024 be used to hold quota values that are looked up in the expansion. When delivery
20025 fails because this quota is exceeded, the handling of the error is as for
20026 system quota failures.
20027
20028 By default, Exim's quota checking mimics system quotas, and restricts the
20029 mailbox to the specified maximum size, though the value is not accurate to the
20030 last byte, owing to separator lines and additional headers that may get added
20031 during message delivery. When a mailbox is nearly full, large messages may get
20032 refused even though small ones are accepted, because the size of the current
20033 message is added to the quota when the check is made. This behaviour can be
20034 changed by setting &%quota_is_inclusive%& false. When this is done, the check
20035 for exceeding the quota does not include the current message. Thus, deliveries
20036 continue until the quota has been exceeded; thereafter, no further messages are
20037 delivered. See also &%quota_warn_threshold%&.
20038
20039
20040 .option quota_directory appendfile string&!! unset
20041 This option defines the directory to check for quota purposes when delivering
20042 into individual files. The default is the delivery directory, or, if a file
20043 called &_maildirfolder_& exists in a maildir directory, the parent of the
20044 delivery directory.
20045
20046
20047 .option quota_filecount appendfile string&!! 0
20048 This option applies when the &%directory%& option is set. It limits the total
20049 number of files in the directory (compare the inode limit in system quotas). It
20050 can only be used if &%quota%& is also set. The value is expanded; an expansion
20051 failure causes delivery to be deferred. A value of zero is interpreted as
20052 &"no quota"&.
20053
20054
20055 .option quota_is_inclusive appendfile boolean true
20056 See &%quota%& above.
20057
20058
20059 .option quota_size_regex appendfile string unset
20060 This option applies when one of the delivery modes that writes a separate file
20061 for each message is being used. When Exim wants to find the size of one of
20062 these files in order to test the quota, it first checks &%quota_size_regex%&.
20063 If this is set to a regular expression that matches the file name, and it
20064 captures one string, that string is interpreted as a representation of the
20065 file's size. The value of &%quota_size_regex%& is not expanded.
20066
20067 This feature is useful only when users have no shell access to their mailboxes
20068 &-- otherwise they could defeat the quota simply by renaming the files. This
20069 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20070 the file length to the file name. For example:
20071 .code
20072 maildir_tag = ,S=$message_size
20073 quota_size_regex = ,S=(\d+)
20074 .endd
20075 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20076 number of lines in the message.
20077
20078 The regular expression should not assume that the length is at the end of the
20079 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20080 sometimes add other information onto the ends of message file names.
20081
20082
20083
20084 .option quota_warn_message appendfile string&!! "see below"
20085 See below for the use of this option. If it is not set when
20086 &%quota_warn_threshold%& is set, it defaults to
20087 .code
20088 quota_warn_message = "\
20089   To: $local_part@$domain\n\
20090   Subject: Your mailbox\n\n\
20091   This message is automatically created \
20092   by mail delivery software.\n\n\
20093   The size of your mailbox has exceeded \
20094   a warning threshold that is\n\
20095   set by the system administrator.\n"
20096 .endd
20097
20098
20099 .option quota_warn_threshold appendfile string&!! 0
20100 .cindex "quota" "warning threshold"
20101 .cindex "mailbox" "size warning"
20102 .cindex "size" "of mailbox"
20103 This option is expanded in the same way as &%quota%& (see above). If the
20104 resulting value is greater than zero, and delivery of the message causes the
20105 size of the file or total space in the directory tree to cross the given
20106 threshold, a warning message is sent. If &%quota%& is also set, the threshold
20107 may be specified as a percentage of it by following the value with a percent
20108 sign. For example:
20109 .code
20110 quota = 10M
20111 quota_warn_threshold = 75%
20112 .endd
20113 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20114 percent sign is ignored.
20115
20116 The warning message itself is specified by the &%quota_warn_message%& option,
20117 and it must start with a &'To:'& header line containing the recipient(s) of the
20118 warning message. These do not necessarily have to include the recipient(s) of
20119 the original message. A &'Subject:'& line should also normally be supplied. You
20120 can include any other header lines that you want. If you do not include a
20121 &'From:'& line, the default is:
20122 .code
20123 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20124 .endd
20125 .oindex &%errors_reply_to%&
20126 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20127 option.
20128
20129 The &%quota%& option does not have to be set in order to use this option; they
20130 are independent of one another except when the threshold is specified as a
20131 percentage.
20132
20133
20134 .option use_bsmtp appendfile boolean false
20135 .cindex "envelope sender"
20136 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20137 format, with the envelope sender and recipient(s) included as SMTP commands. If
20138 you want to include a leading HELO command with such messages, you can do
20139 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20140 for details of batch SMTP.
20141
20142
20143 .option use_crlf appendfile boolean false
20144 .cindex "carriage return"
20145 .cindex "linefeed"
20146 This option causes lines to be terminated with the two-character CRLF sequence
20147 (carriage return, linefeed) instead of just a linefeed character. In the case
20148 of batched SMTP, the byte sequence written to the file is then an exact image
20149 of what would be sent down a real SMTP connection.
20150
20151 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
20152 (which are used to supply the traditional &"From&~"& and blank line separators
20153 in Berkeley-style mailboxes) are written verbatim, so must contain their own
20154 carriage return characters if these are needed. In cases where these options
20155 have non-empty defaults, the values end with a single linefeed, so they must be
20156 changed to end with &`\r\n`& if &%use_crlf%& is set.
20157
20158
20159 .option use_fcntl_lock appendfile boolean "see below"
20160 This option controls the use of the &[fcntl()]& function to lock a file for
20161 exclusive use when a message is being appended. It is set by default unless
20162 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
20163 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
20164 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
20165
20166
20167 .option use_flock_lock appendfile boolean false
20168 This option is provided to support the use of &[flock()]& for file locking, for
20169 the few situations where it is needed. Most modern operating systems support
20170 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
20171 each other. Exim uses &[fcntl()]& locking by default.
20172
20173 This option is required only if you are using an operating system where
20174 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
20175 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
20176 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
20177
20178 .cindex "Solaris" "&[flock()]& support"
20179 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
20180 have it (and some, I think, provide a not quite right version built on top of
20181 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
20182 the ability to use it, and any attempt to do so will cause a configuration
20183 error.
20184
20185 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
20186 is just being mapped onto &[fcntl()]& by the OS).
20187
20188
20189 .option use_lockfile appendfile boolean "see below"
20190 If this option is turned off, Exim does not attempt to create a lock file when
20191 appending to a mailbox file. In this situation, the only locking is by
20192 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
20193 sure that every MUA that is ever going to look at your users' mailboxes uses
20194 &[fcntl()]& rather than a lock file, and even then only when you are not
20195 delivering over NFS from more than one host.
20196
20197 .cindex "NFS" "lock file"
20198 In order to append to an NFS file safely from more than one host, it is
20199 necessary to take out a lock &'before'& opening the file, and the lock file
20200 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
20201 file corruption.
20202
20203 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
20204 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
20205 except when &%mbx_format%& is set.
20206
20207
20208 .option use_mbx_lock appendfile boolean "see below"
20209 This option is available only if Exim has been compiled with SUPPORT_MBX
20210 set in &_Local/Makefile_&. Setting the option specifies that special MBX
20211 locking rules be used. It is set by default if &%mbx_format%& is set and none
20212 of the locking options are mentioned in the configuration. The locking rules
20213 are the same as are used by the &'c-client'& library that underlies Pine and
20214 the IMAP4 and POP daemons that come with it (see the discussion below). The
20215 rules allow for shared access to the mailbox. However, this kind of locking
20216 does not work when the mailbox is NFS mounted.
20217
20218 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
20219 &%use_flock_lock%& to control what kind of locking is used in implementing the
20220 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
20221 without &%use_fcntl_lock%& or &%use_flock_lock%&.
20222
20223
20224
20225
20226 .section "Operational details for appending" "SECTopappend"
20227 .cindex "appending to a file"
20228 .cindex "file" "appending"
20229 Before appending to a file, the following preparations are made:
20230
20231 .ilist
20232 If the name of the file is &_/dev/null_&, no action is taken, and a success
20233 return is given.
20234
20235 .next
20236 .cindex "directory creation"
20237 If any directories on the file's path are missing, Exim creates them if the
20238 &%create_directory%& option is set. A created directory's mode is given by the
20239 &%directory_mode%& option.
20240
20241 .next
20242 If &%file_format%& is set, the format of an existing file is checked. If this
20243 indicates that a different transport should be used, control is passed to that
20244 transport.
20245
20246 .next
20247 .cindex "file" "locking"
20248 .cindex "locking files"
20249 .cindex "NFS" "lock file"
20250 If &%use_lockfile%& is set, a lock file is built in a way that will work
20251 reliably over NFS, as follows:
20252
20253 .olist
20254 Create a &"hitching post"& file whose name is that of the lock file with the
20255 current time, primary host name, and process id added, by opening for writing
20256 as a new file. If this fails with an access error, delivery is deferred.
20257 .next
20258 Close the hitching post file, and hard link it to the lock file name.
20259 .next
20260 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
20261 Unlink the hitching post name.
20262 .next
20263 Otherwise, use &[stat()]& to get information about the hitching post file, and
20264 then unlink hitching post name. If the number of links is exactly two, creation
20265 of the lock file succeeded but something (for example, an NFS server crash and
20266 restart) caused this fact not to be communicated to the &[link()]& call.
20267 .next
20268 If creation of the lock file failed, wait for &%lock_interval%& and try again,
20269 up to &%lock_retries%& times. However, since any program that writes to a
20270 mailbox should complete its task very quickly, it is reasonable to time out old
20271 lock files that are normally the result of user agent and system crashes. If an
20272 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
20273 it before trying again.
20274 .endlist olist
20275
20276 .next
20277 A call is made to &[lstat()]& to discover whether the main file exists, and if
20278 so, what its characteristics are. If &[lstat()]& fails for any reason other
20279 than non-existence, delivery is deferred.
20280
20281 .next
20282 .cindex "symbolic link" "to mailbox"
20283 .cindex "mailbox" "symbolic link"
20284 If the file does exist and is a symbolic link, delivery is deferred, unless the
20285 &%allow_symlink%& option is set, in which case the ownership of the link is
20286 checked, and then &[stat()]& is called to find out about the real file, which
20287 is then subjected to the checks below. The check on the top-level link
20288 ownership prevents one user creating a link for another's mailbox in a sticky
20289 directory, though allowing symbolic links in this case is definitely not a good
20290 idea. If there is a chain of symbolic links, the intermediate ones are not
20291 checked.
20292
20293 .next
20294 If the file already exists but is not a regular file, or if the file's owner
20295 and group (if the group is being checked &-- see &%check_group%& above) are
20296 different from the user and group under which the delivery is running,
20297 delivery is deferred.
20298
20299 .next
20300 If the file's permissions are more generous than specified, they are reduced.
20301 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
20302 is set false, in which case the delivery is tried using the existing
20303 permissions.
20304
20305 .next
20306 The file's inode number is saved, and the file is then opened for appending.
20307 If this fails because the file has vanished, &(appendfile)& behaves as if it
20308 hadn't existed (see below). For any other failures, delivery is deferred.
20309
20310 .next
20311 If the file is opened successfully, check that the inode number hasn't
20312 changed, that it is still a regular file, and that the owner and permissions
20313 have not changed. If anything is wrong, defer delivery and freeze the message.
20314
20315 .next
20316 If the file did not exist originally, defer delivery if the &%file_must_exist%&
20317 option is set. Otherwise, check that the file is being created in a permitted
20318 directory if the &%create_file%& option is set (deferring on failure), and then
20319 open for writing as a new file, with the O_EXCL and O_CREAT options,
20320 except when dealing with a symbolic link (the &%allow_symlink%& option must be
20321 set). In this case, which can happen if the link points to a non-existent file,
20322 the file is opened for writing using O_CREAT but not O_EXCL, because
20323 that prevents link following.
20324
20325 .next
20326 .cindex "loop" "while file testing"
20327 If opening fails because the file exists, obey the tests given above for
20328 existing files. However, to avoid looping in a situation where the file is
20329 being continuously created and destroyed, the exists/not-exists loop is broken
20330 after 10 repetitions, and the message is then frozen.
20331
20332 .next
20333 If opening fails with any other error, defer delivery.
20334
20335 .next
20336 .cindex "file" "locking"
20337 .cindex "locking files"
20338 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
20339 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
20340 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
20341 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
20342 file, and an exclusive lock on the file whose name is
20343 .code
20344 /tmp/.<device-number>.<inode-number>
20345 .endd
20346 using the device and inode numbers of the open mailbox file, in accordance with
20347 the MBX locking rules. This file is created with a mode that is specified by
20348 the &%lockfile_mode%& option.
20349
20350 If Exim fails to lock the file, there are two possible courses of action,
20351 depending on the value of the locking timeout. This is obtained from
20352 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
20353
20354 If the timeout value is zero, the file is closed, Exim waits for
20355 &%lock_interval%&, and then goes back and re-opens the file as above and tries
20356 to lock it again. This happens up to &%lock_retries%& times, after which the
20357 delivery is deferred.
20358
20359 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
20360 &[flock()]& are used (with the given timeout), so there has already been some
20361 waiting involved by the time locking fails. Nevertheless, Exim does not give up
20362 immediately. It retries up to
20363 .code
20364 (lock_retries * lock_interval) / <timeout>
20365 .endd
20366 times (rounded up).
20367 .endlist
20368
20369 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
20370 and/or &[flock()]& locks) and then deletes the lock file if one was created.
20371
20372
20373 .section "Operational details for delivery to a new file" "SECTopdir"
20374 .cindex "delivery" "to single file"
20375 .cindex "&""From""& line"
20376 When the &%directory%& option is set instead of &%file%&, each message is
20377 delivered into a newly-created file or set of files. When &(appendfile)& is
20378 activated directly from a &(redirect)& router, neither &%file%& nor
20379 &%directory%& is normally set, because the path for delivery is supplied by the
20380 router. (See for example, the &(address_file)& transport in the default
20381 configuration.) In this case, delivery is to a new file if either the path name
20382 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
20383
20384 No locking is required while writing the message to a new file, so the various
20385 locking options of the transport are ignored. The &"From"& line that by default
20386 separates messages in a single file is not normally needed, nor is the escaping
20387 of message lines that start with &"From"&, and there is no need to ensure a
20388 newline at the end of each message. Consequently, the default values for
20389 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
20390 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
20391
20392 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
20393 the files in the delivery directory by default. However, you can specify a
20394 different directory by setting &%quota_directory%&. Also, for maildir
20395 deliveries (see below) the &_maildirfolder_& convention is honoured.
20396
20397
20398 .cindex "maildir format"
20399 .cindex "mailstore format"
20400 There are three different ways in which delivery to individual files can be
20401 done, controlled by the settings of the &%maildir_format%& and
20402 &%mailstore_format%& options. Note that code to support maildir or mailstore
20403 formats is not included in the binary unless SUPPORT_MAILDIR or
20404 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
20405
20406 .cindex "directory creation"
20407 In all three cases an attempt is made to create the directory and any necessary
20408 sub-directories if they do not exist, provided that the &%create_directory%&
20409 option is set (the default). The location of a created directory can be
20410 constrained by setting &%create_file%&. A created directory's mode is given by
20411 the &%directory_mode%& option. If creation fails, or if the
20412 &%create_directory%& option is not set when creation is required, delivery is
20413 deferred.
20414
20415
20416
20417 .section "Maildir delivery" "SECTmaildirdelivery"
20418 .cindex "maildir format" "description of"
20419 If the &%maildir_format%& option is true, Exim delivers each message by writing
20420 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
20421 directory that is defined by the &%directory%& option (the &"delivery
20422 directory"&). If the delivery is successful, the file is renamed into the
20423 &_new_& subdirectory.
20424
20425 In the file name, <&'stime'&> is the current time of day in seconds, and
20426 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
20427 Exim checks that the time-of-day clock has moved on by at least one microsecond
20428 before terminating the delivery process. This guarantees uniqueness for the
20429 file name. However, as a precaution, Exim calls &[stat()]& for the file before
20430 opening it. If any response other than ENOENT (does not exist) is given,
20431 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
20432
20433 Before Exim carries out a maildir delivery, it ensures that subdirectories
20434 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
20435 do not exist, Exim tries to create them and any superior directories in their
20436 path, subject to the &%create_directory%& and &%create_file%& options. If the
20437 &%maildirfolder_create_regex%& option is set, and the regular expression it
20438 contains matches the delivery directory, Exim also ensures that a file called
20439 &_maildirfolder_& exists in the delivery directory. If a missing directory or
20440 &_maildirfolder_& file cannot be created, delivery is deferred.
20441
20442 These features make it possible to use Exim to create all the necessary files
20443 and directories in a maildir mailbox, including subdirectories for maildir++
20444 folders. Consider this example:
20445 .code
20446 maildir_format = true
20447 directory = /var/mail/$local_part\
20448            ${if eq{$local_part_suffix}{}{}\
20449            {/.${substr_1:$local_part_suffix}}}
20450 maildirfolder_create_regex = /\.[^/]+$
20451 .endd
20452 If &$local_part_suffix$& is empty (there was no suffix for the local part),
20453 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
20454 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
20455 not match this name, so Exim will not look for or create the file
20456 &_/var/mail/pimbo/maildirfolder_&, though it will create
20457 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
20458
20459 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
20460 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
20461 does match &%maildirfolder_create_regex%&. In this case, Exim will create
20462 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
20463 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
20464
20465 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
20466 not inadvertently match the toplevel maildir directory, because a
20467 &_maildirfolder_& file at top level would completely break quota calculations.
20468
20469 .cindex "quota" "in maildir delivery"
20470 .cindex "maildir++"
20471 If Exim is required to check a &%quota%& setting before a maildir delivery, and
20472 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
20473 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
20474 Exim assumes the directory is a maildir++ folder directory, which is one level
20475 down from the user's top level mailbox directory. This causes it to start at
20476 the parent directory instead of the current directory when calculating the
20477 amount of space used.
20478
20479 One problem with delivering into a multi-file mailbox is that it is
20480 computationally expensive to compute the size of the mailbox for quota
20481 checking. Various approaches have been taken to reduce the amount of work
20482 needed. The next two sections describe two of them. A third alternative is to
20483 use some external process for maintaining the size data, and use the expansion
20484 of the &%mailbox_size%& option as a way of importing it into Exim.
20485
20486
20487
20488
20489 .section "Using tags to record message sizes" "SECID135"
20490 If &%maildir_tag%& is set, the string is expanded for each delivery.
20491 When the maildir file is renamed into the &_new_& sub-directory, the
20492 tag is added to its name. However, if adding the tag takes the length of the
20493 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
20494 the tag is dropped and the maildir file is created with no tag.
20495
20496 .vindex "&$message_size$&"
20497 Tags can be used to encode the size of files in their names; see
20498 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
20499 happens after the message has been written. The value of the &$message_size$&
20500 variable is set to the number of bytes actually written. If the expansion is
20501 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
20502 be deferred. The expanded tag may contain any printing characters except &"/"&.
20503 Non-printing characters in the string are ignored; if the resulting string is
20504 empty, it is ignored. If it starts with an alphanumeric character, a leading
20505 colon is inserted.
20506
20507
20508
20509 .section "Using a maildirsize file" "SECID136"
20510 .cindex "quota" "in maildir delivery"
20511 .cindex "maildir format" "&_maildirsize_& file"
20512 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
20513 storing quota and message size information in a file called &_maildirsize_&
20514 within the toplevel maildir directory. If this file does not exist, Exim
20515 creates it, setting the quota from the &%quota%& option of the transport. If
20516 the maildir directory itself does not exist, it is created before any attempt
20517 to write a &_maildirsize_& file.
20518
20519 The &_maildirsize_& file is used to hold information about the sizes of
20520 messages in the maildir, thus speeding up quota calculations. The quota value
20521 in the file is just a cache; if the quota is changed in the transport, the new
20522 value overrides the cached value when the next message is delivered. The cache
20523 is maintained for the benefit of other programs that access the maildir and
20524 need to know the quota.
20525
20526 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
20527 file is maintained (with a zero quota setting), but no quota is imposed.
20528
20529 A regular expression is available for controlling which directories in the
20530 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
20531 See the description of the &%maildir_quota_directory_regex%& option above for
20532 details.
20533
20534
20535 .section "Mailstore delivery" "SECID137"
20536 .cindex "mailstore format" "description of"
20537 If the &%mailstore_format%& option is true, each message is written as two
20538 files in the given directory. A unique base name is constructed from the
20539 message id and the current delivery process, and the files that are written use
20540 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
20541 contains the message's envelope, and the &_.msg_& file contains the message
20542 itself. The base name is placed in the variable &$mailstore_basename$&.
20543
20544 During delivery, the envelope is first written to a file with the suffix
20545 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
20546 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
20547 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
20548 file before accessing either of them. An alternative approach is to wait for
20549 the absence of a &_.tmp_& file.
20550
20551 The envelope file starts with any text defined by the &%mailstore_prefix%&
20552 option, expanded and terminated by a newline if there isn't one. Then follows
20553 the sender address on one line, then all the recipient addresses, one per line.
20554 There can be more than one recipient only if the &%batch_max%& option is set
20555 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
20556 appended to the file, followed by a newline if it does not end with one.
20557
20558 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
20559 failure, it is ignored. Other expansion errors are treated as serious
20560 configuration errors, and delivery is deferred. The variable
20561 &$mailstore_basename$& is available for use during these expansions.
20562
20563
20564 .section "Non-special new file delivery" "SECID138"
20565 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
20566 file is created directly in the named directory. For example, when delivering
20567 messages into files in batched SMTP format for later delivery to some host (see
20568 section &<<SECTbatchSMTP>>&), a setting such as
20569 .code
20570 directory = /var/bsmtp/$host
20571 .endd
20572 might be used. A message is written to a file with a temporary name, which is
20573 then renamed when the delivery is complete. The final name is obtained by
20574 expanding the contents of the &%directory_file%& option.
20575 .ecindex IIDapptra1
20576 .ecindex IIDapptra2
20577
20578
20579
20580
20581
20582
20583 . ////////////////////////////////////////////////////////////////////////////
20584 . ////////////////////////////////////////////////////////////////////////////
20585
20586 .chapter "The autoreply transport" "CHID8"
20587 .scindex IIDauttra1 "transports" "&(autoreply)&"
20588 .scindex IIDauttra2 "&(autoreply)& transport"
20589 The &(autoreply)& transport is not a true transport in that it does not cause
20590 the message to be transmitted. Instead, it generates a new mail message as an
20591 automatic reply to the incoming message. &'References:'& and
20592 &'Auto-Submitted:'& header lines are included. These are constructed according
20593 to the rules in RFCs 2822 and 3834, respectively.
20594
20595 If the router that passes the message to this transport does not have the
20596 &%unseen%& option set, the original message (for the current recipient) is not
20597 delivered anywhere. However, when the &%unseen%& option is set on the router
20598 that passes the message to this transport, routing of the address continues, so
20599 another router can set up a normal message delivery.
20600
20601
20602 The &(autoreply)& transport is usually run as the result of mail filtering, a
20603 &"vacation"& message being the standard example. However, it can also be run
20604 directly from a router like any other transport. To reduce the possibility of
20605 message cascades, messages created by the &(autoreply)& transport always have
20606 empty envelope sender addresses, like bounce messages.
20607
20608 The parameters of the message to be sent can be specified in the configuration
20609 by options described below. However, these are used only when the address
20610 passed to the transport does not contain its own reply information. When the
20611 transport is run as a consequence of a
20612 &%mail%&
20613 or &%vacation%& command in a filter file, the parameters of the message are
20614 supplied by the filter, and passed with the address. The transport's options
20615 that define the message are then ignored (so they are not usually set in this
20616 case). The message is specified entirely by the filter or by the transport; it
20617 is never built from a mixture of options. However, the &%file_optional%&,
20618 &%mode%&, and &%return_message%& options apply in all cases.
20619
20620 &(Autoreply)& is implemented as a local transport. When used as a result of a
20621 command in a user's filter file, &(autoreply)& normally runs under the uid and
20622 gid of the user, and with appropriate current and home directories (see chapter
20623 &<<CHAPenvironment>>&).
20624
20625 There is a subtle difference between routing a message to a &(pipe)& transport
20626 that generates some text to be returned to the sender, and routing it to an
20627 &(autoreply)& transport. This difference is noticeable only if more than one
20628 address from the same message is so handled. In the case of a pipe, the
20629 separate outputs from the different addresses are gathered up and returned to
20630 the sender in a single message, whereas if &(autoreply)& is used, a separate
20631 message is generated for each address that is passed to it.
20632
20633 Non-printing characters are not permitted in the header lines generated for the
20634 message that &(autoreply)& creates, with the exception of newlines that are
20635 immediately followed by white space. If any non-printing characters are found,
20636 the transport defers.
20637 Whether characters with the top bit set count as printing characters or not is
20638 controlled by the &%print_topbitchars%& global option.
20639
20640 If any of the generic options for manipulating headers (for example,
20641 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
20642 of the original message that is included in the generated message when
20643 &%return_message%& is set. They do not apply to the generated message itself.
20644
20645 .vindex "&$sender_address$&"
20646 If the &(autoreply)& transport receives return code 2 from Exim when it submits
20647 the message, indicating that there were no recipients, it does not treat this
20648 as an error. This means that autoreplies sent to &$sender_address$& when this
20649 is empty (because the incoming message is a bounce message) do not cause
20650 problems. They are just discarded.
20651
20652
20653
20654 .section "Private options for autoreply" "SECID139"
20655 .cindex "options" "&(autoreply)& transport"
20656
20657 .option bcc autoreply string&!! unset
20658 This specifies the addresses that are to receive &"blind carbon copies"& of the
20659 message when the message is specified by the transport.
20660
20661
20662 .option cc autoreply string&!! unset
20663 This specifies recipients of the message and the contents of the &'Cc:'& header
20664 when the message is specified by the transport.
20665
20666
20667 .option file autoreply string&!! unset
20668 The contents of the file are sent as the body of the message when the message
20669 is specified by the transport. If both &%file%& and &%text%& are set, the text
20670 string comes first.
20671
20672
20673 .option file_expand autoreply boolean false
20674 If this is set, the contents of the file named by the &%file%& option are
20675 subjected to string expansion as they are added to the message.
20676
20677
20678 .option file_optional autoreply boolean false
20679 If this option is true, no error is generated if the file named by the &%file%&
20680 option or passed with the address does not exist or cannot be read.
20681
20682
20683 .option from autoreply string&!! unset
20684 This specifies the contents of the &'From:'& header when the message is
20685 specified by the transport.
20686
20687
20688 .option headers autoreply string&!! unset
20689 This specifies additional RFC 2822 headers that are to be added to the message
20690 when the message is specified by the transport. Several can be given by using
20691 &"\n"& to separate them. There is no check on the format.
20692
20693
20694 .option log autoreply string&!! unset
20695 This option names a file in which a record of every message sent is logged when
20696 the message is specified by the transport.
20697
20698
20699 .option mode autoreply "octal integer" 0600
20700 If either the log file or the &"once"& file has to be created, this mode is
20701 used.
20702
20703
20704 .option never_mail autoreply "address list&!!" unset
20705 If any run of the transport creates a message with a recipient that matches any
20706 item in the list, that recipient is quietly discarded. If all recipients are
20707 discarded, no message is created. This applies both when the recipients are
20708 generated by a filter and when they are specified in the transport.
20709
20710
20711
20712 .option once autoreply string&!! unset
20713 This option names a file or DBM database in which a record of each &'To:'&
20714 recipient is kept when the message is specified by the transport. &*Note*&:
20715 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
20716
20717 If &%once%& is unset, or is set to an empty string, the message is always sent.
20718 By default, if &%once%& is set to a non-empty file name, the message
20719 is not sent if a potential recipient is already listed in the database.
20720 However, if the &%once_repeat%& option specifies a time greater than zero, the
20721 message is sent if that much time has elapsed since a message was last sent to
20722 this recipient. A setting of zero time for &%once_repeat%& (the default)
20723 prevents a message from being sent a second time &-- in this case, zero means
20724 infinity.
20725
20726 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
20727 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
20728 greater than zero, it changes the way Exim implements the &%once%& option.
20729 Instead of using a DBM file to record every recipient it sends to, it uses a
20730 regular file, whose size will never get larger than the given value.
20731
20732 In the file, Exim keeps a linear list of recipient addresses and the times at
20733 which they were sent messages. If the file is full when a new address needs to
20734 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
20735 means that a given recipient may receive multiple messages, but at
20736 unpredictable intervals that depend on the rate of turnover of addresses in the
20737 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
20738
20739
20740 .option once_file_size autoreply integer 0
20741 See &%once%& above.
20742
20743
20744 .option once_repeat autoreply time&!! 0s
20745 See &%once%& above.
20746 After expansion, the value of this option must be a valid time value.
20747
20748
20749 .option reply_to autoreply string&!! unset
20750 This specifies the contents of the &'Reply-To:'& header when the message is
20751 specified by the transport.
20752
20753
20754 .option return_message autoreply boolean false
20755 If this is set, a copy of the original message is returned with the new
20756 message, subject to the maximum size set in the &%return_size_limit%& global
20757 configuration option.
20758
20759
20760 .option subject autoreply string&!! unset
20761 This specifies the contents of the &'Subject:'& header when the message is
20762 specified by the transport. It is tempting to quote the original subject in
20763 automatic responses. For example:
20764 .code
20765 subject = Re: $h_subject:
20766 .endd
20767 There is a danger in doing this, however. It may allow a third party to
20768 subscribe your users to an opt-in mailing list, provided that the list accepts
20769 bounce messages as subscription confirmations. Well-managed lists require a
20770 non-bounce message to confirm a subscription, so the danger is relatively
20771 small.
20772
20773
20774
20775 .option text autoreply string&!! unset
20776 This specifies a single string to be used as the body of the message when the
20777 message is specified by the transport. If both &%text%& and &%file%& are set,
20778 the text comes first.
20779
20780
20781 .option to autoreply string&!! unset
20782 This specifies recipients of the message and the contents of the &'To:'& header
20783 when the message is specified by the transport.
20784 .ecindex IIDauttra1
20785 .ecindex IIDauttra2
20786
20787
20788
20789
20790 . ////////////////////////////////////////////////////////////////////////////
20791 . ////////////////////////////////////////////////////////////////////////////
20792
20793 .chapter "The lmtp transport" "CHAPLMTP"
20794 .cindex "transports" "&(lmtp)&"
20795 .cindex "&(lmtp)& transport"
20796 .cindex "LMTP" "over a pipe"
20797 .cindex "LMTP" "over a socket"
20798 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
20799 specified command
20800 or by interacting with a Unix domain socket.
20801 This transport is something of a cross between the &(pipe)& and &(smtp)&
20802 transports. Exim also has support for using LMTP over TCP/IP; this is
20803 implemented as an option for the &(smtp)& transport. Because LMTP is expected
20804 to be of minority interest, the default build-time configure in &_src/EDITME_&
20805 has it commented out. You need to ensure that
20806 .code
20807 TRANSPORT_LMTP=yes
20808 .endd
20809 .cindex "options" "&(lmtp)& transport"
20810 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
20811 included in the Exim binary. The private options of the &(lmtp)& transport are
20812 as follows:
20813
20814 .option batch_id lmtp string&!! unset
20815 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20816
20817
20818 .option batch_max lmtp integer 1
20819 This limits the number of addresses that can be handled in a single delivery.
20820 Most LMTP servers can handle several addresses at once, so it is normally a
20821 good idea to increase this value. See the description of local delivery
20822 batching in chapter &<<CHAPbatching>>&.
20823
20824
20825 .option command lmtp string&!! unset
20826 This option must be set if &%socket%& is not set. The string is a command which
20827 is run in a separate process. It is split up into a command name and list of
20828 arguments, each of which is separately expanded (so expansion cannot change the
20829 number of arguments). The command is run directly, not via a shell. The message
20830 is passed to the new process using the standard input and output to operate the
20831 LMTP protocol.
20832
20833 .option ignore_quota lmtp boolean false
20834 .cindex "LMTP" "ignoring quota errors"
20835 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
20836 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
20837 in its response to the LHLO command.
20838
20839 .option socket lmtp string&!! unset
20840 This option must be set if &%command%& is not set. The result of expansion must
20841 be the name of a Unix domain socket. The transport connects to the socket and
20842 delivers the message to it using the LMTP protocol.
20843
20844
20845 .option timeout lmtp time 5m
20846 The transport is aborted if the created process or Unix domain socket does not
20847 respond to LMTP commands or message input within this timeout. Delivery
20848 is deferred, and will be tried again later. Here is an example of a typical
20849 LMTP transport:
20850 .code
20851 lmtp:
20852   driver = lmtp
20853   command = /some/local/lmtp/delivery/program
20854   batch_max = 20
20855   user = exim
20856 .endd
20857 This delivers up to 20 addresses at a time, in a mixture of domains if
20858 necessary, running as the user &'exim'&.
20859
20860
20861
20862 . ////////////////////////////////////////////////////////////////////////////
20863 . ////////////////////////////////////////////////////////////////////////////
20864
20865 .chapter "The pipe transport" "CHAPpipetransport"
20866 .scindex IIDpiptra1 "transports" "&(pipe)&"
20867 .scindex IIDpiptra2 "&(pipe)& transport"
20868 The &(pipe)& transport is used to deliver messages via a pipe to a command
20869 running in another process. One example is the use of &(pipe)& as a
20870 pseudo-remote transport for passing messages to some other delivery mechanism
20871 (such as UUCP). Another is the use by individual users to automatically process
20872 their incoming messages. The &(pipe)& transport can be used in one of the
20873 following ways:
20874
20875 .ilist
20876 .vindex "&$local_part$&"
20877 A router routes one address to a transport in the normal way, and the
20878 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
20879 contains the local part of the address (as usual), and the command that is run
20880 is specified by the &%command%& option on the transport.
20881 .next
20882 .vindex "&$pipe_addresses$&"
20883 If the &%batch_max%& option is set greater than 1 (the default is 1), the
20884 transport can handle more than one address in a single run. In this case, when
20885 more than one address is routed to the transport, &$local_part$& is not set
20886 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
20887 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
20888 that are routed to the transport.
20889 .next
20890 .vindex "&$address_pipe$&"
20891 A router redirects an address directly to a pipe command (for example, from an
20892 alias or forward file). In this case, &$address_pipe$& contains the text of the
20893 pipe command, and the &%command%& option on the transport is ignored. If only
20894 one address is being transported (&%batch_max%& is not greater than one, or
20895 only one address was redirected to this pipe command), &$local_part$& contains
20896 the local part that was redirected.
20897 .endlist
20898
20899
20900 The &(pipe)& transport is a non-interactive delivery method. Exim can also
20901 deliver messages over pipes using the LMTP interactive protocol. This is
20902 implemented by the &(lmtp)& transport.
20903
20904 In the case when &(pipe)& is run as a consequence of an entry in a local user's
20905 &_.forward_& file, the command runs under the uid and gid of that user. In
20906 other cases, the uid and gid have to be specified explicitly, either on the
20907 transport or on the router that handles the address. Current and &"home"&
20908 directories are also controllable. See chapter &<<CHAPenvironment>>& for
20909 details of the local delivery environment and chapter &<<CHAPbatching>>&
20910 for a discussion of local delivery batching.
20911
20912
20913 .section "Concurrent delivery" "SECID140"
20914 If two messages arrive at almost the same time, and both are routed to a pipe
20915 delivery, the two pipe transports may be run concurrently. You must ensure that
20916 any pipe commands you set up are robust against this happening. If the commands
20917 write to a file, the &%exim_lock%& utility might be of use.
20918
20919
20920
20921
20922 .section "Returned status and data" "SECID141"
20923 .cindex "&(pipe)& transport" "returned data"
20924 If the command exits with a non-zero return code, the delivery is deemed to
20925 have failed, unless either the &%ignore_status%& option is set (in which case
20926 the return code is treated as zero), or the return code is one of those listed
20927 in the &%temp_errors%& option, which are interpreted as meaning &"try again
20928 later"&. In this case, delivery is deferred. Details of a permanent failure are
20929 logged, but are not included in the bounce message, which merely contains
20930 &"local delivery failed"&.
20931
20932 If the return code is greater than 128 and the command being run is a shell
20933 script, it normally means that the script was terminated by a signal whose
20934 value is the return code minus 128.
20935
20936 If Exim is unable to run the command (that is, if &[execve()]& fails), the
20937 return code is set to 127. This is the value that a shell returns if it is
20938 asked to run a non-existent command. The wording for the log line suggests that
20939 a non-existent command may be the problem.
20940
20941 The &%return_output%& option can affect the result of a pipe delivery. If it is
20942 set and the command produces any output on its standard output or standard
20943 error streams, the command is considered to have failed, even if it gave a zero
20944 return code or if &%ignore_status%& is set. The output from the command is
20945 included as part of the bounce message. The &%return_fail_output%& option is
20946 similar, except that output is returned only when the command exits with a
20947 failure return code, that is, a value other than zero or a code that matches
20948 &%temp_errors%&.
20949
20950
20951
20952 .section "How the command is run" "SECThowcommandrun"
20953 .cindex "&(pipe)& transport" "path for command"
20954 The command line is (by default) broken down into a command name and arguments
20955 by the &(pipe)& transport itself. The &%allow_commands%& and
20956 &%restrict_to_path%& options can be used to restrict the commands that may be
20957 run.
20958
20959 .cindex "quoting" "in pipe command"
20960 Unquoted arguments are delimited by white space. If an argument appears in
20961 double quotes, backslash is interpreted as an escape character in the usual
20962 way. If an argument appears in single quotes, no escaping is done.
20963
20964 String expansion is applied to the command line except when it comes from a
20965 traditional &_.forward_& file (commands from a filter file are expanded). The
20966 expansion is applied to each argument in turn rather than to the whole line.
20967 For this reason, any string expansion item that contains white space must be
20968 quoted so as to be contained within a single argument. A setting such as
20969 .code
20970 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
20971 .endd
20972 will not work, because the expansion item gets split between several
20973 arguments. You have to write
20974 .code
20975 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
20976 .endd
20977 to ensure that it is all in one argument. The expansion is done in this way,
20978 argument by argument, so that the number of arguments cannot be changed as a
20979 result of expansion, and quotes or backslashes in inserted variables do not
20980 interact with external quoting. However, this leads to problems if you want to
20981 generate multiple arguments (or the command name plus arguments) from a single
20982 expansion. In this situation, the simplest solution is to use a shell. For
20983 example:
20984 .code
20985 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
20986 .endd
20987
20988 .cindex "transport" "filter"
20989 .cindex "filter" "transport filter"
20990 .vindex "&$pipe_addresses$&"
20991 Special handling takes place when an argument consists of precisely the text
20992 &`$pipe_addresses`&. This is not a general expansion variable; the only
20993 place this string is recognized is when it appears as an argument for a pipe or
20994 transport filter command. It causes each address that is being handled to be
20995 inserted in the argument list at that point &'as a separate argument'&. This
20996 avoids any problems with spaces or shell metacharacters, and is of use when a
20997 &(pipe)& transport is handling groups of addresses in a batch.
20998
20999 After splitting up into arguments and expansion, the resulting command is run
21000 in a subprocess directly from the transport, &'not'& under a shell. The
21001 message that is being delivered is supplied on the standard input, and the
21002 standard output and standard error are both connected to a single pipe that is
21003 read by Exim. The &%max_output%& option controls how much output the command
21004 may produce, and the &%return_output%& and &%return_fail_output%& options
21005 control what is done with it.
21006
21007 Not running the command under a shell (by default) lessens the security risks
21008 in cases when a command from a user's filter file is built out of data that was
21009 taken from an incoming message. If a shell is required, it can of course be
21010 explicitly specified as the command to be run. However, there are circumstances
21011 where existing commands (for example, in &_.forward_& files) expect to be run
21012 under a shell and cannot easily be modified. To allow for these cases, there is
21013 an option called &%use_shell%&, which changes the way the &(pipe)& transport
21014 works. Instead of breaking up the command line as just described, it expands it
21015 as a single string and passes the result to &_/bin/sh_&. The
21016 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
21017 with &%use_shell%&, and the whole mechanism is inherently less secure.
21018
21019
21020
21021 .section "Environment variables" "SECTpipeenv"
21022 .cindex "&(pipe)& transport" "environment for command"
21023 .cindex "environment for pipe transport"
21024 The environment variables listed below are set up when the command is invoked.
21025 This list is a compromise for maximum compatibility with other MTAs. Note that
21026 the &%environment%& option can be used to add additional variables to this
21027 environment.
21028 .display
21029 &`DOMAIN            `&   the domain of the address
21030 &`HOME              `&   the home directory, if set
21031 &`HOST              `&   the host name when called from a router (see below)
21032 &`LOCAL_PART        `&   see below
21033 &`LOCAL_PART_PREFIX `&   see below
21034 &`LOCAL_PART_SUFFIX `&   see below
21035 &`LOGNAME           `&   see below
21036 &`MESSAGE_ID        `&   Exim's local ID for the message
21037 &`PATH              `&   as specified by the &%path%& option below
21038 &`QUALIFY_DOMAIN    `&   the sender qualification domain
21039 &`RECIPIENT         `&   the complete recipient address
21040 &`SENDER            `&   the sender of the message (empty if a bounce)
21041 &`SHELL             `&   &`/bin/sh`&
21042 &`TZ                `&   the value of the &%timezone%& option, if set
21043 &`USER              `&   see below
21044 .endd
21045 When a &(pipe)& transport is called directly from (for example) an &(accept)&
21046 router, LOCAL_PART is set to the local part of the address. When it is
21047 called as a result of a forward or alias expansion, LOCAL_PART is set to
21048 the local part of the address that was expanded. In both cases, any affixes are
21049 removed from the local part, and made available in LOCAL_PART_PREFIX and
21050 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
21051 same value as LOCAL_PART for compatibility with other MTAs.
21052
21053 .cindex "HOST"
21054 HOST is set only when a &(pipe)& transport is called from a router that
21055 associates hosts with an address, typically when using &(pipe)& as a
21056 pseudo-remote transport. HOST is set to the first host name specified by
21057 the router.
21058
21059 .cindex "HOME"
21060 If the transport's generic &%home_directory%& option is set, its value is used
21061 for the HOME environment variable. Otherwise, a home directory may be set
21062 by the router's &%transport_home_directory%& option, which defaults to the
21063 user's home directory if &%check_local_user%& is set.
21064
21065
21066 .section "Private options for pipe" "SECID142"
21067 .cindex "options" "&(pipe)& transport"
21068
21069
21070
21071 .option allow_commands pipe "string list&!!" unset
21072 .cindex "&(pipe)& transport" "permitted commands"
21073 The string is expanded, and is then interpreted as a colon-separated list of
21074 permitted commands. If &%restrict_to_path%& is not set, the only commands
21075 permitted are those in the &%allow_commands%& list. They need not be absolute
21076 paths; the &%path%& option is still used for relative paths. If
21077 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
21078 in the &%allow_commands%& list, or a name without any slashes that is found on
21079 the path. In other words, if neither &%allow_commands%& nor
21080 &%restrict_to_path%& is set, there is no restriction on the command, but
21081 otherwise only commands that are permitted by one or the other are allowed. For
21082 example, if
21083 .code
21084 allow_commands = /usr/bin/vacation
21085 .endd
21086 and &%restrict_to_path%& is not set, the only permitted command is
21087 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
21088 &%use_shell%& is set.
21089
21090
21091 .option batch_id pipe string&!! unset
21092 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21093
21094
21095 .option batch_max pipe integer 1
21096 This limits the number of addresses that can be handled in a single delivery.
21097 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21098
21099
21100 .option check_string pipe string unset
21101 As &(pipe)& writes the message, the start of each line is tested for matching
21102 &%check_string%&, and if it does, the initial matching characters are replaced
21103 by the contents of &%escape_string%&, provided both are set. The value of
21104 &%check_string%& is a literal string, not a regular expression, and the case of
21105 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
21106 of &%check_string%& and &%escape_string%& are forced to values that implement
21107 the SMTP escaping protocol. Any settings made in the configuration file are
21108 ignored.
21109
21110
21111 .option command pipe string&!! unset
21112 This option need not be set when &(pipe)& is being used to deliver to pipes
21113 obtained directly from address redirections. In other cases, the option must be
21114 set, to provide a command to be run. It need not yield an absolute path (see
21115 the &%path%& option below). The command is split up into separate arguments by
21116 Exim, and each argument is separately expanded, as described in section
21117 &<<SECThowcommandrun>>& above.
21118
21119
21120 .option environment pipe string&!! unset
21121 .cindex "&(pipe)& transport" "environment for command"
21122 .cindex "environment for &(pipe)& transport"
21123 This option is used to add additional variables to the environment in which the
21124 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
21125 a string which is expanded, and then interpreted as a colon-separated list of
21126 environment settings of the form <&'name'&>=<&'value'&>.
21127
21128
21129 .option escape_string pipe string unset
21130 See &%check_string%& above.
21131
21132
21133 .option freeze_exec_fail pipe boolean false
21134 .cindex "exec failure"
21135 .cindex "failure of exec"
21136 .cindex "&(pipe)& transport" "failure of exec"
21137 Failure to exec the command in a pipe transport is by default treated like
21138 any other failure while running the command. However, if &%freeze_exec_fail%&
21139 is set, failure to exec is treated specially, and causes the message to be
21140 frozen, whatever the setting of &%ignore_status%&.
21141
21142
21143 .option ignore_status pipe boolean false
21144 If this option is true, the status returned by the subprocess that is set up to
21145 run the command is ignored, and Exim behaves as if zero had been returned.
21146 Otherwise, a non-zero status or termination by signal causes an error return
21147 from the transport unless the status value is one of those listed in
21148 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
21149
21150 &*Note*&: This option does not apply to timeouts, which do not return a status.
21151 See the &%timeout_defer%& option for how timeouts are handled.
21152
21153 .option log_defer_output pipe boolean false
21154 .cindex "&(pipe)& transport" "logging output"
21155 If this option is set, and the status returned by the command is
21156 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
21157 and any output was produced, the first line of it is written to the main log.
21158
21159
21160 .option log_fail_output pipe boolean false
21161 If this option is set, and the command returns any output, and also ends with a
21162 return code that is neither zero nor one of the return codes listed in
21163 &%temp_errors%& (that is, the delivery failed), the first line of output is
21164 written to the main log. This option and &%log_output%& are mutually exclusive.
21165 Only one of them may be set.
21166
21167
21168
21169 .option log_output pipe boolean false
21170 If this option is set and the command returns any output, the first line of
21171 output is written to the main log, whatever the return code. This option and
21172 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
21173
21174
21175
21176 .option max_output pipe integer 20K
21177 This specifies the maximum amount of output that the command may produce on its
21178 standard output and standard error file combined. If the limit is exceeded, the
21179 process running the command is killed. This is intended as a safety measure to
21180 catch runaway processes. The limit is applied independently of the settings of
21181 the options that control what is done with such output (for example,
21182 &%return_output%&). Because of buffering effects, the amount of output may
21183 exceed the limit by a small amount before Exim notices.
21184
21185
21186 .option message_prefix pipe string&!! "see below"
21187 The string specified here is expanded and output at the start of every message.
21188 The default is unset if &%use_bsmtp%& is set. Otherwise it is
21189 .code
21190 message_prefix = \
21191   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
21192   ${tod_bsdinbox}\n
21193 .endd
21194 .cindex "Cyrus"
21195 .cindex "&%tmail%&"
21196 .cindex "&""From""& line"
21197 This is required by the commonly used &_/usr/bin/vacation_& program.
21198 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
21199 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
21200 setting
21201 .code
21202 message_prefix =
21203 .endd
21204 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21205 &`\n`& to &`\r\n`& in &%message_prefix%&.
21206
21207
21208 .option message_suffix pipe string&!! "see below"
21209 The string specified here is expanded and output at the end of every message.
21210 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
21211 The suffix can be suppressed by setting
21212 .code
21213 message_suffix =
21214 .endd
21215 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21216 &`\n`& to &`\r\n`& in &%message_suffix%&.
21217
21218
21219 .option path pipe string "see below"
21220 This option specifies the string that is set up in the PATH environment
21221 variable of the subprocess. The default is:
21222 .code
21223 /bin:/usr/bin
21224 .endd
21225 If the &%command%& option does not yield an absolute path name, the command is
21226 sought in the PATH directories, in the usual way. &*Warning*&: This does not
21227 apply to a command specified as a transport filter.
21228
21229
21230 .new
21231 .option permit_coredump pipe boolean false
21232 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
21233 a core-dump of a pipe command, enable this command.  This enables core-dumps
21234 during delivery and affects both the Exim binary and the pipe command run.
21235 It is recommended that this option remain off unless and until you have a need
21236 for it and that this only be enabled when needed, as the risk of excessive
21237 resource consumption can be quite high.  Note also that Exim is typically
21238 installed as a setuid binary and most operating systems will inhibit coredumps
21239 of these by default, so further OS-specific action may be required.
21240 .wen
21241
21242
21243 .option pipe_as_creator pipe boolean false
21244 .cindex "uid (user id)" "local delivery"
21245 If the generic &%user%& option is not set and this option is true, the delivery
21246 process is run under the uid that was in force when Exim was originally called
21247 to accept the message. If the group id is not otherwise set (via the generic
21248 &%group%& option), the gid that was in force when Exim was originally called to
21249 accept the message is used.
21250
21251
21252 .option restrict_to_path pipe boolean false
21253 When this option is set, any command name not listed in &%allow_commands%& must
21254 contain no slashes. The command is searched for only in the directories listed
21255 in the &%path%& option. This option is intended for use in the case when a pipe
21256 command has been generated from a user's &_.forward_& file. This is usually
21257 handled by a &(pipe)& transport called &%address_pipe%&.
21258
21259
21260 .option return_fail_output pipe boolean false
21261 If this option is true, and the command produced any output and ended with a
21262 return code other than zero or one of the codes listed in &%temp_errors%& (that
21263 is, the delivery failed), the output is returned in the bounce message.
21264 However, if the message has a null sender (that is, it is itself a bounce
21265 message), output from the command is discarded. This option and
21266 &%return_output%& are mutually exclusive. Only one of them may be set.
21267
21268
21269
21270 .option return_output pipe boolean false
21271 If this option is true, and the command produced any output, the delivery is
21272 deemed to have failed whatever the return code from the command, and the output
21273 is returned in the bounce message. Otherwise, the output is just discarded.
21274 However, if the message has a null sender (that is, it is a bounce message),
21275 output from the command is always discarded, whatever the setting of this
21276 option. This option and &%return_fail_output%& are mutually exclusive. Only one
21277 of them may be set.
21278
21279
21280
21281 .option temp_errors pipe "string list" "see below"
21282 .cindex "&(pipe)& transport" "temporary failure"
21283 This option contains either a colon-separated list of numbers, or a single
21284 asterisk. If &%ignore_status%& is false
21285 and &%return_output%& is not set,
21286 and the command exits with a non-zero return code, the failure is treated as
21287 temporary and the delivery is deferred if the return code matches one of the
21288 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
21289 codes are treated as permanent errors. The default setting contains the codes
21290 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
21291 compiled on a system that does not define these macros, it assumes values of 75
21292 and 73, respectively.
21293
21294
21295 .option timeout pipe time 1h
21296 If the command fails to complete within this time, it is killed. This normally
21297 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
21298 specifies no timeout. In order to ensure that any subprocesses created by the
21299 command are also killed, Exim makes the initial process a process group leader,
21300 and kills the whole process group on a timeout. However, this can be defeated
21301 if one of the processes starts a new process group.
21302
21303 .option timeout_defer pipe boolean false
21304 A timeout in a &(pipe)& transport, either in the command that the transport
21305 runs, or in a transport filter that is associated with it, is by default
21306 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
21307 is set true, both kinds of timeout become temporary errors, causing the
21308 delivery to be deferred.
21309
21310 .option umask pipe "octal integer" 022
21311 This specifies the umask setting for the subprocess that runs the command.
21312
21313
21314 .option use_bsmtp pipe boolean false
21315 .cindex "envelope sender"
21316 If this option is set true, the &(pipe)& transport writes messages in &"batch
21317 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
21318 commands. If you want to include a leading HELO command with such messages,
21319 you can do so by setting the &%message_prefix%& option. See section
21320 &<<SECTbatchSMTP>>& for details of batch SMTP.
21321
21322 .option use_classresources pipe boolean false
21323 .cindex "class resources (BSD)"
21324 This option is available only when Exim is running on FreeBSD, NetBSD, or
21325 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
21326 resource limits when a &(pipe)& transport is run to perform a delivery. The
21327 limits for the uid under which the pipe is to run are obtained from the login
21328 class database.
21329
21330
21331 .option use_crlf pipe boolean false
21332 .cindex "carriage return"
21333 .cindex "linefeed"
21334 This option causes lines to be terminated with the two-character CRLF sequence
21335 (carriage return, linefeed) instead of just a linefeed character. In the case
21336 of batched SMTP, the byte sequence written to the pipe is then an exact image
21337 of what would be sent down a real SMTP connection.
21338
21339 The contents of the &%message_prefix%& and &%message_suffix%& options are
21340 written verbatim, so must contain their own carriage return characters if these
21341 are needed. When &%use_bsmtp%& is not set, the default values for both
21342 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
21343 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
21344
21345
21346 .option use_shell pipe boolean false
21347 .vindex "&$pipe_addresses$&"
21348 If this option is set, it causes the command to be passed to &_/bin/sh_&
21349 instead of being run directly from the transport, as described in section
21350 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
21351 where the command is expected to be run under a shell and cannot easily be
21352 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
21353 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
21354 command is expanded as a single string, and handed to &_/bin/sh_& as data for
21355 its &%-c%& option.
21356
21357
21358
21359 .section "Using an external local delivery agent" "SECID143"
21360 .cindex "local delivery" "using an external agent"
21361 .cindex "&'procmail'&"
21362 .cindex "external local delivery"
21363 .cindex "delivery" "&'procmail'&"
21364 .cindex "delivery" "by external agent"
21365 The &(pipe)& transport can be used to pass all messages that require local
21366 delivery to a separate local delivery agent such as &%procmail%&. When doing
21367 this, care must be taken to ensure that the pipe is run under an appropriate
21368 uid and gid. In some configurations one wants this to be a uid that is trusted
21369 by the delivery agent to supply the correct sender of the message. It may be
21370 necessary to recompile or reconfigure the delivery agent so that it trusts an
21371 appropriate user. The following is an example transport and router
21372 configuration for &%procmail%&:
21373 .code
21374 # transport
21375 procmail_pipe:
21376   driver = pipe
21377   command = /usr/local/bin/procmail -d $local_part
21378   return_path_add
21379   delivery_date_add
21380   envelope_to_add
21381   check_string = "From "
21382   escape_string = ">From "
21383   umask = 077
21384   user = $local_part
21385   group = mail
21386
21387 # router
21388 procmail:
21389   driver = accept
21390   check_local_user
21391   transport = procmail_pipe
21392 .endd
21393 In this example, the pipe is run as the local user, but with the group set to
21394 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
21395 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
21396 user to supply a correct sender address. If you do not specify either a
21397 &%group%& or a &%user%& option, the pipe command is run as the local user. The
21398 home directory is the user's home directory by default.
21399
21400 &*Note*&: The command that the pipe transport runs does &'not'& begin with
21401 .code
21402 IFS=" "
21403 .endd
21404 as shown in some &%procmail%& documentation, because Exim does not by default
21405 use a shell to run pipe commands.
21406
21407 .cindex "Cyrus"
21408 The next example shows a transport and a router for a system where local
21409 deliveries are handled by the Cyrus IMAP server.
21410 .code
21411 # transport
21412 local_delivery_cyrus:
21413   driver = pipe
21414   command = /usr/cyrus/bin/deliver \
21415             -m ${substr_1:$local_part_suffix} -- $local_part
21416   user = cyrus
21417   group = mail
21418   return_output
21419   log_output
21420   message_prefix =
21421   message_suffix =
21422
21423 # router
21424 local_user_cyrus:
21425   driver = accept
21426   check_local_user
21427   local_part_suffix = .*
21428   transport = local_delivery_cyrus
21429 .endd
21430 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
21431 &%return_output%& to cause any text written by Cyrus to be returned to the
21432 sender.
21433 .ecindex IIDpiptra1
21434 .ecindex IIDpiptra2
21435
21436
21437 . ////////////////////////////////////////////////////////////////////////////
21438 . ////////////////////////////////////////////////////////////////////////////
21439
21440 .chapter "The smtp transport" "CHAPsmtptrans"
21441 .scindex IIDsmttra1 "transports" "&(smtp)&"
21442 .scindex IIDsmttra2 "&(smtp)& transport"
21443 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
21444 or LMTP protocol. The list of hosts to try can either be taken from the address
21445 that is being processed (having been set up by the router), or specified
21446 explicitly for the transport. Timeout and retry processing (see chapter
21447 &<<CHAPretry>>&) is applied to each IP address independently.
21448
21449
21450 .section "Multiple messages on a single connection" "SECID144"
21451 The sending of multiple messages over a single TCP/IP connection can arise in
21452 two ways:
21453
21454 .ilist
21455 If a message contains more than &%max_rcpt%& (see below) addresses that are
21456 routed to the same host, more than one copy of the message has to be sent to
21457 that host. In this situation, multiple copies may be sent in a single run of
21458 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
21459 does when it has too many addresses to send in one message also depends on the
21460 value of the global &%remote_max_parallel%& option. Details are given in
21461 section &<<SECToutSMTPTCP>>&.)
21462 .next
21463 .cindex "hints database" "remembering routing"
21464 When a message has been successfully delivered over a TCP/IP connection, Exim
21465 looks in its hints database to see if there are any other messages awaiting a
21466 connection to the same host. If there are, a new delivery process is started
21467 for one of them, and the current TCP/IP connection is passed on to it. The new
21468 process may in turn send multiple copies and possibly create yet another
21469 process.
21470 .endlist
21471
21472
21473 For each copy sent over the same TCP/IP connection, a sequence counter is
21474 incremented, and if it ever gets to the value of &%connection_max_messages%&,
21475 no further messages are sent over that connection.
21476
21477
21478
21479 .section "Use of the $host and $host_address variables" "SECID145"
21480 .vindex "&$host$&"
21481 .vindex "&$host_address$&"
21482 At the start of a run of the &(smtp)& transport, the values of &$host$& and
21483 &$host_address$& are the name and IP address of the first host on the host list
21484 passed by the router. However, when the transport is about to connect to a
21485 specific host, and while it is connected to that host, &$host$& and
21486 &$host_address$& are set to the values for that host. These are the values
21487 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
21488 &%serialize_hosts%&, and the various TLS options are expanded.
21489
21490
21491 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
21492 .vindex &$tls_cipher$&
21493 .vindex &$tls_peerdn$&
21494 At the start of a run of the &(smtp)& transport, the values of &$tls_cipher$&
21495 and &$tls_peerdn$& are the values that were set when the message was received.
21496 These are the values that are used for options that are expanded before any
21497 SMTP connections are made. Just before each connection is made, these two
21498 variables are emptied. If TLS is subsequently started, they are set to the
21499 appropriate values for the outgoing connection, and these are the values that
21500 are in force when any authenticators are run and when the
21501 &%authenticated_sender%& option is expanded.
21502
21503
21504 .section "Private options for smtp" "SECID146"
21505 .cindex "options" "&(smtp)& transport"
21506 The private options of the &(smtp)& transport are as follows:
21507
21508
21509 .option address_retry_include_sender smtp boolean true
21510 .cindex "4&'xx'& responses" "retrying after"
21511 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
21512 is the combination of sender and recipient that is delayed in subsequent queue
21513 runs until the retry time is reached. You can delay the recipient without
21514 reference to the sender (which is what earlier versions of Exim did), by
21515 setting &%address_retry_include_sender%& false. However, this can lead to
21516 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
21517
21518 .option allow_localhost smtp boolean false
21519 .cindex "local host" "sending to"
21520 .cindex "fallback" "hosts specified on transport"
21521 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
21522 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
21523 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
21524 the delivery anyway. This should be used only in special cases when the
21525 configuration ensures that no looping will result (for example, a differently
21526 configured Exim is listening on the port to which the message is sent).
21527
21528
21529 .option authenticated_sender smtp string&!! unset
21530 .cindex "Cyrus"
21531 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
21532 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
21533 overriding any existing authenticated sender value. If the string expansion is
21534 forced to fail, the option is ignored. Other expansion failures cause delivery
21535 to be deferred. If the result of expansion is an empty string, that is also
21536 ignored.
21537
21538 The expansion happens after the outgoing connection has been made and TLS
21539 started, if required. This means that the &$host$&, &$host_address$&,
21540 &$tls_cipher$&, and &$tls_peerdn$& variables are set according to the
21541 particular connection.
21542
21543 If the SMTP session is not authenticated, the expansion of
21544 &%authenticated_sender%& still happens (and can cause the delivery to be
21545 deferred if it fails), but no AUTH= item is added to MAIL commands
21546 unless &%authenticated_sender_force%& is true.
21547
21548 This option allows you to use the &(smtp)& transport in LMTP mode to
21549 deliver mail to Cyrus IMAP and provide the proper local part as the
21550 &"authenticated sender"&, via a setting such as:
21551 .code
21552 authenticated_sender = $local_part
21553 .endd
21554 This removes the need for IMAP subfolders to be assigned special ACLs to
21555 allow direct delivery to those subfolders.
21556
21557 Because of expected uses such as that just described for Cyrus (when no
21558 domain is involved), there is no checking on the syntax of the provided
21559 value.
21560
21561
21562 .option authenticated_sender_force smtp boolean false
21563 If this option is set true, the &%authenticated_sender%& option's value
21564 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
21565 authenticated as a client.
21566
21567
21568 .option command_timeout smtp time 5m
21569 This sets a timeout for receiving a response to an SMTP command that has been
21570 sent out. It is also used when waiting for the initial banner line from the
21571 remote host. Its value must not be zero.
21572
21573
21574 .option connect_timeout smtp time 5m
21575 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
21576 to a remote host. A setting of zero allows the system timeout (typically
21577 several minutes) to act. To have any effect, the value of this option must be
21578 less than the system timeout. However, it has been observed that on some
21579 systems there is no system timeout, which is why the default value for this
21580 option is 5 minutes, a value recommended by RFC 1123.
21581
21582
21583 .option connection_max_messages smtp integer 500
21584 .cindex "SMTP" "passed connection"
21585 .cindex "SMTP" "multiple deliveries"
21586 .cindex "multiple SMTP deliveries"
21587 This controls the maximum number of separate message deliveries that are sent
21588 over a single TCP/IP connection. If the value is zero, there is no limit.
21589 For testing purposes, this value can be overridden by the &%-oB%& command line
21590 option.
21591
21592
21593 .option data_timeout smtp time 5m
21594 This sets a timeout for the transmission of each block in the data portion of
21595 the message. As a result, the overall timeout for a message depends on the size
21596 of the message. Its value must not be zero. See also &%final_timeout%&.
21597
21598
21599 .option delay_after_cutoff smtp boolean true
21600 This option controls what happens when all remote IP addresses for a given
21601 domain have been inaccessible for so long that they have passed their retry
21602 cutoff times.
21603
21604 In the default state, if the next retry time has not been reached for any of
21605 them, the address is bounced without trying any deliveries. In other words,
21606 Exim delays retrying an IP address after the final cutoff time until a new
21607 retry time is reached, and can therefore bounce an address without ever trying
21608 a delivery, when machines have been down for a long time. Some people are
21609 unhappy at this prospect, so...
21610
21611 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
21612 addresses are past their final cutoff time, Exim tries to deliver to those
21613 IP addresses that have not been tried since the message arrived. If there are
21614 none, of if they all fail, the address is bounced. In other words, it does not
21615 delay when a new message arrives, but immediately tries those expired IP
21616 addresses that haven't been tried since the message arrived. If there is a
21617 continuous stream of messages for the dead hosts, unsetting
21618 &%delay_after_cutoff%& means that there will be many more attempts to deliver
21619 to them.
21620
21621
21622 .option dns_qualify_single smtp boolean true
21623 If the &%hosts%& or &%fallback_hosts%& option is being used,
21624 and the &%gethostbyname%& option is false,
21625 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
21626 in chapter &<<CHAPdnslookup>>& for more details.
21627
21628
21629 .option dns_search_parents smtp boolean false
21630 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
21631 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
21632 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
21633 details.
21634
21635
21636
21637 .option fallback_hosts smtp "string list" unset
21638 .cindex "fallback" "hosts specified on transport"
21639 String expansion is not applied to this option. The argument must be a
21640 colon-separated list of host names or IP addresses, optionally also including
21641 port numbers, though the separator can be changed, as described in section
21642 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
21643 item in a &%route_list%& setting for the &(manualroute)& router, as described
21644 in section &<<SECTformatonehostitem>>&.
21645
21646 Fallback hosts can also be specified on routers, which associate them with the
21647 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
21648 &%fallback_hosts%& specified on the transport is used only if the address does
21649 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
21650 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
21651 However, &%hosts_randomize%& does apply to fallback host lists.
21652
21653 If Exim is unable to deliver to any of the hosts for a particular address, and
21654 the errors are not permanent rejections, the address is put on a separate
21655 transport queue with its host list replaced by the fallback hosts, unless the
21656 address was routed via MX records and the current host was in the original MX
21657 list. In that situation, the fallback host list is not used.
21658
21659 Once normal deliveries are complete, the fallback queue is delivered by
21660 re-running the same transports with the new host lists. If several failing
21661 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
21662 copy of the message is sent.
21663
21664 The resolution of the host names on the fallback list is controlled by the
21665 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
21666 both to cases when the host list comes with the address and when it is taken
21667 from &%hosts%&. This option provides a &"use a smart host only if delivery
21668 fails"& facility.
21669
21670
21671 .option final_timeout smtp time 10m
21672 This is the timeout that applies while waiting for the response to the final
21673 line containing just &"."& that terminates a message. Its value must not be
21674 zero.
21675
21676 .option gethostbyname smtp boolean false
21677 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
21678 being used, names are looked up using &[gethostbyname()]&
21679 (or &[getipnodebyname()]& when available)
21680 instead of using the DNS. Of course, that function may in fact use the DNS, but
21681 it may also consult other sources of information such as &_/etc/hosts_&.
21682
21683 .option gnutls_require_kx smtp string unset
21684 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
21685 client. For details, see section &<<SECTreqciphgnu>>&.
21686
21687 .option gnutls_require_mac smtp string unset
21688 This option controls the MAC algorithms when GnuTLS is used in an Exim
21689 client. For details, see section &<<SECTreqciphgnu>>&.
21690
21691 .option gnutls_require_protocols smtp string unset
21692 This option controls the protocols when GnuTLS is used in an Exim
21693 client. For details, see section &<<SECTreqciphgnu>>&.
21694
21695 .option gnutls_compat_mode smtp boolean unset
21696 This option controls whether GnuTLS is used in compatibility mode in an Exim
21697 server. This reduces security slightly, but improves interworking with older
21698 implementations of TLS.
21699
21700 .option helo_data smtp string&!! "see below"
21701 .cindex "HELO" "argument, setting"
21702 .cindex "EHLO" "argument, setting"
21703 .cindex "LHLO argument setting"
21704 The value of this option is expanded after a connection to a another host has
21705 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
21706 command that starts the outgoing SMTP or LMTP session. The default value of the
21707 option is:
21708 .code
21709 $primary_hostname
21710 .endd
21711 During the expansion, the variables &$host$& and &$host_address$& are set to
21712 the identity of the remote host, and the variables &$sending_ip_address$& and
21713 &$sending_port$& are set to the local IP address and port number that are being
21714 used. These variables can be used to generate different values for different
21715 servers or different local IP addresses. For example, if you want the string
21716 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
21717 interface address, you could use this:
21718 .code
21719 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
21720   {$primary_hostname}}
21721 .endd
21722 The use of &%helo_data%& applies both to sending messages and when doing
21723 callouts.
21724
21725 .option hosts smtp "string list&!!" unset
21726 Hosts are associated with an address by a router such as &(dnslookup)&, which
21727 finds the hosts by looking up the address domain in the DNS, or by
21728 &(manualroute)&, which has lists of hosts in its configuration. However,
21729 email addresses can be passed to the &(smtp)& transport by any router, and not
21730 all of them can provide an associated list of hosts.
21731
21732 The &%hosts%& option specifies a list of hosts to be used if the address being
21733 processed does not have any hosts associated with it. The hosts specified by
21734 &%hosts%& are also used, whether or not the address has its own hosts, if
21735 &%hosts_override%& is set.
21736
21737 The string is first expanded, before being interpreted as a colon-separated
21738 list of host names or IP addresses, possibly including port numbers. The
21739 separator may be changed to something other than colon, as described in section
21740 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
21741 item in a &%route_list%& setting for the &(manualroute)& router, as described
21742 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
21743 of the &(manualroute)& router is not available here.
21744
21745 If the expansion fails, delivery is deferred. Unless the failure was caused by
21746 the inability to complete a lookup, the error is logged to the panic log as
21747 well as the main log. Host names are looked up either by searching directly for
21748 address records in the DNS or by calling &[gethostbyname()]& (or
21749 &[getipnodebyname()]& when available), depending on the setting of the
21750 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
21751 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
21752 address are used.
21753
21754 During delivery, the hosts are tried in order, subject to their retry status,
21755 unless &%hosts_randomize%& is set.
21756
21757
21758 .option hosts_avoid_esmtp smtp "host list&!!" unset
21759 .cindex "ESMTP, avoiding use of"
21760 .cindex "HELO" "forcing use of"
21761 .cindex "EHLO" "avoiding use of"
21762 .cindex "PIPELINING" "avoiding the use of"
21763 This option is for use with broken hosts that announce ESMTP facilities (for
21764 example, PIPELINING) and then fail to implement them properly. When a host
21765 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
21766 start of the SMTP session. This means that it cannot use any of the ESMTP
21767 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
21768
21769
21770 .option hosts_avoid_pipelining smtp "host list&!!" unset
21771 .cindex "PIPELINING" "avoiding the use of"
21772 Exim will not use the SMTP PIPELINING extension when delivering to any host
21773 that matches this list, even if the server host advertises PIPELINING support.
21774
21775
21776 .option hosts_avoid_tls smtp "host list&!!" unset
21777 .cindex "TLS" "avoiding for certain hosts"
21778 Exim will not try to start a TLS session when delivering to any host that
21779 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
21780
21781
21782 .option hosts_max_try smtp integer 5
21783 .cindex "host" "maximum number to try"
21784 .cindex "limit" "number of hosts tried"
21785 .cindex "limit" "number of MX tried"
21786 .cindex "MX record" "maximum tried"
21787 This option limits the number of IP addresses that are tried for any one
21788 delivery in cases where there are temporary delivery errors. Section
21789 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
21790
21791
21792 .option hosts_max_try_hardlimit smtp integer 50
21793 This is an additional check on the maximum number of IP addresses that Exim
21794 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
21795 why it exists.
21796
21797
21798
21799 .option hosts_nopass_tls smtp "host list&!!" unset
21800 .cindex "TLS" "passing connection"
21801 .cindex "multiple SMTP deliveries"
21802 .cindex "TLS" "multiple message deliveries"
21803 For any host that matches this list, a connection on which a TLS session has
21804 been started will not be passed to a new delivery process for sending another
21805 message on the same connection. See section &<<SECTmulmessam>>& for an
21806 explanation of when this might be needed.
21807
21808
21809 .option hosts_override smtp boolean false
21810 If this option is set and the &%hosts%& option is also set, any hosts that are
21811 attached to the address are ignored, and instead the hosts specified by the
21812 &%hosts%& option are always used. This option does not apply to
21813 &%fallback_hosts%&.
21814
21815
21816 .option hosts_randomize smtp boolean false
21817 .cindex "randomized host list"
21818 .cindex "host" "list of; randomized"
21819 .cindex "fallback" "randomized hosts"
21820 If this option is set, and either the list of hosts is taken from the
21821 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
21822 were not obtained from MX records (this includes fallback hosts from the
21823 router), and were not randomized by the router, the order of trying the hosts
21824 is randomized each time the transport runs. Randomizing the order of a host
21825 list can be used to do crude load sharing.
21826
21827 When &%hosts_randomize%& is true, a host list may be split into groups whose
21828 order is separately randomized. This makes it possible to set up MX-like
21829 behaviour. The boundaries between groups are indicated by an item that is just
21830 &`+`& in the host list. For example:
21831 .code
21832 hosts = host1:host2:host3:+:host4:host5
21833 .endd
21834 The order of the first three hosts and the order of the last two hosts is
21835 randomized for each use, but the first three always end up before the last two.
21836 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
21837
21838 .option hosts_require_auth smtp "host list&!!" unset
21839 .cindex "authentication" "required by client"
21840 This option provides a list of servers for which authentication must succeed
21841 before Exim will try to transfer a message. If authentication fails for
21842 servers which are not in this list, Exim tries to send unauthenticated. If
21843 authentication fails for one of these servers, delivery is deferred. This
21844 temporary error is detectable in the retry rules, so it can be turned into a
21845 hard failure if required. See also &%hosts_try_auth%&, and chapter
21846 &<<CHAPSMTPAUTH>>& for details of authentication.
21847
21848
21849 .option hosts_require_tls smtp "host list&!!" unset
21850 .cindex "TLS" "requiring for certain servers"
21851 Exim will insist on using a TLS session when delivering to any host that
21852 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
21853 &*Note*&: This option affects outgoing mail only. To insist on TLS for
21854 incoming messages, use an appropriate ACL.
21855
21856 .option hosts_try_auth smtp "host list&!!" unset
21857 .cindex "authentication" "optional in client"
21858 This option provides a list of servers to which, provided they announce
21859 authentication support, Exim will attempt to authenticate as a client when it
21860 connects. If authentication fails, Exim will try to transfer the message
21861 unauthenticated. See also &%hosts_require_auth%&, and chapter
21862 &<<CHAPSMTPAUTH>>& for details of authentication.
21863
21864 .option interface smtp "string list&!!" unset
21865 .cindex "bind IP address"
21866 .cindex "IP address" "binding"
21867 .vindex "&$host$&"
21868 .vindex "&$host_address$&"
21869 This option specifies which interface to bind to when making an outgoing SMTP
21870 call. The value is an IP address, not an interface name such as
21871 &`eth0`&. Do not confuse this with the interface address that was used when a
21872 message was received, which is in &$received_ip_address$&, formerly known as
21873 &$interface_address$&. The name was changed to minimize confusion with the
21874 outgoing interface address. There is no variable that contains an outgoing
21875 interface address because, unless it is set by this option, its value is
21876 unknown.
21877
21878 During the expansion of the &%interface%& option the variables &$host$& and
21879 &$host_address$& refer to the host to which a connection is about to be made
21880 during the expansion of the string. Forced expansion failure, or an empty
21881 string result causes the option to be ignored. Otherwise, after expansion, the
21882 string must be a list of IP addresses, colon-separated by default, but the
21883 separator can be changed in the usual way. For example:
21884 .code
21885 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
21886 .endd
21887 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
21888 connection. If none of them are the correct type, the option is ignored. If
21889 &%interface%& is not set, or is ignored, the system's IP functions choose which
21890 interface to use if the host has more than one.
21891
21892
21893 .option keepalive smtp boolean true
21894 .cindex "keepalive" "on outgoing connection"
21895 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
21896 connections. When set, it causes the kernel to probe idle connections
21897 periodically, by sending packets with &"old"& sequence numbers. The other end
21898 of the connection should send a acknowledgment if the connection is still okay
21899 or a reset if the connection has been aborted. The reason for doing this is
21900 that it has the beneficial effect of freeing up certain types of connection
21901 that can get stuck when the remote host is disconnected without tidying up the
21902 TCP/IP call properly. The keepalive mechanism takes several hours to detect
21903 unreachable hosts.
21904
21905
21906 .option lmtp_ignore_quota smtp boolean false
21907 .cindex "LMTP" "ignoring quota errors"
21908 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
21909 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
21910 has advertised support for IGNOREQUOTA in its response to the LHLO command.
21911
21912 .option max_rcpt smtp integer 100
21913 .cindex "RCPT" "maximum number of outgoing"
21914 This option limits the number of RCPT commands that are sent in a single
21915 SMTP message transaction. Each set of addresses is treated independently, and
21916 so can cause parallel connections to the same host if &%remote_max_parallel%&
21917 permits this.
21918
21919
21920 .option multi_domain smtp boolean true
21921 .vindex "&$domain$&"
21922 When this option is set, the &(smtp)& transport can handle a number of
21923 addresses containing a mixture of different domains provided they all resolve
21924 to the same list of hosts. Turning the option off restricts the transport to
21925 handling only one domain at a time. This is useful if you want to use
21926 &$domain$& in an expansion for the transport, because it is set only when there
21927 is a single domain involved in a remote delivery.
21928
21929
21930 .option port smtp string&!! "see below"
21931 .cindex "port" "sending TCP/IP"
21932 .cindex "TCP/IP" "setting outgoing port"
21933 This option specifies the TCP/IP port on the server to which Exim connects.
21934 &*Note:*& Do not confuse this with the port that was used when a message was
21935 received, which is in &$received_port$&, formerly known as &$interface_port$&.
21936 The name was changed to minimize confusion with the outgoing port. There is no
21937 variable that contains an outgoing port.
21938
21939 If the value of this option begins with a digit it is taken as a port number;
21940 otherwise it is looked up using &[getservbyname()]&. The default value is
21941 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
21942 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
21943 is deferred.
21944
21945
21946
21947 .option protocol smtp string smtp
21948 .cindex "LMTP" "over TCP/IP"
21949 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
21950 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
21951 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
21952 deliveries into closed message stores. Exim also has support for running LMTP
21953 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
21954
21955
21956 .option retry_include_ip_address smtp boolean true
21957 Exim normally includes both the host name and the IP address in the key it
21958 constructs for indexing retry data after a temporary delivery failure. This
21959 means that when one of several IP addresses for a host is failing, it gets
21960 tried periodically (controlled by the retry rules), but use of the other IP
21961 addresses is not affected.
21962
21963 However, in some dialup environments hosts are assigned a different IP address
21964 each time they connect. In this situation the use of the IP address as part of
21965 the retry key leads to undesirable behaviour. Setting this option false causes
21966 Exim to use only the host name. This should normally be done on a separate
21967 instance of the &(smtp)& transport, set up specially to handle the dialup
21968 hosts.
21969
21970
21971 .option serialize_hosts smtp "host list&!!" unset
21972 .cindex "serializing connections"
21973 .cindex "host" "serializing connections"
21974 Because Exim operates in a distributed manner, if several messages for the same
21975 host arrive at around the same time, more than one simultaneous connection to
21976 the remote host can occur. This is not usually a problem except when there is a
21977 slow link between the hosts. In that situation it may be helpful to restrict
21978 Exim to one connection at a time. This can be done by setting
21979 &%serialize_hosts%& to match the relevant hosts.
21980
21981 .cindex "hints database" "serializing deliveries to a host"
21982 Exim implements serialization by means of a hints database in which a record is
21983 written whenever a process connects to one of the restricted hosts. The record
21984 is deleted when the connection is completed. Obviously there is scope for
21985 records to get left lying around if there is a system or program crash. To
21986 guard against this, Exim ignores any records that are more than six hours old.
21987
21988 If you set up this kind of serialization, you should also arrange to delete the
21989 relevant hints database whenever your system reboots. The names of the files
21990 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21991 may be one or two files, depending on the type of DBM in use. The same files
21992 are used for ETRN serialization.
21993
21994
21995 .option size_addition smtp integer 1024
21996 .cindex "SMTP" "SIZE"
21997 .cindex "message" "size issue for transport filter"
21998 .cindex "size" "of message"
21999 .cindex "transport" "filter"
22000 .cindex "filter" "transport filter"
22001 If a remote SMTP server indicates that it supports the SIZE option of the
22002 MAIL command, Exim uses this to pass over the message size at the start of
22003 an SMTP transaction. It adds the value of &%size_addition%& to the value it
22004 sends, to allow for headers and other text that may be added during delivery by
22005 configuration options or in a transport filter. It may be necessary to increase
22006 this if a lot of text is added to messages.
22007
22008 Alternatively, if the value of &%size_addition%& is set negative, it disables
22009 the use of the SIZE option altogether.
22010
22011
22012 .option tls_certificate smtp string&!! unset
22013 .cindex "TLS" "client certificate, location of"
22014 .cindex "certificate" "client, location of"
22015 .vindex "&$host$&"
22016 .vindex "&$host_address$&"
22017 The value of this option must be the absolute path to a file which contains the
22018 client's certificate, for possible use when sending a message over an encrypted
22019 connection. The values of &$host$& and &$host_address$& are set to the name and
22020 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
22021 details of TLS.
22022
22023 &*Note*&: This option must be set if you want Exim to be able to use a TLS
22024 certificate when sending messages as a client. The global option of the same
22025 name specifies the certificate for Exim as a server; it is not automatically
22026 assumed that the same certificate should be used when Exim is operating as a
22027 client.
22028
22029
22030 .option tls_crl smtp string&!! unset
22031 .cindex "TLS" "client certificate revocation list"
22032 .cindex "certificate" "revocation list for client"
22033 This option specifies a certificate revocation list. The expanded value must
22034 be the name of a file that contains a CRL in PEM format.
22035
22036
22037 .option tls_privatekey smtp string&!! unset
22038 .cindex "TLS" "client private key, location of"
22039 .vindex "&$host$&"
22040 .vindex "&$host_address$&"
22041 The value of this option must be the absolute path to a file which contains the
22042 client's private key. This is used when sending a message over an encrypted
22043 connection using a client certificate. The values of &$host$& and
22044 &$host_address$& are set to the name and address of the server during the
22045 expansion. If this option is unset, or the expansion is forced to fail, or the
22046 result is an empty string, the private key is assumed to be in the same file as
22047 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
22048
22049
22050 .option tls_require_ciphers smtp string&!! unset
22051 .cindex "TLS" "requiring specific ciphers"
22052 .cindex "cipher" "requiring specific"
22053 .vindex "&$host$&"
22054 .vindex "&$host_address$&"
22055 The value of this option must be a list of permitted cipher suites, for use
22056 when setting up an outgoing encrypted connection. (There is a global option of
22057 the same name for controlling incoming connections.) The values of &$host$& and
22058 &$host_address$& are set to the name and address of the server during the
22059 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
22060 is used in different ways by OpenSSL and GnuTLS (see sections
22061 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
22062 ciphers is a preference order.
22063
22064
22065
22066 .option tls_tempfail_tryclear smtp boolean true
22067 .cindex "4&'xx'& responses" "to STARTTLS"
22068 When the server host is not in &%hosts_require_tls%&, and there is a problem in
22069 setting up a TLS session, this option determines whether or not Exim should try
22070 to deliver the message unencrypted. If it is set false, delivery to the
22071 current host is deferred; if there are other hosts, they are tried. If this
22072 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
22073 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
22074 TLS negotiation fails, Exim closes the current connection (because it is in an
22075 unknown state), opens a new one to the same host, and then tries the delivery
22076 in clear.
22077
22078
22079 .option tls_verify_certificates smtp string&!! unset
22080 .cindex "TLS" "server certificate verification"
22081 .cindex "certificate" "verification of server"
22082 .vindex "&$host$&"
22083 .vindex "&$host_address$&"
22084 The value of this option must be the absolute path to a file containing
22085 permitted server certificates, for use when setting up an encrypted connection.
22086 Alternatively, if you are using OpenSSL, you can set
22087 &%tls_verify_certificates%& to the name of a directory containing certificate
22088 files. This does not work with GnuTLS; the option must be set to the name of a
22089 single file if you are using GnuTLS. The values of &$host$& and
22090 &$host_address$& are set to the name and address of the server during the
22091 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
22092
22093
22094
22095
22096 .section "How the limits for the number of hosts to try are used" &&&
22097          "SECTvalhosmax"
22098 .cindex "host" "maximum number to try"
22099 .cindex "limit" "hosts; maximum number tried"
22100 There are two options that are concerned with the number of hosts that are
22101 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
22102 &%hosts_max_try_hardlimit%&.
22103
22104
22105 The &%hosts_max_try%& option limits the number of hosts that are tried
22106 for a single delivery. However, despite the term &"host"& in its name, the
22107 option actually applies to each IP address independently. In other words, a
22108 multihomed host is treated as several independent hosts, just as it is for
22109 retrying.
22110
22111 Many of the larger ISPs have multiple MX records which often point to
22112 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
22113 created as a result of routing one of these domains.
22114
22115 Trying every single IP address on such a long list does not seem sensible; if
22116 several at the top of the list fail, it is reasonable to assume there is some
22117 problem that is likely to affect all of them. Roughly speaking, the value of
22118 &%hosts_max_try%& is the maximum number that are tried before deferring the
22119 delivery. However, the logic cannot be quite that simple.
22120
22121 Firstly, IP addresses that are skipped because their retry times have not
22122 arrived do not count, and in addition, addresses that are past their retry
22123 limits are also not counted, even when they are tried. This means that when
22124 some IP addresses are past their retry limits, more than the value of
22125 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
22126 that all IP addresses are considered before timing out an email address (but
22127 see below for an exception).
22128
22129 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
22130 list to see if there is a subsequent host with a different (higher valued) MX.
22131 If there is, that host is considered next, and the current IP address is used
22132 but not counted. This behaviour helps in the case of a domain with a retry rule
22133 that hardly ever delays any hosts, as is now explained:
22134
22135 Consider the case of a long list of hosts with one MX value, and a few with a
22136 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
22137 hosts at the top of the list are tried at first. With the default retry rule,
22138 which specifies increasing retry times, the higher MX hosts are eventually
22139 tried when those at the top of the list are skipped because they have not
22140 reached their retry times.
22141
22142 However, it is common practice to put a fixed short retry time on domains for
22143 large ISPs, on the grounds that their servers are rarely down for very long.
22144 Unfortunately, these are exactly the domains that tend to resolve to long lists
22145 of hosts. The short retry time means that the lowest MX hosts are tried every
22146 time. The attempts may be in a different order because of random sorting, but
22147 without the special MX check, the higher MX hosts would never be tried until
22148 all the lower MX hosts had timed out (which might be several days), because
22149 there are always some lower MX hosts that have reached their retry times. With
22150 the special check, Exim considers at least one IP address from each MX value at
22151 every delivery attempt, even if the &%hosts_max_try%& limit has already been
22152 reached.
22153
22154 The above logic means that &%hosts_max_try%& is not a hard limit, and in
22155 particular, Exim normally eventually tries all the IP addresses before timing
22156 out an email address. When &%hosts_max_try%& was implemented, this seemed a
22157 reasonable thing to do. Recently, however, some lunatic DNS configurations have
22158 been set up with hundreds of IP addresses for some domains. It can
22159 take a very long time indeed for an address to time out in these cases.
22160
22161 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
22162 Exim never tries more than this number of IP addresses; if it hits this limit
22163 and they are all timed out, the email address is bounced, even though not all
22164 possible IP addresses have been tried.
22165 .ecindex IIDsmttra1
22166 .ecindex IIDsmttra2
22167
22168
22169
22170
22171
22172 . ////////////////////////////////////////////////////////////////////////////
22173 . ////////////////////////////////////////////////////////////////////////////
22174
22175 .chapter "Address rewriting" "CHAPrewrite"
22176 .scindex IIDaddrew "rewriting" "addresses"
22177 There are some circumstances in which Exim automatically rewrites domains in
22178 addresses. The two most common are when an address is given without a domain
22179 (referred to as an &"unqualified address"&) or when an address contains an
22180 abbreviated domain that is expanded by DNS lookup.
22181
22182 Unqualified envelope addresses are accepted only for locally submitted
22183 messages, or for messages that are received from hosts matching
22184 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
22185 appropriate. Unqualified addresses in header lines are qualified if they are in
22186 locally submitted messages, or messages from hosts that are permitted to send
22187 unqualified envelope addresses. Otherwise, unqualified addresses in header
22188 lines are neither qualified nor rewritten.
22189
22190 One situation in which Exim does &'not'& automatically rewrite a domain is
22191 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
22192 such a domain should be rewritten using the &"canonical"& name, and some MTAs
22193 do this. The new RFCs do not contain this suggestion.
22194
22195
22196 .section "Explicitly configured address rewriting" "SECID147"
22197 This chapter describes the rewriting rules that can be used in the
22198 main rewrite section of the configuration file, and also in the generic
22199 &%headers_rewrite%& option that can be set on any transport.
22200
22201 Some people believe that configured address rewriting is a Mortal Sin.
22202 Others believe that life is not possible without it. Exim provides the
22203 facility; you do not have to use it.
22204
22205 The main rewriting rules that appear in the &"rewrite"& section of the
22206 configuration file are applied to addresses in incoming messages, both envelope
22207 addresses and addresses in header lines. Each rule specifies the types of
22208 address to which it applies.
22209
22210 Whether or not addresses in header lines are rewritten depends on the origin of
22211 the headers and the type of rewriting. Global rewriting, that is, rewriting
22212 rules from the rewrite section of the configuration file, is applied only to
22213 those headers that were received with the message. Header lines that are added
22214 by ACLs or by a system filter or by individual routers or transports (which
22215 are specific to individual recipient addresses) are not rewritten by the global
22216 rules.
22217
22218 Rewriting at transport time, by means of the &%headers_rewrite%& option,
22219 applies all headers except those added by routers and transports. That is, as
22220 well as the headers that were received with the message, it also applies to
22221 headers that were added by an ACL or a system filter.
22222
22223
22224 In general, rewriting addresses from your own system or domain has some
22225 legitimacy. Rewriting other addresses should be done only with great care and
22226 in special circumstances. The author of Exim believes that rewriting should be
22227 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
22228 Although it can sometimes be used as a routing tool, this is very strongly
22229 discouraged.
22230
22231 There are two commonly encountered circumstances where rewriting is used, as
22232 illustrated by these examples:
22233
22234 .ilist
22235 The company whose domain is &'hitch.fict.example'& has a number of hosts that
22236 exchange mail with each other behind a firewall, but there is only a single
22237 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
22238 &'hitch.fict.example'& when sending mail off-site.
22239 .next
22240 A host rewrites the local parts of its own users so that, for example,
22241 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
22242 .endlist
22243
22244
22245
22246 .section "When does rewriting happen?" "SECID148"
22247 .cindex "rewriting" "timing of"
22248 .cindex "&ACL;" "rewriting addresses in"
22249 Configured address rewriting can take place at several different stages of a
22250 message's processing.
22251
22252 .vindex "&$sender_address$&"
22253 At the start of an ACL for MAIL, the sender address may have been rewritten
22254 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
22255 ordinary rewrite rules have yet been applied. If, however, the sender address
22256 is verified in the ACL, it is rewritten before verification, and remains
22257 rewritten thereafter. The subsequent value of &$sender_address$& is the
22258 rewritten address. This also applies if sender verification happens in a
22259 RCPT ACL. Otherwise, when the sender address is not verified, it is
22260 rewritten as soon as a message's header lines have been received.
22261
22262 .vindex "&$domain$&"
22263 .vindex "&$local_part$&"
22264 Similarly, at the start of an ACL for RCPT, the current recipient's address
22265 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
22266 rewrite rules have yet been applied to it. However, the behaviour is different
22267 from the sender address when a recipient is verified. The address is rewritten
22268 for the verification, but the rewriting is not remembered at this stage. The
22269 value of &$local_part$& and &$domain$& after verification are always the same
22270 as they were before (that is, they contain the unrewritten &-- except for
22271 SMTP-time rewriting &-- address).
22272
22273 As soon as a message's header lines have been received, all the envelope
22274 recipient addresses are permanently rewritten, and rewriting is also applied to
22275 the addresses in the header lines (if configured). This happens before adding
22276 any header lines that were specified in MAIL or RCPT ACLs, and
22277 .cindex "&[local_scan()]& function" "address rewriting; timing of"
22278 before the DATA ACL and &[local_scan()]& functions are run.
22279
22280 When an address is being routed, either for delivery or for verification,
22281 rewriting is applied immediately to child addresses that are generated by
22282 redirection, unless &%no_rewrite%& is set on the router.
22283
22284 .cindex "envelope sender" "rewriting at transport time"
22285 .cindex "rewriting" "at transport time"
22286 .cindex "header lines" "rewriting at transport time"
22287 At transport time, additional rewriting of addresses in header lines can be
22288 specified by setting the generic &%headers_rewrite%& option on a transport.
22289 This option contains rules that are identical in form to those in the rewrite
22290 section of the configuration file. They are applied to the original message
22291 header lines and any that were added by ACLs or a system filter. They are not
22292 applied to header lines that are added by routers or the transport.
22293
22294 The outgoing envelope sender can be rewritten by means of the &%return_path%&
22295 transport option. However, it is not possible to rewrite envelope recipients at
22296 transport time.
22297
22298
22299
22300
22301 .section "Testing the rewriting rules that apply on input" "SECID149"
22302 .cindex "rewriting" "testing"
22303 .cindex "testing" "rewriting"
22304 Exim's input rewriting configuration appears in a part of the run time
22305 configuration file headed by &"begin rewrite"&. It can be tested by the
22306 &%-brw%& command line option. This takes an address (which can be a full RFC
22307 2822 address) as its argument. The output is a list of how the address would be
22308 transformed by the rewriting rules for each of the different places it might
22309 appear in an incoming message, that is, for each different header and for the
22310 envelope sender and recipient fields. For example,
22311 .code
22312 exim -brw ph10@exim.workshop.example
22313 .endd
22314 might produce the output
22315 .code
22316 sender: Philip.Hazel@exim.workshop.example
22317 from: Philip.Hazel@exim.workshop.example
22318 to: ph10@exim.workshop.example
22319 cc: ph10@exim.workshop.example
22320 bcc: ph10@exim.workshop.example
22321 reply-to: Philip.Hazel@exim.workshop.example
22322 env-from: Philip.Hazel@exim.workshop.example
22323 env-to: ph10@exim.workshop.example
22324 .endd
22325 which shows that rewriting has been set up for that address when used in any of
22326 the source fields, but not when it appears as a recipient address. At the
22327 present time, there is no equivalent way of testing rewriting rules that are
22328 set for a particular transport.
22329
22330
22331 .section "Rewriting rules" "SECID150"
22332 .cindex "rewriting" "rules"
22333 The rewrite section of the configuration file consists of lines of rewriting
22334 rules in the form
22335 .display
22336 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
22337 .endd
22338 Rewriting rules that are specified for the &%headers_rewrite%& generic
22339 transport option are given as a colon-separated list. Each item in the list
22340 takes the same form as a line in the main rewriting configuration (except that
22341 any colons must be doubled, of course).
22342
22343 The formats of source patterns and replacement strings are described below.
22344 Each is terminated by white space, unless enclosed in double quotes, in which
22345 case normal quoting conventions apply inside the quotes. The flags are single
22346 characters which may appear in any order. Spaces and tabs between them are
22347 ignored.
22348
22349 For each address that could potentially be rewritten, the rules are scanned in
22350 order, and replacements for the address from earlier rules can themselves be
22351 replaced by later rules (but see the &"q"& and &"R"& flags).
22352
22353 The order in which addresses are rewritten is undefined, may change between
22354 releases, and must not be relied on, with one exception: when a message is
22355 received, the envelope sender is always rewritten first, before any header
22356 lines are rewritten. For example, the replacement string for a rewrite of an
22357 address in &'To:'& must not assume that the message's address in &'From:'& has
22358 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
22359 that the envelope sender has already been rewritten.
22360
22361 .vindex "&$domain$&"
22362 .vindex "&$local_part$&"
22363 The variables &$local_part$& and &$domain$& can be used in the replacement
22364 string to refer to the address that is being rewritten. Note that lookup-driven
22365 rewriting can be done by a rule of the form
22366 .code
22367 *@*   ${lookup ...
22368 .endd
22369 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
22370 refer to the address that is being rewritten.
22371
22372
22373 .section "Rewriting patterns" "SECID151"
22374 .cindex "rewriting" "patterns"
22375 .cindex "address list" "in a rewriting pattern"
22376 The source pattern in a rewriting rule is any item which may appear in an
22377 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
22378 single-item address list, which means that it is expanded before being tested
22379 against the address. As always, if you use a regular expression as a pattern,
22380 you must take care to escape dollar and backslash characters, or use the &`\N`&
22381 facility to suppress string expansion within the regular expression.
22382
22383 Domains in patterns should be given in lower case. Local parts in patterns are
22384 case-sensitive. If you want to do case-insensitive matching of local parts, you
22385 can use a regular expression that starts with &`^(?i)`&.
22386
22387 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
22388 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
22389 depending on the type of match which occurred. These can be used in the
22390 replacement string to insert portions of the incoming address. &$0$& always
22391 refers to the complete incoming address. When a regular expression is used, the
22392 numerical variables are set from its capturing subexpressions. For other types
22393 of pattern they are set as follows:
22394
22395 .ilist
22396 If a local part or domain starts with an asterisk, the numerical variables
22397 refer to the character strings matched by asterisks, with &$1$& associated with
22398 the first asterisk, and &$2$& with the second, if present. For example, if the
22399 pattern
22400 .code
22401 *queen@*.fict.example
22402 .endd
22403 is matched against the address &'hearts-queen@wonderland.fict.example'& then
22404 .code
22405 $0 = hearts-queen@wonderland.fict.example
22406 $1 = hearts-
22407 $2 = wonderland
22408 .endd
22409 Note that if the local part does not start with an asterisk, but the domain
22410 does, it is &$1$& that contains the wild part of the domain.
22411
22412 .next
22413 If the domain part of the pattern is a partial lookup, the wild and fixed parts
22414 of the domain are placed in the next available numerical variables. Suppose,
22415 for example, that the address &'foo@bar.baz.example'& is processed by a
22416 rewriting rule of the form
22417 .display
22418 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
22419 .endd
22420 and the key in the file that matches the domain is &`*.baz.example`&. Then
22421 .code
22422 $1 = foo
22423 $2 = bar
22424 $3 = baz.example
22425 .endd
22426 If the address &'foo@baz.example'& is looked up, this matches the same
22427 wildcard file entry, and in this case &$2$& is set to the empty string, but
22428 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
22429 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
22430 whole domain. For non-partial domain lookups, no numerical variables are set.
22431 .endlist
22432
22433
22434 .section "Rewriting replacements" "SECID152"
22435 .cindex "rewriting" "replacements"
22436 If the replacement string for a rule is a single asterisk, addresses that
22437 match the pattern and the flags are &'not'& rewritten, and no subsequent
22438 rewriting rules are scanned. For example,
22439 .code
22440 hatta@lookingglass.fict.example  *  f
22441 .endd
22442 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
22443 &'From:'& headers.
22444
22445 .vindex "&$domain$&"
22446 .vindex "&$local_part$&"
22447 If the replacement string is not a single asterisk, it is expanded, and must
22448 yield a fully qualified address. Within the expansion, the variables
22449 &$local_part$& and &$domain$& refer to the address that is being rewritten.
22450 Any letters they contain retain their original case &-- they are not lower
22451 cased. The numerical variables are set up according to the type of pattern that
22452 matched the address, as described above. If the expansion is forced to fail by
22453 the presence of &"fail"& in a conditional or lookup item, rewriting by the
22454 current rule is abandoned, but subsequent rules may take effect. Any other
22455 expansion failure causes the entire rewriting operation to be abandoned, and an
22456 entry written to the panic log.
22457
22458
22459
22460 .section "Rewriting flags" "SECID153"
22461 There are three different kinds of flag that may appear on rewriting rules:
22462
22463 .ilist
22464 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
22465 c, f, h, r, s, t.
22466 .next
22467 A flag that specifies rewriting at SMTP time: S.
22468 .next
22469 Flags that control the rewriting process: Q, q, R, w.
22470 .endlist
22471
22472 For rules that are part of the &%headers_rewrite%& generic transport option,
22473 E, F, T, and S are not permitted.
22474
22475
22476
22477 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
22478          "SECID154"
22479 .cindex "rewriting" "flags"
22480 If none of the following flag letters, nor the &"S"& flag (see section
22481 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
22482 and to both the sender and recipient fields of the envelope, whereas a
22483 transport-time rewriting rule just applies to all headers. Otherwise, the
22484 rewriting rule is skipped unless the relevant addresses are being processed.
22485 .display
22486 &`E`&       rewrite all envelope fields
22487 &`F`&       rewrite the envelope From field
22488 &`T`&       rewrite the envelope To field
22489 &`b`&       rewrite the &'Bcc:'& header
22490 &`c`&       rewrite the &'Cc:'& header
22491 &`f`&       rewrite the &'From:'& header
22492 &`h`&       rewrite all headers
22493 &`r`&       rewrite the &'Reply-To:'& header
22494 &`s`&       rewrite the &'Sender:'& header
22495 &`t`&       rewrite the &'To:'& header
22496 .endd
22497 "All headers" means all of the headers listed above that can be selected
22498 individually, plus their &'Resent-'& versions. It does not include
22499 other headers such as &'Subject:'& etc.
22500
22501 You should be particularly careful about rewriting &'Sender:'& headers, and
22502 restrict this to special known cases in your own domains.
22503
22504
22505 .section "The SMTP-time rewriting flag" "SECTrewriteS"
22506 .cindex "SMTP" "rewriting malformed addresses"
22507 .cindex "RCPT" "rewriting argument of"
22508 .cindex "MAIL" "rewriting argument of"
22509 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
22510 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
22511 before any other processing; even before syntax checking. The pattern is
22512 required to be a regular expression, and it is matched against the whole of the
22513 data for the command, including any surrounding angle brackets.
22514
22515 .vindex "&$domain$&"
22516 .vindex "&$local_part$&"
22517 This form of rewrite rule allows for the handling of addresses that are not
22518 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
22519 input). Because the input is not required to be a syntactically valid address,
22520 the variables &$local_part$& and &$domain$& are not available during the
22521 expansion of the replacement string. The result of rewriting replaces the
22522 original address in the MAIL or RCPT command.
22523
22524
22525 .section "Flags controlling the rewriting process" "SECID155"
22526 There are four flags which control the way the rewriting process works. These
22527 take effect only when a rule is invoked, that is, when the address is of the
22528 correct type (matches the flags) and matches the pattern:
22529
22530 .ilist
22531 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
22532 unqualified local part. It is qualified with &%qualify_recipient%&. In the
22533 absence of &"Q"& the rewritten address must always include a domain.
22534 .next
22535 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
22536 even if no rewriting actually takes place because of a &"fail"& in the
22537 expansion. The &"q"& flag is not effective if the address is of the wrong type
22538 (does not match the flags) or does not match the pattern.
22539 .next
22540 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
22541 address, up to ten times. It can be combined with the &"q"& flag, to stop
22542 rewriting once it fails to match (after at least one successful rewrite).
22543 .next
22544 .cindex "rewriting" "whole addresses"
22545 When an address in a header is rewritten, the rewriting normally applies only
22546 to the working part of the address, with any comments and RFC 2822 &"phrase"&
22547 left unchanged. For example, rewriting might change
22548 .code
22549 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
22550 .endd
22551 into
22552 .code
22553 From: Ford Prefect <prefectf@hitch.fict.example>
22554 .endd
22555 .cindex "RFC 2047"
22556 Sometimes there is a need to replace the whole address item, and this can be
22557 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
22558 causes an address in a header line to be rewritten, the entire address is
22559 replaced, not just the working part. The replacement must be a complete RFC
22560 2822 address, including the angle brackets if necessary. If text outside angle
22561 brackets contains a character whose value is greater than 126 or less than 32
22562 (except for tab), the text is encoded according to RFC 2047. The character set
22563 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
22564
22565 When the &"w"& flag is set on a rule that causes an envelope address to be
22566 rewritten, all but the working part of the replacement address is discarded.
22567 .endlist
22568
22569
22570 .section "Rewriting examples" "SECID156"
22571 Here is an example of the two common rewriting paradigms:
22572 .code
22573 *@*.hitch.fict.example  $1@hitch.fict.example
22574 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
22575                      {$value}fail}@hitch.fict.example bctfrF
22576 .endd
22577 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
22578 the string expansion to fail if the lookup does not succeed. In this context it
22579 has the effect of leaving the original address unchanged, but Exim goes on to
22580 consider subsequent rewriting rules, if any, because the &"q"& flag is not
22581 present in that rule. An alternative to &"fail"& would be to supply &$1$&
22582 explicitly, which would cause the rewritten address to be the same as before,
22583 at the cost of a small bit of processing. Not supplying either of these is an
22584 error, since the rewritten address would then contain no local part.
22585
22586 The first example above replaces the domain with a superior, more general
22587 domain. This may not be desirable for certain local parts. If the rule
22588 .code
22589 root@*.hitch.fict.example  *
22590 .endd
22591 were inserted before the first rule, rewriting would be suppressed for the
22592 local part &'root'& at any domain ending in &'hitch.fict.example'&.
22593
22594 Rewriting can be made conditional on a number of tests, by making use of
22595 &${if$& in the expansion item. For example, to apply a rewriting rule only to
22596 messages that originate outside the local host:
22597 .code
22598 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
22599                          {$1@hitch.fict.example}fail}"
22600 .endd
22601 The replacement string is quoted in this example because it contains white
22602 space.
22603
22604 .cindex "rewriting" "bang paths"
22605 .cindex "bang paths" "rewriting"
22606 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
22607 an address it treats it as an unqualified local part which it qualifies with
22608 the local qualification domain (if the source of the message is local or if the
22609 remote host is permitted to send unqualified addresses). Rewriting can
22610 sometimes be used to handle simple bang paths with a fixed number of
22611 components. For example, the rule
22612 .code
22613 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
22614 .endd
22615 rewrites a two-component bang path &'host.name!user'& as the domain address
22616 &'user@host.name'&. However, there is a security implication in using this as
22617 a global rewriting rule for envelope addresses. It can provide a backdoor
22618 method for using your system as a relay, because the incoming addresses appear
22619 to be local. If the bang path addresses are received via SMTP, it is safer to
22620 use the &"S"& flag to rewrite them as they are received, so that relay checking
22621 can be done on the rewritten addresses.
22622 .ecindex IIDaddrew
22623
22624
22625
22626
22627
22628 . ////////////////////////////////////////////////////////////////////////////
22629 . ////////////////////////////////////////////////////////////////////////////
22630
22631 .chapter "Retry configuration" "CHAPretry"
22632 .scindex IIDretconf1 "retry" "configuration, description of"
22633 .scindex IIDregconf2 "configuration file" "retry section"
22634 The &"retry"& section of the runtime configuration file contains a list of
22635 retry rules that control how often Exim tries to deliver messages that cannot
22636 be delivered at the first attempt. If there are no retry rules (the section is
22637 empty or not present), there are no retries. In this situation, temporary
22638 errors are treated as permanent. The default configuration contains a single,
22639 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
22640 line option can be used to test which retry rule will be used for a given
22641 address, domain and error.
22642
22643 The most common cause of retries is temporary failure to deliver to a remote
22644 host because the host is down, or inaccessible because of a network problem.
22645 Exim's retry processing in this case is applied on a per-host (strictly, per IP
22646 address) basis, not on a per-message basis. Thus, if one message has recently
22647 been delayed, delivery of a new message to the same host is not immediately
22648 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
22649 log selector is set, the message
22650 .cindex "retry" "time not reached"
22651 &"retry time not reached"& is written to the main log whenever a delivery is
22652 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
22653 the handling of errors during remote deliveries.
22654
22655 Retry processing applies to routing as well as to delivering, except as covered
22656 in the next paragraph. The retry rules do not distinguish between these
22657 actions. It is not possible, for example, to specify different behaviour for
22658 failures to route the domain &'snark.fict.example'& and failures to deliver to
22659 the host &'snark.fict.example'&. I didn't think anyone would ever need this
22660 added complication, so did not implement it. However, although they share the
22661 same retry rule, the actual retry times for routing and transporting a given
22662 domain are maintained independently.
22663
22664 When a delivery is not part of a queue run (typically an immediate delivery on
22665 receipt of a message), the routers are always run, and local deliveries are
22666 always attempted, even if retry times are set for them. This makes for better
22667 behaviour if one particular message is causing problems (for example, causing
22668 quota overflow, or provoking an error in a filter file). If such a delivery
22669 suffers a temporary failure, the retry data is updated as normal, and
22670 subsequent delivery attempts from queue runs occur only when the retry time for
22671 the local address is reached.
22672
22673 .section "Changing retry rules" "SECID157"
22674 If you change the retry rules in your configuration, you should consider
22675 whether or not to delete the retry data that is stored in Exim's spool area in
22676 files with names like &_db/retry_&. Deleting any of Exim's hints files is
22677 always safe; that is why they are called &"hints"&.
22678
22679 The hints retry data contains suggested retry times based on the previous
22680 rules. In the case of a long-running problem with a remote host, it might
22681 record the fact that the host has timed out. If your new rules increase the
22682 timeout time for such a host, you should definitely remove the old retry data
22683 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
22684 messages that it should now be retaining.
22685
22686
22687
22688 .section "Format of retry rules" "SECID158"
22689 .cindex "retry" "rules"
22690 Each retry rule occupies one line and consists of three or four parts,
22691 separated by white space: a pattern, an error name, an optional list of sender
22692 addresses, and a list of retry parameters. The pattern and sender lists must be
22693 enclosed in double quotes if they contain white space. The rules are searched
22694 in order until one is found where the pattern, error name, and sender list (if
22695 present) match the failing host or address, the error that occurred, and the
22696 message's sender, respectively.
22697
22698
22699 The pattern is any single item that may appear in an address list (see section
22700 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
22701 which means that it is expanded before being tested against the address that
22702 has been delayed. A negated address list item is permitted. Address
22703 list processing treats a plain domain name as if it were preceded by &"*@"&,
22704 which makes it possible for many retry rules to start with just a domain. For
22705 example,
22706 .code
22707 lookingglass.fict.example        *  F,24h,30m;
22708 .endd
22709 provides a rule for any address in the &'lookingglass.fict.example'& domain,
22710 whereas
22711 .code
22712 alice@lookingglass.fict.example  *  F,24h,30m;
22713 .endd
22714 applies only to temporary failures involving the local part &%alice%&.
22715 In practice, almost all rules start with a domain name pattern without a local
22716 part.
22717
22718 .cindex "regular expressions" "in retry rules"
22719 &*Warning*&: If you use a regular expression in a routing rule pattern, it
22720 must match a complete address, not just a domain, because that is how regular
22721 expressions work in address lists.
22722 .display
22723 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
22724 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
22725 .endd
22726
22727
22728 .section "Choosing which retry rule to use for address errors" "SECID159"
22729 When Exim is looking for a retry rule after a routing attempt has failed (for
22730 example, after a DNS timeout), each line in the retry configuration is tested
22731 against the complete address only if &%retry_use_local_part%& is set for the
22732 router. Otherwise, only the domain is used, except when matching against a
22733 regular expression, when the local part of the address is replaced with &"*"&.
22734 A domain on its own can match a domain pattern, or a pattern that starts with
22735 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
22736 &%check_local_user%& is true, and false for other routers.
22737
22738 Similarly, when Exim is looking for a retry rule after a local delivery has
22739 failed (for example, after a mailbox full error), each line in the retry
22740 configuration is tested against the complete address only if
22741 &%retry_use_local_part%& is set for the transport (it defaults true for all
22742 local transports).
22743
22744 .cindex "4&'xx'& responses" "retry rules for"
22745 However, when Exim is looking for a retry rule after a remote delivery attempt
22746 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
22747 whole address is always used as the key when searching the retry rules. The
22748 rule that is found is used to create a retry time for the combination of the
22749 failing address and the message's sender. It is the combination of sender and
22750 recipient that is delayed in subsequent queue runs until its retry time is
22751 reached. You can delay the recipient without regard to the sender by setting
22752 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
22753 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
22754 commands.
22755
22756
22757
22758 .section "Choosing which retry rule to use for host and message errors" &&&
22759          "SECID160"
22760 For a temporary error that is not related to an individual address (for
22761 example, a connection timeout), each line in the retry configuration is checked
22762 twice. First, the name of the remote host is used as a domain name (preceded by
22763 &"*@"& when matching a regular expression). If this does not match the line,
22764 the domain from the email address is tried in a similar fashion. For example,
22765 suppose the MX records for &'a.b.c.example'& are
22766 .code
22767 a.b.c.example  MX  5  x.y.z.example
22768                MX  6  p.q.r.example
22769                MX  7  m.n.o.example
22770 .endd
22771 and the retry rules are
22772 .code
22773 p.q.r.example    *      F,24h,30m;
22774 a.b.c.example    *      F,4d,45m;
22775 .endd
22776 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
22777 first rule matches neither the host nor the domain, so Exim looks at the second
22778 rule. This does not match the host, but it does match the domain, so it is used
22779 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
22780 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
22781 first retry rule is used, because it matches the host.
22782
22783 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
22784 first rule to determine retry times, but for all the other hosts for the domain
22785 &'a.b.c.example'&, the second rule is used. The second rule is also used if
22786 routing to &'a.b.c.example'& suffers a temporary failure.
22787
22788 &*Note*&: The host name is used when matching the patterns, not its IP address.
22789 However, if a message is routed directly to an IP address without the use of a
22790 host name, for example, if a &(manualroute)& router contains a setting such as:
22791 .code
22792 route_list = *.a.example  192.168.34.23
22793 .endd
22794 then the &"host name"& that is used when searching for a retry rule is the
22795 textual form of the IP address.
22796
22797 .section "Retry rules for specific errors" "SECID161"
22798 .cindex "retry" "specific errors; specifying"
22799 The second field in a retry rule is the name of a particular error, or an
22800 asterisk, which matches any error. The errors that can be tested for are:
22801
22802 .vlist
22803 .vitem &%auth_failed%&
22804 Authentication failed when trying to send to a host in the
22805 &%hosts_require_auth%& list in an &(smtp)& transport.
22806
22807 .vitem &%data_4xx%&
22808 A 4&'xx'& error was received for an outgoing DATA command, either immediately
22809 after the command, or after sending the message's data.
22810
22811 .vitem &%mail_4xx%&
22812 A 4&'xx'& error was received for an outgoing MAIL command.
22813
22814 .vitem &%rcpt_4xx%&
22815 A 4&'xx'& error was received for an outgoing RCPT command.
22816 .endlist
22817
22818 For the three 4&'xx'& errors, either the first or both of the x's can be given
22819 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
22820 recognize 452 errors given to RCPT commands for addresses in a certain domain,
22821 and have retries every ten minutes with a one-hour timeout, you could set up a
22822 retry rule of this form:
22823 .code
22824 the.domain.name  rcpt_452   F,1h,10m
22825 .endd
22826 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
22827 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
22828
22829 .vlist
22830 .vitem &%lost_connection%&
22831 A server unexpectedly closed the SMTP connection. There may, of course,
22832 legitimate reasons for this (host died, network died), but if it repeats a lot
22833 for the same host, it indicates something odd.
22834
22835 .vitem &%refused_MX%&
22836 A connection to a host obtained from an MX record was refused.
22837
22838 .vitem &%refused_A%&
22839 A connection to a host not obtained from an MX record was refused.
22840
22841 .vitem &%refused%&
22842 A connection was refused.
22843
22844 .vitem &%timeout_connect_MX%&
22845 A connection attempt to a host obtained from an MX record timed out.
22846
22847 .vitem &%timeout_connect_A%&
22848 A connection attempt to a host not obtained from an MX record timed out.
22849
22850 .vitem &%timeout_connect%&
22851 A connection attempt timed out.
22852
22853 .vitem &%timeout_MX%&
22854 There was a timeout while connecting or during an SMTP session with a host
22855 obtained from an MX record.
22856
22857 .vitem &%timeout_A%&
22858 There was a timeout while connecting or during an SMTP session with a host not
22859 obtained from an MX record.
22860
22861 .vitem &%timeout%&
22862 There was a timeout while connecting or during an SMTP session.
22863
22864 .vitem &%tls_required%&
22865 The server was required to use TLS (it matched &%hosts_require_tls%& in the
22866 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
22867 to STARTTLS, or there was a problem setting up the TLS connection.
22868
22869 .vitem &%quota%&
22870 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
22871 transport.
22872
22873 .vitem &%quota_%&<&'time'&>
22874 .cindex "quota" "error testing in retry rule"
22875 .cindex "retry" "quota error testing"
22876 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
22877 transport, and the mailbox has not been accessed for <&'time'&>. For example,
22878 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
22879 for four days.
22880 .endlist
22881
22882 .cindex "mailbox" "time of last read"
22883 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
22884 timeouts when the mailbox is full and is not being read by its owner. Ideally,
22885 it should be based on the last time that the user accessed the mailbox.
22886 However, it is not always possible to determine this. Exim uses the following
22887 heuristic rules:
22888
22889 .ilist
22890 If the mailbox is a single file, the time of last access (the &"atime"&) is
22891 used. As no new messages are being delivered (because the mailbox is over
22892 quota), Exim does not access the file, so this is the time of last user access.
22893 .next
22894 .cindex "maildir format" "time of last read"
22895 For a maildir delivery, the time of last modification of the &_new_&
22896 subdirectory is used. As the mailbox is over quota, no new files are created in
22897 the &_new_& subdirectory, because no new messages are being delivered. Any
22898 change to the &_new_& subdirectory is therefore assumed to be the result of an
22899 MUA moving a new message to the &_cur_& directory when it is first read. The
22900 time that is used is therefore the last time that the user read a new message.
22901 .next
22902 For other kinds of multi-file mailbox, the time of last access cannot be
22903 obtained, so a retry rule that uses this type of error field is never matched.
22904 .endlist
22905
22906 The quota errors apply both to system-enforced quotas and to Exim's own quota
22907 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
22908 when a local delivery is deferred because a partition is full (the ENOSPC
22909 error).
22910
22911
22912
22913 .section "Retry rules for specified senders" "SECID162"
22914 .cindex "retry" "rules; sender-specific"
22915 You can specify retry rules that apply only when the failing message has a
22916 specific sender. In particular, this can be used to define retry rules that
22917 apply only to bounce messages. The third item in a retry rule can be of this
22918 form:
22919 .display
22920 &`senders=`&<&'address list'&>
22921 .endd
22922 The retry timings themselves are then the fourth item. For example:
22923 .code
22924 *   rcpt_4xx   senders=:   F,1h,30m
22925 .endd
22926 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
22927 host. If the address list contains white space, it must be enclosed in quotes.
22928 For example:
22929 .code
22930 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
22931 .endd
22932 &*Warning*&: This facility can be unhelpful if it is used for host errors
22933 (which do not depend on the recipient). The reason is that the sender is used
22934 only to match the retry rule. Once the rule has been found for a host error,
22935 its contents are used to set a retry time for the host, and this will apply to
22936 all messages, not just those with specific senders.
22937
22938 When testing retry rules using &%-brt%&, you can supply a sender using the
22939 &%-f%& command line option, like this:
22940 .code
22941 exim -f "" -brt user@dom.ain
22942 .endd
22943 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
22944 list is never matched.
22945
22946
22947
22948
22949
22950 .section "Retry parameters" "SECID163"
22951 .cindex "retry" "parameters in rules"
22952 The third (or fourth, if a senders list is present) field in a retry rule is a
22953 sequence of retry parameter sets, separated by semicolons. Each set consists of
22954 .display
22955 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
22956 .endd
22957 The letter identifies the algorithm for computing a new retry time; the cutoff
22958 time is the time beyond which this algorithm no longer applies, and the
22959 arguments vary the algorithm's action. The cutoff time is measured from the
22960 time that the first failure for the domain (combined with the local part if
22961 relevant) was detected, not from the time the message was received.
22962
22963 .cindex "retry" "algorithms"
22964 .cindex "retry" "fixed intervals"
22965 .cindex "retry" "increasing intervals"
22966 .cindex "retry" "random intervals"
22967 The available algorithms are:
22968
22969 .ilist
22970 &'F'&: retry at fixed intervals. There is a single time parameter specifying
22971 the interval.
22972 .next
22973 &'G'&: retry at geometrically increasing intervals. The first argument
22974 specifies a starting value for the interval, and the second a multiplier, which
22975 is used to increase the size of the interval at each retry.
22976 .next
22977 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
22978 retry, the previous interval is multiplied by the factor in order to get a
22979 maximum for the next interval. The minimum interval is the first argument of
22980 the parameter, and an actual interval is chosen randomly between them. Such a
22981 rule has been found to be helpful in cluster configurations when all the
22982 members of the cluster restart at once, and may therefore synchronize their
22983 queue processing times.
22984 .endlist
22985
22986 When computing the next retry time, the algorithm definitions are scanned in
22987 order until one whose cutoff time has not yet passed is reached. This is then
22988 used to compute a new retry time that is later than the current time. In the
22989 case of fixed interval retries, this simply means adding the interval to the
22990 current time. For geometrically increasing intervals, retry intervals are
22991 computed from the rule's parameters until one that is greater than the previous
22992 interval is found. The main configuration variable
22993 .cindex "limit" "retry interval"
22994 .cindex "retry" "interval, maximum"
22995 .oindex "&%retry_interval_max%&"
22996 &%retry_interval_max%& limits the maximum interval between retries. It
22997 cannot be set greater than &`24h`&, which is its default value.
22998
22999 A single remote domain may have a number of hosts associated with it, and each
23000 host may have more than one IP address. Retry algorithms are selected on the
23001 basis of the domain name, but are applied to each IP address independently. If,
23002 for example, a host has two IP addresses and one is unusable, Exim will
23003 generate retry times for it and will not try to use it until its next retry
23004 time comes. Thus the good IP address is likely to be tried first most of the
23005 time.
23006
23007 .cindex "hints database" "use for retrying"
23008 Retry times are hints rather than promises. Exim does not make any attempt to
23009 run deliveries exactly at the computed times. Instead, a queue runner process
23010 starts delivery processes for delayed messages periodically, and these attempt
23011 new deliveries only for those addresses that have passed their next retry time.
23012 If a new message arrives for a deferred address, an immediate delivery attempt
23013 occurs only if the address has passed its retry time. In the absence of new
23014 messages, the minimum time between retries is the interval between queue runner
23015 processes. There is not much point in setting retry times of five minutes if
23016 your queue runners happen only once an hour, unless there are a significant
23017 number of incoming messages (which might be the case on a system that is
23018 sending everything to a smart host, for example).
23019
23020 The data in the retry hints database can be inspected by using the
23021 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
23022 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
23023 &'exinext'& utility script can be used to find out what the next retry times
23024 are for the hosts associated with a particular mail domain, and also for local
23025 deliveries that have been deferred.
23026
23027
23028 .section "Retry rule examples" "SECID164"
23029 Here are some example retry rules:
23030 .code
23031 alice@wonderland.fict.example quota_5d  F,7d,3h
23032 wonderland.fict.example       quota_5d
23033 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
23034 lookingglass.fict.example     *         F,24h,30m;
23035 *                 refused_A   F,2h,20m;
23036 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
23037 .endd
23038 The first rule sets up special handling for mail to
23039 &'alice@wonderland.fict.example'& when there is an over-quota error and the
23040 mailbox has not been read for at least 5 days. Retries continue every three
23041 hours for 7 days. The second rule handles over-quota errors for all other local
23042 parts at &'wonderland.fict.example'&; the absence of a local part has the same
23043 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
23044 fail are bounced immediately if the mailbox has not been read for at least 5
23045 days.
23046
23047 The third rule handles all other errors at &'wonderland.fict.example'&; retries
23048 happen every 15 minutes for an hour, then with geometrically increasing
23049 intervals until two days have passed since a delivery first failed. After the
23050 first hour there is a delay of one hour, then two hours, then four hours, and
23051 so on (this is a rather extreme example).
23052
23053 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
23054 They happen every 30 minutes for 24 hours only. The remaining two rules handle
23055 all other domains, with special action for connection refusal from hosts that
23056 were not obtained from an MX record.
23057
23058 The final rule in a retry configuration should always have asterisks in the
23059 first two fields so as to provide a general catch-all for any addresses that do
23060 not have their own special handling. This example tries every 15 minutes for 2
23061 hours, then with intervals starting at one hour and increasing by a factor of
23062 1.5 up to 16 hours, then every 8 hours up to 5 days.
23063
23064
23065
23066 .section "Timeout of retry data" "SECID165"
23067 .cindex "timeout" "of retry data"
23068 .oindex "&%retry_data_expire%&"
23069 .cindex "hints database" "data expiry"
23070 .cindex "retry" "timeout of data"
23071 Exim timestamps the data that it writes to its retry hints database. When it
23072 consults the data during a delivery it ignores any that is older than the value
23073 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
23074 been tried for 7 days, Exim will try to deliver to it immediately a message
23075 arrives, and if that fails, it will calculate a retry time as if it were
23076 failing for the first time.
23077
23078 This improves the behaviour for messages routed to rarely-used hosts such as MX
23079 backups. If such a host was down at one time, and happens to be down again when
23080 Exim tries a month later, using the old retry data would imply that it had been
23081 down all the time, which is not a justified assumption.
23082
23083 If a host really is permanently dead, this behaviour causes a burst of retries
23084 every now and again, but only if messages routed to it are rare. If there is a
23085 message at least once every 7 days the retry data never expires.
23086
23087
23088
23089
23090 .section "Long-term failures" "SECID166"
23091 .cindex "delivery failure, long-term"
23092 .cindex "retry" "after long-term failure"
23093 Special processing happens when an email address has been failing for so long
23094 that the cutoff time for the last algorithm is reached. For example, using the
23095 default retry rule:
23096 .code
23097 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
23098 .endd
23099 the cutoff time is four days. Reaching the retry cutoff is independent of how
23100 long any specific message has been failing; it is the length of continuous
23101 failure for the recipient address that counts.
23102
23103 When the cutoff time is reached for a local delivery, or for all the IP
23104 addresses associated with a remote delivery, a subsequent delivery failure
23105 causes Exim to give up on the address, and a bounce message is generated.
23106 In order to cater for new messages that use the failing address, a next retry
23107 time is still computed from the final algorithm, and is used as follows:
23108
23109 For local deliveries, one delivery attempt is always made for any subsequent
23110 messages. If this delivery fails, the address fails immediately. The
23111 post-cutoff retry time is not used.
23112
23113 If the delivery is remote, there are two possibilities, controlled by the
23114 .oindex "&%delay_after_cutoff%&"
23115 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
23116 default. Until the post-cutoff retry time for one of the IP addresses is
23117 reached, the failing email address is bounced immediately, without a delivery
23118 attempt taking place. After that time, one new delivery attempt is made to
23119 those IP addresses that are past their retry times, and if that still fails,
23120 the address is bounced and new retry times are computed.
23121
23122 In other words, when all the hosts for a given email address have been failing
23123 for a long time, Exim bounces rather then defers until one of the hosts' retry
23124 times is reached. Then it tries once, and bounces if that attempt fails. This
23125 behaviour ensures that few resources are wasted in repeatedly trying to deliver
23126 to a broken destination, but if the host does recover, Exim will eventually
23127 notice.
23128
23129 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23130 addresses are past their final cutoff time, Exim tries to deliver to those IP
23131 addresses that have not been tried since the message arrived. If there are
23132 no suitable IP addresses, or if they all fail, the address is bounced. In other
23133 words, it does not delay when a new message arrives, but tries the expired
23134 addresses immediately, unless they have been tried since the message arrived.
23135 If there is a continuous stream of messages for the failing domains, setting
23136 &%delay_after_cutoff%& false means that there will be many more attempts to
23137 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
23138 true.
23139
23140 .section "Deliveries that work intermittently" "SECID167"
23141 .cindex "retry" "intermittently working deliveries"
23142 Some additional logic is needed to cope with cases where a host is
23143 intermittently available, or when a message has some attribute that prevents
23144 its delivery when others to the same address get through. In this situation,
23145 because some messages are successfully delivered, the &"retry clock"& for the
23146 host or address keeps getting reset by the successful deliveries, and so
23147 failing messages remain on the queue for ever because the cutoff time is never
23148 reached.
23149
23150 Two exceptional actions are applied to prevent this happening. The first
23151 applies to errors that are related to a message rather than a remote host.
23152 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
23153 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
23154 commands, and quota failures. For this type of error, if a message's arrival
23155 time is earlier than the &"first failed"& time for the error, the earlier time
23156 is used when scanning the retry rules to decide when to try next and when to
23157 time out the address.
23158
23159 The exceptional second action applies in all cases. If a message has been on
23160 the queue for longer than the cutoff time of any applicable retry rule for a
23161 given address, a delivery is attempted for that address, even if it is not yet
23162 time, and if this delivery fails, the address is timed out. A new retry time is
23163 not computed in this case, so that other messages for the same address are
23164 considered immediately.
23165 .ecindex IIDretconf1
23166 .ecindex IIDregconf2
23167
23168
23169
23170
23171
23172
23173 . ////////////////////////////////////////////////////////////////////////////
23174 . ////////////////////////////////////////////////////////////////////////////
23175
23176 .chapter "SMTP authentication" "CHAPSMTPAUTH"
23177 .scindex IIDauthconf1 "SMTP" "authentication configuration"
23178 .scindex IIDauthconf2 "authentication"
23179 The &"authenticators"& section of Exim's run time configuration is concerned
23180 with SMTP authentication. This facility is an extension to the SMTP protocol,
23181 described in RFC 2554, which allows a client SMTP host to authenticate itself
23182 to a server. This is a common way for a server to recognize clients that are
23183 permitted to use it as a relay. SMTP authentication is not of relevance to the
23184 transfer of mail between servers that have no managerial connection with each
23185 other.
23186
23187 .cindex "AUTH" "description of"
23188 Very briefly, the way SMTP authentication works is as follows:
23189
23190 .ilist
23191 The server advertises a number of authentication &'mechanisms'& in response to
23192 the client's EHLO command.
23193 .next
23194 The client issues an AUTH command, naming a specific mechanism. The command
23195 may, optionally, contain some authentication data.
23196 .next
23197 The server may issue one or more &'challenges'&, to which the client must send
23198 appropriate responses. In simple authentication mechanisms, the challenges are
23199 just prompts for user names and passwords. The server does not have to issue
23200 any challenges &-- in some mechanisms the relevant data may all be transmitted
23201 with the AUTH command.
23202 .next
23203 The server either accepts or denies authentication.
23204 .next
23205 If authentication succeeds, the client may optionally make use of the AUTH
23206 option on the MAIL command to pass an authenticated sender in subsequent
23207 mail transactions. Authentication lasts for the remainder of the SMTP
23208 connection.
23209 .next
23210 If authentication fails, the client may give up, or it may try a different
23211 authentication mechanism, or it may try transferring mail over the
23212 unauthenticated connection.
23213 .endlist
23214
23215 If you are setting up a client, and want to know which authentication
23216 mechanisms the server supports, you can use Telnet to connect to port 25 (the
23217 SMTP port) on the server, and issue an EHLO command. The response to this
23218 includes the list of supported mechanisms. For example:
23219 .display
23220 &`$ `&&*&`telnet server.example 25`&*&
23221 &`Trying 192.168.34.25...`&
23222 &`Connected to server.example.`&
23223 &`Escape character is &#x0027;^]&#x0027;.`&
23224 &`220 server.example ESMTP Exim 4.20 ...`&
23225 &*&`ehlo client.example`&*&
23226 &`250-server.example Hello client.example [10.8.4.5]`&
23227 &`250-SIZE 52428800`&
23228 &`250-PIPELINING`&
23229 &`250-AUTH PLAIN`&
23230 &`250 HELP`&
23231 .endd
23232 The second-last line of this example output shows that the server supports
23233 authentication using the PLAIN mechanism. In Exim, the different authentication
23234 mechanisms are configured by specifying &'authenticator'& drivers. Like the
23235 routers and transports, which authenticators are included in the binary is
23236 controlled by build-time definitions. The following are currently available,
23237 included by setting
23238 .code
23239 AUTH_CRAM_MD5=yes
23240 AUTH_CYRUS_SASL=yes
23241 AUTH_PLAINTEXT=yes
23242 AUTH_SPA=yes
23243 .endd
23244 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
23245 authentication mechanism (RFC 2195), and the second provides an interface to
23246 the Cyrus SASL authentication library. The third can be configured to support
23247 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
23248 not formally documented, but used by several MUAs. The fourth authenticator
23249 supports Microsoft's &'Secure Password Authentication'& mechanism.
23250
23251 The authenticators are configured using the same syntax as other drivers (see
23252 section &<<SECTfordricon>>&). If no authenticators are required, no
23253 authentication section need be present in the configuration file. Each
23254 authenticator can in principle have both server and client functions. When Exim
23255 is receiving SMTP mail, it is acting as a server; when it is sending out
23256 messages over SMTP, it is acting as a client. Authenticator configuration
23257 options are provided for use in both these circumstances.
23258
23259 To make it clear which options apply to which situation, the prefixes
23260 &%server_%& and &%client_%& are used on option names that are specific to
23261 either the server or the client function, respectively. Server and client
23262 functions are disabled if none of their options are set. If an authenticator is
23263 to be used for both server and client functions, a single definition, using
23264 both sets of options, is required. For example:
23265 .code
23266 cram:
23267   driver = cram_md5
23268   public_name = CRAM-MD5
23269   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
23270   client_name = ph10
23271   client_secret = secret2
23272 .endd
23273 The &%server_%& option is used when Exim is acting as a server, and the
23274 &%client_%& options when it is acting as a client.
23275
23276 Descriptions of the individual authenticators are given in subsequent chapters.
23277 The remainder of this chapter covers the generic options for the
23278 authenticators, followed by general discussion of the way authentication works
23279 in Exim.
23280
23281
23282
23283 .section "Generic options for authenticators" "SECID168"
23284 .cindex "authentication" "generic options"
23285 .cindex "options" "generic; for authenticators"
23286
23287 .option client_condition authenticators string&!! unset
23288 When Exim is authenticating as a client, it skips any authenticator whose
23289 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
23290 used, for example, to skip plain text authenticators when the connection is not
23291 encrypted by a setting such as:
23292 .code
23293 client_condition = ${if !eq{$tls_cipher}{}}
23294 .endd
23295 (Older documentation incorrectly states that &$tls_cipher$& contains the cipher
23296 used for incoming messages. In fact, during SMTP delivery, it contains the
23297 cipher used for the delivery.)
23298
23299
23300 .option driver authenticators string unset
23301 This option must always be set. It specifies which of the available
23302 authenticators is to be used.
23303
23304
23305 .option public_name authenticators string unset
23306 This option specifies the name of the authentication mechanism that the driver
23307 implements, and by which it is known to the outside world. These names should
23308 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
23309 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
23310 defaults to the driver's instance name.
23311
23312
23313 .option server_advertise_condition authenticators string&!! unset
23314 When a server is about to advertise an authentication mechanism, the condition
23315 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
23316 mechanism is not advertised.
23317 If the expansion fails, the mechanism is not advertised. If the failure was not
23318 forced, and was not caused by a lookup defer, the incident is logged.
23319 See section &<<SECTauthexiser>>& below for further discussion.
23320
23321
23322 .option server_condition authenticators string&!! unset
23323 This option must be set for a &%plaintext%& server authenticator, where it
23324 is used directly to control authentication. See section &<<SECTplainserver>>&
23325 for details.
23326
23327 For the other authenticators, &%server_condition%& can be used as an additional
23328 authentication or authorization mechanism that is applied after the other
23329 authenticator conditions succeed. If it is set, it is expanded when the
23330 authenticator would otherwise return a success code. If the expansion is forced
23331 to fail, authentication fails. Any other expansion failure causes a temporary
23332 error code to be returned. If the result of a successful expansion is an empty
23333 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23334 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
23335 other result, a temporary error code is returned, with the expanded string as
23336 the error text.
23337
23338
23339 .option server_debug_print authenticators string&!! unset
23340 If this option is set and authentication debugging is enabled (see the &%-d%&
23341 command line option), the string is expanded and included in the debugging
23342 output when the authenticator is run as a server. This can help with checking
23343 out the values of variables.
23344 If expansion of the string fails, the error message is written to the debugging
23345 output, and Exim carries on processing.
23346
23347
23348 .option server_set_id authenticators string&!! unset
23349 .vindex "&$authenticated_id$&"
23350 When an Exim server successfully authenticates a client, this string is
23351 expanded using data from the authentication, and preserved for any incoming
23352 messages in the variable &$authenticated_id$&. It is also included in the log
23353 lines for incoming messages. For example, a user/password authenticator
23354 configuration might preserve the user name that was used to authenticate, and
23355 refer to it subsequently during delivery of the message.
23356 If expansion fails, the option is ignored.
23357
23358
23359 .option server_mail_auth_condition authenticators string&!! unset
23360 This option allows a server to discard authenticated sender addresses supplied
23361 as part of MAIL commands in SMTP connections that are authenticated by the
23362 driver on which &%server_mail_auth_condition%& is set. The option is not used
23363 as part of the authentication process; instead its (unexpanded) value is
23364 remembered for later use.
23365 How it is used is described in the following section.
23366
23367
23368
23369
23370
23371 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
23372 .cindex "authentication" "sender; authenticated"
23373 .cindex "AUTH" "on MAIL command"
23374 When a client supplied an AUTH= item on a MAIL command, Exim applies
23375 the following checks before accepting it as the authenticated sender of the
23376 message:
23377
23378 .ilist
23379 If the connection is not using extended SMTP (that is, HELO was used rather
23380 than EHLO), the use of AUTH= is a syntax error.
23381 .next
23382 If the value of the AUTH= parameter is &"<>"&, it is ignored.
23383 .next
23384 .vindex "&$authenticated_sender$&"
23385 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
23386 running, the value of &$authenticated_sender$& is set to the value obtained
23387 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
23388 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
23389 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
23390 given for the MAIL command.
23391 .next
23392 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
23393 is accepted and placed in &$authenticated_sender$& only if the client has
23394 authenticated.
23395 .next
23396 If the AUTH= value was accepted by either of the two previous rules, and
23397 the client has authenticated, and the authenticator has a setting for the
23398 &%server_mail_auth_condition%&, the condition is checked at this point. The
23399 valued that was saved from the authenticator is expanded. If the expansion
23400 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
23401 &$authenticated_sender$& is deleted. If the expansion yields any other value,
23402 the value of &$authenticated_sender$& is retained and passed on with the
23403 message.
23404 .endlist
23405
23406
23407 When &$authenticated_sender$& is set for a message, it is passed on to other
23408 hosts to which Exim authenticates as a client. Do not confuse this value with
23409 &$authenticated_id$&, which is a string obtained from the authentication
23410 process, and which is not usually a complete email address.
23411
23412 .vindex "&$sender_address$&"
23413 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
23414 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
23415 therefore make use of &$authenticated_sender$&. The converse is not true: the
23416 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
23417 ACL is run.
23418
23419
23420
23421 .section "Authentication on an Exim server" "SECTauthexiser"
23422 .cindex "authentication" "on an Exim server"
23423 When Exim receives an EHLO command, it advertises the public names of those
23424 authenticators that are configured as servers, subject to the following
23425 conditions:
23426
23427 .ilist
23428 The client host must match &%auth_advertise_hosts%& (default *).
23429 .next
23430 It the &%server_advertise_condition%& option is set, its expansion must not
23431 yield the empty string, &"0"&, &"no"&, or &"false"&.
23432 .endlist
23433
23434 The order in which the authenticators are defined controls the order in which
23435 the mechanisms are advertised.
23436
23437 Some mail clients (for example, some versions of Netscape) require the user to
23438 provide a name and password for authentication whenever AUTH is advertised,
23439 even though authentication may not in fact be needed (for example, Exim may be
23440 set up to allow unconditional relaying from the client by an IP address check).
23441 You can make such clients more friendly by not advertising AUTH to them.
23442 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
23443 that runs for RCPT) to relay without authentication, you should set
23444 .code
23445 auth_advertise_hosts = ! 10.9.8.0/24
23446 .endd
23447 so that no authentication mechanisms are advertised to them.
23448
23449 The &%server_advertise_condition%& controls the advertisement of individual
23450 authentication mechanisms. For example, it can be used to restrict the
23451 advertisement of a particular mechanism to encrypted connections, by a setting
23452 such as:
23453 .code
23454 server_advertise_condition = ${if eq{$tls_cipher}{}{no}{yes}}
23455 .endd
23456 .vindex "&$tls_cipher$&"
23457 If the session is encrypted, &$tls_cipher$& is not empty, and so the expansion
23458 yields &"yes"&, which allows the advertisement to happen.
23459
23460 When an Exim server receives an AUTH command from a client, it rejects it
23461 immediately if AUTH was not advertised in response to an earlier EHLO
23462 command. This is the case if
23463
23464 .ilist
23465 The client host does not match &%auth_advertise_hosts%&; or
23466 .next
23467 No authenticators are configured with server options; or
23468 .next
23469 Expansion of &%server_advertise_condition%& blocked the advertising of all the
23470 server authenticators.
23471 .endlist
23472
23473
23474 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
23475 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
23476 AUTH is accepted from any client host.
23477
23478 If AUTH is not rejected by the ACL, Exim searches its configuration for a
23479 server authentication mechanism that was advertised in response to EHLO and
23480 that matches the one named in the AUTH command. If it finds one, it runs
23481 the appropriate authentication protocol, and authentication either succeeds or
23482 fails. If there is no matching advertised mechanism, the AUTH command is
23483 rejected with a 504 error.
23484
23485 .vindex "&$received_protocol$&"
23486 .vindex "&$sender_host_authenticated$&"
23487 When a message is received from an authenticated host, the value of
23488 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
23489 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
23490 public name) of the authenticator driver that successfully authenticated the
23491 client from which the message was received. This variable is empty if there was
23492 no successful authentication.
23493
23494
23495
23496
23497 .section "Testing server authentication" "SECID169"
23498 .cindex "authentication" "testing a server"
23499 .cindex "AUTH" "testing a server"
23500 .cindex "base64 encoding" "creating authentication test data"
23501 Exim's &%-bh%& option can be useful for testing server authentication
23502 configurations. The data for the AUTH command has to be sent using base64
23503 encoding. A quick way to produce such data for testing is the following Perl
23504 script:
23505 .code
23506 use MIME::Base64;
23507 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
23508 .endd
23509 .cindex "binary zero" "in authentication data"
23510 This interprets its argument as a Perl string, and then encodes it. The
23511 interpretation as a Perl string allows binary zeros, which are required for
23512 some kinds of authentication, to be included in the data. For example, a
23513 command line to run this script on such data might be
23514 .code
23515 encode '\0user\0password'
23516 .endd
23517 Note the use of single quotes to prevent the shell interpreting the
23518 backslashes, so that they can be interpreted by Perl to specify characters
23519 whose code value is zero.
23520
23521 &*Warning 1*&: If either of the user or password strings starts with an octal
23522 digit, you must use three zeros instead of one after the leading backslash. If
23523 you do not, the octal digit that starts your string will be incorrectly
23524 interpreted as part of the code for the first character.
23525
23526 &*Warning 2*&: If there are characters in the strings that Perl interprets
23527 specially, you must use a Perl escape to prevent them being misinterpreted. For
23528 example, a command such as
23529 .code
23530 encode '\0user@domain.com\0pas$$word'
23531 .endd
23532 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
23533
23534 If you have the &%mimencode%& command installed, another way to do produce
23535 base64-encoded strings is to run the command
23536 .code
23537 echo -e -n `\0user\0password' | mimencode
23538 .endd
23539 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
23540 in the argument, and the &%-n%& option specifies no newline at the end of its
23541 output. However, not all versions of &%echo%& recognize these options, so you
23542 should check your version before relying on this suggestion.
23543
23544
23545
23546 .section "Authentication by an Exim client" "SECID170"
23547 .cindex "authentication" "on an Exim client"
23548 The &(smtp)& transport has two options called &%hosts_require_auth%& and
23549 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
23550 announces support for authentication, and the host matches an entry in either
23551 of these options, Exim (as a client) tries to authenticate as follows:
23552
23553 .ilist
23554 For each authenticator that is configured as a client, in the order in which
23555 they are defined in the configuration, it searches the authentication
23556 mechanisms announced by the server for one whose name matches the public name
23557 of the authenticator.
23558 .next
23559 .vindex "&$host$&"
23560 .vindex "&$host_address$&"
23561 When it finds one that matches, it runs the authenticator's client code. The
23562 variables &$host$& and &$host_address$& are available for any string expansions
23563 that the client might do. They are set to the server's name and IP address. If
23564 any expansion is forced to fail, the authentication attempt is abandoned, and
23565 Exim moves on to the next authenticator. Otherwise an expansion failure causes
23566 delivery to be deferred.
23567 .next
23568 If the result of the authentication attempt is a temporary error or a timeout,
23569 Exim abandons trying to send the message to the host for the moment. It will
23570 try again later. If there are any backup hosts available, they are tried in the
23571 usual way.
23572 .next
23573 If the response to authentication is a permanent error (5&'xx'& code), Exim
23574 carries on searching the list of authenticators and tries another one if
23575 possible. If all authentication attempts give permanent errors, or if there are
23576 no attempts because no mechanisms match (or option expansions force failure),
23577 what happens depends on whether the host matches &%hosts_require_auth%& or
23578 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
23579 delivery is deferred. The error can be detected in the retry rules, and thereby
23580 turned into a permanent error if you wish. In the second case, Exim tries to
23581 deliver the message unauthenticated.
23582 .endlist
23583
23584 .cindex "AUTH" "on MAIL command"
23585 When Exim has authenticated itself to a remote server, it adds the AUTH
23586 parameter to the MAIL commands it sends, if it has an authenticated sender for
23587 the message. If the message came from a remote host, the authenticated sender
23588 is the one that was receiving on an incoming MAIL command, provided that the
23589 incoming connection was authenticated and the &%server_mail_auth%& condition
23590 allowed the authenticated sender to be retained. If a local process calls Exim
23591 to send a message, the sender address that is built from the login name and
23592 &%qualify_domain%& is treated as authenticated. However, if the
23593 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
23594 the authenticated sender that was received with the message.
23595 .ecindex IIDauthconf1
23596 .ecindex IIDauthconf2
23597
23598
23599
23600
23601
23602
23603 . ////////////////////////////////////////////////////////////////////////////
23604 . ////////////////////////////////////////////////////////////////////////////
23605
23606 .chapter "The plaintext authenticator" "CHAPplaintext"
23607 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
23608 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
23609 The &(plaintext)& authenticator can be configured to support the PLAIN and
23610 LOGIN authentication mechanisms, both of which transfer authentication data as
23611 plain (unencrypted) text (though base64 encoded). The use of plain text is a
23612 security risk; you are strongly advised to insist on the use of SMTP encryption
23613 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
23614 use unencrypted plain text, you should not use the same passwords for SMTP
23615 connections as you do for login accounts.
23616
23617 .section "Plaintext options" "SECID171"
23618 .cindex "options" "&(plaintext)& authenticator (server)"
23619 When configured as a server, &(plaintext)& uses the following options:
23620
23621 .option server_condition authenticators string&!! unset
23622 This is actually a global authentication option, but it must be set in order to
23623 configure the &(plaintext)& driver as a server. Its use is described below.
23624
23625 .option server_prompts plaintext string&!! unset
23626 The contents of this option, after expansion, must be a colon-separated list of
23627 prompt strings. If expansion fails, a temporary authentication rejection is
23628 given.
23629
23630 .section "Using plaintext in a server" "SECTplainserver"
23631 .cindex "AUTH" "in &(plaintext)& authenticator"
23632 .cindex "binary zero" "in &(plaintext)& authenticator"
23633 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
23634         "in &(plaintext)& authenticator"
23635 .vindex "&$auth1$&, &$auth2$&, etc"
23636 .cindex "base64 encoding" "in &(plaintext)& authenticator"
23637
23638 When running as a server, &(plaintext)& performs the authentication test by
23639 expanding a string. The data sent by the client with the AUTH command, or in
23640 response to subsequent prompts, is base64 encoded, and so may contain any byte
23641 values when decoded. If any data is supplied with the command, it is treated as
23642 a list of strings, separated by NULs (binary zeros), the first three of which
23643 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
23644 (neither LOGIN nor PLAIN uses more than three strings).
23645
23646 For compatibility with previous releases of Exim, the values are also placed in
23647 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
23648 variables for this purpose is now deprecated, as it can lead to confusion in
23649 string expansions that also use them for other things.
23650
23651 If there are more strings in &%server_prompts%& than the number of strings
23652 supplied with the AUTH command, the remaining prompts are used to obtain more
23653 data. Each response from the client may be a list of NUL-separated strings.
23654
23655 .vindex "&$authenticated_id$&"
23656 Once a sufficient number of data strings have been received,
23657 &%server_condition%& is expanded. If the expansion is forced to fail,
23658 authentication fails. Any other expansion failure causes a temporary error code
23659 to be returned. If the result of a successful expansion is an empty string,
23660 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23661 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
23662 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
23663 For any other result, a temporary error code is returned, with the expanded
23664 string as the error text.
23665
23666 &*Warning*&: If you use a lookup in the expansion to find the user's
23667 password, be sure to make the authentication fail if the user is unknown.
23668 There are good and bad examples at the end of the next section.
23669
23670
23671
23672 .section "The PLAIN authentication mechanism" "SECID172"
23673 .cindex "PLAIN authentication mechanism"
23674 .cindex "authentication" "PLAIN mechanism"
23675 .cindex "binary zero" "in &(plaintext)& authenticator"
23676 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
23677 sent as one item of data (that is, one combined string containing two NUL
23678 separators). The data is sent either as part of the AUTH command, or
23679 subsequently in response to an empty prompt from the server.
23680
23681 The second and third strings are a user name and a corresponding password.
23682 Using a single fixed user name and password as an example, this could be
23683 configured as follows:
23684 .code
23685 fixed_plain:
23686   driver = plaintext
23687   public_name = PLAIN
23688   server_prompts = :
23689   server_condition = \
23690     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
23691   server_set_id = $auth2
23692 .endd
23693 Note that the default result strings from &%if%& (&"true"& or an empty string)
23694 are exactly what we want here, so they need not be specified. Obviously, if the
23695 password contains expansion-significant characters such as dollar, backslash,
23696 or closing brace, they have to be escaped.
23697
23698 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
23699 the end of a string list are ignored). If all the data comes as part of the
23700 AUTH command, as is commonly the case, the prompt is not used. This
23701 authenticator is advertised in the response to EHLO as
23702 .code
23703 250-AUTH PLAIN
23704 .endd
23705 and a client host can authenticate itself by sending the command
23706 .code
23707 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
23708 .endd
23709 As this contains three strings (more than the number of prompts), no further
23710 data is required from the client. Alternatively, the client may just send
23711 .code
23712 AUTH PLAIN
23713 .endd
23714 to initiate authentication, in which case the server replies with an empty
23715 prompt. The client must respond with the combined data string.
23716
23717 The data string is base64 encoded, as required by the RFC. This example,
23718 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
23719 represents a zero byte. This is split up into three strings, the first of which
23720 is empty. The &%server_condition%& option in the authenticator checks that the
23721 second two are &`username`& and &`mysecret`& respectively.
23722
23723 Having just one fixed user name and password, as in this example, is not very
23724 realistic, though for a small organization with only a handful of
23725 authenticating clients it could make sense.
23726
23727 A more sophisticated instance of this authenticator could use the user name in
23728 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
23729 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
23730 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
23731 This is an incorrect example:
23732 .code
23733 server_condition = \
23734   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
23735 .endd
23736 The expansion uses the user name (&$auth2$&) as the key to look up a password,
23737 which it then compares to the supplied password (&$auth3$&). Why is this example
23738 incorrect? It works fine for existing users, but consider what happens if a
23739 non-existent user name is given. The lookup fails, but as no success/failure
23740 strings are given for the lookup, it yields an empty string. Thus, to defeat
23741 the authentication, all a client has to do is to supply a non-existent user
23742 name and an empty password. The correct way of writing this test is:
23743 .code
23744 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
23745   {${if eq{$value}{$auth3}}} {false}}
23746 .endd
23747 In this case, if the lookup succeeds, the result is checked; if the lookup
23748 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
23749 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
23750 always fails if its second argument is empty. However, the second way of
23751 writing the test makes the logic clearer.
23752
23753
23754 .section "The LOGIN authentication mechanism" "SECID173"
23755 .cindex "LOGIN authentication mechanism"
23756 .cindex "authentication" "LOGIN mechanism"
23757 The LOGIN authentication mechanism is not documented in any RFC, but is in use
23758 in a number of programs. No data is sent with the AUTH command. Instead, a
23759 user name and password are supplied separately, in response to prompts. The
23760 plaintext authenticator can be configured to support this as in this example:
23761 .code
23762 fixed_login:
23763   driver = plaintext
23764   public_name = LOGIN
23765   server_prompts = User Name : Password
23766   server_condition = \
23767     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
23768   server_set_id = $auth1
23769 .endd
23770 Because of the way plaintext operates, this authenticator accepts data supplied
23771 with the AUTH command (in contravention of the specification of LOGIN), but
23772 if the client does not supply it (as is the case for LOGIN clients), the prompt
23773 strings are used to obtain two data items.
23774
23775 Some clients are very particular about the precise text of the prompts. For
23776 example, Outlook Express is reported to recognize only &"Username:"& and
23777 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
23778 strings. It uses the &%ldapauth%& expansion condition to check the user
23779 name and password by binding to an LDAP server:
23780 .code
23781 login:
23782   driver = plaintext
23783   public_name = LOGIN
23784   server_prompts = Username:: : Password::
23785   server_condition = ${if and{{ \
23786     !eq{}{$auth1} }{ \
23787     ldapauth{user="cn=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
23788              pass=${quote:$auth2} \
23789              ldap://ldap.example.org/} }} }
23790   server_set_id = uid=$auth1,ou=people,o=example.org
23791 .endd
23792 We have to check that the username is not empty before using it, because LDAP
23793 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
23794 operator to correctly quote the DN for authentication. However, the basic
23795 &%quote%& operator, rather than any of the LDAP quoting operators, is the
23796 correct one to use for the password, because quoting is needed only to make
23797 the password conform to the Exim syntax. At the LDAP level, the password is an
23798 uninterpreted string.
23799
23800
23801 .section "Support for different kinds of authentication" "SECID174"
23802 A number of string expansion features are provided for the purpose of
23803 interfacing to different ways of user authentication. These include checking
23804 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
23805 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
23806 &<<SECTexpcond>>&.
23807
23808
23809
23810
23811 .section "Using plaintext in a client" "SECID175"
23812 .cindex "options" "&(plaintext)& authenticator (client)"
23813 The &(plaintext)& authenticator has two client options:
23814
23815 .option client_ignore_invalid_base64 plaintext boolean false
23816 If the client receives a server prompt that is not a valid base64 string,
23817 authentication is abandoned by default. However, if this option is set true,
23818 the error in the challenge is ignored and the client sends the response as
23819 usual.
23820
23821 .option client_send plaintext string&!! unset
23822 The string is a colon-separated list of authentication data strings. Each
23823 string is independently expanded before being sent to the server. The first
23824 string is sent with the AUTH command; any more strings are sent in response
23825 to prompts from the server. Before each string is expanded, the value of the
23826 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
23827 with &$auth1$& for the first prompt. Up to three prompts are stored in this
23828 way. Thus, the prompt that is received in response to sending the first string
23829 (with the AUTH command) can be used in the expansion of the second string, and
23830 so on. If an invalid base64 string is received when
23831 &%client_ignore_invalid_base64%& is set, an empty string is put in the
23832 &$auth$&<&'n'&> variable.
23833
23834 &*Note*&: You cannot use expansion to create multiple strings, because
23835 splitting takes priority and happens first.
23836
23837 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
23838 the data, further processing is applied to each string before it is sent. If
23839 there are any single circumflex characters in the string, they are converted to
23840 NULs. Should an actual circumflex be required as data, it must be doubled in
23841 the string.
23842
23843 This is an example of a client configuration that implements the PLAIN
23844 authentication mechanism with a fixed user name and password:
23845 .code
23846 fixed_plain:
23847   driver = plaintext
23848   public_name = PLAIN
23849   client_send = ^username^mysecret
23850 .endd
23851 The lack of colons means that the entire text is sent with the AUTH
23852 command, with the circumflex characters converted to NULs. A similar example
23853 that uses the LOGIN mechanism is:
23854 .code
23855 fixed_login:
23856   driver = plaintext
23857   public_name = LOGIN
23858   client_send = : username : mysecret
23859 .endd
23860 The initial colon means that the first string is empty, so no data is sent with
23861 the AUTH command itself. The remaining strings are sent in response to
23862 prompts.
23863 .ecindex IIDplaiauth1
23864 .ecindex IIDplaiauth2
23865
23866
23867
23868
23869 . ////////////////////////////////////////////////////////////////////////////
23870 . ////////////////////////////////////////////////////////////////////////////
23871
23872 .chapter "The cram_md5 authenticator" "CHID9"
23873 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
23874 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
23875 .cindex "CRAM-MD5 authentication mechanism"
23876 .cindex "authentication" "CRAM-MD5 mechanism"
23877 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
23878 sends a challenge string to the client, and the response consists of a user
23879 name and the CRAM-MD5 digest of the challenge string combined with a secret
23880 string (password) which is known to both server and client. Thus, the secret
23881 is not sent over the network as plain text, which makes this authenticator more
23882 secure than &(plaintext)&. However, the downside is that the secret has to be
23883 available in plain text at either end.
23884
23885
23886 .section "Using cram_md5 as a server" "SECID176"
23887 .cindex "options" "&(cram_md5)& authenticator (server)"
23888 This authenticator has one server option, which must be set to configure the
23889 authenticator as a server:
23890
23891 .option server_secret cram_md5 string&!! unset
23892 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
23893 When the server receives the client's response, the user name is placed in
23894 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
23895 obtain the password for that user. The server then computes the CRAM-MD5 digest
23896 that the client should have sent, and checks that it received the correct
23897 string. If the expansion of &%server_secret%& is forced to fail, authentication
23898 fails. If the expansion fails for some other reason, a temporary error code is
23899 returned to the client.
23900
23901 For compatibility with previous releases of Exim, the user name is also placed
23902 in &$1$&. However, the use of this variables for this purpose is now
23903 deprecated, as it can lead to confusion in string expansions that also use
23904 numeric variables for other things.
23905
23906 For example, the following authenticator checks that the user name given by the
23907 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
23908 user name, authentication fails.
23909 .code
23910 fixed_cram:
23911   driver = cram_md5
23912   public_name = CRAM-MD5
23913   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
23914   server_set_id = $auth1
23915 .endd
23916 .vindex "&$authenticated_id$&"
23917 If authentication succeeds, the setting of &%server_set_id%& preserves the user
23918 name in &$authenticated_id$&. A more typical configuration might look up the
23919 secret string in a file, using the user name as the key. For example:
23920 .code
23921 lookup_cram:
23922   driver = cram_md5
23923   public_name = CRAM-MD5
23924   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
23925                   {$value}fail}
23926   server_set_id = $auth1
23927 .endd
23928 Note that this expansion explicitly forces failure if the lookup fails
23929 because &$auth1$& contains an unknown user name.
23930
23931
23932 .section "Using cram_md5 as a client" "SECID177"
23933 .cindex "options" "&(cram_md5)& authenticator (client)"
23934 When used as a client, the &(cram_md5)& authenticator has two options:
23935
23936
23937
23938 .option client_name cram_md5 string&!! "the primary host name"
23939 This string is expanded, and the result used as the user name data when
23940 computing the response to the server's challenge.
23941
23942
23943 .option client_secret cram_md5 string&!! unset
23944 This option must be set for the authenticator to work as a client. Its value is
23945 expanded and the result used as the secret string when computing the response.
23946
23947
23948 .vindex "&$host$&"
23949 .vindex "&$host_address$&"
23950 Different user names and secrets can be used for different servers by referring
23951 to &$host$& or &$host_address$& in the options. Forced failure of either
23952 expansion string is treated as an indication that this authenticator is not
23953 prepared to handle this case. Exim moves on to the next configured client
23954 authenticator. Any other expansion failure causes Exim to give up trying to
23955 send the message to the current server.
23956
23957 A simple example configuration of a &(cram_md5)& authenticator, using fixed
23958 strings, is:
23959 .code
23960 fixed_cram:
23961   driver = cram_md5
23962   public_name = CRAM-MD5
23963   client_name = ph10
23964   client_secret = secret
23965 .endd
23966 .ecindex IIDcramauth1
23967 .ecindex IIDcramauth2
23968
23969
23970
23971 . ////////////////////////////////////////////////////////////////////////////
23972 . ////////////////////////////////////////////////////////////////////////////
23973
23974 .chapter "The cyrus_sasl authenticator" "CHID10"
23975 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
23976 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
23977 .cindex "Cyrus" "SASL library"
23978 .cindex "Kerberos"
23979 The code for this authenticator was provided by Matthew Byng-Maddick of A L
23980 Digital Ltd (&url(http://www.aldigital.co.uk)).
23981
23982 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
23983 library implementation of the RFC 2222 (&"Simple Authentication and Security
23984 Layer"&). This library supports a number of authentication mechanisms,
23985 including PLAIN and LOGIN, but also several others that Exim does not support
23986 directly. In particular, there is support for Kerberos authentication.
23987
23988 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
23989 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
23990 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
23991 name of the driver to determine which mechanism to support.
23992
23993 Where access to some kind of secret file is required, for example in GSSAPI
23994 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
23995 user, and that the Cyrus SASL library has no way of escalating privileges
23996 by default. You may also find you need to set environment variables,
23997 depending on the driver you are using.
23998
23999 The application name provided by Exim is &"exim"&, so various SASL options may
24000 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
24001 Kerberos, note that because of limitations in the GSSAPI interface,
24002 changing the server keytab might need to be communicated down to the Kerberos
24003 layer independently. The mechanism for doing so is dependent upon the Kerberos
24004 implementation. For example, for Heimdal, the environment variable KRB5_KTNAME
24005 may be set to point to an alternative keytab file. Exim will pass this
24006 variable through from its own inherited environment when started as root or the
24007 Exim user. The keytab file needs to be readable by the Exim user.
24008
24009
24010 .section "Using cyrus_sasl as a server" "SECID178"
24011 The &(cyrus_sasl)& authenticator has four private options. It puts the username
24012 (on a successful authentication) into &$auth1$&. For compatibility with
24013 previous releases of Exim, the username is also placed in &$1$&. However, the
24014 use of this variable for this purpose is now deprecated, as it can lead to
24015 confusion in string expansions that also use numeric variables for other
24016 things.
24017
24018
24019 .option server_hostname cyrus_sasl string&!! "see below"
24020 This option selects the hostname that is used when communicating with the
24021 library. The default value is &`$primary_hostname`&. It is up to the underlying
24022 SASL plug-in what it does with this data.
24023
24024
24025 .option server_mech cyrus_sasl string "see below"
24026 This option selects the authentication mechanism this driver should use. The
24027 default is the value of the generic &%public_name%& option. This option allows
24028 you to use a different underlying mechanism from the advertised name. For
24029 example:
24030 .code
24031 sasl:
24032   driver = cyrus_sasl
24033   public_name = X-ANYTHING
24034   server_mech = CRAM-MD5
24035   server_set_id = $auth1
24036 .endd
24037
24038 .option server_realm cyrus_sasl string unset
24039 This specifies the SASL realm that the server claims to be in.
24040
24041
24042 .option server_service cyrus_sasl string &`smtp`&
24043 This is the SASL service that the server claims to implement.
24044
24045
24046 For straightforward cases, you do not need to set any of the authenticator's
24047 private options. All you need to do is to specify an appropriate mechanism as
24048 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
24049 PLAIN, you could have two authenticators as follows:
24050 .code
24051 sasl_cram_md5:
24052   driver = cyrus_sasl
24053   public_name = CRAM-MD5
24054   server_set_id = $auth1
24055
24056 sasl_plain:
24057   driver = cyrus_sasl
24058   public_name = PLAIN
24059   server_set_id = $auth2
24060 .endd
24061 Cyrus SASL does implement the LOGIN authentication method, even though it is
24062 not a standard method. It is disabled by default in the source distribution,
24063 but it is present in many binary distributions.
24064 .ecindex IIDcyrauth1
24065 .ecindex IIDcyrauth2
24066
24067
24068
24069
24070 . ////////////////////////////////////////////////////////////////////////////
24071 . ////////////////////////////////////////////////////////////////////////////
24072 .chapter "The dovecot authenticator" "CHAPdovecot"
24073 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
24074 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
24075 This authenticator is an interface to the authentication facility of the
24076 Dovecot POP/IMAP server, which can support a number of authentication methods.
24077 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
24078 to use the same mechanisms for SMTP authentication. This is a server
24079 authenticator only. There is only one option:
24080
24081 .option server_socket dovecot string unset
24082
24083 This option must specify the socket that is the interface to Dovecot
24084 authentication. The &%public_name%& option must specify an authentication
24085 mechanism that Dovecot is configured to support. You can have several
24086 authenticators for different mechanisms. For example:
24087 .code
24088 dovecot_plain:
24089   driver = dovecot
24090   public_name = PLAIN
24091   server_socket = /var/run/dovecot/auth-client
24092   server_set_id = $auth2
24093
24094 dovecot_ntlm:
24095   driver = dovecot
24096   public_name = NTLM
24097   server_socket = /var/run/dovecot/auth-client
24098   server_set_id = $auth1
24099 .endd
24100 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
24101 &$received_ip_address$& (that is, the connection is local), the &"secured"&
24102 option is passed in the Dovecot authentication command. If, for a TLS
24103 connection, a client certificate has been verified, the &"valid-client-cert"&
24104 option is passed. When authentication succeeds, the identity of the user
24105 who authenticated is placed in &$auth1$&.
24106 .ecindex IIDdcotauth1
24107 .ecindex IIDdcotauth2
24108
24109
24110 . ////////////////////////////////////////////////////////////////////////////
24111 . ////////////////////////////////////////////////////////////////////////////
24112
24113 .chapter "The spa authenticator" "CHAPspa"
24114 .scindex IIDspaauth1 "&(spa)& authenticator"
24115 .scindex IIDspaauth2 "authenticators" "&(spa)&"
24116 .cindex "authentication" "Microsoft Secure Password"
24117 .cindex "authentication" "NTLM"
24118 .cindex "Microsoft Secure Password Authentication"
24119 .cindex "NTLM authentication"
24120 The &(spa)& authenticator provides client support for Microsoft's &'Secure
24121 Password Authentication'& mechanism,
24122 which is also sometimes known as NTLM (NT LanMan). The code for client side of
24123 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
24124 taken from the Samba project (&url(http://www.samba.org)). The code for the
24125 server side was subsequently contributed by Tom Kistner. The mechanism works as
24126 follows:
24127
24128 .ilist
24129 After the AUTH command has been accepted, the client sends an SPA
24130 authentication request based on the user name and optional domain.
24131 .next
24132 The server sends back a challenge.
24133 .next
24134 The client builds a challenge response which makes use of the user's password
24135 and sends it to the server, which then accepts or rejects it.
24136 .endlist
24137
24138 Encryption is used to protect the password in transit.
24139
24140
24141
24142 .section "Using spa as a server" "SECID179"
24143 .cindex "options" "&(spa)& authenticator (server)"
24144 The &(spa)& authenticator has just one server option:
24145
24146 .option server_password spa string&!! unset
24147 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
24148 This option is expanded, and the result must be the cleartext password for the
24149 authenticating user, whose name is at this point in &$auth1$&. For
24150 compatibility with previous releases of Exim, the user name is also placed in
24151 &$1$&. However, the use of this variable for this purpose is now deprecated, as
24152 it can lead to confusion in string expansions that also use numeric variables
24153 for other things. For example:
24154 .code
24155 spa:
24156   driver = spa
24157   public_name = NTLM
24158   server_password = \
24159     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
24160 .endd
24161 If the expansion is forced to fail, authentication fails. Any other expansion
24162 failure causes a temporary error code to be returned.
24163
24164
24165
24166
24167
24168 .section "Using spa as a client" "SECID180"
24169 .cindex "options" "&(spa)& authenticator (client)"
24170 The &(spa)& authenticator has the following client options:
24171
24172
24173
24174 .option client_domain spa string&!! unset
24175 This option specifies an optional domain for the authentication.
24176
24177
24178 .option client_password spa string&!! unset
24179 This option specifies the user's password, and must be set.
24180
24181
24182 .option client_username spa string&!! unset
24183 This option specifies the user name, and must be set. Here is an example of a
24184 configuration of this authenticator for use with the mail servers at
24185 &'msn.com'&:
24186 .code
24187 msn:
24188   driver = spa
24189   public_name = MSN
24190   client_username = msn/msn_username
24191   client_password = msn_plaintext_password
24192   client_domain = DOMAIN_OR_UNSET
24193 .endd
24194 .ecindex IIDspaauth1
24195 .ecindex IIDspaauth2
24196
24197
24198
24199
24200
24201 . ////////////////////////////////////////////////////////////////////////////
24202 . ////////////////////////////////////////////////////////////////////////////
24203
24204 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
24205          "Encrypted SMTP connections"
24206 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
24207 .scindex IIDencsmtp2 "SMTP" "encryption"
24208 .cindex "TLS" "on SMTP connection"
24209 .cindex "OpenSSL"
24210 .cindex "GnuTLS"
24211 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
24212 Sockets Layer), is implemented by making use of the OpenSSL library or the
24213 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
24214 cryptographic code in the Exim distribution itself for implementing TLS. In
24215 order to use this feature you must install OpenSSL or GnuTLS, and then build a
24216 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
24217 You also need to understand the basic concepts of encryption at a managerial
24218 level, and in particular, the way that public keys, private keys, and
24219 certificates are used.
24220
24221 RFC 3207 defines how SMTP connections can make use of encryption. Once a
24222 connection is established, the client issues a STARTTLS command. If the
24223 server accepts this, the client and the server negotiate an encryption
24224 mechanism. If the negotiation succeeds, the data that subsequently passes
24225 between them is encrypted.
24226
24227 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
24228 and if so, what cipher suite is in use, whether the client supplied a
24229 certificate, and whether or not that certificate was verified. This makes it
24230 possible for an Exim server to deny or accept certain commands based on the
24231 encryption state.
24232
24233 &*Warning*&: Certain types of firewall and certain anti-virus products can
24234 disrupt TLS connections. You need to turn off SMTP scanning for these products
24235 in order to get TLS to work.
24236
24237
24238
24239 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
24240          "SECID284"
24241 .cindex "ssmtp protocol"
24242 .cindex "smtps protocol"
24243 .cindex "SMTP" "ssmtp protocol"
24244 .cindex "SMTP" "smtps protocol"
24245 Early implementations of encrypted SMTP used a different TCP port from normal
24246 SMTP, and expected an encryption negotiation to start immediately, instead of
24247 waiting for a STARTTLS command from the client using the standard SMTP
24248 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
24249 allocated for this purpose.
24250
24251 This approach was abandoned when encrypted SMTP was standardized, but there are
24252 still some legacy clients that use it. Exim supports these clients by means of
24253 the &%tls_on_connect_ports%& global option. Its value must be a list of port
24254 numbers; the most common use is expected to be:
24255 .code
24256 tls_on_connect_ports = 465
24257 .endd
24258 The port numbers specified by this option apply to all SMTP connections, both
24259 via the daemon and via &'inetd'&. You still need to specify all the ports that
24260 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
24261 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
24262 an extra port &-- rather, it specifies different behaviour on a port that is
24263 defined elsewhere.
24264
24265 There is also a &%-tls-on-connect%& command line option. This overrides
24266 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
24267
24268
24269
24270
24271
24272
24273 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
24274 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
24275 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
24276 followed later, when the first versions of GnuTLS were released. To build Exim
24277 to use GnuTLS, you need to set
24278 .code
24279 USE_GNUTLS=yes
24280 .endd
24281 in Local/Makefile, in addition to
24282 .code
24283 SUPPORT_TLS=yes
24284 .endd
24285 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
24286 include files and libraries for GnuTLS can be found.
24287
24288 There are some differences in usage when using GnuTLS instead of OpenSSL:
24289
24290 .ilist
24291 The &%tls_verify_certificates%& option must contain the name of a file, not the
24292 name of a directory (for OpenSSL it can be either).
24293 .next
24294 The &%tls_dhparam%& option is ignored, because early versions of GnuTLS had no
24295 facility for varying its Diffie-Hellman parameters. I understand that this has
24296 changed, but Exim has not been updated to provide this facility.
24297 .next
24298 .vindex "&$tls_peerdn$&"
24299 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
24300 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
24301 affects the value of the &$tls_peerdn$& variable.
24302 .next
24303 OpenSSL identifies cipher suites using hyphens as separators, for example:
24304 DES-CBC3-SHA. GnuTLS uses underscores, for example: RSA_ARCFOUR_SHA. What is
24305 more, OpenSSL complains if underscores are present in a cipher list. To make
24306 life simpler, Exim changes underscores to hyphens for OpenSSL and hyphens to
24307 underscores for GnuTLS when processing lists of cipher suites in the
24308 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
24309 option).
24310 .next
24311 The &%tls_require_ciphers%& options operate differently, as described in the
24312 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
24313 .endlist
24314
24315
24316 .section "GnuTLS parameter computation" "SECID181"
24317 GnuTLS uses D-H parameters that may take a substantial amount of time
24318 to compute. It is unreasonable to re-compute them for every TLS session.
24319 Therefore, Exim keeps this data in a file in its spool directory, called
24320 &_gnutls-params_&. The file is owned by the Exim user and is readable only by
24321 its owner. Every Exim process that start up GnuTLS reads the D-H
24322 parameters from this file. If the file does not exist, the first Exim process
24323 that needs it computes the data and writes it to a temporary file which is
24324 renamed once it is complete. It does not matter if several Exim processes do
24325 this simultaneously (apart from wasting a few resources). Once a file is in
24326 place, new Exim processes immediately start using it.
24327
24328 For maximum security, the parameters that are stored in this file should be
24329 recalculated periodically, the frequency depending on your paranoia level.
24330 Arranging this is easy in principle; just delete the file when you want new
24331 values to be computed. However, there may be a problem. The calculation of new
24332 parameters needs random numbers, and these are obtained from &_/dev/random_&.
24333 If the system is not very active, &_/dev/random_& may delay returning data
24334 until enough randomness (entropy) is available. This may cause Exim to hang for
24335 a substantial amount of time, causing timeouts on incoming connections.
24336
24337 The solution is to generate the parameters externally to Exim. They are stored
24338 in &_gnutls-params_& in PEM format, which means that they can be generated
24339 externally using the &(certtool)& command that is part of GnuTLS.
24340
24341 To replace the parameters with new ones, instead of deleting the file
24342 and letting Exim re-create it, you can generate new parameters using
24343 &(certtool)& and, when this has been done, replace Exim's cache file by
24344 renaming. The relevant commands are something like this:
24345 .code
24346 # rm -f new-params
24347 # touch new-params
24348 # chown exim:exim new-params
24349 # chmod 0400 new-params
24350 # certtool --generate-privkey --bits 512 >new-params
24351 # echo "" >>new-params
24352 # certtool --generate-dh-params --bits 1024 >> new-params
24353 # mv new-params gnutls-params
24354 .endd
24355 If Exim never has to generate the parameters itself, the possibility of
24356 stalling is removed.
24357
24358
24359 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
24360 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
24361 .oindex "&%tls_require_ciphers%&" "OpenSSL"
24362 There is a function in the OpenSSL library that can be passed a list of cipher
24363 suites before the cipher negotiation takes place. This specifies which ciphers
24364 are acceptable. The list is colon separated and may contain names like
24365 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
24366 directly to this function call. The following quotation from the OpenSSL
24367 documentation specifies what forms of item are allowed in the cipher string:
24368
24369 .ilist
24370 It can consist of a single cipher suite such as RC4-SHA.
24371 .next
24372 It can represent a list of cipher suites containing a certain algorithm,
24373 or cipher suites of a certain type. For example SHA1 represents all
24374 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
24375 SSL v3 algorithms.
24376 .next
24377 Lists of cipher suites can be combined in a single cipher string using
24378 the + character. This is used as a logical and operation. For example
24379 SHA1+DES represents all cipher suites containing the SHA1 and the DES
24380 algorithms.
24381 .endlist
24382
24383 Each cipher string can be optionally preceded by one of the characters &`!`&,
24384 &`-`& or &`+`&.
24385 .ilist
24386 If &`!`& is used, the ciphers are permanently deleted from the list. The
24387 ciphers deleted can never reappear in the list even if they are explicitly
24388 stated.
24389 .next
24390 If &`-`& is used, the ciphers are deleted from the list, but some or all
24391 of the ciphers can be added again by later options.
24392 .next
24393 If &`+`& is used, the ciphers are moved to the end of the list. This
24394 option does not add any new ciphers; it just moves matching existing ones.
24395 .endlist
24396
24397 If none of these characters is present, the string is interpreted as
24398 a list of ciphers to be appended to the current preference list. If the list
24399 includes any ciphers already present they will be ignored: that is, they will
24400 not be moved to the end of the list.
24401 .endlist
24402
24403
24404
24405 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
24406          "SECTreqciphgnu"
24407 .cindex "GnuTLS" "specifying parameters for"
24408 .cindex "TLS" "specifying ciphers (GnuTLS)"
24409 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
24410 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
24411 .cindex "TLS" "specifying protocols (GnuTLS)"
24412 .oindex "&%tls_require_ciphers%&" "GnuTLS"
24413 The GnuTLS library allows the caller to specify separate lists of permitted key
24414 exchange methods, main cipher algorithms, MAC algorithms, and protocols.
24415 Unfortunately, these lists are numerical, and the library does not have a
24416 function for turning names into numbers. Consequently, lists of recognized
24417 names have to be built into the application. The permitted key exchange
24418 methods, ciphers, and MAC algorithms may be used in any combination to form a
24419 cipher suite. This is unlike OpenSSL, where complete cipher suite names are
24420 passed to its control function.
24421
24422 For compatibility with OpenSSL, the &%tls_require_ciphers%& option can be set
24423 to complete cipher suite names such as RSA_ARCFOUR_SHA, but for GnuTLS this
24424 option controls only the cipher algorithms. Exim searches each item in the
24425 list for the name of an available algorithm. For example, if the list
24426 contains RSA_AES_SHA, then AES is recognized, and the behaviour is exactly
24427 the same as if just AES were given.
24428
24429 .oindex "&%gnutls_require_kx%&"
24430 .oindex "&%gnutls_require_mac%&"
24431 .oindex "&%gnutls_require_protocols%&"
24432 There are additional options called &%gnutls_require_kx%&,
24433 &%gnutls_require_mac%&, and &%gnutls_require_protocols%& that can be used to
24434 restrict the key exchange methods, MAC algorithms, and protocols, respectively.
24435 These options are ignored if OpenSSL is in use.
24436
24437 All four options are available as global options, controlling how Exim
24438 behaves as a server, and also as options of the &(smtp)& transport, controlling
24439 how Exim behaves as a client. All the values are string expanded. After
24440 expansion, the values must be colon-separated lists, though the separator
24441 can be changed in the usual way.
24442
24443 Each of the four lists starts out with a default set of algorithms. If the
24444 first item in a list does &'not'& start with an exclamation mark, all the
24445 default items are deleted. In this case, only those that are explicitly
24446 specified can be used. If the first item in a list &'does'& start with an
24447 exclamation mark, the defaults are left on the list.
24448
24449 Then, any item that starts with an exclamation mark causes the relevant
24450 entry to be removed from the list, and any item that does not start with an
24451 exclamation mark causes a new entry to be added to the list. Unrecognized
24452 items in the list are ignored. Thus:
24453 .code
24454 tls_require_ciphers = !ARCFOUR
24455 .endd
24456 allows all the defaults except ARCFOUR, whereas
24457 .code
24458 tls_require_ciphers = AES : 3DES
24459 .endd
24460 allows only cipher suites that use AES or 3DES.
24461
24462 For &%tls_require_ciphers%& the recognized names are AES_256, AES_128, AES
24463 (both of the preceding), 3DES, ARCFOUR_128, ARCFOUR_40, and ARCFOUR (both of
24464 the preceding). The default list does not contain all of these; it just has
24465 AES_256, AES_128, 3DES, and ARCFOUR_128.
24466
24467 For &%gnutls_require_kx%&, the recognized names are DHE_RSA, RSA (which
24468 includes DHE_RSA), DHE_DSS, and DHE (which includes both DHE_RSA and
24469 DHE_DSS). The default list contains RSA, DHE_DSS, DHE_RSA.
24470
24471 For &%gnutls_require_mac%&, the recognized names are SHA (synonym SHA1), and
24472 MD5. The default list contains SHA, MD5.
24473
24474 For &%gnutls_require_protocols%&, the recognized names are TLS1 and SSL3.
24475 The default list contains TLS1, SSL3.
24476
24477 In a server, the order of items in these lists is unimportant. The server
24478 advertises the availability of all the relevant cipher suites. However, in a
24479 client, the order in the &%tls_require_ciphers%& list specifies a preference
24480 order for the cipher algorithms. The first one in the client's list that is
24481 also advertised by the server is tried first. The default order is as listed
24482 above.
24483
24484
24485
24486 .section "Configuring an Exim server to use TLS" "SECID182"
24487 .cindex "TLS" "configuring an Exim server"
24488 When Exim has been built with TLS support, it advertises the availability of
24489 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
24490 but not to any others. The default value of this option is unset, which means
24491 that STARTTLS is not advertised at all. This default is chosen because you
24492 need to set some other options in order to make TLS available, and also it is
24493 sensible for systems that want to use TLS only as a client.
24494
24495 If a client issues a STARTTLS command and there is some configuration
24496 problem in the server, the command is rejected with a 454 error. If the client
24497 persists in trying to issue SMTP commands, all except QUIT are rejected
24498 with the error
24499 .code
24500 554 Security failure
24501 .endd
24502 If a STARTTLS command is issued within an existing TLS session, it is
24503 rejected with a 554 error code.
24504
24505 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
24506 match some hosts. You can, of course, set it to * to match all hosts.
24507 However, this is not all you need to do. TLS sessions to a server won't work
24508 without some further configuration at the server end.
24509
24510 It is rumoured that all existing clients that support TLS/SSL use RSA
24511 encryption. To make this work you need to set, in the server,
24512 .code
24513 tls_certificate = /some/file/name
24514 tls_privatekey = /some/file/name
24515 .endd
24516 These options are, in fact, expanded strings, so you can make them depend on
24517 the identity of the client that is connected if you wish. The first file
24518 contains the server's X509 certificate, and the second contains the private key
24519 that goes with it. These files need to be readable by the Exim user, and must
24520 always be given as full path names. They can be the same file if both the
24521 certificate and the key are contained within it. If &%tls_privatekey%& is not
24522 set, or if its expansion is forced to fail or results in an empty string, this
24523 is assumed to be the case. The certificate file may also contain intermediate
24524 certificates that need to be sent to the client to enable it to authenticate
24525 the server's certificate.
24526
24527 If you do not understand about certificates and keys, please try to find a
24528 source of this background information, which is not Exim-specific. (There are a
24529 few comments below in section &<<SECTcerandall>>&.)
24530
24531 &*Note*&: These options do not apply when Exim is operating as a client &--
24532 they apply only in the case of a server. If you need to use a certificate in an
24533 Exim client, you must set the options of the same names in an &(smtp)&
24534 transport.
24535
24536 With just these options, an Exim server will be able to use TLS. It does not
24537 require the client to have a certificate (but see below for how to insist on
24538 this). There is one other option that may be needed in other situations. If
24539 .code
24540 tls_dhparam = /some/file/name
24541 .endd
24542 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
24543 with the parameters contained in the file. This increases the set of cipher
24544 suites that the server supports. See the command
24545 .code
24546 openssl dhparam
24547 .endd
24548 for a way of generating this data. At present, &%tls_dhparam%& is used only
24549 when Exim is linked with OpenSSL. It is ignored if GnuTLS is being used.
24550
24551 The strings supplied for these three options are expanded every time a client
24552 host connects. It is therefore possible to use different certificates and keys
24553 for different hosts, if you so wish, by making use of the client's IP address
24554 in &$sender_host_address$& to control the expansion. If a string expansion is
24555 forced to fail, Exim behaves as if the option is not set.
24556
24557 .cindex "cipher" "logging"
24558 .cindex "log" "TLS cipher"
24559 .vindex "&$tls_cipher$&"
24560 The variable &$tls_cipher$& is set to the cipher suite that was negotiated for
24561 an incoming TLS connection. It is included in the &'Received:'& header of an
24562 incoming message (by default &-- you can, of course, change this), and it is
24563 also included in the log line that records a message's arrival, keyed by
24564 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
24565 condition can be used to test for specific cipher suites in ACLs.
24566 (For outgoing SMTP deliveries, &$tls_cipher$& is reset &-- see section
24567 &<<SECID185>>&.)
24568
24569 Once TLS has been established, the ACLs that run for subsequent SMTP commands
24570 can check the name of the cipher suite and vary their actions accordingly. The
24571 cipher suite names vary, depending on which TLS library is being used. For
24572 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
24573 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
24574 documentation for more details.
24575
24576
24577 .section "Requesting and verifying client certificates" "SECID183"
24578 .cindex "certificate" "verification of client"
24579 .cindex "TLS" "client certificate verification"
24580 If you want an Exim server to request a certificate when negotiating a TLS
24581 session with a client, you must set either &%tls_verify_hosts%& or
24582 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
24583 apply to all TLS connections. For any host that matches one of these options,
24584 Exim requests a certificate as part of the setup of the TLS session. The
24585 contents of the certificate are verified by comparing it with a list of
24586 expected certificates. These must be available in a file or,
24587 for OpenSSL only (not GnuTLS), a directory, identified by
24588 &%tls_verify_certificates%&.
24589
24590 A file can contain multiple certificates, concatenated end to end. If a
24591 directory is used
24592 (OpenSSL only),
24593 each certificate must be in a separate file, with a name (or a symbolic link)
24594 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
24595 certificate. You can compute the relevant hash by running the command
24596 .code
24597 openssl x509 -hash -noout -in /cert/file
24598 .endd
24599 where &_/cert/file_& contains a single certificate.
24600
24601 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
24602 what happens if the client does not supply a certificate, or if the certificate
24603 does not match any of the certificates in the collection named by
24604 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
24605 attempt to set up a TLS session is aborted, and the incoming connection is
24606 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
24607 session continues. ACLs that run for subsequent SMTP commands can detect the
24608 fact that no certificate was verified, and vary their actions accordingly. For
24609 example, you can insist on a certificate before accepting a message for
24610 relaying, but not when the message is destined for local delivery.
24611
24612 .vindex "&$tls_peerdn$&"
24613 When a client supplies a certificate (whether it verifies or not), the value of
24614 the Distinguished Name of the certificate is made available in the variable
24615 &$tls_peerdn$& during subsequent processing of the message.
24616
24617 .cindex "log" "distinguished name"
24618 Because it is often a long text string, it is not included in the log line or
24619 &'Received:'& header by default. You can arrange for it to be logged, keyed by
24620 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
24621 &%received_header_text%& to change the &'Received:'& header. When no
24622 certificate is supplied, &$tls_peerdn$& is empty.
24623
24624
24625 .section "Revoked certificates" "SECID184"
24626 .cindex "TLS" "revoked certificates"
24627 .cindex "revocation list"
24628 .cindex "certificate" "revocation list"
24629 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
24630 certificates are revoked. If you have such a list, you can pass it to an Exim
24631 server using the global option called &%tls_crl%& and to an Exim client using
24632 an identically named option for the &(smtp)& transport. In each case, the value
24633 of the option is expanded and must then be the name of a file that contains a
24634 CRL in PEM format.
24635
24636
24637 .section "Configuring an Exim client to use TLS" "SECID185"
24638 .cindex "cipher" "logging"
24639 .cindex "log" "TLS cipher"
24640 .cindex "log" "distinguished name"
24641 .cindex "TLS" "configuring an Exim client"
24642 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
24643 deliveries as well as to incoming, the latter one causing logging of the
24644 server certificate's DN. The remaining client configuration for TLS is all
24645 within the &(smtp)& transport.
24646
24647 It is not necessary to set any options to have TLS work in the &(smtp)&
24648 transport. If Exim is built with TLS support, and TLS is advertised by a
24649 server, the &(smtp)& transport always tries to start a TLS session. However,
24650 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
24651 transport) to a list of server hosts for which TLS should not be used.
24652
24653 If you do not want Exim to attempt to send messages unencrypted when an attempt
24654 to set up an encrypted connection fails in any way, you can set
24655 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
24656 those hosts, delivery is always deferred if an encrypted connection cannot be
24657 set up. If there are any other hosts for the address, they are tried in the
24658 usual way.
24659
24660 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
24661 the message unencrypted. It always does this if the response to STARTTLS is
24662 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
24663 session after a success response code, what happens is controlled by the
24664 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
24665 delivery to this host is deferred, and other hosts (if available) are tried. If
24666 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
24667 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
24668 negotiation fails, Exim closes the current connection (because it is in an
24669 unknown state), opens a new one to the same host, and then tries the delivery
24670 unencrypted.
24671
24672 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
24673 transport provide the client with a certificate, which is passed to the server
24674 if it requests it. If the server is Exim, it will request a certificate only if
24675 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
24676
24677 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
24678 must name a file or,
24679 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
24680 expected server certificates. The client verifies the server's certificate
24681 against this collection, taking into account any revoked certificates that are
24682 in the list defined by &%tls_crl%&.
24683
24684 If
24685 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
24686 list of permitted cipher suites. If either of these checks fails, delivery to
24687 the current host is abandoned, and the &(smtp)& transport tries to deliver to
24688 alternative hosts, if any.
24689
24690  &*Note*&:
24691 These options must be set in the &(smtp)& transport for Exim to use TLS when it
24692 is operating as a client. Exim does not assume that a server certificate (set
24693 by the global options of the same name) should also be used when operating as a
24694 client.
24695
24696 .vindex "&$host$&"
24697 .vindex "&$host_address$&"
24698 All the TLS options in the &(smtp)& transport are expanded before use, with
24699 &$host$& and &$host_address$& containing the name and address of the server to
24700 which the client is connected. Forced failure of an expansion causes Exim to
24701 behave as if the relevant option were unset.
24702
24703 .vindex &$tls_cipher$&
24704 .vindex &$tls_peerdn$&
24705 Before an SMTP connection is established, the &$tls_cipher$& and &$tls_peerdn$&
24706 variables are emptied. (Until the first connection, they contain the values
24707 that were set when the message was received.) If STARTTLS is subsequently
24708 successfully obeyed, these variables are set to the relevant values for the
24709 outgoing connection.
24710
24711
24712
24713 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
24714          "SECTmulmessam"
24715 .cindex "multiple SMTP deliveries with TLS"
24716 .cindex "TLS" "multiple message deliveries"
24717 Exim sends multiple messages down the same TCP/IP connection by starting up
24718 an entirely new delivery process for each message, passing the socket from
24719 one process to the next. This implementation does not fit well with the use
24720 of TLS, because there is quite a lot of state information associated with a TLS
24721 connection, not just a socket identification. Passing all the state information
24722 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
24723 session before passing the socket to a new process. The new process may then
24724 try to start a new TLS session, and if successful, may try to re-authenticate
24725 if AUTH is in use, before sending the next message.
24726
24727 The RFC is not clear as to whether or not an SMTP session continues in clear
24728 after TLS has been shut down, or whether TLS may be restarted again later, as
24729 just described. However, if the server is Exim, this shutdown and
24730 reinitialization works. It is not known which (if any) other servers operate
24731 successfully if the client closes a TLS session and continues with unencrypted
24732 SMTP, but there are certainly some that do not work. For such servers, Exim
24733 should not pass the socket to another process, because the failure of the
24734 subsequent attempt to use it would cause Exim to record a temporary host error,
24735 and delay other deliveries to that host.
24736
24737 To test for this case, Exim sends an EHLO command to the server after
24738 closing down the TLS session. If this fails in any way, the connection is
24739 closed instead of being passed to a new delivery process, but no retry
24740 information is recorded.
24741
24742 There is also a manual override; you can set &%hosts_nopass_tls%& on the
24743 &(smtp)& transport to match those hosts for which Exim should not pass
24744 connections to new processes if TLS has been used.
24745
24746
24747
24748
24749 .section "Certificates and all that" "SECTcerandall"
24750 .cindex "certificate" "references to discussion"
24751 In order to understand fully how TLS works, you need to know about
24752 certificates, certificate signing, and certificate authorities. This is not the
24753 place to give a tutorial, especially as I do not know very much about it
24754 myself. Some helpful introduction can be found in the FAQ for the SSL addition
24755 to Apache, currently at
24756 .display
24757 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
24758 .endd
24759 Other parts of the &'modssl'& documentation are also helpful, and have
24760 links to further files.
24761 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
24762 0-201-61598-3), contains both introductory and more in-depth descriptions.
24763 Some sample programs taken from the book are available from
24764 .display
24765 &url(http://www.rtfm.com/openssl-examples/)
24766 .endd
24767
24768
24769 .section "Certificate chains" "SECID186"
24770 The file named by &%tls_certificate%& may contain more than one
24771 certificate. This is useful in the case where the certificate that is being
24772 sent is validated by an intermediate certificate which the other end does
24773 not have. Multiple certificates must be in the correct order in the file.
24774 First the host's certificate itself, then the first intermediate
24775 certificate to validate the issuer of the host certificate, then the next
24776 intermediate certificate to validate the issuer of the first intermediate
24777 certificate, and so on, until finally (optionally) the root certificate.
24778 The root certificate must already be trusted by the recipient for
24779 validation to succeed, of course, but if it's not preinstalled, sending the
24780 root certificate along with the rest makes it available for the user to
24781 install if the receiving end is a client MUA that can interact with a user.
24782
24783
24784 .section "Self-signed certificates" "SECID187"
24785 .cindex "certificate" "self-signed"
24786 You can create a self-signed certificate using the &'req'& command provided
24787 with OpenSSL, like this:
24788 .code
24789 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
24790             -days 9999 -nodes
24791 .endd
24792 &_file1_& and &_file2_& can be the same file; the key and the certificate are
24793 delimited and so can be identified independently. The &%-days%& option
24794 specifies a period for which the certificate is valid. The &%-nodes%& option is
24795 important: if you do not set it, the key is encrypted with a passphrase
24796 that you are prompted for, and any use that is made of the key causes more
24797 prompting for the passphrase. This is not helpful if you are going to use
24798 this certificate and key in an MTA, where prompting is not possible.
24799
24800 A self-signed certificate made in this way is sufficient for testing, and
24801 may be adequate for all your requirements if you are mainly interested in
24802 encrypting transfers, and not in secure identification.
24803
24804 However, many clients require that the certificate presented by the server be a
24805 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
24806 certificate. In this situation, the self-signed certificate described above
24807 must be installed on the client host as a trusted root &'certification
24808 authority'& (CA), and the certificate used by Exim must be a user certificate
24809 signed with that self-signed certificate.
24810
24811 For information on creating self-signed CA certificates and using them to sign
24812 user certificates, see the &'General implementation overview'& chapter of the
24813 Open-source PKI book, available online at
24814 &url(http://ospkibook.sourceforge.net/).
24815 .ecindex IIDencsmtp1
24816 .ecindex IIDencsmtp2
24817
24818
24819
24820 . ////////////////////////////////////////////////////////////////////////////
24821 . ////////////////////////////////////////////////////////////////////////////
24822
24823 .chapter "Access control lists" "CHAPACL"
24824 .scindex IIDacl "&ACL;" "description"
24825 .cindex "control of incoming mail"
24826 .cindex "message" "controlling incoming"
24827 .cindex "policy control" "access control lists"
24828 Access Control Lists (ACLs) are defined in a separate section of the run time
24829 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
24830 name, terminated by a colon. Here is a complete ACL section that contains just
24831 one very small ACL:
24832 .code
24833 begin acl
24834 small_acl:
24835   accept   hosts = one.host.only
24836 .endd
24837 You can have as many lists as you like in the ACL section, and the order in
24838 which they appear does not matter. The lists are self-terminating.
24839
24840 The majority of ACLs are used to control Exim's behaviour when it receives
24841 certain SMTP commands. This applies both to incoming TCP/IP connections, and
24842 when a local process submits a message using SMTP by specifying the &%-bs%&
24843 option. The most common use is for controlling which recipients are accepted
24844 in incoming messages. In addition, you can define an ACL that is used to check
24845 local non-SMTP messages. The default configuration file contains an example of
24846 a realistic ACL for checking RCPT commands. This is discussed in chapter
24847 &<<CHAPdefconfil>>&.
24848
24849
24850 .section "Testing ACLs" "SECID188"
24851 The &%-bh%& command line option provides a way of testing your ACL
24852 configuration locally by running a fake SMTP session with which you interact.
24853 The host &'relay-test.mail-abuse.org'& provides a service for checking your
24854 relaying configuration (see section &<<SECTcheralcon>>& for more details).
24855
24856
24857
24858 .section "Specifying when ACLs are used" "SECID189"
24859 .cindex "&ACL;" "options for specifying"
24860 In order to cause an ACL to be used, you have to name it in one of the relevant
24861 options in the main part of the configuration. These options are:
24862 .cindex "AUTH" "ACL for"
24863 .cindex "DATA" "ACLs for"
24864 .cindex "ETRN" "ACL for"
24865 .cindex "EXPN" "ACL for"
24866 .cindex "HELO" "ACL for"
24867 .cindex "EHLO" "ACL for"
24868 .cindex "MAIL" "ACL for"
24869 .cindex "QUIT, ACL for"
24870 .cindex "RCPT" "ACL for"
24871 .cindex "STARTTLS, ACL for"
24872 .cindex "VRFY" "ACL for"
24873 .cindex "SMTP" "connection, ACL for"
24874 .cindex "non-SMTP messages" "ACLs for"
24875 .cindex "MIME content scanning" "ACL for"
24876
24877 .table2 140pt
24878 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
24879 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
24880 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
24881 .irow &%acl_smtp_auth%&        "ACL for AUTH"
24882 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
24883 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
24884 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
24885 .irow &%acl_smtp_expn%&        "ACL for EXPN"
24886 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
24887 .irow &%acl_smtp_mail%&        "ACL for MAIL"
24888 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
24889 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
24890 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
24891 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
24892 .irow &%acl_smtp_quit%&        "ACL for QUIT"
24893 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
24894 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
24895 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
24896 .endtable
24897
24898 For example, if you set
24899 .code
24900 acl_smtp_rcpt = small_acl
24901 .endd
24902 the little ACL defined above is used whenever Exim receives a RCPT command
24903 in an SMTP dialogue. The majority of policy tests on incoming messages can be
24904 done when RCPT commands arrive. A rejection of RCPT should cause the
24905 sending MTA to give up on the recipient address contained in the RCPT
24906 command, whereas rejection at other times may cause the client MTA to keep on
24907 trying to deliver the message. It is therefore recommended that you do as much
24908 testing as possible at RCPT time.
24909
24910
24911 .section "The non-SMTP ACLs" "SECID190"
24912 .cindex "non-SMTP messages" "ACLs for"
24913 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
24914 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
24915 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
24916 the state of the SMTP connection such as encryption and authentication) are not
24917 relevant and are forbidden in these ACLs. However, the sender and recipients
24918 are known, so the &%senders%& and &%sender_domains%& conditions and the
24919 &$sender_address$& and &$recipients$& variables can be used. Variables such as
24920 &$authenticated_sender$& are also available. You can specify added header lines
24921 in any of these ACLs.
24922
24923 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
24924 non-SMTP message, before any of the message has been read. (This is the
24925 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
24926 batched SMTP input, it runs after the DATA command has been reached. The
24927 result of this ACL is ignored; it cannot be used to reject a message. If you
24928 really need to, you could set a value in an ACL variable here and reject based
24929 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
24930 controls, and in particular, it can be used to set
24931 .code
24932 control = suppress_local_fixups
24933 .endd
24934 This cannot be used in the other non-SMTP ACLs because by the time they are
24935 run, it is too late.
24936
24937 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
24938 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
24939
24940 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
24941 kind of rejection is treated as permanent, because there is no way of sending a
24942 temporary error for these kinds of message.
24943
24944
24945 .section "The SMTP connect ACL" "SECID191"
24946 .cindex "SMTP" "connection, ACL for"
24947 .oindex &%smtp_banner%&
24948 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
24949 session, after the test specified by &%host_reject_connection%& (which is now
24950 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
24951 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
24952 the message override the banner message that is otherwise specified by the
24953 &%smtp_banner%& option.
24954
24955
24956 .section "The EHLO/HELO ACL" "SECID192"
24957 .cindex "EHLO" "ACL for"
24958 .cindex "HELO" "ACL for"
24959 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
24960 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
24961 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
24962 Note that a client may issue more than one EHLO or HELO command in an SMTP
24963 session, and indeed is required to issue a new EHLO or HELO after successfully
24964 setting up encryption following a STARTTLS command.
24965
24966 If the command is accepted by an &%accept%& verb that has a &%message%&
24967 modifier, the message may not contain more than one line (it will be truncated
24968 at the first newline and a panic logged if it does). Such a message cannot
24969 affect the EHLO options that are listed on the second and subsequent lines of
24970 an EHLO response.
24971
24972
24973 .section "The DATA ACLs" "SECID193"
24974 .cindex "DATA" "ACLs for"
24975 Two ACLs are associated with the DATA command, because it is two-stage
24976 command, with two responses being sent to the client.
24977 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
24978 is obeyed. This gives you control after all the RCPT commands, but before
24979 the message itself is received. It offers the opportunity to give a negative
24980 response to the DATA command before the data is transmitted. Header lines
24981 added by MAIL or RCPT ACLs are not visible at this time, but any that
24982 are defined here are visible when the &%acl_smtp_data%& ACL is run.
24983
24984 You cannot test the contents of the message, for example, to verify addresses
24985 in the headers, at RCPT time or when the DATA command is received. Such
24986 tests have to appear in the ACL that is run after the message itself has been
24987 received, before the final response to the DATA command is sent. This is
24988 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
24989 associated with the DATA command.
24990
24991 For both of these ACLs, it is not possible to reject individual recipients. An
24992 error response rejects the entire message. Unfortunately, it is known that some
24993 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
24994 before or after the data) correctly &-- they keep the message on their queues
24995 and try again later, but that is their problem, though it does waste some of
24996 your resources.
24997
24998
24999 .new
25000 .section "The SMTP DKIM ACL" "SECTDKIMACL"
25001 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
25002 enabled (which is the default).
25003
25004 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
25005 received, and is executed for each DKIM signature found in a message.  If not
25006 otherwise specified, the default action is to accept.
25007
25008 For details on the operation of DKIM, see chapter &<<CHID12>>&.
25009 .wen
25010
25011
25012 .section "The SMTP MIME ACL" "SECID194"
25013 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
25014 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
25015
25016
25017 .section "The QUIT ACL" "SECTQUITACL"
25018 .cindex "QUIT, ACL for"
25019 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
25020 does not affect the response code to QUIT, which is always 221. Thus, the ACL
25021 does not in fact control any access. For this reason, the only verbs that are
25022 permitted are &%accept%& and &%warn%&.
25023
25024 This ACL can be used for tasks such as custom logging at the end of an SMTP
25025 session. For example, you can use ACL variables in other ACLs to count
25026 messages, recipients, etc., and log the totals at QUIT time using one or
25027 more &%logwrite%& modifiers on a &%warn%& verb.
25028
25029 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
25030 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
25031
25032 You do not need to have a final &%accept%&, but if you do, you can use a
25033 &%message%& modifier to specify custom text that is sent as part of the 221
25034 response to QUIT.
25035
25036 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
25037 failure (for example, failure to open a log file, or when Exim is bombing out
25038 because it has detected an unrecoverable error), all SMTP commands from the
25039 client are given temporary error responses until QUIT is received or the
25040 connection is closed. In these special cases, the QUIT ACL does not run.
25041
25042
25043 .section "The not-QUIT ACL" "SECTNOTQUITACL"
25044 .vindex &$acl_smtp_notquit$&
25045 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
25046 an SMTP session ends without sending QUIT. However, when Exim itself is is bad
25047 trouble, such as being unable to write to its log files, this ACL is not run,
25048 because it might try to do things (such as write to log files) that make the
25049 situation even worse.
25050
25051 Like the QUIT ACL, this ACL is provided to make it possible to do customized
25052 logging or to gather statistics, and its outcome is ignored. The &%delay%&
25053 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
25054 and &%warn%&.
25055
25056 .vindex &$smtp_notquit_reason$&
25057 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
25058 to a string that indicates the reason for the termination of the SMTP
25059 connection. The possible values are:
25060 .table2
25061 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
25062 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
25063 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
25064 .irow &`connection-lost`&          "The SMTP connection has been lost"
25065 .irow &`data-timeout`&             "Timeout while reading message data"
25066 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
25067 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
25068 .irow &`signal-exit`&              "SIGTERM or SIGINT"
25069 .irow &`synchronization-error`&    "SMTP synchronization error"
25070 .irow &`tls-failed`&               "TLS failed to start"
25071 .endtable
25072 In most cases when an SMTP connection is closed without having received QUIT,
25073 Exim sends an SMTP response message before actually closing the connection.
25074 With the exception of the &`acl-drop`& case, the default message can be
25075 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
25076 &%drop%& verb in another ACL, it is the message from the other ACL that is
25077 used.
25078
25079
25080 .section "Finding an ACL to use" "SECID195"
25081 .cindex "&ACL;" "finding which to use"
25082 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
25083 you can use different ACLs in different circumstances. For example,
25084 .code
25085 acl_smtp_rcpt = ${if ={25}{$interface_port} \
25086                      {acl_check_rcpt} {acl_check_rcpt_submit} }
25087 .endd
25088 In the default configuration file there are some example settings for
25089 providing an RFC 4409 message submission service on port 587 and a
25090 non-standard &"smtps"& service on port 465. You can use a string
25091 expansion like this to choose an ACL for MUAs on these ports which is
25092 more appropriate for this purpose than the default ACL on port 25.
25093
25094 The expanded string does not have to be the name of an ACL in the
25095 configuration file; there are other possibilities. Having expanded the
25096 string, Exim searches for an ACL as follows:
25097
25098 .ilist
25099 If the string begins with a slash, Exim uses it as a file name, and reads its
25100 contents as an ACL. The lines are processed in the same way as lines in the
25101 Exim configuration file. In particular, continuation lines are supported, blank
25102 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
25103 If the file does not exist or cannot be read, an error occurs (typically
25104 causing a temporary failure of whatever caused the ACL to be run). For example:
25105 .code
25106 acl_smtp_data = /etc/acls/\
25107   ${lookup{$sender_host_address}lsearch\
25108   {/etc/acllist}{$value}{default}}
25109 .endd
25110 This looks up an ACL file to use on the basis of the host's IP address, falling
25111 back to a default if the lookup fails. If an ACL is successfully read from a
25112 file, it is retained in memory for the duration of the Exim process, so that it
25113 can be re-used without having to re-read the file.
25114 .next
25115 If the string does not start with a slash, and does not contain any spaces,
25116 Exim searches the ACL section of the configuration for an ACL whose name
25117 matches the string.
25118 .next
25119 If no named ACL is found, or if the string contains spaces, Exim parses
25120 the string as an inline ACL. This can save typing in cases where you just
25121 want to have something like
25122 .code
25123 acl_smtp_vrfy = accept
25124 .endd
25125 in order to allow free use of the VRFY command. Such a string may contain
25126 newlines; it is processed in the same way as an ACL that is read from a file.
25127 .endlist
25128
25129
25130
25131
25132 .section "ACL return codes" "SECID196"
25133 .cindex "&ACL;" "return codes"
25134 Except for the QUIT ACL, which does not affect the SMTP return code (see
25135 section &<<SECTQUITACL>>& above), the result of running an ACL is either
25136 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
25137 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
25138 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
25139 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
25140 This also causes a 4&'xx'& return code.
25141
25142 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
25143 &"deny"&, because there is no mechanism for passing temporary errors to the
25144 submitters of non-SMTP messages.
25145
25146
25147 ACLs that are relevant to message reception may also return &"discard"&. This
25148 has the effect of &"accept"&, but causes either the entire message or an
25149 individual recipient address to be discarded. In other words, it is a
25150 blackholing facility. Use it with care.
25151
25152 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
25153 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
25154 RCPT ACL is to discard just the one recipient address. If there are no
25155 recipients left when the message's data is received, the DATA ACL is not
25156 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
25157 remaining recipients. The &"discard"& return is not permitted for the
25158 &%acl_smtp_predata%& ACL.
25159
25160
25161 .cindex "&[local_scan()]& function" "when all recipients discarded"
25162 The &[local_scan()]& function is always run, even if there are no remaining
25163 recipients; it may create new recipients.
25164
25165
25166
25167 .section "Unset ACL options" "SECID197"
25168 .cindex "&ACL;" "unset options"
25169 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
25170 all the same. &*Note*&: These defaults apply only when the relevant ACL is
25171 not defined at all. For any defined ACL, the default action when control
25172 reaches the end of the ACL statements is &"deny"&.
25173
25174 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
25175 these two are ACLs that are used only for their side effects. They cannot be
25176 used to accept or reject anything.
25177
25178 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
25179 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
25180 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
25181 when the ACL is not defined is &"accept"&.
25182
25183 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
25184 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
25185 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
25186 messages over an SMTP connection. For an example, see the ACL in the default
25187 configuration file.
25188
25189
25190
25191
25192 .section "Data for message ACLs" "SECID198"
25193 .cindex "&ACL;" "data for message ACL"
25194 .vindex &$domain$&
25195 .vindex &$local_part$&
25196 .vindex &$sender_address$&
25197 .vindex &$sender_host_address$&
25198 .vindex &$smtp_command$&
25199 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
25200 that contain information about the host and the message's sender (for example,
25201 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
25202 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
25203 &$local_part$& are set from the argument address. The entire SMTP command
25204 is available in &$smtp_command$&.
25205
25206 When an ACL for the AUTH parameter of MAIL is running, the variables that
25207 contain information about the host are set, but &$sender_address$& is not yet
25208 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
25209 how it is used.
25210
25211 .vindex "&$message_size$&"
25212 The &$message_size$& variable is set to the value of the SIZE parameter on
25213 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
25214 that parameter is not given. The value is updated to the true message size by
25215 the time the final DATA ACL is run (after the message data has been
25216 received).
25217
25218 .vindex "&$rcpt_count$&"
25219 .vindex "&$recipients_count$&"
25220 The &$rcpt_count$& variable increases by one for each RCPT command received.
25221 The &$recipients_count$& variable increases by one each time a RCPT command is
25222 accepted, so while an ACL for RCPT is being processed, it contains the number
25223 of previously accepted recipients. At DATA time (for both the DATA ACLs),
25224 &$rcpt_count$& contains the total number of RCPT commands, and
25225 &$recipients_count$& contains the total number of accepted recipients.
25226
25227
25228
25229
25230
25231 .section "Data for non-message ACLs" "SECTdatfornon"
25232 .cindex "&ACL;" "data for non-message ACL"
25233 .vindex &$smtp_command_argument$&
25234 .vindex &$smtp_command$&
25235 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
25236 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
25237 and the entire SMTP command is available in &$smtp_command$&.
25238 These variables can be tested using a &%condition%& condition. For example,
25239 here is an ACL for use with AUTH, which insists that either the session is
25240 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
25241 does not permit authentication methods that use cleartext passwords on
25242 unencrypted connections.
25243 .code
25244 acl_check_auth:
25245   accept encrypted = *
25246   accept condition = ${if eq{${uc:$smtp_command_argument}}\
25247                      {CRAM-MD5}}
25248   deny   message   = TLS encryption or CRAM-MD5 required
25249 .endd
25250 (Another way of applying this restriction is to arrange for the authenticators
25251 that use cleartext passwords not to be advertised when the connection is not
25252 encrypted. You can use the generic &%server_advertise_condition%& authenticator
25253 option to do this.)
25254
25255
25256
25257 .section "Format of an ACL" "SECID199"
25258 .cindex "&ACL;" "format of"
25259 .cindex "&ACL;" "verbs, definition of"
25260 An individual ACL consists of a number of statements. Each statement starts
25261 with a verb, optionally followed by a number of conditions and &"modifiers"&.
25262 Modifiers can change the way the verb operates, define error and log messages,
25263 set variables, insert delays, and vary the processing of accepted messages.
25264
25265 If all the conditions are met, the verb is obeyed. The same condition may be
25266 used (with different arguments) more than once in the same statement. This
25267 provides a means of specifying an &"and"& conjunction between conditions. For
25268 example:
25269 .code
25270 deny  dnslists = list1.example
25271 dnslists = list2.example
25272 .endd
25273 If there are no conditions, the verb is always obeyed. Exim stops evaluating
25274 the conditions and modifiers when it reaches a condition that fails. What
25275 happens then depends on the verb (and in one case, on a special modifier). Not
25276 all the conditions make sense at every testing point. For example, you cannot
25277 test a sender address in the ACL that is run for a VRFY command.
25278
25279
25280 .section "ACL verbs" "SECID200"
25281 The ACL verbs are as follows:
25282
25283 .ilist
25284 .cindex "&%accept%& ACL verb"
25285 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
25286 of the conditions are not met, what happens depends on whether &%endpass%&
25287 appears among the conditions (for syntax see below). If the failing condition
25288 is before &%endpass%&, control is passed to the next ACL statement; if it is
25289 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
25290 check a RCPT command:
25291 .code
25292 accept domains = +local_domains
25293 endpass
25294 verify = recipient
25295 .endd
25296 If the recipient domain does not match the &%domains%& condition, control
25297 passes to the next statement. If it does match, the recipient is verified, and
25298 the command is accepted if verification succeeds. However, if verification
25299 fails, the ACL yields &"deny"&, because the failing condition is after
25300 &%endpass%&.
25301
25302 The &%endpass%& feature has turned out to be confusing to many people, so its
25303 use is not recommended nowadays. It is always possible to rewrite an ACL so
25304 that &%endpass%& is not needed, and it is no longer used in the default
25305 configuration.
25306
25307 .cindex "&%message%& ACL modifier" "with &%accept%&"
25308 If a &%message%& modifier appears on an &%accept%& statement, its action
25309 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
25310 (when an &%accept%& verb either accepts or passes control to the next
25311 statement), &%message%& can be used to vary the message that is sent when an
25312 SMTP command is accepted. For example, in a RCPT ACL you could have:
25313 .display
25314 &`accept  `&<&'some conditions'&>
25315 &`        message = OK, I will allow you through today`&
25316 .endd
25317 You can specify an SMTP response code, optionally followed by an &"extended
25318 response code"& at the start of the message, but the first digit must be the
25319 same as would be sent by default, which is 2 for an &%accept%& verb.
25320
25321 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
25322 an error message that is used when access is denied. This behaviour is retained
25323 for backward compatibility, but current &"best practice"& is to avoid the use
25324 of &%endpass%&.
25325
25326
25327 .next
25328 .cindex "&%defer%& ACL verb"
25329 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
25330 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
25331 &%defer%& is the same as &%deny%&, because there is no way of sending a
25332 temporary error. For a RCPT command, &%defer%& is much the same as using a
25333 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
25334 be used in any ACL, and even for a recipient it might be a simpler approach.
25335
25336
25337 .next
25338 .cindex "&%deny%& ACL verb"
25339 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
25340 the conditions are not met, control is passed to the next ACL statement. For
25341 example,
25342 .code
25343 deny dnslists = blackholes.mail-abuse.org
25344 .endd
25345 rejects commands from hosts that are on a DNS black list.
25346
25347
25348 .next
25349 .cindex "&%discard%& ACL verb"
25350 &%discard%&: This verb behaves like &%accept%&, except that it returns
25351 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
25352 that are concerned with receiving messages. When all the conditions are true,
25353 the sending entity receives a &"success"& response. However, &%discard%& causes
25354 recipients to be discarded. If it is used in an ACL for RCPT, just the one
25355 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
25356 message's recipients are discarded. Recipients that are discarded before DATA
25357 do not appear in the log line when the &%received_recipients%& log selector is set.
25358
25359 If the &%log_message%& modifier is set when &%discard%& operates,
25360 its contents are added to the line that is automatically written to the log.
25361 The &%message%& modifier operates exactly as it does for &%accept%&.
25362
25363
25364 .next
25365 .cindex "&%drop%& ACL verb"
25366 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
25367 forcibly closed after the 5&'xx'& error message has been sent. For example:
25368 .code
25369 drop   message   = I don't take more than 20 RCPTs
25370        condition = ${if > {$rcpt_count}{20}}
25371 .endd
25372 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
25373 The connection is always dropped after sending a 550 response.
25374
25375 .next
25376 .cindex "&%require%& ACL verb"
25377 &%require%&: If all the conditions are met, control is passed to the next ACL
25378 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
25379 example, when checking a RCPT command,
25380 .code
25381 require message = Sender did not verify
25382         verify  = sender
25383 .endd
25384 passes control to subsequent statements only if the message's sender can be
25385 verified. Otherwise, it rejects the command. Note the positioning of the
25386 &%message%& modifier, before the &%verify%& condition. The reason for this is
25387 discussed in section &<<SECTcondmodproc>>&.
25388
25389 .next
25390 .cindex "&%warn%& ACL verb"
25391 &%warn%&: If all the conditions are true, a line specified by the
25392 &%log_message%& modifier is written to Exim's main log. Control always passes
25393 to the next ACL statement. If any condition is false, the log line is not
25394 written. If an identical log line is requested several times in the same
25395 message, only one copy is actually written to the log. If you want to force
25396 duplicates to be written, use the &%logwrite%& modifier instead.
25397
25398 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
25399 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
25400 &%logwrite%&, and &%add_header%&) that appear before the first failing
25401 condition. There is more about adding header lines in section
25402 &<<SECTaddheadacl>>&.
25403
25404 If any condition on a &%warn%& statement cannot be completed (that is, there is
25405 some sort of defer), the log line specified by &%log_message%& is not written.
25406 This does not include the case of a forced failure from a lookup, which
25407 is considered to be a successful completion. After a defer, no further
25408 conditions or modifiers in the &%warn%& statement are processed. The incident
25409 is logged, and the ACL continues to be processed, from the next statement
25410 onwards.
25411
25412
25413 .vindex "&$acl_verify_message$&"
25414 When one of the &%warn%& conditions is an address verification that fails, the
25415 text of the verification failure message is in &$acl_verify_message$&. If you
25416 want this logged, you must set it up explicitly. For example:
25417 .code
25418 warn   !verify = sender
25419        log_message = sender verify failed: $acl_verify_message
25420 .endd
25421 .endlist
25422
25423 At the end of each ACL there is an implicit unconditional &%deny%&.
25424
25425 As you can see from the examples above, the conditions and modifiers are
25426 written one to a line, with the first one on the same line as the verb, and
25427 subsequent ones on following lines. If you have a very long condition, you can
25428 continue it onto several physical lines by the usual backslash continuation
25429 mechanism. It is conventional to align the conditions vertically.
25430
25431
25432
25433 .section "ACL variables" "SECTaclvariables"
25434 .cindex "&ACL;" "variables"
25435 There are some special variables that can be set during ACL processing. They
25436 can be used to pass information between different ACLs, different invocations
25437 of the same ACL in the same SMTP connection, and between ACLs and the routers,
25438 transports, and filters that are used to deliver a message. The names of these
25439 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
25440 an underscore, but the remainder of the name can be any sequence of
25441 alphanumeric characters and underscores that you choose. There is no limit on
25442 the number of ACL variables. The two sets act as follows:
25443 .ilist
25444 The values of those variables whose names begin with &$acl_c$& persist
25445 throughout an SMTP connection. They are never reset. Thus, a value that is set
25446 while receiving one message is still available when receiving the next message
25447 on the same SMTP connection.
25448 .next
25449 The values of those variables whose names begin with &$acl_m$& persist only
25450 while a message is being received. They are reset afterwards. They are also
25451 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
25452 .endlist
25453
25454 When a message is accepted, the current values of all the ACL variables are
25455 preserved with the message and are subsequently made available at delivery
25456 time. The ACL variables are set by a modifier called &%set%&. For example:
25457 .code
25458 accept hosts = whatever
25459        set acl_m4 = some value
25460 accept authenticated = *
25461        set acl_c_auth = yes
25462 .endd
25463 &*Note*&: A leading dollar sign is not used when naming a variable that is to
25464 be set. If you want to set a variable without taking any action, you can use a
25465 &%warn%& verb without any other modifiers or conditions.
25466
25467 .oindex &%strict_acl_vars%&
25468 What happens if a syntactically valid but undefined ACL variable is
25469 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
25470 false (the default), an empty string is substituted; if it is true, an
25471 error is generated.
25472
25473 Versions of Exim before 4.64 have a limited set of numbered variables, but
25474 their names are compatible, so there is no problem with upgrading.
25475
25476
25477 .section "Condition and modifier processing" "SECTcondmodproc"
25478 .cindex "&ACL;" "conditions; processing"
25479 .cindex "&ACL;" "modifiers; processing"
25480 An exclamation mark preceding a condition negates its result. For example:
25481 .code
25482 deny   domains = *.dom.example
25483       !verify  = recipient
25484 .endd
25485 causes the ACL to return &"deny"& if the recipient domain ends in
25486 &'dom.example'& and the recipient address cannot be verified. Sometimes
25487 negation can be used on the right-hand side of a condition. For example, these
25488 two statements are equivalent:
25489 .code
25490 deny  hosts = !192.168.3.4
25491 deny !hosts =  192.168.3.4
25492 .endd
25493 However, for many conditions (&%verify%& being a good example), only left-hand
25494 side negation of the whole condition is possible.
25495
25496 The arguments of conditions and modifiers are expanded. A forced failure
25497 of an expansion causes a condition to be ignored, that is, it behaves as if the
25498 condition is true. Consider these two statements:
25499 .code
25500 accept  senders = ${lookup{$host_name}lsearch\
25501                   {/some/file}{$value}fail}
25502 accept  senders = ${lookup{$host_name}lsearch\
25503                   {/some/file}{$value}{}}
25504 .endd
25505 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
25506 the returned list is searched, but if the lookup fails the behaviour is
25507 different in the two cases. The &%fail%& in the first statement causes the
25508 condition to be ignored, leaving no further conditions. The &%accept%& verb
25509 therefore succeeds. The second statement, however, generates an empty list when
25510 the lookup fails. No sender can match an empty list, so the condition fails,
25511 and therefore the &%accept%& also fails.
25512
25513 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
25514 specify actions that are taken as the conditions for a statement are checked;
25515 others specify text for messages that are used when access is denied or a
25516 warning is generated. The &%control%& modifier affects the way an incoming
25517 message is handled.
25518
25519 The positioning of the modifiers in an ACL statement important, because the
25520 processing of a verb ceases as soon as its outcome is known. Only those
25521 modifiers that have already been encountered will take effect. For example,
25522 consider this use of the &%message%& modifier:
25523 .code
25524 require message = Can't verify sender
25525         verify  = sender
25526         message = Can't verify recipient
25527         verify  = recipient
25528         message = This message cannot be used
25529 .endd
25530 If sender verification fails, Exim knows that the result of the statement is
25531 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
25532 so its text is used as the error message. If sender verification succeeds, but
25533 recipient verification fails, the second message is used. If recipient
25534 verification succeeds, the third message becomes &"current"&, but is never used
25535 because there are no more conditions to cause failure.
25536
25537 For the &%deny%& verb, on the other hand, it is always the last &%message%&
25538 modifier that is used, because all the conditions must be true for rejection to
25539 happen. Specifying more than one &%message%& modifier does not make sense, and
25540 the message can even be specified after all the conditions. For example:
25541 .code
25542 deny   hosts = ...
25543       !senders = *@my.domain.example
25544        message = Invalid sender from client host
25545 .endd
25546 The &"deny"& result does not happen until the end of the statement is reached,
25547 by which time Exim has set up the message.
25548
25549
25550
25551 .section "ACL modifiers" "SECTACLmodi"
25552 .cindex "&ACL;" "modifiers; list of"
25553 The ACL modifiers are as follows:
25554
25555 .vlist
25556 .vitem &*add_header*&&~=&~<&'text'&>
25557 This modifier specifies one or more header lines that are to be added to an
25558 incoming message, assuming, of course, that the message is ultimately
25559 accepted. For details, see section &<<SECTaddheadacl>>&.
25560
25561 .vitem &*continue*&&~=&~<&'text'&>
25562 .cindex "&%continue%& ACL modifier"
25563 .cindex "database" "updating in ACL"
25564 This modifier does nothing of itself, and processing of the ACL always
25565 continues with the next condition or modifier. The value of &%continue%& is in
25566 the side effects of expanding its argument. Typically this could be used to
25567 update a database. It is really just a syntactic tidiness, to avoid having to
25568 write rather ugly lines like this:
25569 .display
25570 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
25571 .endd
25572 Instead, all you need is
25573 .display
25574 &`continue = `&<&'some expansion'&>
25575 .endd
25576
25577 .vitem &*control*&&~=&~<&'text'&>
25578 .cindex "&%control%& ACL modifier"
25579 This modifier affects the subsequent processing of the SMTP connection or of an
25580 incoming message that is accepted. The effect of the first type of control
25581 lasts for the duration of the connection, whereas the effect of the second type
25582 lasts only until the current message has been received. The message-specific
25583 controls always apply to the whole message, not to individual recipients,
25584 even if the &%control%& modifier appears in a RCPT ACL.
25585
25586 As there are now quite a few controls that can be applied, they are described
25587 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
25588 in several different ways. For example:
25589
25590 . ==== As this is a nested list, any displays it contains must be indented
25591 . ==== as otherwise they are too far to the left. That comment applies only
25592 . ==== when xmlto and fop are used; formatting with sdop gets it right either
25593 . ==== way.
25594
25595 .ilist
25596 It can be at the end of an &%accept%& statement:
25597 .code
25598     accept  ...some conditions
25599             control = queue_only
25600 .endd
25601 In this case, the control is applied when this statement yields &"accept"&, in
25602 other words, when the conditions are all true.
25603
25604 .next
25605 It can be in the middle of an &%accept%& statement:
25606 .code
25607     accept  ...some conditions...
25608             control = queue_only
25609             ...some more conditions...
25610 .endd
25611 If the first set of conditions are true, the control is applied, even if the
25612 statement does not accept because one of the second set of conditions is false.
25613 In this case, some subsequent statement must yield &"accept"& for the control
25614 to be relevant.
25615
25616 .next
25617 It can be used with &%warn%& to apply the control, leaving the
25618 decision about accepting or denying to a subsequent verb. For
25619 example:
25620 .code
25621     warn    ...some conditions...
25622             control = freeze
25623     accept  ...
25624 .endd
25625 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
25626 &%logwrite%&, so it does not add anything to the message and does not write a
25627 log entry.
25628
25629 .next
25630 If you want to apply a control unconditionally, you can use it with a
25631 &%require%& verb. For example:
25632 .code
25633     require  control = no_multiline_responses
25634 .endd
25635 .endlist
25636
25637 .vitem &*delay*&&~=&~<&'time'&>
25638 .cindex "&%delay%& ACL modifier"
25639 .oindex "&%-bh%&"
25640 This modifier may appear in any ACL. It causes Exim to wait for the time
25641 interval before proceeding. However, when testing Exim using the &%-bh%&
25642 option, the delay is not actually imposed (an appropriate message is output
25643 instead). The time is given in the usual Exim notation, and the delay happens
25644 as soon as the modifier is processed. In an SMTP session, pending output is
25645 flushed before the delay is imposed.
25646
25647 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
25648 example:
25649 .code
25650 deny    ...some conditions...
25651         delay = 30s
25652 .endd
25653 The delay happens if all the conditions are true, before the statement returns
25654 &"deny"&. Compare this with:
25655 .code
25656 deny    delay = 30s
25657         ...some conditions...
25658 .endd
25659 which waits for 30s before processing the conditions. The &%delay%& modifier
25660 can also be used with &%warn%& and together with &%control%&:
25661 .code
25662 warn    ...some conditions...
25663         delay = 2m
25664         control = freeze
25665 accept  ...
25666 .endd
25667
25668 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
25669 responses to several commands are no longer buffered and sent in one packet (as
25670 they would normally be) because all output is flushed before imposing the
25671 delay. This optimization is disabled so that a number of small delays do not
25672 appear to the client as one large aggregated delay that might provoke an
25673 unwanted timeout. You can, however, disable output flushing for &%delay%& by
25674 using a &%control%& modifier to set &%no_delay_flush%&.
25675
25676
25677 .vitem &*endpass*&
25678 .cindex "&%endpass%& ACL modifier"
25679 This modifier, which has no argument, is recognized only in &%accept%& and
25680 &%discard%& statements. It marks the boundary between the conditions whose
25681 failure causes control to pass to the next statement, and the conditions whose
25682 failure causes the ACL to return &"deny"&. This concept has proved to be
25683 confusing to some people, so the use of &%endpass%& is no longer recommended as
25684 &"best practice"&. See the description of &%accept%& above for more details.
25685
25686
25687 .vitem &*log_message*&&~=&~<&'text'&>
25688 .cindex "&%log_message%& ACL modifier"
25689 This modifier sets up a message that is used as part of the log message if the
25690 ACL denies access or a &%warn%& statement's conditions are true. For example:
25691 .code
25692 require log_message = wrong cipher suite $tls_cipher
25693         encrypted   = DES-CBC3-SHA
25694 .endd
25695 &%log_message%& is also used when recipients are discarded by &%discard%&. For
25696 example:
25697 .display
25698 &`discard `&<&'some conditions'&>
25699 &`        log_message = Discarded $local_part@$domain because...`&
25700 .endd
25701 When access is denied, &%log_message%& adds to any underlying error message
25702 that may exist because of a condition failure. For example, while verifying a
25703 recipient address, a &':fail:'& redirection might have already set up a
25704 message.
25705
25706 The message may be defined before the conditions to which it applies, because
25707 the string expansion does not happen until Exim decides that access is to be
25708 denied. This means that any variables that are set by the condition are
25709 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
25710 variables are set after a DNS black list lookup succeeds. If the expansion of
25711 &%log_message%& fails, or if the result is an empty string, the modifier is
25712 ignored.
25713
25714 .vindex "&$acl_verify_message$&"
25715 If you want to use a &%warn%& statement to log the result of an address
25716 verification, you can use &$acl_verify_message$& to include the verification
25717 error message.
25718
25719 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
25720 the start of the logged message. If the same warning log message is requested
25721 more than once while receiving  a single email message, only one copy is
25722 actually logged. If you want to log multiple copies, use &%logwrite%& instead
25723 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
25724 is logged for a successful &%warn%& statement.
25725
25726 If &%log_message%& is not present and there is no underlying error message (for
25727 example, from the failure of address verification), but &%message%& is present,
25728 the &%message%& text is used for logging rejections. However, if any text for
25729 logging contains newlines, only the first line is logged. In the absence of
25730 both &%log_message%& and &%message%&, a default built-in message is used for
25731 logging rejections.
25732
25733
25734 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
25735 .cindex "&%log_reject_target%& ACL modifier"
25736 .cindex "logging in ACL" "specifying which log"
25737 This modifier makes it possible to specify which logs are used for messages
25738 about ACL rejections. Its argument is a colon-separated list of words that can
25739 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
25740 may be empty, in which case a rejection is not logged at all. For example, this
25741 ACL fragment writes no logging information when access is denied:
25742 .display
25743 &`deny `&<&'some conditions'&>
25744 &`     log_reject_target =`&
25745 .endd
25746 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
25747 permanent and temporary rejections. Its effect lasts for the rest of the
25748 current ACL.
25749
25750
25751 .vitem &*logwrite*&&~=&~<&'text'&>
25752 .cindex "&%logwrite%& ACL modifier"
25753 .cindex "logging in ACL" "immediate"
25754 This modifier writes a message to a log file as soon as it is encountered when
25755 processing an ACL. (Compare &%log_message%&, which, except in the case of
25756 &%warn%& and &%discard%&, is used only if the ACL statement denies
25757 access.) The &%logwrite%& modifier can be used to log special incidents in
25758 ACLs. For example:
25759 .display
25760 &`accept `&<&'some special conditions'&>
25761 &`       control  = freeze`&
25762 &`       logwrite = froze message because ...`&
25763 .endd
25764 By default, the message is written to the main log. However, it may begin
25765 with a colon, followed by a comma-separated list of log names, and then
25766 another colon, to specify exactly which logs are to be written. For
25767 example:
25768 .code
25769 logwrite = :main,reject: text for main and reject logs
25770 logwrite = :panic: text for panic log only
25771 .endd
25772
25773
25774 .vitem &*message*&&~=&~<&'text'&>
25775 .cindex "&%message%& ACL modifier"
25776 This modifier sets up a text string that is expanded and used as a response
25777 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
25778 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
25779 there is some complication if &%endpass%& is involved; see the description of
25780 &%accept%& for details.)
25781
25782 The expansion of the message happens at the time Exim decides that the ACL is
25783 to end, not at the time it processes &%message%&. If the expansion fails, or
25784 generates an empty string, the modifier is ignored. Here is an example where
25785 &%message%& must be specified first, because the ACL ends with a rejection if
25786 the &%hosts%& condition fails:
25787 .code
25788 require  message = Host not recognized
25789          hosts = 10.0.0.0/8
25790 .endd
25791 (Once a condition has failed, no further conditions or modifiers are
25792 processed.)
25793
25794 .cindex "SMTP" "error codes"
25795 .oindex "&%smtp_banner%&
25796 For ACLs that are triggered by SMTP commands, the message is returned as part
25797 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
25798 is meaningful only for SMTP, as no message is returned when a non-SMTP message
25799 is accepted. In the case of the connect ACL, accepting with a message modifier
25800 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
25801 accept message may not contain more than one line (otherwise it will be
25802 truncated at the first newline and a panic logged), and it cannot affect the
25803 EHLO options.
25804
25805 When SMTP is involved, the message may begin with an overriding response code,
25806 consisting of three digits optionally followed by an &"extended response code"&
25807 of the form &'n.n.n'&, each code being followed by a space. For example:
25808 .code
25809 deny  message = 599 1.2.3 Host not welcome
25810       hosts = 192.168.34.0/24
25811 .endd
25812 The first digit of the supplied response code must be the same as would be sent
25813 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
25814 access, but for the predata ACL, note that the default success code is 354, not
25815 2&'xx'&.
25816
25817 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
25818 the message modifier cannot override the 221 response code.
25819
25820 The text in a &%message%& modifier is literal; any quotes are taken as
25821 literals, but because the string is expanded, backslash escapes are processed
25822 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
25823 response.
25824
25825 .vindex "&$acl_verify_message$&"
25826 If &%message%& is used on a statement that verifies an address, the message
25827 specified overrides any message that is generated by the verification process.
25828 However, the original message is available in the variable
25829 &$acl_verify_message$&, so you can incorporate it into your message if you
25830 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
25831 routers to be passed back as part of the SMTP response, you should either not
25832 use a &%message%& modifier, or make use of &$acl_verify_message$&.
25833
25834 For compatibility with previous releases of Exim, a &%message%& modifier that
25835 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
25836 modifier, but this usage is now deprecated. However, &%message%& acts only when
25837 all the conditions are true, wherever it appears in an ACL command, whereas
25838 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
25839 &%warn%& in an ACL that is not concerned with receiving a message, it has no
25840 effect.
25841
25842
25843 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
25844 .cindex "&%set%& ACL modifier"
25845 This modifier puts a value into one of the ACL variables (see section
25846 &<<SECTaclvariables>>&).
25847 .endlist
25848
25849
25850
25851
25852
25853 .section "Use of the control modifier" "SECTcontrols"
25854 .cindex "&%control%& ACL modifier"
25855 The &%control%& modifier supports the following settings:
25856
25857 .vlist
25858 .vitem &*control&~=&~allow_auth_unadvertised*&
25859 This modifier allows a client host to use the SMTP AUTH command even when it
25860 has not been advertised in response to EHLO. Furthermore, because there are
25861 apparently some really broken clients that do this, Exim will accept AUTH after
25862 HELO (rather than EHLO) when this control is set. It should be used only if you
25863 really need it, and you should limit its use to those broken clients that do
25864 not work without it. For example:
25865 .code
25866 warn hosts   = 192.168.34.25
25867      control = allow_auth_unadvertised
25868 .endd
25869 Normally, when an Exim server receives an AUTH command, it checks the name of
25870 the authentication mechanism that is given in the command to ensure that it
25871 matches an advertised mechanism. When this control is set, the check that a
25872 mechanism has been advertised is bypassed. Any configured mechanism can be used
25873 by the client. This control is permitted only in the connection and HELO ACLs.
25874
25875
25876 .vitem &*control&~=&~caseful_local_part*& &&&
25877        &*control&~=&~caselower_local_part*&
25878 .cindex "&ACL;" "case of local part in"
25879 .cindex "case of local parts"
25880 .vindex "&$local_part$&"
25881 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
25882 (that is, during RCPT processing). By default, the contents of &$local_part$&
25883 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
25884 any uppercase letters in the original local part are restored in &$local_part$&
25885 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
25886 is encountered.
25887
25888 These controls affect only the current recipient. Moreover, they apply only to
25889 local part handling that takes place directly in the ACL (for example, as a key
25890 in lookups). If a test to verify the recipient is obeyed, the case-related
25891 handling of the local part during the verification is controlled by the router
25892 configuration (see the &%caseful_local_part%& generic router option).
25893
25894 This facility could be used, for example, to add a spam score to local parts
25895 containing upper case letters. For example, using &$acl_m4$& to accumulate the
25896 spam score:
25897 .code
25898 warn  control = caseful_local_part
25899       set acl_m4 = ${eval:\
25900                      $acl_m4 + \
25901                      ${if match{$local_part}{[A-Z]}{1}{0}}\
25902                     }
25903       control = caselower_local_part
25904 .endd
25905 Notice that we put back the lower cased version afterwards, assuming that
25906 is what is wanted for subsequent tests.
25907
25908 .new
25909 .vitem &*control&~=&~debug/*&<&'options'&>
25910 .cindex "&ACL;" "enabling debug logging"
25911 .cindex "debugging" "enabling from an ACL"
25912 This control turns on debug logging, almost as though Exim had been invoked
25913 with &`-d`&, with the output going to a new logfile, by default called
25914 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
25915 may access any variables already defined.  The logging may be adjusted with
25916 the &'opts'& option, which takes the same values as the &`-d`& command-line
25917 option.  Some examples (which depend on variables that don't exist in all
25918 contexts):
25919 .code
25920       control = debug
25921       control = debug/tag=.$sender_host_address
25922       control = debug/opts=+expand+acl
25923       control = debug/tag=.$message_exim_id/opts=+expand
25924 .endd
25925 .wen
25926
25927 .vitem &*control&~=&~enforce_sync*& &&&
25928        &*control&~=&~no_enforce_sync*&
25929 .cindex "SMTP" "synchronization checking"
25930 .cindex "synchronization checking in SMTP"
25931 These controls make it possible to be selective about when SMTP synchronization
25932 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
25933 state of the switch (it is true by default). See the description of this option
25934 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
25935
25936 The effect of these two controls lasts for the remainder of the SMTP
25937 connection. They can appear in any ACL except the one for the non-SMTP
25938 messages. The most straightforward place to put them is in the ACL defined by
25939 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
25940 before the first synchronization check. The expected use is to turn off the
25941 synchronization checks for badly-behaved hosts that you nevertheless need to
25942 work with.
25943
25944
25945 .vitem &*control&~=&~fakedefer/*&<&'message'&>
25946 .cindex "fake defer"
25947 .cindex "defer, fake"
25948 This control works in exactly the same way as &%fakereject%& (described below)
25949 except that it causes an SMTP 450 response after the message data instead of a
25950 550 response. You must take care when using &%fakedefer%& because it causes the
25951 messages to be duplicated when the sender retries. Therefore, you should not
25952 use &%fakedefer%& if the message is to be delivered normally.
25953
25954 .vitem &*control&~=&~fakereject/*&<&'message'&>
25955 .cindex "fake rejection"
25956 .cindex "rejection, fake"
25957 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
25958 words, only when an SMTP message is being received. If Exim accepts the
25959 message, instead the final 250 response, a 550 rejection message is sent.
25960 However, Exim proceeds to deliver the message as normal. The control applies
25961 only to the current message, not to any subsequent ones that may be received in
25962 the same SMTP connection.
25963
25964 The text for the 550 response is taken from the &%control%& modifier. If no
25965 message is supplied, the following is used:
25966 .code
25967 550-Your message has been rejected but is being
25968 550-kept for evaluation.
25969 550-If it was a legitimate message, it may still be
25970 550 delivered to the target recipient(s).
25971 .endd
25972 This facility should be used with extreme caution.
25973
25974 .vitem &*control&~=&~freeze*&
25975 .cindex "frozen messages" "forcing in ACL"
25976 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
25977 other words, only when a message is being received. If the message is accepted,
25978 it is placed on Exim's queue and frozen. The control applies only to the
25979 current message, not to any subsequent ones that may be received in the same
25980 SMTP connection.
25981
25982 This modifier can optionally be followed by &`/no_tell`&. If the global option
25983 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
25984 is told about the freezing), provided all the &*control=freeze*& modifiers that
25985 are obeyed for the current message have the &`/no_tell`& option.
25986
25987 .vitem &*control&~=&~no_delay_flush*&
25988 .cindex "SMTP" "output flushing, disabling for delay"
25989 Exim normally flushes SMTP output before implementing a delay in an ACL, to
25990 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
25991 use. This control, as long as it is encountered before the &%delay%& modifier,
25992 disables such output flushing.
25993
25994 .vitem &*control&~=&~no_callout_flush*&
25995 .cindex "SMTP" "output flushing, disabling for callout"
25996 Exim normally flushes SMTP output before performing a callout in an ACL, to
25997 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
25998 use. This control, as long as it is encountered before the &%verify%& condition
25999 that causes the callout, disables such output flushing.
26000
26001 .vitem &*control&~=&~no_mbox_unspool*&
26002 This control is available when Exim is compiled with the content scanning
26003 extension. Content scanning may require a copy of the current message, or parts
26004 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
26005 or spam scanner. Normally, such copies are deleted when they are no longer
26006 needed. If this control is set, the copies are not deleted. The control applies
26007 only to the current message, not to any subsequent ones that may be received in
26008 the same SMTP connection. It is provided for debugging purposes and is unlikely
26009 to be useful in production.
26010
26011 .vitem &*control&~=&~no_multiline_responses*&
26012 .cindex "multiline responses, suppressing"
26013 This control is permitted for any ACL except the one for non-SMTP messages.
26014 It seems that there are broken clients in use that cannot handle multiline
26015 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
26016
26017 If this control is set, multiline SMTP responses from ACL rejections are
26018 suppressed. One way of doing this would have been to put out these responses as
26019 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
26020 (&"use multiline responses for more"& it says &-- ha!), and some of the
26021 responses might get close to that. So this facility, which is after all only a
26022 sop to broken clients, is implemented by doing two very easy things:
26023
26024 .ilist
26025 Extra information that is normally output as part of a rejection caused by
26026 sender verification failure is omitted. Only the final line (typically &"sender
26027 verification failed"&) is sent.
26028 .next
26029 If a &%message%& modifier supplies a multiline response, only the first
26030 line is output.
26031 .endlist
26032
26033 The setting of the switch can, of course, be made conditional on the
26034 calling host. Its effect lasts until the end of the SMTP connection.
26035
26036 .vitem &*control&~=&~no_pipelining*&
26037 .cindex "PIPELINING" "suppressing advertising"
26038 This control turns off the advertising of the PIPELINING extension to SMTP in
26039 the current session. To be useful, it must be obeyed before Exim sends its
26040 response to an EHLO command. Therefore, it should normally appear in an ACL
26041 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
26042 &%pipelining_advertise_hosts%&.
26043
26044 .vitem &*control&~=&~queue_only*&
26045 .oindex "&%queue_only%&"
26046 .cindex "queueing incoming messages"
26047 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
26048 other words, only when a message is being received. If the message is accepted,
26049 it is placed on Exim's queue and left there for delivery by a subsequent queue
26050 runner. No immediate delivery process is started. In other words, it has the
26051 effect as the &%queue_only%& global option. However, the control applies only
26052 to the current message, not to any subsequent ones that may be received in the
26053 same SMTP connection.
26054
26055 .vitem &*control&~=&~submission/*&<&'options'&>
26056 .cindex "message" "submission"
26057 .cindex "submission mode"
26058 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
26059 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
26060 the current message is a submission from a local MUA. In this case, Exim
26061 operates in &"submission mode"&, and applies certain fixups to the message if
26062 necessary. For example, it adds a &'Date:'& header line if one is not present.
26063 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
26064 late (the message has already been created).
26065
26066 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
26067 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
26068 submission mode; the available options for this control are described there.
26069 The control applies only to the current message, not to any subsequent ones
26070 that may be received in the same SMTP connection.
26071
26072 .vitem &*control&~=&~suppress_local_fixups*&
26073 .cindex "submission fixups, suppressing"
26074 This control applies to locally submitted (non TCP/IP) messages, and is the
26075 complement of &`control = submission`&. It disables the fixups that are
26076 normally applied to locally-submitted messages. Specifically:
26077
26078 .ilist
26079 Any &'Sender:'& header line is left alone (in this respect, it is a
26080 dynamic version of &%local_sender_retain%&).
26081 .next
26082 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
26083 .next
26084 There is no check that &'From:'& corresponds to the actual sender.
26085 .endlist ilist
26086
26087 This control may be useful when a remotely-originated message is accepted,
26088 passed to some scanning program, and then re-submitted for delivery. It can be
26089 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
26090 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
26091 data is read.
26092
26093 &*Note:*& This control applies only to the current message, not to any others
26094 that are being submitted at the same time using &%-bs%& or &%-bS%&.
26095 .endlist vlist
26096
26097
26098 .section "Summary of message fixup control" "SECTsummesfix"
26099 All four possibilities for message fixups can be specified:
26100
26101 .ilist
26102 Locally submitted, fixups applied: the default.
26103 .next
26104 Locally submitted, no fixups applied: use
26105 &`control = suppress_local_fixups`&.
26106 .next
26107 Remotely submitted, no fixups applied: the default.
26108 .next
26109 Remotely submitted, fixups applied: use &`control = submission`&.
26110 .endlist
26111
26112
26113
26114 .section "Adding header lines in ACLs" "SECTaddheadacl"
26115 .cindex "header lines" "adding in an ACL"
26116 .cindex "header lines" "position of added lines"
26117 .cindex "&%message%& ACL modifier"
26118 The &%add_header%& modifier can be used to add one or more extra header lines
26119 to an incoming message, as in this example:
26120 .code
26121 warn dnslists = sbl.spamhaus.org : \
26122                 dialup.mail-abuse.org
26123      add_header = X-blacklisted-at: $dnslist_domain
26124 .endd
26125 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
26126 MIME, and non-SMTP ACLs (in other words, those that are concerned with
26127 receiving a message). The message must ultimately be accepted for
26128 &%add_header%& to have any significant effect. You can use &%add_header%& with
26129 any ACL verb, including &%deny%& (though this is potentially useful only in a
26130 RCPT ACL).
26131
26132 If the data for the &%add_header%& modifier contains one or more newlines that
26133 are not followed by a space or a tab, it is assumed to contain multiple header
26134 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
26135 front of any line that is not a valid header line.
26136
26137 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
26138 They are added to the message before processing the DATA and MIME ACLs.
26139 However, if an identical header line is requested more than once, only one copy
26140 is actually added to the message. Further header lines may be accumulated
26141 during the DATA and MIME ACLs, after which they are added to the message, again
26142 with duplicates suppressed. Thus, it is possible to add two identical header
26143 lines to an SMTP message, but only if one is added before DATA and one after.
26144 In the case of non-SMTP messages, new headers are accumulated during the
26145 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
26146 message is rejected after DATA or by the non-SMTP ACL, all added header lines
26147 are included in the entry that is written to the reject log.
26148
26149 .cindex "header lines" "added; visibility of"
26150 Header lines are not visible in string expansions until they are added to the
26151 message. It follows that header lines defined in the MAIL, RCPT, and predata
26152 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
26153 header lines that are added by the DATA or MIME ACLs are not visible in those
26154 ACLs. Because of this restriction, you cannot use header lines as a way of
26155 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
26156 this, you can use ACL variables, as described in section
26157 &<<SECTaclvariables>>&.
26158
26159 The &%add_header%& modifier acts immediately it is encountered during the
26160 processing of an ACL. Notice the difference between these two cases:
26161 .display
26162 &`accept add_header = ADDED: some text`&
26163 &`       `&<&'some condition'&>
26164
26165 &`accept `&<&'some condition'&>
26166 &`       add_header = ADDED: some text`&
26167 .endd
26168 In the first case, the header line is always added, whether or not the
26169 condition is true. In the second case, the header line is added only if the
26170 condition is true. Multiple occurrences of &%add_header%& may occur in the same
26171 ACL statement. All those that are encountered before a condition fails are
26172 honoured.
26173
26174 .cindex "&%warn%& ACL verb"
26175 For compatibility with previous versions of Exim, a &%message%& modifier for a
26176 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
26177 effect only if all the conditions are true, even if it appears before some of
26178 them. Furthermore, only the last occurrence of &%message%& is honoured. This
26179 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
26180 are present on a &%warn%& verb, both are processed according to their
26181 specifications.
26182
26183 By default, new header lines are added to a message at the end of the existing
26184 header lines. However, you can specify that any particular header line should
26185 be added right at the start (before all the &'Received:'& lines), immediately
26186 after the first block of &'Received:'& lines, or immediately before any line
26187 that is not a &'Received:'& or &'Resent-something:'& header.
26188
26189 This is done by specifying &":at_start:"&, &":after_received:"&, or
26190 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
26191 header line, respectively. (Header text cannot start with a colon, as there has
26192 to be a header name first.) For example:
26193 .code
26194 warn add_header = \
26195        :after_received:X-My-Header: something or other...
26196 .endd
26197 If more than one header line is supplied in a single &%add_header%& modifier,
26198 each one is treated independently and can therefore be placed differently. If
26199 you add more than one line at the start, or after the Received: block, they end
26200 up in reverse order.
26201
26202 &*Warning*&: This facility currently applies only to header lines that are
26203 added in an ACL. It does NOT work for header lines that are added in a
26204 system filter or in a router or transport.
26205
26206
26207
26208
26209 .section "ACL conditions" "SECTaclconditions"
26210 .cindex "&ACL;" "conditions; list of"
26211 Some of conditions listed in this section are available only when Exim is
26212 compiled with the content-scanning extension. They are included here briefly
26213 for completeness. More detailed descriptions can be found in the discussion on
26214 content scanning in chapter &<<CHAPexiscan>>&.
26215
26216 Not all conditions are relevant in all circumstances. For example, testing
26217 senders and recipients does not make sense in an ACL that is being run as the
26218 result of the arrival of an ETRN command, and checks on message headers can be
26219 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
26220 can use the same condition (with different parameters) more than once in the
26221 same ACL statement. This provides a way of specifying an &"and"& conjunction.
26222 The conditions are as follows:
26223
26224
26225 .vlist
26226 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
26227 .cindex "&ACL;" "nested"
26228 .cindex "&ACL;" "indirect"
26229 .cindex "&%acl%& ACL condition"
26230 The possible values of the argument are the same as for the
26231 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
26232 &"accept"& the condition is true; if it returns &"deny"& the condition is
26233 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
26234 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
26235 condition false. This means that further processing of the &%warn%& verb
26236 ceases, but processing of the ACL continues.
26237
26238 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
26239 the connection is dropped. If it returns &"discard"&, the verb must be
26240 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
26241 conditions are tested.
26242
26243 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
26244 loops. This condition allows you to use different ACLs in different
26245 circumstances. For example, different ACLs can be used to handle RCPT commands
26246 for different local users or different local domains.
26247
26248 .vitem &*authenticated&~=&~*&<&'string&~list'&>
26249 .cindex "&%authenticated%& ACL condition"
26250 .cindex "authentication" "ACL checking"
26251 .cindex "&ACL;" "testing for authentication"
26252 If the SMTP connection is not authenticated, the condition is false. Otherwise,
26253 the name of the authenticator is tested against the list. To test for
26254 authentication by any authenticator, you can set
26255 .code
26256 authenticated = *
26257 .endd
26258
26259 .vitem &*condition&~=&~*&<&'string'&>
26260 .cindex "&%condition%& ACL condition"
26261 .cindex "customizing" "ACL condition"
26262 .cindex "&ACL;" "customized test"
26263 .cindex "&ACL;" "testing, customized"
26264 This feature allows you to make up custom conditions. If the result of
26265 expanding the string is an empty string, the number zero, or one of the strings
26266 &"no"& or &"false"&, the condition is false. If the result is any non-zero
26267 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
26268 any other value, some error is assumed to have occurred, and the ACL returns
26269 &"defer"&. However, if the expansion is forced to fail, the condition is
26270 ignored. The effect is to treat it as true, whether it is positive or
26271 negative.
26272
26273 .vitem &*decode&~=&~*&<&'location'&>
26274 .cindex "&%decode%& ACL condition"
26275 This condition is available only when Exim is compiled with the
26276 content-scanning extension, and it is allowed only in the ACL defined by
26277 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
26278 If all goes well, the condition is true. It is false only if there are
26279 problems such as a syntax error or a memory shortage. For more details, see
26280 chapter &<<CHAPexiscan>>&.
26281
26282 .vitem &*demime&~=&~*&<&'extension&~list'&>
26283 .cindex "&%demime%& ACL condition"
26284 This condition is available only when Exim is compiled with the
26285 content-scanning extension. Its use is described in section
26286 &<<SECTdemimecond>>&.
26287
26288 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
26289 .cindex "&%dnslists%& ACL condition"
26290 .cindex "DNS list" "in ACL"
26291 .cindex "black list (DNS)"
26292 .cindex "&ACL;" "testing a DNS list"
26293 This condition checks for entries in DNS black lists. These are also known as
26294 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
26295 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
26296 different variants of this condition to describe briefly here. See sections
26297 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
26298
26299 .vitem &*domains&~=&~*&<&'domain&~list'&>
26300 .cindex "&%domains%& ACL condition"
26301 .cindex "domain" "ACL checking"
26302 .cindex "&ACL;" "testing a recipient domain"
26303 .vindex "&$domain_data$&"
26304 This condition is relevant only after a RCPT command. It checks that the domain
26305 of the recipient address is in the domain list. If percent-hack processing is
26306 enabled, it is done before this test is done. If the check succeeds with a
26307 lookup, the result of the lookup is placed in &$domain_data$& until the next
26308 &%domains%& test.
26309
26310 &*Note carefully*& (because many people seem to fall foul of this): you cannot
26311 use &%domains%& in a DATA ACL.
26312
26313
26314 .vitem &*encrypted&~=&~*&<&'string&~list'&>
26315 .cindex "&%encrypted%& ACL condition"
26316 .cindex "encryption" "checking in an ACL"
26317 .cindex "&ACL;" "testing for encryption"
26318 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
26319 name of the cipher suite in use is tested against the list. To test for
26320 encryption without testing for any specific cipher suite(s), set
26321 .code
26322 encrypted = *
26323 .endd
26324
26325
26326 .vitem &*hosts&~=&~*&<&'&~host&~list'&>
26327 .cindex "&%hosts%& ACL condition"
26328 .cindex "host" "ACL checking"
26329 .cindex "&ACL;" "testing the client host"
26330 This condition tests that the calling host matches the host list. If you have
26331 name lookups or wildcarded host names and IP addresses in the same host list,
26332 you should normally put the IP addresses first. For example, you could have:
26333 .code
26334 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
26335 .endd
26336 The lookup in this example uses the host name for its key. This is implied by
26337 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
26338 and it wouldn't matter which way round you had these two items.)
26339
26340 The reason for the problem with host names lies in the left-to-right way that
26341 Exim processes lists. It can test IP addresses without doing any DNS lookups,
26342 but when it reaches an item that requires a host name, it fails if it cannot
26343 find a host name to compare with the pattern. If the above list is given in the
26344 opposite order, the &%accept%& statement fails for a host whose name cannot be
26345 found, even if its IP address is 10.9.8.7.
26346
26347 If you really do want to do the name check first, and still recognize the IP
26348 address even if the name lookup fails, you can rewrite the ACL like this:
26349 .code
26350 accept hosts = dbm;/etc/friendly/hosts
26351 accept hosts = 10.9.8.7
26352 .endd
26353 The default action on failing to find the host name is to assume that the host
26354 is not in the list, so the first &%accept%& statement fails. The second
26355 statement can then check the IP address.
26356
26357 .vindex "&$host_data$&"
26358 If a &%hosts%& condition is satisfied by means of a lookup, the result
26359 of the lookup is made available in the &$host_data$& variable. This
26360 allows you, for example, to set up a statement like this:
26361 .code
26362 deny  hosts = net-lsearch;/some/file
26363 message = $host_data
26364 .endd
26365 which gives a custom error message for each denied host.
26366
26367 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
26368 .cindex "&%local_parts%& ACL condition"
26369 .cindex "local part" "ACL checking"
26370 .cindex "&ACL;" "testing a local part"
26371 .vindex "&$local_part_data$&"
26372 This condition is relevant only after a RCPT command. It checks that the local
26373 part of the recipient address is in the list. If percent-hack processing is
26374 enabled, it is done before this test. If the check succeeds with a lookup, the
26375 result of the lookup is placed in &$local_part_data$&, which remains set until
26376 the next &%local_parts%& test.
26377
26378 .vitem &*malware&~=&~*&<&'option'&>
26379 .cindex "&%malware%& ACL condition"
26380 .cindex "&ACL;" "virus scanning"
26381 .cindex "&ACL;" "scanning for viruses"
26382 This condition is available only when Exim is compiled with the
26383 content-scanning extension. It causes the incoming message to be scanned for
26384 viruses. For details, see chapter &<<CHAPexiscan>>&.
26385
26386 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
26387 .cindex "&%mime_regex%& ACL condition"
26388 .cindex "&ACL;" "testing by regex matching"
26389 This condition is available only when Exim is compiled with the
26390 content-scanning extension, and it is allowed only in the ACL defined by
26391 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
26392 with any of the regular expressions. For details, see chapter
26393 &<<CHAPexiscan>>&.
26394
26395 .vitem &*ratelimit&~=&~*&<&'parameters'&>
26396 .cindex "rate limiting"
26397 This condition can be used to limit the rate at which a user or host submits
26398 messages. Details are given in section &<<SECTratelimiting>>&.
26399
26400 .vitem &*recipients&~=&~*&<&'address&~list'&>
26401 .cindex "&%recipients%& ACL condition"
26402 .cindex "recipient" "ACL checking"
26403 .cindex "&ACL;" "testing a recipient"
26404 This condition is relevant only after a RCPT command. It checks the entire
26405 recipient address against a list of recipients.
26406
26407 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
26408 .cindex "&%regex%& ACL condition"
26409 .cindex "&ACL;" "testing by regex matching"
26410 This condition is available only when Exim is compiled with the
26411 content-scanning extension, and is available only in the DATA, MIME, and
26412 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
26413 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
26414
26415 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
26416 .cindex "&%sender_domains%& ACL condition"
26417 .cindex "sender" "ACL checking"
26418 .cindex "&ACL;" "testing a sender domain"
26419 .vindex "&$domain$&"
26420 .vindex "&$sender_address_domain$&"
26421 This condition tests the domain of the sender of the message against the given
26422 domain list. &*Note*&: The domain of the sender address is in
26423 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
26424 of this condition. This is an exception to the general rule for testing domain
26425 lists. It is done this way so that, if this condition is used in an ACL for a
26426 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
26427 influence the sender checking.
26428
26429 &*Warning*&: It is a bad idea to use this condition on its own as a control on
26430 relaying, because sender addresses are easily, and commonly, forged.
26431
26432 .vitem &*senders&~=&~*&<&'address&~list'&>
26433 .cindex "&%senders%& ACL condition"
26434 .cindex "sender" "ACL checking"
26435 .cindex "&ACL;" "testing a sender"
26436 This condition tests the sender of the message against the given list. To test
26437 for a bounce message, which has an empty sender, set
26438 .code
26439 senders = :
26440 .endd
26441 &*Warning*&: It is a bad idea to use this condition on its own as a control on
26442 relaying, because sender addresses are easily, and commonly, forged.
26443
26444 .vitem &*spam&~=&~*&<&'username'&>
26445 .cindex "&%spam%& ACL condition"
26446 .cindex "&ACL;" "scanning for spam"
26447 This condition is available only when Exim is compiled with the
26448 content-scanning extension. It causes the incoming message to be scanned by
26449 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
26450
26451 .vitem &*verify&~=&~certificate*&
26452 .cindex "&%verify%& ACL condition"
26453 .cindex "TLS" "client certificate verification"
26454 .cindex "certificate" "verification of client"
26455 .cindex "&ACL;" "certificate verification"
26456 .cindex "&ACL;" "testing a TLS certificate"
26457 This condition is true in an SMTP session if the session is encrypted, and a
26458 certificate was received from the client, and the certificate was verified. The
26459 server requests a certificate only if the client matches &%tls_verify_hosts%&
26460 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
26461
26462 .vitem &*verify&~=&~csa*&
26463 .cindex "CSA verification"
26464 This condition checks whether the sending host (the client) is authorized to
26465 send email. Details of how this works are given in section
26466 &<<SECTverifyCSA>>&.
26467
26468 .vitem &*verify&~=&~header_sender/*&<&'options'&>
26469 .cindex "&%verify%& ACL condition"
26470 .cindex "&ACL;" "verifying sender in the header"
26471 .cindex "header lines" "verifying the sender in"
26472 .cindex "sender" "verifying in header"
26473 .cindex "verifying" "sender in header"
26474 This condition is relevant only in an ACL that is run after a message has been
26475 received, that is, in an ACL specified by &%acl_smtp_data%& or
26476 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
26477 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
26478 is loosely thought of as a &"sender"& address (hence the name of the test).
26479 However, an address that appears in one of these headers need not be an address
26480 that accepts bounce messages; only sender addresses in envelopes are required
26481 to accept bounces. Therefore, if you use the callout option on this check, you
26482 might want to arrange for a non-empty address in the MAIL command.
26483
26484 Details of address verification and the options are given later, starting at
26485 section &<<SECTaddressverification>>& (callouts are described in section
26486 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
26487 condition to restrict it to bounce messages only:
26488 .code
26489 deny    senders = :
26490         message = A valid sender header is required for bounces
26491        !verify  = header_sender
26492 .endd
26493
26494 .vitem &*verify&~=&~header_syntax*&
26495 .cindex "&%verify%& ACL condition"
26496 .cindex "&ACL;" "verifying header syntax"
26497 .cindex "header lines" "verifying syntax"
26498 .cindex "verifying" "header syntax"
26499 This condition is relevant only in an ACL that is run after a message has been
26500 received, that is, in an ACL specified by &%acl_smtp_data%& or
26501 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
26502 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
26503 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
26504 permitted only in locally generated messages and from hosts that match
26505 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26506 appropriate.
26507
26508 Note that this condition is a syntax check only. However, a common spamming
26509 ploy used to be to send syntactically invalid headers such as
26510 .code
26511 To: @
26512 .endd
26513 and this condition can be used to reject such messages, though they are not as
26514 common as they used to be.
26515
26516 .vitem &*verify&~=&~helo*&
26517 .cindex "&%verify%& ACL condition"
26518 .cindex "&ACL;" "verifying HELO/EHLO"
26519 .cindex "HELO" "verifying"
26520 .cindex "EHLO" "verifying"
26521 .cindex "verifying" "EHLO"
26522 .cindex "verifying" "HELO"
26523 This condition is true if a HELO or EHLO command has been received from the
26524 client host, and its contents have been verified. If there has been no previous
26525 attempt to verify the HELO/EHLO contents, it is carried out when this
26526 condition is encountered. See the description of the &%helo_verify_hosts%& and
26527 &%helo_try_verify_hosts%& options for details of how to request verification
26528 independently of this condition.
26529
26530 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
26531 option), this condition is always true.
26532
26533
26534 .vitem &*verify&~=&~not_blind*&
26535 .cindex "verifying" "not blind"
26536 .cindex "bcc recipients, verifying none"
26537 This condition checks that there are no blind (bcc) recipients in the message.
26538 Every envelope recipient must appear either in a &'To:'& header line or in a
26539 &'Cc:'& header line for this condition to be true. Local parts are checked
26540 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
26541 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
26542 used only in a DATA or non-SMTP ACL.
26543
26544 There are, of course, many legitimate messages that make use of blind (bcc)
26545 recipients. This check should not be used on its own for blocking messages.
26546
26547
26548 .vitem &*verify&~=&~recipient/*&<&'options'&>
26549 .cindex "&%verify%& ACL condition"
26550 .cindex "&ACL;" "verifying recipient"
26551 .cindex "recipient" "verifying"
26552 .cindex "verifying" "recipient"
26553 .vindex "&$address_data$&"
26554 This condition is relevant only after a RCPT command. It verifies the current
26555 recipient. Details of address verification are given later, starting at section
26556 &<<SECTaddressverification>>&. After a recipient has been verified, the value
26557 of &$address_data$& is the last value that was set while routing the address.
26558 This applies even if the verification fails. When an address that is being
26559 verified is redirected to a single address, verification continues with the new
26560 address, and in that case, the subsequent value of &$address_data$& is the
26561 value for the child address.
26562
26563 .vitem &*verify&~=&~reverse_host_lookup*&
26564 .cindex "&%verify%& ACL condition"
26565 .cindex "&ACL;" "verifying host reverse lookup"
26566 .cindex "host" "verifying reverse lookup"
26567 This condition ensures that a verified host name has been looked up from the IP
26568 address of the client host. (This may have happened already if the host name
26569 was needed for checking a host list, or if the host matched &%host_lookup%&.)
26570 Verification ensures that the host name obtained from a reverse DNS lookup, or
26571 one of its aliases, does, when it is itself looked up in the DNS, yield the
26572 original IP address.
26573
26574 If this condition is used for a locally generated message (that is, when there
26575 is no client host involved), it always succeeds.
26576
26577 .vitem &*verify&~=&~sender/*&<&'options'&>
26578 .cindex "&%verify%& ACL condition"
26579 .cindex "&ACL;" "verifying sender"
26580 .cindex "sender" "verifying"
26581 .cindex "verifying" "sender"
26582 This condition is relevant only after a MAIL or RCPT command, or after a
26583 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
26584 the message's sender is empty (that is, this is a bounce message), the
26585 condition is true. Otherwise, the sender address is verified.
26586
26587 .vindex "&$address_data$&"
26588 .vindex "&$sender_address_data$&"
26589 If there is data in the &$address_data$& variable at the end of routing, its
26590 value is placed in &$sender_address_data$& at the end of verification. This
26591 value can be used in subsequent conditions and modifiers in the same ACL
26592 statement. It does not persist after the end of the current statement. If you
26593 want to preserve the value for longer, you can save it in an ACL variable.
26594
26595 Details of verification are given later, starting at section
26596 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
26597 to avoid doing it more than once per message.
26598
26599 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
26600 .cindex "&%verify%& ACL condition"
26601 This is a variation of the previous option, in which a modified address is
26602 verified as a sender.
26603 .endlist
26604
26605
26606
26607 .section "Using DNS lists" "SECTmorednslists"
26608 .cindex "DNS list" "in ACL"
26609 .cindex "black list (DNS)"
26610 .cindex "&ACL;" "testing a DNS list"
26611 In its simplest form, the &%dnslists%& condition tests whether the calling host
26612 is on at least one of a number of DNS lists by looking up the inverted IP
26613 address in one or more DNS domains. (Note that DNS list domains are not mail
26614 domains, so the &`+`& syntax for named lists doesn't work - it is used for
26615 special options instead.) For example, if the calling host's IP
26616 address is 192.168.62.43, and the ACL statement is
26617 .code
26618 deny dnslists = blackholes.mail-abuse.org : \
26619                 dialups.mail-abuse.org
26620 .endd
26621 the following records are looked up:
26622 .code
26623 43.62.168.192.blackholes.mail-abuse.org
26624 43.62.168.192.dialups.mail-abuse.org
26625 .endd
26626 As soon as Exim finds an existing DNS record, processing of the list stops.
26627 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
26628 to test that a host is on more than one list (an &"and"& conjunction), you can
26629 use two separate conditions:
26630 .code
26631 deny dnslists = blackholes.mail-abuse.org
26632      dnslists = dialups.mail-abuse.org
26633 .endd
26634 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
26635 behaves as if the host does not match the list item, that is, as if the DNS
26636 record does not exist. If there are further items in the DNS list, they are
26637 processed.
26638
26639 This is usually the required action when &%dnslists%& is used with &%deny%&
26640 (which is the most common usage), because it prevents a DNS failure from
26641 blocking mail. However, you can change this behaviour by putting one of the
26642 following special items in the list:
26643 .display
26644 &`+include_unknown `&   behave as if the item is on the list
26645 &`+exclude_unknown `&   behave as if the item is not on the list (default)
26646 &`+defer_unknown   `&   give a temporary error
26647 .endd
26648 .cindex "&`+include_unknown`&"
26649 .cindex "&`+exclude_unknown`&"
26650 .cindex "&`+defer_unknown`&"
26651 Each of these applies to any subsequent items on the list. For example:
26652 .code
26653 deny dnslists = +defer_unknown : foo.bar.example
26654 .endd
26655 Testing the list of domains stops as soon as a match is found. If you want to
26656 warn for one list and block for another, you can use two different statements:
26657 .code
26658 deny  dnslists = blackholes.mail-abuse.org
26659 warn  message  = X-Warn: sending host is on dialups list
26660       dnslists = dialups.mail-abuse.org
26661 .endd
26662 DNS list lookups are cached by Exim for the duration of the SMTP session,
26663 so a lookup based on the IP address is done at most once for any incoming
26664 connection. Exim does not share information between multiple incoming
26665 connections (but your local name server cache should be active).
26666
26667
26668
26669 .section "Specifying the IP address for a DNS list lookup" "SECID201"
26670 .cindex "DNS list" "keyed by explicit IP address"
26671 By default, the IP address that is used in a DNS list lookup is the IP address
26672 of the calling host. However, you can specify another IP address by listing it
26673 after the domain name, introduced by a slash. For example:
26674 .code
26675 deny dnslists = black.list.tld/192.168.1.2
26676 .endd
26677 This feature is not very helpful with explicit IP addresses; it is intended for
26678 use with IP addresses that are looked up, for example, the IP addresses of the
26679 MX hosts or nameservers of an email sender address. For an example, see section
26680 &<<SECTmulkeyfor>>& below.
26681
26682
26683
26684
26685 .section "DNS lists keyed on domain names" "SECID202"
26686 .cindex "DNS list" "keyed by domain name"
26687 There are some lists that are keyed on domain names rather than inverted IP
26688 addresses (see for example the &'domain based zones'& link at
26689 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
26690 with these lists. You can change the name that is looked up in a DNS list by
26691 listing it after the domain name, introduced by a slash. For example,
26692 .code
26693 deny  message  = Sender's domain is listed at $dnslist_domain
26694       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
26695 .endd
26696 This particular example is useful only in ACLs that are obeyed after the
26697 RCPT or DATA commands, when a sender address is available. If (for
26698 example) the message's sender is &'user@tld.example'& the name that is looked
26699 up by this example is
26700 .code
26701 tld.example.dsn.rfc-ignorant.org
26702 .endd
26703 A single &%dnslists%& condition can contain entries for both names and IP
26704 addresses. For example:
26705 .code
26706 deny dnslists = sbl.spamhaus.org : \
26707                 dsn.rfc-ignorant.org/$sender_address_domain
26708 .endd
26709 The first item checks the sending host's IP address; the second checks a domain
26710 name. The whole condition is true if either of the DNS lookups succeeds.
26711
26712
26713
26714
26715 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
26716 .cindex "DNS list" "multiple keys for"
26717 The syntax described above for looking up explicitly-defined values (either
26718 names or IP addresses) in a DNS blacklist is a simplification. After the domain
26719 name for the DNS list, what follows the slash can in fact be a list of items.
26720 As with all lists in Exim, the default separator is a colon. However, because
26721 this is a sublist within the list of DNS blacklist domains, it is necessary
26722 either to double the separators like this:
26723 .code
26724 dnslists = black.list.tld/name.1::name.2
26725 .endd
26726 or to change the separator character, like this:
26727 .code
26728 dnslists = black.list.tld/<;name.1;name.2
26729 .endd
26730 If an item in the list is an IP address, it is inverted before the DNS
26731 blacklist domain is appended. If it is not an IP address, no inversion
26732 occurs. Consider this condition:
26733 .code
26734 dnslists = black.list.tld/<;192.168.1.2;a.domain
26735 .endd
26736 The DNS lookups that occur are:
26737 .code
26738 2.1.168.192.black.list.tld
26739 a.domain.black.list.tld
26740 .endd
26741 Once a DNS record has been found (that matches a specific IP return
26742 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
26743 are done. If there is a temporary DNS error, the rest of the sublist of domains
26744 or IP addresses is tried. A temporary error for the whole dnslists item occurs
26745 only if no other DNS lookup in this sublist succeeds. In other words, a
26746 successful lookup for any of the items in the sublist overrides a temporary
26747 error for a previous item.
26748
26749 The ability to supply a list of items after the slash is in some sense just a
26750 syntactic convenience. These two examples have the same effect:
26751 .code
26752 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
26753 dnslists = black.list.tld/a.domain::b.domain
26754 .endd
26755 However, when the data for the list is obtained from a lookup, the second form
26756 is usually much more convenient. Consider this example:
26757 .code
26758 deny message  = The mail servers for the domain \
26759                 $sender_address_domain \
26760                 are listed at $dnslist_domain ($dnslist_value); \
26761                 see $dnslist_text.
26762      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
26763                                    ${lookup dnsdb {>|mxh=\
26764                                    $sender_address_domain} }} }
26765 .endd
26766 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
26767 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
26768 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
26769 of expanding the condition might be something like this:
26770 .code
26771 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
26772 .endd
26773 Thus, this example checks whether or not the IP addresses of the sender
26774 domain's mail servers are on the Spamhaus black list.
26775
26776 The key that was used for a successful DNS list lookup is put into the variable
26777 &$dnslist_matched$& (see section &<<SECID204>>&).
26778
26779
26780
26781
26782 .section "Data returned by DNS lists" "SECID203"
26783 .cindex "DNS list" "data returned from"
26784 DNS lists are constructed using address records in the DNS. The original RBL
26785 just used the address 127.0.0.1 on the right hand side of each record, but the
26786 RBL+ list and some other lists use a number of values with different meanings.
26787 The values used on the RBL+ list are:
26788 .display
26789 127.1.0.1  RBL
26790 127.1.0.2  DUL
26791 127.1.0.3  DUL and RBL
26792 127.1.0.4  RSS
26793 127.1.0.5  RSS and RBL
26794 127.1.0.6  RSS and DUL
26795 127.1.0.7  RSS and DUL and RBL
26796 .endd
26797 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
26798 different values. Some DNS lists may return more than one address record;
26799 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
26800
26801
26802 .section "Variables set from DNS lists" "SECID204"
26803 .cindex "expansion" "variables, set from DNS list"
26804 .cindex "DNS list" "variables set from"
26805 .vindex "&$dnslist_domain$&"
26806 .vindex "&$dnslist_matched$&"
26807 .vindex "&$dnslist_text$&"
26808 .vindex "&$dnslist_value$&"
26809 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
26810 the name of the overall domain that matched (for example,
26811 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
26812 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
26813 the DNS record. When the key is an IP address, it is not reversed in
26814 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
26815 cases, for example:
26816 .code
26817 deny dnslists = spamhaus.example
26818 .endd
26819 the key is also available in another variable (in this case,
26820 &$sender_host_address$&). In more complicated cases, however, this is not true.
26821 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
26822 might generate a dnslists lookup like this:
26823 .code
26824 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
26825 .endd
26826 If this condition succeeds, the value in &$dnslist_matched$& might be
26827 &`192.168.6.7`& (for example).
26828
26829 If more than one address record is returned by the DNS lookup, all the IP
26830 addresses are included in &$dnslist_value$&, separated by commas and spaces.
26831 The variable &$dnslist_text$& contains the contents of any associated TXT
26832 record. For lists such as RBL+ the TXT record for a merged entry is often not
26833 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
26834 information.
26835
26836 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
26837 &-- although these appear before the condition in the ACL, they are not
26838 expanded until after it has failed. For example:
26839 .code
26840 deny    hosts = !+local_networks
26841         message = $sender_host_address is listed \
26842                   at $dnslist_domain
26843         dnslists = rbl-plus.mail-abuse.example
26844 .endd
26845
26846
26847
26848 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
26849 .cindex "DNS list" "matching specific returned data"
26850 You can add an equals sign and an IP address after a &%dnslists%& domain name
26851 in order to restrict its action to DNS records with a matching right hand side.
26852 For example,
26853 .code
26854 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
26855 .endd
26856 rejects only those hosts that yield 127.0.0.2. Without this additional data,
26857 any address record is considered to be a match. For the moment, we assume
26858 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
26859 describes how multiple records are handled.
26860
26861 More than one IP address may be given for checking, using a comma as a
26862 separator. These are alternatives &-- if any one of them matches, the
26863 &%dnslists%& condition is true. For example:
26864 .code
26865 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
26866 .endd
26867 If you want to specify a constraining address list and also specify names or IP
26868 addresses to be looked up, the constraining address list must be specified
26869 first. For example:
26870 .code
26871 deny dnslists = dsn.rfc-ignorant.org\
26872                 =127.0.0.2/$sender_address_domain
26873 .endd
26874
26875 If the character &`&&`& is used instead of &`=`&, the comparison for each
26876 listed IP address is done by a bitwise &"and"& instead of by an equality test.
26877 In other words, the listed addresses are used as bit masks. The comparison is
26878 true if all the bits in the mask are present in the address that is being
26879 tested. For example:
26880 .code
26881 dnslists = a.b.c&0.0.0.3
26882 .endd
26883 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
26884 want to test whether one bit or another bit is present (as opposed to both
26885 being present), you must use multiple values. For example:
26886 .code
26887 dnslists = a.b.c&0.0.0.1,0.0.0.2
26888 .endd
26889 matches if the final component of the address is an odd number or two times
26890 an odd number.
26891
26892
26893
26894 .section "Negated DNS matching conditions" "SECID205"
26895 You can supply a negative list of IP addresses as part of a &%dnslists%&
26896 condition. Whereas
26897 .code
26898 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
26899 .endd
26900 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
26901 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
26902 .code
26903 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
26904 .endd
26905 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
26906 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
26907 words, the result of the test is inverted if an exclamation mark appears before
26908 the &`=`& (or the &`&&`&) sign.
26909
26910 &*Note*&: This kind of negation is not the same as negation in a domain,
26911 host, or address list (which is why the syntax is different).
26912
26913 If you are using just one list, the negation syntax does not gain you much. The
26914 previous example is precisely equivalent to
26915 .code
26916 deny  dnslists = a.b.c
26917      !dnslists = a.b.c=127.0.0.2,127.0.0.3
26918 .endd
26919 However, if you are using multiple lists, the negation syntax is clearer.
26920 Consider this example:
26921 .code
26922 deny  dnslists = sbl.spamhaus.org : \
26923                  list.dsbl.org : \
26924                  dnsbl.njabl.org!=127.0.0.3 : \
26925                  relays.ordb.org
26926 .endd
26927 Using only positive lists, this would have to be:
26928 .code
26929 deny  dnslists = sbl.spamhaus.org : \
26930                  list.dsbl.org
26931 deny  dnslists = dnsbl.njabl.org
26932      !dnslists = dnsbl.njabl.org=127.0.0.3
26933 deny  dnslists = relays.ordb.org
26934 .endd
26935 which is less clear, and harder to maintain.
26936
26937
26938
26939
26940 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
26941 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
26942 thereby providing more than one IP address. When an item in a &%dnslists%& list
26943 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
26944 the match to specific results from the DNS lookup, there are two ways in which
26945 the checking can be handled. For example, consider the condition:
26946 .code
26947 dnslists = a.b.c=127.0.0.1
26948 .endd
26949 What happens if the DNS lookup for the incoming IP address yields both
26950 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
26951 condition true because at least one given value was found, or is it false
26952 because at least one of the found values was not listed? And how does this
26953 affect negated conditions? Both possibilities are provided for with the help of
26954 additional separators &`==`& and &`=&&`&.
26955
26956 .ilist
26957 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
26958 IP addresses matches one of the listed addresses. For the example above, the
26959 condition is true because 127.0.0.1 matches.
26960 .next
26961 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
26962 looked up IP addresses matches one of the listed addresses. If the condition is
26963 changed to:
26964 .code
26965 dnslists = a.b.c==127.0.0.1
26966 .endd
26967 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
26968 false because 127.0.0.2 is not listed. You would need to have:
26969 .code
26970 dnslists = a.b.c==127.0.0.1,127.0.0.2
26971 .endd
26972 for the condition to be true.
26973 .endlist
26974
26975 When &`!`& is used to negate IP address matching, it inverts the result, giving
26976 the precise opposite of the behaviour above. Thus:
26977 .ilist
26978 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
26979 addresses matches one of the listed addresses. Consider:
26980 .code
26981 dnslists = a.b.c!&0.0.0.1
26982 .endd
26983 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
26984 false because 127.0.0.1 matches.
26985 .next
26986 If &`!==`& or &`!=&&`& is used, the condition is true there is at least one
26987 looked up IP address that does not match. Consider:
26988 .code
26989 dnslists = a.b.c!=&0.0.0.1
26990 .endd
26991 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
26992 true, because 127.0.0.2 does not match. You would need to have:
26993 .code
26994 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
26995 .endd
26996 for the condition to be false.
26997 .endlist
26998 When the DNS lookup yields only a single IP address, there is no difference
26999 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
27000
27001
27002
27003
27004 .section "Detailed information from merged DNS lists" "SECTmordetinf"
27005 .cindex "DNS list" "information from merged"
27006 When the facility for restricting the matching IP values in a DNS list is used,
27007 the text from the TXT record that is set in &$dnslist_text$& may not reflect
27008 the true reason for rejection. This happens when lists are merged and the IP
27009 address in the A record is used to distinguish them; unfortunately there is
27010 only one TXT record. One way round this is not to use merged lists, but that
27011 can be inefficient because it requires multiple DNS lookups where one would do
27012 in the vast majority of cases when the host of interest is not on any of the
27013 lists.
27014
27015 A less inefficient way of solving this problem is available. If
27016 two domain names, comma-separated, are given, the second is used first to
27017 do an initial check, making use of any IP value restrictions that are set.
27018 If there is a match, the first domain is used, without any IP value
27019 restrictions, to get the TXT record. As a byproduct of this, there is also
27020 a check that the IP being tested is indeed on the first list. The first
27021 domain is the one that is put in &$dnslist_domain$&. For example:
27022 .code
27023 reject message  = \
27024          rejected because $sender_host_address is blacklisted \
27025          at $dnslist_domain\n$dnslist_text
27026        dnslists = \
27027          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
27028          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27029 .endd
27030 For the first blacklist item, this starts by doing a lookup in
27031 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
27032 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
27033 value, and as long as something is found, it looks for the corresponding TXT
27034 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
27035 The second blacklist item is processed similarly.
27036
27037 If you are interested in more than one merged list, the same list must be
27038 given several times, but because the results of the DNS lookups are cached,
27039 the DNS calls themselves are not repeated. For example:
27040 .code
27041 reject dnslists = \
27042          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
27043          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
27044          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
27045          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27046 .endd
27047 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
27048 values matches (or if no record is found), this is the only lookup that is
27049 done. Only if there is a match is one of the more specific lists consulted.
27050
27051
27052
27053 .section "DNS lists and IPv6" "SECTmorednslistslast"
27054 .cindex "IPv6" "DNS black lists"
27055 .cindex "DNS list" "IPv6 usage"
27056 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
27057 nibble by nibble. For example, if the calling host's IP address is
27058 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
27059 .code
27060 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
27061   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
27062 .endd
27063 (split over two lines here to fit on the page). Unfortunately, some of the DNS
27064 lists contain wildcard records, intended for IPv4, that interact badly with
27065 IPv6. For example, the DNS entry
27066 .code
27067 *.3.some.list.example.    A    127.0.0.1
27068 .endd
27069 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
27070 Unfortunately, it also matches the entire 3::/4 IPv6 network.
27071
27072 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
27073 &%condition%& condition, as in this example:
27074 .code
27075 deny   condition = ${if isip4{$sender_host_address}}
27076        dnslists  = some.list.example
27077 .endd
27078
27079 .section "Rate limiting incoming messages" "SECTratelimiting"
27080 .cindex "rate limiting" "client sending"
27081 .cindex "limiting client sending rates"
27082 .oindex "&%smtp_ratelimit_*%&"
27083 The &%ratelimit%& ACL condition can be used to measure and control the rate at
27084 which clients can send email. This is more powerful than the
27085 &%smtp_ratelimit_*%& options, because those options control the rate of
27086 commands in a single SMTP session only, whereas the &%ratelimit%& condition
27087 works across all connections (concurrent and sequential) from the same client
27088 host. The syntax of the &%ratelimit%& condition is:
27089 .display
27090 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
27091 .endd
27092 If the average client sending rate is less than &'m'& messages per time
27093 period &'p'& then the condition is false; otherwise it is true.
27094
27095 As a side-effect, the &%ratelimit%& condition sets the expansion variable
27096 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
27097 configured value of &'m'&, and &$sender_rate_period$& to the configured value
27098 of &'p'&.
27099
27100 The parameter &'p'& is the smoothing time constant, in the form of an Exim
27101 time interval, for example, &`8h`& for eight hours. A larger time constant
27102 means that it takes Exim longer to forget a client's past behaviour. The
27103 parameter &'m'& is the maximum number of messages that a client is permitted to
27104 send in each time interval. It also specifies the number of messages permitted
27105 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
27106 constant, you can allow a client to send more messages in a burst without
27107 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
27108 both small, messages must be sent at an even rate.
27109
27110 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
27111 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
27112 when deploying the &%ratelimit%& ACL condition. The script prints usage
27113 instructions when it is run with no arguments.
27114
27115 The key is used to look up the data for calculating the client's average
27116 sending rate. This data is stored in Exim's spool directory, alongside the
27117 retry and other hints databases. The default key is &$sender_host_address$&,
27118 which means Exim computes the sending rate of each client host IP address.
27119 By changing the key you can change how Exim identifies clients for the purpose
27120 of ratelimiting. For example, to limit the sending rate of each authenticated
27121 user, independent of the computer they are sending from, set the key to
27122 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
27123 example, &$authenticated_id$& is only meaningful if the client has
27124 authenticated (which you can check with the &%authenticated%& ACL condition).
27125
27126 The lookup key does not have to identify clients: If you want to limit the
27127 rate at which a recipient receives messages, you can use the key
27128 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
27129 ACL.
27130
27131 Internally, Exim appends the smoothing constant &'p'& and the options onto the
27132 lookup key because they alter the meaning of the stored data. This is not true
27133 for the limit &'m'&, so you can alter the configured maximum rate and Exim will
27134 still remember clients' past behaviour, but if you alter the other ratelimit
27135 parameters Exim forgets past behaviour.
27136
27137 Each &%ratelimit%& condition can have up to three options. One option
27138 specifies what Exim measures the rate of, and the second specifies how Exim
27139 handles excessively fast clients. The third option can be &`noupdate`&, to
27140 disable updating of the ratelimiting database (see section &<<rearatdat>>&).
27141 The options are separated by a slash, like the other parameters. They may
27142 appear in any order.
27143
27144 .section "Ratelimit options for what is being measured" "ratoptmea"
27145 The &%per_conn%& option limits the client's connection rate.
27146
27147 The &%per_mail%& option limits the client's rate of sending messages. This is
27148 the default if none of the &%per_*%& options is specified.
27149
27150 The &%per_byte%& option limits the sender's email bandwidth. Note that it is
27151 best to use this option in the DATA ACL; if it is used in an earlier ACL it
27152 relies on the SIZE parameter specified by the client in its MAIL command,
27153 which may be inaccurate or completely missing. You can follow the limit &'m'&
27154 in the configuration with K, M, or G to specify limits in kilobytes,
27155 megabytes, or gigabytes, respectively.
27156
27157 The &%per_rcpt%& option causes Exim to limit the rate at which
27158 recipients are accepted. To be effective, it would need to be used in
27159 either the &%acl_smtp_rcpt%& or the &%acl_not_smtp%& ACL. In the
27160 &%acl_smtp_rcpt%& ACL, the number of recipients is incremented by one.
27161 In the case of a locally submitted message in the &%acl_not_smtp%& ACL,
27162 the number of recipients is incremented by the &%$recipients_count%&
27163 for the entire message. Note that in either case the rate limiting
27164 engine will see a message with many recipients as a large high-speed
27165 burst.
27166
27167 The &%per_cmd%& option causes Exim to recompute the rate every time the
27168 condition is processed. This can be used to limit the SMTP command rate.
27169 This command is essentially an alias of &%per_rcpt%& to make it clear
27170 that the effect is to limit the rate at which individual commands,
27171 rather than recipients, are accepted.
27172
27173 .section "Ratelimit options for handling fast clients" "ratophanfas"
27174 If a client's average rate is greater than the maximum, the rate limiting
27175 engine can react in two possible ways, depending on the presence of the
27176 &%strict%& or &%leaky%& options. This is independent of the other
27177 counter-measures (such as rejecting the message) that may be specified by the
27178 rest of the ACL. The default mode is leaky, which avoids a sender's
27179 over-aggressive retry rate preventing it from getting any email through.
27180
27181 The &%strict%& option means that the client's recorded rate is always
27182 updated. The effect of this is that Exim measures the client's average rate
27183 of attempts to send email, which can be much higher than the maximum it is
27184 actually allowed. If the client is over the limit it may be subjected to
27185 counter-measures by the ACL until it slows down below the maximum rate. If
27186 the client stops attempting to send email for the time specified in the &'p'&
27187 parameter then its computed rate will decay exponentially to 37% of its peak
27188 value. You can work out the time (the number of smoothing periods) that a
27189 client is subjected to counter-measures after an over-limit burst with this
27190 formula:
27191 .code
27192         ln(peakrate/maxrate)
27193 .endd
27194 The &%leaky%& (default) option means that the client's recorded rate is not
27195 updated if it is above the limit. The effect of this is that Exim measures the
27196 client's average rate of successfully sent email, which cannot be greater than
27197 the maximum allowed. If the client is over the limit it may suffer some
27198 counter-measures (as specified in the ACL), but it will still be able to send
27199 email at the configured maximum rate, whatever the rate of its attempts. This
27200 is generally the better choice if you have clients that retry automatically.
27201
27202 .section "Using rate limiting" "useratlim"
27203 Exim's other ACL facilities are used to define what counter-measures are taken
27204 when the rate limit is exceeded. This might be anything from logging a warning
27205 (for example, while measuring existing sending rates in order to define
27206 policy), through time delays to slow down fast senders, up to rejecting the
27207 message. For example:
27208 .code
27209 # Log all senders' rates
27210 warn ratelimit = 0 / 1h / strict
27211      log_message = Sender rate $sender_rate / $sender_rate_period
27212
27213 # Slow down fast senders; note the need to truncate $sender_rate
27214 # at the decimal point.
27215 warn ratelimit = 100 / 1h / per_rcpt / strict
27216      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
27217                    $sender_rate_limit }s
27218
27219 # Keep authenticated users under control
27220 deny authenticated = *
27221      ratelimit = 100 / 1d / strict / $authenticated_id
27222
27223 # System-wide rate limit
27224 defer message = Sorry, too busy. Try again later.
27225      ratelimit = 10 / 1s / $primary_hostname
27226
27227 # Restrict incoming rate from each host, with a default
27228 # set using a macro and special cases looked up in a table.
27229 defer message = Sender rate exceeds $sender_rate_limit \
27230                messages per $sender_rate_period
27231      ratelimit = ${lookup {$sender_host_address} \
27232                    cdb {DB/ratelimits.cdb} \
27233                    {$value} {RATELIMIT} }
27234 .endd
27235 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
27236 especially with the &%per_rcpt%& option, you may suffer from a performance
27237 bottleneck caused by locking on the ratelimit hints database. Apart from
27238 making your ACLs less complicated, you can reduce the problem by using a
27239 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
27240 this means that Exim will lose its hints data after a reboot (including retry
27241 hints, the callout cache, and ratelimit data).
27242
27243
27244 .section "Reading ratelimit data without updating" "rearatdat"
27245 .cindex "rate limitint" "reading data without updating"
27246 If the &%noupdate%& option is present on a &%ratelimit%& ACL condition, Exim
27247 computes the rate and checks the limit as normal, but it does not update the
27248 saved data. This means that, in relevant ACLs, it is possible to lookup the
27249 existence of a specified (or auto-generated) ratelimit key without incrementing
27250 the ratelimit counter for that key. In order for this to be useful, another ACL
27251 entry must set the rate for the same key (otherwise it will always be zero).
27252 For example:
27253 .code
27254 acl_check_connect:
27255   deny ratelimit = 100 / 5m / strict / per_cmd / noupdate
27256        log_message = RATE: $sender_rate/$sender_rate_period \
27257                      (max $sender_rate_limit)
27258 .endd
27259 .display
27260 &'... some other logic and tests...'&
27261 .endd
27262 .code
27263 acl_check_mail:
27264   warn ratelimit = 100 / 5m / strict / per_cmd
27265        condition = ${if le{$sender_rate}{$sender_rate_limit}}
27266        logwrite  = RATE UPDATE: $sender_rate/$sender_rate_period \
27267                      (max $sender_rate_limit)
27268 .endd
27269 In this example, the rate is tested and used to deny access (when it is too
27270 high) in the connect ACL, but the actual computation of the remembered rate
27271 happens later, on a per-command basis, in another ACL.
27272
27273
27274
27275 .section "Address verification" "SECTaddressverification"
27276 .cindex "verifying address" "options for"
27277 .cindex "policy control" "address verification"
27278 Several of the &%verify%& conditions described in section
27279 &<<SECTaclconditions>>& cause addresses to be verified. Section
27280 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
27281 The verification conditions can be followed by options that modify the
27282 verification process. The options are separated from the keyword and from each
27283 other by slashes, and some of them contain parameters. For example:
27284 .code
27285 verify = sender/callout
27286 verify = recipient/defer_ok/callout=10s,defer_ok
27287 .endd
27288 The first stage of address verification, which always happens, is to run the
27289 address through the routers, in &"verify mode"&. Routers can detect the
27290 difference between verification and routing for delivery, and their actions can
27291 be varied by a number of generic options such as &%verify%& and &%verify_only%&
27292 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
27293 The available options are as follows:
27294
27295 .ilist
27296 If the &%callout%& option is specified, successful routing to one or more
27297 remote hosts is followed by a &"callout"& to those hosts as an additional
27298 check. Callouts and their sub-options are discussed in the next section.
27299 .next
27300 If there is a defer error while doing verification routing, the ACL
27301 normally returns &"defer"&. However, if you include &%defer_ok%& in the
27302 options, the condition is forced to be true instead. Note that this is a main
27303 verification option as well as a suboption for callouts.
27304 .next
27305 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
27306 discusses the reporting of sender address verification failures.
27307 .next
27308 The &%success_on_redirect%& option causes verification always to succeed
27309 immediately after a successful redirection. By default, if a redirection
27310 generates just one address, that address is also verified. See further
27311 discussion in section &<<SECTredirwhilveri>>&.
27312 .endlist
27313
27314 .cindex "verifying address" "differentiating failures"
27315 .vindex "&$recipient_verify_failure$&"
27316 .vindex "&$sender_verify_failure$&"
27317 .vindex "&$acl_verify_message$&"
27318 After an address verification failure, &$acl_verify_message$& contains the
27319 error message that is associated with the failure. It can be preserved by
27320 coding like this:
27321 .code
27322 warn  !verify = sender
27323        set acl_m0 = $acl_verify_message
27324 .endd
27325 If you are writing your own custom rejection message or log message when
27326 denying access, you can use this variable to include information about the
27327 verification failure.
27328
27329 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
27330 appropriate) contains one of the following words:
27331
27332 .ilist
27333 &%qualify%&: The address was unqualified (no domain), and the message
27334 was neither local nor came from an exempted host.
27335 .next
27336 &%route%&: Routing failed.
27337 .next
27338 &%mail%&: Routing succeeded, and a callout was attempted; rejection
27339 occurred at or before the MAIL command (that is, on initial
27340 connection, HELO, or MAIL).
27341 .next
27342 &%recipient%&: The RCPT command in a callout was rejected.
27343 .next
27344 &%postmaster%&: The postmaster check in a callout was rejected.
27345 .endlist
27346
27347 The main use of these variables is expected to be to distinguish between
27348 rejections of MAIL and rejections of RCPT in callouts.
27349
27350
27351
27352
27353 .section "Callout verification" "SECTcallver"
27354 .cindex "verifying address" "by callout"
27355 .cindex "callout" "verification"
27356 .cindex "SMTP" "callout verification"
27357 For non-local addresses, routing verifies the domain, but is unable to do any
27358 checking of the local part. There are situations where some means of verifying
27359 the local part is desirable. One way this can be done is to make an SMTP
27360 &'callback'& to a delivery host for the sender address or a &'callforward'& to
27361 a subsequent host for a recipient address, to see if the host accepts the
27362 address. We use the term &'callout'& to cover both cases. Note that for a
27363 sender address, the callback is not to the client host that is trying to
27364 deliver the message, but to one of the hosts that accepts incoming mail for the
27365 sender's domain.
27366
27367 Exim does not do callouts by default. If you want them to happen, you must
27368 request them by setting appropriate options on the &%verify%& condition, as
27369 described below. This facility should be used with care, because it can add a
27370 lot of resource usage to the cost of verifying an address. However, Exim does
27371 cache the results of callouts, which helps to reduce the cost. Details of
27372 caching are in section &<<SECTcallvercache>>&.
27373
27374 Recipient callouts are usually used only between hosts that are controlled by
27375 the same administration. For example, a corporate gateway host could use
27376 callouts to check for valid recipients on an internal mailserver. A successful
27377 callout does not guarantee that a real delivery to the address would succeed;
27378 on the other hand, a failing callout does guarantee that a delivery would fail.
27379
27380 If the &%callout%& option is present on a condition that verifies an address, a
27381 second stage of verification occurs if the address is successfully routed to
27382 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
27383 &(manualroute)& router, where the router specifies the hosts. However, if a
27384 router that does not set up hosts routes to an &(smtp)& transport with a
27385 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
27386 &%hosts_override%& set, its hosts are always used, whether or not the router
27387 supplies a host list.
27388
27389 The port that is used is taken from the transport, if it is specified and is a
27390 remote transport. (For routers that do verification only, no transport need be
27391 specified.) Otherwise, the default SMTP port is used. If a remote transport
27392 specifies an outgoing interface, this is used; otherwise the interface is not
27393 specified. Likewise, the text that is used for the HELO command is taken from
27394 the transport's &%helo_data%& option; if there is no transport, the value of
27395 &$smtp_active_hostname$& is used.
27396
27397 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
27398 test whether a bounce message could be delivered to the sender address. The
27399 following SMTP commands are sent:
27400 .display
27401 &`HELO `&<&'local host name'&>
27402 &`MAIL FROM:<>`&
27403 &`RCPT TO:`&<&'the address to be tested'&>
27404 &`QUIT`&
27405 .endd
27406 LHLO is used instead of HELO if the transport's &%protocol%& option is
27407 set to &"lmtp"&.
27408
27409 A recipient callout check is similar. By default, it also uses an empty address
27410 for the sender. This default is chosen because most hosts do not make use of
27411 the sender address when verifying a recipient. Using the same address means
27412 that a single cache entry can be used for each recipient. Some sites, however,
27413 do make use of the sender address when verifying. These are catered for by the
27414 &%use_sender%& and &%use_postmaster%& options, described in the next section.
27415
27416 If the response to the RCPT command is a 2&'xx'& code, the verification
27417 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
27418 Exim tries the next host, if any. If there is a problem with all the remote
27419 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
27420 &%callout%& option is given, in which case the condition is forced to succeed.
27421
27422 .cindex "SMTP" "output flushing, disabling for callout"
27423 A callout may take a little time. For this reason, Exim normally flushes SMTP
27424 output before performing a callout in an ACL, to avoid unexpected timeouts in
27425 clients when the SMTP PIPELINING extension is in use. The flushing can be
27426 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
27427
27428
27429
27430
27431 .section "Additional parameters for callouts" "CALLaddparcall"
27432 .cindex "callout" "additional parameters for"
27433 The &%callout%& option can be followed by an equals sign and a number of
27434 optional parameters, separated by commas. For example:
27435 .code
27436 verify = recipient/callout=10s,defer_ok
27437 .endd
27438 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
27439 separate verify options, is retained for backwards compatibility, but is now
27440 deprecated. The additional parameters for &%callout%& are as follows:
27441
27442
27443 .vlist
27444 .vitem <&'a&~time&~interval'&>
27445 .cindex "callout" "timeout, specifying"
27446 This specifies the timeout that applies for the callout attempt to each host.
27447 For example:
27448 .code
27449 verify = sender/callout=5s
27450 .endd
27451 The default is 30 seconds. The timeout is used for each response from the
27452 remote host. It is also used for the initial connection, unless overridden by
27453 the &%connect%& parameter.
27454
27455
27456 .vitem &*connect&~=&~*&<&'time&~interval'&>
27457 .cindex "callout" "connection timeout, specifying"
27458 This parameter makes it possible to set a different (usually smaller) timeout
27459 for making the SMTP connection. For example:
27460 .code
27461 verify = sender/callout=5s,connect=1s
27462 .endd
27463 If not specified, this timeout defaults to the general timeout value.
27464
27465 .vitem &*defer_ok*&
27466 .cindex "callout" "defer, action on"
27467 When this parameter is present, failure to contact any host, or any other kind
27468 of temporary error, is treated as success by the ACL. However, the cache is not
27469 updated in this circumstance.
27470
27471 .vitem &*fullpostmaster*&
27472 .cindex "callout" "full postmaster check"
27473 This operates like the &%postmaster%& option (see below), but if the check for
27474 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
27475 accordance with the specification in RFC 2821. The RFC states that the
27476 unqualified address &'postmaster'& should be accepted.
27477
27478
27479 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
27480 .cindex "callout" "sender when verifying header"
27481 When verifying addresses in header lines using the &%header_sender%&
27482 verification option, Exim behaves by default as if the addresses are envelope
27483 sender addresses from a message. Callout verification therefore tests to see
27484 whether a bounce message could be delivered, by using an empty address in the
27485 MAIL command. However, it is arguable that these addresses might never be used
27486 as envelope senders, and could therefore justifiably reject bounce messages
27487 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
27488 address to use in the MAIL command. For example:
27489 .code
27490 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
27491 .endd
27492 This parameter is available only for the &%header_sender%& verification option.
27493
27494
27495 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
27496 .cindex "callout" "overall timeout, specifying"
27497 This parameter sets an overall timeout for performing a callout verification.
27498 For example:
27499 .code
27500 verify = sender/callout=5s,maxwait=30s
27501 .endd
27502 This timeout defaults to four times the callout timeout for individual SMTP
27503 commands. The overall timeout applies when there is more than one host that can
27504 be tried. The timeout is checked before trying the next host. This prevents
27505 very long delays if there are a large number of hosts and all are timing out
27506 (for example, when network connections are timing out).
27507
27508
27509 .vitem &*no_cache*&
27510 .cindex "callout" "cache, suppressing"
27511 .cindex "caching callout, suppressing"
27512 When this parameter is given, the callout cache is neither read nor updated.
27513
27514 .vitem &*postmaster*&
27515 .cindex "callout" "postmaster; checking"
27516 When this parameter is set, a successful callout check is followed by a similar
27517 check for the local part &'postmaster'& at the same domain. If this address is
27518 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
27519 the postmaster check is recorded in a cache record; if it is a failure, this is
27520 used to fail subsequent callouts for the domain without a connection being
27521 made, until the cache record expires.
27522
27523 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
27524 The postmaster check uses an empty sender in the MAIL command by default.
27525 You can use this parameter to do a postmaster check using a different address.
27526 For example:
27527 .code
27528 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
27529 .endd
27530 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
27531 one overrides. The &%postmaster%& parameter is equivalent to this example:
27532 .code
27533 require  verify = sender/callout=postmaster_mailfrom=
27534 .endd
27535 &*Warning*&: The caching arrangements for postmaster checking do not take
27536 account of the sender address. It is assumed that either the empty address or
27537 a fixed non-empty address will be used. All that Exim remembers is that the
27538 postmaster check for the domain succeeded or failed.
27539
27540
27541 .vitem &*random*&
27542 .cindex "callout" "&""random""& check"
27543 When this parameter is set, before doing the normal callout check, Exim does a
27544 check for a &"random"& local part at the same domain. The local part is not
27545 really random &-- it is defined by the expansion of the option
27546 &%callout_random_local_part%&, which defaults to
27547 .code
27548 $primary_host_name-$tod_epoch-testing
27549 .endd
27550 The idea here is to try to determine whether the remote host accepts all local
27551 parts without checking. If it does, there is no point in doing callouts for
27552 specific local parts. If the &"random"& check succeeds, the result is saved in
27553 a cache record, and used to force the current and subsequent callout checks to
27554 succeed without a connection being made, until the cache record expires.
27555
27556 .vitem &*use_postmaster*&
27557 .cindex "callout" "sender for recipient check"
27558 This parameter applies to recipient callouts only. For example:
27559 .code
27560 deny  !verify = recipient/callout=use_postmaster
27561 .endd
27562 .vindex "&$qualify_domain$&"
27563 It causes a non-empty postmaster address to be used in the MAIL command when
27564 performing the callout for the recipient, and also for a &"random"& check if
27565 that is configured. The local part of the address is &`postmaster`& and the
27566 domain is the contents of &$qualify_domain$&.
27567
27568 .vitem &*use_sender*&
27569 This option applies to recipient callouts only. For example:
27570 .code
27571 require  verify = recipient/callout=use_sender
27572 .endd
27573 It causes the message's actual sender address to be used in the MAIL
27574 command when performing the callout, instead of an empty address. There is no
27575 need to use this option unless you know that the called hosts make use of the
27576 sender when checking recipients. If used indiscriminately, it reduces the
27577 usefulness of callout caching.
27578 .endlist
27579
27580 If you use any of the parameters that set a non-empty sender for the MAIL
27581 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
27582 &%use_sender%&), you should think about possible loops. Recipient checking is
27583 usually done between two hosts that are under the same management, and the host
27584 that receives the callouts is not normally configured to do callouts itself.
27585 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
27586 these circumstances.
27587
27588 However, if you use a non-empty sender address for a callout to an arbitrary
27589 host, there is the likelihood that the remote host will itself initiate a
27590 callout check back to your host. As it is checking what appears to be a message
27591 sender, it is likely to use an empty address in MAIL, thus avoiding a
27592 callout loop. However, to be on the safe side it would be best to set up your
27593 own ACLs so that they do not do sender verification checks when the recipient
27594 is the address you use for header sender or postmaster callout checking.
27595
27596 Another issue to think about when using non-empty senders for callouts is
27597 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
27598 by the sender/recipient combination; thus, for any given recipient, many more
27599 actual callouts are performed than when an empty sender or postmaster is used.
27600
27601
27602
27603
27604 .section "Callout caching" "SECTcallvercache"
27605 .cindex "hints database" "callout cache"
27606 .cindex "callout" "cache, description of"
27607 .cindex "caching" "callout"
27608 Exim caches the results of callouts in order to reduce the amount of resources
27609 used, unless you specify the &%no_cache%& parameter with the &%callout%&
27610 option. A hints database called &"callout"& is used for the cache. Two
27611 different record types are used: one records the result of a callout check for
27612 a specific address, and the other records information that applies to the
27613 entire domain (for example, that it accepts the local part &'postmaster'&).
27614
27615 When an original callout fails, a detailed SMTP error message is given about
27616 the failure. However, for subsequent failures use the cache data, this message
27617 is not available.
27618
27619 The expiry times for negative and positive address cache records are
27620 independent, and can be set by the global options &%callout_negative_expire%&
27621 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
27622
27623 If a host gives a negative response to an SMTP connection, or rejects any
27624 commands up to and including
27625 .code
27626 MAIL FROM:<>
27627 .endd
27628 (but not including the MAIL command with a non-empty address),
27629 any callout attempt is bound to fail. Exim remembers such failures in a
27630 domain cache record, which it uses to fail callouts for the domain without
27631 making new connections, until the domain record times out. There are two
27632 separate expiry times for domain cache records:
27633 &%callout_domain_negative_expire%& (default 3h) and
27634 &%callout_domain_positive_expire%& (default 7d).
27635
27636 Domain records expire when the negative expiry time is reached if callouts
27637 cannot be made for the domain, or if the postmaster check failed.
27638 Otherwise, they expire when the positive expiry time is reached. This
27639 ensures that, for example, a host that stops accepting &"random"& local parts
27640 will eventually be noticed.
27641
27642 The callout caching mechanism is based on the domain of the address that is
27643 being tested. If the domain routes to several hosts, it is assumed that their
27644 behaviour will be the same.
27645
27646
27647
27648 .section "Sender address verification reporting" "SECTsenaddver"
27649 .cindex "verifying" "suppressing error details"
27650 See section &<<SECTaddressverification>>& for a general discussion of
27651 verification. When sender verification fails in an ACL, the details of the
27652 failure are given as additional output lines before the 550 response to the
27653 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
27654 you might see:
27655 .code
27656 MAIL FROM:<xyz@abc.example>
27657 250 OK
27658 RCPT TO:<pqr@def.example>
27659 550-Verification failed for <xyz@abc.example>
27660 550-Called:   192.168.34.43
27661 550-Sent:     RCPT TO:<xyz@abc.example>
27662 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
27663 550 Sender verification failed
27664 .endd
27665 If more than one RCPT command fails in the same way, the details are given
27666 only for the first of them. However, some administrators do not want to send
27667 out this much information. You can suppress the details by adding
27668 &`/no_details`& to the ACL statement that requests sender verification. For
27669 example:
27670 .code
27671 verify = sender/no_details
27672 .endd
27673
27674 .section "Redirection while verifying" "SECTredirwhilveri"
27675 .cindex "verifying" "redirection while"
27676 .cindex "address redirection" "while verifying"
27677 A dilemma arises when a local address is redirected by aliasing or forwarding
27678 during verification: should the generated addresses themselves be verified,
27679 or should the successful expansion of the original address be enough to verify
27680 it? By default, Exim takes the following pragmatic approach:
27681
27682 .ilist
27683 When an incoming address is redirected to just one child address, verification
27684 continues with the child address, and if that fails to verify, the original
27685 verification also fails.
27686 .next
27687 When an incoming address is redirected to more than one child address,
27688 verification does not continue. A success result is returned.
27689 .endlist
27690
27691 This seems the most reasonable behaviour for the common use of aliasing as a
27692 way of redirecting different local parts to the same mailbox. It means, for
27693 example, that a pair of alias entries of the form
27694 .code
27695 A.Wol:   aw123
27696 aw123:   :fail: Gone away, no forwarding address
27697 .endd
27698 work as expected, with both local parts causing verification failure. When a
27699 redirection generates more than one address, the behaviour is more like a
27700 mailing list, where the existence of the alias itself is sufficient for
27701 verification to succeed.
27702
27703 It is possible, however, to change the default behaviour so that all successful
27704 redirections count as successful verifications, however many new addresses are
27705 generated. This is specified by the &%success_on_redirect%& verification
27706 option. For example:
27707 .code
27708 require verify = recipient/success_on_redirect/callout=10s
27709 .endd
27710 In this example, verification succeeds if a router generates a new address, and
27711 the callout does not occur, because no address was routed to a remote host.
27712
27713 When verification is being tested via the &%-bv%& option, the treatment of
27714 redirections is as just described, unless the &%-v%& or any debugging option is
27715 also specified. In that case, full verification is done for every generated
27716 address and a report is output for each of them.
27717
27718
27719
27720 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
27721 .cindex "CSA" "verifying"
27722 Client SMTP Authorization is a system that allows a site to advertise
27723 which machines are and are not permitted to send email. This is done by placing
27724 special SRV records in the DNS; these are looked up using the client's HELO
27725 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
27726 Authorization checks in Exim are performed by the ACL condition:
27727 .code
27728 verify = csa
27729 .endd
27730 This fails if the client is not authorized. If there is a DNS problem, or if no
27731 valid CSA SRV record is found, or if the client is authorized, the condition
27732 succeeds. These three cases can be distinguished using the expansion variable
27733 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
27734 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
27735 be likely to cause problems for legitimate email.
27736
27737 The error messages produced by the CSA code include slightly more
27738 detail. If &$csa_status$& is &"defer"&, this may be because of problems
27739 looking up the CSA SRV record, or problems looking up the CSA target
27740 address record. There are four reasons for &$csa_status$& being &"fail"&:
27741
27742 .ilist
27743 The client's host name is explicitly not authorized.
27744 .next
27745 The client's IP address does not match any of the CSA target IP addresses.
27746 .next
27747 The client's host name is authorized but it has no valid target IP addresses
27748 (for example, the target's addresses are IPv6 and the client is using IPv4).
27749 .next
27750 The client's host name has no CSA SRV record but a parent domain has asserted
27751 that all subdomains must be explicitly authorized.
27752 .endlist
27753
27754 The &%csa%& verification condition can take an argument which is the domain to
27755 use for the DNS query. The default is:
27756 .code
27757 verify = csa/$sender_helo_name
27758 .endd
27759 This implementation includes an extension to CSA. If the query domain
27760 is an address literal such as [192.0.2.95], or if it is a bare IP
27761 address, Exim searches for CSA SRV records in the reverse DNS as if
27762 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
27763 meaningful to say:
27764 .code
27765 verify = csa/$sender_host_address
27766 .endd
27767 In fact, this is the check that Exim performs if the client does not say HELO.
27768 This extension can be turned off by setting the main configuration option
27769 &%dns_csa_use_reverse%& to be false.
27770
27771 If a CSA SRV record is not found for the domain itself, a search
27772 is performed through its parent domains for a record which might be
27773 making assertions about subdomains. The maximum depth of this search is limited
27774 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
27775 default. Exim does not look for CSA SRV records in a top level domain, so the
27776 default settings handle HELO domains as long as seven
27777 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
27778 of legitimate HELO domains.
27779
27780 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
27781 direct SRV lookups, this is not sufficient because of the extra parent domain
27782 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
27783 addresses into lookups in the reverse DNS space. The result of a successful
27784 lookup such as:
27785 .code
27786 ${lookup dnsdb {csa=$sender_helo_name}}
27787 .endd
27788 has two space-separated fields: an authorization code and a target host name.
27789 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
27790 authorization required but absent, or &"?"& for unknown.
27791
27792
27793
27794
27795 .section "Bounce address tag validation" "SECTverifyPRVS"
27796 .cindex "BATV, verifying"
27797 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
27798 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
27799 Genuine incoming bounce messages should therefore always be addressed to
27800 recipients that have a valid tag. This scheme is a way of detecting unwanted
27801 bounce messages caused by sender address forgeries (often called &"collateral
27802 spam"&), because the recipients of such messages do not include valid tags.
27803
27804 There are two expansion items to help with the implementation of the BATV
27805 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
27806 the original envelope sender address by using a simple key to add a hash of the
27807 address and some time-based randomizing information. The &%prvs%& expansion
27808 item creates a signed address, and the &%prvscheck%& expansion item checks one.
27809 The syntax of these expansion items is described in section
27810 &<<SECTexpansionitems>>&.
27811
27812 As an example, suppose the secret per-address keys are stored in an MySQL
27813 database. A query to look up the key for an address could be defined as a macro
27814 like this:
27815 .code
27816 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
27817                 WHERE sender='${quote_mysql:$prvscheck_address}'\
27818                 }{$value}}
27819 .endd
27820 Suppose also that the senders who make use of BATV are defined by an address
27821 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
27822 use this:
27823 .code
27824 # Bounces: drop unsigned addresses for BATV senders
27825 deny message = This address does not send an unsigned reverse path
27826      senders = :
27827      recipients = +batv_senders
27828
27829 # Bounces: In case of prvs-signed address, check signature.
27830 deny message = Invalid reverse path signature.
27831      senders = :
27832      condition  = ${prvscheck {$local_part@$domain}\
27833                   {PRVSCHECK_SQL}{1}}
27834      !condition = $prvscheck_result
27835 .endd
27836 The first statement rejects recipients for bounce messages that are addressed
27837 to plain BATV sender addresses, because it is known that BATV senders do not
27838 send out messages with plain sender addresses. The second statement rejects
27839 recipients that are prvs-signed, but with invalid signatures (either because
27840 the key is wrong, or the signature has timed out).
27841
27842 A non-prvs-signed address is not rejected by the second statement, because the
27843 &%prvscheck%& expansion yields an empty string if its first argument is not a
27844 prvs-signed address, thus causing the &%condition%& condition to be false. If
27845 the first argument is a syntactically valid prvs-signed address, the yield is
27846 the third string (in this case &"1"&), whether or not the cryptographic and
27847 timeout checks succeed. The &$prvscheck_result$& variable contains the result
27848 of the checks (empty for failure, &"1"& for success).
27849
27850 There is one more issue you must consider when implementing prvs-signing:
27851 you have to ensure that the routers accept prvs-signed addresses and
27852 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
27853 router to remove the signature with a configuration along these lines:
27854 .code
27855 batv_redirect:
27856   driver = redirect
27857   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
27858 .endd
27859 This works because, if the third argument of &%prvscheck%& is empty, the result
27860 of the expansion of a prvs-signed address is the decoded value of the original
27861 address. This router should probably be the first of your routers that handles
27862 local addresses.
27863
27864 To create BATV-signed addresses in the first place, a transport of this form
27865 can be used:
27866 .code
27867 external_smtp_batv:
27868   driver = smtp
27869   return_path = ${prvs {$return_path} \
27870                        {${lookup mysql{SELECT \
27871                        secret FROM batv_prvs WHERE \
27872                        sender='${quote_mysql:$sender_address}'} \
27873                        {$value}fail}}}
27874 .endd
27875 If no key can be found for the existing return path, no signing takes place.
27876
27877
27878
27879 .section "Using an ACL to control relaying" "SECTrelaycontrol"
27880 .cindex "&ACL;" "relay control"
27881 .cindex "relaying" "control by ACL"
27882 .cindex "policy control" "relay control"
27883 An MTA is said to &'relay'& a message if it receives it from some host and
27884 delivers it directly to another host as a result of a remote address contained
27885 within it. Redirecting a local address via an alias or forward file and then
27886 passing the message on to another host is not relaying,
27887 .cindex "&""percent hack""&"
27888 but a redirection as a result of the &"percent hack"& is.
27889
27890 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
27891 A host which is acting as a gateway or an MX backup is concerned with incoming
27892 relaying from arbitrary hosts to a specific set of domains. On the other hand,
27893 a host which is acting as a smart host for a number of clients is concerned
27894 with outgoing relaying from those clients to the Internet at large. Often the
27895 same host is fulfilling both functions,
27896 . ///
27897 . as illustrated in the diagram below,
27898 . ///
27899 but in principle these two kinds of relaying are entirely independent. What is
27900 not wanted is the transmission of mail from arbitrary remote hosts through your
27901 system to arbitrary domains.
27902
27903
27904 You can implement relay control by means of suitable statements in the ACL that
27905 runs for each RCPT command. For convenience, it is often easiest to use
27906 Exim's named list facility to define the domains and hosts involved. For
27907 example, suppose you want to do the following:
27908
27909 .ilist
27910 Deliver a number of domains to mailboxes on the local host (or process them
27911 locally in some other way). Let's say these are &'my.dom1.example'& and
27912 &'my.dom2.example'&.
27913 .next
27914 Relay mail for a number of other domains for which you are the secondary MX.
27915 These might be &'friend1.example'& and &'friend2.example'&.
27916 .next
27917 Relay mail from the hosts on your local LAN, to whatever domains are involved.
27918 Suppose your LAN is 192.168.45.0/24.
27919 .endlist
27920
27921
27922 In the main part of the configuration, you put the following definitions:
27923 .code
27924 domainlist local_domains = my.dom1.example : my.dom2.example
27925 domainlist relay_domains = friend1.example : friend2.example
27926 hostlist   relay_hosts   = 192.168.45.0/24
27927 .endd
27928 Now you can use these definitions in the ACL that is run for every RCPT
27929 command:
27930 .code
27931 acl_check_rcpt:
27932   accept domains = +local_domains : +relay_domains
27933   accept hosts   = +relay_hosts
27934 .endd
27935 The first statement accepts any RCPT command that contains an address in
27936 the local or relay domains. For any other domain, control passes to the second
27937 statement, which accepts the command only if it comes from one of the relay
27938 hosts. In practice, you will probably want to make your ACL more sophisticated
27939 than this, for example, by including sender and recipient verification. The
27940 default configuration includes a more comprehensive example, which is described
27941 in chapter &<<CHAPdefconfil>>&.
27942
27943
27944
27945 .section "Checking a relay configuration" "SECTcheralcon"
27946 .cindex "relaying" "checking control of"
27947 You can check the relay characteristics of your configuration in the same way
27948 that you can test any ACL behaviour for an incoming SMTP connection, by using
27949 the &%-bh%& option to run a fake SMTP session with which you interact.
27950
27951 For specifically testing for unwanted relaying, the host
27952 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
27953 host from the host on which Exim is running, using the normal telnet port, you
27954 will see a normal telnet connection message and then quite a long delay. Be
27955 patient. The remote host is making an SMTP connection back to your host, and
27956 trying a number of common probes to test for open relay vulnerability. The
27957 results of the tests will eventually appear on your terminal.
27958 .ecindex IIDacl
27959
27960
27961
27962 . ////////////////////////////////////////////////////////////////////////////
27963 . ////////////////////////////////////////////////////////////////////////////
27964
27965 .chapter "Content scanning at ACL time" "CHAPexiscan"
27966 .scindex IIDcosca "content scanning" "at ACL time"
27967 The extension of Exim to include content scanning at ACL time, formerly known
27968 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
27969 was integrated into the main source for Exim release 4.50, and Tom continues to
27970 maintain it. Most of the wording of this chapter is taken from Tom's
27971 specification.
27972
27973 It is also possible to scan the content of messages at other times. The
27974 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
27975 scanning after all the ACLs have run. A transport filter can be used to scan
27976 messages at delivery time (see the &%transport_filter%& option, described in
27977 chapter &<<CHAPtransportgeneric>>&).
27978
27979 If you want to include the ACL-time content-scanning features when you compile
27980 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
27981 &_Local/Makefile_&. When you do that, the Exim binary is built with:
27982
27983 .ilist
27984 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
27985 for all MIME parts for SMTP and non-SMTP messages, respectively.
27986 .next
27987 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
27988 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
27989 run at the end of message reception (the &%acl_smtp_data%& ACL).
27990 .next
27991 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
27992 of messages, or parts of messages, for debugging purposes.
27993 .next
27994 Additional expansion variables that are set in the new ACL and by the new
27995 conditions.
27996 .next
27997 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
27998 .endlist
27999
28000 There is another content-scanning configuration option for &_Local/Makefile_&,
28001 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
28002 condition is compiled, in addition to all the other content-scanning features.
28003
28004 Content-scanning is continually evolving, and new features are still being
28005 added. While such features are still unstable and liable to incompatible
28006 changes, they are made available in Exim by setting options whose names begin
28007 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
28008 this manual. You can find out about them by reading the file called
28009 &_doc/experimental.txt_&.
28010
28011 All the content-scanning facilities work on a MBOX copy of the message that is
28012 temporarily created in a file called:
28013 .display
28014 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
28015 .endd
28016 The &_.eml_& extension is a friendly hint to virus scanners that they can
28017 expect an MBOX-like structure inside that file. The file is created when the
28018 first content scanning facility is called. Subsequent calls to content
28019 scanning conditions open the same file again. The directory is recursively
28020 removed when the &%acl_smtp_data%& ACL has finished running, unless
28021 .code
28022 control = no_mbox_unspool
28023 .endd
28024 has been encountered. When the MIME ACL decodes files, they are put into the
28025 same directory by default.
28026
28027
28028
28029 .section "Scanning for viruses" "SECTscanvirus"
28030 .cindex "virus scanning"
28031 .cindex "content scanning" "for viruses"
28032 .cindex "content scanning" "the &%malware%& condition"
28033 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
28034 It supports a &"generic"& interface to scanners called via the shell, and
28035 specialized interfaces for &"daemon"& type virus scanners, which are resident
28036 in memory and thus are much faster.
28037
28038 .oindex "&%av_scanner%&"
28039 You can set the &%av_scanner%& option in first part of the Exim configuration
28040 file to specify which scanner to use, together with any additional options that
28041 are needed. The basic syntax is as follows:
28042 .display
28043 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
28044 .endd
28045 If you do not set &%av_scanner%&, it defaults to
28046 .code
28047 av_scanner = sophie:/var/run/sophie
28048 .endd
28049 If the value of &%av_scanner%& starts with a dollar character, it is expanded
28050 before use. The following scanner types are supported in this release:
28051
28052 .vlist
28053 .vitem &%aveserver%&
28054 .cindex "virus scanners" "Kaspersky"
28055 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
28056 at &url(http://www.kaspersky.com). This scanner type takes one option,
28057 which is the path to the daemon's UNIX socket. The default is shown in this
28058 example:
28059 .code
28060 av_scanner = aveserver:/var/run/aveserver
28061 .endd
28062
28063 .vitem &%clamd%&
28064 .cindex "virus scanners" "clamd"
28065 This daemon-type scanner is GPL and free. You can get it at
28066 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
28067 unpack MIME containers, so it used to be recommended to unpack MIME attachments
28068 in the MIME ACL. This no longer believed to be necessary. One option is
28069 required: either the path and name of a UNIX socket file, or a hostname or IP
28070 number, and a port, separated by space, as in the second of these examples:
28071 .code
28072 av_scanner = clamd:/opt/clamd/socket
28073 av_scanner = clamd:192.0.2.3 1234
28074 av_scanner = clamd:192.0.2.3 1234:local
28075 .endd
28076 If the value of av_scanner points to a UNIX socket file or contains the local
28077 keyword, then the ClamAV interface will pass a filename containing the data
28078 to be scanned, which will should normally result in less I/O happening and be
28079 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
28080 Exim does not assume that there is a common filesystem with the remote host.
28081 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
28082 you be running a version of ClamAV prior to 0.95.
28083 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
28084 contributing the code for this scanner.
28085
28086 .vitem &%cmdline%&
28087 .cindex "virus scanners" "command line interface"
28088 This is the keyword for the generic command line scanner interface. It can be
28089 used to attach virus scanners that are invoked from the shell. This scanner
28090 type takes 3 mandatory options:
28091
28092 .olist
28093 The full path and name of the scanner binary, with all command line options,
28094 and a placeholder (&`%s`&) for the directory to scan.
28095
28096 .next
28097 A regular expression to match against the STDOUT and STDERR output of the
28098 virus scanner. If the expression matches, a virus was found. You must make
28099 absolutely sure that this expression matches on &"virus found"&. This is called
28100 the &"trigger"& expression.
28101
28102 .next
28103 Another regular expression, containing exactly one pair of parentheses, to
28104 match the name of the virus found in the scanners output. This is called the
28105 &"name"& expression.
28106 .endlist olist
28107
28108 For example, Sophos Sweep reports a virus on a line like this:
28109 .code
28110 Virus 'W32/Magistr-B' found in file ./those.bat
28111 .endd
28112 For the trigger expression, we can match the phrase &"found in file"&. For the
28113 name expression, we want to extract the W32/Magistr-B string, so we can match
28114 for the single quotes left and right of it. Altogether, this makes the
28115 configuration setting:
28116 .code
28117 av_scanner = cmdline:\
28118              /path/to/sweep -ss -all -rec -archive %s:\
28119              found in file:'(.+)'
28120 .endd
28121 .vitem &%drweb%&
28122 .cindex "virus scanners" "DrWeb"
28123 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
28124 argument, either a full path to a UNIX socket, or an IP address and port
28125 separated by white space, as in these examples:
28126 .code
28127 av_scanner = drweb:/var/run/drwebd.sock
28128 av_scanner = drweb:192.168.2.20 31337
28129 .endd
28130 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
28131 is used. Thanks to Alex Miller for contributing the code for this scanner.
28132
28133 .vitem &%fsecure%&
28134 .cindex "virus scanners" "F-Secure"
28135 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
28136 argument which is the path to a UNIX socket. For example:
28137 .code
28138 av_scanner = fsecure:/path/to/.fsav
28139 .endd
28140 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
28141 Thelmen for contributing the code for this scanner.
28142
28143 .vitem &%kavdaemon%&
28144 .cindex "virus scanners" "Kaspersky"
28145 This is the scanner daemon of Kaspersky Version 4. This version of the
28146 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
28147 scanner type takes one option, which is the path to the daemon's UNIX socket.
28148 For example:
28149 .code
28150 av_scanner = kavdaemon:/opt/AVP/AvpCtl
28151 .endd
28152 The default path is &_/var/run/AvpCtl_&.
28153
28154 .vitem &%mksd%&
28155 .cindex "virus scanners" "mksd"
28156 This is a daemon type scanner that is aimed mainly at Polish users, though some
28157 parts of documentation are now available in English. You can get it at
28158 &url(http://linux.mks.com.pl/). The only option for this scanner type is
28159 the maximum number of processes used simultaneously to scan the attachments,
28160 provided that the demime facility is employed and also provided that mksd has
28161 been run with at least the same number of child processes. For example:
28162 .code
28163 av_scanner = mksd:2
28164 .endd
28165 You can safely omit this option (the default value is 1).
28166
28167 .vitem &%sophie%&
28168 .cindex "virus scanners" "Sophos and Sophie"
28169 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
28170 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
28171 for this scanner type is the path to the UNIX socket that Sophie uses for
28172 client communication. For example:
28173 .code
28174 av_scanner = sophie:/tmp/sophie
28175 .endd
28176 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
28177 the option.
28178 .endlist
28179
28180 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
28181 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
28182 ACL.
28183
28184 The &%av_scanner%& option is expanded each time &%malware%& is called. This
28185 makes it possible to use different scanners. See further below for an example.
28186 The &%malware%& condition caches its results, so when you use it multiple times
28187 for the same message, the actual scanning process is only carried out once.
28188 However, using expandable items in &%av_scanner%& disables this caching, in
28189 which case each use of the &%malware%& condition causes a new scan of the
28190 message.
28191
28192 The &%malware%& condition takes a right-hand argument that is expanded before
28193 use. It can then be one of
28194
28195 .ilist
28196 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
28197 The condition succeeds if a virus was found, and fail otherwise. This is the
28198 recommended usage.
28199 .next
28200 &"false"& or &"0"& or an empty string, in which case no scanning is done and
28201 the condition fails immediately.
28202 .next
28203 A regular expression, in which case the message is scanned for viruses. The
28204 condition succeeds if a virus is found and its name matches the regular
28205 expression. This allows you to take special actions on certain types of virus.
28206 .endlist
28207
28208 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
28209 even if there is a problem with the virus scanner. Otherwise, such a problem
28210 causes the ACL to defer.
28211
28212 .vindex "&$malware_name$&"
28213 When a virus is found, the condition sets up an expansion variable called
28214 &$malware_name$& that contains the name of the virus. You can use it in a
28215 &%message%& modifier that specifies the error returned to the sender, and/or in
28216 logging data.
28217
28218 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
28219 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
28220 &%malware%& condition.
28221
28222 .new
28223 Beware the interaction of Exim's &%message_size_limit%& with any size limits
28224 imposed by your anti-virus scanner.
28225 .wen
28226
28227 Here is a very simple scanning example:
28228 .code
28229 deny message = This message contains malware ($malware_name)
28230      demime = *
28231      malware = *
28232 .endd
28233 The next example accepts messages when there is a problem with the scanner:
28234 .code
28235 deny message = This message contains malware ($malware_name)
28236      demime = *
28237      malware = */defer_ok
28238 .endd
28239 The next example shows how to use an ACL variable to scan with both sophie and
28240 aveserver. It assumes you have set:
28241 .code
28242 av_scanner = $acl_m0
28243 .endd
28244 in the main Exim configuration.
28245 .code
28246 deny message = This message contains malware ($malware_name)
28247      set acl_m0 = sophie
28248      malware = *
28249
28250 deny message = This message contains malware ($malware_name)
28251      set acl_m0 = aveserver
28252      malware = *
28253 .endd
28254
28255
28256 .section "Scanning with SpamAssassin" "SECTscanspamass"
28257 .cindex "content scanning" "for spam"
28258 .cindex "spam scanning"
28259 .cindex "SpamAssassin"
28260 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
28261 score and a report for the message. You can get SpamAssassin at
28262 &url(http://www.spamassassin.org), or, if you have a working Perl
28263 installation, you can use CPAN by running:
28264 .code
28265 perl -MCPAN -e 'install Mail::SpamAssassin'
28266 .endd
28267 SpamAssassin has its own set of configuration files. Please review its
28268 documentation to see how you can tweak it. The default installation should work
28269 nicely, however.
28270
28271 .oindex "&%spamd_address%&"
28272 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
28273 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
28274 port for &%spamd%&, you must set the &%spamd_address%& option in the global
28275 part of the Exim configuration as follows (example):
28276 .code
28277 spamd_address = 192.168.99.45 387
28278 .endd
28279 You do not need to set this option if you use the default. As of version 2.60,
28280 &%spamd%& also supports communication over UNIX sockets. If you want to use
28281 these, supply &%spamd_address%& with an absolute file name instead of a
28282 address/port pair:
28283 .code
28284 spamd_address = /var/run/spamd_socket
28285 .endd
28286 You can have multiple &%spamd%& servers to improve scalability. These can
28287 reside on other hardware reachable over the network. To specify multiple
28288 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
28289 option, separated with colons:
28290 .code
28291 spamd_address = 192.168.2.10 783 : \
28292                 192.168.2.11 783 : \
28293                 192.168.2.12 783
28294 .endd
28295 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
28296 fashion. When a server fails to respond to the connection attempt, all other
28297 servers are tried until one succeeds. If no server responds, the &%spam%&
28298 condition defers.
28299
28300 &*Warning*&: It is not possible to use the UNIX socket connection method with
28301 multiple &%spamd%& servers.
28302
28303 The &%spamd_address%& variable is expanded before use if it starts with
28304 a dollar sign. In this case, the expansion may return a string that is
28305 used as the list so that multiple spamd servers can be the result of an
28306 expansion.
28307
28308 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
28309 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
28310 .code
28311 deny message = This message was classified as SPAM
28312      spam = joe
28313 .endd
28314 The right-hand side of the &%spam%& condition specifies a name. This is
28315 relevant if you have set up multiple SpamAssassin profiles. If you do not want
28316 to scan using a specific profile, but rather use the SpamAssassin system-wide
28317 default profile, you can scan for an unknown name, or simply use &"nobody"&.
28318 However, you must put something on the right-hand side.
28319
28320 The name allows you to use per-domain or per-user antispam profiles in
28321 principle, but this is not straightforward in practice, because a message may
28322 have multiple recipients, not necessarily all in the same domain. Because the
28323 &%spam%& condition has to be called from a DATA ACL in order to be able to
28324 read the contents of the message, the variables &$local_part$& and &$domain$&
28325 are not set.
28326
28327 The right-hand side of the &%spam%& condition is expanded before being used, so
28328 you can put lookups or conditions there. When the right-hand side evaluates to
28329 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
28330
28331
28332 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
28333 large ones may cause significant performance degradation. As most spam messages
28334 are quite small, it is recommended that you do not scan the big ones. For
28335 example:
28336 .code
28337 deny message = This message was classified as SPAM
28338      condition = ${if < {$message_size}{10K}}
28339      spam = nobody
28340 .endd
28341
28342 The &%spam%& condition returns true if the threshold specified in the user's
28343 SpamAssassin profile has been matched or exceeded. If you want to use the
28344 &%spam%& condition for its side effects (see the variables below), you can make
28345 it always return &"true"& by appending &`:true`& to the username.
28346
28347 .new
28348 .cindex "spam scanning" "returned variables"
28349 When the &%spam%& condition is run, it sets up a number of expansion
28350 variables. These variables are saved with the received message, thus they are
28351 available for use at delivery time.
28352 .wen
28353
28354 .vlist
28355 .vitem &$spam_score$&
28356 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
28357 for inclusion in log or reject messages.
28358
28359 .vitem &$spam_score_int$&
28360 The spam score of the message, multiplied by ten, as an integer value. For
28361 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
28362 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
28363 The integer value is useful for numeric comparisons in conditions.
28364
28365
28366 .vitem &$spam_bar$&
28367 A string consisting of a number of &"+"& or &"-"& characters, representing the
28368 integer part of the spam score value. A spam score of 4.4 would have a
28369 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
28370 headers, since MUAs can match on such strings.
28371
28372 .vitem &$spam_report$&
28373 A multiline text table, containing the full SpamAssassin report for the
28374 message. Useful for inclusion in headers or reject messages.
28375 .endlist
28376
28377 The &%spam%& condition caches its results unless expansion in
28378 spamd_address was used. If you call it again with the same user name, it
28379 does not scan again, but rather returns the same values as before.
28380
28381 The &%spam%& condition returns DEFER if there is any error while running
28382 the message through SpamAssassin or if the expansion of spamd_address
28383 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
28384 statement block), append &`/defer_ok`& to the right-hand side of the
28385 spam condition, like this:
28386 .code
28387 deny message = This message was classified as SPAM
28388      spam    = joe/defer_ok
28389 .endd
28390 This causes messages to be accepted even if there is a problem with &%spamd%&.
28391
28392 Here is a longer, commented example of the use of the &%spam%&
28393 condition:
28394 .code
28395 # put headers in all messages (no matter if spam or not)
28396 warn  spam = nobody:true
28397       add_header = X-Spam-Score: $spam_score ($spam_bar)
28398       add_header = X-Spam-Report: $spam_report
28399
28400 # add second subject line with *SPAM* marker when message
28401 # is over threshold
28402 warn  spam = nobody
28403       add_header = Subject: *SPAM* $h_Subject:
28404
28405 # reject spam at high scores (> 12)
28406 deny  message = This message scored $spam_score spam points.
28407       spam = nobody:true
28408       condition = ${if >{$spam_score_int}{120}{1}{0}}
28409 .endd
28410
28411
28412
28413 .section "Scanning MIME parts" "SECTscanmimepart"
28414 .cindex "content scanning" "MIME parts"
28415 .cindex "MIME content scanning"
28416 .oindex "&%acl_smtp_mime%&"
28417 .oindex "&%acl_not_smtp_mime%&"
28418 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
28419 each MIME part of an SMTP message, including multipart types, in the sequence
28420 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
28421 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
28422 options may both refer to the same ACL if you want the same processing in both
28423 cases.
28424
28425 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
28426 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
28427 the case of a non-SMTP message. However, a MIME ACL is called only if the
28428 message contains a &'Content-Type:'& header line. When a call to a MIME
28429 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
28430 result code is sent to the client. In the case of an SMTP message, the
28431 &%acl_smtp_data%& ACL is not called when this happens.
28432
28433 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
28434 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
28435 condition to match against the raw MIME part. You can also use the
28436 &%mime_regex%& condition to match against the decoded MIME part (see section
28437 &<<SECTscanregex>>&).
28438
28439 At the start of a MIME ACL, a number of variables are set from the header
28440 information for the relevant MIME part. These are described below. The contents
28441 of the MIME part are not by default decoded into a disk file except for MIME
28442 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
28443 part into a disk file, you can use the &%decode%& condition. The general
28444 syntax is:
28445 .display
28446 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
28447 .endd
28448 The right hand side is expanded before use. After expansion,
28449 the value can be:
28450
28451 .olist
28452 &"0"& or &"false"&, in which case no decoding is done.
28453 .next
28454 The string &"default"&. In that case, the file is put in the temporary
28455 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
28456 a sequential file name consisting of the message id and a sequence number. The
28457 full path and name is available in &$mime_decoded_filename$& after decoding.
28458 .next
28459 A full path name starting with a slash. If the full name is an existing
28460 directory, it is used as a replacement for the default directory. The filename
28461 is then sequentially assigned. If the path does not exist, it is used as
28462 the full path and file name.
28463 .next
28464 If the string does not start with a slash, it is used as the
28465 filename, and the default path is then used.
28466 .endlist
28467 The &%decode%& condition normally succeeds. It is only false for syntax
28468 errors or unusual circumstances such as memory shortages. You can easily decode
28469 a file with its original, proposed filename using
28470 .code
28471 decode = $mime_filename
28472 .endd
28473 However, you should keep in mind that &$mime_filename$& might contain
28474 anything. If you place files outside of the default path, they are not
28475 automatically unlinked.
28476
28477 For RFC822 attachments (these are messages attached to messages, with a
28478 content-type of &"message/rfc822"&), the ACL is called again in the same manner
28479 as for the primary message, only that the &$mime_is_rfc822$& expansion
28480 variable is set (see below). Attached messages are always decoded to disk
28481 before being checked, and the files are unlinked once the check is done.
28482
28483 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
28484 used to match regular expressions against raw and decoded MIME parts,
28485 respectively. They are described in section &<<SECTscanregex>>&.
28486
28487 .cindex "MIME content scanning" "returned variables"
28488 The following list describes all expansion variables that are
28489 available in the MIME ACL:
28490
28491 .vlist
28492 .vitem &$mime_boundary$&
28493 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
28494 have a boundary string, which is stored in this variable. If the current part
28495 has no boundary parameter in the &'Content-Type:'& header, this variable
28496 contains the empty string.
28497
28498 .vitem &$mime_charset$&
28499 This variable contains the character set identifier, if one was found in the
28500 &'Content-Type:'& header. Examples for charset identifiers are:
28501 .code
28502 us-ascii
28503 gb2312 (Chinese)
28504 iso-8859-1
28505 .endd
28506 Please note that this value is not normalized, so you should do matches
28507 case-insensitively.
28508
28509 .vitem &$mime_content_description$&
28510 This variable contains the normalized content of the &'Content-Description:'&
28511 header. It can contain a human-readable description of the parts content. Some
28512 implementations repeat the filename for attachments here, but they are usually
28513 only used for display purposes.
28514
28515 .vitem &$mime_content_disposition$&
28516 This variable contains the normalized content of the &'Content-Disposition:'&
28517 header. You can expect strings like &"attachment"& or &"inline"& here.
28518
28519 .vitem &$mime_content_id$&
28520 This variable contains the normalized content of the &'Content-ID:'& header.
28521 This is a unique ID that can be used to reference a part from another part.
28522
28523 .vitem &$mime_content_size$&
28524 This variable is set only after the &%decode%& modifier (see above) has been
28525 successfully run. It contains the size of the decoded part in kilobytes. The
28526 size is always rounded up to full kilobytes, so only a completely empty part
28527 has a &$mime_content_size$& of zero.
28528
28529 .vitem &$mime_content_transfer_encoding$&
28530 This variable contains the normalized content of the
28531 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
28532 type. Typical values are &"base64"& and &"quoted-printable"&.
28533
28534 .vitem &$mime_content_type$&
28535 If the MIME part has a &'Content-Type:'& header, this variable contains its
28536 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
28537 are some examples of popular MIME types, as they may appear in this variable:
28538 .code
28539 text/plain
28540 text/html
28541 application/octet-stream
28542 image/jpeg
28543 audio/midi
28544 .endd
28545 If the MIME part has no &'Content-Type:'& header, this variable contains the
28546 empty string.
28547
28548 .vitem &$mime_decoded_filename$&
28549 This variable is set only after the &%decode%& modifier (see above) has been
28550 successfully run. It contains the full path and file name of the file
28551 containing the decoded data.
28552 .endlist
28553
28554 .cindex "RFC 2047"
28555 .vlist
28556 .vitem &$mime_filename$&
28557 This is perhaps the most important of the MIME variables. It contains a
28558 proposed filename for an attachment, if one was found in either the
28559 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
28560 RFC2047 decoded, but no additional sanity checks are done. If no filename was
28561 found, this variable contains the empty string.
28562
28563 .vitem &$mime_is_coverletter$&
28564 This variable attempts to differentiate the &"cover letter"& of an e-mail from
28565 attached data. It can be used to clamp down on flashy or unnecessarily encoded
28566 content in the cover letter, while not restricting attachments at all.
28567
28568 The variable contains 1 (true) for a MIME part believed to be part of the
28569 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
28570 follows:
28571
28572 .olist
28573 The outermost MIME part of a message is always a cover letter.
28574
28575 .next
28576 If a multipart/alternative or multipart/related MIME part is a cover letter,
28577 so are all MIME subparts within that multipart.
28578
28579 .next
28580 If any other multipart is a cover letter, the first subpart is a cover letter,
28581 and the rest are attachments.
28582
28583 .next
28584 All parts contained within an attachment multipart are attachments.
28585 .endlist olist
28586
28587 As an example, the following will ban &"HTML mail"& (including that sent with
28588 alternative plain text), while allowing HTML files to be attached. HTML
28589 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
28590 .code
28591 deny message = HTML mail is not accepted here
28592 !condition = $mime_is_rfc822
28593 condition = $mime_is_coverletter
28594 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
28595 .endd
28596 .vitem &$mime_is_multipart$&
28597 This variable has the value 1 (true) when the current part has the main type
28598 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
28599 Since multipart entities only serve as containers for other parts, you may not
28600 want to carry out specific actions on them.
28601
28602 .vitem &$mime_is_rfc822$&
28603 This variable has the value 1 (true) if the current part is not a part of the
28604 checked message itself, but part of an attached message. Attached message
28605 decoding is fully recursive.
28606
28607 .vitem &$mime_part_count$&
28608 This variable is a counter that is raised for each processed MIME part. It
28609 starts at zero for the very first part (which is usually a multipart). The
28610 counter is per-message, so it is reset when processing RFC822 attachments (see
28611 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
28612 complete, so you can use it in the DATA ACL to determine the number of MIME
28613 parts of a message. For non-MIME messages, this variable contains the value -1.
28614 .endlist
28615
28616
28617
28618 .section "Scanning with regular expressions" "SECTscanregex"
28619 .cindex "content scanning" "with regular expressions"
28620 .cindex "regular expressions" "content scanning with"
28621 You can specify your own custom regular expression matches on the full body of
28622 the message, or on individual MIME parts.
28623
28624 The &%regex%& condition takes one or more regular expressions as arguments and
28625 matches them against the full message (when called in the DATA ACL) or a raw
28626 MIME part (when called in the MIME ACL). The &%regex%& condition matches
28627 linewise, with a maximum line length of 32K characters. That means you cannot
28628 have multiline matches with the &%regex%& condition.
28629
28630 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
28631 to 32K of decoded content (the whole content at once, not linewise). If the
28632 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
28633 is decoded automatically when &%mime_regex%& is executed (using default path
28634 and filename values). If the decoded data is larger than  32K, only the first
28635 32K characters are checked.
28636
28637 The regular expressions are passed as a colon-separated list. To include a
28638 literal colon, you must double it. Since the whole right-hand side string is
28639 expanded before being used, you must also escape dollar signs and backslashes
28640 with more backslashes, or use the &`\N`& facility to disable expansion.
28641 Here is a simple example that contains two regular expressions:
28642 .code
28643 deny message = contains blacklisted regex ($regex_match_string)
28644      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
28645 .endd
28646 The conditions returns true if any one of the regular expressions matches. The
28647 &$regex_match_string$& expansion variable is then set up and contains the
28648 matching regular expression.
28649
28650 &*Warning*&: With large messages, these conditions can be fairly
28651 CPU-intensive.
28652
28653
28654
28655
28656 .section "The demime condition" "SECTdemimecond"
28657 .cindex "content scanning" "MIME checking"
28658 .cindex "MIME content scanning"
28659 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
28660 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
28661 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
28662 ACL functionality, but provides no additional facilities. Please note that this
28663 condition is deprecated and kept only for backward compatibility. You must set
28664 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
28665 use the &%demime%& condition.
28666
28667 The &%demime%& condition unpacks MIME containers in the message. It detects
28668 errors in MIME containers and can match file extensions found in the message
28669 against a list. Using this facility produces files containing the unpacked MIME
28670 parts of the message in the temporary scan directory. If you do antivirus
28671 scanning, it is recommended that you use the &%demime%& condition before the
28672 antivirus (&%malware%&) condition.
28673
28674 On the right-hand side of the &%demime%& condition you can pass a
28675 colon-separated list of file extensions that it should match against. For
28676 example:
28677 .code
28678 deny message = Found blacklisted file attachment
28679      demime  = vbs:com:bat:pif:prf:lnk
28680 .endd
28681 If one of the file extensions is found, the condition is true, otherwise it is
28682 false. If there is a temporary error while demimeing (for example, &"disk
28683 full"&), the condition defers, and the message is temporarily rejected (unless
28684 the condition is on a &%warn%& verb).
28685
28686 The right-hand side is expanded before being treated as a list, so you can have
28687 conditions and lookups there. If it expands to an empty string, &"false"&, or
28688 zero (&"0"&), no demimeing is done and the condition is false.
28689
28690 The &%demime%& condition set the following variables:
28691
28692 .vlist
28693 .vitem &$demime_errorlevel$&
28694 .vindex "&$demime_errorlevel$&"
28695 When an error is detected in a MIME container, this variable contains the
28696 severity of the error, as an integer number. The higher the value, the more
28697 severe the error (the current maximum value is 3). If this variable is unset or
28698 zero, no error occurred.
28699
28700 .vitem &$demime_reason$&
28701 .vindex "&$demime_reason$&"
28702 When &$demime_errorlevel$& is greater than zero, this variable contains a
28703 human-readable text string describing the MIME error that occurred.
28704 .endlist
28705
28706 .vlist
28707 .vitem &$found_extension$&
28708 .vindex "&$found_extension$&"
28709 When the &%demime%& condition is true, this variable contains the file
28710 extension it found.
28711 .endlist
28712
28713 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
28714 the &%demime%& condition, and are not changed on subsequent calls.
28715
28716 If you do not want to check for file extensions, but rather use the &%demime%&
28717 condition for unpacking or error checking purposes, pass &"*"& as the
28718 right-hand side value. Here is a more elaborate example of how to use this
28719 facility:
28720 .code
28721 # Reject messages with serious MIME container errors
28722 deny  message = Found MIME error ($demime_reason).
28723       demime = *
28724       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
28725
28726 # Reject known virus spreading file extensions.
28727 # Accepting these is pretty much braindead.
28728 deny  message = contains $found_extension file (blacklisted).
28729       demime  = com:vbs:bat:pif:scr
28730
28731 # Freeze .exe and .doc files. Postmaster can
28732 # examine them and eventually thaw them.
28733 deny  log_message = Another $found_extension file.
28734       demime = exe:doc
28735       control = freeze
28736 .endd
28737 .ecindex IIDcosca
28738
28739
28740
28741
28742 . ////////////////////////////////////////////////////////////////////////////
28743 . ////////////////////////////////////////////////////////////////////////////
28744
28745 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
28746          "Local scan function"
28747 .scindex IIDlosca "&[local_scan()]& function" "description of"
28748 .cindex "customizing" "input scan using C function"
28749 .cindex "policy control" "by local scan function"
28750 In these days of email worms, viruses, and ever-increasing spam, some sites
28751 want to apply a lot of checking to messages before accepting them.
28752
28753 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
28754 passing messages to external virus and spam scanning software. You can also do
28755 a certain amount in Exim itself through string expansions and the &%condition%&
28756 condition in the ACL that runs after the SMTP DATA command or the ACL for
28757 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
28758
28759 To allow for further customization to a site's own requirements, there is the
28760 possibility of linking Exim with a private message scanning function, written
28761 in C. If you want to run code that is written in something other than C, you
28762 can of course use a little C stub to call it.
28763
28764 The local scan function is run once for every incoming message, at the point
28765 when Exim is just about to accept the message.
28766 It can therefore be used to control non-SMTP messages from local processes as
28767 well as messages arriving via SMTP.
28768
28769 Exim applies a timeout to calls of the local scan function, and there is an
28770 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
28771 Zero means &"no timeout"&.
28772 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
28773 before calling the local scan function, so that the most common types of crash
28774 are caught. If the timeout is exceeded or one of those signals is caught, the
28775 incoming message is rejected with a temporary error if it is an SMTP message.
28776 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
28777 code. The incident is logged on the main and reject logs.
28778
28779
28780
28781 .section "Building Exim to use a local scan function" "SECID207"
28782 .cindex "&[local_scan()]& function" "building Exim to use"
28783 To make use of the local scan function feature, you must tell Exim where your
28784 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
28785 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
28786 directory, so you might set
28787 .code
28788 LOCAL_SCAN_SOURCE=Local/local_scan.c
28789 .endd
28790 for example. The function must be called &[local_scan()]&. It is called by
28791 Exim after it has received a message, when the success return code is about to
28792 be sent. This is after all the ACLs have been run. The return code from your
28793 function controls whether the message is actually accepted or not. There is a
28794 commented template function (that just accepts the message) in the file
28795 _src/local_scan.c_.
28796
28797 If you want to make use of Exim's run time configuration file to set options
28798 for your &[local_scan()]& function, you must also set
28799 .code
28800 LOCAL_SCAN_HAS_OPTIONS=yes
28801 .endd
28802 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
28803
28804
28805
28806
28807 .section "API for local_scan()" "SECTapiforloc"
28808 .cindex "&[local_scan()]& function" "API description"
28809 You must include this line near the start of your code:
28810 .code
28811 #include "local_scan.h"
28812 .endd
28813 This header file defines a number of variables and other values, and the
28814 prototype for the function itself. Exim is coded to use unsigned char values
28815 almost exclusively, and one of the things this header defines is a shorthand
28816 for &`unsigned char`& called &`uschar`&.
28817 It also contains the following macro definitions, to simplify casting character
28818 strings and pointers to character strings:
28819 .code
28820 #define CS   (char *)
28821 #define CCS  (const char *)
28822 #define CSS  (char **)
28823 #define US   (unsigned char *)
28824 #define CUS  (const unsigned char *)
28825 #define USS  (unsigned char **)
28826 .endd
28827 The function prototype for &[local_scan()]& is:
28828 .code
28829 extern int local_scan(int fd, uschar **return_text);
28830 .endd
28831 The arguments are as follows:
28832
28833 .ilist
28834 &%fd%& is a file descriptor for the file that contains the body of the message
28835 (the -D file). The file is open for reading and writing, but updating it is not
28836 recommended. &*Warning*&: You must &'not'& close this file descriptor.
28837
28838 The descriptor is positioned at character 19 of the file, which is the first
28839 character of the body itself, because the first 19 characters are the message
28840 id followed by &`-D`& and a newline. If you rewind the file, you should use the
28841 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
28842 case this changes in some future version.
28843 .next
28844 &%return_text%& is an address which you can use to return a pointer to a text
28845 string at the end of the function. The value it points to on entry is NULL.
28846 .endlist
28847
28848 The function must return an &%int%& value which is one of the following macros:
28849
28850 .vlist
28851 .vitem &`LOCAL_SCAN_ACCEPT`&
28852 .vindex "&$local_scan_data$&"
28853 The message is accepted. If you pass back a string of text, it is saved with
28854 the message, and made available in the variable &$local_scan_data$&. No
28855 newlines are permitted (if there are any, they are turned into spaces) and the
28856 maximum length of text is 1000 characters.
28857
28858 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
28859 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
28860 queued without immediate delivery, and is frozen.
28861
28862 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
28863 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
28864 queued without immediate delivery.
28865
28866 .vitem &`LOCAL_SCAN_REJECT`&
28867 The message is rejected; the returned text is used as an error message which is
28868 passed back to the sender and which is also logged. Newlines are permitted &--
28869 they cause a multiline response for SMTP rejections, but are converted to
28870 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
28871 used.
28872
28873 .vitem &`LOCAL_SCAN_TEMPREJECT`&
28874 The message is temporarily rejected; the returned text is used as an error
28875 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
28876 problem"& is used.
28877
28878 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
28879 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
28880 message is not written to the reject log. It has the effect of unsetting the
28881 &%rejected_header%& log selector for just this rejection. If
28882 &%rejected_header%& is already unset (see the discussion of the
28883 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
28884 same as LOCAL_SCAN_REJECT.
28885
28886 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
28887 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
28888 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
28889 .endlist
28890
28891 If the message is not being received by interactive SMTP, rejections are
28892 reported by writing to &%stderr%& or by sending an email, as configured by the
28893 &%-oe%& command line options.
28894
28895
28896
28897 .section "Configuration options for local_scan()" "SECTconoptloc"
28898 .cindex "&[local_scan()]& function" "configuration options"
28899 It is possible to have option settings in the main configuration file
28900 that set values in static variables in the &[local_scan()]& module. If you
28901 want to do this, you must have the line
28902 .code
28903 LOCAL_SCAN_HAS_OPTIONS=yes
28904 .endd
28905 in your &_Local/Makefile_& when you build Exim. (This line is in
28906 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
28907 file, you must define static variables to hold the option values, and a table
28908 to define them.
28909
28910 The table must be a vector called &%local_scan_options%&, of type
28911 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
28912 and a pointer to the variable that holds the value. The entries must appear in
28913 alphabetical order. Following &%local_scan_options%& you must also define a
28914 variable called &%local_scan_options_count%& that contains the number of
28915 entries in the table. Here is a short example, showing two kinds of option:
28916 .code
28917 static int my_integer_option = 42;
28918 static uschar *my_string_option = US"a default string";
28919
28920 optionlist local_scan_options[] = {
28921   { "my_integer", opt_int,       &my_integer_option },
28922   { "my_string",  opt_stringptr, &my_string_option }
28923 };
28924
28925 int local_scan_options_count =
28926   sizeof(local_scan_options)/sizeof(optionlist);
28927 .endd
28928 The values of the variables can now be changed from Exim's runtime
28929 configuration file by including a local scan section as in this example:
28930 .code
28931 begin local_scan
28932 my_integer = 99
28933 my_string = some string of text...
28934 .endd
28935 The available types of option data are as follows:
28936
28937 .vlist
28938 .vitem &*opt_bool*&
28939 This specifies a boolean (true/false) option. The address should point to a
28940 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
28941 that are defined as &"1"& and &"0"&, respectively. If you want to detect
28942 whether such a variable has been set at all, you can initialize it to
28943 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
28944 values.)
28945
28946 .vitem &*opt_fixed*&
28947 This specifies a fixed point number, such as is used for load averages.
28948 The address should point to a variable of type &`int`&. The value is stored
28949 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
28950
28951 .vitem &*opt_int*&
28952 This specifies an integer; the address should point to a variable of type
28953 &`int`&. The value may be specified in any of the integer formats accepted by
28954 Exim.
28955
28956 .vitem &*opt_mkint*&
28957 This is the same as &%opt_int%&, except that when such a value is output in a
28958 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
28959 printed with the suffix K or M.
28960
28961 .vitem &*opt_octint*&
28962 This also specifies an integer, but the value is always interpreted as an
28963 octal integer, whether or not it starts with the digit zero, and it is
28964 always output in octal.
28965
28966 .vitem &*opt_stringptr*&
28967 This specifies a string value; the address must be a pointer to a
28968 variable that points to a string (for example, of type &`uschar *`&).
28969
28970 .vitem &*opt_time*&
28971 This specifies a time interval value. The address must point to a variable of
28972 type &`int`&. The value that is placed there is a number of seconds.
28973 .endlist
28974
28975 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
28976 out the values of all the &[local_scan()]& options.
28977
28978
28979
28980 .section "Available Exim variables" "SECID208"
28981 .cindex "&[local_scan()]& function" "available Exim variables"
28982 The header &_local_scan.h_& gives you access to a number of C variables. These
28983 are the only ones that are guaranteed to be maintained from release to release.
28984 Note, however, that you can obtain the value of any Exim expansion variable,
28985 including &$recipients$&, by calling &'expand_string()'&. The exported
28986 C variables are as follows:
28987
28988 .vlist
28989 .vitem &*int&~body_linecount*&
28990 This variable contains the number of lines in the message's body.
28991
28992 .vitem &*int&~body_zerocount*&
28993 This variable contains the number of binary zero bytes in the message's body.
28994
28995 .vitem &*unsigned&~int&~debug_selector*&
28996 This variable is set to zero when no debugging is taking place. Otherwise, it
28997 is a bitmap of debugging selectors. Two bits are identified for use in
28998 &[local_scan()]&; they are defined as macros:
28999
29000 .ilist
29001 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
29002 testing option that is not privileged &-- any caller may set it. All the
29003 other selector bits can be set only by admin users.
29004
29005 .next
29006 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
29007 by the &`+local_scan`& debug selector. It is not included in the default set
29008 of debugging bits.
29009 .endlist ilist
29010
29011 Thus, to write to the debugging output only when &`+local_scan`& has been
29012 selected, you should use code like this:
29013 .code
29014 if ((debug_selector & D_local_scan) != 0)
29015   debug_printf("xxx", ...);
29016 .endd
29017 .vitem &*uschar&~*expand_string_message*&
29018 After a failing call to &'expand_string()'& (returned value NULL), the
29019 variable &%expand_string_message%& contains the error message, zero-terminated.
29020
29021 .vitem &*header_line&~*header_list*&
29022 A pointer to a chain of header lines. The &%header_line%& structure is
29023 discussed below.
29024
29025 .vitem &*header_line&~*header_last*&
29026 A pointer to the last of the header lines.
29027
29028 .vitem &*uschar&~*headers_charset*&
29029 The value of the &%headers_charset%& configuration option.
29030
29031 .vitem &*BOOL&~host_checking*&
29032 This variable is TRUE during a host checking session that is initiated by the
29033 &%-bh%& command line option.
29034
29035 .vitem &*uschar&~*interface_address*&
29036 The IP address of the interface that received the message, as a string. This
29037 is NULL for locally submitted messages.
29038
29039 .vitem &*int&~interface_port*&
29040 The port on which this message was received. When testing with the &%-bh%&
29041 command line option, the value of this variable is -1 unless a port has been
29042 specified via the &%-oMi%& option.
29043
29044 .vitem &*uschar&~*message_id*&
29045 This variable contains Exim's message id for the incoming message (the value of
29046 &$message_exim_id$&) as a zero-terminated string.
29047
29048 .vitem &*uschar&~*received_protocol*&
29049 The name of the protocol by which the message was received.
29050
29051 .vitem &*int&~recipients_count*&
29052 The number of accepted recipients.
29053
29054 .vitem &*recipient_item&~*recipients_list*&
29055 .cindex "recipient" "adding in local scan"
29056 .cindex "recipient" "removing in local scan"
29057 The list of accepted recipients, held in a vector of length
29058 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
29059 can add additional recipients by calling &'receive_add_recipient()'& (see
29060 below). You can delete recipients by removing them from the vector and
29061 adjusting the value in &%recipients_count%&. In particular, by setting
29062 &%recipients_count%& to zero you remove all recipients. If you then return the
29063 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
29064 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
29065 and then call &'receive_add_recipient()'& as often as needed.
29066
29067 .vitem &*uschar&~*sender_address*&
29068 The envelope sender address. For bounce messages this is the empty string.
29069
29070 .vitem &*uschar&~*sender_host_address*&
29071 The IP address of the sending host, as a string. This is NULL for
29072 locally-submitted messages.
29073
29074 .vitem &*uschar&~*sender_host_authenticated*&
29075 The name of the authentication mechanism that was used, or NULL if the message
29076 was not received over an authenticated SMTP connection.
29077
29078 .vitem &*uschar&~*sender_host_name*&
29079 The name of the sending host, if known.
29080
29081 .vitem &*int&~sender_host_port*&
29082 The port on the sending host.
29083
29084 .vitem &*BOOL&~smtp_input*&
29085 This variable is TRUE for all SMTP input, including BSMTP.
29086
29087 .vitem &*BOOL&~smtp_batched_input*&
29088 This variable is TRUE for BSMTP input.
29089
29090 .vitem &*int&~store_pool*&
29091 The contents of this variable control which pool of memory is used for new
29092 requests. See section &<<SECTmemhanloc>>& for details.
29093 .endlist
29094
29095
29096 .section "Structure of header lines" "SECID209"
29097 The &%header_line%& structure contains the members listed below.
29098 You can add additional header lines by calling the &'header_add()'& function
29099 (see below). You can cause header lines to be ignored (deleted) by setting
29100 their type to *.
29101
29102
29103 .vlist
29104 .vitem &*struct&~header_line&~*next*&
29105 A pointer to the next header line, or NULL for the last line.
29106
29107 .vitem &*int&~type*&
29108 A code identifying certain headers that Exim recognizes. The codes are printing
29109 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
29110 Notice in particular that any header line whose type is * is not transmitted
29111 with the message. This flagging is used for header lines that have been
29112 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
29113 lines.) Effectively, * means &"deleted"&.
29114
29115 .vitem &*int&~slen*&
29116 The number of characters in the header line, including the terminating and any
29117 internal newlines.
29118
29119 .vitem &*uschar&~*text*&
29120 A pointer to the text of the header. It always ends with a newline, followed by
29121 a zero byte. Internal newlines are preserved.
29122 .endlist
29123
29124
29125
29126 .section "Structure of recipient items" "SECID210"
29127 The &%recipient_item%& structure contains these members:
29128
29129 .vlist
29130 .vitem &*uschar&~*address*&
29131 This is a pointer to the recipient address as it was received.
29132
29133 .vitem &*int&~pno*&
29134 This is used in later Exim processing when top level addresses are created by
29135 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
29136 and must always contain -1 at this stage.
29137
29138 .vitem &*uschar&~*errors_to*&
29139 If this value is not NULL, bounce messages caused by failing to deliver to the
29140 recipient are sent to the address it contains. In other words, it overrides the
29141 envelope sender for this one recipient. (Compare the &%errors_to%& generic
29142 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
29143 an unqualified address, Exim qualifies it using the domain from
29144 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
29145 is NULL for all recipients.
29146 .endlist
29147
29148
29149
29150 .section "Available Exim functions" "SECID211"
29151 .cindex "&[local_scan()]& function" "available Exim functions"
29152 The header &_local_scan.h_& gives you access to a number of Exim functions.
29153 These are the only ones that are guaranteed to be maintained from release to
29154 release:
29155
29156 .vlist
29157 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
29158        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
29159
29160 This function creates a child process that runs the command specified by
29161 &%argv%&. The environment for the process is specified by &%envp%&, which can
29162 be NULL if no environment variables are to be passed. A new umask is supplied
29163 for the process in &%newumask%&.
29164
29165 Pipes to the standard input and output of the new process are set up
29166 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
29167 standard error is cloned to the standard output. If there are any file
29168 descriptors &"in the way"& in the new process, they are closed. If the final
29169 argument is TRUE, the new process is made into a process group leader.
29170
29171 The function returns the pid of the new process, or -1 if things go wrong.
29172
29173 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
29174 This function waits for a child process to terminate, or for a timeout (in
29175 seconds) to expire. A timeout value of zero means wait as long as it takes. The
29176 return value is as follows:
29177
29178 .ilist
29179 >= 0
29180
29181 The process terminated by a normal exit and the value is the process
29182 ending status.
29183
29184 .next
29185 < 0 and > &--256
29186
29187 The process was terminated by a signal and the value is the negation of the
29188 signal number.
29189
29190 .next
29191 &--256
29192
29193 The process timed out.
29194 .next
29195 &--257
29196
29197 The was some other error in wait(); &%errno%& is still set.
29198 .endlist
29199
29200 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
29201 This function provide you with a means of submitting a new message to
29202 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
29203 want, but this packages it all up for you.) The function creates a pipe,
29204 forks a subprocess that is running
29205 .code
29206 exim -t -oem -oi -f <>
29207 .endd
29208 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
29209 that is connected to the standard input. The yield of the function is the PID
29210 of the subprocess. You can then write a message to the file descriptor, with
29211 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
29212
29213 When you have finished, call &'child_close()'& to wait for the process to
29214 finish and to collect its ending status. A timeout value of zero is usually
29215 fine in this circumstance. Unless you have made a mistake with the recipient
29216 addresses, you should get a return code of zero.
29217
29218
29219 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
29220        *sender_authentication)*&
29221 This function is a more sophisticated version of &'child_open()'&. The command
29222 that it runs is:
29223 .display
29224 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
29225 .endd
29226 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
29227
29228
29229 .vitem &*void&~debug_printf(char&~*,&~...)*&
29230 This is Exim's debugging function, with arguments as for &'(printf()'&. The
29231 output is written to the standard error stream. If no debugging is selected,
29232 calls to &'debug_printf()'& have no effect. Normally, you should make calls
29233 conditional on the &`local_scan`& debug selector by coding like this:
29234 .code
29235 if ((debug_selector & D_local_scan) != 0)
29236   debug_printf("xxx", ...);
29237 .endd
29238
29239 .vitem &*uschar&~*expand_string(uschar&~*string)*&
29240 This is an interface to Exim's string expansion code. The return value is the
29241 expanded string, or NULL if there was an expansion failure.
29242 The C variable &%expand_string_message%& contains an error message after an
29243 expansion failure. If expansion does not change the string, the return value is
29244 the pointer to the input string. Otherwise, the return value points to a new
29245 block of memory that was obtained by a call to &'store_get()'&. See section
29246 &<<SECTmemhanloc>>& below for a discussion of memory handling.
29247
29248 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
29249 This function allows you to an add additional header line at the end of the
29250 existing ones. The first argument is the type, and should normally be a space
29251 character. The second argument is a format string and any number of
29252 substitution arguments as for &[sprintf()]&. You may include internal newlines
29253 if you want, and you must ensure that the string ends with a newline.
29254
29255 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
29256         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
29257 This function adds a new header line at a specified point in the header
29258 chain. The header itself is specified as for &'header_add()'&.
29259
29260 If &%name%& is NULL, the new header is added at the end of the chain if
29261 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
29262 NULL, the header lines are searched for the first non-deleted header that
29263 matches the name. If one is found, the new header is added before it if
29264 &%after%& is false. If &%after%& is true, the new header is added after the
29265 found header and any adjacent subsequent ones with the same name (even if
29266 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
29267 option controls where the header is added. If it is true, addition is at the
29268 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
29269 headers, or at the top if there are no &'Received:'& headers, you could use
29270 .code
29271 header_add_at_position(TRUE, US"Received", TRUE,
29272   ' ', "X-xxx: ...");
29273 .endd
29274 Normally, there is always at least one non-deleted &'Received:'& header, but
29275 there may not be if &%received_header_text%& expands to an empty string.
29276
29277
29278 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
29279 This function removes header lines. If &%occurrence%& is zero or negative, all
29280 occurrences of the header are removed. If occurrence is greater than zero, that
29281 particular instance of the header is removed. If no header(s) can be found that
29282 match the specification, the function does nothing.
29283
29284
29285 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
29286         int&~length,&~BOOL&~notdel)*&"
29287 This function tests whether the given header has the given name. It is not just
29288 a string comparison, because white space is permitted between the name and the
29289 colon. If the &%notdel%& argument is true, a false return is forced for all
29290 &"deleted"& headers; otherwise they are not treated specially. For example:
29291 .code
29292 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
29293 .endd
29294 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
29295 .cindex "base64 encoding" "functions for &[local_scan()]& use"
29296 This function base64-encodes a string, which is passed by address and length.
29297 The text may contain bytes of any value, including zero. The result is passed
29298 back in dynamic memory that is obtained by calling &'store_get()'&. It is
29299 zero-terminated.
29300
29301 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
29302 This function decodes a base64-encoded string. Its arguments are a
29303 zero-terminated base64-encoded string and the address of a variable that is set
29304 to point to the result, which is in dynamic memory. The length of the decoded
29305 string is the yield of the function. If the input is invalid base64 data, the
29306 yield is -1. A zero byte is added to the end of the output string to make it
29307 easy to interpret as a C string (assuming it contains no zeros of its own). The
29308 added zero byte is not included in the returned count.
29309
29310 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
29311 This function checks for a match in a domain list. Domains are always
29312 matched caselessly. The return value is one of the following:
29313 .display
29314 &`OK     `& match succeeded
29315 &`FAIL   `& match failed
29316 &`DEFER  `& match deferred
29317 .endd
29318 DEFER is usually caused by some kind of lookup defer, such as the
29319 inability to contact a database.
29320
29321 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
29322         BOOL&~caseless)*&"
29323 This function checks for a match in a local part list. The third argument
29324 controls case-sensitivity. The return values are as for
29325 &'lss_match_domain()'&.
29326
29327 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
29328         BOOL&~caseless)*&"
29329 This function checks for a match in an address list. The third argument
29330 controls the case-sensitivity of the local part match. The domain is always
29331 matched caselessly. The return values are as for &'lss_match_domain()'&.
29332
29333 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
29334         uschar&~*list)*&"
29335 This function checks for a match in a host list. The most common usage is
29336 expected to be
29337 .code
29338 lss_match_host(sender_host_name, sender_host_address, ...)
29339 .endd
29340 .vindex "&$sender_host_address$&"
29341 An empty address field matches an empty item in the host list. If the host name
29342 is NULL, the name corresponding to &$sender_host_address$& is automatically
29343 looked up if a host name is required to match an item in the list. The return
29344 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
29345 returns ERROR in the case when it had to look up a host name, but the lookup
29346 failed.
29347
29348 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
29349         *format,&~...)*&"
29350 This function writes to Exim's log files. The first argument should be zero (it
29351 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
29352 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
29353 them. It specifies to which log or logs the message is written. The remaining
29354 arguments are a format and relevant insertion arguments. The string should not
29355 contain any newlines, not even at the end.
29356
29357
29358 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
29359 This function adds an additional recipient to the message. The first argument
29360 is the recipient address. If it is unqualified (has no domain), it is qualified
29361 with the &%qualify_recipient%& domain. The second argument must always be -1.
29362
29363 This function does not allow you to specify a private &%errors_to%& address (as
29364 described with the structure of &%recipient_item%& above), because it pre-dates
29365 the addition of that field to the structure. However, it is easy to add such a
29366 value afterwards. For example:
29367 .code
29368  receive_add_recipient(US"monitor@mydom.example", -1);
29369  recipients_list[recipients_count-1].errors_to =
29370    US"postmaster@mydom.example";
29371 .endd
29372
29373 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
29374 This is a convenience function to remove a named recipient from the list of
29375 recipients. It returns true if a recipient was removed, and false if no
29376 matching recipient could be found. The argument must be a complete email
29377 address.
29378 .endlist
29379
29380
29381 .cindex "RFC 2047"
29382 .vlist
29383 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
29384   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
29385 This function decodes strings that are encoded according to RFC 2047. Typically
29386 these are the contents of header lines. First, each &"encoded word"& is decoded
29387 from the Q or B encoding into a byte-string. Then, if provided with the name of
29388 a charset encoding, and if the &[iconv()]& function is available, an attempt is
29389 made  to translate the result to the named character set. If this fails, the
29390 binary string is returned with an error message.
29391
29392 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
29393 maximum MIME word length is enforced. The third argument is the target
29394 encoding, or NULL if no translation is wanted.
29395
29396 .cindex "binary zero" "in RFC 2047 decoding"
29397 .cindex "RFC 2047" "binary zero in"
29398 If a binary zero is encountered in the decoded string, it is replaced by the
29399 contents of the &%zeroval%& argument. For use with Exim headers, the value must
29400 not be 0 because header lines are handled as zero-terminated strings.
29401
29402 The function returns the result of processing the string, zero-terminated; if
29403 &%lenptr%& is not NULL, the length of the result is set in the variable to
29404 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
29405
29406 If an error is encountered, the function returns NULL and uses the &%error%&
29407 argument to return an error message. The variable pointed to by &%error%& is
29408 set to NULL if there is no error; it may be set non-NULL even when the function
29409 returns a non-NULL value if decoding was successful, but there was a problem
29410 with translation.
29411
29412
29413 .vitem &*int&~smtp_fflush(void)*&
29414 This function is used in conjunction with &'smtp_printf()'&, as described
29415 below.
29416
29417 .vitem &*void&~smtp_printf(char&~*,&~...)*&
29418 The arguments of this function are like &[printf()]&; it writes to the SMTP
29419 output stream. You should use this function only when there is an SMTP output
29420 stream, that is, when the incoming message is being received via interactive
29421 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
29422 is FALSE. If you want to test for an incoming message from another host (as
29423 opposed to a local process that used the &%-bs%& command line option), you can
29424 test the value of &%sender_host_address%&, which is non-NULL when a remote host
29425 is involved.
29426
29427 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
29428 output function, so it can be used for all forms of SMTP connection.
29429
29430 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
29431 must start with an appropriate response code: 550 if you are going to return
29432 LOCAL_SCAN_REJECT, 451 if you are going to return
29433 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
29434 initial lines of a multi-line response, the code must be followed by a hyphen
29435 to indicate that the line is not the final response line. You must also ensure
29436 that the lines you write terminate with CRLF. For example:
29437 .code
29438 smtp_printf("550-this is some extra info\r\n");
29439 return LOCAL_SCAN_REJECT;
29440 .endd
29441 Note that you can also create multi-line responses by including newlines in
29442 the data returned via the &%return_text%& argument. The added value of using
29443 &'smtp_printf()'& is that, for instance, you could introduce delays between
29444 multiple output lines.
29445
29446 The &'smtp_printf()'& function does not return any error indication, because it
29447 does not automatically flush pending output, and therefore does not test
29448 the state of the stream. (In the main code of Exim, flushing and error
29449 detection is done when Exim is ready for the next SMTP input command.) If
29450 you want to flush the output and check for an error (for example, the
29451 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
29452 arguments. It flushes the output stream, and returns a non-zero value if there
29453 is an error.
29454
29455 .vitem &*void&~*store_get(int)*&
29456 This function accesses Exim's internal store (memory) manager. It gets a new
29457 chunk of memory whose size is given by the argument. Exim bombs out if it ever
29458 runs out of memory. See the next section for a discussion of memory handling.
29459
29460 .vitem &*void&~*store_get_perm(int)*&
29461 This function is like &'store_get()'&, but it always gets memory from the
29462 permanent pool. See the next section for a discussion of memory handling.
29463
29464 .vitem &*uschar&~*string_copy(uschar&~*string)*&
29465 See below.
29466
29467 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
29468 See below.
29469
29470 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
29471 These three functions create strings using Exim's dynamic memory facilities.
29472 The first makes a copy of an entire string. The second copies up to a maximum
29473 number of characters, indicated by the second argument. The third uses a format
29474 and insertion arguments to create a new string. In each case, the result is a
29475 pointer to a new string in the current memory pool. See the next section for
29476 more discussion.
29477 .endlist
29478
29479
29480
29481 .section "More about Exim's memory handling" "SECTmemhanloc"
29482 .cindex "&[local_scan()]& function" "memory handling"
29483 No function is provided for freeing memory, because that is never needed.
29484 The dynamic memory that Exim uses when receiving a message is automatically
29485 recycled if another message is received by the same process (this applies only
29486 to incoming SMTP connections &-- other input methods can supply only one
29487 message at a time). After receiving the last message, a reception process
29488 terminates.
29489
29490 Because it is recycled, the normal dynamic memory cannot be used for holding
29491 data that must be preserved over a number of incoming messages on the same SMTP
29492 connection. However, Exim in fact uses two pools of dynamic memory; the second
29493 one is not recycled, and can be used for this purpose.
29494
29495 If you want to allocate memory that remains available for subsequent messages
29496 in the same SMTP connection, you should set
29497 .code
29498 store_pool = POOL_PERM
29499 .endd
29500 before calling the function that does the allocation. There is no need to
29501 restore the value if you do not need to; however, if you do want to revert to
29502 the normal pool, you can either restore the previous value of &%store_pool%& or
29503 set it explicitly to POOL_MAIN.
29504
29505 The pool setting applies to all functions that get dynamic memory, including
29506 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
29507 There is also a convenience function called &'store_get_perm()'& that gets a
29508 block of memory from the permanent pool while preserving the value of
29509 &%store_pool%&.
29510 .ecindex IIDlosca
29511
29512
29513
29514
29515 . ////////////////////////////////////////////////////////////////////////////
29516 . ////////////////////////////////////////////////////////////////////////////
29517
29518 .chapter "System-wide message filtering" "CHAPsystemfilter"
29519 .scindex IIDsysfil1 "filter" "system filter"
29520 .scindex IIDsysfil2 "filtering all mail"
29521 .scindex IIDsysfil3 "system filter"
29522 The previous chapters (on ACLs and the local scan function) describe checks
29523 that can be applied to messages before they are accepted by a host. There is
29524 also a mechanism for checking messages once they have been received, but before
29525 they are delivered. This is called the &'system filter'&.
29526
29527 The system filter operates in a similar manner to users' filter files, but it
29528 is run just once per message (however many recipients the message has).
29529 It should not normally be used as a substitute for routing, because &%deliver%&
29530 commands in a system router provide new envelope recipient addresses.
29531 The system filter must be an Exim filter. It cannot be a Sieve filter.
29532
29533 The system filter is run at the start of a delivery attempt, before any routing
29534 is done. If a message fails to be completely delivered at the first attempt,
29535 the system filter is run again at the start of every retry.
29536 If you want your filter to do something only once per message, you can make use
29537 of the &%first_delivery%& condition in an &%if%& command in the filter to
29538 prevent it happening on retries.
29539
29540 .vindex "&$domain$&"
29541 .vindex "&$local_part$&"
29542 &*Warning*&: Because the system filter runs just once, variables that are
29543 specific to individual recipient addresses, such as &$local_part$& and
29544 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
29545 you want to run a centrally-specified filter for each recipient address
29546 independently, you can do so by setting up a suitable &(redirect)& router, as
29547 described in section &<<SECTperaddfil>>& below.
29548
29549
29550 .section "Specifying a system filter" "SECID212"
29551 .cindex "uid (user id)" "system filter"
29552 .cindex "gid (group id)" "system filter"
29553 The name of the file that contains the system filter must be specified by
29554 setting &%system_filter%&. If you want the filter to run under a uid and gid
29555 other than root, you must also set &%system_filter_user%& and
29556 &%system_filter_group%& as appropriate. For example:
29557 .code
29558 system_filter = /etc/mail/exim.filter
29559 system_filter_user = exim
29560 .endd
29561 If a system filter generates any deliveries directly to files or pipes (via the
29562 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
29563 specified by setting &%system_filter_file_transport%& and
29564 &%system_filter_pipe_transport%&, respectively. Similarly,
29565 &%system_filter_reply_transport%& must be set to handle any messages generated
29566 by the &%reply%& command.
29567
29568
29569 .section "Testing a system filter" "SECID213"
29570 You can run simple tests of a system filter in the same way as for a user
29571 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
29572 are permitted only in system filters are recognized.
29573
29574 If you want to test the combined effect of a system filter and a user filter,
29575 you can use both &%-bF%& and &%-bf%& on the same command line.
29576
29577
29578
29579 .section "Contents of a system filter" "SECID214"
29580 The language used to specify system filters is the same as for users' filter
29581 files. It is described in the separate end-user document &'Exim's interface to
29582 mail filtering'&. However, there are some additional features that are
29583 available only in system filters; these are described in subsequent sections.
29584 If they are encountered in a user's filter file or when testing with &%-bf%&,
29585 they cause errors.
29586
29587 .cindex "frozen messages" "manual thaw; testing in filter"
29588 There are two special conditions which, though available in users' filter
29589 files, are designed for use in system filters. The condition &%first_delivery%&
29590 is true only for the first attempt at delivering a message, and
29591 &%manually_thawed%& is true only if the message has been frozen, and
29592 subsequently thawed by an admin user. An explicit forced delivery counts as a
29593 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
29594
29595 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
29596 specify an &"unseen"& (non-significant) delivery, and that delivery does not
29597 succeed, it will not be tried again.
29598 If you want Exim to retry an unseen delivery until it succeeds, you should
29599 arrange to set it up every time the filter runs.
29600
29601 When a system filter finishes running, the values of the variables &$n0$& &--
29602 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
29603 users' filter files. Thus a system filter can, for example, set up &"scores"&
29604 to which users' filter files can refer.
29605
29606
29607
29608 .section "Additional variable for system filters" "SECID215"
29609 .vindex "&$recipients$&"
29610 The expansion variable &$recipients$&, containing a list of all the recipients
29611 of the message (separated by commas and white space), is available in system
29612 filters. It is not available in users' filters for privacy reasons.
29613
29614
29615
29616 .section "Defer, freeze, and fail commands for system filters" "SECID216"
29617 .cindex "freezing messages"
29618 .cindex "message" "freezing"
29619 .cindex "message" "forced failure"
29620 .cindex "&%fail%&" "in system filter"
29621 .cindex "&%freeze%& in system filter"
29622 .cindex "&%defer%& in system filter"
29623 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
29624 always available in system filters, but are not normally enabled in users'
29625 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
29626 for the &(redirect)& router.) These commands can optionally be followed by the
29627 word &%text%& and a string containing an error message, for example:
29628 .code
29629 fail text "this message looks like spam to me"
29630 .endd
29631 The keyword &%text%& is optional if the next character is a double quote.
29632
29633 The &%defer%& command defers delivery of the original recipients of the
29634 message. The &%fail%& command causes all the original recipients to be failed,
29635 and a bounce message to be created. The &%freeze%& command suspends all
29636 delivery attempts for the original recipients. In all cases, any new deliveries
29637 that are specified by the filter are attempted as normal after the filter has
29638 run.
29639
29640 The &%freeze%& command is ignored if the message has been manually unfrozen and
29641 not manually frozen since. This means that automatic freezing by a system
29642 filter can be used as a way of checking out suspicious messages. If a message
29643 is found to be all right, manually unfreezing it allows it to be delivered.
29644
29645 .cindex "log" "&%fail%& command log line"
29646 .cindex "&%fail%&" "log line; reducing"
29647 The text given with a fail command is used as part of the bounce message as
29648 well as being written to the log. If the message is quite long, this can fill
29649 up a lot of log space when such failures are common. To reduce the size of the
29650 log message, Exim interprets the text in a special way if it starts with the
29651 two characters &`<<`& and contains &`>>`& later. The text between these two
29652 strings is written to the log, and the rest of the text is used in the bounce
29653 message. For example:
29654 .code
29655 fail "<<filter test 1>>Your message is rejected \
29656      because it contains attachments that we are \
29657      not prepared to receive."
29658 .endd
29659
29660 .cindex "loop" "caused by &%fail%&"
29661 Take great care with the &%fail%& command when basing the decision to fail on
29662 the contents of the message, because the bounce message will of course include
29663 the contents of the original message and will therefore trigger the &%fail%&
29664 command again (causing a mail loop) unless steps are taken to prevent this.
29665 Testing the &%error_message%& condition is one way to prevent this. You could
29666 use, for example
29667 .code
29668 if $message_body contains "this is spam" and not error_message
29669 then fail text "spam is not wanted here" endif
29670 .endd
29671 though of course that might let through unwanted bounce messages. The
29672 alternative is clever checking of the body and/or headers to detect bounces
29673 generated by the filter.
29674
29675 The interpretation of a system filter file ceases after a
29676 &%defer%&,
29677 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
29678 set up earlier in the filter file are honoured, so you can use a sequence such
29679 as
29680 .code
29681 mail ...
29682 freeze
29683 .endd
29684 to send a specified message when the system filter is freezing (or deferring or
29685 failing) a message. The normal deliveries for the message do not, of course,
29686 take place.
29687
29688
29689
29690 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
29691 .cindex "header lines" "adding; in system filter"
29692 .cindex "header lines" "removing; in system filter"
29693 .cindex "filter" "header lines; adding/removing"
29694 Two filter commands that are available only in system filters are:
29695 .code
29696 headers add <string>
29697 headers remove <string>
29698 .endd
29699 The argument for the &%headers add%& is a string that is expanded and then
29700 added to the end of the message's headers. It is the responsibility of the
29701 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
29702 space is ignored, and if the string is otherwise empty, or if the expansion is
29703 forced to fail, the command has no effect.
29704
29705 You can use &"\n"& within the string, followed by white space, to specify
29706 continued header lines. More than one header may be added in one command by
29707 including &"\n"& within the string without any following white space. For
29708 example:
29709 .code
29710 headers add "X-header-1: ....\n  \
29711              continuation of X-header-1 ...\n\
29712              X-header-2: ...."
29713 .endd
29714 Note that the header line continuation white space after the first newline must
29715 be placed before the backslash that continues the input string, because white
29716 space after input continuations is ignored.
29717
29718 The argument for &%headers remove%& is a colon-separated list of header names.
29719 This command applies only to those headers that are stored with the message;
29720 those that are added at delivery time (such as &'Envelope-To:'& and
29721 &'Return-Path:'&) cannot be removed by this means. If there is more than one
29722 header with the same name, they are all removed.
29723
29724 The &%headers%& command in a system filter makes an immediate change to the set
29725 of header lines that was received with the message (with possible additions
29726 from ACL processing). Subsequent commands in the system filter operate on the
29727 modified set, which also forms the basis for subsequent message delivery.
29728 Unless further modified during routing or transporting, this set of headers is
29729 used for all recipients of the message.
29730
29731 During routing and transporting, the variables that refer to the contents of
29732 header lines refer only to those lines that are in this set. Thus, header lines
29733 that are added by a system filter are visible to users' filter files and to all
29734 routers and transports. This contrasts with the manipulation of header lines by
29735 routers and transports, which is not immediate, but which instead is saved up
29736 until the message is actually being written (see section
29737 &<<SECTheadersaddrem>>&).
29738
29739 If the message is not delivered at the first attempt, header lines that were
29740 added by the system filter are stored with the message, and so are still
29741 present at the next delivery attempt. Header lines that were removed are still
29742 present, but marked &"deleted"& so that they are not transported with the
29743 message. For this reason, it is usual to make the &%headers%& command
29744 conditional on &%first_delivery%& so that the set of header lines is not
29745 modified more than once.
29746
29747 Because header modification in a system filter acts immediately, you have to
29748 use an indirect approach if you want to modify the contents of a header line.
29749 For example:
29750 .code
29751 headers add "Old-Subject: $h_subject:"
29752 headers remove "Subject"
29753 headers add "Subject: new subject (was: $h_old-subject:)"
29754 headers remove "Old-Subject"
29755 .endd
29756
29757
29758
29759 .section "Setting an errors address in a system filter" "SECID217"
29760 .cindex "envelope sender"
29761 In a system filter, if a &%deliver%& command is followed by
29762 .code
29763 errors_to <some address>
29764 .endd
29765 in order to change the envelope sender (and hence the error reporting) for that
29766 delivery, any address may be specified. (In a user filter, only the current
29767 user's address can be set.) For example, if some mail is being monitored, you
29768 might use
29769 .code
29770 unseen deliver monitor@spying.example errors_to root@local.example
29771 .endd
29772 to take a copy which would not be sent back to the normal error reporting
29773 address if its delivery failed.
29774
29775
29776
29777 .section "Per-address filtering" "SECTperaddfil"
29778 .vindex "&$domain$&"
29779 .vindex "&$local_part$&"
29780 In contrast to the system filter, which is run just once per message for each
29781 delivery attempt, it is also possible to set up a system-wide filtering
29782 operation that runs once for each recipient address. In this case, variables
29783 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
29784 filter file could be made dependent on them. This is an example of a router
29785 which implements such a filter:
29786 .code
29787 central_filter:
29788   check_local_user
29789   driver = redirect
29790   domains = +local_domains
29791   file = /central/filters/$local_part
29792   no_verify
29793   allow_filter
29794   allow_freeze
29795 .endd
29796 The filter is run in a separate process under its own uid. Therefore, either
29797 &%check_local_user%& must be set (as above), in which case the filter is run as
29798 the local user, or the &%user%& option must be used to specify which user to
29799 use. If both are set, &%user%& overrides.
29800
29801 Care should be taken to ensure that none of the commands in the filter file
29802 specify a significant delivery if the message is to go on to be delivered to
29803 its intended recipient. The router will not then claim to have dealt with the
29804 address, so it will be passed on to subsequent routers to be delivered in the
29805 normal way.
29806 .ecindex IIDsysfil1
29807 .ecindex IIDsysfil2
29808 .ecindex IIDsysfil3
29809
29810
29811
29812
29813
29814
29815 . ////////////////////////////////////////////////////////////////////////////
29816 . ////////////////////////////////////////////////////////////////////////////
29817
29818 .chapter "Message processing" "CHAPmsgproc"
29819 .scindex IIDmesproc "message" "general processing"
29820 Exim performs various transformations on the sender and recipient addresses of
29821 all messages that it handles, and also on the messages' header lines. Some of
29822 these are optional and configurable, while others always take place. All of
29823 this processing, except rewriting as a result of routing, and the addition or
29824 removal of header lines while delivering, happens when a message is received,
29825 before it is placed on Exim's queue.
29826
29827 Some of the automatic processing takes place by default only for
29828 &"locally-originated"& messages. This adjective is used to describe messages
29829 that are not received over TCP/IP, but instead are passed to an Exim process on
29830 its standard input. This includes the interactive &"local SMTP"& case that is
29831 set up by the &%-bs%& command line option.
29832
29833 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
29834 or ::1) are not considered to be locally-originated. Exim does not treat the
29835 loopback interface specially in any way.
29836
29837 If you want the loopback interface to be treated specially, you must ensure
29838 that there are appropriate entries in your ACLs.
29839
29840
29841
29842
29843 .section "Submission mode for non-local messages" "SECTsubmodnon"
29844 .cindex "message" "submission"
29845 .cindex "submission mode"
29846 Processing that happens automatically for locally-originated messages (unless
29847 &%suppress_local_fixups%& is set) can also be requested for messages that are
29848 received over TCP/IP. The term &"submission mode"& is used to describe this
29849 state. Submission mode is set by the modifier
29850 .code
29851 control = submission
29852 .endd
29853 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
29854 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
29855 a local submission, and is normally used when the source of the message is
29856 known to be an MUA running on a client host (as opposed to an MTA). For
29857 example, to set submission mode for messages originating on the IPv4 loopback
29858 interface, you could include the following in the MAIL ACL:
29859 .code
29860 warn  hosts = 127.0.0.1
29861       control = submission
29862 .endd
29863 .cindex "&%sender_retain%& submission option"
29864 There are some options that can be used when setting submission mode. A slash
29865 is used to separate options. For example:
29866 .code
29867 control = submission/sender_retain
29868 .endd
29869 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
29870 true and &%local_from_check%& false for the current incoming message. The first
29871 of these allows an existing &'Sender:'& header in the message to remain, and
29872 the second suppresses the check to ensure that &'From:'& matches the
29873 authenticated sender. With this setting, Exim still fixes up messages by adding
29874 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
29875 attempt to check sender authenticity in header lines.
29876
29877 When &%sender_retain%& is not set, a submission mode setting may specify a
29878 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
29879 example:
29880 .code
29881 control = submission/domain=some.domain
29882 .endd
29883 The domain may be empty. How this value is used is described in sections
29884 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
29885 that allows you to specify the user's full name for inclusion in a created
29886 &'Sender:'& or &'From:'& header line. For example:
29887 .code
29888 accept authenticated = *
29889        control = submission/domain=wonderland.example/\
29890                             name=${lookup {$authenticated_id} \
29891                                    lsearch {/etc/exim/namelist}}
29892 .endd
29893 Because the name may contain any characters, including slashes, the &%name%&
29894 option must be given last. The remainder of the string is used as the name. For
29895 the example above, if &_/etc/exim/namelist_& contains:
29896 .code
29897 bigegg:  Humpty Dumpty
29898 .endd
29899 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
29900 line would be:
29901 .code
29902 Sender: Humpty Dumpty <bigegg@wonderland.example>
29903 .endd
29904 .cindex "return path" "in submission mode"
29905 By default, submission mode forces the return path to the same address as is
29906 used to create the &'Sender:'& header. However, if &%sender_retain%& is
29907 specified, the return path is also left unchanged.
29908
29909 &*Note*&: The changes caused by submission mode take effect after the predata
29910 ACL. This means that any sender checks performed before the fix-ups use the
29911 untrusted sender address specified by the user, not the trusted sender address
29912 specified by submission mode. Although this might be slightly unexpected, it
29913 does mean that you can configure ACL checks to spot that a user is trying to
29914 spoof another's address.
29915
29916 .section "Line endings" "SECTlineendings"
29917 .cindex "line endings"
29918 .cindex "carriage return"
29919 .cindex "linefeed"
29920 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
29921 linefeed) is the line ending for messages transmitted over the Internet using
29922 SMTP over TCP/IP. However, within individual operating systems, different
29923 conventions are used. For example, Unix-like systems use just LF, but others
29924 use CRLF or just CR.
29925
29926 Exim was designed for Unix-like systems, and internally, it stores messages
29927 using the system's convention of a single LF as a line terminator. When
29928 receiving a message, all line endings are translated to this standard format.
29929 Originally, it was thought that programs that passed messages directly to an
29930 MTA within an operating system would use that system's convention. Experience
29931 has shown that this is not the case; for example, there are Unix applications
29932 that use CRLF in this circumstance. For this reason, and for compatibility with
29933 other MTAs, the way Exim handles line endings for all messages is now as
29934 follows:
29935
29936 .ilist
29937 LF not preceded by CR is treated as a line ending.
29938 .next
29939 CR is treated as a line ending; if it is immediately followed by LF, the LF
29940 is ignored.
29941 .next
29942 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
29943 nor a local message in the state where a line containing only a dot is a
29944 terminator.
29945 .next
29946 If a bare CR is encountered within a header line, an extra space is added after
29947 the line terminator so as not to end the header line. The reasoning behind this
29948 is that bare CRs in header lines are most likely either to be mistakes, or
29949 people trying to play silly games.
29950 .next
29951 If the first header line received in a message ends with CRLF, a subsequent
29952 bare LF in a header line is treated in the same way as a bare CR in a header
29953 line.
29954 .endlist
29955
29956
29957
29958
29959
29960 .section "Unqualified addresses" "SECID218"
29961 .cindex "unqualified addresses"
29962 .cindex "address" "qualification"
29963 By default, Exim expects every envelope address it receives from an external
29964 host to be fully qualified. Unqualified addresses cause negative responses to
29965 SMTP commands. However, because SMTP is used as a means of transporting
29966 messages from MUAs running on personal workstations, there is sometimes a
29967 requirement to accept unqualified addresses from specific hosts or IP networks.
29968
29969 Exim has two options that separately control which hosts may send unqualified
29970 sender or recipient addresses in SMTP commands, namely
29971 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
29972 cases, if an unqualified address is accepted, it is qualified by adding the
29973 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
29974
29975 .oindex "&%qualify_domain%&"
29976 .oindex "&%qualify_recipient%&"
29977 Unqualified addresses in header lines are automatically qualified for messages
29978 that are locally originated, unless the &%-bnq%& option is given on the command
29979 line. For messages received over SMTP, unqualified addresses in header lines
29980 are qualified only if unqualified addresses are permitted in SMTP commands. In
29981 other words, such qualification is also controlled by
29982 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
29983
29984
29985
29986
29987 .section "The UUCP From line" "SECID219"
29988 .cindex "&""From""& line"
29989 .cindex "UUCP" "&""From""& line"
29990 .cindex "sender" "address"
29991 .oindex "&%uucp_from_pattern%&"
29992 .oindex "&%uucp_from_sender%&"
29993 .cindex "envelope sender"
29994 .cindex "Sendmail compatibility" "&""From""& line"
29995 Messages that have come from UUCP (and some other applications) often begin
29996 with a line containing the envelope sender and a timestamp, following the word
29997 &"From"&. Examples of two common formats are:
29998 .code
29999 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
30000 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
30001 .endd
30002 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
30003 Exim recognizes such lines at the start of messages that are submitted to it
30004 via the command line (that is, on the standard input). It does not recognize
30005 such lines in incoming SMTP messages, unless the sending host matches
30006 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
30007 and &%ignore_fromline_local%& is set. The recognition is controlled by a
30008 regular expression that is defined by the &%uucp_from_pattern%& option, whose
30009 default value matches the two common cases shown above and puts the address
30010 that follows &"From"& into &$1$&.
30011
30012 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
30013 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
30014 a trusted user, the message's sender address is constructed by expanding the
30015 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
30016 then parsed as an RFC 2822 address. If there is no domain, the local part is
30017 qualified with &%qualify_domain%& unless it is the empty string. However, if
30018 the command line &%-f%& option is used, it overrides the &"From"& line.
30019
30020 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
30021 sender address is not changed. This is also the case for incoming SMTP messages
30022 that are permitted to contain &"From"& lines.
30023
30024 Only one &"From"& line is recognized. If there is more than one, the second is
30025 treated as a data line that starts the body of the message, as it is not valid
30026 as a header line. This also happens if a &"From"& line is present in an
30027 incoming SMTP message from a source that is not permitted to send them.
30028
30029
30030
30031 .section "Resent- header lines" "SECID220"
30032 .cindex "&%Resent-%& header lines"
30033 RFC 2822 makes provision for sets of header lines starting with the string
30034 &`Resent-`& to be added to a message when it is resent by the original
30035 recipient to somebody else. These headers are &'Resent-Date:'&,
30036 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
30037 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
30038
30039 .blockquote
30040 &'Resent fields are strictly informational. They MUST NOT be used in the normal
30041 processing of replies or other such automatic actions on messages.'&
30042 .endblockquote
30043
30044 This leaves things a bit vague as far as other processing actions such as
30045 address rewriting are concerned. Exim treats &%Resent-%& header lines as
30046 follows:
30047
30048 .ilist
30049 A &'Resent-From:'& line that just contains the login id of the submitting user
30050 is automatically rewritten in the same way as &'From:'& (see below).
30051 .next
30052 If there's a rewriting rule for a particular header line, it is also applied to
30053 &%Resent-%& header lines of the same type. For example, a rule that rewrites
30054 &'From:'& also rewrites &'Resent-From:'&.
30055 .next
30056 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
30057 also removed.
30058 .next
30059 For a locally-submitted message,
30060 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
30061 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
30062 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
30063 included in log lines in this case.
30064 .next
30065 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
30066 &%Resent-%& header lines are present.
30067 .endlist
30068
30069
30070
30071
30072 .section "The Auto-Submitted: header line" "SECID221"
30073 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
30074 includes the header line:
30075 .code
30076 Auto-Submitted: auto-replied
30077 .endd
30078
30079 .section "The Bcc: header line" "SECID222"
30080 .cindex "&'Bcc:'& header line"
30081 If Exim is called with the &%-t%& option, to take recipient addresses from a
30082 message's header, it removes any &'Bcc:'& header line that may exist (after
30083 extracting its addresses). If &%-t%& is not present on the command line, any
30084 existing &'Bcc:'& is not removed.
30085
30086
30087 .section "The Date: header line" "SECID223"
30088 .cindex "&'Date:'& header line"
30089 If a locally-generated or submission-mode message has no &'Date:'& header line,
30090 Exim adds one, using the current date and time, unless the
30091 &%suppress_local_fixups%& control has been specified.
30092
30093 .section "The Delivery-date: header line" "SECID224"
30094 .cindex "&'Delivery-date:'& header line"
30095 .oindex "&%delivery_date_remove%&"
30096 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
30097 set. Exim can be configured to add them to the final delivery of messages. (See
30098 the generic &%delivery_date_add%& transport option.) They should not be present
30099 in messages in transit. If the &%delivery_date_remove%& configuration option is
30100 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
30101 messages.
30102
30103
30104 .section "The Envelope-to: header line" "SECID225"
30105 .cindex "&'Envelope-to:'& header line"
30106 .oindex "&%envelope_to_remove%&"
30107 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
30108 Exim can be configured to add them to the final delivery of messages. (See the
30109 generic &%envelope_to_add%& transport option.) They should not be present in
30110 messages in transit. If the &%envelope_to_remove%& configuration option is set
30111 (the default), Exim removes &'Envelope-to:'& header lines from incoming
30112 messages.
30113
30114
30115 .section "The From: header line" "SECTthefrohea"
30116 .cindex "&'From:'& header line"
30117 .cindex "Sendmail compatibility" "&""From""& line"
30118 .cindex "message" "submission"
30119 .cindex "submission mode"
30120 If a submission-mode message does not contain a &'From:'& header line, Exim
30121 adds one if either of the following conditions is true:
30122
30123 .ilist
30124 The envelope sender address is not empty (that is, this is not a bounce
30125 message). The added header line copies the envelope sender address.
30126 .next
30127 .vindex "&$authenticated_id$&"
30128 The SMTP session is authenticated and &$authenticated_id$& is not empty.
30129 .olist
30130 .vindex "&$qualify_domain$&"
30131 If no domain is specified by the submission control, the local part is
30132 &$authenticated_id$& and the domain is &$qualify_domain$&.
30133 .next
30134 If a non-empty domain is specified by the submission control, the local
30135 part is &$authenticated_id$&, and the domain is the specified domain.
30136 .next
30137 If an empty domain is specified by the submission control,
30138 &$authenticated_id$& is assumed to be the complete address.
30139 .endlist
30140 .endlist
30141
30142 A non-empty envelope sender takes precedence.
30143
30144 If a locally-generated incoming message does not contain a &'From:'& header
30145 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
30146 containing the sender's address. The calling user's login name and full name
30147 are used to construct the address, as described in section &<<SECTconstr>>&.
30148 They are obtained from the password data by calling &[getpwuid()]& (but see the
30149 &%unknown_login%& configuration option). The address is qualified with
30150 &%qualify_domain%&.
30151
30152 For compatibility with Sendmail, if an incoming, non-SMTP message has a
30153 &'From:'& header line containing just the unqualified login name of the calling
30154 user, this is replaced by an address containing the user's login name and full
30155 name as described in section &<<SECTconstr>>&.
30156
30157
30158 .section "The Message-ID: header line" "SECID226"
30159 .cindex "&'Message-ID:'& header line"
30160 .cindex "message" "submission"
30161 .oindex "&%message_id_header_text%&"
30162 If a locally-generated or submission-mode incoming message does not contain a
30163 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
30164 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
30165 to the message. If there are any &'Resent-:'& headers in the message, it
30166 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
30167 message id, preceded by the letter E to ensure it starts with a letter, and
30168 followed by @ and the primary host name. Additional information can be included
30169 in this header line by setting the &%message_id_header_text%& and/or
30170 &%message_id_header_domain%& options.
30171
30172
30173 .section "The Received: header line" "SECID227"
30174 .cindex "&'Received:'& header line"
30175 A &'Received:'& header line is added at the start of every message. The
30176 contents are defined by the &%received_header_text%& configuration option, and
30177 Exim automatically adds a semicolon and a timestamp to the configured string.
30178
30179 The &'Received:'& header is generated as soon as the message's header lines
30180 have been received. At this stage, the timestamp in the &'Received:'& header
30181 line is the time that the message started to be received. This is the value
30182 that is seen by the DATA ACL and by the &[local_scan()]& function.
30183
30184 Once a message is accepted, the timestamp in the &'Received:'& header line is
30185 changed to the time of acceptance, which is (apart from a small delay while the
30186 -H spool file is written) the earliest time at which delivery could start.
30187
30188
30189 .section "The References: header line" "SECID228"
30190 .cindex "&'References:'& header line"
30191 Messages created by the &(autoreply)& transport include a &'References:'&
30192 header line. This is constructed according to the rules that are described in
30193 section 3.64 of RFC 2822 (which states that replies should contain such a
30194 header line), and section 3.14 of RFC 3834 (which states that automatic
30195 responses are not different in this respect). However, because some mail
30196 processing software does not cope well with very long header lines, no more
30197 than 12 message IDs are copied from the &'References:'& header line in the
30198 incoming message. If there are more than 12, the first one and then the final
30199 11 are copied, before adding the message ID of the incoming message.
30200
30201
30202
30203 .section "The Return-path: header line" "SECID229"
30204 .cindex "&'Return-path:'& header line"
30205 .oindex "&%return_path_remove%&"
30206 &'Return-path:'& header lines are defined as something an MTA may insert when
30207 it does the final delivery of messages. (See the generic &%return_path_add%&
30208 transport option.) Therefore, they should not be present in messages in
30209 transit. If the &%return_path_remove%& configuration option is set (the
30210 default), Exim removes &'Return-path:'& header lines from incoming messages.
30211
30212
30213
30214 .section "The Sender: header line" "SECTthesenhea"
30215 .cindex "&'Sender:'& header line"
30216 .cindex "message" "submission"
30217 For a locally-originated message from an untrusted user, Exim may remove an
30218 existing &'Sender:'& header line, and it may add a new one. You can modify
30219 these actions by setting the &%local_sender_retain%& option true, the
30220 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
30221 control setting.
30222
30223 When a local message is received from an untrusted user and
30224 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
30225 control has not been set, a check is made to see if the address given in the
30226 &'From:'& header line is the correct (local) sender of the message. The address
30227 that is expected has the login name as the local part and the value of
30228 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
30229 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
30230 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
30231 line is added to the message.
30232
30233 If you set &%local_from_check%& false, this checking does not occur. However,
30234 the removal of an existing &'Sender:'& line still happens, unless you also set
30235 &%local_sender_retain%& to be true. It is not possible to set both of these
30236 options true at the same time.
30237
30238 .cindex "submission mode"
30239 By default, no processing of &'Sender:'& header lines is done for messages
30240 received over TCP/IP or for messages submitted by trusted users. However, when
30241 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
30242 not specified on the submission control, the following processing takes place:
30243
30244 .vindex "&$authenticated_id$&"
30245 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
30246 authenticated, and &$authenticated_id$& is not empty, a sender address is
30247 created as follows:
30248
30249 .ilist
30250 .vindex "&$qualify_domain$&"
30251 If no domain is specified by the submission control, the local part is
30252 &$authenticated_id$& and the domain is &$qualify_domain$&.
30253 .next
30254 If a non-empty domain is specified by the submission control, the local part
30255 is &$authenticated_id$&, and the domain is the specified domain.
30256 .next
30257 If an empty domain is specified by the submission control,
30258 &$authenticated_id$& is assumed to be the complete address.
30259 .endlist
30260
30261 This address is compared with the address in the &'From:'& header line. If they
30262 are different, a &'Sender:'& header line containing the created address is
30263 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
30264 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
30265
30266 .cindex "return path" "created from &'Sender:'&"
30267 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
30268 the message (the envelope sender address) is changed to be the same address,
30269 except in the case of submission mode when &%sender_retain%& is specified.
30270
30271
30272
30273 .section "Adding and removing header lines in routers and transports" &&&
30274          "SECTheadersaddrem"
30275 .cindex "header lines" "adding; in router or transport"
30276 .cindex "header lines" "removing; in router or transport"
30277 When a message is delivered, the addition and removal of header lines can be
30278 specified in a system filter, or on any of the routers and transports that
30279 process the message. Section &<<SECTaddremheasys>>& contains details about
30280 modifying headers in a system filter. Header lines can also be added in an ACL
30281 as a message is received (see section &<<SECTaddheadacl>>&).
30282
30283 In contrast to what happens in a system filter, header modifications that are
30284 specified on routers and transports apply only to the particular recipient
30285 addresses that are being processed by those routers and transports. These
30286 changes do not actually take place until a copy of the message is being
30287 transported. Therefore, they do not affect the basic set of header lines, and
30288 they do not affect the values of the variables that refer to header lines.
30289
30290 &*Note*&: In particular, this means that any expansions in the configuration of
30291 the transport cannot refer to the modified header lines, because such
30292 expansions all occur before the message is actually transported.
30293
30294 For both routers and transports, the result of expanding a &%headers_add%&
30295 option must be in the form of one or more RFC 2822 header lines, separated by
30296 newlines (coded as &"\n"&). For example:
30297 .code
30298 headers_add = X-added-header: added by $primary_hostname\n\
30299               X-added-second: another added header line
30300 .endd
30301 Exim does not check the syntax of these added header lines.
30302
30303 The result of expanding &%headers_remove%& must consist of a colon-separated
30304 list of header names. This is confusing, because header names themselves are
30305 often terminated by colons. In this case, the colons are the list separators,
30306 not part of the names. For example:
30307 .code
30308 headers_remove = return-receipt-to:acknowledge-to
30309 .endd
30310 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
30311 is expanded at routing time, and then associated with all addresses that are
30312 accepted by that router, and also with any new addresses that it generates. If
30313 an address passes through several routers as a result of aliasing or
30314 forwarding, the changes are cumulative.
30315
30316 .oindex "&%unseen%&"
30317 However, this does not apply to multiple routers that result from the use of
30318 the &%unseen%& option. Any header modifications that were specified by the
30319 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
30320
30321 Addresses that end up with different &%headers_add%& or &%headers_remove%&
30322 settings cannot be delivered together in a batch, so a transport is always
30323 dealing with a set of addresses that have the same header-processing
30324 requirements.
30325
30326 The transport starts by writing the original set of header lines that arrived
30327 with the message, possibly modified by the system filter. As it writes out
30328 these lines, it consults the list of header names that were attached to the
30329 recipient address(es) by &%headers_remove%& options in routers, and it also
30330 consults the transport's own &%headers_remove%& option. Header lines whose
30331 names are on either of these lists are not written out. If there are multiple
30332 instances of any listed header, they are all skipped.
30333
30334 After the remaining original header lines have been written, new header
30335 lines that were specified by routers' &%headers_add%& options are written, in
30336 the order in which they were attached to the address. These are followed by any
30337 header lines specified by the transport's &%headers_add%& option.
30338
30339 This way of handling header line modifications in routers and transports has
30340 the following consequences:
30341
30342 .ilist
30343 The original set of header lines, possibly modified by the system filter,
30344 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
30345 to it, at all times.
30346 .next
30347 Header lines that are added by a router's
30348 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
30349 expansion syntax in subsequent routers or the transport.
30350 .next
30351 Conversely, header lines that are specified for removal by &%headers_remove%&
30352 in a router remain visible to subsequent routers and the transport.
30353 .next
30354 Headers added to an address by &%headers_add%& in a router cannot be removed by
30355 a later router or by a transport.
30356 .next
30357 An added header can refer to the contents of an original header that is to be
30358 removed, even it has the same name as the added header. For example:
30359 .code
30360 headers_remove = subject
30361 headers_add = Subject: new subject (was: $h_subject:)
30362 .endd
30363 .endlist
30364
30365 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
30366 for a &(redirect)& router that has the &%one_time%& option set.
30367
30368
30369
30370
30371
30372 .section "Constructed addresses" "SECTconstr"
30373 .cindex "address" "constructed"
30374 .cindex "constructed address"
30375 When Exim constructs a sender address for a locally-generated message, it uses
30376 the form
30377 .display
30378 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
30379 .endd
30380 For example:
30381 .code
30382 Zaphod Beeblebrox <zaphod@end.univ.example>
30383 .endd
30384 The user name is obtained from the &%-F%& command line option if set, or
30385 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
30386 &"gecos"& field from the password entry. If the &"gecos"& field contains an
30387 ampersand character, this is replaced by the login name with the first letter
30388 upper cased, as is conventional in a number of operating systems. See the
30389 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
30390 The &%unknown_username%& option can be used to specify user names in cases when
30391 there is no password file entry.
30392
30393 .cindex "RFC 2047"
30394 In all cases, the user name is made to conform to RFC 2822 by quoting all or
30395 parts of it if necessary. In addition, if it contains any non-printing
30396 characters, it is encoded as described in RFC 2047, which defines a way of
30397 including non-ASCII characters in header lines. The value of the
30398 &%headers_charset%& option specifies the name of the encoding that is used (the
30399 characters are assumed to be in this encoding). The setting of
30400 &%print_topbitchars%& controls whether characters with the top bit set (that
30401 is, with codes greater than 127) count as printing characters or not.
30402
30403
30404
30405 .section "Case of local parts" "SECID230"
30406 .cindex "case of local parts"
30407 .cindex "local part" "case of"
30408 RFC 2822 states that the case of letters in the local parts of addresses cannot
30409 be assumed to be non-significant. Exim preserves the case of local parts of
30410 addresses, but by default it uses a lower-cased form when it is routing,
30411 because on most Unix systems, usernames are in lower case and case-insensitive
30412 routing is required. However, any particular router can be made to use the
30413 original case for local parts by setting the &%caseful_local_part%& generic
30414 router option.
30415
30416 .cindex "mixed-case login names"
30417 If you must have mixed-case user names on your system, the best way to proceed,
30418 assuming you want case-independent handling of incoming email, is to set up
30419 your first router to convert incoming local parts in your domains to the
30420 correct case by means of a file lookup. For example:
30421 .code
30422 correct_case:
30423   driver = redirect
30424   domains = +local_domains
30425   data = ${lookup{$local_part}cdb\
30426               {/etc/usercased.cdb}{$value}fail}\
30427               @$domain
30428 .endd
30429 For this router, the local part is forced to lower case by the default action
30430 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
30431 up a new local part in the correct case. If you then set &%caseful_local_part%&
30432 on any subsequent routers which process your domains, they will operate on
30433 local parts with the correct case in a case-sensitive manner.
30434
30435
30436
30437 .section "Dots in local parts" "SECID231"
30438 .cindex "dot" "in local part"
30439 .cindex "local part" "dots in"
30440 RFC 2822 forbids empty components in local parts. That is, an unquoted local
30441 part may not begin or end with a dot, nor have two consecutive dots in the
30442 middle. However, it seems that many MTAs do not enforce this, so Exim permits
30443 empty components for compatibility.
30444
30445
30446
30447 .section "Rewriting addresses" "SECID232"
30448 .cindex "rewriting" "addresses"
30449 Rewriting of sender and recipient addresses, and addresses in headers, can
30450 happen automatically, or as the result of configuration options, as described
30451 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
30452 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
30453
30454 Automatic rewriting includes qualification, as mentioned above. The other case
30455 in which it can happen is when an incomplete non-local domain is given. The
30456 routing process may cause this to be expanded into the full domain name. For
30457 example, a header such as
30458 .code
30459 To: hare@teaparty
30460 .endd
30461 might get rewritten as
30462 .code
30463 To: hare@teaparty.wonderland.fict.example
30464 .endd
30465 Rewriting as a result of routing is the one kind of message processing that
30466 does not happen at input time, as it cannot be done until the address has
30467 been routed.
30468
30469 Strictly, one should not do &'any'& deliveries of a message until all its
30470 addresses have been routed, in case any of the headers get changed as a
30471 result of routing. However, doing this in practice would hold up many
30472 deliveries for unreasonable amounts of time, just because one address could not
30473 immediately be routed. Exim therefore does not delay other deliveries when
30474 routing of one or more addresses is deferred.
30475 .ecindex IIDmesproc
30476
30477
30478
30479 . ////////////////////////////////////////////////////////////////////////////
30480 . ////////////////////////////////////////////////////////////////////////////
30481
30482 .chapter "SMTP processing" "CHAPSMTP"
30483 .scindex IIDsmtpproc1 "SMTP" "processing details"
30484 .scindex IIDsmtpproc2 "LMTP" "processing details"
30485 Exim supports a number of different ways of using the SMTP protocol, and its
30486 LMTP variant, which is an interactive protocol for transferring messages into a
30487 closed mail store application. This chapter contains details of how SMTP is
30488 processed. For incoming mail, the following are available:
30489
30490 .ilist
30491 SMTP over TCP/IP (Exim daemon or &'inetd'&);
30492 .next
30493 SMTP over the standard input and output (the &%-bs%& option);
30494 .next
30495 Batched SMTP on the standard input (the &%-bS%& option).
30496 .endlist
30497
30498 For mail delivery, the following are available:
30499
30500 .ilist
30501 SMTP over TCP/IP (the &(smtp)& transport);
30502 .next
30503 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
30504 &"lmtp"&);
30505 .next
30506 LMTP over a pipe to a process running in the local host (the &(lmtp)&
30507 transport);
30508 .next
30509 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
30510 the &%use_bsmtp%& option set).
30511 .endlist
30512
30513 &'Batched SMTP'& is the name for a process in which batches of messages are
30514 stored in or read from files (or pipes), in a format in which SMTP commands are
30515 used to contain the envelope information.
30516
30517
30518
30519 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
30520 .cindex "SMTP" "outgoing over TCP/IP"
30521 .cindex "outgoing SMTP over TCP/IP"
30522 .cindex "LMTP" "over TCP/IP"
30523 .cindex "outgoing LMTP over TCP/IP"
30524 .cindex "EHLO"
30525 .cindex "HELO"
30526 .cindex "SIZE option on MAIL command"
30527 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
30528 The &%protocol%& option selects which protocol is to be used, but the actual
30529 processing is the same in both cases.
30530
30531 If, in response to its EHLO command, Exim is told that the SIZE
30532 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
30533 command. The value of <&'n'&> is the message size plus the value of the
30534 &%size_addition%& option (default 1024) to allow for additions to the message
30535 such as per-transport header lines, or changes made in a
30536 .cindex "transport" "filter"
30537 .cindex "filter" "transport filter"
30538 transport filter. If &%size_addition%& is set negative, the use of SIZE is
30539 suppressed.
30540
30541 If the remote server advertises support for PIPELINING, Exim uses the
30542 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
30543 required for the transaction.
30544
30545 If the remote server advertises support for the STARTTLS command, and Exim
30546 was built to support TLS encryption, it tries to start a TLS session unless the
30547 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
30548
30549 If the remote server advertises support for the AUTH command, Exim scans
30550 the authenticators configuration for any suitable client settings, as described
30551 in chapter &<<CHAPSMTPAUTH>>&.
30552
30553 .cindex "carriage return"
30554 .cindex "linefeed"
30555 Responses from the remote host are supposed to be terminated by CR followed by
30556 LF. However, there are known to be hosts that do not send CR characters, so in
30557 order to be able to interwork with such hosts, Exim treats LF on its own as a
30558 line terminator.
30559
30560 If a message contains a number of different addresses, all those with the same
30561 characteristics (for example, the same envelope sender) that resolve to the
30562 same set of hosts, in the same order, are sent in a single SMTP transaction,
30563 even if they are for different domains, unless there are more than the setting
30564 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
30565 they are split into groups containing no more than &%max_rcpt%&s addresses
30566 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
30567 in parallel sessions. The order of hosts with identical MX values is not
30568 significant when checking whether addresses can be batched in this way.
30569
30570 When the &(smtp)& transport suffers a temporary failure that is not
30571 message-related, Exim updates its transport-specific database, which contains
30572 records indexed by host name that remember which messages are waiting for each
30573 particular host. It also updates the retry database with new retry times.
30574
30575 .cindex "hints database" "retry keys"
30576 Exim's retry hints are based on host name plus IP address, so if one address of
30577 a multi-homed host is broken, it will soon be skipped most of the time.
30578 See the next section for more detail about error handling.
30579
30580 .cindex "SMTP" "passed connection"
30581 .cindex "SMTP" "batching over TCP/IP"
30582 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
30583 looks in the hints database for the transport to see if there are any queued
30584 messages waiting for the host to which it is connected. If it finds one, it
30585 creates a new Exim process using the &%-MC%& option (which can only be used by
30586 a process running as root or the Exim user) and passes the TCP/IP socket to it
30587 so that it can deliver another message using the same socket. The new process
30588 does only those deliveries that are routed to the connected host, and may in
30589 turn pass the socket on to a third process, and so on.
30590
30591 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
30592 limit the number of messages sent down a single TCP/IP connection.
30593
30594 .cindex "asterisk" "after IP address"
30595 The second and subsequent messages delivered down an existing connection are
30596 identified in the main log by the addition of an asterisk after the closing
30597 square bracket of the IP address.
30598
30599
30600
30601
30602 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
30603 .cindex "error" "in outgoing SMTP"
30604 .cindex "SMTP" "errors in outgoing"
30605 .cindex "host" "error"
30606 Three different kinds of error are recognized for outgoing SMTP: host errors,
30607 message errors, and recipient errors.
30608
30609 .vlist
30610 .vitem "&*Host errors*&"
30611 A host error is not associated with a particular message or with a
30612 particular recipient of a message. The host errors are:
30613
30614 .ilist
30615 Connection refused or timed out,
30616 .next
30617 Any error response code on connection,
30618 .next
30619 Any error response code to EHLO or HELO,
30620 .next
30621 Loss of connection at any time, except after &"."&,
30622 .next
30623 I/O errors at any time,
30624 .next
30625 Timeouts during the session, other than in response to MAIL, RCPT or
30626 the &"."& at the end of the data.
30627 .endlist ilist
30628
30629 For a host error, a permanent error response on connection, or in response to
30630 EHLO, causes all addresses routed to the host to be failed. Any other host
30631 error causes all addresses to be deferred, and retry data to be created for the
30632 host. It is not tried again, for any message, until its retry time arrives. If
30633 the current set of addresses are not all delivered in this run (to some
30634 alternative host), the message is added to the list of those waiting for this
30635 host, so if it is still undelivered when a subsequent successful delivery is
30636 made to the host, it will be sent down the same SMTP connection.
30637
30638 .vitem "&*Message errors*&"
30639 .cindex "message" "error"
30640 A message error is associated with a particular message when sent to a
30641 particular host, but not with a particular recipient of the message. The
30642 message errors are:
30643
30644 .ilist
30645 Any error response code to MAIL, DATA, or the &"."& that terminates
30646 the data,
30647 .next
30648 Timeout after MAIL,
30649 .next
30650 Timeout or loss of connection after the &"."& that terminates the data. A
30651 timeout after the DATA command itself is treated as a host error, as is loss of
30652 connection at any other time.
30653 .endlist ilist
30654
30655 For a message error, a permanent error response (5&'xx'&) causes all addresses
30656 to be failed, and a delivery error report to be returned to the sender. A
30657 temporary error response (4&'xx'&), or one of the timeouts, causes all
30658 addresses to be deferred. Retry data is not created for the host, but instead,
30659 a retry record for the combination of host plus message id is created. The
30660 message is not added to the list of those waiting for this host. This ensures
30661 that the failing message will not be sent to this host again until the retry
30662 time arrives. However, other messages that are routed to the host are not
30663 affected, so if it is some property of the message that is causing the error,
30664 it will not stop the delivery of other mail.
30665
30666 If the remote host specified support for the SIZE parameter in its response
30667 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
30668 over-large message will cause a message error because the error arrives as a
30669 response to MAIL.
30670
30671 .vitem "&*Recipient errors*&"
30672 .cindex "recipient" "error"
30673 A recipient error is associated with a particular recipient of a message. The
30674 recipient errors are:
30675
30676 .ilist
30677 Any error response to RCPT,
30678 .next
30679 Timeout after RCPT.
30680 .endlist
30681
30682 For a recipient error, a permanent error response (5&'xx'&) causes the
30683 recipient address to be failed, and a bounce message to be returned to the
30684 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
30685 address to be deferred, and routing retry data to be created for it. This is
30686 used to delay processing of the address in subsequent queue runs, until its
30687 routing retry time arrives. This applies to all messages, but because it
30688 operates only in queue runs, one attempt will be made to deliver a new message
30689 to the failing address before the delay starts to operate. This ensures that,
30690 if the failure is really related to the message rather than the recipient
30691 (&"message too big for this recipient"& is a possible example), other messages
30692 have a chance of getting delivered. If a delivery to the address does succeed,
30693 the retry information gets cleared, so all stuck messages get tried again, and
30694 the retry clock is reset.
30695
30696 The message is not added to the list of those waiting for this host. Use of the
30697 host for other messages is unaffected, and except in the case of a timeout,
30698 other recipients are processed independently, and may be successfully delivered
30699 in the current SMTP session. After a timeout it is of course impossible to
30700 proceed with the session, so all addresses get deferred. However, those other
30701 than the one that failed do not suffer any subsequent retry delays. Therefore,
30702 if one recipient is causing trouble, the others have a chance of getting
30703 through when a subsequent delivery attempt occurs before the failing
30704 recipient's retry time.
30705 .endlist
30706
30707 In all cases, if there are other hosts (or IP addresses) available for the
30708 current set of addresses (for example, from multiple MX records), they are
30709 tried in this run for any undelivered addresses, subject of course to their
30710 own retry data. In other words, recipient error retry data does not take effect
30711 until the next delivery attempt.
30712
30713 Some hosts have been observed to give temporary error responses to every
30714 MAIL command at certain times (&"insufficient space"& has been seen). It
30715 would be nice if such circumstances could be recognized, and defer data for the
30716 host itself created, but this is not possible within the current Exim design.
30717 What actually happens is that retry data for every (host, message) combination
30718 is created.
30719
30720 The reason that timeouts after MAIL and RCPT are treated specially is that
30721 these can sometimes arise as a result of the remote host's verification
30722 procedures. Exim makes this assumption, and treats them as if a temporary error
30723 response had been received. A timeout after &"."& is treated specially because
30724 it is known that some broken implementations fail to recognize the end of the
30725 message if the last character of the last line is a binary zero. Thus, it is
30726 helpful to treat this case as a message error.
30727
30728 Timeouts at other times are treated as host errors, assuming a problem with the
30729 host, or the connection to it. If a timeout after MAIL, RCPT,
30730 or &"."& is really a connection problem, the assumption is that at the next try
30731 the timeout is likely to occur at some other point in the dialogue, causing it
30732 then to be treated as a host error.
30733
30734 There is experimental evidence that some MTAs drop the connection after the
30735 terminating &"."& if they do not like the contents of the message for some
30736 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
30737 should be given. That is why Exim treats this case as a message rather than a
30738 host error, in order not to delay other messages to the same host.
30739
30740
30741
30742
30743 .section "Incoming SMTP messages over TCP/IP" "SECID233"
30744 .cindex "SMTP" "incoming over TCP/IP"
30745 .cindex "incoming SMTP over TCP/IP"
30746 .cindex "inetd"
30747 .cindex "daemon"
30748 Incoming SMTP messages can be accepted in one of two ways: by running a
30749 listening daemon, or by using &'inetd'&. In the latter case, the entry in
30750 &_/etc/inetd.conf_& should be like this:
30751 .code
30752 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
30753 .endd
30754 Exim distinguishes between this case and the case of a locally running user
30755 agent using the &%-bs%& option by checking whether or not the standard input is
30756 a socket. When it is, either the port must be privileged (less than 1024), or
30757 the caller must be root or the Exim user. If any other user passes a socket
30758 with an unprivileged port number, Exim prints a message on the standard error
30759 stream and exits with an error code.
30760
30761 By default, Exim does not make a log entry when a remote host connects or
30762 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
30763 unexpected. It can be made to write such log entries by setting the
30764 &%smtp_connection%& log selector.
30765
30766 .cindex "carriage return"
30767 .cindex "linefeed"
30768 Commands from the remote host are supposed to be terminated by CR followed by
30769 LF. However, there are known to be hosts that do not send CR characters. In
30770 order to be able to interwork with such hosts, Exim treats LF on its own as a
30771 line terminator.
30772 Furthermore, because common code is used for receiving messages from all
30773 sources, a CR on its own is also interpreted as a line terminator. However, the
30774 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
30775
30776 .cindex "EHLO" "invalid data"
30777 .cindex "HELO" "invalid data"
30778 One area that sometimes gives rise to problems concerns the EHLO or
30779 HELO commands. Some clients send syntactically invalid versions of these
30780 commands, which Exim rejects by default. (This is nothing to do with verifying
30781 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
30782 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
30783 match the broken hosts that send invalid commands.
30784
30785 .cindex "SIZE option on MAIL command"
30786 .cindex "MAIL" "SIZE option"
30787 The amount of disk space available is checked whenever SIZE is received on
30788 a MAIL command, independently of whether &%message_size_limit%& or
30789 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
30790 false. A temporary error is given if there is not enough space. If
30791 &%check_spool_space%& is set, the check is for that amount of space plus the
30792 value given with SIZE, that is, it checks that the addition of the incoming
30793 message will not reduce the space below the threshold.
30794
30795 When a message is successfully received, Exim includes the local message id in
30796 its response to the final &"."& that terminates the data. If the remote host
30797 logs this text it can help with tracing what has happened to a message.
30798
30799 The Exim daemon can limit the number of simultaneous incoming connections it is
30800 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
30801 number of simultaneous incoming connections from a single remote host (see the
30802 &%smtp_accept_max_per_host%& option). Additional connection attempts are
30803 rejected using the SMTP temporary error code 421.
30804
30805 The Exim daemon does not rely on the SIGCHLD signal to detect when a
30806 subprocess has finished, as this can get lost at busy times. Instead, it looks
30807 for completed subprocesses every time it wakes up. Provided there are other
30808 things happening (new incoming calls, starts of queue runs), completed
30809 processes will be noticed and tidied away. On very quiet systems you may
30810 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
30811 it will be noticed when the daemon next wakes up.
30812
30813 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
30814 and can also be set up to reject SMTP calls from non-reserved hosts at times of
30815 high system load &-- for details see the &%smtp_accept_reserve%&,
30816 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
30817 applies in both the daemon and &'inetd'& cases.
30818
30819 Exim normally starts a delivery process for each message received, though this
30820 can be varied by means of the &%-odq%& command line option and the
30821 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
30822 number of simultaneously running delivery processes started in this way from
30823 SMTP input can be limited by the &%smtp_accept_queue%& and
30824 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
30825 subsequently received messages are just put on the input queue without starting
30826 a delivery process.
30827
30828 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
30829 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
30830 started up from the &'inetd'& daemon, because in that case each connection is
30831 handled by an entirely independent Exim process. Control by load average is,
30832 however, available with &'inetd'&.
30833
30834 Exim can be configured to verify addresses in incoming SMTP commands as they
30835 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
30836 to rewrite addresses at this time &-- before any syntax checking is done. See
30837 section &<<SECTrewriteS>>&.
30838
30839 Exim can also be configured to limit the rate at which a client host submits
30840 MAIL and RCPT commands in a single SMTP session. See the
30841 &%smtp_ratelimit_hosts%& option.
30842
30843
30844
30845 .section "Unrecognized SMTP commands" "SECID234"
30846 .cindex "SMTP" "unrecognized commands"
30847 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
30848 commands during a single SMTP connection, it drops the connection after sending
30849 the error response to the last command. The default value for
30850 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
30851 abuse that subvert web servers into making connections to SMTP ports; in these
30852 circumstances, a number of non-SMTP lines are sent first.
30853
30854
30855 .section "Syntax and protocol errors in SMTP commands" "SECID235"
30856 .cindex "SMTP" "syntax errors"
30857 .cindex "SMTP" "protocol errors"
30858 A syntax error is detected if an SMTP command is recognized, but there is
30859 something syntactically wrong with its data, for example, a malformed email
30860 address in a RCPT command. Protocol errors include invalid command
30861 sequencing such as RCPT before MAIL. If Exim receives more than
30862 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
30863 drops the connection after sending the error response to the last command. The
30864 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
30865 broken clients that loop sending bad commands (yes, it has been seen).
30866
30867
30868
30869 .section "Use of non-mail SMTP commands" "SECID236"
30870 .cindex "SMTP" "non-mail commands"
30871 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
30872 DATA. Exim counts such commands, and drops the connection if there are too
30873 many of them in a single SMTP session. This action catches some
30874 denial-of-service attempts and things like repeated failing AUTHs, or a mad
30875 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
30876 defines what &"too many"& means. Its default value is 10.
30877
30878 When a new message is expected, one occurrence of RSET is not counted. This
30879 allows a client to send one RSET between messages (this is not necessary,
30880 but some clients do it). Exim also allows one uncounted occurrence of HELO
30881 or EHLO, and one occurrence of STARTTLS between messages. After
30882 starting up a TLS session, another EHLO is expected, and so it too is not
30883 counted.
30884
30885 The first occurrence of AUTH in a connection, or immediately following
30886 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
30887 RCPT, DATA, and QUIT are counted.
30888
30889 You can control which hosts are subject to the limit set by
30890 &%smtp_accept_max_nonmail%& by setting
30891 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
30892 the limit apply to all hosts. This option means that you can exclude any
30893 specific badly-behaved hosts that you have to live with.
30894
30895
30896
30897
30898 .section "The VRFY and EXPN commands" "SECID237"
30899 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
30900 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
30901 appropriate) in order to decide whether the command should be accepted or not.
30902 If no ACL is defined, the command is rejected.
30903
30904 .cindex "VRFY" "processing"
30905 When VRFY is accepted, it runs exactly the same code as when Exim is
30906 called with the &%-bv%& option.
30907
30908 .cindex "EXPN" "processing"
30909 When EXPN is accepted, a single-level expansion of the address is done.
30910 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
30911 than a verification (the &%-bv%& option). If an unqualified local part is given
30912 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
30913 of VRFY and EXPN commands are logged on the main and reject logs, and
30914 VRFY verification failures are logged on the main log for consistency with
30915 RCPT failures.
30916
30917
30918
30919 .section "The ETRN command" "SECTETRN"
30920 .cindex "ETRN" "processing"
30921 RFC 1985 describes an SMTP command called ETRN that is designed to
30922 overcome the security problems of the TURN command (which has fallen into
30923 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
30924 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
30925 should be accepted or not. If no ACL is defined, the command is rejected.
30926
30927 The ETRN command is concerned with &"releasing"& messages that are awaiting
30928 delivery to certain hosts. As Exim does not organize its message queue by host,
30929 the only form of ETRN that is supported by default is the one where the
30930 text starts with the &"#"& prefix, in which case the remainder of the text is
30931 specific to the SMTP server. A valid ETRN command causes a run of Exim with
30932 the &%-R%& option to happen, with the remainder of the ETRN text as its
30933 argument. For example,
30934 .code
30935 ETRN #brigadoon
30936 .endd
30937 runs the command
30938 .code
30939 exim -R brigadoon
30940 .endd
30941 which causes a delivery attempt on all messages with undelivered addresses
30942 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
30943 default), Exim prevents the simultaneous execution of more than one queue run
30944 for the same argument string as a result of an ETRN command. This stops
30945 a misbehaving client from starting more than one queue runner at once.
30946
30947 .cindex "hints database" "ETRN serialization"
30948 Exim implements the serialization by means of a hints database in which a
30949 record is written whenever a process is started by ETRN, and deleted when
30950 the process completes. However, Exim does not keep the SMTP session waiting for
30951 the ETRN process to complete. Once ETRN is accepted, the client is sent
30952 a &"success"& return code. Obviously there is scope for hints records to get
30953 left lying around if there is a system or program crash. To guard against this,
30954 Exim ignores any records that are more than six hours old.
30955
30956 .oindex "&%smtp_etrn_command%&"
30957 For more control over what ETRN does, the &%smtp_etrn_command%& option can
30958 used. This specifies a command that is run whenever ETRN is received,
30959 whatever the form of its argument. For
30960 example:
30961 .code
30962 smtp_etrn_command = /etc/etrn_command $domain \
30963                     $sender_host_address
30964 .endd
30965 .vindex "&$domain$&"
30966 The string is split up into arguments which are independently expanded. The
30967 expansion variable &$domain$& is set to the argument of the ETRN command,
30968 and no syntax checking is done on the contents of this argument. Exim does not
30969 wait for the command to complete, so its status code is not checked. Exim runs
30970 under its own uid and gid when receiving incoming SMTP, so it is not possible
30971 for it to change them before running the command.
30972
30973
30974
30975 .section "Incoming local SMTP" "SECID238"
30976 .cindex "SMTP" "local incoming"
30977 Some user agents use SMTP to pass messages to their local MTA using the
30978 standard input and output, as opposed to passing the envelope on the command
30979 line and writing the message to the standard input. This is supported by the
30980 &%-bs%& option. This form of SMTP is handled in the same way as incoming
30981 messages over TCP/IP (including the use of ACLs), except that the envelope
30982 sender given in a MAIL command is ignored unless the caller is trusted. In
30983 an ACL you can detect this form of SMTP input by testing for an empty host
30984 identification. It is common to have this as the first line in the ACL that
30985 runs for RCPT commands:
30986 .code
30987 accept hosts = :
30988 .endd
30989 This accepts SMTP messages from local processes without doing any other tests.
30990
30991
30992
30993 .section "Outgoing batched SMTP" "SECTbatchSMTP"
30994 .cindex "SMTP" "batched outgoing"
30995 .cindex "batched SMTP output"
30996 Both the &(appendfile)& and &(pipe)& transports can be used for handling
30997 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
30998 be output in BSMTP format. No SMTP responses are possible for this form of
30999 delivery. All it is doing is using SMTP commands as a way of transmitting the
31000 envelope along with the message.
31001
31002 The message is written to the file or pipe preceded by the SMTP commands
31003 MAIL and RCPT, and followed by a line containing a single dot. Lines in
31004 the message that start with a dot have an extra dot added. The SMTP command
31005 HELO is not normally used. If it is required, the &%message_prefix%& option
31006 can be used to specify it.
31007
31008 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
31009 one recipient address at a time by default. However, you can arrange for them
31010 to handle several addresses at once by setting the &%batch_max%& option. When
31011 this is done for BSMTP, messages may contain multiple RCPT commands. See
31012 chapter &<<CHAPbatching>>& for more details.
31013
31014 .vindex "&$host$&"
31015 When one or more addresses are routed to a BSMTP transport by a router that
31016 sets up a host list, the name of the first host on the list is available to the
31017 transport in the variable &$host$&. Here is an example of such a transport and
31018 router:
31019 .code
31020 begin routers
31021 route_append:
31022   driver = manualroute
31023   transport = smtp_appendfile
31024   route_list = domain.example  batch.host.example
31025
31026 begin transports
31027 smtp_appendfile:
31028   driver = appendfile
31029   directory = /var/bsmtp/$host
31030   batch_max = 1000
31031   use_bsmtp
31032   user = exim
31033 .endd
31034 This causes messages addressed to &'domain.example'& to be written in BSMTP
31035 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
31036 message (unless there are more than 1000 recipients).
31037
31038
31039
31040 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
31041 .cindex "SMTP" "batched incoming"
31042 .cindex "batched SMTP input"
31043 The &%-bS%& command line option causes Exim to accept one or more messages by
31044 reading SMTP on the standard input, but to generate no responses. If the caller
31045 is trusted, the senders in the MAIL commands are believed; otherwise the
31046 sender is always the caller of Exim. Unqualified senders and receivers are not
31047 rejected (there seems little point) but instead just get qualified. HELO
31048 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
31049 as NOOP; QUIT quits.
31050
31051 Minimal policy checking is done for BSMTP input. Only the non-SMTP
31052 ACL is run in the same way as for non-SMTP local input.
31053
31054 If an error is detected while reading a message, including a missing &"."& at
31055 the end, Exim gives up immediately. It writes details of the error to the
31056 standard output in a stylized way that the calling program should be able to
31057 make some use of automatically, for example:
31058 .code
31059 554 Unexpected end of file
31060 Transaction started in line 10
31061 Error detected in line 14
31062 .endd
31063 It writes a more verbose version, for human consumption, to the standard error
31064 file, for example:
31065 .code
31066 An error was detected while processing a file of BSMTP input.
31067 The error message was:
31068
31069 501 '>' missing at end of address
31070
31071 The SMTP transaction started in line 10.
31072 The error was detected in line 12.
31073 The SMTP command at fault was:
31074
31075 rcpt to:<malformed@in.com.plete
31076
31077 1 previous message was successfully processed.
31078 The rest of the batch was abandoned.
31079 .endd
31080 The return code from Exim is zero only if there were no errors. It is 1 if some
31081 messages were accepted before an error was detected, and 2 if no messages were
31082 accepted.
31083 .ecindex IIDsmtpproc1
31084 .ecindex IIDsmtpproc2
31085
31086
31087
31088 . ////////////////////////////////////////////////////////////////////////////
31089 . ////////////////////////////////////////////////////////////////////////////
31090
31091 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
31092          "Customizing messages"
31093 When a message fails to be delivered, or remains on the queue for more than a
31094 configured amount of time, Exim sends a message to the original sender, or
31095 to an alternative configured address. The text of these messages is built into
31096 the code of Exim, but it is possible to change it, either by adding a single
31097 string, or by replacing each of the paragraphs by text supplied in a file.
31098
31099 The &'From:'& and &'To:'& header lines are automatically generated; you can
31100 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
31101 option. Exim also adds the line
31102 .code
31103 Auto-Submitted: auto-generated
31104 .endd
31105 to all warning and bounce messages,
31106
31107
31108 .section "Customizing bounce messages" "SECID239"
31109 .cindex "customizing" "bounce message"
31110 .cindex "bounce message" "customizing"
31111 If &%bounce_message_text%& is set, its contents are included in the default
31112 message immediately after &"This message was created automatically by mail
31113 delivery software."& The string is not expanded. It is not used if
31114 &%bounce_message_file%& is set.
31115
31116 When &%bounce_message_file%& is set, it must point to a template file for
31117 constructing error messages. The file consists of a series of text items,
31118 separated by lines consisting of exactly four asterisks. If the file cannot be
31119 opened, default text is used and a message is written to the main and panic
31120 logs. If any text item in the file is empty, default text is used for that
31121 item.
31122
31123 .vindex "&$bounce_recipient$&"
31124 .vindex "&$bounce_return_size_limit$&"
31125 Each item of text that is read from the file is expanded, and there are two
31126 expansion variables which can be of use here: &$bounce_recipient$& is set to
31127 the recipient of an error message while it is being created, and
31128 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
31129 option, rounded to a whole number.
31130
31131 The items must appear in the file in the following order:
31132
31133 .ilist
31134 The first item is included in the headers, and should include at least a
31135 &'Subject:'& header. Exim does not check the syntax of these headers.
31136 .next
31137 The second item forms the start of the error message. After it, Exim lists the
31138 failing addresses with their error messages.
31139 .next
31140 The third item is used to introduce any text from pipe transports that is to be
31141 returned to the sender. It is omitted if there is no such text.
31142 .next
31143 The fourth item is used to introduce the copy of the message that is returned
31144 as part of the error report.
31145 .next
31146 The fifth item is added after the fourth one if the returned message is
31147 truncated because it is bigger than &%return_size_limit%&.
31148 .next
31149 The sixth item is added after the copy of the original message.
31150 .endlist
31151
31152 The default state (&%bounce_message_file%& unset) is equivalent to the
31153 following file, in which the sixth item is empty. The &'Subject:'& and some
31154 other lines have been split in order to fit them on the page:
31155 .code
31156 Subject: Mail delivery failed
31157   ${if eq{$sender_address}{$bounce_recipient}
31158   {: returning message to sender}}
31159 ****
31160 This message was created automatically by mail delivery software.
31161
31162 A message ${if eq{$sender_address}{$bounce_recipient}
31163   {that you sent }{sent by
31164
31165 <$sender_address>
31166
31167 }}could not be delivered to all of its recipients.
31168 This is a permanent error. The following address(es) failed:
31169 ****
31170 The following text was generated during the delivery attempt(s):
31171 ****
31172 ------ This is a copy of the message, including all the headers.
31173   ------
31174 ****
31175 ------ The body of the message is $message_size characters long;
31176   only the first
31177 ------ $bounce_return_size_limit or so are included here.
31178 ****
31179 .endd
31180 .section "Customizing warning messages" "SECTcustwarn"
31181 .cindex "customizing" "warning message"
31182 .cindex "warning of delay" "customizing the message"
31183 The option &%warn_message_file%& can be pointed at a template file for use when
31184 warnings about message delays are created. In this case there are only three
31185 text sections:
31186
31187 .ilist
31188 The first item is included in the headers, and should include at least a
31189 &'Subject:'& header. Exim does not check the syntax of these headers.
31190 .next
31191 The second item forms the start of the warning message. After it, Exim lists
31192 the delayed addresses.
31193 .next
31194 The third item then ends the message.
31195 .endlist
31196
31197 The default state is equivalent to the following file, except that some lines
31198 have been split here, in order to fit them on the page:
31199 .code
31200 Subject: Warning: message $message_exim_id delayed
31201   $warn_message_delay
31202 ****
31203 This message was created automatically by mail delivery software.
31204
31205 A message ${if eq{$sender_address}{$warn_message_recipients}
31206 {that you sent }{sent by
31207
31208 <$sender_address>
31209
31210 }}has not been delivered to all of its recipients after
31211 more than $warn_message_delay on the queue on $primary_hostname.
31212
31213 The message identifier is:     $message_exim_id
31214 The subject of the message is: $h_subject
31215 The date of the message is:    $h_date
31216
31217 The following address(es) have not yet been delivered:
31218 ****
31219 No action is required on your part. Delivery attempts will
31220 continue for some time, and this warning may be repeated at
31221 intervals if the message remains undelivered. Eventually the
31222 mail delivery software will give up, and when that happens,
31223 the message will be returned to you.
31224 .endd
31225 .vindex "&$warn_message_delay$&"
31226 .vindex "&$warn_message_recipients$&"
31227 However, in the default state the subject and date lines are omitted if no
31228 appropriate headers exist. During the expansion of this file,
31229 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
31230 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
31231 of recipients for the warning message. There may be more than one if there are
31232 multiple addresses with different &%errors_to%& settings on the routers that
31233 handled them.
31234
31235
31236
31237
31238 . ////////////////////////////////////////////////////////////////////////////
31239 . ////////////////////////////////////////////////////////////////////////////
31240
31241 .chapter "Some common configuration settings" "CHAPcomconreq"
31242 This chapter discusses some configuration settings that seem to be fairly
31243 common. More examples and discussion can be found in the Exim book.
31244
31245
31246
31247 .section "Sending mail to a smart host" "SECID240"
31248 .cindex "smart host" "example router"
31249 If you want to send all mail for non-local domains to a &"smart host"&, you
31250 should replace the default &(dnslookup)& router with a router which does the
31251 routing explicitly:
31252 .code
31253 send_to_smart_host:
31254   driver = manualroute
31255   route_list = !+local_domains smart.host.name
31256   transport = remote_smtp
31257 .endd
31258 You can use the smart host's IP address instead of the name if you wish.
31259 If you are using Exim only to submit messages to a smart host, and not for
31260 receiving incoming messages, you can arrange for it to do the submission
31261 synchronously by setting the &%mua_wrapper%& option (see chapter
31262 &<<CHAPnonqueueing>>&).
31263
31264
31265
31266
31267 .section "Using Exim to handle mailing lists" "SECTmailinglists"
31268 .cindex "mailing lists"
31269 Exim can be used to run simple mailing lists, but for large and/or complicated
31270 requirements, the use of additional specialized mailing list software such as
31271 Majordomo or Mailman is recommended.
31272
31273 The &(redirect)& router can be used to handle mailing lists where each list
31274 is maintained in a separate file, which can therefore be managed by an
31275 independent manager. The &%domains%& router option can be used to run these
31276 lists in a separate domain from normal mail. For example:
31277 .code
31278 lists:
31279   driver = redirect
31280   domains = lists.example
31281   file = /usr/lists/$local_part
31282   forbid_pipe
31283   forbid_file
31284   errors_to = $local_part-request@lists.example
31285   no_more
31286 .endd
31287 This router is skipped for domains other than &'lists.example'&. For addresses
31288 in that domain, it looks for a file that matches the local part. If there is no
31289 such file, the router declines, but because &%no_more%& is set, no subsequent
31290 routers are tried, and so the whole delivery fails.
31291
31292 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
31293 expanded into a file name or a pipe delivery, which is usually inappropriate in
31294 a mailing list.
31295
31296 .oindex "&%errors_to%&"
31297 The &%errors_to%& option specifies that any delivery errors caused by addresses
31298 taken from a mailing list are to be sent to the given address rather than the
31299 original sender of the message. However, before acting on this, Exim verifies
31300 the error address, and ignores it if verification fails.
31301
31302 For example, using the configuration above, mail sent to
31303 &'dicts@lists.example'& is passed on to those addresses contained in
31304 &_/usr/lists/dicts_&, with error reports directed to
31305 &'dicts-request@lists.example'&, provided that this address can be verified.
31306 There could be a file called &_/usr/lists/dicts-request_& containing
31307 the address(es) of this particular list's manager(s), but other approaches,
31308 such as setting up an earlier router (possibly using the &%local_part_prefix%&
31309 or &%local_part_suffix%& options) to handle addresses of the form
31310 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
31311
31312
31313
31314 .section "Syntax errors in mailing lists" "SECID241"
31315 .cindex "mailing lists" "syntax errors in"
31316 If an entry in redirection data contains a syntax error, Exim normally defers
31317 delivery of the original address. That means that a syntax error in a mailing
31318 list holds up all deliveries to the list. This may not be appropriate when a
31319 list is being maintained automatically from data supplied by users, and the
31320 addresses are not rigorously checked.
31321
31322 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
31323 entries that fail to parse, noting the incident in the log. If in addition
31324 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
31325 whenever a broken address is skipped. It is usually appropriate to set
31326 &%syntax_errors_to%& to the same address as &%errors_to%&.
31327
31328
31329
31330 .section "Re-expansion of mailing lists" "SECID242"
31331 .cindex "mailing lists" "re-expansion of"
31332 Exim remembers every individual address to which a message has been delivered,
31333 in order to avoid duplication, but it normally stores only the original
31334 recipient addresses with a message. If all the deliveries to a mailing list
31335 cannot be done at the first attempt, the mailing list is re-expanded when the
31336 delivery is next tried. This means that alterations to the list are taken into
31337 account at each delivery attempt, so addresses that have been added to
31338 the list since the message arrived will therefore receive a copy of the
31339 message, even though it pre-dates their subscription.
31340
31341 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
31342 on the &(redirect)& router. If this is done, any addresses generated by the
31343 router that fail to deliver at the first attempt are added to the message as
31344 &"top level"& addresses, and the parent address that generated them is marked
31345 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
31346 subsequent delivery attempts. The disadvantage of this is that if any of the
31347 failing addresses are incorrect, correcting them in the file has no effect on
31348 pre-existing messages.
31349
31350 The original top-level address is remembered with each of the generated
31351 addresses, and is output in any log messages. However, any intermediate parent
31352 addresses are not recorded. This makes a difference to the log only if the
31353 &%all_parents%& selector is set, but for mailing lists there is normally only
31354 one level of expansion anyway.
31355
31356
31357
31358 .section "Closed mailing lists" "SECID243"
31359 .cindex "mailing lists" "closed"
31360 The examples so far have assumed open mailing lists, to which anybody may
31361 send mail. It is also possible to set up closed lists, where mail is accepted
31362 from specified senders only. This is done by making use of the generic
31363 &%senders%& option to restrict the router that handles the list.
31364
31365 The following example uses the same file as a list of recipients and as a list
31366 of permitted senders. It requires three routers:
31367 .code
31368 lists_request:
31369   driver = redirect
31370   domains = lists.example
31371   local_part_suffix = -request
31372   file = /usr/lists/$local_part$local_part_suffix
31373   no_more
31374
31375 lists_post:
31376   driver = redirect
31377   domains = lists.example
31378   senders = ${if exists {/usr/lists/$local_part}\
31379              {lsearch;/usr/lists/$local_part}{*}}
31380   file = /usr/lists/$local_part
31381   forbid_pipe
31382   forbid_file
31383   errors_to = $local_part-request@lists.example
31384   no_more
31385
31386 lists_closed:
31387   driver = redirect
31388   domains = lists.example
31389   allow_fail
31390   data = :fail: $local_part@lists.example is a closed mailing list
31391 .endd
31392 All three routers have the same &%domains%& setting, so for any other domains,
31393 they are all skipped. The first router runs only if the local part ends in
31394 &%-request%&. It handles messages to the list manager(s) by means of an open
31395 mailing list.
31396
31397 The second router runs only if the &%senders%& precondition is satisfied. It
31398 checks for the existence of a list that corresponds to the local part, and then
31399 checks that the sender is on the list by means of a linear search. It is
31400 necessary to check for the existence of the file before trying to search it,
31401 because otherwise Exim thinks there is a configuration error. If the file does
31402 not exist, the expansion of &%senders%& is *, which matches all senders. This
31403 means that the router runs, but because there is no list, declines, and
31404 &%no_more%& ensures that no further routers are run. The address fails with an
31405 &"unrouteable address"& error.
31406
31407 The third router runs only if the second router is skipped, which happens when
31408 a mailing list exists, but the sender is not on it. This router forcibly fails
31409 the address, giving a suitable error message.
31410
31411
31412
31413
31414 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
31415 .cindex "VERP"
31416 .cindex "Variable Envelope Return Paths"
31417 .cindex "envelope sender"
31418 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
31419 are a way of helping mailing list administrators discover which subscription
31420 address is the cause of a particular delivery failure. The idea is to encode
31421 the original recipient address in the outgoing envelope sender address, so that
31422 if the message is forwarded by another host and then subsequently bounces, the
31423 original recipient can be extracted from the recipient address of the bounce.
31424
31425 .oindex &%errors_to%&
31426 .oindex &%return_path%&
31427 Envelope sender addresses can be modified by Exim using two different
31428 facilities: the &%errors_to%& option on a router (as shown in previous mailing
31429 list examples), or the &%return_path%& option on a transport. The second of
31430 these is effective only if the message is successfully delivered to another
31431 host; it is not used for errors detected on the local host (see the description
31432 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
31433 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
31434 .code
31435 verp_smtp:
31436   driver = smtp
31437   max_rcpt = 1
31438   return_path = \
31439     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
31440       {$1-request+$local_part=$domain@your.dom.example}fail}
31441 .endd
31442 This has the effect of rewriting the return path (envelope sender) on outgoing
31443 SMTP messages, if the local part of the original return path ends in
31444 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
31445 local part and domain of the recipient into the return path. Suppose, for
31446 example, that a message whose return path has been set to
31447 &'somelist-request@your.dom.example'& is sent to
31448 &'subscriber@other.dom.example'&. In the transport, the return path is
31449 rewritten as
31450 .code
31451 somelist-request+subscriber=other.dom.example@your.dom.example
31452 .endd
31453 .vindex "&$local_part$&"
31454 For this to work, you must tell Exim to send multiple copies of messages that
31455 have more than one recipient, so that each copy has just one recipient. This is
31456 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
31457 might be sent to several different recipients in the same domain, in which case
31458 &$local_part$& is not available in the transport, because it is not unique.
31459
31460 Unless your host is doing nothing but mailing list deliveries, you should
31461 probably use a separate transport for the VERP deliveries, so as not to use
31462 extra resources in making one-per-recipient copies for other deliveries. This
31463 can easily be done by expanding the &%transport%& option in the router:
31464 .code
31465 dnslookup:
31466   driver = dnslookup
31467   domains = ! +local_domains
31468   transport = \
31469     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
31470       {verp_smtp}{remote_smtp}}
31471   no_more
31472 .endd
31473 If you want to change the return path using &%errors_to%& in a router instead
31474 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
31475 routers that handle mailing list addresses. This will ensure that all delivery
31476 errors, including those detected on the local host, are sent to the VERP
31477 address.
31478
31479 On a host that does no local deliveries and has no manual routing, only the
31480 &(dnslookup)& router needs to be changed. A special transport is not needed for
31481 SMTP deliveries. Every mailing list recipient has its own return path value,
31482 and so Exim must hand them to the transport one at a time. Here is an example
31483 of a &(dnslookup)& router that implements VERP:
31484 .code
31485 verp_dnslookup:
31486   driver = dnslookup
31487   domains = ! +local_domains
31488   transport = remote_smtp
31489   errors_to = \
31490     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
31491      {$1-request+$local_part=$domain@your.dom.example}fail}
31492   no_more
31493 .endd
31494 Before you start sending out messages with VERPed return paths, you must also
31495 configure Exim to accept the bounce messages that come back to those paths.
31496 Typically this is done by setting a &%local_part_suffix%& option for a
31497 router, and using this to route the messages to wherever you want to handle
31498 them.
31499
31500 The overhead incurred in using VERP depends very much on the size of the
31501 message, the number of recipient addresses that resolve to the same remote
31502 host, and the speed of the connection over which the message is being sent. If
31503 a lot of addresses resolve to the same host and the connection is slow, sending
31504 a separate copy of the message for each address may take substantially longer
31505 than sending a single copy with many recipients (for which VERP cannot be
31506 used).
31507
31508
31509
31510
31511
31512
31513 .section "Virtual domains" "SECTvirtualdomains"
31514 .cindex "virtual domains"
31515 .cindex "domain" "virtual"
31516 The phrase &'virtual domain'& is unfortunately used with two rather different
31517 meanings:
31518
31519 .ilist
31520 A domain for which there are no real mailboxes; all valid local parts are
31521 aliases for other email addresses. Common examples are organizational
31522 top-level domains and &"vanity"& domains.
31523 .next
31524 One of a number of independent domains that are all handled by the same host,
31525 with mailboxes on that host, but where the mailbox owners do not necessarily
31526 have login accounts on that host.
31527 .endlist
31528
31529 The first usage is probably more common, and does seem more &"virtual"& than
31530 the second. This kind of domain can be handled in Exim with a straightforward
31531 aliasing router. One approach is to create a separate alias file for each
31532 virtual domain. Exim can test for the existence of the alias file to determine
31533 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
31534 to a router of this form:
31535 .code
31536 virtual:
31537   driver = redirect
31538   domains = dsearch;/etc/mail/virtual
31539   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
31540   no_more
31541 .endd
31542 The &%domains%& option specifies that the router is to be skipped, unless there
31543 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
31544 domain that is being processed. When the router runs, it looks up the local
31545 part in the file to find a new address (or list of addresses). The &%no_more%&
31546 setting ensures that if the lookup fails (leading to &%data%& being an empty
31547 string), Exim gives up on the address without trying any subsequent routers.
31548
31549 This one router can handle all the virtual domains because the alias file names
31550 follow a fixed pattern. Permissions can be arranged so that appropriate people
31551 can edit the different alias files. A successful aliasing operation results in
31552 a new envelope recipient address, which is then routed from scratch.
31553
31554 The other kind of &"virtual"& domain can also be handled in a straightforward
31555 way. One approach is to create a file for each domain containing a list of
31556 valid local parts, and use it in a router like this:
31557 .code
31558 my_domains:
31559   driver = accept
31560   domains = dsearch;/etc/mail/domains
31561   local_parts = lsearch;/etc/mail/domains/$domain
31562   transport = my_mailboxes
31563 .endd
31564 The address is accepted if there is a file for the domain, and the local part
31565 can be found in the file. The &%domains%& option is used to check for the
31566 file's existence because &%domains%& is tested before the &%local_parts%&
31567 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
31568 because that option is tested after &%local_parts%&. The transport is as
31569 follows:
31570 .code
31571 my_mailboxes:
31572   driver = appendfile
31573   file = /var/mail/$domain/$local_part
31574   user = mail
31575 .endd
31576 This uses a directory of mailboxes for each domain. The &%user%& setting is
31577 required, to specify which uid is to be used for writing to the mailboxes.
31578
31579 The configuration shown here is just one example of how you might support this
31580 requirement. There are many other ways this kind of configuration can be set
31581 up, for example, by using a database instead of separate files to hold all the
31582 information about the domains.
31583
31584
31585
31586 .section "Multiple user mailboxes" "SECTmulbox"
31587 .cindex "multiple mailboxes"
31588 .cindex "mailbox" "multiple"
31589 .cindex "local part" "prefix"
31590 .cindex "local part" "suffix"
31591 Heavy email users often want to operate with multiple mailboxes, into which
31592 incoming mail is automatically sorted. A popular way of handling this is to
31593 allow users to use multiple sender addresses, so that replies can easily be
31594 identified. Users are permitted to add prefixes or suffixes to their local
31595 parts for this purpose. The wildcard facility of the generic router options
31596 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
31597 example, consider this router:
31598 .code
31599 userforward:
31600   driver = redirect
31601   check_local_user
31602   file = $home/.forward
31603   local_part_suffix = -*
31604   local_part_suffix_optional
31605   allow_filter
31606 .endd
31607 .vindex "&$local_part_suffix$&"
31608 It runs a user's &_.forward_& file for all local parts of the form
31609 &'username-*'&. Within the filter file the user can distinguish different
31610 cases by testing the variable &$local_part_suffix$&. For example:
31611 .code
31612 if $local_part_suffix contains -special then
31613 save /home/$local_part/Mail/special
31614 endif
31615 .endd
31616 If the filter file does not exist, or does not deal with such addresses, they
31617 fall through to subsequent routers, and, assuming no subsequent use of the
31618 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
31619 control over which suffixes are valid.
31620
31621 Alternatively, a suffix can be used to trigger the use of a different
31622 &_.forward_& file &-- which is the way a similar facility is implemented in
31623 another MTA:
31624 .code
31625 userforward:
31626   driver = redirect
31627   check_local_user
31628   file = $home/.forward$local_part_suffix
31629   local_part_suffix = -*
31630   local_part_suffix_optional
31631   allow_filter
31632 .endd
31633 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
31634 example, &_.forward-special_& is used. Once again, if the appropriate file
31635 does not exist, or does not deal with the address, it is passed on to
31636 subsequent routers, which could, if required, look for an unqualified
31637 &_.forward_& file to use as a default.
31638
31639
31640
31641 .section "Simplified vacation processing" "SECID244"
31642 .cindex "vacation processing"
31643 The traditional way of running the &'vacation'& program is for a user to set up
31644 a pipe command in a &_.forward_& file
31645 (see section &<<SECTspecitredli>>& for syntax details).
31646 This is prone to error by inexperienced users. There are two features of Exim
31647 that can be used to make this process simpler for users:
31648
31649 .ilist
31650 A local part prefix such as &"vacation-"& can be specified on a router which
31651 can cause the message to be delivered directly to the &'vacation'& program, or
31652 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
31653 &_.forward_& file are then much simpler. For example:
31654 .code
31655 spqr, vacation-spqr
31656 .endd
31657 .next
31658 The &%require_files%& generic router option can be used to trigger a
31659 vacation delivery by checking for the existence of a certain file in the
31660 user's home directory. The &%unseen%& generic option should also be used, to
31661 ensure that the original delivery also proceeds. In this case, all the user has
31662 to do is to create a file called, say, &_.vacation_&, containing a vacation
31663 message.
31664 .endlist
31665
31666 Another advantage of both these methods is that they both work even when the
31667 use of arbitrary pipes by users is locked out.
31668
31669
31670
31671 .section "Taking copies of mail" "SECID245"
31672 .cindex "message" "copying every"
31673 Some installations have policies that require archive copies of all messages to
31674 be made. A single copy of each message can easily be taken by an appropriate
31675 command in a system filter, which could, for example, use a different file for
31676 each day's messages.
31677
31678 There is also a shadow transport mechanism that can be used to take copies of
31679 messages that are successfully delivered by local transports, one copy per
31680 delivery. This could be used, &'inter alia'&, to implement automatic
31681 notification of delivery by sites that insist on doing such things.
31682
31683
31684
31685 .section "Intermittently connected hosts" "SECID246"
31686 .cindex "intermittently connected hosts"
31687 It has become quite common (because it is cheaper) for hosts to connect to the
31688 Internet periodically rather than remain connected all the time. The normal
31689 arrangement is that mail for such hosts accumulates on a system that is
31690 permanently connected.
31691
31692 Exim was designed for use on permanently connected hosts, and so it is not
31693 particularly well-suited to use in an intermittently connected environment.
31694 Nevertheless there are some features that can be used.
31695
31696
31697 .section "Exim on the upstream server host" "SECID247"
31698 It is tempting to arrange for incoming mail for the intermittently connected
31699 host to remain on Exim's queue until the client connects. However, this
31700 approach does not scale very well. Two different kinds of waiting message are
31701 being mixed up in the same queue &-- those that cannot be delivered because of
31702 some temporary problem, and those that are waiting for their destination host
31703 to connect. This makes it hard to manage the queue, as well as wasting
31704 resources, because each queue runner scans the entire queue.
31705
31706 A better approach is to separate off those messages that are waiting for an
31707 intermittently connected host. This can be done by delivering these messages
31708 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
31709 format, from where they are transmitted by other software when their
31710 destination connects. This makes it easy to collect all the mail for one host
31711 in a single directory, and to apply local timeout rules on a per-message basis
31712 if required.
31713
31714 On a very small scale, leaving the mail on Exim's queue can be made to work. If
31715 you are doing this, you should configure Exim with a long retry period for the
31716 intermittent host. For example:
31717 .code
31718 cheshire.wonderland.fict.example    *   F,5d,24h
31719 .endd
31720 This stops a lot of failed delivery attempts from occurring, but Exim remembers
31721 which messages it has queued up for that host. Once the intermittent host comes
31722 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
31723 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
31724 causes all the queued up messages to be delivered, often down a single SMTP
31725 connection. While the host remains connected, any new messages get delivered
31726 immediately.
31727
31728 If the connecting hosts do not have fixed IP addresses, that is, if a host is
31729 issued with a different IP address each time it connects, Exim's retry
31730 mechanisms on the holding host get confused, because the IP address is normally
31731 used as part of the key string for holding retry information. This can be
31732 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
31733 Since this has disadvantages for permanently connected hosts, it is best to
31734 arrange a separate transport for the intermittently connected ones.
31735
31736
31737
31738 .section "Exim on the intermittently connected client host" "SECID248"
31739 The value of &%smtp_accept_queue_per_connection%& should probably be
31740 increased, or even set to zero (that is, disabled) on the intermittently
31741 connected host, so that all incoming messages down a single connection get
31742 delivered immediately.
31743
31744 .cindex "SMTP" "passed connection"
31745 .cindex "SMTP" "multiple deliveries"
31746 .cindex "multiple SMTP deliveries"
31747 Mail waiting to be sent from an intermittently connected host will probably
31748 not have been routed, because without a connection DNS lookups are not
31749 possible. This means that if a normal queue run is done at connection time,
31750 each message is likely to be sent in a separate SMTP session. This can be
31751 avoided by starting the queue run with a command line option beginning with
31752 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
31753 first pass, routing is done but no deliveries take place. The second pass is a
31754 normal queue run; since all the messages have been previously routed, those
31755 destined for the same host are likely to get sent as multiple deliveries in a
31756 single SMTP connection.
31757
31758
31759
31760 . ////////////////////////////////////////////////////////////////////////////
31761 . ////////////////////////////////////////////////////////////////////////////
31762
31763 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
31764          "Exim as a non-queueing client"
31765 .cindex "client, non-queueing"
31766 .cindex "smart host" "suppressing queueing"
31767 On a personal computer, it is a common requirement for all
31768 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
31769 configured to operate that way, for all the popular operating systems.
31770 However, there are some MUAs for Unix-like systems that cannot be so
31771 configured: they submit messages using the command line interface of
31772 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
31773 messages this way.
31774
31775 If the personal computer runs continuously, there is no problem, because it can
31776 run a conventional MTA that handles delivery to the smart host, and deal with
31777 any delays via its queueing mechanism. However, if the computer does not run
31778 continuously or runs different operating systems at different times, queueing
31779 email is not desirable.
31780
31781 There is therefore a requirement for something that can provide the
31782 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
31783 any queueing or retrying facilities. Furthermore, the delivery to the smart
31784 host should be synchronous, so that if it fails, the sending MUA is immediately
31785 informed. In other words, we want something that extends an MUA that submits
31786 to a local MTA via the command line so that it behaves like one that submits
31787 to a remote smart host using TCP/SMTP.
31788
31789 There are a number of applications (for example, there is one called &'ssmtp'&)
31790 that do this job. However, people have found them to be lacking in various
31791 ways. For instance, you might want to allow aliasing and forwarding to be done
31792 before sending a message to the smart host.
31793
31794 Exim already had the necessary infrastructure for doing this job. Just a few
31795 tweaks were needed to make it behave as required, though it is somewhat of an
31796 overkill to use a fully-featured MTA for this purpose.
31797
31798 .oindex "&%mua_wrapper%&"
31799 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
31800 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
31801 assumes that it is being used to &"wrap"& a command-line MUA in the manner
31802 just described. As well as setting &%mua_wrapper%&, you also need to provide a
31803 compatible router and transport configuration. Typically there will be just one
31804 router and one transport, sending everything to a smart host.
31805
31806 When run in MUA wrapping mode, the behaviour of Exim changes in the
31807 following ways:
31808
31809 .ilist
31810 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
31811 In other words, the only way to submit messages is via the command line.
31812 .next
31813 Each message is synchronously delivered as soon as it is received (&%-odi%& is
31814 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
31815 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
31816 does not finish until the delivery attempt is complete. If the delivery is
31817 successful, a zero return code is given.
31818 .next
31819 Address redirection is permitted, but the final routing for all addresses must
31820 be to the same remote transport, and to the same list of hosts. Furthermore,
31821 the return address (envelope sender) must be the same for all recipients, as
31822 must any added or deleted header lines. In other words, it must be possible to
31823 deliver the message in a single SMTP transaction, however many recipients there
31824 are.
31825 .next
31826 If these conditions are not met, or if routing any address results in a
31827 failure or defer status, or if Exim is unable to deliver all the recipients
31828 successfully to one of the smart hosts, delivery of the entire message fails.
31829 .next
31830 Because no queueing is allowed, all failures are treated as permanent; there
31831 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
31832 smart host. Furthermore, because only a single yes/no response can be given to
31833 the caller, it is not possible to deliver to some recipients and not others. If
31834 there is an error (temporary or permanent) for any recipient, all are failed.
31835 .next
31836 If more than one smart host is listed, Exim will try another host after a
31837 connection failure or a timeout, in the normal way. However, if this kind of
31838 failure happens for all the hosts, the delivery fails.
31839 .next
31840 When delivery fails, an error message is written to the standard error stream
31841 (as well as to Exim's log), and Exim exits to the caller with a return code
31842 value 1. The message is expunged from Exim's spool files. No bounce messages
31843 are ever generated.
31844 .next
31845 No retry data is maintained, and any retry rules are ignored.
31846 .next
31847 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
31848 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
31849 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
31850 .endlist
31851
31852 The overall effect is that Exim makes a single synchronous attempt to deliver
31853 the message, failing if there is any kind of problem. Because no local
31854 deliveries are done and no daemon can be run, Exim does not need root
31855 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
31856 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
31857 the advantages and disadvantages of running without root privilege.
31858
31859
31860
31861
31862 . ////////////////////////////////////////////////////////////////////////////
31863 . ////////////////////////////////////////////////////////////////////////////
31864
31865 .chapter "Log files" "CHAPlog"
31866 .scindex IIDloggen "log" "general description"
31867 .cindex "log" "types of"
31868 Exim writes three different logs, referred to as the main log, the reject log,
31869 and the panic log:
31870
31871 .ilist
31872 .cindex "main log"
31873 The main log records the arrival of each message and each delivery in a single
31874 line in each case. The format is as compact as possible, in an attempt to keep
31875 down the size of log files. Two-character flag sequences make it easy to pick
31876 out these lines. A number of other events are recorded in the main log. Some of
31877 them are optional, in which case the &%log_selector%& option controls whether
31878 they are included or not. A Perl script called &'eximstats'&, which does simple
31879 analysis of main log files, is provided in the Exim distribution (see section
31880 &<<SECTmailstat>>&).
31881 .next
31882 .cindex "reject log"
31883 The reject log records information from messages that are rejected as a result
31884 of a configuration option (that is, for policy reasons).
31885 The first line of each rejection is a copy of the line that is also written to
31886 the main log. Then, if the message's header has been read at the time the log
31887 is written, its contents are written to this log. Only the original header
31888 lines are available; header lines added by ACLs are not logged. You can use the
31889 reject log to check that your policy controls are working correctly; on a busy
31890 host this may be easier than scanning the main log for rejection messages. You
31891 can suppress the writing of the reject log by setting &%write_rejectlog%&
31892 false.
31893 .next
31894 .cindex "panic log"
31895 .cindex "system log"
31896 When certain serious errors occur, Exim writes entries to its panic log. If the
31897 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
31898 are usually written to the main log as well, but can get lost amid the mass of
31899 other entries. The panic log should be empty under normal circumstances. It is
31900 therefore a good idea to check it (or to have a &'cron'& script check it)
31901 regularly, in order to become aware of any problems. When Exim cannot open its
31902 panic log, it tries as a last resort to write to the system log (syslog). This
31903 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
31904 message itself is written at priority LOG_CRIT.
31905 .endlist
31906
31907 Every log line starts with a timestamp, in the format shown in the following
31908 example. Note that many of the examples shown in this chapter are line-wrapped.
31909 In the log file, this would be all on one line:
31910 .code
31911 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
31912   by QUIT
31913 .endd
31914 By default, the timestamps are in the local timezone. There are two
31915 ways of changing this:
31916
31917 .ilist
31918 You can set the &%timezone%& option to a different time zone; in particular, if
31919 you set
31920 .code
31921 timezone = UTC
31922 .endd
31923 the timestamps will be in UTC (aka GMT).
31924 .next
31925 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
31926 example:
31927 .code
31928 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
31929 .endd
31930 .endlist
31931
31932 .cindex "log" "process ids in"
31933 .cindex "pid (process id)" "in log lines"
31934 Exim does not include its process id in log lines by default, but you can
31935 request that it does so by specifying the &`pid`& log selector (see section
31936 &<<SECTlogselector>>&). When this is set, the process id is output, in square
31937 brackets, immediately after the time and date.
31938
31939
31940
31941
31942 .section "Where the logs are written" "SECTwhelogwri"
31943 .cindex "log" "destination"
31944 .cindex "log" "to file"
31945 .cindex "log" "to syslog"
31946 .cindex "syslog"
31947 The logs may be written to local files, or to syslog, or both. However, it
31948 should be noted that many syslog implementations use UDP as a transport, and
31949 are therefore unreliable in the sense that messages are not guaranteed to
31950 arrive at the loghost, nor is the ordering of messages necessarily maintained.
31951 It has also been reported that on large log files (tens of megabytes) you may
31952 need to tweak syslog to prevent it syncing the file with each write &-- on
31953 Linux this has been seen to make syslog take 90% plus of CPU time.
31954
31955 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
31956 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
31957 configuration. This latter string is expanded, so it can contain, for example,
31958 references to the host name:
31959 .code
31960 log_file_path = /var/log/$primary_hostname/exim_%slog
31961 .endd
31962 It is generally advisable, however, to set the string in &_Local/Makefile_&
31963 rather than at run time, because then the setting is available right from the
31964 start of Exim's execution. Otherwise, if there's something it wants to log
31965 before it has read the configuration file (for example, an error in the
31966 configuration file) it will not use the path you want, and may not be able to
31967 log at all.
31968
31969 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
31970 list, currently limited to at most two items. This is one option where the
31971 facility for changing a list separator may not be used. The list must always be
31972 colon-separated. If an item in the list is &"syslog"& then syslog is used;
31973 otherwise the item must either be an absolute path, containing &`%s`& at the
31974 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
31975 implying the use of a default path.
31976
31977 When Exim encounters an empty item in the list, it searches the list defined by
31978 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
31979 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
31980 mean &"use the path specified at build time"&. It no such item exists, log
31981 files are written in the &_log_& subdirectory of the spool directory. This is
31982 equivalent to the setting:
31983 .code
31984 log_file_path = $spool_directory/log/%slog
31985 .endd
31986 If you do not specify anything at build time or run time, that is where the
31987 logs are written.
31988
31989 A log file path may also contain &`%D`& if datestamped log file names are in
31990 use &-- see section &<<SECTdatlogfil>>& below.
31991
31992 Here are some examples of possible settings:
31993 .display
31994 &`LOG_FILE_PATH=syslog                    `& syslog only
31995 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
31996 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
31997 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
31998 .endd
31999 If there are more than two paths in the list, the first is used and a panic
32000 error is logged.
32001
32002
32003
32004 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
32005 .cindex "log" "cycling local files"
32006 .cindex "cycling logs"
32007 .cindex "&'exicyclog'&"
32008 .cindex "log" "local files; writing to"
32009 Some operating systems provide centralized and standardized methods for cycling
32010 log files. For those that do not, a utility script called &'exicyclog'& is
32011 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
32012 main and reject logs each time it is called. The maximum number of old logs to
32013 keep can be set. It is suggested this script is run as a daily &'cron'& job.
32014
32015 An Exim delivery process opens the main log when it first needs to write to it,
32016 and it keeps the file open in case subsequent entries are required &-- for
32017 example, if a number of different deliveries are being done for the same
32018 message. However, remote SMTP deliveries can take a long time, and this means
32019 that the file may be kept open long after it is renamed if &'exicyclog'& or
32020 something similar is being used to rename log files on a regular basis. To
32021 ensure that a switch of log files is noticed as soon as possible, Exim calls
32022 &[stat()]& on the main log's name before reusing an open file, and if the file
32023 does not exist, or its inode has changed, the old file is closed and Exim
32024 tries to open the main log from scratch. Thus, an old log file may remain open
32025 for quite some time, but no Exim processes should write to it once it has been
32026 renamed.
32027
32028
32029
32030 .section "Datestamped log files" "SECTdatlogfil"
32031 .cindex "log" "datestamped files"
32032 Instead of cycling the main and reject log files by renaming them
32033 periodically, some sites like to use files whose names contain a datestamp,
32034 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_&.
32035 Exim has support for this way of working. It is enabled by setting the
32036 &%log_file_path%& option to a path that includes &`%D`& at the point where the
32037 datestamp is required. For example:
32038 .code
32039 log_file_path = /var/spool/exim/log/%slog-%D
32040 log_file_path = /var/log/exim-%s-%D.log
32041 log_file_path = /var/spool/exim/log/%D-%slog
32042 .endd
32043 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
32044 examples of names generated by the above examples:
32045 .code
32046 /var/spool/exim/log/mainlog-20021225
32047 /var/log/exim-reject-20021225.log
32048 /var/spool/exim/log/20021225-mainlog
32049 .endd
32050 When this form of log file is specified, Exim automatically switches to new
32051 files at midnight. It does not make any attempt to compress old logs; you
32052 will need to write your own script if you require this. You should not
32053 run &'exicyclog'& with this form of logging.
32054
32055 The location of the panic log is also determined by &%log_file_path%&, but it
32056 is not datestamped, because rotation of the panic log does not make sense.
32057 When generating the name of the panic log, &`%D`& is removed from the string.
32058 In addition, if it immediately follows a slash, a following non-alphanumeric
32059 character is removed; otherwise a preceding non-alphanumeric character is
32060 removed. Thus, the three examples above would give these panic log names:
32061 .code
32062 /var/spool/exim/log/paniclog
32063 /var/log/exim-panic.log
32064 /var/spool/exim/log/paniclog
32065 .endd
32066
32067
32068 .section "Logging to syslog" "SECID249"
32069 .cindex "log" "syslog; writing to"
32070 The use of syslog does not change what Exim logs or the format of its messages,
32071 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
32072 Exim's log lines are omitted when these lines are sent to syslog. Apart from
32073 that, the same strings are written to syslog as to log files. The syslog
32074 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
32075 by default, but you can change these by setting the &%syslog_facility%& and
32076 &%syslog_processname%& options, respectively. If Exim was compiled with
32077 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
32078 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
32079 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
32080 the time and host name to each line.
32081 The three log streams are mapped onto syslog priorities as follows:
32082
32083 .ilist
32084 &'mainlog'& is mapped to LOG_INFO
32085 .next
32086 &'rejectlog'& is mapped to LOG_NOTICE
32087 .next
32088 &'paniclog'& is mapped to LOG_ALERT
32089 .endlist
32090
32091 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
32092 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
32093 these are routed by syslog to the same place. You can suppress this duplication
32094 by setting &%syslog_duplication%& false.
32095
32096 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
32097 entries contain multiple lines when headers are included. To cope with both
32098 these cases, entries written to syslog are split into separate &[syslog()]&
32099 calls at each internal newline, and also after a maximum of
32100 870 data characters. (This allows for a total syslog line length of 1024, when
32101 additions such as timestamps are added.) If you are running a syslog
32102 replacement that can handle lines longer than the 1024 characters allowed by
32103 RFC 3164, you should set
32104 .code
32105 SYSLOG_LONG_LINES=yes
32106 .endd
32107 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
32108 lines, but it still splits at internal newlines in &'reject'& log entries.
32109
32110 To make it easy to re-assemble split lines later, each component of a split
32111 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
32112 where <&'n'&> is the component number and <&'m'&> is the total number of
32113 components in the entry. The / delimiter is used when the line was split
32114 because it was too long; if it was split because of an internal newline, the \
32115 delimiter is used. For example, supposing the length limit to be 50 instead of
32116 870, the following would be the result of a typical rejection message to
32117 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
32118 name, and pid as added by syslog:
32119 .code
32120 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
32121 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
32122 [3/5]  when scanning for sender: missing or malformed lo
32123 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
32124 [5/5] mple>)
32125 .endd
32126 The same error might cause the following lines to be written to &"rejectlog"&
32127 (LOG_NOTICE):
32128 .code
32129 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
32130 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
32131 [3/18] er when scanning for sender: missing or malformed
32132 [4/18]  local part in "<>" (envelope sender is <ph10@cam
32133 [5\18] .example>)
32134 [6\18] Recipients: ph10@some.domain.cam.example
32135 [7\18] P Received: from [127.0.0.1] (ident=ph10)
32136 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
32137 [9\18]        id 16RdAL-0006pc-00
32138 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
32139 [11\18] 09:43 +0100
32140 [12\18] F From: <>
32141 [13\18]   Subject: this is a test header
32142 [18\18]   X-something: this is another header
32143 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
32144 [16\18] le>
32145 [17\18] B Bcc:
32146 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
32147 .endd
32148 Log lines that are neither too long nor contain newlines are written to syslog
32149 without modification.
32150
32151 If only syslog is being used, the Exim monitor is unable to provide a log tail
32152 display, unless syslog is routing &'mainlog'& to a file on the local host and
32153 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
32154 where it is.
32155
32156
32157
32158 .section "Log line flags" "SECID250"
32159 One line is written to the main log for each message received, and for each
32160 successful, unsuccessful, and delayed delivery. These lines can readily be
32161 picked out by the distinctive two-character flags that immediately follow the
32162 timestamp. The flags are:
32163 .display
32164 &`<=`&     message arrival
32165 &`=>`&     normal message delivery
32166 &`->`&     additional address in same delivery
32167 &`*>`&     delivery suppressed by &%-N%&
32168 &`**`&     delivery failed; address bounced
32169 &`==`&     delivery deferred; temporary problem
32170 .endd
32171
32172
32173 .section "Logging message reception" "SECID251"
32174 .cindex "log" "reception line"
32175 The format of the single-line entry in the main log that is written for every
32176 message received is shown in the basic example below, which is split over
32177 several lines in order to fit it on the page:
32178 .code
32179 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
32180   H=mailer.fict.example [192.168.123.123] U=exim
32181   P=smtp S=5678 id=<incoming message id>
32182 .endd
32183 The address immediately following &"<="& is the envelope sender address. A
32184 bounce message is shown with the sender address &"<>"&, and if it is locally
32185 generated, this is followed by an item of the form
32186 .code
32187 R=<message id>
32188 .endd
32189 which is a reference to the message that caused the bounce to be sent.
32190
32191 .cindex "HELO"
32192 .cindex "EHLO"
32193 For messages from other hosts, the H and U fields identify the remote host and
32194 record the RFC 1413 identity of the user that sent the message, if one was
32195 received. The number given in square brackets is the IP address of the sending
32196 host. If there is a single, unparenthesized  host name in the H field, as
32197 above, it has been verified to correspond to the IP address (see the
32198 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
32199 by the remote host in the SMTP HELO or EHLO command, and has not been
32200 verified. If verification yields a different name to that given for HELO or
32201 EHLO, the verified name appears first, followed by the HELO or EHLO
32202 name in parentheses.
32203
32204 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
32205 without brackets, in the HELO or EHLO command, leading to entries in
32206 the log containing text like these examples:
32207 .code
32208 H=(10.21.32.43) [192.168.8.34]
32209 H=([10.21.32.43]) [192.168.8.34]
32210 .endd
32211 This can be confusing. Only the final address in square brackets can be relied
32212 on.
32213
32214 For locally generated messages (that is, messages not received over TCP/IP),
32215 the H field is omitted, and the U field contains the login name of the caller
32216 of Exim.
32217
32218 .cindex "authentication" "logging"
32219 .cindex "AUTH" "logging"
32220 For all messages, the P field specifies the protocol used to receive the
32221 message. This is the value that is stored in &$received_protocol$&. In the case
32222 of incoming SMTP messages, the value indicates whether or not any SMTP
32223 extensions (ESMTP), encryption, or authentication were used. If the SMTP
32224 session was encrypted, there is an additional X field that records the cipher
32225 suite that was used.
32226
32227 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
32228 hosts that have authenticated themselves using the SMTP AUTH command. The first
32229 value is used when the SMTP connection was encrypted (&"secure"&). In this case
32230 there is an additional item A= followed by the name of the authenticator that
32231 was used. If an authenticated identification was set up by the authenticator's
32232 &%server_set_id%& option, this is logged too, separated by a colon from the
32233 authenticator name.
32234
32235 .cindex "size" "of message"
32236 The id field records the existing message id, if present. The size of the
32237 received message is given by the S field. When the message is delivered,
32238 headers may be removed or added, so that the size of delivered copies of the
32239 message may not correspond with this value (and indeed may be different to each
32240 other).
32241
32242 The &%log_selector%& option can be used to request the logging of additional
32243 data when a message is received. See section &<<SECTlogselector>>& below.
32244
32245
32246
32247 .section "Logging deliveries" "SECID252"
32248 .cindex "log" "delivery line"
32249 The format of the single-line entry in the main log that is written for every
32250 delivery is shown in one of the examples below, for local and remote
32251 deliveries, respectively. Each example has been split into two lines in order
32252 to fit it on the page:
32253 .code
32254 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
32255   <marv@hitch.fict.example> R=localuser T=local_delivery
32256 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
32257   monk@holistic.fict.example R=dnslookup T=remote_smtp
32258   H=holistic.fict.example [192.168.234.234]
32259 .endd
32260 For ordinary local deliveries, the original address is given in angle brackets
32261 after the final delivery address, which might be a pipe or a file. If
32262 intermediate address(es) exist between the original and the final address, the
32263 last of these is given in parentheses after the final address. The R and T
32264 fields record the router and transport that were used to process the address.
32265
32266 If a shadow transport was run after a successful local delivery, the log line
32267 for the successful delivery has an item added on the end, of the form
32268 .display
32269 &`ST=<`&&'shadow transport name'&&`>`&
32270 .endd
32271 If the shadow transport did not succeed, the error message is put in
32272 parentheses afterwards.
32273
32274 .cindex "asterisk" "after IP address"
32275 When more than one address is included in a single delivery (for example, two
32276 SMTP RCPT commands in one transaction) the second and subsequent addresses are
32277 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
32278 down a single SMTP connection, an asterisk follows the IP address in the log
32279 lines for the second and subsequent messages.
32280
32281 The generation of a reply message by a filter file gets logged as a
32282 &"delivery"& to the addressee, preceded by &">"&.
32283
32284 The &%log_selector%& option can be used to request the logging of additional
32285 data when a message is delivered. See section &<<SECTlogselector>>& below.
32286
32287
32288 .section "Discarded deliveries" "SECID253"
32289 .cindex "discarded messages"
32290 .cindex "message" "discarded"
32291 .cindex "delivery" "discarded; logging"
32292 When a message is discarded as a result of the command &"seen finish"& being
32293 obeyed in a filter file which generates no deliveries, a log entry of the form
32294 .code
32295 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
32296   <low.club@bridge.example> R=userforward
32297 .endd
32298 is written, to record why no deliveries are logged. When a message is discarded
32299 because it is aliased to &":blackhole:"& the log line is like this:
32300 .code
32301 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
32302   <hole@nowhere.example> R=blackhole_router
32303 .endd
32304
32305
32306 .section "Deferred deliveries" "SECID254"
32307 When a delivery is deferred, a line of the following form is logged:
32308 .code
32309 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
32310   R=dnslookup T=smtp defer (146): Connection refused
32311 .endd
32312 In the case of remote deliveries, the error is the one that was given for the
32313 last IP address that was tried. Details of individual SMTP failures are also
32314 written to the log, so the above line would be preceded by something like
32315 .code
32316 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
32317   mail1.endrest.example [192.168.239.239]: Connection refused
32318 .endd
32319 When a deferred address is skipped because its retry time has not been reached,
32320 a message is written to the log, but this can be suppressed by setting an
32321 appropriate value in &%log_selector%&.
32322
32323
32324
32325 .section "Delivery failures" "SECID255"
32326 .cindex "delivery" "failure; logging"
32327 If a delivery fails because an address cannot be routed, a line of the
32328 following form is logged:
32329 .code
32330 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
32331   <jim@trek99.example>: unknown mail domain
32332 .endd
32333 If a delivery fails at transport time, the router and transport are shown, and
32334 the response from the remote host is included, as in this example:
32335 .code
32336 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
32337   R=dnslookup T=remote_smtp: SMTP error from remote mailer
32338   after pipelined RCPT TO:<ace400@pb.example>: host
32339   pbmail3.py.example [192.168.63.111]: 553 5.3.0
32340   <ace400@pb.example>...Addressee unknown
32341 .endd
32342 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
32343 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
32344 disabling PIPELINING. The log lines for all forms of delivery failure are
32345 flagged with &`**`&.
32346
32347
32348
32349 .section "Fake deliveries" "SECID256"
32350 .cindex "delivery" "fake; logging"
32351 If a delivery does not actually take place because the &%-N%& option has been
32352 used to suppress it, a normal delivery line is written to the log, except that
32353 &"=>"& is replaced by &"*>"&.
32354
32355
32356
32357 .section "Completion" "SECID257"
32358 A line of the form
32359 .code
32360 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
32361 .endd
32362 is written to the main log when a message is about to be removed from the spool
32363 at the end of its processing.
32364
32365
32366
32367
32368 .section "Summary of Fields in Log Lines" "SECID258"
32369 .cindex "log" "summary of fields"
32370 A summary of the field identifiers that are used in log lines is shown in
32371 the following table:
32372 .display
32373 &`A   `&        authenticator name (and optional id)
32374 &`C   `&        SMTP confirmation on delivery
32375 &`    `&        command list for &"no mail in SMTP session"&
32376 &`CV  `&        certificate verification status
32377 &`D   `&        duration of &"no mail in SMTP session"&
32378 &`DN  `&        distinguished name from peer certificate
32379 &`DT  `&        on &`=>`& lines: time taken for a delivery
32380 &`F   `&        sender address (on delivery lines)
32381 &`H   `&        host name and IP address
32382 &`I   `&        local interface used
32383 &`id  `&        message id for incoming message
32384 &`P   `&        on &`<=`& lines: protocol used
32385 &`    `&        on &`=>`& and &`**`& lines: return path
32386 &`QT  `&        on &`=>`& lines: time spent on queue so far
32387 &`    `&        on &"Completed"& lines: time spent on queue
32388 &`R   `&        on &`<=`& lines: reference for local bounce
32389 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
32390 &`S   `&        size of message
32391 &`ST  `&        shadow transport name
32392 &`T   `&        on &`<=`& lines: message subject (topic)
32393 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
32394 &`U   `&        local user or RFC 1413 identity
32395 &`X   `&        TLS cipher suite
32396 .endd
32397
32398
32399 .section "Other log entries" "SECID259"
32400 Various other types of log entry are written from time to time. Most should be
32401 self-explanatory. Among the more common are:
32402
32403 .ilist
32404 .cindex "retry" "time not reached"
32405 &'retry time not reached'&&~&~An address previously suffered a temporary error
32406 during routing or local delivery, and the time to retry has not yet arrived.
32407 This message is not written to an individual message log file unless it happens
32408 during the first delivery attempt.
32409 .next
32410 &'retry time not reached for any host'&&~&~An address previously suffered
32411 temporary errors during remote delivery, and the retry time has not yet arrived
32412 for any of the hosts to which it is routed.
32413 .next
32414 .cindex "spool directory" "file locked"
32415 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
32416 some other Exim process is already working on the message. This can be quite
32417 common if queue running processes are started at frequent intervals. The
32418 &'exiwhat'& utility script can be used to find out what Exim processes are
32419 doing.
32420 .next
32421 .cindex "error" "ignored"
32422 &'error ignored'&&~&~There are several circumstances that give rise to this
32423 message:
32424 .olist
32425 Exim failed to deliver a bounce message whose age was greater than
32426 &%ignore_bounce_errors_after%&. The bounce was discarded.
32427 .next
32428 A filter file set up a delivery using the &"noerror"& option, and the delivery
32429 failed. The delivery was discarded.
32430 .next
32431 A delivery set up by a router configured with
32432 . ==== As this is a nested list, any displays it contains must be indented
32433 . ==== as otherwise they are too far to the left.
32434 .code
32435     errors_to = <>
32436 .endd
32437 failed. The delivery was discarded.
32438 .endlist olist
32439 .endlist ilist
32440
32441
32442
32443
32444
32445 .section "Reducing or increasing what is logged" "SECTlogselector"
32446 .cindex "log" "selectors"
32447 By setting the &%log_selector%& global option, you can disable some of Exim's
32448 default logging, or you can request additional logging. The value of
32449 &%log_selector%& is made up of names preceded by plus or minus characters. For
32450 example:
32451 .code
32452 log_selector = +arguments -retry_defer
32453 .endd
32454 The list of optional log items is in the following table, with the default
32455 selection marked by asterisks:
32456 .display
32457 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
32458 &` address_rewrite            `&  address rewriting
32459 &` all_parents                `&  all parents in => lines
32460 &` arguments                  `&  command line arguments
32461 &`*connection_reject          `&  connection rejections
32462 &`*delay_delivery             `&  immediate delivery delayed
32463 &` deliver_time               `&  time taken to perform delivery
32464 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
32465 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
32466 &`*etrn                       `&  ETRN commands
32467 &`*host_lookup_failed         `&  as it says
32468 &` ident_timeout              `&  timeout for ident connection
32469 &` incoming_interface         `&  incoming interface on <= lines
32470 &` incoming_port              `&  incoming port on <= lines
32471 &`*lost_incoming_connection   `&  as it says (includes timeouts)
32472 &` outgoing_port              `&  add remote port to => lines
32473 &`*queue_run                  `&  start and end queue runs
32474 &` queue_time                 `&  time on queue for one recipient
32475 &` queue_time_overall         `&  time on queue for whole message
32476 &` pid                        `&  Exim process id
32477 &` received_recipients        `&  recipients on <= lines
32478 &` received_sender            `&  sender on <= lines
32479 &`*rejected_header            `&  header contents on reject log
32480 &`*retry_defer                `&  &"retry time not reached"&
32481 &` return_path_on_delivery    `&  put return path on => and ** lines
32482 &` sender_on_delivery         `&  add sender to => lines
32483 &`*sender_verify_fail         `&  sender verification failures
32484 &`*size_reject                `&  rejection because too big
32485 &`*skip_delivery              `&  delivery skipped in a queue run
32486 &` smtp_confirmation          `&  SMTP confirmation on => lines
32487 &` smtp_connection            `&  SMTP connections
32488 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
32489 &` smtp_no_mail               `&  session with no MAIL commands
32490 &` smtp_protocol_error        `&  SMTP protocol errors
32491 &` smtp_syntax_error          `&  SMTP syntax errors
32492 &` subject                    `&  contents of &'Subject:'& on <= lines
32493 &` tls_certificate_verified   `&  certificate verification status
32494 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
32495 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
32496 &` unknown_in_list            `&  DNS lookup failed in list match
32497
32498 &` all                        `&  all of the above
32499 .endd
32500 More details on each of these items follows:
32501
32502 .ilist
32503 .cindex "&%warn%& ACL verb" "log when skipping"
32504 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
32505 its conditions cannot be evaluated, a log line to this effect is written if
32506 this log selector is set.
32507 .next
32508 .cindex "log" "rewriting"
32509 .cindex "rewriting" "logging"
32510 &%address_rewrite%&: This applies both to global rewrites and per-transport
32511 rewrites, but not to rewrites in filters run as an unprivileged user (because
32512 such users cannot access the log).
32513 .next
32514 .cindex "log" "full parentage"
32515 &%all_parents%&: Normally only the original and final addresses are logged on
32516 delivery lines; with this selector, intermediate parents are given in
32517 parentheses between them.
32518 .next
32519 .cindex "log" "Exim arguments"
32520 .cindex "Exim arguments, logging"
32521 &%arguments%&: This causes Exim to write the arguments with which it was called
32522 to the main log, preceded by the current working directory. This is a debugging
32523 feature, added to make it easier to find out how certain MUAs call
32524 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
32525 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
32526 that are empty or that contain white space are quoted. Non-printing characters
32527 are shown as escape sequences. This facility cannot log unrecognized arguments,
32528 because the arguments are checked before the configuration file is read. The
32529 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
32530 between the caller and Exim.
32531 .next
32532 .cindex "log" "connection rejections"
32533 &%connection_reject%&: A log entry is written whenever an incoming SMTP
32534 connection is rejected, for whatever reason.
32535 .next
32536 .cindex "log" "delayed delivery"
32537 .cindex "delayed delivery, logging"
32538 &%delay_delivery%&: A log entry is written whenever a delivery process is not
32539 started for an incoming message because the load is too high or too many
32540 messages were received on one connection. Logging does not occur if no delivery
32541 process is started because &%queue_only%& is set or &%-odq%& was used.
32542 .next
32543 .cindex "log" "delivery duration"
32544 &%deliver_time%&: For each delivery, the amount of real time it has taken to
32545 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
32546 .next
32547 .cindex "log" "message size on delivery"
32548 .cindex "size" "of message"
32549 &%delivery_size%&: For each delivery, the size of message delivered is added to
32550 the &"=>"& line, tagged with S=.
32551 .next
32552 .cindex "log" "dnslist defer"
32553 .cindex "DNS list" "logging defer"
32554 .cindex "black list (DNS)"
32555 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
32556 DNS black list suffers a temporary error.
32557 .next
32558 .cindex "log" "ETRN commands"
32559 .cindex "ETRN" "logging"
32560 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
32561 is run to determine whether or not it is actually accepted. An invalid ETRN
32562 command, or one received within a message transaction is not logged by this
32563 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
32564 .next
32565 .cindex "log" "host lookup failure"
32566 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
32567 any addresses, or when a lookup of an IP address fails to find a host name, a
32568 log line is written. This logging does not apply to direct DNS lookups when
32569 routing email addresses, but it does apply to &"byname"& lookups.
32570 .next
32571 .cindex "log" "ident timeout"
32572 .cindex "RFC 1413" "logging timeout"
32573 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
32574 client's ident port times out.
32575 .next
32576 .cindex "log" "incoming interface"
32577 .cindex "interface" "logging"
32578 &%incoming_interface%&: The interface on which a message was received is added
32579 to the &"<="& line as an IP address in square brackets, tagged by I= and
32580 followed by a colon and the port number. The local interface and port are also
32581 added to other SMTP log lines, for example &"SMTP connection from"&, and to
32582 rejection lines.
32583 .next
32584 .cindex "log" "incoming remote port"
32585 .cindex "port" "logging remote"
32586 .cindex "TCP/IP" "logging incoming remote port"
32587 .vindex "&$sender_fullhost$&"
32588 .vindex "&$sender_rcvhost$&"
32589 &%incoming_port%&: The remote port number from which a message was received is
32590 added to log entries and &'Received:'& header lines, following the IP address
32591 in square brackets, and separated from it by a colon. This is implemented by
32592 changing the value that is put in the &$sender_fullhost$& and
32593 &$sender_rcvhost$& variables. Recording the remote port number has become more
32594 important with the widening use of NAT (see RFC 2505).
32595 .next
32596 .cindex "log" "dropped connection"
32597 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
32598 connection is unexpectedly dropped.
32599 .next
32600 .cindex "log" "outgoing remote port"
32601 .cindex "port" "logging outgoint remote"
32602 .cindex "TCP/IP" "logging ougtoing remote port"
32603 &%outgoing_port%&: The remote port number is added to delivery log lines (those
32604 containing => tags) following the IP address. This option is not included in
32605 the default setting, because for most ordinary configurations, the remote port
32606 number is always 25 (the SMTP port).
32607 .next
32608 .cindex "log" "process ids in"
32609 .cindex "pid (process id)" "in log lines"
32610 &%pid%&: The current process id is added to every log line, in square brackets,
32611 immediately after the time and date.
32612 .next
32613 .cindex "log" "queue run"
32614 .cindex "queue runner" "logging"
32615 &%queue_run%&: The start and end of every queue run are logged.
32616 .next
32617 .cindex "log" "queue time"
32618 &%queue_time%&: The amount of time the message has been in the queue on the
32619 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
32620 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
32621 includes reception time as well as the delivery time for the current address.
32622 This means that it may be longer than the difference between the arrival and
32623 delivery log line times, because the arrival log line is not written until the
32624 message has been successfully received.
32625 .next
32626 &%queue_time_overall%&: The amount of time the message has been in the queue on
32627 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
32628 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
32629 message, so it includes reception time as well as the total delivery time.
32630 .next
32631 .cindex "log" "recipients"
32632 &%received_recipients%&: The recipients of a message are listed in the main log
32633 as soon as the message is received. The list appears at the end of the log line
32634 that is written when a message is received, preceded by the word &"for"&. The
32635 addresses are listed after they have been qualified, but before any rewriting
32636 has taken place.
32637 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
32638 in the list.
32639 .next
32640 .cindex "log" "sender reception"
32641 &%received_sender%&: The unrewritten original sender of a message is added to
32642 the end of the log line that records the message's arrival, after the word
32643 &"from"& (before the recipients if &%received_recipients%& is also set).
32644 .next
32645 .cindex "log" "header lines for rejection"
32646 &%rejected_header%&: If a message's header has been received at the time a
32647 rejection is written to the reject log, the complete header is added to the
32648 log. Header logging can be turned off individually for messages that are
32649 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
32650 .next
32651 .cindex "log" "retry defer"
32652 &%retry_defer%&: A log line is written if a delivery is deferred because a
32653 retry time has not yet been reached. However, this &"retry time not reached"&
32654 message is always omitted from individual message logs after the first delivery
32655 attempt.
32656 .next
32657 .cindex "log" "return path"
32658 &%return_path_on_delivery%&: The return path that is being transmitted with
32659 the message is included in delivery and bounce lines, using the tag P=.
32660 This is omitted if no delivery actually happens, for example, if routing fails,
32661 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
32662 .next
32663 .cindex "log" "sender on delivery"
32664 &%sender_on_delivery%&: The message's sender address is added to every delivery
32665 and bounce line, tagged by F= (for &"from"&).
32666 This is the original sender that was received with the message; it is not
32667 necessarily the same as the outgoing return path.
32668 .next
32669 .cindex "log" "sender verify failure"
32670 &%sender_verify_fail%&: If this selector is unset, the separate log line that
32671 gives details of a sender verification failure is not written. Log lines for
32672 the rejection of SMTP commands contain just &"sender verify failed"&, so some
32673 detail is lost.
32674 .next
32675 .cindex "log" "size rejection"
32676 &%size_reject%&: A log line is written whenever a message is rejected because
32677 it is too big.
32678 .next
32679 .cindex "log" "frozen messages; skipped"
32680 .cindex "frozen messages" "logging skipping"
32681 &%skip_delivery%&: A log line is written whenever a message is skipped during a
32682 queue run because it is frozen or because another process is already delivering
32683 it.
32684 .cindex "&""spool file is locked""&"
32685 The message that is written is &"spool file is locked"&.
32686 .next
32687 .cindex "log" "smtp confirmation"
32688 .cindex "SMTP" "logging confirmation"
32689 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
32690 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
32691 A number of MTAs (including Exim) return an identifying string in this
32692 response.
32693 .next
32694 .cindex "log" "SMTP connections"
32695 .cindex "SMTP" "logging connections"
32696 &%smtp_connection%&: A log line is written whenever an SMTP connection is
32697 established or closed, unless the connection is from a host that matches
32698 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
32699 only when the closure is unexpected.) This applies to connections from local
32700 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
32701 dropped in the middle of a message, a log line is always written, whether or
32702 not this selector is set, but otherwise nothing is written at the start and end
32703 of connections unless this selector is enabled.
32704
32705 For TCP/IP connections to an Exim daemon, the current number of connections is
32706 included in the log message for each new connection, but note that the count is
32707 reset if the daemon is restarted.
32708 Also, because connections are closed (and the closure is logged) in
32709 subprocesses, the count may not include connections that have been closed but
32710 whose termination the daemon has not yet noticed. Thus, while it is possible to
32711 match up the opening and closing of connections in the log, the value of the
32712 logged counts may not be entirely accurate.
32713 .next
32714 .cindex "log" "SMTP transaction; incomplete"
32715 .cindex "SMTP" "logging incomplete transactions"
32716 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
32717 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
32718 and the message sender plus any accepted recipients are included in the log
32719 line. This can provide evidence of dictionary attacks.
32720 .next
32721 .cindex "log" "non-MAIL SMTP sessions"
32722 .cindex "MAIL" "logging session without"
32723 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
32724 connection terminates without having issued a MAIL command. This includes both
32725 the case when the connection is dropped, and the case when QUIT is used. It
32726 does not include cases where the connection is rejected right at the start (by
32727 an ACL, or because there are too many connections, or whatever). These cases
32728 already have their own log lines.
32729
32730 The log line that is written contains the identity of the client in the usual
32731 way, followed by D= and a time, which records the duration of the connection.
32732 If the connection was authenticated, this fact is logged exactly as it is for
32733 an incoming message, with an A= item. If the connection was encrypted, CV=,
32734 DN=, and X= items may appear as they do for an incoming message, controlled by
32735 the same logging options.
32736
32737 Finally, if any SMTP commands were issued during the connection, a C= item
32738 is added to the line, listing the commands that were used. For example,
32739 .code
32740 C=EHLO,QUIT
32741 .endd
32742 shows that the client issued QUIT straight after EHLO. If there were fewer
32743 than 20 commands, they are all listed. If there were more than 20 commands,
32744 the last 20 are listed, preceded by &"..."&. However, with the default
32745 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
32746 have been aborted before 20 non-mail commands are processed.
32747 .next
32748 .cindex "log" "SMTP protocol error"
32749 .cindex "SMTP" "logging protocol error"
32750 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
32751 encountered. Exim does not have perfect detection of all protocol errors
32752 because of transmission delays and the use of pipelining. If PIPELINING has
32753 been advertised to a client, an Exim server assumes that the client will use
32754 it, and therefore it does not count &"expected"& errors (for example, RCPT
32755 received after rejecting MAIL) as protocol errors.
32756 .next
32757 .cindex "SMTP" "logging syntax errors"
32758 .cindex "SMTP" "syntax errors; logging"
32759 .cindex "SMTP" "unknown command; logging"
32760 .cindex "log" "unknown SMTP command"
32761 .cindex "log" "SMTP syntax error"
32762 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
32763 encountered. An unrecognized command is treated as a syntax error. For an
32764 external connection, the host identity is given; for an internal connection
32765 using &%-bs%& the sender identification (normally the calling user) is given.
32766 .next
32767 .cindex "log" "subject"
32768 .cindex "subject, logging"
32769 &%subject%&: The subject of the message is added to the arrival log line,
32770 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
32771 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
32772 specifies whether characters with values greater than 127 should be logged
32773 unchanged, or whether they should be rendered as escape sequences.
32774 .next
32775 .cindex "log" "certificate verification"
32776 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
32777 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
32778 verified, and &`CV=no`& if not.
32779 .next
32780 .cindex "log" "TLS cipher"
32781 .cindex "TLS" "logging cipher"
32782 &%tls_cipher%&: When a message is sent or received over an encrypted
32783 connection, the cipher suite used is added to the log line, preceded by X=.
32784 .next
32785 .cindex "log" "TLS peer DN"
32786 .cindex "TLS" "logging peer DN"
32787 &%tls_peerdn%&: When a message is sent or received over an encrypted
32788 connection, and a certificate is supplied by the remote host, the peer DN is
32789 added to the log line, preceded by DN=.
32790 .next
32791 .cindex "log" "DNS failure in list"
32792 &%unknown_in_list%&: This setting causes a log entry to be written when the
32793 result of a list match is failure because a DNS lookup failed.
32794 .endlist
32795
32796
32797 .section "Message log" "SECID260"
32798 .cindex "message" "log file for"
32799 .cindex "log" "message log; description of"
32800 .cindex "&_msglog_& directory"
32801 .oindex "&%preserve_message_logs%&"
32802 In addition to the general log files, Exim writes a log file for each message
32803 that it handles. The names of these per-message logs are the message ids, and
32804 they are kept in the &_msglog_& sub-directory of the spool directory. Each
32805 message log contains copies of the log lines that apply to the message. This
32806 makes it easier to inspect the status of an individual message without having
32807 to search the main log. A message log is deleted when processing of the message
32808 is complete, unless &%preserve_message_logs%& is set, but this should be used
32809 only with great care because they can fill up your disk very quickly.
32810
32811 On a heavily loaded system, it may be desirable to disable the use of
32812 per-message logs, in order to reduce disk I/O. This can be done by setting the
32813 &%message_logs%& option false.
32814 .ecindex IIDloggen
32815
32816
32817
32818
32819 . ////////////////////////////////////////////////////////////////////////////
32820 . ////////////////////////////////////////////////////////////////////////////
32821
32822 .chapter "Exim utilities" "CHAPutils"
32823 .scindex IIDutils "utilities"
32824 A number of utility scripts and programs are supplied with Exim and are
32825 described in this chapter. There is also the Exim Monitor, which is covered in
32826 the next chapter. The utilities described here are:
32827
32828 .itable none 0 0 3  7* left  15* left  40* left
32829 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
32830   "list what Exim processes are doing"
32831 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
32832 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
32833 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
32834 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
32835                                                 various criteria"
32836 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
32837 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
32838   "extract statistics from the log"
32839 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
32840   "check address acceptance from given IP"
32841 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
32842 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
32843 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
32844 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
32845 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
32846 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
32847 .endtable
32848
32849 Another utility that might be of use to sites with many MTAs is Tom Kistner's
32850 &'exilog'&. It provides log visualizations across multiple Exim servers. See
32851 &url(http://duncanthrax.net/exilog/) for details.
32852
32853
32854
32855
32856 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
32857 .cindex "&'exiwhat'&"
32858 .cindex "process, querying"
32859 .cindex "SIGUSR1"
32860 On operating systems that can restart a system call after receiving a signal
32861 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
32862 a line describing what it is doing to the file &_exim-process.info_& in the
32863 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
32864 processes it can find, having first emptied the file. It then waits for one
32865 second to allow the Exim processes to react before displaying the results. In
32866 order to run &'exiwhat'& successfully you have to have sufficient privilege to
32867 send the signal to the Exim processes, so it is normally run as root.
32868
32869 &*Warning*&: This is not an efficient process. It is intended for occasional
32870 use by system administrators. It is not sensible, for example, to set up a
32871 script that sends SIGUSR1 signals to Exim processes at short intervals.
32872
32873
32874 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
32875 varies in different operating systems. Not only are different options used,
32876 but the format of the output is different. For this reason, there are some
32877 system configuration options that configure exactly how &'exiwhat'& works. If
32878 it doesn't seem to be working for you, check the following compile-time
32879 options:
32880 .display
32881 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
32882 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
32883 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
32884 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
32885 .endd
32886 An example of typical output from &'exiwhat'& is
32887 .code
32888 164 daemon: -q1h, listening on port 25
32889 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
32890 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
32891   [10.19.42.42] (editor@ref.example)
32892 10592 handling incoming call from [192.168.243.242]
32893 10628 accepting a local non-SMTP message
32894 .endd
32895 The first number in the output line is the process number. The third line has
32896 been split here, in order to fit it on the page.
32897
32898
32899
32900 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
32901 .cindex "&'exiqgrep'&"
32902 .cindex "queue" "grepping"
32903 This utility is a Perl script contributed by Matt Hubbard. It runs
32904 .code
32905 exim -bpu
32906 .endd
32907 to obtain a queue listing with undelivered recipients only, and then greps the
32908 output to select messages that match given criteria. The following selection
32909 options are available:
32910
32911 .vlist
32912 .vitem &*-f*&&~<&'regex'&>
32913 Match the sender address. The field that is tested is enclosed in angle
32914 brackets, so you can test for bounce messages with
32915 .code
32916 exiqgrep -f '^<>$'
32917 .endd
32918 .vitem &*-r*&&~<&'regex'&>
32919 Match a recipient address. The field that is tested is not enclosed in angle
32920 brackets.
32921
32922 .vitem &*-s*&&~<&'regex'&>
32923 Match against the size field.
32924
32925 .vitem &*-y*&&~<&'seconds'&>
32926 Match messages that are younger than the given time.
32927
32928 .vitem &*-o*&&~<&'seconds'&>
32929 Match messages that are older than the given time.
32930
32931 .vitem &*-z*&
32932 Match only frozen messages.
32933
32934 .vitem &*-x*&
32935 Match only non-frozen messages.
32936 .endlist
32937
32938 The following options control the format of the output:
32939
32940 .vlist
32941 .vitem &*-c*&
32942 Display only the count of matching messages.
32943
32944 .vitem &*-l*&
32945 Long format &-- display the full message information as output by Exim. This is
32946 the default.
32947
32948 .vitem &*-i*&
32949 Display message ids only.
32950
32951 .vitem &*-b*&
32952 Brief format &-- one line per message.
32953
32954 .vitem &*-R*&
32955 Display messages in reverse order.
32956 .endlist
32957
32958 There is one more option, &%-h%&, which outputs a list of options.
32959
32960
32961
32962 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
32963 .cindex "&'exiqsumm'&"
32964 .cindex "queue" "summary"
32965 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
32966 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
32967 running a command such as
32968 .code
32969 exim -bp | exiqsumm
32970 .endd
32971 The output consists of one line for each domain that has messages waiting for
32972 it, as in the following example:
32973 .code
32974 3   2322   74m   66m  msn.com.example
32975 .endd
32976 Each line lists the number of pending deliveries for a domain, their total
32977 volume, and the length of time that the oldest and the newest messages have
32978 been waiting. Note that the number of pending deliveries is greater than the
32979 number of messages when messages have more than one recipient.
32980
32981 A summary line is output at the end. By default the output is sorted on the
32982 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
32983 the output to be sorted by oldest message and by count of messages,
32984 respectively. There are also three options that split the messages for each
32985 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
32986 separates frozen messages, and &%-s%& separates messages according to their
32987 sender.
32988
32989 The output of &'exim -bp'& contains the original addresses in the message, so
32990 this also applies to the output from &'exiqsumm'&. No domains from addresses
32991 generated by aliasing or forwarding are included (unless the &%one_time%&
32992 option of the &(redirect)& router has been used to convert them into &"top
32993 level"& addresses).
32994
32995
32996
32997
32998 .section "Extracting specific information from the log (exigrep)" &&&
32999          "SECTextspeinf"
33000 .cindex "&'exigrep'&"
33001 .cindex "log" "extracts; grepping for"
33002 The &'exigrep'& utility is a Perl script that searches one or more main log
33003 files for entries that match a given pattern. When it finds a match, it
33004 extracts all the log entries for the relevant message, not just those that
33005 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
33006 given message, or all mail for a given user, or for a given host, for example.
33007 The input files can be in Exim log format or syslog format.
33008 If a matching log line is not associated with a specific message, it is
33009 included in &'exigrep'&'s output without any additional lines. The usage is:
33010 .display
33011 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
33012 .endd
33013 If no log file names are given on the command line, the standard input is read.
33014
33015 The &%-t%& argument specifies a number of seconds. It adds an additional
33016 condition for message selection. Messages that are complete are shown only if
33017 they spent more than <&'n'&> seconds on the queue.
33018
33019 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
33020 makes it case-sensitive. This may give a performance improvement when searching
33021 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
33022 option; with &%-I%& they do not. In both cases it is possible to change the
33023 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
33024
33025 The &%-l%& option means &"literal"&, that is, treat all characters in the
33026 pattern as standing for themselves. Otherwise the pattern must be a Perl
33027 regular expression.
33028
33029 The &%-v%& option inverts the matching condition. That is, a line is selected
33030 if it does &'not'& match the pattern.
33031
33032 If the location of a &'zcat'& command is known from the definition of
33033 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
33034 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
33035
33036
33037 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
33038 .cindex "&'exipick'&"
33039 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
33040 lists messages from the queue according to a variety of criteria. For details
33041 of &'exipick'&'s facilities, visit the web page at
33042 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
33043 the &%--help%& option.
33044
33045
33046 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
33047 .cindex "log" "cycling local files"
33048 .cindex "cycling logs"
33049 .cindex "&'exicyclog'&"
33050 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
33051 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
33052 you are using log files with datestamps in their names (see section
33053 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
33054 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
33055 There are two command line options for &'exicyclog'&:
33056 .ilist
33057 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
33058 default that is set when Exim is built. The default default is 10.
33059 .next
33060 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
33061 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
33062 overriding the script's default, which is to find the setting from Exim's
33063 configuration.
33064 .endlist
33065
33066 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
33067 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
33068 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
33069 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
33070 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
33071 logs are handled similarly.
33072
33073 If the limit is greater than 99, the script uses 3-digit numbers such as
33074 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
33075 to one that is greater, or &'vice versa'&, you will have to fix the names of
33076 any existing log files.
33077
33078 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
33079 the end are deleted. All files with numbers greater than 01 are compressed,
33080 using a compression command which is configured by the COMPRESS_COMMAND
33081 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
33082 root &%crontab%& entry of the form
33083 .code
33084 1 0 * * * su exim -c /usr/exim/bin/exicyclog
33085 .endd
33086 assuming you have used the name &"exim"& for the Exim user. You can run
33087 &'exicyclog'& as root if you wish, but there is no need.
33088
33089
33090
33091 .section "Mail statistics (eximstats)" "SECTmailstat"
33092 .cindex "statistics"
33093 .cindex "&'eximstats'&"
33094 A Perl script called &'eximstats'& is provided for extracting statistical
33095 information from log files. The output is either plain text, or HTML.
33096 Exim log files are also supported by the &'Lire'& system produced by the
33097 LogReport Foundation &url(http://www.logreport.org).
33098
33099 The &'eximstats'& script has been hacked about quite a bit over time. The
33100 latest version is the result of some extensive revision by Steve Campbell. A
33101 lot of information is given by default, but there are options for suppressing
33102 various parts of it. Following any options, the arguments to the script are a
33103 list of files, which should be main log files. For example:
33104 .code
33105 eximstats -nr /var/spool/exim/log/mainlog.01
33106 .endd
33107 By default, &'eximstats'& extracts information about the number and volume of
33108 messages received from or delivered to various hosts. The information is sorted
33109 both by message count and by volume, and the top fifty hosts in each category
33110 are listed on the standard output. Similar information, based on email
33111 addresses or domains instead of hosts can be requested by means of various
33112 options. For messages delivered and received locally, similar statistics are
33113 also produced per user.
33114
33115 The output also includes total counts and statistics about delivery errors, and
33116 histograms showing the number of messages received and deliveries made in each
33117 hour of the day. A delivery with more than one address in its envelope (for
33118 example, an SMTP transaction with more than one RCPT command) is counted
33119 as a single delivery by &'eximstats'&.
33120
33121 Though normally more deliveries than receipts are reported (as messages may
33122 have multiple recipients), it is possible for &'eximstats'& to report more
33123 messages received than delivered, even though the queue is empty at the start
33124 and end of the period in question. If an incoming message contains no valid
33125 recipients, no deliveries are recorded for it. A bounce message is handled as
33126 an entirely separate message.
33127
33128 &'eximstats'& always outputs a grand total summary giving the volume and number
33129 of messages received and deliveries made, and the number of hosts involved in
33130 each case. It also outputs the number of messages that were delayed (that is,
33131 not completely delivered at the first attempt), and the number that had at
33132 least one address that failed.
33133
33134 The remainder of the output is in sections that can be independently disabled
33135 or modified by various options. It consists of a summary of deliveries by
33136 transport, histograms of messages received and delivered per time interval
33137 (default per hour), information about the time messages spent on the queue,
33138 a list of relayed messages, lists of the top fifty sending hosts, local
33139 senders, destination hosts, and destination local users by count and by volume,
33140 and a list of delivery errors that occurred.
33141
33142 The relay information lists messages that were actually relayed, that is, they
33143 came from a remote host and were directly delivered to some other remote host,
33144 without being processed (for example, for aliasing or forwarding) locally.
33145
33146 There are quite a few options for &'eximstats'& to control exactly what it
33147 outputs. These are documented in the Perl script itself, and can be extracted
33148 by running the command &(perldoc)& on the script. For example:
33149 .code
33150 perldoc /usr/exim/bin/eximstats
33151 .endd
33152
33153 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
33154 .cindex "&'exim_checkaccess'&"
33155 .cindex "policy control" "checking access"
33156 .cindex "checking access"
33157 The &%-bh%& command line argument allows you to run a fake SMTP session with
33158 debugging output, in order to check what Exim is doing when it is applying
33159 policy controls to incoming SMTP mail. However, not everybody is sufficiently
33160 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
33161 sometimes you just want to answer the question &"Does this address have
33162 access?"& without bothering with any further details.
33163
33164 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
33165 two arguments, an IP address and an email address:
33166 .code
33167 exim_checkaccess 10.9.8.7 A.User@a.domain.example
33168 .endd
33169 The utility runs a call to Exim with the &%-bh%& option, to test whether the
33170 given email address would be accepted in a RCPT command in a TCP/IP
33171 connection from the host with the given IP address. The output of the utility
33172 is either the word &"accepted"&, or the SMTP error response, for example:
33173 .code
33174 Rejected:
33175 550 Relay not permitted
33176 .endd
33177 When running this test, the utility uses &`<>`& as the envelope sender address
33178 for the MAIL command, but you can change this by providing additional
33179 options. These are passed directly to the Exim command. For example, to specify
33180 that the test is to be run with the sender address &'himself@there.example'&
33181 you can use:
33182 .code
33183 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
33184                  -f himself@there.example
33185 .endd
33186 Note that these additional Exim command line items must be given after the two
33187 mandatory arguments.
33188
33189 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
33190 while running its checks. You can run checks that include callouts by using
33191 &%-bhc%&, but this is not yet available in a &"packaged"& form.
33192
33193
33194
33195 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
33196 .cindex "DBM" "building dbm files"
33197 .cindex "building DBM files"
33198 .cindex "&'exim_dbmbuild'&"
33199 .cindex "lower casing"
33200 .cindex "binary zero" "in lookup key"
33201 The &'exim_dbmbuild'& program reads an input file containing keys and data in
33202 the format used by the &(lsearch)& lookup (see section
33203 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
33204 names as keys and the remainder of the information as data. The lower-casing
33205 can be prevented by calling the program with the &%-nolc%& option.
33206
33207 A terminating zero is included as part of the key string. This is expected by
33208 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
33209 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
33210 strings or the data strings. The &(dbmnz)& lookup type can be used with such
33211 files.
33212
33213 The program requires two arguments: the name of the input file (which can be a
33214 single hyphen to indicate the standard input), and the name of the output file.
33215 It creates the output under a temporary name, and then renames it if all went
33216 well.
33217
33218 .cindex "USE_DB"
33219 If the native DB interface is in use (USE_DB is set in a compile-time
33220 configuration file &-- this is common in free versions of Unix) the two file
33221 names must be different, because in this mode the Berkeley DB functions create
33222 a single output file using exactly the name given. For example,
33223 .code
33224 exim_dbmbuild /etc/aliases /etc/aliases.db
33225 .endd
33226 reads the system alias file and creates a DBM version of it in
33227 &_/etc/aliases.db_&.
33228
33229 In systems that use the &'ndbm'& routines (mostly proprietary versions of
33230 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
33231 environment, the suffixes are added to the second argument of
33232 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
33233 when the Berkeley functions are used in compatibility mode (though this is not
33234 recommended), because in that case it adds a &_.db_& suffix to the file name.
33235
33236 If a duplicate key is encountered, the program outputs a warning, and when it
33237 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
33238 option is used. By default, only the first of a set of duplicates is used &--
33239 this makes it compatible with &(lsearch)& lookups. There is an option
33240 &%-lastdup%& which causes it to use the data for the last duplicate instead.
33241 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
33242 &%stderr%&. For other errors, where it doesn't actually make a new file, the
33243 return code is 2.
33244
33245
33246
33247
33248 .section "Finding individual retry times (exinext)" "SECTfinindret"
33249 .cindex "retry" "times"
33250 .cindex "&'exinext'&"
33251 A utility called &'exinext'& (mostly a Perl script) provides the ability to
33252 fish specific information out of the retry database. Given a mail domain (or a
33253 complete address), it looks up the hosts for that domain, and outputs any retry
33254 information for the hosts or for the domain. At present, the retry information
33255 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
33256 output. For example:
33257 .code
33258 $ exinext piglet@milne.fict.example
33259 kanga.milne.example:192.168.8.1 error 146: Connection refused
33260   first failed: 21-Feb-1996 14:57:34
33261   last tried:   21-Feb-1996 14:57:34
33262   next try at:  21-Feb-1996 15:02:34
33263 roo.milne.example:192.168.8.3 error 146: Connection refused
33264   first failed: 20-Jan-1996 13:12:08
33265   last tried:   21-Feb-1996 11:42:03
33266   next try at:  21-Feb-1996 19:42:03
33267   past final cutoff time
33268 .endd
33269 You can also give &'exinext'& a local part, without a domain, and it
33270 will give any retry information for that local part in your default domain.
33271 A message id can be used to obtain retry information pertaining to a specific
33272 message. This exists only when an attempt to deliver a message to a remote host
33273 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
33274 &'exinext'& is not particularly efficient, but then it is not expected to be
33275 run very often.
33276
33277 The &'exinext'& utility calls Exim to find out information such as the location
33278 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
33279 passed on to the &'exim'& commands. The first specifies an alternate Exim
33280 configuration file, and the second sets macros for use within the configuration
33281 file. These features are mainly to help in testing, but might also be useful in
33282 environments where more than one configuration file is in use.
33283
33284
33285
33286 .section "Hints database maintenance" "SECThindatmai"
33287 .cindex "hints database" "maintenance"
33288 .cindex "maintaining Exim's hints database"
33289 Three utility programs are provided for maintaining the DBM files that Exim
33290 uses to contain its delivery hint information. Each program requires two
33291 arguments. The first specifies the name of Exim's spool directory, and the
33292 second is the name of the database it is to operate on. These are as follows:
33293
33294 .ilist
33295 &'retry'&: the database of retry information
33296 .next
33297 &'wait-'&<&'transport name'&>: databases of information about messages waiting
33298 for remote hosts
33299 .next
33300 &'callout'&: the callout cache
33301 .next
33302 &'ratelimit'&: the data for implementing the ratelimit ACL condition
33303 .next
33304 &'misc'&: other hints data
33305 .endlist
33306
33307 The &'misc'& database is used for
33308
33309 .ilist
33310 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
33311 .next
33312 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
33313 &(smtp)& transport)
33314 .endlist
33315
33316
33317
33318 .section "exim_dumpdb" "SECID261"
33319 .cindex "&'exim_dumpdb'&"
33320 The entire contents of a database are written to the standard output by the
33321 &'exim_dumpdb'& program, which has no options or arguments other than the
33322 spool and database names. For example, to dump the retry database:
33323 .code
33324 exim_dumpdb /var/spool/exim retry
33325 .endd
33326 Two lines of output are produced for each entry:
33327 .code
33328 T:mail.ref.example:192.168.242.242 146 77 Connection refused
33329 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
33330 .endd
33331 The first item on the first line is the key of the record. It starts with one
33332 of the letters R, or T, depending on whether it refers to a routing or
33333 transport retry. For a local delivery, the next part is the local address; for
33334 a remote delivery it is the name of the remote host, followed by its failing IP
33335 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
33336 transport). If the remote port is not the standard one (port 25), it is added
33337 to the IP address. Then there follows an error code, an additional error code,
33338 and a textual description of the error.
33339
33340 The three times on the second line are the time of first failure, the time of
33341 the last delivery attempt, and the computed time for the next attempt. The line
33342 ends with an asterisk if the cutoff time for the last retry rule has been
33343 exceeded.
33344
33345 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
33346 consists of a host name followed by a list of ids for messages that are or were
33347 waiting to be delivered to that host. If there are a very large number for any
33348 one host, continuation records, with a sequence number added to the host name,
33349 may be seen. The data in these records is often out of date, because a message
33350 may be routed to several alternative hosts, and Exim makes no effort to keep
33351 cross-references.
33352
33353
33354
33355 .section "exim_tidydb" "SECID262"
33356 .cindex "&'exim_tidydb'&"
33357 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
33358 database. If run with no options, it removes all records that are more than 30
33359 days old. The age is calculated from the date and time that the record was last
33360 updated. Note that, in the case of the retry database, it is &'not'& the time
33361 since the first delivery failure. Information about a host that has been down
33362 for more than 30 days will remain in the database, provided that the record is
33363 updated sufficiently often.
33364
33365 The cutoff date can be altered by means of the &%-t%& option, which must be
33366 followed by a time. For example, to remove all records older than a week from
33367 the retry database:
33368 .code
33369 exim_tidydb -t 7d /var/spool/exim retry
33370 .endd
33371 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
33372 message ids. In the former these appear as data in records keyed by host &--
33373 they were messages that were waiting for that host &-- and in the latter they
33374 are the keys for retry information for messages that have suffered certain
33375 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
33376 message ids in database records are those of messages that are still on the
33377 queue. Message ids for messages that no longer exist are removed from
33378 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
33379 For the &'retry'& database, records whose keys are non-existent message ids are
33380 removed. The &'exim_tidydb'& utility outputs comments on the standard output
33381 whenever it removes information from the database.
33382
33383 Certain records are automatically removed by Exim when they are no longer
33384 needed, but others are not. For example, if all the MX hosts for a domain are
33385 down, a retry record is created for each one. If the primary MX host comes back
33386 first, its record is removed when Exim successfully delivers to it, but the
33387 records for the others remain because Exim has not tried to use those hosts.
33388
33389 It is important, therefore, to run &'exim_tidydb'& periodically on all the
33390 hints databases. You should do this at a quiet time of day, because it requires
33391 a database to be locked (and therefore inaccessible to Exim) while it does its
33392 work. Removing records from a DBM file does not normally make the file smaller,
33393 but all the common DBM libraries are able to re-use the space that is released.
33394 After an initial phase of increasing in size, the databases normally reach a
33395 point at which they no longer get any bigger, as long as they are regularly
33396 tidied.
33397
33398 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
33399 databases is likely to keep on increasing.
33400
33401
33402
33403
33404 .section "exim_fixdb" "SECID263"
33405 .cindex "&'exim_fixdb'&"
33406 The &'exim_fixdb'& program is a utility for interactively modifying databases.
33407 Its main use is for testing Exim, but it might also be occasionally useful for
33408 getting round problems in a live system. It has no options, and its interface
33409 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
33410 key of a database record can then be entered, and the data for that record is
33411 displayed.
33412
33413 If &"d"& is typed at the next prompt, the entire record is deleted. For all
33414 except the &'retry'& database, that is the only operation that can be carried
33415 out. For the &'retry'& database, each field is output preceded by a number, and
33416 data for individual fields can be changed by typing the field number followed
33417 by new data, for example:
33418 .code
33419 > 4 951102:1000
33420 .endd
33421 resets the time of the next delivery attempt. Time values are given as a
33422 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
33423 used as optional separators.
33424
33425
33426
33427
33428 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
33429 .cindex "mailbox" "maintenance"
33430 .cindex "&'exim_lock'&"
33431 .cindex "locking mailboxes"
33432 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
33433 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
33434 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
33435 a user agent while investigating a problem. The utility requires the name of
33436 the file as its first argument. If the locking is successful, the second
33437 argument is run as a command (using C's &[system()]& function); if there is no
33438 second argument, the value of the SHELL environment variable is used; if this
33439 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
33440 is unlocked and the utility ends. The following options are available:
33441
33442 .vlist
33443 .vitem &%-fcntl%&
33444 Use &[fcntl()]& locking on the open mailbox.
33445
33446 .vitem &%-flock%&
33447 Use &[flock()]& locking on the open mailbox, provided the operating system
33448 supports it.
33449
33450 .vitem &%-interval%&
33451 This must be followed by a number, which is a number of seconds; it sets the
33452 interval to sleep between retries (default 3).
33453
33454 .vitem &%-lockfile%&
33455 Create a lock file before opening the mailbox.
33456
33457 .vitem &%-mbx%&
33458 Lock the mailbox using MBX rules.
33459
33460 .vitem &%-q%&
33461 Suppress verification output.
33462
33463 .vitem &%-retries%&
33464 This must be followed by a number; it sets the number of times to try to get
33465 the lock (default 10).
33466
33467 .vitem &%-restore_time%&
33468 This option causes &%exim_lock%& to restore the modified and read times to the
33469 locked file before exiting. This allows you to access a locked mailbox (for
33470 example, to take a backup copy) without disturbing the times that the user
33471 subsequently sees.
33472
33473 .vitem &%-timeout%&
33474 This must be followed by a number, which is a number of seconds; it sets a
33475 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
33476 default), a non-blocking call is used.
33477
33478 .vitem &%-v%&
33479 Generate verbose output.
33480 .endlist
33481
33482 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
33483 default is to create a lock file and also to use &[fcntl()]& locking on the
33484 mailbox, which is the same as Exim's default. The use of &%-flock%& or
33485 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
33486 requires that the directory containing the file be writeable. Locking by lock
33487 file does not last for ever; Exim assumes that a lock file is expired if it is
33488 more than 30 minutes old.
33489
33490 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
33491 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
33492 to be taken out on the open mailbox, and an exclusive lock on the file
33493 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
33494 number of the mailbox file. When the locking is released, if an exclusive lock
33495 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
33496
33497 The default output contains verification of the locking that takes place. The
33498 &%-v%& option causes some additional information to be given. The &%-q%& option
33499 suppresses all output except error messages.
33500
33501 A command such as
33502 .code
33503 exim_lock /var/spool/mail/spqr
33504 .endd
33505 runs an interactive shell while the file is locked, whereas
33506 .display
33507 &`exim_lock -q /var/spool/mail/spqr <<End`&
33508 <&'some commands'&>
33509 &`End`&
33510 .endd
33511 runs a specific non-interactive sequence of commands while the file is locked,
33512 suppressing all verification output. A single command can be run by a command
33513 such as
33514 .code
33515 exim_lock -q /var/spool/mail/spqr \
33516   "cp /var/spool/mail/spqr /some/where"
33517 .endd
33518 Note that if a command is supplied, it must be entirely contained within the
33519 second argument &-- hence the quotes.
33520 .ecindex IIDutils
33521
33522
33523 . ////////////////////////////////////////////////////////////////////////////
33524 . ////////////////////////////////////////////////////////////////////////////
33525
33526 .chapter "The Exim monitor" "CHAPeximon"
33527 .scindex IIDeximon "Exim monitor" "description"
33528 .cindex "X-windows"
33529 .cindex "&'eximon'&"
33530 .cindex "Local/eximon.conf"
33531 .cindex "&_exim_monitor/EDITME_&"
33532 The Exim monitor is an application which displays in an X window information
33533 about the state of Exim's queue and what Exim is doing. An admin user can
33534 perform certain operations on messages from this GUI interface; however all
33535 such facilities are also available from the command line, and indeed, the
33536 monitor itself makes use of the command line to perform any actions requested.
33537
33538
33539
33540 .section "Running the monitor" "SECID264"
33541 The monitor is started by running the script called &'eximon'&. This is a shell
33542 script that sets up a number of environment variables, and then runs the
33543 binary called &_eximon.bin_&. The default appearance of the monitor window can
33544 be changed by editing the &_Local/eximon.conf_& file created by editing
33545 &_exim_monitor/EDITME_&. Comments in that file describe what the various
33546 parameters are for.
33547
33548 The parameters that get built into the &'eximon'& script can be overridden for
33549 a particular invocation by setting up environment variables of the same names,
33550 preceded by &`EXIMON_`&. For example, a shell command such as
33551 .code
33552 EXIMON_LOG_DEPTH=400 eximon
33553 .endd
33554 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
33555 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
33556 overrides the Exim log file configuration. This makes it possible to have
33557 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
33558 syslog messages are routed to a file on the local host.
33559
33560 X resources can be used to change the appearance of the window in the normal
33561 way. For example, a resource setting of the form
33562 .code
33563 Eximon*background: gray94
33564 .endd
33565 changes the colour of the background to light grey rather than white. The
33566 stripcharts are drawn with both the data lines and the reference lines in
33567 black. This means that the reference lines are not visible when on top of the
33568 data. However, their colour can be changed by setting a resource called
33569 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
33570 For example, if your X server is running Unix, you could set up lighter
33571 reference lines in the stripcharts by obeying
33572 .code
33573 xrdb -merge <<End
33574 Eximon*highlight: gray
33575 End
33576 .endd
33577 .cindex "admin user"
33578 In order to see the contents of messages on the queue, and to operate on them,
33579 &'eximon'& must either be run as root or by an admin user.
33580
33581 The monitor's window is divided into three parts. The first contains one or
33582 more stripcharts and two action buttons, the second contains a &"tail"& of the
33583 main log file, and the third is a display of the queue of messages awaiting
33584 delivery, with two more action buttons. The following sections describe these
33585 different parts of the display.
33586
33587
33588
33589
33590 .section "The stripcharts" "SECID265"
33591 .cindex "stripchart"
33592 The first stripchart is always a count of messages on the queue. Its name can
33593 be configured by setting QUEUE_STRIPCHART_NAME in the
33594 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
33595 configuration script by regular expression matches on log file entries, making
33596 it possible to display, for example, counts of messages delivered to certain
33597 hosts or using certain transports. The supplied defaults display counts of
33598 received and delivered messages, and of local and SMTP deliveries. The default
33599 period between stripchart updates is one minute; this can be adjusted by a
33600 parameter in the &_Local/eximon.conf_& file.
33601
33602 The stripchart displays rescale themselves automatically as the value they are
33603 displaying changes. There are always 10 horizontal lines in each chart; the
33604 title string indicates the value of each division when it is greater than one.
33605 For example, &"x2"& means that each division represents a value of 2.
33606
33607 It is also possible to have a stripchart which shows the percentage fullness of
33608 a particular disk partition, which is useful when local deliveries are confined
33609 to a single partition.
33610
33611 .cindex "&%statvfs%& function"
33612 This relies on the availability of the &[statvfs()]& function or equivalent in
33613 the operating system. Most, but not all versions of Unix that support Exim have
33614 this. For this particular stripchart, the top of the chart always represents
33615 100%, and the scale is given as &"x10%"&. This chart is configured by setting
33616 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
33617 &_Local/eximon.conf_& file.
33618
33619
33620
33621
33622 .section "Main action buttons" "SECID266"
33623 .cindex "size" "of monitor window"
33624 .cindex "Exim monitor" "window size"
33625 .cindex "window size"
33626 Below the stripcharts there is an action button for quitting the monitor. Next
33627 to this is another button marked &"Size"&. They are placed here so that
33628 shrinking the window to its default minimum size leaves just the queue count
33629 stripchart and these two buttons visible. Pressing the &"Size"& button causes
33630 the window to expand to its maximum size, unless it is already at the maximum,
33631 in which case it is reduced to its minimum.
33632
33633 When expanding to the maximum, if the window cannot be fully seen where it
33634 currently is, it is moved back to where it was the last time it was at full
33635 size. When it is expanding from its minimum size, the old position is
33636 remembered, and next time it is reduced to the minimum it is moved back there.
33637
33638 The idea is that you can keep a reduced window just showing one or two
33639 stripcharts at a convenient place on your screen, easily expand it to show
33640 the full window when required, and just as easily put it back to what it was.
33641 The idea is copied from what the &'twm'& window manager does for its
33642 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
33643 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
33644
33645 Normally, the monitor starts up with the window at its full size, but it can be
33646 built so that it starts up with the window at its smallest size, by setting
33647 START_SMALL=yes in &_Local/eximon.conf_&.
33648
33649
33650
33651 .section "The log display" "SECID267"
33652 .cindex "log" "tail of; in monitor"
33653 The second section of the window is an area in which a display of the tail of
33654 the main log is maintained.
33655 To save space on the screen, the timestamp on each log line is shortened by
33656 removing the date and, if &%log_timezone%& is set, the timezone.
33657 The log tail is not available when the only destination for logging data is
33658 syslog, unless the syslog lines are routed to a local file whose name is passed
33659 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
33660
33661 The log sub-window has a scroll bar at its lefthand side which can be used to
33662 move back to look at earlier text, and the up and down arrow keys also have a
33663 scrolling effect. The amount of log that is kept depends on the setting of
33664 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
33665 to use. When this is full, the earlier 50% of data is discarded &-- this is
33666 much more efficient than throwing it away line by line. The sub-window also has
33667 a horizontal scroll bar for accessing the ends of long log lines. This is the
33668 only means of horizontal scrolling; the right and left arrow keys are not
33669 available. Text can be cut from this part of the window using the mouse in the
33670 normal way. The size of this subwindow is controlled by parameters in the
33671 configuration file &_Local/eximon.conf_&.
33672
33673 Searches of the text in the log window can be carried out by means of the ^R
33674 and ^S keystrokes, which default to a reverse and a forward search,
33675 respectively. The search covers only the text that is displayed in the window.
33676 It cannot go further back up the log.
33677
33678 The point from which the search starts is indicated by a caret marker. This is
33679 normally at the end of the text in the window, but can be positioned explicitly
33680 by pointing and clicking with the left mouse button, and is moved automatically
33681 by a successful search. If new text arrives in the window when it is scrolled
33682 back, the caret remains where it is, but if the window is not scrolled back,
33683 the caret is moved to the end of the new text.
33684
33685 Pressing ^R or ^S pops up a window into which the search text can be typed.
33686 There are buttons for selecting forward or reverse searching, for carrying out
33687 the search, and for cancelling. If the &"Search"& button is pressed, the search
33688 happens and the window remains so that further searches can be done. If the
33689 &"Return"& key is pressed, a single search is done and the window is closed. If
33690 ^C is typed the search is cancelled.
33691
33692 The searching facility is implemented using the facilities of the Athena text
33693 widget. By default this pops up a window containing both &"search"& and
33694 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
33695 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
33696 However, the linkers in BSDI and HP-UX seem unable to handle an externally
33697 provided version of &%TextPop%& when the remaining parts of the text widget
33698 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
33699 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
33700 on these systems, at the expense of having unwanted items in the search popup
33701 window.
33702
33703
33704
33705 .section "The queue display" "SECID268"
33706 .cindex "queue" "display in monitor"
33707 The bottom section of the monitor window contains a list of all messages that
33708 are on the queue, which includes those currently being received or delivered,
33709 as well as those awaiting delivery. The size of this subwindow is controlled by
33710 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
33711 at which it is updated is controlled by another parameter in the same file &--
33712 the default is 5 minutes, since queue scans can be quite expensive. However,
33713 there is an &"Update"& action button just above the display which can be used
33714 to force an update of the queue display at any time.
33715
33716 When a host is down for some time, a lot of pending mail can build up for it,
33717 and this can make it hard to deal with other messages on the queue. To help
33718 with this situation there is a button next to &"Update"& called &"Hide"&. If
33719 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
33720 type anything in here and press &"Return"&, the text is added to a chain of
33721 such texts, and if every undelivered address in a message matches at least one
33722 of the texts, the message is not displayed.
33723
33724 If there is an address that does not match any of the texts, all the addresses
33725 are displayed as normal. The matching happens on the ends of addresses so, for
33726 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
33727 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
33728 has been set up, a button called &"Unhide"& is displayed. If pressed, it
33729 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
33730 a hide request is automatically cancelled after one hour.
33731
33732 While the dialogue box is displayed, you can't press any buttons or do anything
33733 else to the monitor window. For this reason, if you want to cut text from the
33734 queue display to use in the dialogue box, you have to do the cutting before
33735 pressing the &"Hide"& button.
33736
33737 The queue display contains, for each unhidden queued message, the length of
33738 time it has been on the queue, the size of the message, the message id, the
33739 message sender, and the first undelivered recipient, all on one line. If it is
33740 a bounce message, the sender is shown as &"<>"&. If there is more than one
33741 recipient to which the message has not yet been delivered, subsequent ones are
33742 listed on additional lines, up to a maximum configured number, following which
33743 an ellipsis is displayed. Recipients that have already received the message are
33744 not shown.
33745
33746 .cindex "frozen messages" "display"
33747 If a message is frozen, an asterisk is displayed at the left-hand side.
33748
33749 The queue display has a vertical scroll bar, and can also be scrolled by means
33750 of the arrow keys. Text can be cut from it using the mouse in the normal way.
33751 The text searching facilities, as described above for the log window, are also
33752 available, but the caret is always moved to the end of the text when the queue
33753 display is updated.
33754
33755
33756
33757 .section "The queue menu" "SECID269"
33758 .cindex "queue" "menu in monitor"
33759 If the &%shift%& key is held down and the left button is clicked when the mouse
33760 pointer is over the text for any message, an action menu pops up, and the first
33761 line of the queue display for the message is highlighted. This does not affect
33762 any selected text.
33763
33764 If you want to use some other event for popping up the menu, you can set the
33765 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
33766 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
33767 value set in this parameter is a standard X event description. For example, to
33768 run eximon using &%ctrl%& rather than &%shift%& you could use
33769 .code
33770 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
33771 .endd
33772 The title of the menu is the message id, and it contains entries which act as
33773 follows:
33774
33775 .ilist
33776 &'message log'&: The contents of the message log for the message are displayed
33777 in a new text window.
33778 .next
33779 &'headers'&: Information from the spool file that contains the envelope
33780 information and headers is displayed in a new text window. See chapter
33781 &<<CHAPspool>>& for a description of the format of spool files.
33782 .next
33783 &'body'&: The contents of the spool file containing the body of the message are
33784 displayed in a new text window. There is a default limit of 20,000 bytes to the
33785 amount of data displayed. This can be changed by setting the BODY_MAX
33786 option at compile time, or the EXIMON_BODY_MAX option at run time.
33787 .next
33788 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
33789 delivery of the message. This causes an automatic thaw if the message is
33790 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
33791 a new text window. The delivery is run in a separate process, to avoid holding
33792 up the monitor while the delivery proceeds.
33793 .next
33794 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
33795 that the message be frozen.
33796 .next
33797 .cindex "thawing messages"
33798 .cindex "unfreezing messages"
33799 .cindex "frozen messages" "thawing"
33800 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
33801 that the message be thawed.
33802 .next
33803 .cindex "delivery" "forcing failure"
33804 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
33805 that Exim gives up trying to deliver the message. A bounce message is generated
33806 for any remaining undelivered addresses.
33807 .next
33808 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
33809 that the message be deleted from the system without generating a bounce
33810 message.
33811 .next
33812 &'add recipient'&: A dialog box is displayed into which a recipient address can
33813 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
33814 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
33815 Otherwise it must be entered as a fully qualified address. Pressing RETURN
33816 causes a call to Exim to be made using the &%-Mar%& option to request that an
33817 additional recipient be added to the message, unless the entry box is empty, in
33818 which case no action is taken.
33819 .next
33820 &'mark delivered'&: A dialog box is displayed into which a recipient address
33821 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
33822 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
33823 Otherwise it must be entered as a fully qualified address. Pressing RETURN
33824 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
33825 recipient address as already delivered, unless the entry box is empty, in which
33826 case no action is taken.
33827 .next
33828 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
33829 mark all recipient addresses as already delivered.
33830 .next
33831 &'edit sender'&: A dialog box is displayed initialized with the current
33832 sender's address. Pressing RETURN causes a call to Exim to be made using the
33833 &%-Mes%& option to replace the sender address, unless the entry box is empty,
33834 in which case no action is taken. If you want to set an empty sender (as in
33835 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
33836 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
33837 the address is qualified with that domain.
33838 .endlist
33839
33840 When a delivery is forced, a window showing the &%-v%& output is displayed. In
33841 other cases when a call to Exim is made, if there is any output from Exim (in
33842 particular, if the command fails) a window containing the command and the
33843 output is displayed. Otherwise, the results of the action are normally apparent
33844 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
33845 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
33846 if no output is generated.
33847
33848 The queue display is automatically updated for actions such as freezing and
33849 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
33850 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
33851 force an update of the display after one of these actions.
33852
33853 In any text window that is displayed as result of a menu action, the normal
33854 cut-and-paste facility is available, and searching can be carried out using ^R
33855 and ^S, as described above for the log tail window.
33856 .ecindex IIDeximon
33857
33858
33859
33860
33861
33862 . ////////////////////////////////////////////////////////////////////////////
33863 . ////////////////////////////////////////////////////////////////////////////
33864
33865 .chapter "Security considerations" "CHAPsecurity"
33866 .scindex IIDsecurcon "security" "discussion of"
33867 This chapter discusses a number of issues concerned with security, some of
33868 which are also covered in other parts of this manual.
33869
33870 For reasons that this author does not understand, some people have promoted
33871 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
33872 existence of this chapter in the documentation. However, the intent of the
33873 chapter is simply to describe the way Exim works in relation to certain
33874 security concerns, not to make any specific claims about the effectiveness of
33875 its security as compared with other MTAs.
33876
33877 What follows is a description of the way Exim is supposed to be. Best efforts
33878 have been made to try to ensure that the code agrees with the theory, but an
33879 absence of bugs can never be guaranteed. Any that are reported will get fixed
33880 as soon as possible.
33881
33882
33883 .section "Building a more &""hardened""& Exim" "SECID286"
33884 .cindex "security" "build-time features"
33885 There are a number of build-time options that can be set in &_Local/Makefile_&
33886 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
33887 Exim administrator who does not have the root password, or by someone who has
33888 penetrated the Exim (but not the root) account. These options are as follows:
33889
33890 .ilist
33891 ALT_CONFIG_PREFIX can be set to a string that is required to match the
33892 start of any file names used with the &%-C%& option. When it is set, these file
33893 names are also not allowed to contain the sequence &"/../"&. (However, if the
33894 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
33895 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
33896 default setting for &%ALT_CONFIG_PREFIX%&.
33897
33898 If the permitted configuration files are confined to a directory to
33899 which only root has access, this guards against someone who has broken
33900 into the Exim account from running a privileged Exim with an arbitrary
33901 configuration file, and using it to break into other accounts.
33902 .next
33903 .new
33904 If a non-trusted configuration file (i.e. not the default configuration file
33905 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
33906 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
33907 the next item), then root privilege is retained only if the caller of Exim is
33908 root. This locks out the possibility of testing a configuration using &%-C%&
33909 right through message reception and delivery, even if the caller is root. The
33910 reception works, but by that time, Exim is running as the Exim user, so when
33911 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
33912 privilege to be lost. However, root can test reception and delivery using two
33913 separate commands.
33914 .wen
33915 .next
33916 The WHITELIST_D_MACROS build option declares some macros to be safe to override
33917 with &%-D%& if the real uid is one of root, the Exim run-time user or the
33918 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
33919 requiring the run-time value supplied to &%-D%& to match a regex that errs on
33920 the restrictive side.  Requiring build-time selection of safe macros is onerous
33921 but this option is intended solely as a transition mechanism to permit
33922 previously-working configurations to continue to work after release 4.73.
33923 .next
33924 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
33925 is disabled.
33926 .next
33927 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
33928 never to be used for any deliveries. This is like the &%never_users%& runtime
33929 option, but it cannot be overridden; the runtime option adds additional users
33930 to the list. The default setting is &"root"&; this prevents a non-root user who
33931 is permitted to modify the runtime file from using Exim as a way to get root.
33932 .endlist
33933
33934
33935
33936
33937 .section "Root privilege" "SECID270"
33938 .cindex "setuid"
33939 .cindex "root privilege"
33940 The Exim binary is normally setuid to root, which means that it gains root
33941 privilege (runs as root) when it starts execution. In some special cases (for
33942 example, when the daemon is not in use and there are no local deliveries), it
33943 may be possible to run Exim setuid to some user other than root. This is
33944 discussed in the next section. However, in most installations, root privilege
33945 is required for two things:
33946
33947 .ilist
33948 To set up a socket connected to the standard SMTP port (25) when initialising
33949 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
33950 not required.
33951 .next
33952 To be able to change uid and gid in order to read users' &_.forward_& files and
33953 perform local deliveries as the receiving user or as specified in the
33954 configuration.
33955 .endlist
33956
33957 It is not necessary to be root to do any of the other things Exim does, such as
33958 receiving messages and delivering them externally over SMTP, and it is
33959 obviously more secure if Exim does not run as root except when necessary.
33960 For this reason, a user and group for Exim to use must be defined in
33961 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
33962 group"&. Their values can be changed by the run time configuration, though this
33963 is not recommended. Often a user called &'exim'& is used, but some sites use
33964 &'mail'& or another user name altogether.
33965
33966 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
33967 abdication; the process cannot regain root afterwards. Prior to release 4.00,
33968 &[seteuid()]& was used in some circumstances, but this is no longer the case.
33969
33970 After a new Exim process has interpreted its command line options, it changes
33971 uid and gid in the following cases:
33972
33973 .ilist
33974 .oindex "&%-C%&"
33975 .oindex "&%-D%&"
33976 If the &%-C%& option is used to specify an alternate configuration file, or if
33977 the &%-D%& option is used to define macro values for the configuration, and the
33978 calling process is not running as root, the uid and gid are changed to those of
33979 the calling process.
33980 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
33981 option may not be used at all.
33982 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
33983 can be supplied if the calling process is running as root, the Exim run-time
33984 user or CONFIGURE_OWNER, if defined.
33985 .next
33986 .oindex "&%-be%&"
33987 .oindex "&%-bf%&"
33988 .oindex "&%-bF%&"
33989 If the expansion test option (&%-be%&) or one of the filter testing options
33990 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
33991 calling process.
33992 .next
33993 If the process is not a daemon process or a queue runner process or a delivery
33994 process or a process for testing address routing (started with &%-bt%&), the
33995 uid and gid are changed to the Exim user and group. This means that Exim always
33996 runs under its own uid and gid when receiving messages. This also applies when
33997 testing address verification
33998 .oindex "&%-bv%&"
33999 .oindex "&%-bh%&"
34000 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
34001 option).
34002 .next
34003 For a daemon, queue runner, delivery, or address testing process, the uid
34004 remains as root at this stage, but the gid is changed to the Exim group.
34005 .endlist
34006
34007 The processes that initially retain root privilege behave as follows:
34008
34009 .ilist
34010 A daemon process changes the gid to the Exim group and the uid to the Exim
34011 user after setting up one or more listening sockets. The &[initgroups()]&
34012 function is called, so that if the Exim user is in any additional groups, they
34013 will be used during message reception.
34014 .next
34015 A queue runner process retains root privilege throughout its execution. Its
34016 job is to fork a controlled sequence of delivery processes.
34017 .next
34018 A delivery process retains root privilege throughout most of its execution,
34019 but any actual deliveries (that is, the transports themselves) are run in
34020 subprocesses which always change to a non-root uid and gid. For local
34021 deliveries this is typically the uid and gid of the owner of the mailbox; for
34022 remote deliveries, the Exim uid and gid are used. Once all the delivery
34023 subprocesses have been run, a delivery process changes to the Exim uid and gid
34024 while doing post-delivery tidying up such as updating the retry database and
34025 generating bounce and warning messages.
34026
34027 While the recipient addresses in a message are being routed, the delivery
34028 process runs as root. However, if a user's filter file has to be processed,
34029 this is done in a subprocess that runs under the individual user's uid and
34030 gid. A system filter is run as root unless &%system_filter_user%& is set.
34031 .next
34032 A process that is testing addresses (the &%-bt%& option) runs as root so that
34033 the routing is done in the same environment as a message delivery.
34034 .endlist
34035
34036
34037
34038
34039 .section "Running Exim without privilege" "SECTrunexiwitpri"
34040 .cindex "privilege, running without"
34041 .cindex "unprivileged running"
34042 .cindex "root privilege" "running without"
34043 Some installations like to run Exim in an unprivileged state for more of its
34044 operation, for added security. Support for this mode of operation is provided
34045 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
34046 gid are changed to the Exim user and group at the start of a delivery process
34047 (and also queue runner and address testing processes). This means that address
34048 routing is no longer run as root, and the deliveries themselves cannot change
34049 to any other uid.
34050
34051 .cindex SIGHUP
34052 .cindex "daemon" "restarting"
34053 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
34054 that the daemon can still be started in the usual way, and it can respond
34055 correctly to SIGHUP because the re-invocation regains root privilege.
34056
34057 An alternative approach is to make Exim setuid to the Exim user and also setgid
34058 to the Exim group. If you do this, the daemon must be started from a root
34059 process. (Calling Exim from a root process makes it behave in the way it does
34060 when it is setuid root.) However, the daemon cannot restart itself after a
34061 SIGHUP signal because it cannot regain privilege.
34062
34063 It is still useful to set &%deliver_drop_privilege%& in this case, because it
34064 stops Exim from trying to re-invoke itself to do a delivery after a message has
34065 been received. Such a re-invocation is a waste of resources because it has no
34066 effect.
34067
34068 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
34069 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
34070 to the Exim user seems a clean approach, but there is one complication:
34071
34072 In this style of operation, Exim is running with the real uid and gid set to
34073 those of the calling process, and the effective uid/gid set to Exim's values.
34074 Ideally, any association with the calling process' uid/gid should be dropped,
34075 that is, the real uid/gid should be reset to the effective values so as to
34076 discard any privileges that the caller may have. While some operating systems
34077 have a function that permits this action for a non-root effective uid, quite a
34078 number of them do not. Because of this lack of standardization, Exim does not
34079 address this problem at this time.
34080
34081 For this reason, the recommended approach for &"mostly unprivileged"& running
34082 is to keep the Exim binary setuid to root, and to set
34083 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
34084 be used in the most straightforward way.
34085
34086 If you configure Exim not to run delivery processes as root, there are a
34087 number of restrictions on what you can do:
34088
34089 .ilist
34090 You can deliver only as the Exim user/group. You should  explicitly use the
34091 &%user%& and &%group%& options to override routers or local transports that
34092 normally deliver as the recipient. This makes sure that configurations that
34093 work in this mode function the same way in normal mode. Any implicit or
34094 explicit specification of another user causes an error.
34095 .next
34096 Use of &_.forward_& files is severely restricted, such that it is usually
34097 not worthwhile to include them in the configuration.
34098 .next
34099 Users who wish to use &_.forward_& would have to make their home directory and
34100 the file itself accessible to the Exim user. Pipe and append-to-file entries,
34101 and their equivalents in Exim filters, cannot be used. While they could be
34102 enabled in the Exim user's name, that would be insecure and not very useful.
34103 .next
34104 Unless the local user mailboxes are all owned by the Exim user (possible in
34105 some POP3 or IMAP-only environments):
34106
34107 .olist
34108 They must be owned by the Exim group and be writeable by that group. This
34109 implies you must set &%mode%& in the appendfile configuration, as well as the
34110 mode of the mailbox files themselves.
34111 .next
34112 You must set &%no_check_owner%&, since most or all of the files will not be
34113 owned by the Exim user.
34114 .next
34115 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
34116 on a newly created mailbox when unprivileged. This also implies that new
34117 mailboxes need to be created manually.
34118 .endlist olist
34119 .endlist ilist
34120
34121
34122 These restrictions severely restrict what can be done in local deliveries.
34123 However, there are no restrictions on remote deliveries. If you are running a
34124 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
34125 gives more security at essentially no cost.
34126
34127 If you are using the &%mua_wrapper%& facility (see chapter
34128 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
34129
34130
34131
34132
34133 .section "Delivering to local files" "SECID271"
34134 Full details of the checks applied by &(appendfile)& before it writes to a file
34135 are given in chapter &<<CHAPappendfile>>&.
34136
34137
34138
34139 .section "IPv4 source routing" "SECID272"
34140 .cindex "source routing" "in IP packets"
34141 .cindex "IP source routing"
34142 Many operating systems suppress IP source-routed packets in the kernel, but
34143 some cannot be made to do this, so Exim does its own check. It logs incoming
34144 IPv4 source-routed TCP calls, and then drops them. Things are all different in
34145 IPv6. No special checking is currently done.
34146
34147
34148
34149 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
34150 Support for these SMTP commands is disabled by default. If required, they can
34151 be enabled by defining suitable ACLs.
34152
34153
34154
34155
34156 .section "Privileged users" "SECID274"
34157 .cindex "trusted users"
34158 .cindex "admin user"
34159 .cindex "privileged user"
34160 .cindex "user" "trusted"
34161 .cindex "user" "admin"
34162 Exim recognizes two sets of users with special privileges. Trusted users are
34163 able to submit new messages to Exim locally, but supply their own sender
34164 addresses and information about a sending host. For other users submitting
34165 local messages, Exim sets up the sender address from the uid, and doesn't
34166 permit a remote host to be specified.
34167
34168 .oindex "&%-f%&"
34169 However, an untrusted user is permitted to use the &%-f%& command line option
34170 in the special form &%-f <>%& to indicate that a delivery failure for the
34171 message should not cause an error report. This affects the message's envelope,
34172 but it does not affect the &'Sender:'& header. Untrusted users may also be
34173 permitted to use specific forms of address with the &%-f%& option by setting
34174 the &%untrusted_set_sender%& option.
34175
34176 Trusted users are used to run processes that receive mail messages from some
34177 other mail domain and pass them on to Exim for delivery either locally, or over
34178 the Internet. Exim trusts a caller that is running as root, as the Exim user,
34179 as any user listed in the &%trusted_users%& configuration option, or under any
34180 group listed in the &%trusted_groups%& option.
34181
34182 Admin users are permitted to do things to the messages on Exim's queue. They
34183 can freeze or thaw messages, cause them to be returned to their senders, remove
34184 them entirely, or modify them in various ways. In addition, admin users can run
34185 the Exim monitor and see all the information it is capable of providing, which
34186 includes the contents of files on the spool.
34187
34188 .oindex "&%-M%&"
34189 .oindex "&%-q%&"
34190 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
34191 delivery of messages on its queue is restricted to admin users. This
34192 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
34193 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
34194 queue is also restricted to admin users. This restriction can be relaxed by
34195 setting &%no_queue_list_requires_admin%&.
34196
34197 Exim recognizes an admin user if the calling process is running as root or as
34198 the Exim user or if any of the groups associated with the calling process is
34199 the Exim group. It is not necessary actually to be running under the Exim
34200 group. However, if admin users who are not root or the Exim user are to access
34201 the contents of files on the spool via the Exim monitor (which runs
34202 unprivileged), Exim must be built to allow group read access to its spool
34203 files.
34204
34205
34206
34207 .section "Spool files" "SECID275"
34208 .cindex "spool directory" "files"
34209 Exim's spool directory and everything it contains is owned by the Exim user and
34210 set to the Exim group. The mode for spool files is defined in the
34211 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
34212 any user who is a member of the Exim group can access these files.
34213
34214
34215
34216 .section "Use of argv[0]" "SECID276"
34217 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
34218 of specific strings, Exim assumes certain options. For example, calling Exim
34219 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
34220 to calling it with the option &%-bS%&. There are no security implications in
34221 this.
34222
34223
34224
34225 .section "Use of %f formatting" "SECID277"
34226 The only use made of &"%f"& by Exim is in formatting load average values. These
34227 are actually stored in integer variables as 1000 times the load average.
34228 Consequently, their range is limited and so therefore is the length of the
34229 converted output.
34230
34231
34232
34233 .section "Embedded Exim path" "SECID278"
34234 Exim uses its own path name, which is embedded in the code, only when it needs
34235 to re-exec in order to regain root privilege. Therefore, it is not root when it
34236 does so. If some bug allowed the path to get overwritten, it would lead to an
34237 arbitrary program's being run as exim, not as root.
34238
34239
34240
34241 .section "Dynamic module directory" "SECTdynmoddir"
34242 Any dynamically loadable modules must be installed into the directory
34243 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
34244 loading it.
34245
34246
34247
34248 .section "Use of sprintf()" "SECID279"
34249 .cindex "&[sprintf()]&"
34250 A large number of occurrences of &"sprintf"& in the code are actually calls to
34251 &'string_sprintf()'&, a function that returns the result in malloc'd store.
34252 The intermediate formatting is done into a large fixed buffer by a function
34253 that runs through the format string itself, and checks the length of each
34254 conversion before performing it, thus preventing buffer overruns.
34255
34256 The remaining uses of &[sprintf()]& happen in controlled circumstances where
34257 the output buffer is known to be sufficiently long to contain the converted
34258 string.
34259
34260
34261
34262 .section "Use of debug_printf() and log_write()" "SECID280"
34263 Arbitrary strings are passed to both these functions, but they do their
34264 formatting by calling the function &'string_vformat()'&, which runs through
34265 the format string itself, and checks the length of each conversion.
34266
34267
34268
34269 .section "Use of strcat() and strcpy()" "SECID281"
34270 These are used only in cases where the output buffer is known to be large
34271 enough to hold the result.
34272 .ecindex IIDsecurcon
34273
34274
34275
34276
34277 . ////////////////////////////////////////////////////////////////////////////
34278 . ////////////////////////////////////////////////////////////////////////////
34279
34280 .chapter "Format of spool files" "CHAPspool"
34281 .scindex IIDforspo1 "format" "spool files"
34282 .scindex IIDforspo2 "spool directory" "format of files"
34283 .scindex IIDforspo3 "spool files" "format of"
34284 .cindex "spool files" "editing"
34285 A message on Exim's queue consists of two files, whose names are the message id
34286 followed by -D and -H, respectively. The data portion of the message is kept in
34287 the -D file on its own. The message's envelope, status, and headers are all
34288 kept in the -H file, whose format is described in this chapter. Each of these
34289 two files contains the final component of its own name as its first line. This
34290 is insurance against disk crashes where the directory is lost but the files
34291 themselves are recoverable.
34292
34293 Some people are tempted into editing -D files in order to modify messages. You
34294 need to be extremely careful if you do this; it is not recommended and you are
34295 on your own if you do it. Here are some of the pitfalls:
34296
34297 .ilist
34298 You must ensure that Exim does not try to deliver the message while you are
34299 fiddling with it. The safest way is to take out a write lock on the -D file,
34300 which is what Exim itself does, using &[fcntl()]&. If you update the file in
34301 place, the lock will be retained. If you write a new file and rename it, the
34302 lock will be lost at the instant of rename.
34303 .next
34304 .vindex "&$body_linecount$&"
34305 If you change the number of lines in the file, the value of
34306 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
34307 present, this value is not used by Exim, but there is no guarantee that this
34308 will always be the case.
34309 .next
34310 If the message is in MIME format, you must take care not to break it.
34311 .next
34312 If the message is cryptographically signed, any change will invalidate the
34313 signature.
34314 .endlist
34315 All in all, modifying -D files is fraught with danger.
34316
34317 Files whose names end with -J may also be seen in the &_input_& directory (or
34318 its subdirectories when &%split_spool_directory%& is set). These are journal
34319 files, used to record addresses to which the message has been delivered during
34320 the course of a delivery attempt. If there are still undelivered recipients at
34321 the end, the -H file is updated, and the -J file is deleted. If, however, there
34322 is some kind of crash (for example, a power outage) before this happens, the -J
34323 file remains in existence. When Exim next processes the message, it notices the
34324 -J file and uses it to update the -H file before starting the next delivery
34325 attempt.
34326
34327 .section "Format of the -H file" "SECID282"
34328 .cindex "uid (user id)" "in spool file"
34329 .cindex "gid (group id)" "in spool file"
34330 The second line of the -H file contains the login name for the uid of the
34331 process that called Exim to read the message, followed by the numerical uid and
34332 gid. For a locally generated message, this is normally the user who sent the
34333 message. For a message received over TCP/IP via the daemon, it is
34334 normally the Exim user.
34335
34336 The third line of the file contains the address of the message's sender as
34337 transmitted in the envelope, contained in angle brackets. The sender address is
34338 empty for bounce messages. For incoming SMTP mail, the sender address is given
34339 in the MAIL command. For locally generated mail, the sender address is
34340 created by Exim from the login name of the current user and the configured
34341 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
34342 leading &"From&~"& line if the caller is trusted, or if the supplied address is
34343 &"<>"& or an address that matches &%untrusted_set_senders%&.
34344
34345 The fourth line contains two numbers. The first is the time that the message
34346 was received, in the conventional Unix form &-- the number of seconds since the
34347 start of the epoch. The second number is a count of the number of messages
34348 warning of delayed delivery that have been sent to the sender.
34349
34350 There follow a number of lines starting with a hyphen. These can appear in any
34351 order, and are omitted when not relevant:
34352
34353 .vlist
34354 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
34355 This item is obsolete, and is not generated from Exim release 4.61 onwards;
34356 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
34357 recognized, to provide backward compatibility. In the old format, a line of
34358 this form is present for every ACL variable that is not empty. The number
34359 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
34360 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
34361 the data string for the variable. The string itself starts at the beginning of
34362 the next line, and is followed by a newline character. It may contain internal
34363 newlines.
34364
34365 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
34366 A line of this form is present for every ACL connection variable that is
34367 defined. Note that there is a space between &%-aclc%& and the rest of the name.
34368 The length is the length of the data string for the variable. The string itself
34369 starts at the beginning of the next line, and is followed by a newline
34370 character. It may contain internal newlines.
34371
34372 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
34373 A line of this form is present for every ACL message variable that is defined.
34374 Note that there is a space between &%-aclm%& and the rest of the name. The
34375 length is the length of the data string for the variable. The string itself
34376 starts at the beginning of the next line, and is followed by a newline
34377 character. It may contain internal newlines.
34378
34379 .vitem "&%-active_hostname%&&~<&'hostname'&>"
34380 This is present if, when the message was received over SMTP, the value of
34381 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
34382
34383 .vitem &%-allow_unqualified_recipient%&
34384 This is present if unqualified recipient addresses are permitted in header
34385 lines (to stop such addresses from being qualified if rewriting occurs at
34386 transport time). Local messages that were input using &%-bnq%& and remote
34387 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
34388
34389 .vitem &%-allow_unqualified_sender%&
34390 This is present if unqualified sender addresses are permitted in header lines
34391 (to stop such addresses from being qualified if rewriting occurs at transport
34392 time). Local messages that were input using &%-bnq%& and remote messages from
34393 hosts that match &%sender_unqualified_hosts%& set this flag.
34394
34395 .vitem "&%-auth_id%&&~<&'text'&>"
34396 The id information for a message received on an authenticated SMTP connection
34397 &-- the value of the &$authenticated_id$& variable.
34398
34399 .vitem "&%-auth_sender%&&~<&'address'&>"
34400 The address of an authenticated sender &-- the value of the
34401 &$authenticated_sender$& variable.
34402
34403 .vitem "&%-body_linecount%&&~<&'number'&>"
34404 This records the number of lines in the body of the message, and is always
34405 present.
34406
34407 .vitem "&%-body_zerocount%&&~<&'number'&>"
34408 This records the number of binary zero bytes in the body of the message, and is
34409 present if the number is greater than zero.
34410
34411 .vitem &%-deliver_firsttime%&
34412 This is written when a new message is first added to the spool. When the spool
34413 file is updated after a deferral, it is omitted.
34414
34415 .vitem "&%-frozen%&&~<&'time'&>"
34416 .cindex "frozen messages" "spool data"
34417 The message is frozen, and the freezing happened at <&'time'&>.
34418
34419 .vitem "&%-helo_name%&&~<&'text'&>"
34420 This records the host name as specified by a remote host in a HELO or EHLO
34421 command.
34422
34423 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
34424 This records the IP address of the host from which the message was received and
34425 the remote port number that was used. It is omitted for locally generated
34426 messages.
34427
34428 .vitem "&%-host_auth%&&~<&'text'&>"
34429 If the message was received on an authenticated SMTP connection, this records
34430 the name of the authenticator &-- the value of the
34431 &$sender_host_authenticated$& variable.
34432
34433 .vitem &%-host_lookup_failed%&
34434 This is present if an attempt to look up the sending host's name from its IP
34435 address failed. It corresponds to the &$host_lookup_failed$& variable.
34436
34437 .vitem "&%-host_name%&&~<&'text'&>"
34438 .cindex "reverse DNS lookup"
34439 .cindex "DNS" "reverse lookup"
34440 This records the name of the remote host from which the message was received,
34441 if the host name was looked up from the IP address when the message was being
34442 received. It is not present if no reverse lookup was done.
34443
34444 .vitem "&%-ident%&&~<&'text'&>"
34445 For locally submitted messages, this records the login of the originating user,
34446 unless it was a trusted user and the &%-oMt%& option was used to specify an
34447 ident value. For messages received over TCP/IP, this records the ident string
34448 supplied by the remote host, if any.
34449
34450 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
34451 This records the IP address of the local interface and the port number through
34452 which a message was received from a remote host. It is omitted for locally
34453 generated messages.
34454
34455 .vitem &%-local%&
34456 The message is from a local sender.
34457
34458 .vitem &%-localerror%&
34459 The message is a locally-generated bounce message.
34460
34461 .vitem "&%-local_scan%&&~<&'string'&>"
34462 This records the data string that was returned by the &[local_scan()]& function
34463 when the message was received &-- the value of the &$local_scan_data$&
34464 variable. It is omitted if no data was returned.
34465
34466 .vitem &%-manual_thaw%&
34467 The message was frozen but has been thawed manually, that is, by an explicit
34468 Exim command rather than via the auto-thaw process.
34469
34470 .vitem &%-N%&
34471 A testing delivery process was started using the &%-N%& option to suppress any
34472 actual deliveries, but delivery was deferred. At any further delivery attempts,
34473 &%-N%& is assumed.
34474
34475 .vitem &%-received_protocol%&
34476 This records the value of the &$received_protocol$& variable, which contains
34477 the name of the protocol by which the message was received.
34478
34479 .vitem &%-sender_set_untrusted%&
34480 The envelope sender of this message was set by an untrusted local caller (used
34481 to ensure that the caller is displayed in queue listings).
34482
34483 .vitem "&%-spam_score_int%&&~<&'number'&>"
34484 If a message was scanned by SpamAssassin, this is present. It records the value
34485 of &$spam_score_int$&.
34486
34487 .vitem &%-tls_certificate_verified%&
34488 A TLS certificate was received from the client that sent this message, and the
34489 certificate was verified by the server.
34490
34491 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
34492 When the message was received over an encrypted connection, this records the
34493 name of the cipher suite that was used.
34494
34495 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
34496 When the message was received over an encrypted connection, and a certificate
34497 was received from the client, this records the Distinguished Name from that
34498 certificate.
34499 .endlist
34500
34501 Following the options there is a list of those addresses to which the message
34502 is not to be delivered. This set of addresses is initialized from the command
34503 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
34504 is set; otherwise it starts out empty. Whenever a successful delivery is made,
34505 the address is added to this set. The addresses are kept internally as a
34506 balanced binary tree, and it is a representation of that tree which is written
34507 to the spool file. If an address is expanded via an alias or forward file, the
34508 original address is added to the tree when deliveries to all its child
34509 addresses are complete.
34510
34511 If the tree is empty, there is a single line in the spool file containing just
34512 the text &"XX"&. Otherwise, each line consists of two letters, which are either
34513 Y or N, followed by an address. The address is the value for the node of the
34514 tree, and the letters indicate whether the node has a left branch and/or a
34515 right branch attached to it, respectively. If branches exist, they immediately
34516 follow. Here is an example of a three-node tree:
34517 .code
34518 YY darcy@austen.fict.example
34519 NN alice@wonderland.fict.example
34520 NN editor@thesaurus.ref.example
34521 .endd
34522 After the non-recipients tree, there is a list of the message's recipients.
34523 This is a simple list, preceded by a count. It includes all the original
34524 recipients of the message, including those to whom the message has already been
34525 delivered. In the simplest case, the list contains one address per line. For
34526 example:
34527 .code
34528 4
34529 editor@thesaurus.ref.example
34530 darcy@austen.fict.example
34531 rdo@foundation
34532 alice@wonderland.fict.example
34533 .endd
34534 However, when a child address has been added to the top-level addresses as a
34535 result of the use of the &%one_time%& option on a &(redirect)& router, each
34536 line is of the following form:
34537 .display
34538 <&'top-level address'&> <&'errors_to address'&> &&&
34539   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
34540 .endd
34541 The 01 flag bit indicates the presence of the three other fields that follow
34542 the top-level address. Other bits may be used in future to support additional
34543 fields. The <&'parent number'&> is the offset in the recipients list of the
34544 original parent of the &"one time"& address. The first two fields are the
34545 envelope sender that is associated with this address and its length. If the
34546 length is zero, there is no special envelope sender (there are then two space
34547 characters in the line). A non-empty field can arise from a &(redirect)& router
34548 that has an &%errors_to%& setting.
34549
34550
34551 A blank line separates the envelope and status information from the headers
34552 which follow. A header may occupy several lines of the file, and to save effort
34553 when reading it in, each header is preceded by a number and an identifying
34554 character. The number is the number of characters in the header, including any
34555 embedded newlines and the terminating newline. The character is one of the
34556 following:
34557
34558 .table2 50pt
34559 .row <&'blank'&>         "header in which Exim has no special interest"
34560 .row &`B`&               "&'Bcc:'& header"
34561 .row &`C`&               "&'Cc:'& header"
34562 .row &`F`&               "&'From:'& header"
34563 .row &`I`&               "&'Message-id:'& header"
34564 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
34565 .row &`R`&               "&'Reply-To:'& header"
34566 .row &`S`&               "&'Sender:'& header"
34567 .row &`T`&               "&'To:'& header"
34568 .row &`*`&               "replaced or deleted header"
34569 .endtable
34570
34571 Deleted or replaced (rewritten) headers remain in the spool file for debugging
34572 purposes. They are not transmitted when the message is delivered. Here is a
34573 typical set of headers:
34574 .code
34575 111P Received: by hobbit.fict.example with local (Exim 4.00)
34576 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
34577 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
34578 038* X-rewrote-sender: bb@hobbit.fict.example
34579 042* From: Bilbo Baggins <bb@hobbit.fict.example>
34580 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
34581 099* To: alice@wonderland.fict.example, rdo@foundation,
34582 darcy@austen.fict.example, editor@thesaurus.ref.example
34583 104T To: alice@wonderland.fict.example, rdo@foundation.example,
34584 darcy@austen.fict.example, editor@thesaurus.ref.example
34585 038  Date: Fri, 11 May 2001 10:28:59 +0100
34586 .endd
34587 The asterisked headers indicate that the envelope sender, &'From:'& header, and
34588 &'To:'& header have been rewritten, the last one because routing expanded the
34589 unqualified domain &'foundation'&.
34590 .ecindex IIDforspo1
34591 .ecindex IIDforspo2
34592 .ecindex IIDforspo3
34593
34594 . ////////////////////////////////////////////////////////////////////////////
34595 . ////////////////////////////////////////////////////////////////////////////
34596
34597 .chapter "Support for DKIM (DomainKeys Identified Mail) - RFC4871" "CHID12" &&&
34598          "DKIM Support"
34599 .cindex "DKIM"
34600
34601 Since version 4.70, DKIM support is compiled into Exim by default. It can be
34602 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
34603
34604 Exim's DKIM implementation allows to
34605 .olist
34606 Sign outgoing messages: This function is implemented in the SMTP transport.
34607 It can co-exist with all other Exim features, including transport filters.
34608 .next
34609 Verify signatures in incoming messages: This is implemented by an additional
34610 ACL (acl_smtp_dkim), which can be called several times per message, with
34611 different signature contexts.
34612 .endlist
34613
34614 In typical Exim style, the verification implementation does not include any
34615 default "policy". Instead it enables you to build your own policy using
34616 Exim's standard controls.
34617
34618 Please note that verification of DKIM signatures in incoming mail is turned
34619 on by default for logging purposes. For each signature in incoming email,
34620 exim will log a line displaying the most important signature details, and the
34621 signature status. Here is an example:
34622 .code
34623 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]
34624 .endd
34625 You might want to turn off DKIM verification processing entirely for internal
34626 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
34627 control modifier. This should typically be done in the RCPT ACL, at points
34628 where you accept mail from relay sources (internal hosts or authenticated
34629 senders).
34630
34631
34632 .section "Signing outgoing messages" "SECID513"
34633 .cindex "DKIM" "signing"
34634
34635 Signing is implemented by setting private options on the SMTP transport.
34636 These options take (expandable) strings as arguments.
34637
34638 .option dkim_domain smtp string&!! unset
34639 MANDATORY:
34640 The domain you want to sign with. The result of this expanded
34641 option is put into the &%$dkim_domain%& expansion variable.
34642
34643 .option dkim_selector smtp string&!! unset
34644 MANDATORY:
34645 This sets the key selector string. You can use the &%$dkim_domain%& expansion
34646 variable to look up a matching selector. The result is put in the expansion
34647 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
34648 option along with &%$dkim_domain%&.
34649
34650 .option dkim_private_key smtp string&!! unset
34651 MANDATORY:
34652 This sets the private key to use. You can use the &%$dkim_domain%& and
34653 &%$dkim_selector%& expansion variables to determine the private key to use.
34654 The result can either
34655 .ilist
34656 be a valid RSA private key in ASCII armor, including line breaks.
34657 .next
34658 start with a slash, in which case it is treated as a file that contains
34659 the private key.
34660 .next
34661 be "0", "false" or the empty string, in which case the message will not
34662 be signed. This case will not result in an error, even if &%dkim_strict%&
34663 is set.
34664 .endlist
34665
34666 .option dkim_canon smtp string&!! unset
34667 OPTIONAL:
34668 This option sets the canonicalization method used when signing a message.
34669 The DKIM RFC currently supports two methods: "simple" and "relaxed".
34670 The option defaults to "relaxed" when unset. Note: the current implementation
34671 only supports using the same canonicalization method for both headers and body.
34672
34673 .option dkim_strict smtp string&!! unset
34674 OPTIONAL:
34675 This  option  defines  how  Exim  behaves  when  signing a message that
34676 should be signed fails for some reason.  When the expansion evaluates to
34677 either "1" or "true", Exim will defer. Otherwise Exim will send the message
34678 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
34679 variables here.
34680
34681 .option dkim_sign_headers smtp string&!! unset
34682 OPTIONAL:
34683 When set, this option must expand to (or be specified as) a colon-separated
34684 list of header names. Headers with these names will be included in the message
34685 signature. When unspecified, the header names recommended in RFC4871 will be
34686 used.
34687
34688
34689 .section "Verifying DKIM signatures in incoming mail" "SECID514"
34690 .cindex "DKIM" "verification"
34691
34692 Verification of DKIM signatures in incoming email is implemented via the
34693 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
34694 syntactically(!) correct signature in the incoming message.
34695
34696 To evaluate the signature in the ACL a large number of expansion variables
34697 containing the signature status and its details are set up during the
34698 runtime of the ACL.
34699
34700 Calling the ACL only for existing signatures is not sufficient to build
34701 more advanced policies. For that reason, the global option
34702 &%dkim_verify_signers%&, and a global expansion variable
34703 &%$dkim_signers%& exist.
34704
34705 The global option &%dkim_verify_signers%& can be set to a colon-separated
34706 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
34707 called. It is expanded when the message has been received. At this point,
34708 the expansion variable &%$dkim_signers%& already contains a colon-separated
34709 list of signer domains and identities for the message. When
34710 &%dkim_verify_signers%& is not specified in the main configuration,
34711 it defaults as:
34712 .code
34713 dkim_verify_signers = $dkim_signers
34714 .endd
34715 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
34716 DKIM signature in the message. Current DKIM verifiers may want to explicitly
34717 call the ACL for known domains or identities. This would be achieved as follows:
34718 .code
34719 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
34720 .endd
34721 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
34722 and "ebay.com", plus all domains and identities that have signatures in the message.
34723 You can also be more creative in constructing your policy. For example:
34724 .code
34725 dkim_verify_signers = $sender_address_domain:$dkim_signers
34726 .endd
34727
34728 If a domain or identity is listed several times in the (expanded) value of
34729 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
34730
34731
34732 Inside the &%acl_smtp_dkim%&, the following expansion variables are
34733 available (from most to least important):
34734
34735 .vlist
34736 .vitem &%$dkim_cur_signer%&
34737 The signer that is being evaluated in this ACL run. This can be a domain or
34738 an identity. This is one of the list items from the expanded main option
34739 &%dkim_verify_signers%& (see above).
34740 .vitem &%$dkim_verify_status%&
34741 A string describing the general status of the signature. One of
34742 .ilist
34743 &%none%&: There is no signature in the message for the current domain or
34744 identity (as reflected by &%$dkim_cur_signer%&).
34745 .next
34746 &%invalid%&: The signature could not be verified due to a processing error.
34747 More detail is available in &%$dkim_verify_reason%&.
34748 .next
34749 &%fail%&: Verification of the signature failed.  More detail is
34750 available in &%$dkim_verify_reason%&.
34751 .next
34752 &%pass%&: The signature passed verification. It is valid.
34753 .endlist
34754 .vitem &%$dkim_verify_reason%&
34755 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
34756 "fail" or "invalid". One of
34757 .ilist
34758 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
34759 key for the domain could not be retrieved. This may be a temporary problem.
34760 .next
34761 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
34762 record for the domain is syntactically invalid.
34763 .next
34764 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
34765 body hash does not match the one specified in the signature header. This
34766 means that the message body was modified in transit.
34767 .next
34768 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
34769 could not be verified. This may mean that headers were modified,
34770 re-written or otherwise changed in a way which is incompatible with
34771 DKIM verification. It may of course also mean that the signature is forged.
34772 .endlist
34773 .vitem &%$dkim_domain%&
34774 The signing domain. IMPORTANT: This variable is only populated if there is
34775 an actual signature in the message for the current domain or identity (as
34776 reflected by &%$dkim_cur_signer%&).
34777 .vitem &%$dkim_identity%&
34778 The signing identity, if present. IMPORTANT: This variable is only populated
34779 if there is an actual signature in the message for the current domain or
34780 identity (as reflected by &%$dkim_cur_signer%&).
34781 .vitem &%$dkim_selector%&
34782 The key record selector string.
34783 .vitem &%$dkim_algo%&
34784 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
34785 .vitem &%$dkim_canon_body%&
34786 The body canonicalization method. One of 'relaxed' or 'simple'.
34787 .vitem &%dkim_canon_headers%&
34788 The header canonicalization method. One of 'relaxed' or 'simple'.
34789 .vitem &%$dkim_copiedheaders%&
34790 A transcript of headers and their values which are included in the signature
34791 (copied from the 'z=' tag of the signature).
34792 .vitem &%$dkim_bodylength%&
34793 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
34794 limit was set by the signer, "9999999999999" is returned. This makes sure
34795 that this variable always expands to an integer value.
34796 .vitem &%$dkim_created%&
34797 UNIX timestamp reflecting the date and time when the signature was created.
34798 When this was not specified by the signer, "0" is returned.
34799 .vitem &%$dkim_expires%&
34800 UNIX timestamp reflecting the date and time when the signer wants the
34801 signature to be treated as "expired". When this was not specified by the
34802 signer, "9999999999999" is returned. This makes it possible to do useful
34803 integer size comparisons against this value.
34804 .vitem &%$dkim_headernames%&
34805 A colon-separated list of names of headers included in the signature.
34806 .vitem &%$dkim_key_testing%&
34807 "1" if the key record has the "testing" flag set, "0" if not.
34808 .vitem &%$dkim_key_nosubdomaining%&
34809 "1" if the key record forbids subdomaining, "0" otherwise.
34810 .vitem &%$dkim_key_srvtype%&
34811 Service type (tag s=) from the key record. Defaults to "*" if not specified
34812 in the key record.
34813 .vitem &%$dkim_key_granularity%&
34814 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
34815 in the key record.
34816 .vitem &%$dkim_key_notes%&
34817 Notes from the key record (tag n=).
34818 .endlist
34819
34820 In addition, two ACL conditions are provided:
34821
34822 .vlist
34823 .vitem &%dkim_signers%&
34824 ACL condition that checks a colon-separated list of domains or identities
34825 for a match against the domain or identity that the ACL is currently verifying
34826 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
34827 verb to a group of domains or identities. For example:
34828
34829 .code
34830 # Warn when message apparently from GMail has no signature at all
34831 warn log_message = GMail sender without DKIM signature
34832      sender_domains = gmail.com
34833      dkim_signers = gmail.com
34834      dkim_status = none
34835 .endd
34836
34837 .vitem &%dkim_status%&
34838 ACL condition that checks a colon-separated list of possible DKIM verification
34839 results agains the actual result of verification. This is typically used
34840 to restrict an ACL verb to a list of verification outcomes, like:
34841
34842 .code
34843 deny message = Message from Paypal with invalid or missing signature
34844      sender_domains = paypal.com:paypal.de
34845      dkim_signers = paypal.com:paypal.de
34846      dkim_status = none:invalid:fail
34847 .endd
34848
34849 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
34850 see the documentation of the &%$dkim_verify_status%& expansion variable above
34851 for more information of what they mean.
34852 .endlist
34853
34854 . ////////////////////////////////////////////////////////////////////////////
34855 . ////////////////////////////////////////////////////////////////////////////
34856
34857 .chapter "Adding new drivers or lookup types" "CHID13" &&&
34858          "Adding drivers or lookups"
34859 .cindex "adding drivers"
34860 .cindex "new drivers, adding"
34861 .cindex "drivers" "adding new"
34862 The following actions have to be taken in order to add a new router, transport,
34863 authenticator, or lookup type to Exim:
34864
34865 .olist
34866 Choose a name for the driver or lookup type that does not conflict with any
34867 existing name; I will use &"newdriver"& in what follows.
34868 .next
34869 Add to &_src/EDITME_& the line:
34870 .display
34871 <&'type'&>&`_NEWDRIVER=yes`&
34872 .endd
34873 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
34874 code is not to be included in the binary by default, comment this line out. You
34875 should also add any relevant comments about the driver or lookup type.
34876 .next
34877 Add to &_src/config.h.defaults_& the line:
34878 .code
34879 #define <type>_NEWDRIVER
34880 .endd
34881 .next
34882 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
34883 and create a table entry as is done for all the other drivers and lookup types.
34884 .next
34885 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
34886 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
34887 driver or lookup type and add it to the definition of OBJ.
34888 .next
34889 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
34890 &_src_&.
34891 .next
34892 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
34893 as for other drivers and lookups.
34894 .endlist
34895
34896 Then all you need to do is write the code! A good way to start is to make a
34897 proforma by copying an existing module of the same type, globally changing all
34898 occurrences of the name, and cutting out most of the code. Note that any
34899 options you create must be listed in alphabetical order, because the tables are
34900 searched using a binary chop procedure.
34901
34902 There is a &_README_& file in each of the sub-directories of &_src_& describing
34903 the interface that is expected.
34904
34905
34906
34907
34908 . ////////////////////////////////////////////////////////////////////////////
34909 . ////////////////////////////////////////////////////////////////////////////
34910
34911 . /////////////////////////////////////////////////////////////////////////////
34912 . These lines are processing instructions for the Simple DocBook Processor that
34913 . Philip Hazel has developed as a less cumbersome way of making PostScript and
34914 . PDFs than using xmlto and fop. They will be ignored by all other XML
34915 . processors.
34916 . /////////////////////////////////////////////////////////////////////////////
34917
34918 .literal xml
34919 <?sdop
34920   format="newpage"
34921   foot_right_recto="&chaptertitle;"
34922   foot_right_verso="&chaptertitle;"
34923 ?>
34924 .literal off
34925
34926 .makeindex "Options index"   "option"
34927 .makeindex "Variables index" "variable"
34928 .makeindex "Concept index"   "concept"
34929
34930
34931 . /////////////////////////////////////////////////////////////////////////////
34932 . /////////////////////////////////////////////////////////////////////////////