Implement freeze_signal on pipe transport.
[users/heiko/exim.git] / doc / doc-docbook / spec.xfpt
1 . $Cambridge: exim/doc/doc-docbook/spec.xfpt,v 1.88 2010/06/14 18:51:09 pdp Exp $
2 .
3 . /////////////////////////////////////////////////////////////////////////////
4 . This is the primary source of the Exim Manual. It is an xfpt document that is
5 . converted into DocBook XML for subsequent conversion into printing and online
6 . formats. The markup used herein is "standard" xfpt markup, with some extras.
7 . The markup is summarized in a file called Markup.txt.
8 .
9 . WARNING: When you use the .new macro, make sure it appears *before* any
10 . adjacent index items; otherwise you get an empty "paragraph" which causes
11 . unwanted vertical space.
12 . /////////////////////////////////////////////////////////////////////////////
13
14 .include stdflags
15 .include stdmacs
16
17 . /////////////////////////////////////////////////////////////////////////////
18 . This outputs the standard DocBook boilerplate.
19 . /////////////////////////////////////////////////////////////////////////////
20
21 .docbook
22
23 . /////////////////////////////////////////////////////////////////////////////
24 . These lines are processing instructions for the Simple DocBook Processor that
25 . Philip Hazel has developed as a less cumbersome way of making PostScript and
26 . PDFs than using xmlto and fop. They will be ignored by all other XML
27 . processors.
28 . /////////////////////////////////////////////////////////////////////////////
29
30 .literal xml
31 <?sdop
32   foot_right_recto="&chaptertitle; (&chapternumber;)"
33   foot_right_verso="&chaptertitle; (&chapternumber;)"
34   toc_chapter_blanks="yes,yes"
35   table_warn_overflow="overprint"
36 ?>
37 .literal off
38
39 . /////////////////////////////////////////////////////////////////////////////
40 . This generate the outermost <book> element that wraps then entire document.
41 . /////////////////////////////////////////////////////////////////////////////
42
43 .book
44
45 . /////////////////////////////////////////////////////////////////////////////
46 . These definitions set some parameters and save some typing. Remember that
47 . the <bookinfo> element must also be updated for each new edition.
48 . /////////////////////////////////////////////////////////////////////////////
49
50 .set previousversion "4.72"
51 .set version "4.74"
52
53 .set ACL "access control lists (ACLs)"
54 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
55
56
57 . /////////////////////////////////////////////////////////////////////////////
58 . Additional xfpt markup used by this document, over and above the default
59 . provided in the xfpt library.
60 . /////////////////////////////////////////////////////////////////////////////
61
62 . --- Override the &$ flag to automatically insert a $ with the variable name
63
64 .flag &$  $&   "<varname>$"  "</varname>"
65
66 . --- Short flags for daggers in option headings. They will always be inside
67 . --- an italic string, but we want the daggers to be roman.
68
69 .flag &!!      "</emphasis>&dagger;<emphasis>"
70 .flag &!?      "</emphasis>&Dagger;<emphasis>"
71
72 . --- A macro for an Exim option definition heading, generating a one-line
73 . --- table with four columns. For cases when the option name is given with
74 . --- a space, so that it can be split, a fifth argument is used for the
75 . --- index entry.
76
77 .macro option
78 .arg 5
79 .oindex "&%$5%&"
80 .endarg
81 .arg -5
82 .oindex "&%$1%&"
83 .endarg
84 .itable all 0 0 4 8* left 6* center 6* center 6* right
85 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
86 .endtable
87 .endmacro
88
89 . --- A macro for the common 2-column tables. The width of the first column
90 . --- is suitable for the many tables at the start of the main options chapter;
91 . --- the small number of other 2-column tables override it.
92
93 .macro table2 196pt 254pt
94 .itable none 0 0 2 $1 left $2 left
95 .endmacro
96
97 . --- A macro that generates .row, but puts &I; at the start of the first
98 . --- argument, thus indenting it. Assume a minimum of two arguments, and
99 . --- allow up to four arguments, which is as many as we'll ever need.
100
101 .macro irow
102 .arg 4
103 .row "&I;$1" "$2" "$3" "$4"
104 .endarg
105 .arg -4
106 .arg 3
107 .row "&I;$1" "$2" "$3"
108 .endarg
109 .arg -3
110 .row "&I;$1" "$2"
111 .endarg
112 .endarg
113 .endmacro
114
115 . --- Macros for option, variable, and concept index entries. For a "range"
116 . --- style of entry, use .scindex for the start and .ecindex for the end. The
117 . --- first argument of .scindex and the only argument of .ecindex must be the
118 . --- ID that ties them together.
119
120 .macro cindex
121 &<indexterm role="concept">&
122 &<primary>&$1&</primary>&
123 .arg 2
124 &<secondary>&$2&</secondary>&
125 .endarg
126 &</indexterm>&
127 .endmacro
128
129 .macro scindex
130 &<indexterm role="concept" id="$1" class="startofrange">&
131 &<primary>&$2&</primary>&
132 .arg 3
133 &<secondary>&$3&</secondary>&
134 .endarg
135 &</indexterm>&
136 .endmacro
137
138 .macro ecindex
139 &<indexterm role="concept" startref="$1" class="endofrange"/>&
140 .endmacro
141
142 .macro oindex
143 &<indexterm role="option">&
144 &<primary>&$1&</primary>&
145 .arg 2
146 &<secondary>&$2&</secondary>&
147 .endarg
148 &</indexterm>&
149 .endmacro
150
151 .macro vindex
152 &<indexterm role="variable">&
153 &<primary>&$1&</primary>&
154 .arg 2
155 &<secondary>&$2&</secondary>&
156 .endarg
157 &</indexterm>&
158 .endmacro
159
160 .macro index
161 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
162 .endmacro
163 . ////////////////////////////////////////////////////////////////////////////
164
165
166 . ////////////////////////////////////////////////////////////////////////////
167 . The <bookinfo> element is removed from the XML before processing for Ascii
168 . output formats.
169 . ////////////////////////////////////////////////////////////////////////////
170
171 .literal xml
172 <bookinfo>
173 <title>Specification of the Exim Mail Transfer Agent</title>
174 <titleabbrev>The Exim MTA</titleabbrev>
175 <date>21 Jan 2011</date>
176 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
177 <authorinitials>EM</authorinitials>
178 <revhistory><revision>
179   <revnumber>4.74</revnumber>
180   <date>21 Jan 2011</date>
181   <authorinitials>EM</authorinitials>
182 </revision></revhistory>
183 <copyright><year>2011</year><holder>University of Cambridge</holder></copyright>
184 </bookinfo>
185 .literal off
186
187
188 . /////////////////////////////////////////////////////////////////////////////
189 . This chunk of literal XML implements index entries of the form "x, see y" and
190 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
191 . at the top level, so we have to put the .chapter directive first.
192 . /////////////////////////////////////////////////////////////////////////////
193
194 .chapter "Introduction" "CHID1"
195 .literal xml
196
197 <indexterm role="variable">
198   <primary>$1, $2, etc.</primary>
199   <see><emphasis>numerical variables</emphasis></see>
200 </indexterm>
201 <indexterm role="concept">
202   <primary>address</primary>
203   <secondary>rewriting</secondary>
204   <see><emphasis>rewriting</emphasis></see>
205 </indexterm>
206 <indexterm role="concept">
207   <primary>Bounce Address Tag Validation</primary>
208   <see><emphasis>BATV</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Client SMTP Authorization</primary>
212   <see><emphasis>CSA</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>CR character</primary>
216   <see><emphasis>carriage return</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CRL</primary>
220   <see><emphasis>certificate revocation list</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>delivery</primary>
224   <secondary>failure report</secondary>
225   <see><emphasis>bounce message</emphasis></see>
226 </indexterm>
227 <indexterm role="concept">
228   <primary>dialup</primary>
229   <see><emphasis>intermittently connected hosts</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>exiscan</primary>
233   <see><emphasis>content scanning</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>failover</primary>
237   <see><emphasis>fallback</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>fallover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>filter</primary>
245   <secondary>Sieve</secondary>
246   <see><emphasis>Sieve filter</emphasis></see>
247 </indexterm>
248 <indexterm role="concept">
249   <primary>ident</primary>
250   <see><emphasis>RFC 1413</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>LF character</primary>
254   <see><emphasis>linefeed</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>maximum</primary>
258   <seealso><emphasis>limit</emphasis></seealso>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>monitor</primary>
262   <see><emphasis>Exim monitor</emphasis></see>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>no_<emphasis>xxx</emphasis></primary>
266   <see>entry for xxx</see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>NUL</primary>
270   <see><emphasis>binary zero</emphasis></see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>passwd file</primary>
274   <see><emphasis>/etc/passwd</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>process id</primary>
278   <see><emphasis>pid</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>RBL</primary>
282   <see><emphasis>DNS list</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>redirection</primary>
286   <see><emphasis>address redirection</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>return path</primary>
290   <seealso><emphasis>envelope sender</emphasis></seealso>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>scanning</primary>
294   <see><emphasis>content scanning</emphasis></see>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>SSL</primary>
298   <see><emphasis>TLS</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>string</primary>
302   <secondary>expansion</secondary>
303   <see><emphasis>expansion</emphasis></see>
304 </indexterm>
305 <indexterm role="concept">
306   <primary>top bit</primary>
307   <see><emphasis>8-bit characters</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>variables</primary>
311   <see><emphasis>expansion, variables</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>zero, binary</primary>
315   <see><emphasis>binary zero</emphasis></see>
316 </indexterm>
317
318 .literal off
319
320
321 . /////////////////////////////////////////////////////////////////////////////
322 . This is the real start of the first chapter. See the comment above as to why
323 . we can't have the .chapter line here.
324 . chapter "Introduction"
325 . /////////////////////////////////////////////////////////////////////////////
326
327 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
328 Unix-like operating systems. It was designed on the assumption that it would be
329 run on hosts that are permanently connected to the Internet. However, it can be
330 used on intermittently connected hosts with suitable configuration adjustments.
331
332 Configuration files currently exist for the following operating systems: AIX,
333 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
334 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
335 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
336 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
337 Some of these operating systems are no longer current and cannot easily be
338 tested, so the configuration files may no longer work in practice.
339
340 There are also configuration files for compiling Exim in the Cygwin environment
341 that can be installed on systems running Windows. However, this document does
342 not contain any information about running Exim in the Cygwin environment.
343
344 The terms and conditions for the use and distribution of Exim are contained in
345 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
346 Public Licence, a copy of which may be found in the file &_LICENCE_&.
347
348 The use, supply or promotion of Exim for the purpose of sending bulk,
349 unsolicited electronic mail is incompatible with the basic aims of the program,
350 which revolve around the free provision of a service that enhances the quality
351 of personal communications. The author of Exim regards indiscriminate
352 mass-mailing as an antisocial, irresponsible abuse of the Internet.
353
354 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
355 experience of running and working on the Smail 3 code, I could never have
356 contemplated starting to write a new MTA. Many of the ideas and user interfaces
357 were originally taken from Smail 3, though the actual code of Exim is entirely
358 new, and has developed far beyond the initial concept.
359
360 Many people, both in Cambridge and around the world, have contributed to the
361 development and the testing of Exim, and to porting it to various operating
362 systems. I am grateful to them all. The distribution now contains a file called
363 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
364 contributors.
365
366
367 .section "Exim documentation" "SECID1"
368 . Keep this example change bar when updating the documentation!
369
370 .new
371 .cindex "documentation"
372 This edition of the Exim specification applies to version &version; of Exim.
373 Substantive changes from the &previousversion; edition are marked in some
374 renditions of the document; this paragraph is so marked if the rendition is
375 capable of showing a change indicator.
376 .wen
377
378 This document is very much a reference manual; it is not a tutorial. The reader
379 is expected to have some familiarity with the SMTP mail transfer protocol and
380 with general Unix system administration. Although there are some discussions
381 and examples in places, the information is mostly organized in a way that makes
382 it easy to look up, rather than in a natural order for sequential reading.
383 Furthermore, the manual aims to cover every aspect of Exim in detail, including
384 a number of rarely-used, special-purpose features that are unlikely to be of
385 very wide interest.
386
387 .cindex "books about Exim"
388 An &"easier"& discussion of Exim which provides more in-depth explanatory,
389 introductory, and tutorial material can be found in a book entitled &'The Exim
390 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
391 (&url(http://www.uit.co.uk/exim-book/)).
392
393 This book also contains a chapter that gives a general introduction to SMTP and
394 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
395 with the latest release of Exim. (Note that the earlier book about Exim,
396 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
397
398 .cindex "Debian" "information sources"
399 If you are using a Debian distribution of Exim, you will find information about
400 Debian-specific features in the file
401 &_/usr/share/doc/exim4-base/README.Debian_&.
402 The command &(man update-exim.conf)& is another source of Debian-specific
403 information.
404
405 .cindex "&_doc/NewStuff_&"
406 .cindex "&_doc/ChangeLog_&"
407 .cindex "change log"
408 As the program develops, there may be features in newer versions that have not
409 yet made it into this document, which is updated only when the most significant
410 digit of the fractional part of the version number changes. Specifications of
411 new features that are not yet in this manual are placed in the file
412 &_doc/NewStuff_& in the Exim distribution.
413
414 Some features may be classified as &"experimental"&. These may change
415 incompatibly while they are developing, or even be withdrawn. For this reason,
416 they are not documented in this manual. Information about experimental features
417 can be found in the file &_doc/experimental.txt_&.
418
419 All changes to the program (whether new features, bug fixes, or other kinds of
420 change) are noted briefly in the file called &_doc/ChangeLog_&.
421
422 .cindex "&_doc/spec.txt_&"
423 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
424 that it can easily be searched with a text editor. Other files in the &_doc_&
425 directory are:
426
427 .table2 100pt
428 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
429 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
430 .row &_exim.8_&              "a man page of Exim's command line options"
431 .row &_experimental.txt_&    "documentation of experimental features"
432 .row &_filter.txt_&          "specification of the filter language"
433 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
434 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
435 .endtable
436
437 The main specification and the specification of the filtering language are also
438 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
439 &<<SECTavail>>& below tells you how to get hold of these.
440
441
442
443 .section "FTP and web sites" "SECID2"
444 .cindex "web site"
445 .cindex "FTP site"
446 The primary site for Exim source distributions is currently the University of
447 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
448 distribution'& below. In addition, there is a web site and an FTP site at
449 &%exim.org%&. These are now also hosted at the University of Cambridge. The
450 &%exim.org%& site was previously hosted for a number of years by Energis
451 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
452
453 .cindex "wiki"
454 .cindex "FAQ"
455 As well as Exim distribution tar files, the Exim web site contains a number of
456 differently formatted versions of the documentation. A recent addition to the
457 online information is the Exim wiki (&url(http://wiki.exim.org)),
458 which contains what used to be a separate FAQ, as well as various other
459 examples, tips, and know-how that have been contributed by Exim users.
460
461 .cindex Bugzilla
462 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
463 this to report bugs, and also to add items to the wish list. Please search
464 first to check that you are not duplicating a previous entry.
465
466
467
468 .section "Mailing lists" "SECID3"
469 .cindex "mailing lists" "for Exim users"
470 The following Exim mailing lists exist:
471
472 .table2 140pt
473 .row &'exim-users@exim.org'&      "General discussion list"
474 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
475 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
476 .row &'exim-future@exim.org'&     "Discussion of long-term development"
477 .endtable
478
479 You can subscribe to these lists, change your existing subscriptions, and view
480 or search the archives via the mailing lists link on the Exim home page.
481 .cindex "Debian" "mailing list for"
482 If you are using a Debian distribution of Exim, you may wish to subscribe to
483 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
484 via this web page:
485 .display
486 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
487 .endd
488 Please ask Debian-specific questions on this list and not on the general Exim
489 lists.
490
491 .section "Exim training" "SECID4"
492 .cindex "training courses"
493 Training courses in Cambridge (UK) used to be run annually by the author of
494 Exim, before he retired. At the time of writing, there are no plans to run
495 further Exim courses in Cambridge. However, if that changes, relevant
496 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
497
498 .section "Bug reports" "SECID5"
499 .cindex "bug reports"
500 .cindex "reporting bugs"
501 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
502 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
503 whether some behaviour is a bug or not, the best thing to do is to post a
504 message to the &'exim-dev'& mailing list and have it discussed.
505
506
507
508 .section "Where to find the Exim distribution" "SECTavail"
509 .cindex "FTP site"
510 .cindex "distribution" "ftp site"
511 The master ftp site for the Exim distribution is
512 .display
513 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
514 .endd
515 This is mirrored by
516 .display
517 &*ftp://ftp.exim.org/pub/exim*&
518 .endd
519 The file references that follow are relative to the &_exim_& directories at
520 these sites. There are now quite a number of independent mirror sites around
521 the world. Those that I know about are listed in the file called &_Mirrors_&.
522
523 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
524 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
525 distributions), and &_Testing_& for testing versions. In the &_exim4_&
526 subdirectory, the current release can always be found in files called
527 .display
528 &_exim-n.nn.tar.gz_&
529 &_exim-n.nn.tar.bz2_&
530 .endd
531 where &'n.nn'& is the highest such version number in the directory. The two
532 files contain identical data; the only difference is the type of compression.
533 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
534
535 .cindex "distribution" "signing details"
536 .cindex "distribution" "public key"
537 .cindex "public key for signed distribution"
538 The distributions are currently signed with Nigel Metheringham's GPG key. The
539 corresponding public key is available from a number of keyservers, and there is
540 also a copy in the file &_nigel-pubkey.asc_&. The signatures for the tar bundles are
541 in:
542 .display
543 &_exim-n.nn.tar.gz.asc_&
544 &_exim-n.nn.tar.bz2.asc_&
545 .endd
546 For each released version, the log of changes is made separately available in a
547 separate file in the directory &_ChangeLogs_& so that it is possible to
548 find out what has changed without having to download the entire distribution.
549
550 .cindex "documentation" "available formats"
551 The main distribution contains ASCII versions of this specification and other
552 documentation; other formats of the documents are available in separate files
553 inside the &_exim4_& directory of the FTP site:
554 .display
555 &_exim-html-n.nn.tar.gz_&
556 &_exim-pdf-n.nn.tar.gz_&
557 &_exim-postscript-n.nn.tar.gz_&
558 &_exim-texinfo-n.nn.tar.gz_&
559 .endd
560 These tar files contain only the &_doc_& directory, not the complete
561 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
562
563
564 .section "Limitations" "SECID6"
565 .ilist
566 .cindex "limitations of Exim"
567 .cindex "bang paths" "not handled by Exim"
568 Exim is designed for use as an Internet MTA, and therefore handles addresses in
569 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
570 simple two-component bang paths can be converted by a straightforward rewriting
571 configuration. This restriction does not prevent Exim from being interfaced to
572 UUCP as a transport mechanism, provided that domain addresses are used.
573 .next
574 .cindex "domainless addresses"
575 .cindex "address" "without domain"
576 Exim insists that every address it handles has a domain attached. For incoming
577 local messages, domainless addresses are automatically qualified with a
578 configured domain value. Configuration options specify from which remote
579 systems unqualified addresses are acceptable. These are then qualified on
580 arrival.
581 .next
582 .cindex "transport" "external"
583 .cindex "external transports"
584 The only external transport mechanisms that are currently implemented are SMTP
585 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
586 transport is available, and there are facilities for writing messages to files
587 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
588 to send messages to other transport mechanisms such as UUCP, provided they can
589 handle domain-style addresses. Batched SMTP input is also catered for.
590 .next
591 Exim is not designed for storing mail for dial-in hosts. When the volumes of
592 such mail are large, it is better to get the messages &"delivered"& into files
593 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
594 other means.
595 .next
596 Although Exim does have basic facilities for scanning incoming messages, these
597 are not comprehensive enough to do full virus or spam scanning. Such operations
598 are best carried out using additional specialized software packages. If you
599 compile Exim with the content-scanning extension, straightforward interfaces to
600 a number of common scanners are provided.
601 .endlist
602
603
604 .section "Run time configuration" "SECID7"
605 Exim's run time configuration is held in a single text file that is divided
606 into a number of sections. The entries in this file consist of keywords and
607 values, in the style of Smail 3 configuration files. A default configuration
608 file which is suitable for simple online installations is provided in the
609 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
610
611
612 .section "Calling interface" "SECID8"
613 .cindex "Sendmail compatibility" "command line interface"
614 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
615 can be a straight replacement for &_/usr/lib/sendmail_& or
616 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
617 about Sendmail in order to run Exim. For actions other than sending messages,
618 Sendmail-compatible options also exist, but those that produce output (for
619 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
620 format. There are also some additional options that are compatible with Smail
621 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
622 documents all Exim's command line options. This information is automatically
623 made into the man page that forms part of the Exim distribution.
624
625 Control of messages on the queue can be done via certain privileged command
626 line options. There is also an optional monitor program called &'eximon'&,
627 which displays current information in an X window, and which contains a menu
628 interface to Exim's command line administration options.
629
630
631
632 .section "Terminology" "SECID9"
633 .cindex "terminology definitions"
634 .cindex "body of message" "definition of"
635 The &'body'& of a message is the actual data that the sender wants to transmit.
636 It is the last part of a message, and is separated from the &'header'& (see
637 below) by a blank line.
638
639 .cindex "bounce message" "definition of"
640 When a message cannot be delivered, it is normally returned to the sender in a
641 delivery failure message or a &"non-delivery report"& (NDR). The term
642 &'bounce'& is commonly used for this action, and the error reports are often
643 called &'bounce messages'&. This is a convenient shorthand for &"delivery
644 failure error report"&. Such messages have an empty sender address in the
645 message's &'envelope'& (see below) to ensure that they cannot themselves give
646 rise to further bounce messages.
647
648 The term &'default'& appears frequently in this manual. It is used to qualify a
649 value which is used in the absence of any setting in the configuration. It may
650 also qualify an action which is taken unless a configuration setting specifies
651 otherwise.
652
653 The term &'defer'& is used when the delivery of a message to a specific
654 destination cannot immediately take place for some reason (a remote host may be
655 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
656 until a later time.
657
658 The word &'domain'& is sometimes used to mean all but the first component of a
659 host's name. It is &'not'& used in that sense here, where it normally refers to
660 the part of an email address following the @ sign.
661
662 .cindex "envelope, definition of"
663 .cindex "sender" "definition of"
664 A message in transit has an associated &'envelope'&, as well as a header and a
665 body. The envelope contains a sender address (to which bounce messages should
666 be delivered), and any number of recipient addresses. References to the
667 sender or the recipients of a message usually mean the addresses in the
668 envelope. An MTA uses these addresses for delivery, and for returning bounce
669 messages, not the addresses that appear in the header lines.
670
671 .cindex "message" "header, definition of"
672 .cindex "header section" "definition of"
673 The &'header'& of a message is the first part of a message's text, consisting
674 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
675 &'Subject:'&, etc. Long header lines can be split over several text lines by
676 indenting the continuations. The header is separated from the body by a blank
677 line.
678
679 .cindex "local part" "definition of"
680 .cindex "domain" "definition of"
681 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
682 part of an email address that precedes the @ sign. The part that follows the
683 @ sign is called the &'domain'& or &'mail domain'&.
684
685 .cindex "local delivery" "definition of"
686 .cindex "remote delivery, definition of"
687 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
688 delivery to a file or a pipe on the local host from delivery by SMTP over
689 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
690 host it is running on are &'remote'&.
691
692 .cindex "return path" "definition of"
693 &'Return path'& is another name that is used for the sender address in a
694 message's envelope.
695
696 .cindex "queue" "definition of"
697 The term &'queue'& is used to refer to the set of messages awaiting delivery,
698 because this term is in widespread use in the context of MTAs. However, in
699 Exim's case the reality is more like a pool than a queue, because there is
700 normally no ordering of waiting messages.
701
702 .cindex "queue runner" "definition of"
703 The term &'queue runner'& is used to describe a process that scans the queue
704 and attempts to deliver those messages whose retry times have come. This term
705 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
706 the waiting messages are normally processed in an unpredictable order.
707
708 .cindex "spool directory" "definition of"
709 The term &'spool directory'& is used for a directory in which Exim keeps the
710 messages on its queue &-- that is, those that it is in the process of
711 delivering. This should not be confused with the directory in which local
712 mailboxes are stored, which is called a &"spool directory"& by some people. In
713 the Exim documentation, &"spool"& is always used in the first sense.
714
715
716
717
718
719
720 . ////////////////////////////////////////////////////////////////////////////
721 . ////////////////////////////////////////////////////////////////////////////
722
723 .chapter "Incorporated code" "CHID2"
724 .cindex "incorporated code"
725 .cindex "regular expressions" "library"
726 .cindex "PCRE"
727 A number of pieces of external code are included in the Exim distribution.
728
729 .ilist
730 Regular expressions are supported in the main Exim program and in the
731 Exim monitor using the freely-distributable PCRE library, copyright
732 &copy; University of Cambridge. The source to PCRE is no longer shipped with
733 Exim, so you will need to use the version of PCRE shipped with your system,
734 or obtain and install the full version of the library from
735 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
736 .next
737 .cindex "cdb" "acknowledgment"
738 Support for the cdb (Constant DataBase) lookup method is provided by code
739 contributed by Nigel Metheringham of (at the time he contributed it) Planet
740 Online Ltd. The implementation is completely contained within the code of Exim.
741 It does not link against an external cdb library. The code contains the
742 following statements:
743
744 .blockquote
745 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
746
747 This program is free software; you can redistribute it and/or modify it under
748 the terms of the GNU General Public License as published by the Free Software
749 Foundation; either version 2 of the License, or (at your option) any later
750 version.
751 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
752 the spec and sample code for cdb can be obtained from
753 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
754 some code from Dan Bernstein's implementation (which has no license
755 restrictions applied to it).
756 .endblockquote
757 .next
758 .cindex "SPA authentication"
759 .cindex "Samba project"
760 .cindex "Microsoft Secure Password Authentication"
761 Client support for Microsoft's &'Secure Password Authentication'& is provided
762 by code contributed by Marc Prud'hommeaux. Server support was contributed by
763 Tom Kistner. This includes code taken from the Samba project, which is released
764 under the Gnu GPL.
765 .next
766 .cindex "Cyrus"
767 .cindex "&'pwcheck'& daemon"
768 .cindex "&'pwauthd'& daemon"
769 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
770 by code taken from the Cyrus-SASL library and adapted by Alexander S.
771 Sabourenkov. The permission notice appears below, in accordance with the
772 conditions expressed therein.
773
774 .blockquote
775 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
776
777 Redistribution and use in source and binary forms, with or without
778 modification, are permitted provided that the following conditions
779 are met:
780
781 .olist
782 Redistributions of source code must retain the above copyright
783 notice, this list of conditions and the following disclaimer.
784 .next
785 Redistributions in binary form must reproduce the above copyright
786 notice, this list of conditions and the following disclaimer in
787 the documentation and/or other materials provided with the
788 distribution.
789 .next
790 The name &"Carnegie Mellon University"& must not be used to
791 endorse or promote products derived from this software without
792 prior written permission. For permission or any other legal
793 details, please contact
794 .display
795               Office of Technology Transfer
796               Carnegie Mellon University
797               5000 Forbes Avenue
798               Pittsburgh, PA  15213-3890
799               (412) 268-4387, fax: (412) 268-7395
800               tech-transfer@andrew.cmu.edu
801 .endd
802 .next
803 Redistributions of any form whatsoever must retain the following
804 acknowledgment:
805
806 &"This product includes software developed by Computing Services
807 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
808
809 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
810 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
811 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
812 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
813 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
814 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
815 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
816 .endlist
817 .endblockquote
818
819 .next
820 .cindex "Exim monitor" "acknowledgment"
821 .cindex "X-windows"
822 .cindex "Athena"
823 The Exim Monitor program, which is an X-Window application, includes
824 modified versions of the Athena StripChart and TextPop widgets.
825 This code is copyright by DEC and MIT, and their permission notice appears
826 below, in accordance with the conditions expressed therein.
827
828 .blockquote
829 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
830 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
831
832 All Rights Reserved
833
834 Permission to use, copy, modify, and distribute this software and its
835 documentation for any purpose and without fee is hereby granted,
836 provided that the above copyright notice appear in all copies and that
837 both that copyright notice and this permission notice appear in
838 supporting documentation, and that the names of Digital or MIT not be
839 used in advertising or publicity pertaining to distribution of the
840 software without specific, written prior permission.
841
842 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
843 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
844 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
845 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
846 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
847 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
848 SOFTWARE.
849 .endblockquote
850
851 .next
852 Many people have contributed code fragments, some large, some small, that were
853 not covered by any specific licence requirements. It is assumed that the
854 contributors are happy to see their code incorporated into Exim under the GPL.
855 .endlist
856
857
858
859
860
861 . ////////////////////////////////////////////////////////////////////////////
862 . ////////////////////////////////////////////////////////////////////////////
863
864 .chapter "How Exim receives and delivers mail" "CHID11" &&&
865          "Receiving and delivering mail"
866
867
868 .section "Overall philosophy" "SECID10"
869 .cindex "design philosophy"
870 Exim is designed to work efficiently on systems that are permanently connected
871 to the Internet and are handling a general mix of mail. In such circumstances,
872 most messages can be delivered immediately. Consequently, Exim does not
873 maintain independent queues of messages for specific domains or hosts, though
874 it does try to send several messages in a single SMTP connection after a host
875 has been down, and it also maintains per-host retry information.
876
877
878 .section "Policy control" "SECID11"
879 .cindex "policy control" "overview"
880 Policy controls are now an important feature of MTAs that are connected to the
881 Internet. Perhaps their most important job is to stop MTAs being abused as
882 &"open relays"& by misguided individuals who send out vast amounts of
883 unsolicited junk, and want to disguise its source. Exim provides flexible
884 facilities for specifying policy controls on incoming mail:
885
886 .ilist
887 .cindex "&ACL;" "introduction"
888 Exim 4 (unlike previous versions of Exim) implements policy controls on
889 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
890 series of statements that may either grant or deny access. ACLs can be used at
891 several places in the SMTP dialogue while receiving a message from a remote
892 host. However, the most common places are after each RCPT command, and at the
893 very end of the message. The sysadmin can specify conditions for accepting or
894 rejecting individual recipients or the entire message, respectively, at these
895 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
896 error code.
897 .next
898 An ACL is also available for locally generated, non-SMTP messages. In this
899 case, the only available actions are to accept or deny the entire message.
900 .next
901 When Exim is compiled with the content-scanning extension, facilities are
902 provided in the ACL mechanism for passing the message to external virus and/or
903 spam scanning software. The result of such a scan is passed back to the ACL,
904 which can then use it to decide what to do with the message.
905 .next
906 When a message has been received, either from a remote host or from the local
907 host, but before the final acknowledgment has been sent, a locally supplied C
908 function called &[local_scan()]& can be run to inspect the message and decide
909 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
910 is accepted, the list of recipients can be modified by the function.
911 .next
912 Using the &[local_scan()]& mechanism is another way of calling external scanner
913 software. The &%SA-Exim%& add-on package works this way. It does not require
914 Exim to be compiled with the content-scanning extension.
915 .next
916 After a message has been accepted, a further checking mechanism is available in
917 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
918 runs at the start of every delivery process.
919 .endlist
920
921
922
923 .section "User filters" "SECID12"
924 .cindex "filter" "introduction"
925 .cindex "Sieve filter"
926 In a conventional Exim configuration, users are able to run private filters by
927 setting up appropriate &_.forward_& files in their home directories. See
928 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
929 configuration needed to support this, and the separate document entitled
930 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
931 of filtering are available:
932
933 .ilist
934 Sieve filters are written in the standard filtering language that is defined
935 by RFC 3028.
936 .next
937 Exim filters are written in a syntax that is unique to Exim, but which is more
938 powerful than Sieve, which it pre-dates.
939 .endlist
940
941 User filters are run as part of the routing process, described below.
942
943
944
945 .section "Message identification" "SECTmessiden"
946 .cindex "message ids" "details of format"
947 .cindex "format" "of message id"
948 .cindex "id of message"
949 .cindex "base62"
950 .cindex "base36"
951 .cindex "Darwin"
952 .cindex "Cygwin"
953 Every message handled by Exim is given a &'message id'& which is sixteen
954 characters long. It is divided into three parts, separated by hyphens, for
955 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
956 normally encoding numbers in base 62. However, in the Darwin operating
957 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
958 (avoiding the use of lower case letters) is used instead, because the message
959 id is used to construct file names, and the names of files in those systems are
960 not always case-sensitive.
961
962 .cindex "pid (process id)" "re-use of"
963 The detail of the contents of the message id have changed as Exim has evolved.
964 Earlier versions relied on the operating system not re-using a process id (pid)
965 within one second. On modern operating systems, this assumption can no longer
966 be made, so the algorithm had to be changed. To retain backward compatibility,
967 the format of the message id was retained, which is why the following rules are
968 somewhat eccentric:
969
970 .ilist
971 The first six characters of the message id are the time at which the message
972 started to be received, to a granularity of one second. That is, this field
973 contains the number of seconds since the start of the epoch (the normal Unix
974 way of representing the date and time of day).
975 .next
976 After the first hyphen, the next six characters are the id of the process that
977 received the message.
978 .next
979 There are two different possibilities for the final two characters:
980 .olist
981 .oindex "&%localhost_number%&"
982 If &%localhost_number%& is not set, this value is the fractional part of the
983 time of reception, normally in units of 1/2000 of a second, but for systems
984 that must use base 36 instead of base 62 (because of case-insensitive file
985 systems), the units are 1/1000 of a second.
986 .next
987 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
988 the fractional part of the time, which in this case is in units of 1/200
989 (1/100) of a second.
990 .endlist
991 .endlist
992
993 After a message has been received, Exim waits for the clock to tick at the
994 appropriate resolution before proceeding, so that if another message is
995 received by the same process, or by another process with the same (re-used)
996 pid, it is guaranteed that the time will be different. In most cases, the clock
997 will already have ticked while the message was being received.
998
999
1000 .section "Receiving mail" "SECID13"
1001 .cindex "receiving mail"
1002 .cindex "message" "reception"
1003 The only way Exim can receive mail from another host is using SMTP over
1004 TCP/IP, in which case the sender and recipient addresses are transferred using
1005 SMTP commands. However, from a locally running process (such as a user's MUA),
1006 there are several possibilities:
1007
1008 .ilist
1009 If the process runs Exim with the &%-bm%& option, the message is read
1010 non-interactively (usually via a pipe), with the recipients taken from the
1011 command line, or from the body of the message if &%-t%& is also used.
1012 .next
1013 If the process runs Exim with the &%-bS%& option, the message is also read
1014 non-interactively, but in this case the recipients are listed at the start of
1015 the message in a series of SMTP RCPT commands, terminated by a DATA
1016 command. This is so-called &"batch SMTP"& format,
1017 but it isn't really SMTP. The SMTP commands are just another way of passing
1018 envelope addresses in a non-interactive submission.
1019 .next
1020 If the process runs Exim with the &%-bs%& option, the message is read
1021 interactively, using the SMTP protocol. A two-way pipe is normally used for
1022 passing data between the local process and the Exim process.
1023 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1024 example, the ACLs for SMTP commands are used for this form of submission.
1025 .next
1026 A local process may also make a TCP/IP call to the host's loopback address
1027 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1028 does not treat the loopback address specially. It treats all such connections
1029 in the same way as connections from other hosts.
1030 .endlist
1031
1032
1033 .cindex "message sender, constructed by Exim"
1034 .cindex "sender" "constructed by Exim"
1035 In the three cases that do not involve TCP/IP, the sender address is
1036 constructed from the login name of the user that called Exim and a default
1037 qualification domain (which can be set by the &%qualify_domain%& configuration
1038 option). For local or batch SMTP, a sender address that is passed using the
1039 SMTP MAIL command is ignored. However, the system administrator may allow
1040 certain users (&"trusted users"&) to specify a different sender address
1041 unconditionally, or all users to specify certain forms of different sender
1042 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1043 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1044 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1045 users to change sender addresses.
1046
1047 Messages received by either of the non-interactive mechanisms are subject to
1048 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1049 (either over TCP/IP, or interacting with a local process) can be checked by a
1050 number of ACLs that operate at different times during the SMTP session. Either
1051 individual recipients, or the entire message, can be rejected if local policy
1052 requirements are not met. The &[local_scan()]& function (see chapter
1053 &<<CHAPlocalscan>>&) is run for all incoming messages.
1054
1055 Exim can be configured not to start a delivery process when a message is
1056 received; this can be unconditional, or depend on the number of incoming SMTP
1057 connections or the system load. In these situations, new messages wait on the
1058 queue until a queue runner process picks them up. However, in standard
1059 configurations under normal conditions, delivery is started as soon as a
1060 message is received.
1061
1062
1063
1064
1065
1066 .section "Handling an incoming message" "SECID14"
1067 .cindex "spool directory" "files that hold a message"
1068 .cindex "file" "how a message is held"
1069 When Exim accepts a message, it writes two files in its spool directory. The
1070 first contains the envelope information, the current status of the message, and
1071 the header lines, and the second contains the body of the message. The names of
1072 the two spool files consist of the message id, followed by &`-H`& for the
1073 file containing the envelope and header, and &`-D`& for the data file.
1074
1075 .cindex "spool directory" "&_input_& sub-directory"
1076 By default all these message files are held in a single directory called
1077 &_input_& inside the general Exim spool directory. Some operating systems do
1078 not perform very well if the number of files in a directory gets large; to
1079 improve performance in such cases, the &%split_spool_directory%& option can be
1080 used. This causes Exim to split up the input files into 62 sub-directories
1081 whose names are single letters or digits. When this is done, the queue is
1082 processed one sub-directory at a time instead of all at once, which can improve
1083 overall performance even when there are not enough files in each directory to
1084 affect file system performance.
1085
1086 The envelope information consists of the address of the message's sender and
1087 the addresses of the recipients. This information is entirely separate from
1088 any addresses contained in the header lines. The status of the message includes
1089 a list of recipients who have already received the message. The format of the
1090 first spool file is described in chapter &<<CHAPspool>>&.
1091
1092 .cindex "rewriting" "addresses"
1093 Address rewriting that is specified in the rewrite section of the configuration
1094 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1095 both in the header lines and the envelope, at the time the message is accepted.
1096 If during the course of delivery additional addresses are generated (for
1097 example, via aliasing), these new addresses are rewritten as soon as they are
1098 generated. At the time a message is actually delivered (transported) further
1099 rewriting can take place; because this is a transport option, it can be
1100 different for different forms of delivery. It is also possible to specify the
1101 addition or removal of certain header lines at the time the message is
1102 delivered (see chapters &<<CHAProutergeneric>>& and
1103 &<<CHAPtransportgeneric>>&).
1104
1105
1106
1107 .section "Life of a message" "SECID15"
1108 .cindex "message" "life of"
1109 .cindex "message" "frozen"
1110 A message remains in the spool directory until it is completely delivered to
1111 its recipients or to an error address, or until it is deleted by an
1112 administrator or by the user who originally created it. In cases when delivery
1113 cannot proceed &-- for example, when a message can neither be delivered to its
1114 recipients nor returned to its sender, the message is marked &"frozen"& on the
1115 spool, and no more deliveries are attempted.
1116
1117 .cindex "frozen messages" "thawing"
1118 .cindex "message" "thawing frozen"
1119 An administrator can &"thaw"& such messages when the problem has been
1120 corrected, and can also freeze individual messages by hand if necessary. In
1121 addition, an administrator can force a delivery error, causing a bounce message
1122 to be sent.
1123
1124 .oindex "&%timeout_frozen_after%&"
1125 .oindex "&%ignore_bounce_errors_after%&"
1126 There are options called &%ignore_bounce_errors_after%& and
1127 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1128 The first applies only to frozen bounces, the second to any frozen messages.
1129
1130 .cindex "message" "log file for"
1131 .cindex "log" "file for each message"
1132 While Exim is working on a message, it writes information about each delivery
1133 attempt to its main log file. This includes successful, unsuccessful, and
1134 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1135 lines are also written to a separate &'message log'& file for each message.
1136 These logs are solely for the benefit of the administrator, and are normally
1137 deleted along with the spool files when processing of a message is complete.
1138 The use of individual message logs can be disabled by setting
1139 &%no_message_logs%&; this might give an improvement in performance on very busy
1140 systems.
1141
1142 .cindex "journal file"
1143 .cindex "file" "journal"
1144 All the information Exim itself needs to set up a delivery is kept in the first
1145 spool file, along with the header lines. When a successful delivery occurs, the
1146 address is immediately written at the end of a journal file, whose name is the
1147 message id followed by &`-J`&. At the end of a delivery run, if there are some
1148 addresses left to be tried again later, the first spool file (the &`-H`& file)
1149 is updated to indicate which these are, and the journal file is then deleted.
1150 Updating the spool file is done by writing a new file and renaming it, to
1151 minimize the possibility of data loss.
1152
1153 Should the system or the program crash after a successful delivery but before
1154 the spool file has been updated, the journal is left lying around. The next
1155 time Exim attempts to deliver the message, it reads the journal file and
1156 updates the spool file before proceeding. This minimizes the chances of double
1157 deliveries caused by crashes.
1158
1159
1160
1161 .section "Processing an address for delivery" "SECTprocaddress"
1162 .cindex "drivers" "definition of"
1163 .cindex "router" "definition of"
1164 .cindex "transport" "definition of"
1165 The main delivery processing elements of Exim are called &'routers'& and
1166 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1167 number of them is provided in the source distribution, and compile-time options
1168 specify which ones are included in the binary. Run time options specify which
1169 ones are actually used for delivering messages.
1170
1171 .cindex "drivers" "instance definition"
1172 Each driver that is specified in the run time configuration is an &'instance'&
1173 of that particular driver type. Multiple instances are allowed; for example,
1174 you can set up several different &(smtp)& transports, each with different
1175 option values that might specify different ports or different timeouts. Each
1176 instance has its own identifying name. In what follows we will normally use the
1177 instance name when discussing one particular instance (that is, one specific
1178 configuration of the driver), and the generic driver name when discussing
1179 the driver's features in general.
1180
1181 A &'router'& is a driver that operates on an address, either determining how
1182 its delivery should happen, by assigning it to a specific transport, or
1183 converting the address into one or more new addresses (for example, via an
1184 alias file). A router may also explicitly choose to fail an address, causing it
1185 to be bounced.
1186
1187 A &'transport'& is a driver that transmits a copy of the message from Exim's
1188 spool to some destination. There are two kinds of transport: for a &'local'&
1189 transport, the destination is a file or a pipe on the local host, whereas for a
1190 &'remote'& transport the destination is some other host. A message is passed
1191 to a specific transport as a result of successful routing. If a message has
1192 several recipients, it may be passed to a number of different transports.
1193
1194 .cindex "preconditions" "definition of"
1195 An address is processed by passing it to each configured router instance in
1196 turn, subject to certain preconditions, until a router accepts the address or
1197 specifies that it should be bounced. We will describe this process in more
1198 detail shortly. First, as a simple example, we consider how each recipient
1199 address in a message is processed in a small configuration of three routers.
1200
1201 To make this a more concrete example, it is described in terms of some actual
1202 routers, but remember, this is only an example. You can configure Exim's
1203 routers in many different ways, and there may be any number of routers in a
1204 configuration.
1205
1206 The first router that is specified in a configuration is often one that handles
1207 addresses in domains that are not recognized specially by the local host. These
1208 are typically addresses for arbitrary domains on the Internet. A precondition
1209 is set up which looks for the special domains known to the host (for example,
1210 its own domain name), and the router is run for addresses that do &'not'&
1211 match. Typically, this is a router that looks up domains in the DNS in order to
1212 find the hosts to which this address routes. If it succeeds, the address is
1213 assigned to a suitable SMTP transport; if it does not succeed, the router is
1214 configured to fail the address.
1215
1216 The second router is reached only when the domain is recognized as one that
1217 &"belongs"& to the local host. This router does redirection &-- also known as
1218 aliasing and forwarding. When it generates one or more new addresses from the
1219 original, each of them is routed independently from the start. Otherwise, the
1220 router may cause an address to fail, or it may simply decline to handle the
1221 address, in which case the address is passed to the next router.
1222
1223 The final router in many configurations is one that checks to see if the
1224 address belongs to a local mailbox. The precondition may involve a check to
1225 see if the local part is the name of a login account, or it may look up the
1226 local part in a file or a database. If its preconditions are not met, or if
1227 the router declines, we have reached the end of the routers. When this happens,
1228 the address is bounced.
1229
1230
1231
1232 .section "Processing an address for verification" "SECID16"
1233 .cindex "router" "for verification"
1234 .cindex "verifying address" "overview"
1235 As well as being used to decide how to deliver to an address, Exim's routers
1236 are also used for &'address verification'&. Verification can be requested as
1237 one of the checks to be performed in an ACL for incoming messages, on both
1238 sender and recipient addresses, and it can be tested using the &%-bv%& and
1239 &%-bvs%& command line options.
1240
1241 When an address is being verified, the routers are run in &"verify mode"&. This
1242 does not affect the way the routers work, but it is a state that can be
1243 detected. By this means, a router can be skipped or made to behave differently
1244 when verifying. A common example is a configuration in which the first router
1245 sends all messages to a message-scanning program, unless they have been
1246 previously scanned. Thus, the first router accepts all addresses without any
1247 checking, making it useless for verifying. Normally, the &%no_verify%& option
1248 would be set for such a router, causing it to be skipped in verify mode.
1249
1250
1251
1252
1253 .section "Running an individual router" "SECTrunindrou"
1254 .cindex "router" "running details"
1255 .cindex "preconditions" "checking"
1256 .cindex "router" "result of running"
1257 As explained in the example above, a number of preconditions are checked before
1258 running a router. If any are not met, the router is skipped, and the address is
1259 passed to the next router. When all the preconditions on a router &'are'& met,
1260 the router is run. What happens next depends on the outcome, which is one of
1261 the following:
1262
1263 .ilist
1264 &'accept'&: The router accepts the address, and either assigns it to a
1265 transport, or generates one or more &"child"& addresses. Processing the
1266 original address ceases,
1267 .oindex "&%unseen%&"
1268 unless the &%unseen%& option is set on the router. This option
1269 can be used to set up multiple deliveries with different routing (for example,
1270 for keeping archive copies of messages). When &%unseen%& is set, the address is
1271 passed to the next router. Normally, however, an &'accept'& return marks the
1272 end of routing.
1273
1274 Any child addresses generated by the router are processed independently,
1275 starting with the first router by default. It is possible to change this by
1276 setting the &%redirect_router%& option to specify which router to start at for
1277 child addresses. Unlike &%pass_router%& (see below) the router specified by
1278 &%redirect_router%& may be anywhere in the router configuration.
1279 .next
1280 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1281 requests that the address be passed to another router. By default the address
1282 is passed to the next router, but this can be changed by setting the
1283 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1284 must be below the current router (to avoid loops).
1285 .next
1286 &'decline'&: The router declines to accept the address because it does not
1287 recognize it at all. By default, the address is passed to the next router, but
1288 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1289 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1290 &'decline'& into &'fail'&.
1291 .next
1292 &'fail'&: The router determines that the address should fail, and queues it for
1293 the generation of a bounce message. There is no further processing of the
1294 original address unless &%unseen%& is set on the router.
1295 .next
1296 &'defer'&: The router cannot handle the address at the present time. (A
1297 database may be offline, or a DNS lookup may have timed out.) No further
1298 processing of the address happens in this delivery attempt. It is tried again
1299 next time the message is considered for delivery.
1300 .next
1301 &'error'&: There is some error in the router (for example, a syntax error in
1302 its configuration). The action is as for defer.
1303 .endlist
1304
1305 If an address reaches the end of the routers without having been accepted by
1306 any of them, it is bounced as unrouteable. The default error message in this
1307 situation is &"unrouteable address"&, but you can set your own message by
1308 making use of the &%cannot_route_message%& option. This can be set for any
1309 router; the value from the last router that &"saw"& the address is used.
1310
1311 Sometimes while routing you want to fail a delivery when some conditions are
1312 met but others are not, instead of passing the address on for further routing.
1313 You can do this by having a second router that explicitly fails the delivery
1314 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1315 facility for this purpose.
1316
1317
1318 .section "Duplicate addresses" "SECID17"
1319 .cindex "case of local parts"
1320 .cindex "address duplicate, discarding"
1321 .cindex "duplicate addresses"
1322 Once routing is complete, Exim scans the addresses that are assigned to local
1323 and remote transports, and discards any duplicates that it finds. During this
1324 check, local parts are treated as case-sensitive. This happens only when
1325 actually delivering a message; when testing routers with &%-bt%&, all the
1326 routed addresses are shown.
1327
1328
1329
1330 .section "Router preconditions" "SECTrouprecon"
1331 .cindex "router" "preconditions, order of processing"
1332 .cindex "preconditions" "order of processing"
1333 The preconditions that are tested for each router are listed below, in the
1334 order in which they are tested. The individual configuration options are
1335 described in more detail in chapter &<<CHAProutergeneric>>&.
1336
1337 .ilist
1338 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1339 the local parts handled by the router may or must have certain prefixes and/or
1340 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1341 skipped. These conditions are tested first. When an affix is present, it is
1342 removed from the local part before further processing, including the evaluation
1343 of any other conditions.
1344 .next
1345 Routers can be designated for use only when not verifying an address, that is,
1346 only when routing it for delivery (or testing its delivery routing). If the
1347 &%verify%& option is set false, the router is skipped when Exim is verifying an
1348 address.
1349 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1350 &%verify_recipient%&, which independently control the use of the router for
1351 sender and recipient verification. You can set these options directly if
1352 you want a router to be used for only one type of verification.
1353 .next
1354 If the &%address_test%& option is set false, the router is skipped when Exim is
1355 run with the &%-bt%& option to test an address routing. This can be helpful
1356 when the first router sends all new messages to a scanner of some sort; it
1357 makes it possible to use &%-bt%& to test subsequent delivery routing without
1358 having to simulate the effect of the scanner.
1359 .next
1360 Routers can be designated for use only when verifying an address, as
1361 opposed to routing it for delivery. The &%verify_only%& option controls this.
1362 .next
1363 Individual routers can be explicitly skipped when running the routers to
1364 check an address given in the SMTP EXPN command (see the &%expn%& option).
1365 .next
1366 If the &%domains%& option is set, the domain of the address must be in the set
1367 of domains that it defines.
1368 .next
1369 .vindex "&$local_part_prefix$&"
1370 .vindex "&$local_part$&"
1371 .vindex "&$local_part_suffix$&"
1372 If the &%local_parts%& option is set, the local part of the address must be in
1373 the set of local parts that it defines. If &%local_part_prefix%& or
1374 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1375 part before this check. If you want to do precondition tests on local parts
1376 that include affixes, you can do so by using a &%condition%& option (see below)
1377 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1378 &$local_part_suffix$& as necessary.
1379 .next
1380 .vindex "&$local_user_uid$&"
1381 .vindex "&$local_user_gid$&"
1382 .vindex "&$home$&"
1383 If the &%check_local_user%& option is set, the local part must be the name of
1384 an account on the local host. If this check succeeds, the uid and gid of the
1385 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1386 user's home directory is placed in &$home$&; these values can be used in the
1387 remaining preconditions.
1388 .next
1389 If the &%router_home_directory%& option is set, it is expanded at this point,
1390 because it overrides the value of &$home$&. If this expansion were left till
1391 later, the value of &$home$& as set by &%check_local_user%& would be used in
1392 subsequent tests. Having two different values of &$home$& in the same router
1393 could lead to confusion.
1394 .next
1395 If the &%senders%& option is set, the envelope sender address must be in the
1396 set of addresses that it defines.
1397 .next
1398 If the &%require_files%& option is set, the existence or non-existence of
1399 specified files is tested.
1400 .next
1401 .cindex "customizing" "precondition"
1402 If the &%condition%& option is set, it is evaluated and tested. This option
1403 uses an expanded string to allow you to set up your own custom preconditions.
1404 Expanded strings are described in chapter &<<CHAPexpand>>&.
1405 .endlist
1406
1407
1408 Note that &%require_files%& comes near the end of the list, so you cannot use
1409 it to check for the existence of a file in which to lookup up a domain, local
1410 part, or sender. However, as these options are all expanded, you can use the
1411 &%exists%& expansion condition to make such tests within each condition. The
1412 &%require_files%& option is intended for checking files that the router may be
1413 going to use internally, or which are needed by a specific transport (for
1414 example, &_.procmailrc_&).
1415
1416
1417
1418 .section "Delivery in detail" "SECID18"
1419 .cindex "delivery" "in detail"
1420 When a message is to be delivered, the sequence of events is as follows:
1421
1422 .ilist
1423 If a system-wide filter file is specified, the message is passed to it. The
1424 filter may add recipients to the message, replace the recipients, discard the
1425 message, cause a new message to be generated, or cause the message delivery to
1426 fail. The format of the system filter file is the same as for Exim user filter
1427 files, described in the separate document entitled &'Exim's interfaces to mail
1428 filtering'&.
1429 .cindex "Sieve filter" "not available for system filter"
1430 (&*Note*&: Sieve cannot be used for system filter files.)
1431
1432 Some additional features are available in system filters &-- see chapter
1433 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1434 filter only once per delivery attempt, however many recipients it has. However,
1435 if there are several delivery attempts because one or more addresses could not
1436 be immediately delivered, the system filter is run each time. The filter
1437 condition &%first_delivery%& can be used to detect the first run of the system
1438 filter.
1439 .next
1440 Each recipient address is offered to each configured router in turn, subject to
1441 its preconditions, until one is able to handle it. If no router can handle the
1442 address, that is, if they all decline, the address is failed. Because routers
1443 can be targeted at particular domains, several locally handled domains can be
1444 processed entirely independently of each other.
1445 .next
1446 .cindex "routing" "loops in"
1447 .cindex "loop" "while routing"
1448 A router that accepts an address may assign it to a local or a remote
1449 transport. However, the transport is not run at this time. Instead, the address
1450 is placed on a list for the particular transport, which will be run later.
1451 Alternatively, the router may generate one or more new addresses (typically
1452 from alias, forward, or filter files). New addresses are fed back into this
1453 process from the top, but in order to avoid loops, a router ignores any address
1454 which has an identically-named ancestor that was processed by itself.
1455 .next
1456 When all the routing has been done, addresses that have been successfully
1457 handled are passed to their assigned transports. When local transports are
1458 doing real local deliveries, they handle only one address at a time, but if a
1459 local transport is being used as a pseudo-remote transport (for example, to
1460 collect batched SMTP messages for transmission by some other means) multiple
1461 addresses can be handled. Remote transports can always handle more than one
1462 address at a time, but can be configured not to do so, or to restrict multiple
1463 addresses to the same domain.
1464 .next
1465 Each local delivery to a file or a pipe runs in a separate process under a
1466 non-privileged uid, and these deliveries are run one at a time. Remote
1467 deliveries also run in separate processes, normally under a uid that is private
1468 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1469 run in parallel. The maximum number of simultaneous remote deliveries for any
1470 one message is set by the &%remote_max_parallel%& option.
1471 The order in which deliveries are done is not defined, except that all local
1472 deliveries happen before any remote deliveries.
1473 .next
1474 .cindex "queue runner"
1475 When it encounters a local delivery during a queue run, Exim checks its retry
1476 database to see if there has been a previous temporary delivery failure for the
1477 address before running the local transport. If there was a previous failure,
1478 Exim does not attempt a new delivery until the retry time for the address is
1479 reached. However, this happens only for delivery attempts that are part of a
1480 queue run. Local deliveries are always attempted when delivery immediately
1481 follows message reception, even if retry times are set for them. This makes for
1482 better behaviour if one particular message is causing problems (for example,
1483 causing quota overflow, or provoking an error in a filter file).
1484 .next
1485 .cindex "delivery" "retry in remote transports"
1486 Remote transports do their own retry handling, since an address may be
1487 deliverable to one of a number of hosts, each of which may have a different
1488 retry time. If there have been previous temporary failures and no host has
1489 reached its retry time, no delivery is attempted, whether in a queue run or
1490 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1491 .next
1492 If there were any permanent errors, a bounce message is returned to an
1493 appropriate address (the sender in the common case), with details of the error
1494 for each failing address. Exim can be configured to send copies of bounce
1495 messages to other addresses.
1496 .next
1497 .cindex "delivery" "deferral"
1498 If one or more addresses suffered a temporary failure, the message is left on
1499 the queue, to be tried again later. Delivery of these addresses is said to be
1500 &'deferred'&.
1501 .next
1502 When all the recipient addresses have either been delivered or bounced,
1503 handling of the message is complete. The spool files and message log are
1504 deleted, though the message log can optionally be preserved if required.
1505 .endlist
1506
1507
1508
1509
1510 .section "Retry mechanism" "SECID19"
1511 .cindex "delivery" "retry mechanism"
1512 .cindex "retry" "description of mechanism"
1513 .cindex "queue runner"
1514 Exim's mechanism for retrying messages that fail to get delivered at the first
1515 attempt is the queue runner process. You must either run an Exim daemon that
1516 uses the &%-q%& option with a time interval to start queue runners at regular
1517 intervals, or use some other means (such as &'cron'&) to start them. If you do
1518 not arrange for queue runners to be run, messages that fail temporarily at the
1519 first attempt will remain on your queue for ever. A queue runner process works
1520 its way through the queue, one message at a time, trying each delivery that has
1521 passed its retry time.
1522 You can run several queue runners at once.
1523
1524 Exim uses a set of configured rules to determine when next to retry the failing
1525 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1526 should give up trying to deliver to the address, at which point it generates a
1527 bounce message. If no retry rules are set for a particular host, address, and
1528 error combination, no retries are attempted, and temporary errors are treated
1529 as permanent.
1530
1531
1532
1533 .section "Temporary delivery failure" "SECID20"
1534 .cindex "delivery" "temporary failure"
1535 There are many reasons why a message may not be immediately deliverable to a
1536 particular address. Failure to connect to a remote machine (because it, or the
1537 connection to it, is down) is one of the most common. Temporary failures may be
1538 detected during routing as well as during the transport stage of delivery.
1539 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1540 is on a file system where the user is over quota. Exim can be configured to
1541 impose its own quotas on local mailboxes; where system quotas are set they will
1542 also apply.
1543
1544 .new
1545 If a host is unreachable for a period of time, a number of messages may be
1546 waiting for it by the time it recovers, and sending them in a single SMTP
1547 connection is clearly beneficial. Whenever a delivery to a remote host is
1548 deferred,
1549 .cindex "hints database"
1550 Exim makes a note in its hints database, and whenever a successful
1551 SMTP delivery has happened, it looks to see if any other messages are waiting
1552 for the same host. If any are found, they are sent over the same SMTP
1553 connection, subject to a configuration limit as to the maximum number in any
1554 one connection.
1555 .wen
1556
1557
1558
1559 .section "Permanent delivery failure" "SECID21"
1560 .cindex "delivery" "permanent failure"
1561 .cindex "bounce message" "when generated"
1562 When a message cannot be delivered to some or all of its intended recipients, a
1563 bounce message is generated. Temporary delivery failures turn into permanent
1564 errors when their timeout expires. All the addresses that fail in a given
1565 delivery attempt are listed in a single message. If the original message has
1566 many recipients, it is possible for some addresses to fail in one delivery
1567 attempt and others to fail subsequently, giving rise to more than one bounce
1568 message. The wording of bounce messages can be customized by the administrator.
1569 See chapter &<<CHAPemsgcust>>& for details.
1570
1571 .cindex "&'X-Failed-Recipients:'& header line"
1572 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1573 failed addresses, for the benefit of programs that try to analyse such messages
1574 automatically.
1575
1576 .cindex "bounce message" "recipient of"
1577 A bounce message is normally sent to the sender of the original message, as
1578 obtained from the message's envelope. For incoming SMTP messages, this is the
1579 address given in the MAIL command. However, when an address is expanded via a
1580 forward or alias file, an alternative address can be specified for delivery
1581 failures of the generated addresses. For a mailing list expansion (see section
1582 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1583 of the list.
1584
1585
1586
1587 .section "Failures to deliver bounce messages" "SECID22"
1588 .cindex "bounce message" "failure to deliver"
1589 If a bounce message (either locally generated or received from a remote host)
1590 itself suffers a permanent delivery failure, the message is left on the queue,
1591 but it is frozen, awaiting the attention of an administrator. There are options
1592 that can be used to make Exim discard such failed messages, or to keep them
1593 for only a short time (see &%timeout_frozen_after%& and
1594 &%ignore_bounce_errors_after%&).
1595
1596
1597
1598
1599
1600 . ////////////////////////////////////////////////////////////////////////////
1601 . ////////////////////////////////////////////////////////////////////////////
1602
1603 .chapter "Building and installing Exim" "CHID3"
1604 .scindex IIDbuex "building Exim"
1605
1606 .section "Unpacking" "SECID23"
1607 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1608 creates a directory with the name of the current release (for example,
1609 &_exim-&version;_&) into which the following files are placed:
1610
1611 .table2 140pt
1612 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1613 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1614   documented"
1615 .irow &_LICENCE_&         "the GNU General Public Licence"
1616 .irow &_Makefile_&        "top-level make file"
1617 .irow &_NOTICE_&          "conditions for the use of Exim"
1618 .irow &_README_&          "list of files, directories and simple build &&&
1619   instructions"
1620 .endtable
1621
1622 Other files whose names begin with &_README_& may also be present. The
1623 following subdirectories are created:
1624
1625 .table2 140pt
1626 .irow &_Local_&           "an empty directory for local configuration files"
1627 .irow &_OS_&              "OS-specific files"
1628 .irow &_doc_&             "documentation files"
1629 .irow &_exim_monitor_&    "source files for the Exim monitor"
1630 .irow &_scripts_&         "scripts used in the build process"
1631 .irow &_src_&             "remaining source files"
1632 .irow &_util_&            "independent utilities"
1633 .endtable
1634
1635 The main utility programs are contained in the &_src_& directory, and are built
1636 with the Exim binary. The &_util_& directory contains a few optional scripts
1637 that may be useful to some sites.
1638
1639
1640 .section "Multiple machine architectures and operating systems" "SECID24"
1641 .cindex "building Exim" "multiple OS/architectures"
1642 The building process for Exim is arranged to make it easy to build binaries for
1643 a number of different architectures and operating systems from the same set of
1644 source files. Compilation does not take place in the &_src_& directory.
1645 Instead, a &'build directory'& is created for each architecture and operating
1646 system.
1647 .cindex "symbolic link" "to build directory"
1648 Symbolic links to the sources are installed in this directory, which is where
1649 the actual building takes place. In most cases, Exim can discover the machine
1650 architecture and operating system for itself, but the defaults can be
1651 overridden if necessary.
1652
1653
1654 .section "PCRE library" "SECTpcre"
1655 .cindex "PCRE library"
1656 Exim no longer has an embedded PCRE library as the vast majority of
1657 modern systems include PCRE as a system library, although you may need
1658 to install the PCRE or PCRE development package for your operating
1659 system. If your system has a normal PCRE installation the Exim build
1660 process will need no further configuration. If the library or the
1661 headers are in an unusual location you will need to set the PCRE_LIBS
1662 and INCLUDE directives appropriately. If your operating system has no
1663 PCRE support then you will need to obtain and build the current PCRE
1664 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1665
1666 .section "DBM libraries" "SECTdb"
1667 .cindex "DBM libraries" "discussion of"
1668 .cindex "hints database" "DBM files used for"
1669 Even if you do not use any DBM files in your configuration, Exim still needs a
1670 DBM library in order to operate, because it uses indexed files for its hints
1671 databases. Unfortunately, there are a number of DBM libraries in existence, and
1672 different operating systems often have different ones installed.
1673
1674 .cindex "Solaris" "DBM library for"
1675 .cindex "IRIX, DBM library for"
1676 .cindex "BSD, DBM library for"
1677 .cindex "Linux, DBM library for"
1678 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1679 Linux distribution, the DBM configuration should happen automatically, and you
1680 may be able to ignore this section. Otherwise, you may have to learn more than
1681 you would like about DBM libraries from what follows.
1682
1683 .cindex "&'ndbm'& DBM library"
1684 Licensed versions of Unix normally contain a library of DBM functions operating
1685 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1686 versions of Unix seem to vary in what they contain as standard. In particular,
1687 some early versions of Linux have no default DBM library, and different
1688 distributors have chosen to bundle different libraries with their packaged
1689 versions. However, the more recent releases seem to have standardized on the
1690 Berkeley DB library.
1691
1692 Different DBM libraries have different conventions for naming the files they
1693 use. When a program opens a file called &_dbmfile_&, there are several
1694 possibilities:
1695
1696 .olist
1697 A traditional &'ndbm'& implementation, such as that supplied as part of
1698 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1699 .next
1700 .cindex "&'gdbm'& DBM library"
1701 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1702 compatibility interface it makes two different hard links to it with names
1703 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1704 file name is used unmodified.
1705 .next
1706 .cindex "Berkeley DB library"
1707 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1708 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1709 programmer exactly the same as the traditional &'ndbm'& implementation.
1710 .next
1711 If the Berkeley package is used in its native mode, it operates on a single
1712 file called &_dbmfile_&; the programmer's interface is somewhat different to
1713 the traditional &'ndbm'& interface.
1714 .next
1715 To complicate things further, there are several very different versions of the
1716 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1717 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1718 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1719 versions of Berkeley DB can be obtained from
1720 &url(http://www.sleepycat.com/).
1721 .next
1722 .cindex "&'tdb'& DBM library"
1723 Yet another DBM library, called &'tdb'&, is available from
1724 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1725 operates on a single file.
1726 .endlist
1727
1728 .cindex "USE_DB"
1729 .cindex "DBM libraries" "configuration for building"
1730 Exim and its utilities can be compiled to use any of these interfaces. In order
1731 to use any version of the Berkeley DB package in native mode, you must set
1732 USE_DB in an appropriate configuration file (typically
1733 &_Local/Makefile_&). For example:
1734 .code
1735 USE_DB=yes
1736 .endd
1737 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1738 error is diagnosed if you set more than one of these.
1739
1740 At the lowest level, the build-time configuration sets none of these options,
1741 thereby assuming an interface of type (1). However, some operating system
1742 configuration files (for example, those for the BSD operating systems and
1743 Linux) assume type (4) by setting USE_DB as their default, and the
1744 configuration files for Cygwin set USE_GDBM. Anything you set in
1745 &_Local/Makefile_&, however, overrides these system defaults.
1746
1747 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1748 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1749 in one of these lines:
1750 .code
1751 DBMLIB = -ldb
1752 DBMLIB = -ltdb
1753 .endd
1754 Settings like that will work if the DBM library is installed in the standard
1755 place. Sometimes it is not, and the library's header file may also not be in
1756 the default path. You may need to set INCLUDE to specify where the header
1757 file is, and to specify the path to the library more fully in DBMLIB, as in
1758 this example:
1759 .code
1760 INCLUDE=-I/usr/local/include/db-4.1
1761 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1762 .endd
1763 There is further detailed discussion about the various DBM libraries in the
1764 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1765
1766
1767
1768 .section "Pre-building configuration" "SECID25"
1769 .cindex "building Exim" "pre-building configuration"
1770 .cindex "configuration for building Exim"
1771 .cindex "&_Local/Makefile_&"
1772 .cindex "&_src/EDITME_&"
1773 Before building Exim, a local configuration file that specifies options
1774 independent of any operating system has to be created with the name
1775 &_Local/Makefile_&. A template for this file is supplied as the file
1776 &_src/EDITME_&, and it contains full descriptions of all the option settings
1777 therein. These descriptions are therefore not repeated here. If you are
1778 building Exim for the first time, the simplest thing to do is to copy
1779 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1780
1781 There are three settings that you must supply, because Exim will not build
1782 without them. They are the location of the run time configuration file
1783 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1784 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1785 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1786 a colon-separated list of file names; Exim uses the first of them that exists.
1787
1788 There are a few other parameters that can be specified either at build time or
1789 at run time, to enable the same binary to be used on a number of different
1790 machines. However, if the locations of Exim's spool directory and log file
1791 directory (if not within the spool directory) are fixed, it is recommended that
1792 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1793 detected early in Exim's execution (such as a malformed configuration file) can
1794 be logged.
1795
1796 .cindex "content scanning" "specifying at build time"
1797 Exim's interfaces for calling virus and spam scanning software directly from
1798 access control lists are not compiled by default. If you want to include these
1799 facilities, you need to set
1800 .code
1801 WITH_CONTENT_SCAN=yes
1802 .endd
1803 in your &_Local/Makefile_&. For details of the facilities themselves, see
1804 chapter &<<CHAPexiscan>>&.
1805
1806
1807 .cindex "&_Local/eximon.conf_&"
1808 .cindex "&_exim_monitor/EDITME_&"
1809 If you are going to build the Exim monitor, a similar configuration process is
1810 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1811 your installation and saved under the name &_Local/eximon.conf_&. If you are
1812 happy with the default settings described in &_exim_monitor/EDITME_&,
1813 &_Local/eximon.conf_& can be empty, but it must exist.
1814
1815 This is all the configuration that is needed in straightforward cases for known
1816 operating systems. However, the building process is set up so that it is easy
1817 to override options that are set by default or by operating-system-specific
1818 configuration files, for example to change the name of the C compiler, which
1819 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1820 do this.
1821
1822
1823
1824 .section "Support for iconv()" "SECID26"
1825 .cindex "&[iconv()]& support"
1826 .cindex "RFC 2047"
1827 The contents of header lines in messages may be encoded according to the rules
1828 described RFC 2047. This makes it possible to transmit characters that are not
1829 in the ASCII character set, and to label them as being in a particular
1830 character set. When Exim is inspecting header lines by means of the &%$h_%&
1831 mechanism, it decodes them, and translates them into a specified character set
1832 (default ISO-8859-1). The translation is possible only if the operating system
1833 supports the &[iconv()]& function.
1834
1835 However, some of the operating systems that supply &[iconv()]& do not support
1836 very many conversions. The GNU &%libiconv%& library (available from
1837 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1838 systems to remedy this deficiency, as well as on systems that do not supply
1839 &[iconv()]& at all. After installing &%libiconv%&, you should add
1840 .code
1841 HAVE_ICONV=yes
1842 .endd
1843 to your &_Local/Makefile_& and rebuild Exim.
1844
1845
1846
1847 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1848 .cindex "TLS" "including support for TLS"
1849 .cindex "encryption" "including support for"
1850 .cindex "SUPPORT_TLS"
1851 .cindex "OpenSSL" "building Exim with"
1852 .cindex "GnuTLS" "building Exim with"
1853 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1854 command as per RFC 2487. It can also support legacy clients that expect to
1855 start a TLS session immediately on connection to a non-standard port (see the
1856 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1857 line option).
1858
1859 If you want to build Exim with TLS support, you must first install either the
1860 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1861 implementing SSL.
1862
1863 If OpenSSL is installed, you should set
1864 .code
1865 SUPPORT_TLS=yes
1866 TLS_LIBS=-lssl -lcrypto
1867 .endd
1868 in &_Local/Makefile_&. You may also need to specify the locations of the
1869 OpenSSL library and include files. For example:
1870 .code
1871 SUPPORT_TLS=yes
1872 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1873 TLS_INCLUDE=-I/usr/local/openssl/include/
1874 .endd
1875 .cindex "USE_GNUTLS"
1876 If GnuTLS is installed, you should set
1877 .code
1878 SUPPORT_TLS=yes
1879 USE_GNUTLS=yes
1880 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1881 .endd
1882 in &_Local/Makefile_&, and again you may need to specify the locations of the
1883 library and include files. For example:
1884 .code
1885 SUPPORT_TLS=yes
1886 USE_GNUTLS=yes
1887 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1888 TLS_INCLUDE=-I/usr/gnu/include
1889 .endd
1890 You do not need to set TLS_INCLUDE if the relevant directory is already
1891 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1892 given in chapter &<<CHAPTLS>>&.
1893
1894
1895
1896
1897 .new
1898 .section "Use of tcpwrappers" "SECID27"
1899
1900 .cindex "tcpwrappers, building Exim to support"
1901 .cindex "USE_TCP_WRAPPERS"
1902 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1903 .cindex "tcp_wrappers_daemon_name"
1904 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1905 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1906 alternative to Exim's own checking facilities for installations that are
1907 already making use of &'tcpwrappers'& for other purposes. To do this, you
1908 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1909 &_tcpd.h_& to be available at compile time, and also ensure that the library
1910 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1911 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1912 you might have
1913 .code
1914 USE_TCP_WRAPPERS=yes
1915 CFLAGS=-O -I/usr/local/include
1916 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1917 .endd
1918 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1919 files is &"exim"&. For example, the line
1920 .code
1921 exim : LOCAL  192.168.1.  .friendly.domain.example
1922 .endd
1923 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1924 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1925 All other connections are denied. The daemon name used by &'tcpwrappers'&
1926 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1927 in &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1928 configure file. Consult the &'tcpwrappers'& documentation for
1929 further details.
1930 .wen
1931
1932
1933 .section "Including support for IPv6" "SECID28"
1934 .cindex "IPv6" "including support for"
1935 Exim contains code for use on systems that have IPv6 support. Setting
1936 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1937 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1938 where the IPv6 support is not fully integrated into the normal include and
1939 library files.
1940
1941 Two different types of DNS record for handling IPv6 addresses have been
1942 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1943 currently seen as the mainstream. Another record type called A6 was proposed
1944 as better than AAAA because it had more flexibility. However, it was felt to be
1945 over-complex, and its status was reduced to &"experimental"&. It is not known
1946 if anyone is actually using A6 records. Exim has support for A6 records, but
1947 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1948 support has not been tested for some time.
1949
1950
1951
1952 .new
1953 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1954 .cindex "lookup modules"
1955 .cindex "dynamic modules"
1956 .cindex ".so building"
1957 On some platforms, Exim supports not compiling all lookup types directly into
1958 the main binary, instead putting some into external modules which can be loaded
1959 on demand.
1960 This permits packagers to build Exim with support for lookups with extensive
1961 library dependencies without requiring all users to install all of those
1962 dependencies.
1963 Most, but not all, lookup types can be built this way.
1964
1965 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
1966 installed; Exim will only load modules from that directory, as a security
1967 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
1968 for your OS; see &_OS/Makefile-Linux_& for an example.
1969 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
1970 see &_src/EDITME_& for details.
1971
1972 Then, for each module to be loaded dynamically, define the relevant
1973 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
1974 For example, this will build in lsearch but load sqlite and mysql support
1975 on demand:
1976 .code
1977 LOOKUP_LSEARCH=yes
1978 LOOKUP_SQLITE=2
1979 LOOKUP_MYSQL=2
1980 .endd
1981 .wen
1982
1983 .section "The building process" "SECID29"
1984 .cindex "build directory"
1985 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
1986 created, run &'make'& at the top level. It determines the architecture and
1987 operating system types, and creates a build directory if one does not exist.
1988 For example, on a Sun system running Solaris 8, the directory
1989 &_build-SunOS5-5.8-sparc_& is created.
1990 .cindex "symbolic link" "to source files"
1991 Symbolic links to relevant source files are installed in the build directory.
1992
1993 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
1994 building process fails if it is set.
1995
1996 If this is the first time &'make'& has been run, it calls a script that builds
1997 a make file inside the build directory, using the configuration files from the
1998 &_Local_& directory. The new make file is then passed to another instance of
1999 &'make'&. This does the real work, building a number of utility scripts, and
2000 then compiling and linking the binaries for the Exim monitor (if configured), a
2001 number of utility programs, and finally Exim itself. The command &`make
2002 makefile`& can be used to force a rebuild of the make file in the build
2003 directory, should this ever be necessary.
2004
2005 If you have problems building Exim, check for any comments there may be in the
2006 &_README_& file concerning your operating system, and also take a look at the
2007 FAQ, where some common problems are covered.
2008
2009
2010
2011 .section 'Output from &"make"&' "SECID283"
2012 The output produced by the &'make'& process for compile lines is often very
2013 unreadable, because these lines can be very long. For this reason, the normal
2014 output is suppressed by default, and instead output similar to that which
2015 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2016 each module that is being compiled or linked. However, it is still possible to
2017 get the full output, by calling &'make'& like this:
2018 .code
2019 FULLECHO='' make -e
2020 .endd
2021 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2022 command reflection in &'make'&. When you ask for the full output, it is
2023 given in addition to the short output.
2024
2025
2026
2027 .section "Overriding build-time options for Exim" "SECToverride"
2028 .cindex "build-time options, overriding"
2029 The main make file that is created at the beginning of the building process
2030 consists of the concatenation of a number of files which set configuration
2031 values, followed by a fixed set of &'make'& instructions. If a value is set
2032 more than once, the last setting overrides any previous ones. This provides a
2033 convenient way of overriding defaults. The files that are concatenated are, in
2034 order:
2035 .display
2036 &_OS/Makefile-Default_&
2037 &_OS/Makefile-_&<&'ostype'&>
2038 &_Local/Makefile_&
2039 &_Local/Makefile-_&<&'ostype'&>
2040 &_Local/Makefile-_&<&'archtype'&>
2041 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2042 &_OS/Makefile-Base_&
2043 .endd
2044 .cindex "&_Local/Makefile_&"
2045 .cindex "building Exim" "operating system type"
2046 .cindex "building Exim" "architecture type"
2047 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2048 architecture type. &_Local/Makefile_& is required to exist, and the building
2049 process fails if it is absent. The other three &_Local_& files are optional,
2050 and are often not needed.
2051
2052 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2053 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2054 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2055 values are used, thereby providing a means of forcing particular settings.
2056 Otherwise, the scripts try to get values from the &%uname%& command. If this
2057 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2058 of &'ad hoc'& transformations are then applied, to produce the standard names
2059 that Exim expects. You can run these scripts directly from the shell in order
2060 to find out what values are being used on your system.
2061
2062
2063 &_OS/Makefile-Default_& contains comments about the variables that are set
2064 therein. Some (but not all) are mentioned below. If there is something that
2065 needs changing, review the contents of this file and the contents of the make
2066 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2067 default values are.
2068
2069
2070 .cindex "building Exim" "overriding default settings"
2071 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2072 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2073 need to change the original files. Instead, you should make the changes by
2074 putting the new values in an appropriate &_Local_& file. For example,
2075 .cindex "Tru64-Unix build-time settings"
2076 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2077 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2078 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2079 called with the option &%-std1%&, to make it recognize some of the features of
2080 Standard C that Exim uses. (Most other compilers recognize Standard C by
2081 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2082 containing the lines
2083 .code
2084 CC=cc
2085 CFLAGS=-std1
2086 .endd
2087 If you are compiling for just one operating system, it may be easier to put
2088 these lines directly into &_Local/Makefile_&.
2089
2090 Keeping all your local configuration settings separate from the distributed
2091 files makes it easy to transfer them to new versions of Exim simply by copying
2092 the contents of the &_Local_& directory.
2093
2094
2095 .cindex "NIS lookup type" "including support for"
2096 .cindex "NIS+ lookup type" "including support for"
2097 .cindex "LDAP" "including support for"
2098 .cindex "lookup" "inclusion in binary"
2099 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2100 lookup, but not all systems have these components installed, so the default is
2101 not to include the relevant code in the binary. All the different kinds of file
2102 and database lookup that Exim supports are implemented as separate code modules
2103 which are included only if the relevant compile-time options are set. In the
2104 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2105 .code
2106 LOOKUP_LDAP=yes
2107 LOOKUP_NIS=yes
2108 LOOKUP_NISPLUS=yes
2109 .endd
2110 and similar settings apply to the other lookup types. They are all listed in
2111 &_src/EDITME_&. In many cases the relevant include files and interface
2112 libraries need to be installed before compiling Exim.
2113 .cindex "cdb" "including support for"
2114 However, there are some optional lookup types (such as cdb) for which
2115 the code is entirely contained within Exim, and no external include
2116 files or libraries are required. When a lookup type is not included in the
2117 binary, attempts to configure Exim to use it cause run time configuration
2118 errors.
2119
2120 .cindex "Perl" "including support for"
2121 Exim can be linked with an embedded Perl interpreter, allowing Perl
2122 subroutines to be called during string expansion. To enable this facility,
2123 .code
2124 EXIM_PERL=perl.o
2125 .endd
2126 must be defined in &_Local/Makefile_&. Details of this facility are given in
2127 chapter &<<CHAPperl>>&.
2128
2129 .cindex "X11 libraries, location of"
2130 The location of the X11 libraries is something that varies a lot between
2131 operating systems, and there may be different versions of X11 to cope
2132 with. Exim itself makes no use of X11, but if you are compiling the Exim
2133 monitor, the X11 libraries must be available.
2134 The following three variables are set in &_OS/Makefile-Default_&:
2135 .code
2136 X11=/usr/X11R6
2137 XINCLUDE=-I$(X11)/include
2138 XLFLAGS=-L$(X11)/lib
2139 .endd
2140 These are overridden in some of the operating-system configuration files. For
2141 example, in &_OS/Makefile-SunOS5_& there is
2142 .code
2143 X11=/usr/openwin
2144 XINCLUDE=-I$(X11)/include
2145 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2146 .endd
2147 If you need to override the default setting for your operating system, place a
2148 definition of all three of these variables into your
2149 &_Local/Makefile-<ostype>_& file.
2150
2151 .cindex "EXTRALIBS"
2152 If you need to add any extra libraries to the link steps, these can be put in a
2153 variable called EXTRALIBS, which appears in all the link commands, but by
2154 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2155 command for linking the main Exim binary, and not for any associated utilities.
2156
2157 .cindex "DBM libraries" "configuration for building"
2158 There is also DBMLIB, which appears in the link commands for binaries that
2159 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2160 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2161 binary, and which can be used, for example, to include additional X11
2162 libraries.
2163
2164 .cindex "configuration file" "editing"
2165 The make file copes with rebuilding Exim correctly if any of the configuration
2166 files are edited. However, if an optional configuration file is deleted, it is
2167 necessary to touch the associated non-optional file (that is,
2168 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2169
2170
2171 .section "OS-specific header files" "SECID30"
2172 .cindex "&_os.h_&"
2173 .cindex "building Exim" "OS-specific C header files"
2174 The &_OS_& directory contains a number of files with names of the form
2175 &_os.h-<ostype>_&. These are system-specific C header files that should not
2176 normally need to be changed. There is a list of macro settings that are
2177 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2178 are porting Exim to a new operating system.
2179
2180
2181
2182 .section "Overriding build-time options for the monitor" "SECID31"
2183 .cindex "building Eximon"
2184 A similar process is used for overriding things when building the Exim monitor,
2185 where the files that are involved are
2186 .display
2187 &_OS/eximon.conf-Default_&
2188 &_OS/eximon.conf-_&<&'ostype'&>
2189 &_Local/eximon.conf_&
2190 &_Local/eximon.conf-_&<&'ostype'&>
2191 &_Local/eximon.conf-_&<&'archtype'&>
2192 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2193 .endd
2194 .cindex "&_Local/eximon.conf_&"
2195 As with Exim itself, the final three files need not exist, and in this case the
2196 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2197 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2198 variables of the same name, preceded by EXIMON_. For example, setting
2199 EXIMON_LOG_DEPTH in the environment overrides the value of
2200 LOG_DEPTH at run time.
2201 .ecindex IIDbuex
2202
2203
2204 .section "Installing Exim binaries and scripts" "SECID32"
2205 .cindex "installing Exim"
2206 .cindex "BIN_DIRECTORY"
2207 The command &`make install`& runs the &(exim_install)& script with no
2208 arguments. The script copies binaries and utility scripts into the directory
2209 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2210 .cindex "setuid" "installing Exim with"
2211 The install script copies files only if they are newer than the files they are
2212 going to replace. The Exim binary is required to be owned by root and have the
2213 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2214 install`& as root so that it can set up the Exim binary in this way. However, in
2215 some special situations (for example, if a host is doing no local deliveries)
2216 it may be possible to run Exim without making the binary setuid root (see
2217 chapter &<<CHAPsecurity>>& for details).
2218
2219 .cindex "CONFIGURE_FILE"
2220 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2221 in &_Local/Makefile_&. If this names a single file, and the file does not
2222 exist, the default configuration file &_src/configure.default_& is copied there
2223 by the installation script. If a run time configuration file already exists, it
2224 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2225 alternative files, no default is installed.
2226
2227 .cindex "system aliases file"
2228 .cindex "&_/etc/aliases_&"
2229 One change is made to the default configuration file when it is installed: the
2230 default configuration contains a router that references a system aliases file.
2231 The path to this file is set to the value specified by
2232 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2233 If the system aliases file does not exist, the installation script creates it,
2234 and outputs a comment to the user.
2235
2236 The created file contains no aliases, but it does contain comments about the
2237 aliases a site should normally have. Mail aliases have traditionally been
2238 kept in &_/etc/aliases_&. However, some operating systems are now using
2239 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2240 Exim's configuration if necessary.
2241
2242 The default configuration uses the local host's name as the only local domain,
2243 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2244 running as the local user. System aliases and &_.forward_& files in users' home
2245 directories are supported, but no NIS or NIS+ support is configured. Domains
2246 other than the name of the local host are routed using the DNS, with delivery
2247 over SMTP.
2248
2249 It is possible to install Exim for special purposes (such as building a binary
2250 distribution) in a private part of the file system. You can do this by a
2251 command such as
2252 .code
2253 make DESTDIR=/some/directory/ install
2254 .endd
2255 This has the effect of pre-pending the specified directory to all the file
2256 paths, except the name of the system aliases file that appears in the default
2257 configuration. (If a default alias file is created, its name &'is'& modified.)
2258 For backwards compatibility, ROOT is used if DESTDIR is not set,
2259 but this usage is deprecated.
2260
2261 .cindex "installing Exim" "what is not installed"
2262 Running &'make install'& does not copy the Exim 4 conversion script
2263 &'convert4r4'&. You will probably run this only once if you are
2264 upgrading from Exim 3. None of the documentation files in the &_doc_&
2265 directory are copied, except for the info files when you have set
2266 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2267
2268 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2269 to their names. The Exim binary itself, however, is handled differently. It is
2270 installed under a name that includes the version number and the compile number,
2271 for example &_exim-&version;-1_&. The script then arranges for a symbolic link
2272 called &_exim_& to point to the binary. If you are updating a previous version
2273 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2274 from the directory (as seen by other processes).
2275
2276 .cindex "installing Exim" "testing the script"
2277 If you want to see what the &'make install'& will do before running it for
2278 real, you can pass the &%-n%& option to the installation script by this
2279 command:
2280 .code
2281 make INSTALL_ARG=-n install
2282 .endd
2283 The contents of the variable INSTALL_ARG are passed to the installation
2284 script. You do not need to be root to run this test. Alternatively, you can run
2285 the installation script directly, but this must be from within the build
2286 directory. For example, from the top-level Exim directory you could use this
2287 command:
2288 .code
2289 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2290 .endd
2291 .cindex "installing Exim" "install script options"
2292 There are two other options that can be supplied to the installation script.
2293
2294 .ilist
2295 &%-no_chown%& bypasses the call to change the owner of the installed binary
2296 to root, and the call to make it a setuid binary.
2297 .next
2298 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2299 installed binary.
2300 .endlist
2301
2302 INSTALL_ARG can be used to pass these options to the script. For example:
2303 .code
2304 make INSTALL_ARG=-no_symlink install
2305 .endd
2306 The installation script can also be given arguments specifying which files are
2307 to be copied. For example, to install just the Exim binary, and nothing else,
2308 without creating the symbolic link, you could use:
2309 .code
2310 make INSTALL_ARG='-no_symlink exim' install
2311 .endd
2312
2313
2314
2315 .section "Installing info documentation" "SECTinsinfdoc"
2316 .cindex "installing Exim" "&'info'& documentation"
2317 Not all systems use the GNU &'info'& system for documentation, and for this
2318 reason, the Texinfo source of Exim's documentation is not included in the main
2319 distribution. Instead it is available separately from the ftp site (see section
2320 &<<SECTavail>>&).
2321
2322 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2323 source of the documentation is found in the source tree, running &`make
2324 install`& automatically builds the info files and installs them.
2325
2326
2327
2328 .section "Setting up the spool directory" "SECID33"
2329 .cindex "spool directory" "creating"
2330 When it starts up, Exim tries to create its spool directory if it does not
2331 exist. The Exim uid and gid are used for the owner and group of the spool
2332 directory. Sub-directories are automatically created in the spool directory as
2333 necessary.
2334
2335
2336
2337
2338 .section "Testing" "SECID34"
2339 .cindex "testing" "installation"
2340 Having installed Exim, you can check that the run time configuration file is
2341 syntactically valid by running the following command, which assumes that the
2342 Exim binary directory is within your PATH environment variable:
2343 .code
2344 exim -bV
2345 .endd
2346 If there are any errors in the configuration file, Exim outputs error messages.
2347 Otherwise it outputs the version number and build date,
2348 the DBM library that is being used, and information about which drivers and
2349 other optional code modules are included in the binary.
2350 Some simple routing tests can be done by using the address testing option. For
2351 example,
2352 .display
2353 &`exim -bt`& <&'local username'&>
2354 .endd
2355 should verify that it recognizes a local mailbox, and
2356 .display
2357 &`exim -bt`& <&'remote address'&>
2358 .endd
2359 a remote one. Then try getting it to deliver mail, both locally and remotely.
2360 This can be done by passing messages directly to Exim, without going through a
2361 user agent. For example:
2362 .code
2363 exim -v postmaster@your.domain.example
2364 From: user@your.domain.example
2365 To: postmaster@your.domain.example
2366 Subject: Testing Exim
2367
2368 This is a test message.
2369 ^D
2370 .endd
2371 The &%-v%& option causes Exim to output some verification of what it is doing.
2372 In this case you should see copies of three log lines, one for the message's
2373 arrival, one for its delivery, and one containing &"Completed"&.
2374
2375 .cindex "delivery" "problems with"
2376 If you encounter problems, look at Exim's log files (&'mainlog'& and
2377 &'paniclog'&) to see if there is any relevant information there. Another source
2378 of information is running Exim with debugging turned on, by specifying the
2379 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2380 with debugging turned on by a command of the form
2381 .display
2382 &`exim -d -M`& <&'exim-message-id'&>
2383 .endd
2384 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2385 produces rather a lot of output, but you can cut this down to specific areas.
2386 For example, if you use &%-d-all+route%& only the debugging information
2387 relevant to routing is included. (See the &%-d%& option in chapter
2388 &<<CHAPcommandline>>& for more details.)
2389
2390 .cindex '&"sticky"& bit'
2391 .cindex "lock files"
2392 One specific problem that has shown up on some sites is the inability to do
2393 local deliveries into a shared mailbox directory, because it does not have the
2394 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2395 writing to a mailbox file, and if it cannot create the lock file, the delivery
2396 is deferred. You can get round this either by setting the &"sticky bit"& on the
2397 directory, or by setting a specific group for local deliveries and allowing
2398 that group to create files in the directory (see the comments above the
2399 &(local_delivery)& transport in the default configuration file). Another
2400 approach is to configure Exim not to use lock files, but just to rely on
2401 &[fcntl()]& locking instead. However, you should do this only if all user
2402 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2403 see chapter &<<CHAPappendfile>>&.
2404
2405 One thing that cannot be tested on a system that is already running an MTA is
2406 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2407 &%-oX%& option can be used to run an Exim daemon that listens on some other
2408 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2409 &'exim_checkaccess'& utility can be used to check out policy controls on
2410 incoming SMTP mail.
2411
2412 Testing a new version on a system that is already running Exim can most easily
2413 be done by building a binary with a different CONFIGURE_FILE setting. From
2414 within the run time configuration, all other file and directory names
2415 that Exim uses can be altered, in order to keep it entirely clear of the
2416 production version.
2417
2418
2419 .section "Replacing another MTA with Exim" "SECID35"
2420 .cindex "replacing another MTA"
2421 Building and installing Exim for the first time does not of itself put it in
2422 general use. The name by which the system's MTA is called by mail user agents
2423 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2424 operating system), and it is necessary to make this name point to the &'exim'&
2425 binary in order to get the user agents to pass messages to Exim. This is
2426 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2427 or &_/usr/lib/sendmail_&
2428 .cindex "symbolic link" "to &'exim'& binary"
2429 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2430 privilege and executable status from the old MTA. It is then necessary to stop
2431 and restart the mailer daemon, if one is running.
2432
2433 .cindex "FreeBSD, MTA indirection"
2434 .cindex "&_/etc/mail/mailer.conf_&"
2435 Some operating systems have introduced alternative ways of switching MTAs. For
2436 example, if you are running FreeBSD, you need to edit the file
2437 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2438 described. A typical example of the contents of this file for running Exim is
2439 as follows:
2440 .code
2441 sendmail            /usr/exim/bin/exim
2442 send-mail           /usr/exim/bin/exim
2443 mailq               /usr/exim/bin/exim -bp
2444 newaliases          /usr/bin/true
2445 .endd
2446 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2447 your Exim installation is &"live"&. Check it by sending a message from your
2448 favourite user agent.
2449
2450 You should consider what to tell your users about the change of MTA. Exim may
2451 have different capabilities to what was previously running, and there are
2452 various operational differences such as the text of messages produced by
2453 command line options and in bounce messages. If you allow your users to make
2454 use of Exim's filtering capabilities, you should make the document entitled
2455 &'Exim's interface to mail filtering'& available to them.
2456
2457
2458
2459 .section "Upgrading Exim" "SECID36"
2460 .cindex "upgrading Exim"
2461 If you are already running Exim on your host, building and installing a new
2462 version automatically makes it available to MUAs, or any other programs that
2463 call the MTA directly. However, if you are running an Exim daemon, you do need
2464 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2465 new binary. You do not need to stop processing mail in order to install a new
2466 version of Exim. The install script does not modify an existing runtime
2467 configuration file.
2468
2469
2470
2471
2472 .section "Stopping the Exim daemon on Solaris" "SECID37"
2473 .cindex "Solaris" "stopping Exim on"
2474 The standard command for stopping the mailer daemon on Solaris is
2475 .code
2476 /etc/init.d/sendmail stop
2477 .endd
2478 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2479 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2480 for the text &"sendmail"&; this is not present because the actual program name
2481 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2482 solution is to replace the line that finds the process id with something like
2483 .code
2484 pid=`cat /var/spool/exim/exim-daemon.pid`
2485 .endd
2486 to obtain the daemon's pid directly from the file that Exim saves it in.
2487
2488 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2489 still be received from local processes, and if automatic delivery is configured
2490 (the normal case), deliveries will still occur.
2491
2492
2493
2494
2495 . ////////////////////////////////////////////////////////////////////////////
2496 . ////////////////////////////////////////////////////////////////////////////
2497
2498 .chapter "The Exim command line" "CHAPcommandline"
2499 .scindex IIDclo1 "command line" "options"
2500 .scindex IIDclo2 "options" "command line"
2501 Exim's command line takes the standard Unix form of a sequence of options,
2502 each starting with a hyphen character, followed by a number of arguments. The
2503 options are compatible with the main options of Sendmail, and there are also
2504 some additional options, some of which are compatible with Smail 3. Certain
2505 combinations of options do not make sense, and provoke an error if used.
2506 The form of the arguments depends on which options are set.
2507
2508
2509 .section "Setting options by program name" "SECID38"
2510 .cindex "&'mailq'&"
2511 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2512 were present before any other options.
2513 The &%-bp%& option requests a listing of the contents of the mail queue on the
2514 standard output.
2515 This feature is for compatibility with some systems that contain a command of
2516 that name in one of the standard libraries, symbolically linked to
2517 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2518
2519 .cindex "&'rsmtp'&"
2520 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2521 were present before any other options, for compatibility with Smail. The
2522 &%-bS%& option is used for reading in a number of messages in batched SMTP
2523 format.
2524
2525 .cindex "&'rmail'&"
2526 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2527 &%-oee%& options were present before any other options, for compatibility with
2528 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2529
2530 .cindex "&'runq'&"
2531 .cindex "queue runner"
2532 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2533 were present before any other options, for compatibility with Smail. The &%-q%&
2534 option causes a single queue runner process to be started.
2535
2536 .cindex "&'newaliases'&"
2537 .cindex "alias file" "building"
2538 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2539 If Exim is called under the name &'newaliases'& it behaves as if the option
2540 &%-bi%& were present before any other options, for compatibility with Sendmail.
2541 This option is used for rebuilding Sendmail's alias file. Exim does not have
2542 the concept of a single alias file, but can be configured to run a given
2543 command if called with the &%-bi%& option.
2544
2545
2546 .section "Trusted and admin users" "SECTtrustedadmin"
2547 Some Exim options are available only to &'trusted users'& and others are
2548 available only to &'admin users'&. In the description below, the phrases &"Exim
2549 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2550 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2551 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2552
2553 .ilist
2554 .cindex "trusted users" "definition of"
2555 .cindex "user" "trusted definition of"
2556 The trusted users are root, the Exim user, any user listed in the
2557 &%trusted_users%& configuration option, and any user whose current group or any
2558 supplementary group is one of those listed in the &%trusted_groups%&
2559 configuration option. Note that the Exim group is not automatically trusted.
2560
2561 .cindex '&"From"& line'
2562 .cindex "envelope sender"
2563 Trusted users are always permitted to use the &%-f%& option or a leading
2564 &"From&~"& line to specify the envelope sender of a message that is passed to
2565 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2566 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2567 users to set envelope senders.
2568
2569 .cindex "&'From:'& header line"
2570 .cindex "&'Sender:'& header line"
2571 For a trusted user, there is never any check on the contents of the &'From:'&
2572 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2573 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2574
2575 Trusted users may also specify a host name, host address, interface address,
2576 protocol name, ident value, and authentication data when submitting a message
2577 locally. Thus, they are able to insert messages into Exim's queue locally that
2578 have the characteristics of messages received from a remote host. Untrusted
2579 users may in some circumstances use &%-f%&, but can never set the other values
2580 that are available to trusted users.
2581 .next
2582 .cindex "user" "admin definition of"
2583 .cindex "admin user" "definition of"
2584 The admin users are root, the Exim user, and any user that is a member of the
2585 Exim group or of any group listed in the &%admin_groups%& configuration option.
2586 The current group does not have to be one of these groups.
2587
2588 Admin users are permitted to list the queue, and to carry out certain
2589 operations on messages, for example, to force delivery failures. It is also
2590 necessary to be an admin user in order to see the full information provided by
2591 the Exim monitor, and full debugging output.
2592
2593 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2594 Exim to attempt delivery of messages on its queue is restricted to admin users.
2595 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2596 option false (that is, specifying &%no_prod_requires_admin%&).
2597
2598 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2599 is restricted to admin users unless &%queue_list_requires_admin%& is set
2600 false.
2601 .endlist
2602
2603
2604 &*Warning*&: If you configure your system so that admin users are able to
2605 edit Exim's configuration file, you are giving those users an easy way of
2606 getting root. There is further discussion of this issue at the start of chapter
2607 &<<CHAPconf>>&.
2608
2609
2610
2611
2612 .section "Command line options" "SECID39"
2613 Exim's command line options are described in alphabetical order below. If none
2614 of the options that specifies a specific action (such as starting the daemon or
2615 a queue runner, or testing an address, or receiving a message in a specific
2616 format, or listing the queue) are present, and there is at least one argument
2617 on the command line, &%-bm%& (accept a local message on the standard input,
2618 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2619 outputs a brief message about itself and exits.
2620
2621 . ////////////////////////////////////////////////////////////////////////////
2622 . Insert a stylized XML comment here, to identify the start of the command line
2623 . options. This is for the benefit of the Perl script that automatically
2624 . creates a man page for the options.
2625 . ////////////////////////////////////////////////////////////////////////////
2626
2627 .literal xml
2628 <!-- === Start of command line options === -->
2629 .literal off
2630
2631
2632 .vlist
2633 .vitem &%--%&
2634 .oindex "--"
2635 .cindex "options" "command line; terminating"
2636 This is a pseudo-option whose only purpose is to terminate the options and
2637 therefore to cause subsequent command line items to be treated as arguments
2638 rather than options, even if they begin with hyphens.
2639
2640 .vitem &%--help%&
2641 .oindex "&%--help%&"
2642 This option causes Exim to output a few sentences stating what it is.
2643 The same output is generated if the Exim binary is called with no options and
2644 no arguments.
2645
2646 .new
2647 .vitem &%--version%&
2648 .oindex "&%--version%&"
2649 This option is an alias for &%-bV%& and causes version information to be
2650 displayed.
2651 .wen
2652
2653 .vitem &%-B%&<&'type'&>
2654 .oindex "&%-B%&"
2655 .cindex "8-bit characters"
2656 .cindex "Sendmail compatibility" "8-bit characters"
2657 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2658 clean; it ignores this option.
2659
2660 .vitem &%-bd%&
2661 .oindex "&%-bd%&"
2662 .cindex "daemon"
2663 .cindex "SMTP" "listener"
2664 .cindex "queue runner"
2665 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2666 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2667 that the daemon should also initiate periodic queue runs.
2668
2669 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2670 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2671 disconnect from the controlling terminal. When running this way, it can be
2672 stopped by pressing ctrl-C.
2673
2674 By default, Exim listens for incoming connections to the standard SMTP port on
2675 all the host's running interfaces. However, it is possible to listen on other
2676 ports, on multiple ports, and only on specific interfaces. Chapter
2677 &<<CHAPinterfaces>>& contains a description of the options that control this.
2678
2679 When a listening daemon
2680 .cindex "daemon" "process id (pid)"
2681 .cindex "pid (process id)" "of daemon"
2682 is started without the use of &%-oX%& (that is, without overriding the normal
2683 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2684 in Exim's spool directory. This location can be overridden by setting
2685 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2686 running as root.
2687
2688 When &%-oX%& is used on the command line to start a listening daemon, the
2689 process id is not written to the normal pid file path. However, &%-oP%& can be
2690 used to specify a path on the command line if a pid file is required.
2691
2692 The SIGHUP signal
2693 .cindex "SIGHUP"
2694 .cindex "daemon" "restarting"
2695 can be used to cause the daemon to re-execute itself. This should be done
2696 whenever Exim's configuration file, or any file that is incorporated into it by
2697 means of the &%.include%& facility, is changed, and also whenever a new version
2698 of Exim is installed. It is not necessary to do this when other files that are
2699 referenced from the configuration (for example, alias files) are changed,
2700 because these are reread each time they are used.
2701
2702 .vitem &%-bdf%&
2703 .oindex "&%-bdf%&"
2704 This option has the same effect as &%-bd%& except that it never disconnects
2705 from the controlling terminal, even when no debugging is specified.
2706
2707 .vitem &%-be%&
2708 .oindex "&%-be%&"
2709 .cindex "testing" "string expansion"
2710 .cindex "expansion" "testing"
2711 Run Exim in expansion testing mode. Exim discards its root privilege, to
2712 prevent ordinary users from using this mode to read otherwise inaccessible
2713 files. If no arguments are given, Exim runs interactively, prompting for lines
2714 of data. Otherwise, it processes each argument in turn.
2715
2716 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2717 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2718 used without command line arguments. If successful, it uses the &[readline()]&
2719 function, which provides extensive line-editing facilities, for reading the
2720 test data. A line history is supported.
2721
2722 Long expansion expressions can be split over several lines by using backslash
2723 continuations. As in Exim's run time configuration, white space at the start of
2724 continuation lines is ignored. Each argument or data line is passed through the
2725 string expansion mechanism, and the result is output. Variable values from the
2726 configuration file (for example, &$qualify_domain$&) are available, but no
2727 message-specific values (such as &$sender_domain$&) are set, because no message
2728 is being processed (but see &%-bem%& and &%-Mset%&).
2729
2730 &*Note*&: If you use this mechanism to test lookups, and you change the data
2731 files or databases you are using, you must exit and restart Exim before trying
2732 the same lookup again. Otherwise, because each Exim process caches the results
2733 of lookups, you will just get the same result as before.
2734
2735 .vitem &%-bem%&&~<&'filename'&>
2736 .oindex "&%-bem%&"
2737 .cindex "testing" "string expansion"
2738 .cindex "expansion" "testing"
2739 This option operates like &%-be%& except that it must be followed by the name
2740 of a file. For example:
2741 .code
2742 exim -bem /tmp/testmessage
2743 .endd
2744 The file is read as a message (as if receiving a locally-submitted non-SMTP
2745 message) before any of the test expansions are done. Thus, message-specific
2746 variables such as &$message_size$& and &$header_from:$& are available. However,
2747 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2748 recipients are read from the headers in the normal way, and are shown in the
2749 &$recipients$& variable. Note that recipients cannot be given on the command
2750 line, because further arguments are taken as strings to expand (just like
2751 &%-be%&).
2752
2753 .vitem &%-bF%&&~<&'filename'&>
2754 .oindex "&%-bF%&"
2755 .cindex "system filter" "testing"
2756 .cindex "testing" "system filter"
2757 This option is the same as &%-bf%& except that it assumes that the filter being
2758 tested is a system filter. The additional commands that are available only in
2759 system filters are recognized.
2760
2761 .vitem &%-bf%&&~<&'filename'&>
2762 .oindex "&%-bf%&"
2763 .cindex "filter" "testing"
2764 .cindex "testing" "filter file"
2765 .cindex "forward file" "testing"
2766 .cindex "testing" "forward file"
2767 .cindex "Sieve filter" "testing"
2768 This option runs Exim in user filter testing mode; the file is the filter file
2769 to be tested, and a test message must be supplied on the standard input. If
2770 there are no message-dependent tests in the filter, an empty file can be
2771 supplied.
2772
2773 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2774 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2775 filter and a user filter in the same run. For example:
2776 .code
2777 exim -bF /system/filter -bf /user/filter </test/message
2778 .endd
2779 This is helpful when the system filter adds header lines or sets filter
2780 variables that are used by the user filter.
2781
2782 If the test filter file does not begin with one of the special lines
2783 .code
2784 # Exim filter
2785 # Sieve filter
2786 .endd
2787 it is taken to be a normal &_.forward_& file, and is tested for validity under
2788 that interpretation. See sections &<<SECTitenonfilred>>& to
2789 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2790 redirection lists.
2791
2792 The result of an Exim command that uses &%-bf%&, provided no errors are
2793 detected, is a list of the actions that Exim would try to take if presented
2794 with the message for real. More details of filter testing are given in the
2795 separate document entitled &'Exim's interfaces to mail filtering'&.
2796
2797 When testing a filter file,
2798 .cindex "&""From""& line"
2799 .cindex "envelope sender"
2800 .oindex "&%-f%&" "for filter testing"
2801 the envelope sender can be set by the &%-f%& option,
2802 or by a &"From&~"& line at the start of the test message. Various parameters
2803 that would normally be taken from the envelope recipient address of the message
2804 can be set by means of additional command line options (see the next four
2805 options).
2806
2807 .vitem &%-bfd%&&~<&'domain'&>
2808 .oindex "&%-bfd%&"
2809 .vindex "&$qualify_domain$&"
2810 This sets the domain of the recipient address when a filter file is being
2811 tested by means of the &%-bf%& option. The default is the value of
2812 &$qualify_domain$&.
2813
2814 .vitem &%-bfl%&&~<&'local&~part'&>
2815 .oindex "&%-bfl%&"
2816 This sets the local part of the recipient address when a filter file is being
2817 tested by means of the &%-bf%& option. The default is the username of the
2818 process that calls Exim. A local part should be specified with any prefix or
2819 suffix stripped, because that is how it appears to the filter when a message is
2820 actually being delivered.
2821
2822 .vitem &%-bfp%&&~<&'prefix'&>
2823 .oindex "&%-bfp%&"
2824 This sets the prefix of the local part of the recipient address when a filter
2825 file is being tested by means of the &%-bf%& option. The default is an empty
2826 prefix.
2827
2828 .vitem &%-bfs%&&~<&'suffix'&>
2829 .oindex "&%-bfs%&"
2830 This sets the suffix of the local part of the recipient address when a filter
2831 file is being tested by means of the &%-bf%& option. The default is an empty
2832 suffix.
2833
2834 .vitem &%-bh%&&~<&'IP&~address'&>
2835 .oindex "&%-bh%&"
2836 .cindex "testing" "incoming SMTP"
2837 .cindex "SMTP" "testing incoming"
2838 .cindex "testing" "relay control"
2839 .cindex "relaying" "testing configuration"
2840 .cindex "policy control" "testing"
2841 .cindex "debugging" "&%-bh%& option"
2842 This option runs a fake SMTP session as if from the given IP address, using the
2843 standard input and output. The IP address may include a port number at the end,
2844 after a full stop. For example:
2845 .code
2846 exim -bh 10.9.8.7.1234
2847 exim -bh fe80::a00:20ff:fe86:a061.5678
2848 .endd
2849 When an IPv6 address is given, it is converted into canonical form. In the case
2850 of the second example above, the value of &$sender_host_address$& after
2851 conversion to the canonical form is
2852 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2853
2854 Comments as to what is going on are written to the standard error file. These
2855 include lines beginning with &"LOG"& for anything that would have been logged.
2856 This facility is provided for testing configuration options for incoming
2857 messages, to make sure they implement the required policy. For example, you can
2858 test your relay controls using &%-bh%&.
2859
2860 &*Warning 1*&:
2861 .cindex "RFC 1413"
2862 You can test features of the configuration that rely on ident (RFC 1413)
2863 information by using the &%-oMt%& option. However, Exim cannot actually perform
2864 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2865 connection.
2866
2867 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2868 are also skipped when testing using &%-bh%&. If you want these callouts to
2869 occur, use &%-bhc%& instead.
2870
2871 Messages supplied during the testing session are discarded, and nothing is
2872 written to any of the real log files. There may be pauses when DNS (and other)
2873 lookups are taking place, and of course these may time out. The &%-oMi%& option
2874 can be used to specify a specific IP interface and port if this is important,
2875 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2876 session were authenticated.
2877
2878 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2879 output just states whether a given recipient address from a given host is
2880 acceptable or not. See section &<<SECTcheckaccess>>&.
2881
2882 Features such as authentication and encryption, where the client input is not
2883 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2884 specialized SMTP test program such as
2885 &url(http://jetmore.org/john/code/#swaks,swaks).
2886
2887 .vitem &%-bhc%&&~<&'IP&~address'&>
2888 .oindex "&%-bhc%&"
2889 This option operates in the same way as &%-bh%&, except that address
2890 verification callouts are performed if required. This includes consulting and
2891 updating the callout cache database.
2892
2893 .vitem &%-bi%&
2894 .oindex "&%-bi%&"
2895 .cindex "alias file" "building"
2896 .cindex "building alias file"
2897 .cindex "Sendmail compatibility" "&%-bi%& option"
2898 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2899 Exim does not have the concept of a single alias file, and so it cannot mimic
2900 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2901 tend to appear in various scripts such as NIS make files, so the option must be
2902 recognized.
2903
2904 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2905 configuration option is run, under the uid and gid of the caller of Exim. If
2906 the &%-oA%& option is used, its value is passed to the command as an argument.
2907 The command set by &%bi_command%& may not contain arguments. The command can
2908 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2909 if this is required. If the &%bi_command%& option is not set, calling Exim with
2910 &%-bi%& is a no-op.
2911
2912 .vitem &%-bm%&
2913 .oindex "&%-bm%&"
2914 .cindex "local message reception"
2915 This option runs an Exim receiving process that accepts an incoming,
2916 locally-generated message on the current input. The recipients are given as the
2917 command arguments (except when &%-t%& is also present &-- see below). Each
2918 argument can be a comma-separated list of RFC 2822 addresses. This is the
2919 default option for selecting the overall action of an Exim call; it is assumed
2920 if no other conflicting option is present.
2921
2922 If any addresses in the message are unqualified (have no domain), they are
2923 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
2924 options, as appropriate. The &%-bnq%& option (see below) provides a way of
2925 suppressing this for special cases.
2926
2927 Policy checks on the contents of local messages can be enforced by means of
2928 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
2929
2930 .cindex "return code" "for &%-bm%&"
2931 The return code is zero if the message is successfully accepted. Otherwise, the
2932 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
2933
2934 The format
2935 .cindex "message" "format"
2936 .cindex "format" "message"
2937 .cindex "&""From""& line"
2938 .cindex "UUCP" "&""From""& line"
2939 .cindex "Sendmail compatibility" "&""From""& line"
2940 of the message must be as defined in RFC 2822, except that, for
2941 compatibility with Sendmail and Smail, a line in one of the forms
2942 .code
2943 From sender Fri Jan  5 12:55 GMT 1997
2944 From sender Fri, 5 Jan 97 12:55:01
2945 .endd
2946 (with the weekday optional, and possibly with additional text after the date)
2947 is permitted to appear at the start of the message. There appears to be no
2948 authoritative specification of the format of this line. Exim recognizes it by
2949 matching against the regular expression defined by the &%uucp_from_pattern%&
2950 option, which can be changed if necessary.
2951
2952 .oindex "&%-f%&" "overriding &""From""& line"
2953 The specified sender is treated as if it were given as the argument to the
2954 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
2955 preference to the address taken from the message. The caller of Exim must be a
2956 trusted user for the sender of a message to be set in this way.
2957
2958 .vitem &%-bnq%&
2959 .oindex "&%-bnq%&"
2960 .cindex "address qualification, suppressing"
2961 By default, Exim automatically qualifies unqualified addresses (those
2962 without domains) that appear in messages that are submitted locally (that
2963 is, not over TCP/IP). This qualification applies both to addresses in
2964 envelopes, and addresses in header lines. Sender addresses are qualified using
2965 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
2966 defaults to the value of &%qualify_domain%&).
2967
2968 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
2969 being used to re-submit messages that originally came from remote hosts after
2970 content scanning, you probably do not want to qualify unqualified addresses in
2971 header lines. (Such lines will be present only if you have not enabled a header
2972 syntax check in the appropriate ACL.)
2973
2974 The &%-bnq%& option suppresses all qualification of unqualified addresses in
2975 messages that originate on the local host. When this is used, unqualified
2976 addresses in the envelope provoke errors (causing message rejection) and
2977 unqualified addresses in header lines are left alone.
2978
2979
2980 .vitem &%-bP%&
2981 .oindex "&%-bP%&"
2982 .cindex "configuration options" "extracting"
2983 .cindex "options" "configuration &-- extracting"
2984 If this option is given with no arguments, it causes the values of all Exim's
2985 main configuration options to be written to the standard output. The values
2986 of one or more specific options can be requested by giving their names as
2987 arguments, for example:
2988 .code
2989 exim -bP qualify_domain hold_domains
2990 .endd
2991 .cindex "hiding configuration option values"
2992 .cindex "configuration options" "hiding value of"
2993 .cindex "options" "hiding value of"
2994 However, any option setting that is preceded by the word &"hide"& in the
2995 configuration file is not shown in full, except to an admin user. For other
2996 users, the output is as in this example:
2997 .code
2998 mysql_servers = <value not displayable>
2999 .endd
3000 If &%configure_file%& is given as an argument, the name of the run time
3001 configuration file is output.
3002 If a list of configuration files was supplied, the value that is output here
3003 is the name of the file that was actually used.
3004
3005 .cindex "daemon" "process id (pid)"
3006 .cindex "pid (process id)" "of daemon"
3007 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3008 directories where log files and daemon pid files are written are output,
3009 respectively. If these values are unset, log files are written in a
3010 sub-directory of the spool directory called &%log%&, and the pid file is
3011 written directly into the spool directory.
3012
3013 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3014 .code
3015 exim -bP +local_domains
3016 .endd
3017 it searches for a matching named list of any type (domain, host, address, or
3018 local part) and outputs what it finds.
3019
3020 .cindex "options" "router &-- extracting"
3021 .cindex "options" "transport &-- extracting"
3022 .cindex "options" "authenticator &-- extracting"
3023 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3024 followed by the name of an appropriate driver instance, the option settings for
3025 that driver are output. For example:
3026 .code
3027 exim -bP transport local_delivery
3028 .endd
3029 The generic driver options are output first, followed by the driver's private
3030 options. A list of the names of drivers of a particular type can be obtained by
3031 using one of the words &%router_list%&, &%transport_list%&, or
3032 &%authenticator_list%&, and a complete list of all drivers with their option
3033 settings can be obtained by using &%routers%&, &%transports%&, or
3034 &%authenticators%&.
3035
3036 .cindex "options" "macro &-- extracting"
3037 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3038 are available, similarly to the drivers.  Because macros are sometimes used
3039 for storing passwords, this option is restricted.
3040 The output format is one item per line.
3041
3042 .vitem &%-bp%&
3043 .oindex "&%-bp%&"
3044 .cindex "queue" "listing messages on"
3045 .cindex "listing" "messages on the queue"
3046 This option requests a listing of the contents of the mail queue on the
3047 standard output. If the &%-bp%& option is followed by a list of message ids,
3048 just those messages are listed. By default, this option can be used only by an
3049 admin user. However, the &%queue_list_requires_admin%& option can be set false
3050 to allow any user to see the queue.
3051
3052 Each message on the queue is displayed as in the following example:
3053 .code
3054 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3055           red.king@looking-glass.fict.example
3056           <other addresses>
3057 .endd
3058 .cindex "message" "size in queue listing"
3059 .cindex "size" "of message"
3060 The first line contains the length of time the message has been on the queue
3061 (in this case 25 minutes), the size of the message (2.9K), the unique local
3062 identifier for the message, and the message sender, as contained in the
3063 envelope. For bounce messages, the sender address is empty, and appears as
3064 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3065 the default sender address, the user's login name is shown in parentheses
3066 before the sender address.
3067
3068 .cindex "frozen messages" "in queue listing"
3069 If the message is frozen (attempts to deliver it are suspended) then the text
3070 &"*** frozen ***"& is displayed at the end of this line.
3071
3072 The recipients of the message (taken from the envelope, not the headers) are
3073 displayed on subsequent lines. Those addresses to which the message has already
3074 been delivered are marked with the letter D. If an original address gets
3075 expanded into several addresses via an alias or forward file, the original is
3076 displayed with a D only when deliveries for all of its child addresses are
3077 complete.
3078
3079
3080 .vitem &%-bpa%&
3081 .oindex "&%-bpa%&"
3082 This option operates like &%-bp%&, but in addition it shows delivered addresses
3083 that were generated from the original top level address(es) in each message by
3084 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3085 of just &"D"&.
3086
3087
3088 .vitem &%-bpc%&
3089 .oindex "&%-bpc%&"
3090 .cindex "queue" "count of messages on"
3091 This option counts the number of messages on the queue, and writes the total
3092 to the standard output. It is restricted to admin users, unless
3093 &%queue_list_requires_admin%& is set false.
3094
3095
3096 .vitem &%-bpr%&
3097 .oindex "&%-bpr%&"
3098 This option operates like &%-bp%&, but the output is not sorted into
3099 chronological order of message arrival. This can speed it up when there are
3100 lots of messages on the queue, and is particularly useful if the output is
3101 going to be post-processed in a way that doesn't need the sorting.
3102
3103 .vitem &%-bpra%&
3104 .oindex "&%-bpra%&"
3105 This option is a combination of &%-bpr%& and &%-bpa%&.
3106
3107 .vitem &%-bpru%&
3108 .oindex "&%-bpru%&"
3109 This option is a combination of &%-bpr%& and &%-bpu%&.
3110
3111
3112 .vitem &%-bpu%&
3113 .oindex "&%-bpu%&"
3114 This option operates like &%-bp%& but shows only undelivered top-level
3115 addresses for each message displayed. Addresses generated by aliasing or
3116 forwarding are not shown, unless the message was deferred after processing by a
3117 router with the &%one_time%& option set.
3118
3119
3120 .vitem &%-brt%&
3121 .oindex "&%-brt%&"
3122 .cindex "testing" "retry configuration"
3123 .cindex "retry" "configuration testing"
3124 This option is for testing retry rules, and it must be followed by up to three
3125 arguments. It causes Exim to look for a retry rule that matches the values
3126 and to write it to the standard output. For example:
3127 .code
3128 exim -brt bach.comp.mus.example
3129 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3130 .endd
3131 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3132 argument, which is required, can be a complete address in the form
3133 &'local_part@domain'&, or it can be just a domain name. If the second argument
3134 contains a dot, it is interpreted as an optional second domain name; if no
3135 retry rule is found for the first argument, the second is tried. This ties in
3136 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3137 rule is found that matches the host, one that matches the mail domain is
3138 sought. Finally, an argument that is the name of a specific delivery error, as
3139 used in setting up retry rules, can be given. For example:
3140 .code
3141 exim -brt haydn.comp.mus.example quota_3d
3142 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3143 .endd
3144
3145 .vitem &%-brw%&
3146 .oindex "&%-brw%&"
3147 .cindex "testing" "rewriting"
3148 .cindex "rewriting" "testing"
3149 This option is for testing address rewriting rules, and it must be followed by
3150 a single argument, consisting of either a local part without a domain, or a
3151 complete address with a fully qualified domain. Exim outputs how this address
3152 would be rewritten for each possible place it might appear. See chapter
3153 &<<CHAPrewrite>>& for further details.
3154
3155 .vitem &%-bS%&
3156 .oindex "&%-bS%&"
3157 .cindex "SMTP" "batched incoming"
3158 .cindex "batched SMTP input"
3159 This option is used for batched SMTP input, which is an alternative interface
3160 for non-interactive local message submission. A number of messages can be
3161 submitted in a single run. However, despite its name, this is not really SMTP
3162 input. Exim reads each message's envelope from SMTP commands on the standard
3163 input, but generates no responses. If the caller is trusted, or
3164 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3165 believed; otherwise the sender is always the caller of Exim.
3166
3167 The message itself is read from the standard input, in SMTP format (leading
3168 dots doubled), terminated by a line containing just a single dot. An error is
3169 provoked if the terminating dot is missing. A further message may then follow.
3170
3171 As for other local message submissions, the contents of incoming batch SMTP
3172 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3173 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3174 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3175
3176 Some other SMTP commands are recognized in the input. HELO and EHLO act
3177 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3178 QUIT quits, ignoring the rest of the standard input.
3179
3180 .cindex "return code" "for &%-bS%&"
3181 If any error is encountered, reports are written to the standard output and
3182 error streams, and Exim gives up immediately. The return code is 0 if no error
3183 was detected; it is 1 if one or more messages were accepted before the error
3184 was detected; otherwise it is 2.
3185
3186 More details of input using batched SMTP are given in section
3187 &<<SECTincomingbatchedSMTP>>&.
3188
3189 .vitem &%-bs%&
3190 .oindex "&%-bs%&"
3191 .cindex "SMTP" "local input"
3192 .cindex "local SMTP input"
3193 This option causes Exim to accept one or more messages by reading SMTP commands
3194 on the standard input, and producing SMTP replies on the standard output. SMTP
3195 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3196 Some user agents use this interface as a way of passing locally-generated
3197 messages to the MTA.
3198
3199 In
3200 .cindex "sender" "source of"
3201 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3202 set, the senders of messages are taken from the SMTP MAIL commands.
3203 Otherwise the content of these commands is ignored and the sender is set up as
3204 the calling user. Unqualified addresses are automatically qualified using
3205 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3206 &%-bnq%& option is used.
3207
3208 .cindex "inetd"
3209 The
3210 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3211 using a listening daemon. Exim can distinguish the two cases by checking
3212 whether the standard input is a TCP/IP socket. When Exim is called from
3213 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3214 above concerning senders and qualification do not apply. In this situation,
3215 Exim behaves in exactly the same way as it does when receiving a message via
3216 the listening daemon.
3217
3218 .new
3219 .vitem &%-bmalware%&&~<&'filename'&>
3220 .oindex "&%-bmalware%&"
3221 .cindex "testing", "malware"
3222 .cindex "malware scan test"
3223 This debugging option causes Exim to scan the given file,
3224 using the malware scanning framework.  The option of &%av_scanner%& influences
3225 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3226 the expansion should have defaults which apply to this invocation.  ACLs are
3227 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3228 will never be populated and &%-bmalware%& will fail.
3229
3230 Exim will have changed working directory before resolving the filename, so
3231 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3232 user when it tries to open the file, rather than as the invoking user.
3233 This option requires admin privileges.
3234
3235 The &%-bmalware%& option will not be extended to be more generally useful,
3236 there are better tools for file-scanning.  This option exists to help
3237 administrators verify their Exim and AV scanner configuration.
3238 .wen
3239
3240 .vitem &%-bt%&
3241 .oindex "&%-bt%&"
3242 .cindex "testing" "addresses"
3243 .cindex "address" "testing"
3244 This option runs Exim in address testing mode, in which each argument is taken
3245 as a recipient address to be tested for deliverability. The results are
3246 written to the standard output. If a test fails, and the caller is not an admin
3247 user, no details of the failure are output, because these might contain
3248 sensitive information such as usernames and passwords for database lookups.
3249
3250 If no arguments are given, Exim runs in an interactive manner, prompting with a
3251 right angle bracket for addresses to be tested.
3252
3253 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3254 &[readline()]& function, because it is running as &'root'& and there are
3255 security issues.
3256
3257 Each address is handled as if it were the recipient address of a message
3258 (compare the &%-bv%& option). It is passed to the routers and the result is
3259 written to the standard output. However, any router that has
3260 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3261 genuine routing tests if your first router passes everything to a scanner
3262 program.
3263
3264 .cindex "return code" "for &%-bt%&"
3265 The return code is 2 if any address failed outright; it is 1 if no address
3266 failed outright but at least one could not be resolved for some reason. Return
3267 code 0 is given only when all addresses succeed.
3268
3269 .cindex "duplicate addresses"
3270 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3271 addresses after routing is complete, so that only one delivery takes place.
3272 This does not happen when testing with &%-bt%&; the full results of routing are
3273 always shown.
3274
3275 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3276 routers in the configuration makes any tests on the sender address of a
3277 message,
3278 .oindex "&%-f%&" "for address testing"
3279 you can use the &%-f%& option to set an appropriate sender when running
3280 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3281 default qualifying domain. However, if you have set up (for example) routers
3282 whose behaviour depends on the contents of an incoming message, you cannot test
3283 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3284 doing such tests.
3285
3286 .new
3287 .vitem &%-bV%&
3288 .oindex "&%-bV%&"
3289 .cindex "version number of Exim"
3290 This option causes Exim to write the current version number, compilation
3291 number, and compilation date of the &'exim'& binary to the standard output.
3292 It also lists the DBM library that is being used, the optional modules (such as
3293 specific lookup types), the drivers that are included in the binary, and the
3294 name of the run time configuration file that is in use.
3295 .wen
3296 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3297 configuration file. However, this is a static check only. It cannot check
3298 values that are to be expanded. For example, although a misspelt ACL verb is
3299 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3300 alone to discover (for example) all the typos in the configuration; some
3301 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3302 dynamic testing facilities.
3303
3304 .vitem &%-bv%&
3305 .oindex "&%-bv%&"
3306 .cindex "verifying address" "using &%-bv%&"
3307 .cindex "address" "verification"
3308 This option runs Exim in address verification mode, in which each argument is
3309 taken as a recipient address to be verified by the routers. (This does
3310 not involve any verification callouts). During normal operation, verification
3311 happens mostly as a consequence processing a &%verify%& condition in an ACL
3312 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3313 including callouts, see the &%-bh%& and &%-bhc%& options.
3314
3315 If verification fails, and the caller is not an admin user, no details of the
3316 failure are output, because these might contain sensitive information such as
3317 usernames and passwords for database lookups.
3318
3319 If no arguments are given, Exim runs in an interactive manner, prompting with a
3320 right angle bracket for addresses to be verified.
3321
3322 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3323 &[readline()]& function, because it is running as &'exim'& and there are
3324 security issues.
3325
3326 Verification differs from address testing (the &%-bt%& option) in that routers
3327 that have &%no_verify%& set are skipped, and if the address is accepted by a
3328 router that has &%fail_verify%& set, verification fails. The address is
3329 verified as a recipient if &%-bv%& is used; to test verification for a sender
3330 address, &%-bvs%& should be used.
3331
3332 If the &%-v%& option is not set, the output consists of a single line for each
3333 address, stating whether it was verified or not, and giving a reason in the
3334 latter case. Without &%-v%&, generating more than one address by redirection
3335 causes verification to end successfully, without considering the generated
3336 addresses. However, if just one address is generated, processing continues,
3337 and the generated address must verify successfully for the overall verification
3338 to succeed.
3339
3340 When &%-v%& is set, more details are given of how the address has been handled,
3341 and in the case of address redirection, all the generated addresses are also
3342 considered. Verification may succeed for some and fail for others.
3343
3344 The
3345 .cindex "return code" "for &%-bv%&"
3346 return code is 2 if any address failed outright; it is 1 if no address
3347 failed outright but at least one could not be resolved for some reason. Return
3348 code 0 is given only when all addresses succeed.
3349
3350 If any of the routers in the configuration makes any tests on the sender
3351 address of a message, you should use the &%-f%& option to set an appropriate
3352 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3353 calling user at the default qualifying domain.
3354
3355 .vitem &%-bvs%&
3356 .oindex "&%-bvs%&"
3357 This option acts like &%-bv%&, but verifies the address as a sender rather
3358 than a recipient address. This affects any rewriting and qualification that
3359 might happen.
3360
3361 .vitem &%-C%&&~<&'filelist'&>
3362 .oindex "&%-C%&"
3363 .cindex "configuration file" "alternate"
3364 .cindex "CONFIGURE_FILE"
3365 .cindex "alternate configuration file"
3366 This option causes Exim to find the run time configuration file from the given
3367 list instead of from the list specified by the CONFIGURE_FILE
3368 compile-time setting. Usually, the list will consist of just a single file
3369 name, but it can be a colon-separated list of names. In this case, the first
3370 file that exists is used. Failure to open an existing file stops Exim from
3371 proceeding any further along the list, and an error is generated.
3372
3373 .new
3374 When this option is used by a caller other than root, and the list is different
3375 from the compiled-in list, Exim gives up its root privilege immediately, and
3376 runs with the real and effective uid and gid set to those of the caller.
3377 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3378 file contains a list of full pathnames, one per line, for configuration files
3379 which are trusted. Root privilege is retained for any configuration file so
3380 listed, as long as the caller is the Exim user (or the user specified in the
3381 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3382 not writeable by inappropriate users or groups.
3383
3384 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3385 configuration using &%-C%& right through message reception and delivery,
3386 even if the caller is root. The reception works, but by that time, Exim is
3387 running as the Exim user, so when it re-executes to regain privilege for the
3388 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3389 test reception and delivery using two separate commands (one to put a message
3390 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3391 .wen
3392 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3393 prefix string with which any file named in a &%-C%& command line option
3394 must start. In addition, the file name must not contain the sequence &`/../`&.
3395 However, if the value of the &%-C%& option is identical to the value of
3396 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3397 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3398 unset, any file name can be used with &%-C%&.
3399
3400 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3401 to a directory to which only root has access. This prevents someone who has
3402 broken into the Exim account from running a privileged Exim with an arbitrary
3403 configuration file.
3404
3405 The &%-C%& facility is useful for ensuring that configuration files are
3406 syntactically correct, but cannot be used for test deliveries, unless the
3407 caller is privileged, or unless it is an exotic configuration that does not
3408 require privilege. No check is made on the owner or group of the files
3409 specified by this option.
3410
3411
3412 .vitem &%-D%&<&'macro'&>=<&'value'&>
3413 .oindex "&%-D%&"
3414 .cindex "macro" "setting on command line"
3415 This option can be used to override macro definitions in the configuration file
3416 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3417 unprivileged caller, it causes Exim to give up its root privilege.
3418 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3419 completely disabled, and its use causes an immediate error exit.
3420
3421 .new
3422 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3423 colon-separated list of macros which are considered safe and, if &%-D%& only
3424 supplies macros from this list, and the values are acceptable, then Exim will
3425 not give up root privilege if the caller is root, the Exim run-time user, or
3426 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3427 to be removed in the future.  Acceptable values for the macros satisfy the
3428 regexp: &`^[A-Za-z0-9_/.-]*$`&
3429 .wen
3430 The entire option (including equals sign if present) must all be within one
3431 command line item. &%-D%& can be used to set the value of a macro to the empty
3432 string, in which case the equals sign is optional. These two commands are
3433 synonymous:
3434 .code
3435 exim -DABC  ...
3436 exim -DABC= ...
3437 .endd
3438 To include spaces in a macro definition item, quotes must be used. If you use
3439 quotes, spaces are permitted around the macro name and the equals sign. For
3440 example:
3441 .code
3442 exim '-D ABC = something' ...
3443 .endd
3444 &%-D%& may be repeated up to 10 times on a command line.
3445
3446
3447 .vitem &%-d%&<&'debug&~options'&>
3448 .oindex "&%-d%&"
3449 .cindex "debugging" "list of selectors"
3450 .cindex "debugging" "&%-d%& option"
3451 This option causes debugging information to be written to the standard
3452 error stream. It is restricted to admin users because debugging output may show
3453 database queries that contain password information. Also, the details of users'
3454 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3455 writes an error message to the standard error stream and exits with a non-zero
3456 return code.
3457
3458 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3459 standard debugging data is output. This can be reduced, or increased to include
3460 some more rarely needed information, by directly following &%-d%& with a string
3461 made up of names preceded by plus or minus characters. These add or remove sets
3462 of debugging data, respectively. For example, &%-d+filter%& adds filter
3463 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3464 no spaces are allowed in the debug setting. The available debugging categories
3465 are:
3466 .display
3467 &`acl            `& ACL interpretation
3468 &`auth           `& authenticators
3469 &`deliver        `& general delivery logic
3470 &`dns            `& DNS lookups (see also resolver)
3471 &`dnsbl          `& DNS black list (aka RBL) code
3472 &`exec           `& arguments for &[execv()]& calls
3473 &`expand         `& detailed debugging for string expansions
3474 &`filter         `& filter handling
3475 &`hints_lookup   `& hints data lookups
3476 &`host_lookup    `& all types of name-to-IP address handling
3477 &`ident          `& ident lookup
3478 &`interface      `& lists of local interfaces
3479 &`lists          `& matching things in lists
3480 &`load           `& system load checks
3481 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3482                     &<<CHAPlocalscan>>&)
3483 &`lookup         `& general lookup code and all lookups
3484 &`memory         `& memory handling
3485 &`pid            `& add pid to debug output lines
3486 &`process_info   `& setting info for the process log
3487 &`queue_run      `& queue runs
3488 &`receive        `& general message reception logic
3489 &`resolver       `& turn on the DNS resolver's debugging output
3490 &`retry          `& retry handling
3491 &`rewrite        `& address rewriting
3492 &`route          `& address routing
3493 &`timestamp      `& add timestamp to debug output lines
3494 &`tls            `& TLS logic
3495 &`transport      `& transports
3496 &`uid            `& changes of uid/gid and looking up uid/gid
3497 &`verify         `& address verification logic
3498 &`all            `& almost all of the above (see below), and also &%-v%&
3499 .endd
3500 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3501 for &`-all`&. The reason for this is that &`+all`& is something that people
3502 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3503 is included, an awful lot of output that is very rarely of interest is
3504 generated, so it now has to be explicitly requested. However, &`-all`& does
3505 turn everything off.
3506
3507 .cindex "resolver, debugging output"
3508 .cindex "DNS resolver, debugging output"
3509 The &`resolver`& option produces output only if the DNS resolver was compiled
3510 with DEBUG enabled. This is not the case in some operating systems. Also,
3511 unfortunately, debugging output from the DNS resolver is written to stdout
3512 rather than stderr.
3513
3514 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3515 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3516 However, the &`pid`& selector is forced when debugging is turned on for a
3517 daemon, which then passes it on to any re-executed Exims. Exim also
3518 automatically adds the pid to debug lines when several remote deliveries are
3519 run in parallel.
3520
3521 The &`timestamp`& selector causes the current time to be inserted at the start
3522 of all debug output lines. This can be useful when trying to track down delays
3523 in processing.
3524
3525 If the &%debug_print%& option is set in any driver, it produces output whenever
3526 any debugging is selected, or if &%-v%& is used.
3527
3528 .vitem &%-dd%&<&'debug&~options'&>
3529 .oindex "&%-dd%&"
3530 This option behaves exactly like &%-d%& except when used on a command that
3531 starts a daemon process. In that case, debugging is turned off for the
3532 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3533 behaviour of the daemon without creating as much output as full debugging does.
3534
3535 .vitem &%-dropcr%&
3536 .oindex "&%-dropcr%&"
3537 This is an obsolete option that is now a no-op. It used to affect the way Exim
3538 handled CR and LF characters in incoming messages. What happens now is
3539 described in section &<<SECTlineendings>>&.
3540
3541 .vitem &%-E%&
3542 .oindex "&%-E%&"
3543 .cindex "bounce message" "generating"
3544 This option specifies that an incoming message is a locally-generated delivery
3545 failure report. It is used internally by Exim when handling delivery failures
3546 and is not intended for external use. Its only effect is to stop Exim
3547 generating certain messages to the postmaster, as otherwise message cascades
3548 could occur in some situations. As part of the same option, a message id may
3549 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3550 new message contains the id, following &"R="&, as a cross-reference.
3551
3552 .vitem &%-e%&&'x'&
3553 .oindex "&%-e%&&'x'&"
3554 There are a number of Sendmail options starting with &%-oe%& which seem to be
3555 called by various programs without the leading &%o%& in the option. For
3556 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3557 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3558
3559 .vitem &%-F%&&~<&'string'&>
3560 .oindex "&%-F%&"
3561 .cindex "sender" "name"
3562 .cindex "name" "of sender"
3563 This option sets the sender's full name for use when a locally-generated
3564 message is being accepted. In the absence of this option, the user's &'gecos'&
3565 entry from the password data is used. As users are generally permitted to alter
3566 their &'gecos'& entries, no security considerations are involved. White space
3567 between &%-F%& and the <&'string'&> is optional.
3568
3569 .vitem &%-f%&&~<&'address'&>
3570 .oindex "&%-f%&"
3571 .cindex "sender" "address"
3572 .cindex "address" "sender"
3573 .cindex "trusted users"
3574 .cindex "envelope sender"
3575 .cindex "user" "trusted"
3576 This option sets the address of the envelope sender of a locally-generated
3577 message (also known as the return path). The option can normally be used only
3578 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3579 users to use it.
3580
3581 Processes running as root or the Exim user are always trusted. Other
3582 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3583 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3584 of a local message is set to the caller's login name at the default qualify
3585 domain.
3586
3587 There is one exception to the restriction on the use of &%-f%&: an empty sender
3588 can be specified by any user, trusted or not, to create a message that can
3589 never provoke a bounce. An empty sender can be specified either as an empty
3590 string, or as a pair of angle brackets with nothing between them, as in these
3591 examples of shell commands:
3592 .code
3593 exim -f '<>' user@domain
3594 exim -f "" user@domain
3595 .endd
3596 In addition, the use of &%-f%& is not restricted when testing a filter file
3597 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3598 &%-bv%& options.
3599
3600 Allowing untrusted users to change the sender address does not of itself make
3601 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3602 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3603 though this can be overridden by setting &%no_local_from_check%&.
3604
3605 White
3606 .cindex "&""From""& line"
3607 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3608 given as two arguments or one combined argument). The sender of a
3609 locally-generated message can also be set (when permitted) by an initial
3610 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3611 if &%-f%& is also present, it overrides &"From&~"&.
3612
3613 .vitem &%-G%&
3614 .oindex "&%-G%&"
3615 .cindex "Sendmail compatibility" "&%-G%& option ignored"
3616 This is a Sendmail option which is ignored by Exim.
3617
3618 .vitem &%-h%&&~<&'number'&>
3619 .oindex "&%-h%&"
3620 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3621 This option is accepted for compatibility with Sendmail, but has no effect. (In
3622 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3623 headers.)
3624
3625 .vitem &%-i%&
3626 .oindex "&%-i%&"
3627 .cindex "Solaris" "&'mail'& command"
3628 .cindex "dot" "in incoming non-SMTP message"
3629 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3630 line by itself should not terminate an incoming, non-SMTP message. I can find
3631 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3632 command in Solaris 2.4 uses it. See also &%-ti%&.
3633
3634 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3635 .oindex "&%-M%&"
3636 .cindex "forcing delivery"
3637 .cindex "delivery" "forcing attempt"
3638 .cindex "frozen messages" "forcing delivery"
3639 This option requests Exim to run a delivery attempt on each message in turn. If
3640 any of the messages are frozen, they are automatically thawed before the
3641 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3642 and &%hold_domains%& are ignored.
3643
3644 Retry
3645 .cindex "hints database" "overriding retry hints"
3646 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3647 the normal retry time has not yet been reached. This option requires the caller
3648 to be an admin user. However, there is an option called &%prod_requires_admin%&
3649 which can be set false to relax this restriction (and also the same requirement
3650 for the &%-q%&, &%-R%&, and &%-S%& options).
3651
3652 The deliveries happen synchronously, that is, the original Exim process does
3653 not terminate until all the delivery attempts have finished. No output is
3654 produced unless there is a serious error. If you want to see what is happening,
3655 use the &%-v%& option as well, or inspect Exim's main log.
3656
3657 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3658 .oindex "&%-Mar%&"
3659 .cindex "message" "adding recipients"
3660 .cindex "recipient" "adding"
3661 This option requests Exim to add the addresses to the list of recipients of the
3662 message (&"ar"& for &"add recipients"&). The first argument must be a message
3663 id, and the remaining ones must be email addresses. However, if the message is
3664 active (in the middle of a delivery attempt), it is not altered. This option
3665 can be used only by an admin user.
3666
3667 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3668         &~<&'message&~id'&>"
3669 .oindex "&%-MC%&"
3670 .cindex "SMTP" "passed connection"
3671 .cindex "SMTP" "multiple deliveries"
3672 .cindex "multiple SMTP deliveries"
3673 This option is not intended for use by external callers. It is used internally
3674 by Exim to invoke another instance of itself to deliver a waiting message using
3675 an existing SMTP connection, which is passed as the standard input. Details are
3676 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3677 must be root or the Exim user in order to use it.
3678
3679 .vitem &%-MCA%&
3680 .oindex "&%-MCA%&"
3681 This option is not intended for use by external callers. It is used internally
3682 by Exim in conjunction with the &%-MC%& option. It signifies that the
3683 connection to the remote host has been authenticated.
3684
3685 .vitem &%-MCP%&
3686 .oindex "&%-MCP%&"
3687 This option is not intended for use by external callers. It is used internally
3688 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3689 which Exim is connected supports pipelining.
3690
3691 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3692 .oindex "&%-MCQ%&"
3693 This option is not intended for use by external callers. It is used internally
3694 by Exim in conjunction with the &%-MC%& option when the original delivery was
3695 started by a queue runner. It passes on the process id of the queue runner,
3696 together with the file descriptor number of an open pipe. Closure of the pipe
3697 signals the final completion of the sequence of processes that are passing
3698 messages through the same SMTP connection.
3699
3700 .vitem &%-MCS%&
3701 .oindex "&%-MCS%&"
3702 This option is not intended for use by external callers. It is used internally
3703 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3704 SMTP SIZE option should be used on messages delivered down the existing
3705 connection.
3706
3707 .vitem &%-MCT%&
3708 .oindex "&%-MCT%&"
3709 This option is not intended for use by external callers. It is used internally
3710 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3711 host to which Exim is connected supports TLS encryption.
3712
3713 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3714 .oindex "&%-Mc%&"
3715 .cindex "hints database" "not overridden by &%-Mc%&"
3716 .cindex "delivery" "manually started &-- not forced"
3717 This option requests Exim to run a delivery attempt on each message in turn,
3718 but unlike the &%-M%& option, it does check for retry hints, and respects any
3719 that are found. This option is not very useful to external callers. It is
3720 provided mainly for internal use by Exim when it needs to re-invoke itself in
3721 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3722 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3723 respects retry times and other options such as &%hold_domains%& that are
3724 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3725 If you want to run a specific delivery as if in a queue run, you should use
3726 &%-q%& with a message id argument. A distinction between queue run deliveries
3727 and other deliveries is made in one or two places.
3728
3729 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3730 .oindex "&%-Mes%&"
3731 .cindex "message" "changing sender"
3732 .cindex "sender" "changing"
3733 This option requests Exim to change the sender address in the message to the
3734 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3735 &"edit sender"&). There must be exactly two arguments. The first argument must
3736 be a message id, and the second one an email address. However, if the message
3737 is active (in the middle of a delivery attempt), its status is not altered.
3738 This option can be used only by an admin user.
3739
3740 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3741 .oindex "&%-Mf%&"
3742 .cindex "freezing messages"
3743 .cindex "message" "manually freezing"
3744 This option requests Exim to mark each listed message as &"frozen"&. This
3745 prevents any delivery attempts taking place until the message is &"thawed"&,
3746 either manually or as a result of the &%auto_thaw%& configuration option.
3747 However, if any of the messages are active (in the middle of a delivery
3748 attempt), their status is not altered. This option can be used only by an admin
3749 user.
3750
3751 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3752 .oindex "&%-Mg%&"
3753 .cindex "giving up on messages"
3754 .cindex "message" "abandoning delivery attempts"
3755 .cindex "delivery" "abandoning further attempts"
3756 This option requests Exim to give up trying to deliver the listed messages,
3757 including any that are frozen. However, if any of the messages are active,
3758 their status is not altered. For non-bounce messages, a delivery error message
3759 is sent to the sender, containing the text &"cancelled by administrator"&.
3760 Bounce messages are just discarded. This option can be used only by an admin
3761 user.
3762
3763 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3764 .oindex "&%-Mmad%&"
3765 .cindex "delivery" "cancelling all"
3766 This option requests Exim to mark all the recipient addresses in the messages
3767 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3768 message is active (in the middle of a delivery attempt), its status is not
3769 altered. This option can be used only by an admin user.
3770
3771 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3772 .oindex "&%-Mmd%&"
3773 .cindex "delivery" "cancelling by address"
3774 .cindex "recipient" "removing"
3775 .cindex "removing recipients"
3776 This option requests Exim to mark the given addresses as already delivered
3777 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3778 the remaining ones must be email addresses. These are matched to recipient
3779 addresses in the message in a case-sensitive manner. If the message is active
3780 (in the middle of a delivery attempt), its status is not altered. This option
3781 can be used only by an admin user.
3782
3783 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3784 .oindex "&%-Mrm%&"
3785 .cindex "removing messages"
3786 .cindex "abandoning mail"
3787 .cindex "message" "manually discarding"
3788 This option requests Exim to remove the given messages from the queue. No
3789 bounce messages are sent; each message is simply forgotten. However, if any of
3790 the messages are active, their status is not altered. This option can be used
3791 only by an admin user or by the user who originally caused the message to be
3792 placed on the queue.
3793
3794 .vitem &%-Mset%&&~<&'message&~id'&>
3795 .oindex "&%-Mset%&
3796 .cindex "testing" "string expansion"
3797 .cindex "expansion" "testing"
3798 This option is useful only in conjunction with &%-be%& (that is, when testing
3799 string expansions). Exim loads the given message from its spool before doing
3800 the test expansions, thus setting message-specific variables such as
3801 &$message_size$& and the header variables. The &$recipients$& variable is made
3802 available. This feature is provided to make it easier to test expansions that
3803 make use of these variables. However, this option can be used only by an admin
3804 user. See also &%-bem%&.
3805
3806 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3807 .oindex "&%-Mt%&"
3808 .cindex "thawing messages"
3809 .cindex "unfreezing messages"
3810 .cindex "frozen messages" "thawing"
3811 .cindex "message" "thawing frozen"
3812 This option requests Exim to &"thaw"& any of the listed messages that are
3813 &"frozen"&, so that delivery attempts can resume. However, if any of the
3814 messages are active, their status is not altered. This option can be used only
3815 by an admin user.
3816
3817 .vitem &%-Mvb%&&~<&'message&~id'&>
3818 .oindex "&%-Mvb%&"
3819 .cindex "listing" "message body"
3820 .cindex "message" "listing body of"
3821 This option causes the contents of the message body (-D) spool file to be
3822 written to the standard output. This option can be used only by an admin user.
3823
3824 .new
3825 .vitem &%-Mvc%&&~<&'message&~id'&>
3826 .oindex "&%-Mvc%&"
3827 .cindex "message" "listing in RFC 2822 format"
3828 .cindex "listing" "message in RFC 2822 format"
3829 This option causes a copy of the complete message (header lines plus body) to
3830 be written to the standard output in RFC 2822 format. This option can be used
3831 only by an admin user.
3832 .wen
3833 .vitem &%-Mvh%&&~<&'message&~id'&>
3834 .oindex "&%-Mvh%&"
3835 .cindex "listing" "message headers"
3836 .cindex "header lines" "listing"
3837 .cindex "message" "listing header lines"
3838 This option causes the contents of the message headers (-H) spool file to be
3839 written to the standard output. This option can be used only by an admin user.
3840
3841 .vitem &%-Mvl%&&~<&'message&~id'&>
3842 .oindex "&%-Mvl%&"
3843 .cindex "listing" "message log"
3844 .cindex "message" "listing message log"
3845 This option causes the contents of the message log spool file to be written to
3846 the standard output. This option can be used only by an admin user.
3847
3848 .vitem &%-m%&
3849 .oindex "&%-m%&"
3850 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3851 treats it that way too.
3852
3853 .vitem &%-N%&
3854 .oindex "&%-N%&"
3855 .cindex "debugging" "&%-N%& option"
3856 .cindex "debugging" "suppressing delivery"
3857 This is a debugging option that inhibits delivery of a message at the transport
3858 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3859 it just doesn't actually transport the message, but instead behaves as if it
3860 had successfully done so. However, it does not make any updates to the retry
3861 database, and the log entries for deliveries are flagged with &"*>"& rather
3862 than &"=>"&.
3863
3864 Because &%-N%& discards any message to which it applies, only root or the Exim
3865 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3866 words, an ordinary user can use it only when supplying an incoming message to
3867 which it will apply. Although transportation never fails when &%-N%& is set, an
3868 address may be deferred because of a configuration problem on a transport, or a
3869 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3870 the message, and applies to any subsequent delivery attempts that may happen
3871 for that message.
3872
3873 .vitem &%-n%&
3874 .oindex "&%-n%&"
3875 .cindex "Sendmail compatibility" "&%-n%& option ignored"
3876 This option is interpreted by Sendmail to mean &"no aliasing"&. It is ignored
3877 by Exim.
3878
3879 .vitem &%-O%&&~<&'data'&>
3880 .oindex "&%-O%&"
3881 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
3882 Exim.
3883
3884 .vitem &%-oA%&&~<&'file&~name'&>
3885 .oindex "&%-oA%&"
3886 .cindex "Sendmail compatibility" "&%-oA%& option"
3887 This option is used by Sendmail in conjunction with &%-bi%& to specify an
3888 alternative alias file name. Exim handles &%-bi%& differently; see the
3889 description above.
3890
3891 .vitem &%-oB%&&~<&'n'&>
3892 .oindex "&%-oB%&"
3893 .cindex "SMTP" "passed connection"
3894 .cindex "SMTP" "multiple deliveries"
3895 .cindex "multiple SMTP deliveries"
3896 This is a debugging option which limits the maximum number of messages that can
3897 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
3898 transport. If <&'n'&> is omitted, the limit is set to 1.
3899
3900 .vitem &%-odb%&
3901 .oindex "&%-odb%&"
3902 .cindex "background delivery"
3903 .cindex "delivery" "in the background"
3904 This option applies to all modes in which Exim accepts incoming messages,
3905 including the listening daemon. It requests &"background"& delivery of such
3906 messages, which means that the accepting process automatically starts a
3907 delivery process for each message received, but does not wait for the delivery
3908 processes to finish.
3909
3910 When all the messages have been received, the reception process exits,
3911 leaving the delivery processes to finish in their own time. The standard output
3912 and error streams are closed at the start of each delivery process.
3913 This is the default action if none of the &%-od%& options are present.
3914
3915 If one of the queueing options in the configuration file
3916 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
3917 overrides it if &%queue_only_override%& is set true, which is the default
3918 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
3919
3920 .vitem &%-odf%&
3921 .oindex "&%-odf%&"
3922 .cindex "foreground delivery"
3923 .cindex "delivery" "in the foreground"
3924 This option requests &"foreground"& (synchronous) delivery when Exim has
3925 accepted a locally-generated message. (For the daemon it is exactly the same as
3926 &%-odb%&.) A delivery process is automatically started to deliver the message,
3927 and Exim waits for it to complete before proceeding.
3928
3929 The original Exim reception process does not finish until the delivery
3930 process for the final message has ended. The standard error stream is left open
3931 during deliveries.
3932
3933 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
3934 false and one of the queueing options in the configuration file is in effect.
3935
3936 If there is a temporary delivery error during foreground delivery, the
3937 message is left on the queue for later delivery, and the original reception
3938 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
3939 restricted configuration that never queues messages.
3940
3941
3942 .vitem &%-odi%&
3943 .oindex "&%-odi%&"
3944 This option is synonymous with &%-odf%&. It is provided for compatibility with
3945 Sendmail.
3946
3947 .vitem &%-odq%&
3948 .oindex "&%-odq%&"
3949 .cindex "non-immediate delivery"
3950 .cindex "delivery" "suppressing immediate"
3951 .cindex "queueing incoming messages"
3952 This option applies to all modes in which Exim accepts incoming messages,
3953 including the listening daemon. It specifies that the accepting process should
3954 not automatically start a delivery process for each message received. Messages
3955 are placed on the queue, and remain there until a subsequent queue runner
3956 process encounters them. There are several configuration options (such as
3957 &%queue_only%&) that can be used to queue incoming messages under certain
3958 conditions. This option overrides all of them and also &%-odqs%&. It always
3959 forces queueing.
3960
3961 .vitem &%-odqs%&
3962 .oindex "&%-odqs%&"
3963 .cindex "SMTP" "delaying delivery"
3964 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
3965 However, like &%-odb%& and &%-odi%&, this option has no effect if
3966 &%queue_only_override%& is false and one of the queueing options in the
3967 configuration file is in effect.
3968
3969 When &%-odqs%& does operate, a delivery process is started for each incoming
3970 message, in the background by default, but in the foreground if &%-odi%& is
3971 also present. The recipient addresses are routed, and local deliveries are done
3972 in the normal way. However, if any SMTP deliveries are required, they are not
3973 done at this time, so the message remains on the queue until a subsequent queue
3974 runner process encounters it. Because routing was done, Exim knows which
3975 messages are waiting for which hosts, and so a number of messages for the same
3976 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
3977 configuration option has the same effect for specific domains. See also the
3978 &%-qq%& option.
3979
3980 .vitem &%-oee%&
3981 .oindex "&%-oee%&"
3982 .cindex "error" "reporting"
3983 If an error is detected while a non-SMTP message is being received (for
3984 example, a malformed address), the error is reported to the sender in a mail
3985 message.
3986
3987 .cindex "return code" "for &%-oee%&"
3988 Provided
3989 this error message is successfully sent, the Exim receiving process
3990 exits with a return code of zero. If not, the return code is 2 if the problem
3991 is that the original message has no recipients, or 1 any other error. This is
3992 the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
3993
3994 .vitem &%-oem%&
3995 .oindex "&%-oem%&"
3996 .cindex "error" "reporting"
3997 .cindex "return code" "for &%-oem%&"
3998 This is the same as &%-oee%&, except that Exim always exits with a non-zero
3999 return code, whether or not the error message was successfully sent.
4000 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4001
4002 .vitem &%-oep%&
4003 .oindex "&%-oep%&"
4004 .cindex "error" "reporting"
4005 If an error is detected while a non-SMTP message is being received, the
4006 error is reported by writing a message to the standard error file (stderr).
4007 .cindex "return code" "for &%-oep%&"
4008 The return code is 1 for all errors.
4009
4010 .vitem &%-oeq%&
4011 .oindex "&%-oeq%&"
4012 .cindex "error" "reporting"
4013 This option is supported for compatibility with Sendmail, but has the same
4014 effect as &%-oep%&.
4015
4016 .vitem &%-oew%&
4017 .oindex "&%-oew%&"
4018 .cindex "error" "reporting"
4019 This option is supported for compatibility with Sendmail, but has the same
4020 effect as &%-oem%&.
4021
4022 .vitem &%-oi%&
4023 .oindex "&%-oi%&"
4024 .cindex "dot" "in incoming non-SMTP message"
4025 This option, which has the same effect as &%-i%&, specifies that a dot on a
4026 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4027 single dot does terminate, though Exim does no special processing for other
4028 lines that start with a dot. This option is set by default if Exim is called as
4029 &'rmail'&. See also &%-ti%&.
4030
4031 .vitem &%-oitrue%&
4032 .oindex "&%-oitrue%&"
4033 This option is treated as synonymous with &%-oi%&.
4034
4035 .vitem &%-oMa%&&~<&'host&~address'&>
4036 .oindex "&%-oMa%&"
4037 .cindex "sender" "host address, specifying for local message"
4038 A number of options starting with &%-oM%& can be used to set values associated
4039 with remote hosts on locally-submitted messages (that is, messages not received
4040 over TCP/IP). These options can be used by any caller in conjunction with the
4041 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4042 other circumstances, they are ignored unless the caller is trusted.
4043
4044 The &%-oMa%& option sets the sender host address. This may include a port
4045 number at the end, after a full stop (period). For example:
4046 .code
4047 exim -bs -oMa 10.9.8.7.1234
4048 .endd
4049 An alternative syntax is to enclose the IP address in square brackets,
4050 followed by a colon and the port number:
4051 .code
4052 exim -bs -oMa [10.9.8.7]:1234
4053 .endd
4054 The IP address is placed in the &$sender_host_address$& variable, and the
4055 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4056 are present on the command line, the sender host IP address is taken from
4057 whichever one is last.
4058
4059 .vitem &%-oMaa%&&~<&'name'&>
4060 .oindex "&%-oMaa%&"
4061 .cindex "authentication" "name, specifying for local message"
4062 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4063 option sets the value of &$sender_host_authenticated$& (the authenticator
4064 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4065 This option can be used with &%-bh%& and &%-bs%& to set up an
4066 authenticated SMTP session without actually using the SMTP AUTH command.
4067
4068 .vitem &%-oMai%&&~<&'string'&>
4069 .oindex "&%-oMai%&"
4070 .cindex "authentication" "id, specifying for local message"
4071 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4072 option sets the value of &$authenticated_id$& (the id that was authenticated).
4073 This overrides the default value (the caller's login id, except with &%-bh%&,
4074 where there is no default) for messages from local sources. See chapter
4075 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4076
4077 .vitem &%-oMas%&&~<&'address'&>
4078 .oindex "&%-oMas%&"
4079 .cindex "authentication" "sender, specifying for local message"
4080 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4081 option sets the authenticated sender value in &$authenticated_sender$&. It
4082 overrides the sender address that is created from the caller's login id for
4083 messages from local sources, except when &%-bh%& is used, when there is no
4084 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4085 specified on a MAIL command overrides this value. See chapter
4086 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4087
4088 .vitem &%-oMi%&&~<&'interface&~address'&>
4089 .oindex "&%-oMi%&"
4090 .cindex "interface" "address, specifying for local message"
4091 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4092 option sets the IP interface address value. A port number may be included,
4093 using the same syntax as for &%-oMa%&. The interface address is placed in
4094 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4095
4096 .vitem &%-oMr%&&~<&'protocol&~name'&>
4097 .oindex "&%-oMr%&"
4098 .cindex "protocol, specifying for local message"
4099 .vindex "&$received_protocol$&"
4100 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4101 option sets the received protocol value that is stored in
4102 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4103 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4104 SMTP protocol names (see the description of &$received_protocol$& in section
4105 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4106 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4107 be set by &%-oMr%&.
4108
4109 .vitem &%-oMs%&&~<&'host&~name'&>
4110 .oindex "&%-oMs%&"
4111 .cindex "sender" "host name, specifying for local message"
4112 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4113 option sets the sender host name in &$sender_host_name$&. When this option is
4114 present, Exim does not attempt to look up a host name from an IP address; it
4115 uses the name it is given.
4116
4117 .vitem &%-oMt%&&~<&'ident&~string'&>
4118 .oindex "&%-oMt%&"
4119 .cindex "sender" "ident string, specifying for local message"
4120 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4121 option sets the sender ident value in &$sender_ident$&. The default setting for
4122 local callers is the login id of the calling process, except when &%-bh%& is
4123 used, when there is no default.
4124
4125 .vitem &%-om%&
4126 .oindex "&%-om%&"
4127 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4128 In Sendmail, this option means &"me too"&, indicating that the sender of a
4129 message should receive a copy of the message if the sender appears in an alias
4130 expansion. Exim always does this, so the option does nothing.
4131
4132 .vitem &%-oo%&
4133 .oindex "&%-oo%&"
4134 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4135 This option is ignored. In Sendmail it specifies &"old style headers"&,
4136 whatever that means.
4137
4138 .vitem &%-oP%&&~<&'path'&>
4139 .oindex "&%-oP%&"
4140 .cindex "pid (process id)" "of daemon"
4141 .cindex "daemon" "process id (pid)"
4142 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4143 value. The option specifies the file to which the process id of the daemon is
4144 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4145 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4146 because in those cases, the normal pid file is not used.
4147
4148 .vitem &%-or%&&~<&'time'&>
4149 .oindex "&%-or%&"
4150 .cindex "timeout" "for non-SMTP input"
4151 This option sets a timeout value for incoming non-SMTP messages. If it is not
4152 set, Exim will wait forever for the standard input. The value can also be set
4153 by the &%receive_timeout%& option. The format used for specifying times is
4154 described in section &<<SECTtimeformat>>&.
4155
4156 .vitem &%-os%&&~<&'time'&>
4157 .oindex "&%-os%&"
4158 .cindex "timeout" "for SMTP input"
4159 .cindex "SMTP" "input timeout"
4160 This option sets a timeout value for incoming SMTP messages. The timeout
4161 applies to each SMTP command and block of data. The value can also be set by
4162 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4163 for specifying times is described in section &<<SECTtimeformat>>&.
4164
4165 .vitem &%-ov%&
4166 .oindex "&%-ov%&"
4167 This option has exactly the same effect as &%-v%&.
4168
4169 .vitem &%-oX%&&~<&'number&~or&~string'&>
4170 .oindex "&%-oX%&"
4171 .cindex "TCP/IP" "setting listening ports"
4172 .cindex "TCP/IP" "setting listening interfaces"
4173 .cindex "port" "receiving TCP/IP"
4174 This option is relevant only when the &%-bd%& (start listening daemon) option
4175 is also given. It controls which ports and interfaces the daemon uses. Details
4176 of the syntax, and how it interacts with configuration file options, are given
4177 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4178 file is written unless &%-oP%& is also present to specify a pid file name.
4179
4180 .vitem &%-pd%&
4181 .oindex "&%-pd%&"
4182 .cindex "Perl" "starting the interpreter"
4183 This option applies when an embedded Perl interpreter is linked with Exim (see
4184 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4185 option, forcing the starting of the interpreter to be delayed until it is
4186 needed.
4187
4188 .vitem &%-ps%&
4189 .oindex "&%-ps%&"
4190 .cindex "Perl" "starting the interpreter"
4191 This option applies when an embedded Perl interpreter is linked with Exim (see
4192 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4193 option, forcing the starting of the interpreter to occur as soon as Exim is
4194 started.
4195
4196 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4197 .oindex "&%-p%&"
4198 For compatibility with Sendmail, this option is equivalent to
4199 .display
4200 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4201 .endd
4202 It sets the incoming protocol and host name (for trusted callers). The
4203 host name and its colon can be omitted when only the protocol is to be set.
4204 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4205 to embedded Perl. It is therefore impossible to set a protocol value of &`p`&
4206 or &`s`& using this option (but that does not seem a real limitation).
4207
4208 .vitem &%-q%&
4209 .oindex "&%-q%&"
4210 .cindex "queue runner" "starting manually"
4211 This option is normally restricted to admin users. However, there is a
4212 configuration option called &%prod_requires_admin%& which can be set false to
4213 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4214 and &%-S%& options).
4215
4216 .cindex "queue runner" "description of operation"
4217 The &%-q%& option starts one queue runner process. This scans the queue of
4218 waiting messages, and runs a delivery process for each one in turn. It waits
4219 for each delivery process to finish before starting the next one. A delivery
4220 process may not actually do any deliveries if the retry times for the addresses
4221 have not been reached. Use &%-qf%& (see below) if you want to override this.
4222
4223 If
4224 .cindex "SMTP" "passed connection"
4225 .cindex "SMTP" "multiple deliveries"
4226 .cindex "multiple SMTP deliveries"
4227 the delivery process spawns other processes to deliver other messages down
4228 passed SMTP connections, the queue runner waits for these to finish before
4229 proceeding.
4230
4231 When all the queued messages have been considered, the original queue runner
4232 process terminates. In other words, a single pass is made over the waiting
4233 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4234 this to be repeated periodically.
4235
4236 Exim processes the waiting messages in an unpredictable order. It isn't very
4237 random, but it is likely to be different each time, which is all that matters.
4238 If one particular message screws up a remote MTA, other messages to the same
4239 MTA have a chance of getting through if they get tried first.
4240
4241 It is possible to cause the messages to be processed in lexical message id
4242 order, which is essentially the order in which they arrived, by setting the
4243 &%queue_run_in_order%& option, but this is not recommended for normal use.
4244
4245 .vitem &%-q%&<&'qflags'&>
4246 The &%-q%& option may be followed by one or more flag letters that change its
4247 behaviour. They are all optional, but if more than one is present, they must
4248 appear in the correct order. Each flag is described in a separate item below.
4249
4250 .vitem &%-qq...%&
4251 .oindex "&%-qq%&"
4252 .cindex "queue" "double scanning"
4253 .cindex "queue" "routing"
4254 .cindex "routing" "whole queue before delivery"
4255 An option starting with &%-qq%& requests a two-stage queue run. In the first
4256 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4257 every domain. Addresses are routed, local deliveries happen, but no remote
4258 transports are run.
4259
4260 .cindex "hints database" "remembering routing"
4261 The hints database that remembers which messages are waiting for specific hosts
4262 is updated, as if delivery to those hosts had been deferred. After this is
4263 complete, a second, normal queue scan happens, with routing and delivery taking
4264 place as normal. Messages that are routed to the same host should mostly be
4265 delivered down a single SMTP
4266 .cindex "SMTP" "passed connection"
4267 .cindex "SMTP" "multiple deliveries"
4268 .cindex "multiple SMTP deliveries"
4269 connection because of the hints that were set up during the first queue scan.
4270 This option may be useful for hosts that are connected to the Internet
4271 intermittently.
4272
4273 .vitem &%-q[q]i...%&
4274 .oindex "&%-qi%&"
4275 .cindex "queue" "initial delivery"
4276 If the &'i'& flag is present, the queue runner runs delivery processes only for
4277 those messages that haven't previously been tried. (&'i'& stands for &"initial
4278 delivery"&.) This can be helpful if you are putting messages on the queue using
4279 &%-odq%& and want a queue runner just to process the new messages.
4280
4281 .vitem &%-q[q][i]f...%&
4282 .oindex "&%-qf%&"
4283 .cindex "queue" "forcing delivery"
4284 .cindex "delivery" "forcing in queue run"
4285 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4286 message, whereas without &'f'& only those non-frozen addresses that have passed
4287 their retry times are tried.
4288
4289 .vitem &%-q[q][i]ff...%&
4290 .oindex "&%-qff%&"
4291 .cindex "frozen messages" "forcing delivery"
4292 If &'ff'& is present, a delivery attempt is forced for every message, whether
4293 frozen or not.
4294
4295 .vitem &%-q[q][i][f[f]]l%&
4296 .oindex "&%-ql%&"
4297 .cindex "queue" "local deliveries only"
4298 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4299 be done. If a message requires any remote deliveries, it remains on the queue
4300 for later delivery.
4301
4302 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4303 .cindex "queue" "delivering specific messages"
4304 When scanning the queue, Exim can be made to skip over messages whose ids are
4305 lexically less than a given value by following the &%-q%& option with a
4306 starting message id. For example:
4307 .code
4308 exim -q 0t5C6f-0000c8-00
4309 .endd
4310 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4311 second message id is given, messages whose ids are lexically greater than it
4312 are also skipped. If the same id is given twice, for example,
4313 .code
4314 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4315 .endd
4316 just one delivery process is started, for that message. This differs from
4317 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4318 that it counts as a delivery from a queue run. Note that the selection
4319 mechanism does not affect the order in which the messages are scanned. There
4320 are also other ways of selecting specific sets of messages for delivery in a
4321 queue run &-- see &%-R%& and &%-S%&.
4322
4323 .vitem &%-q%&<&'qflags'&><&'time'&>
4324 .cindex "queue runner" "starting periodically"
4325 .cindex "periodic queue running"
4326 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4327 starting a queue runner process at intervals specified by the given time value
4328 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4329 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4330 single daemon process handles both functions. A common way of starting up a
4331 combined daemon at system boot time is to use a command such as
4332 .code
4333 /usr/exim/bin/exim -bd -q30m
4334 .endd
4335 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4336 process every 30 minutes.
4337
4338 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4339 pid file is written unless one is explicitly requested by the &%-oP%& option.
4340
4341 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4342 .oindex "&%-qR%&"
4343 This option is synonymous with &%-R%&. It is provided for Sendmail
4344 compatibility.
4345
4346 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4347 .oindex "&%-qS%&"
4348 This option is synonymous with &%-S%&.
4349
4350 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4351 .oindex "&%-R%&"
4352 .cindex "queue runner" "for specific recipients"
4353 .cindex "delivery" "to given domain"
4354 .cindex "domain" "delivery to"
4355 The <&'rsflags'&> may be empty, in which case the white space before the string
4356 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4357 which are the possible values for <&'rsflags'&>. White space is required if
4358 <&'rsflags'&> is not empty.
4359
4360 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4361 perform a single queue run, except that, when scanning the messages on the
4362 queue, Exim processes only those that have at least one undelivered recipient
4363 address containing the given string, which is checked in a case-independent
4364 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4365 regular expression; otherwise it is a literal string.
4366
4367 If you want to do periodic queue runs for messages with specific recipients,
4368 you can combine &%-R%& with &%-q%& and a time value. For example:
4369 .code
4370 exim -q25m -R @special.domain.example
4371 .endd
4372 This example does a queue run for messages with recipients in the given domain
4373 every 25 minutes. Any additional flags that are specified with &%-q%& are
4374 applied to each queue run.
4375
4376 Once a message is selected for delivery by this mechanism, all its addresses
4377 are processed. For the first selected message, Exim overrides any retry
4378 information and forces a delivery attempt for each undelivered address. This
4379 means that if delivery of any address in the first message is successful, any
4380 existing retry information is deleted, and so delivery attempts for that
4381 address in subsequently selected messages (which are processed without forcing)
4382 will run. However, if delivery of any address does not succeed, the retry
4383 information is updated, and in subsequently selected messages, the failing
4384 address will be skipped.
4385
4386 .cindex "frozen messages" "forcing delivery"
4387 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4388 all selected messages, not just the first; frozen messages are included when
4389 &'ff'& is present.
4390
4391 The &%-R%& option makes it straightforward to initiate delivery of all messages
4392 to a given domain after a host has been down for some time. When the SMTP
4393 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4394 effect is to run Exim with the &%-R%& option, but it can be configured to run
4395 an arbitrary command instead.
4396
4397 .vitem &%-r%&
4398 .oindex "&%-r%&"
4399 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4400
4401 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4402 .oindex "&%-S%&"
4403 .cindex "delivery" "from given sender"
4404 .cindex "queue runner" "for specific senders"
4405 This option acts like &%-R%& except that it checks the string against each
4406 message's sender instead of against the recipients. If &%-R%& is also set, both
4407 conditions must be met for a message to be selected. If either of the options
4408 has &'f'& or &'ff'& in its flags, the associated action is taken.
4409
4410 .vitem &%-Tqt%&&~<&'times'&>
4411 .oindex "&%-Tqt%&"
4412 This an option that is exclusively for use by the Exim testing suite. It is not
4413 recognized when Exim is run normally. It allows for the setting up of explicit
4414 &"queue times"& so that various warning/retry features can be tested.
4415
4416 .vitem &%-t%&
4417 .oindex "&%-t%&"
4418 .cindex "recipient" "extracting from header lines"
4419 .cindex "&'Bcc:'& header line"
4420 .cindex "&'Cc:'& header line"
4421 .cindex "&'To:'& header line"
4422 When Exim is receiving a locally-generated, non-SMTP message on its standard
4423 input, the &%-t%& option causes the recipients of the message to be obtained
4424 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4425 from the command arguments. The addresses are extracted before any rewriting
4426 takes place and the &'Bcc:'& header line, if present, is then removed.
4427
4428 .cindex "Sendmail compatibility" "&%-t%& option"
4429 If the command has any arguments, they specify addresses to which the message
4430 is &'not'& to be delivered. That is, the argument addresses are removed from
4431 the recipients list obtained from the headers. This is compatible with Smail 3
4432 and in accordance with the documented behaviour of several versions of
4433 Sendmail, as described in man pages on a number of operating systems (e.g.
4434 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4435 argument addresses to those obtained from the headers, and the O'Reilly
4436 Sendmail book documents it that way. Exim can be made to add argument addresses
4437 instead of subtracting them by setting the option
4438 &%extract_addresses_remove_arguments%& false.
4439
4440 .cindex "&%Resent-%& header lines" "with &%-t%&"
4441 If there are any &%Resent-%& header lines in the message, Exim extracts
4442 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4443 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4444 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4445 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4446
4447 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4448 message is resent several times). The RFC also specifies that they should be
4449 added at the front of the message, and separated by &'Received:'& lines. It is
4450 not at all clear how &%-t%& should operate in the present of multiple sets,
4451 nor indeed exactly what constitutes a &"set"&.
4452 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4453 are often added at the end of the header, and if a message is resent more than
4454 once, it is common for the original set of &%Resent-%& headers to be renamed as
4455 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4456
4457 .vitem &%-ti%&
4458 .oindex "&%-ti%&"
4459 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4460 compatibility with Sendmail.
4461
4462 .vitem &%-tls-on-connect%&
4463 .oindex "&%-tls-on-connect%&"
4464 .cindex "TLS" "use without STARTTLS"
4465 .cindex "TLS" "automatic start"
4466 This option is available when Exim is compiled with TLS support. It forces all
4467 incoming SMTP connections to behave as if the incoming port is listed in the
4468 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4469 &<<CHAPTLS>>& for further details.
4470
4471
4472 .vitem &%-U%&
4473 .oindex "&%-U%&"
4474 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4475 Sendmail uses this option for &"initial message submission"&, and its
4476 documentation states that in future releases, it may complain about
4477 syntactically invalid messages rather than fixing them when this flag is not
4478 set. Exim ignores this option.
4479
4480 .vitem &%-v%&
4481 .oindex "&%-v%&"
4482 This option causes Exim to write information to the standard error stream,
4483 describing what it is doing. In particular, it shows the log lines for
4484 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4485 dialogue is shown. Some of the log lines shown may not actually be written to
4486 the log if the setting of &%log_selector%& discards them. Any relevant
4487 selectors are shown with each log line. If none are shown, the logging is
4488 unconditional.
4489
4490 .vitem &%-x%&
4491 .oindex "&%-x%&"
4492 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4493 National Language Support extended characters in the body of the mail item"&).
4494 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4495 this option.
4496 .endlist
4497
4498 .ecindex IIDclo1
4499 .ecindex IIDclo2
4500
4501
4502 . ////////////////////////////////////////////////////////////////////////////
4503 . Insert a stylized DocBook comment here, to identify the end of the command
4504 . line options. This is for the benefit of the Perl script that automatically
4505 . creates a man page for the options.
4506 . ////////////////////////////////////////////////////////////////////////////
4507
4508 .literal xml
4509 <!-- === End of command line options === -->
4510 .literal off
4511
4512
4513
4514
4515
4516 . ////////////////////////////////////////////////////////////////////////////
4517 . ////////////////////////////////////////////////////////////////////////////
4518
4519
4520 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4521          "The runtime configuration file"
4522
4523 .cindex "run time configuration"
4524 .cindex "configuration file" "general description"
4525 .cindex "CONFIGURE_FILE"
4526 .cindex "configuration file" "errors in"
4527 .cindex "error" "in configuration file"
4528 .cindex "return code" "for bad configuration"
4529 Exim uses a single run time configuration file that is read whenever an Exim
4530 binary is executed. Note that in normal operation, this happens frequently,
4531 because Exim is designed to operate in a distributed manner, without central
4532 control.
4533
4534 If a syntax error is detected while reading the configuration file, Exim
4535 writes a message on the standard error, and exits with a non-zero return code.
4536 The message is also written to the panic log. &*Note*&: Only simple syntax
4537 errors can be detected at this time. The values of any expanded options are
4538 not checked until the expansion happens, even when the expansion does not
4539 actually alter the string.
4540
4541 The name of the configuration file is compiled into the binary for security
4542 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4543 most configurations, this specifies a single file. However, it is permitted to
4544 give a colon-separated list of file names, in which case Exim uses the first
4545 existing file in the list.
4546
4547 .new
4548 .cindex "EXIM_USER"
4549 .cindex "EXIM_GROUP"
4550 .cindex "CONFIGURE_OWNER"
4551 .cindex "CONFIGURE_GROUP"
4552 .cindex "configuration file" "ownership"
4553 .cindex "ownership" "configuration file"
4554 The run time configuration file must be owned by root or by the user that is
4555 specified at compile time by the CONFIGURE_OWNER option (if set). The
4556 configuration file must not be world-writeable, or group-writeable unless its
4557 group is the root group or the one specified at compile time by the
4558 CONFIGURE_GROUP option.
4559
4560 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4561 to root, anybody who is able to edit the run time configuration file has an
4562 easy way to run commands as root. If you specify a user or group in the
4563 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4564 who are members of that group will trivially be able to obtain root privileges.
4565
4566 Up to Exim version 4.72, the run time configuration file was also permitted to
4567 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4568 since it offered a simple privilege escalation for any attacker who managed to
4569 compromise the Exim user account.
4570 .wen
4571 A default configuration file, which will work correctly in simple situations,
4572 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4573 defines just one file name, the installation process copies the default
4574 configuration to a new file of that name if it did not previously exist. If
4575 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4576 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4577 configuration.
4578
4579
4580
4581 .new
4582 .section "Using a different configuration file" "SECID40"
4583 .cindex "configuration file" "alternate"
4584 A one-off alternate configuration can be specified by the &%-C%& command line
4585 option, which may specify a single file or a list of files. However, when
4586 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4587 unless the argument for &%-C%& is identical to the built-in value from
4588 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4589 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4590 is useful mainly for checking the syntax of configuration files before
4591 installing them. No owner or group checks are done on a configuration file
4592 specified by &%-C%&, if root privilege has been dropped.
4593
4594 Even the Exim user is not trusted to specify an arbitrary configuration file
4595 with the &%-C%& option to be used with root privileges, unless that file is
4596 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4597 testing a configuration using &%-C%& right through message reception and
4598 delivery, even if the caller is root. The reception works, but by that time,
4599 Exim is running as the Exim user, so when it re-execs to regain privilege for
4600 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4601 can test reception and delivery using two separate commands (one to put a
4602 message on the queue, using &%-odq%&, and another to do the delivery, using
4603 &%-M%&).
4604 .wen
4605 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4606 prefix string with which any file named in a &%-C%& command line option must
4607 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4608 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4609 name can be used with &%-C%&.
4610
4611 One-off changes to a configuration can be specified by the &%-D%& command line
4612 option, which defines and overrides values for macros used inside the
4613 configuration file. However, like &%-C%&, the use of this option by a
4614 non-privileged user causes Exim to discard its root privilege.
4615 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4616 completely disabled, and its use causes an immediate error exit.
4617
4618 .new
4619 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4620 to declare certain macro names trusted, such that root privilege will not
4621 necessarily be discarded.
4622 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4623 considered safe and, if &%-D%& only supplies macros from this list, and the
4624 values are acceptable, then Exim will not give up root privilege if the caller
4625 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4626 transition mechanism and is expected to be removed in the future.  Acceptable
4627 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4628 .wen
4629
4630 Some sites may wish to use the same Exim binary on different machines that
4631 share a file system, but to use different configuration files on each machine.
4632 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4633 looks for a file whose name is the configuration file name followed by a dot
4634 and the machine's node name, as obtained from the &[uname()]& function. If this
4635 file does not exist, the standard name is tried. This processing occurs for
4636 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4637
4638 In some esoteric situations different versions of Exim may be run under
4639 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4640 help with this. See the comments in &_src/EDITME_& for details.
4641
4642
4643
4644 .section "Configuration file format" "SECTconffilfor"
4645 .cindex "configuration file" "format of"
4646 .cindex "format" "configuration file"
4647 Exim's configuration file is divided into a number of different parts. General
4648 option settings must always appear at the start of the file. The other parts
4649 are all optional, and may appear in any order. Each part other than the first
4650 is introduced by the word &"begin"& followed by the name of the part. The
4651 optional parts are:
4652
4653 .ilist
4654 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4655 &<<CHAPACL>>&).
4656 .next
4657 .cindex "AUTH" "configuration"
4658 &'authenticators'&: Configuration settings for the authenticator drivers. These
4659 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4660 .next
4661 &'routers'&: Configuration settings for the router drivers. Routers process
4662 addresses and determine how the message is to be delivered (see chapters
4663 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4664 .next
4665 &'transports'&: Configuration settings for the transport drivers. Transports
4666 define mechanisms for copying messages to destinations (see chapters
4667 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4668 .next
4669 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4670 If there is no retry section, or if it is empty (that is, no retry rules are
4671 defined), Exim will not retry deliveries. In this situation, temporary errors
4672 are treated the same as permanent errors. Retry rules are discussed in chapter
4673 &<<CHAPretry>>&.
4674 .next
4675 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4676 when new addresses are generated during delivery. Rewriting is discussed in
4677 chapter &<<CHAPrewrite>>&.
4678 .next
4679 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4680 want to use this feature, you must set
4681 .code
4682 LOCAL_SCAN_HAS_OPTIONS=yes
4683 .endd
4684 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4685 facility are given in chapter &<<CHAPlocalscan>>&.
4686 .endlist
4687
4688 .cindex "configuration file" "leading white space in"
4689 .cindex "configuration file" "trailing white space in"
4690 .cindex "white space" "in configuration file"
4691 Leading and trailing white space in configuration lines is always ignored.
4692
4693 Blank lines in the file, and lines starting with a # character (ignoring
4694 leading white space) are treated as comments and are ignored. &*Note*&: A
4695 # character other than at the beginning of a line is not treated specially,
4696 and does not introduce a comment.
4697
4698 Any non-comment line can be continued by ending it with a backslash. Note that
4699 the general rule for white space means that trailing white space after the
4700 backslash and leading white space at the start of continuation
4701 lines is ignored. Comment lines beginning with # (but not empty lines) may
4702 appear in the middle of a sequence of continuation lines.
4703
4704 A convenient way to create a configuration file is to start from the
4705 default, which is supplied in &_src/configure.default_&, and add, delete, or
4706 change settings as required.
4707
4708 The ACLs, retry rules, and rewriting rules have their own syntax which is
4709 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4710 respectively. The other parts of the configuration file have some syntactic
4711 items in common, and these are described below, from section &<<SECTcos>>&
4712 onwards. Before that, the inclusion, macro, and conditional facilities are
4713 described.
4714
4715
4716
4717 .section "File inclusions in the configuration file" "SECID41"
4718 .cindex "inclusions in configuration file"
4719 .cindex "configuration file" "including other files"
4720 .cindex "&`.include`& in configuration file"
4721 .cindex "&`.include_if_exists`& in configuration file"
4722 You can include other files inside Exim's run time configuration file by
4723 using this syntax:
4724 .display
4725 &`.include`& <&'file name'&>
4726 &`.include_if_exists`& <&'file name'&>
4727 .endd
4728 on a line by itself. Double quotes round the file name are optional. If you use
4729 the first form, a configuration error occurs if the file does not exist; the
4730 second form does nothing for non-existent files. In all cases, an absolute file
4731 name is required.
4732
4733 Includes may be nested to any depth, but remember that Exim reads its
4734 configuration file often, so it is a good idea to keep them to a minimum.
4735 If you change the contents of an included file, you must HUP the daemon,
4736 because an included file is read only when the configuration itself is read.
4737
4738 The processing of inclusions happens early, at a physical line level, so, like
4739 comment lines, an inclusion can be used in the middle of an option setting,
4740 for example:
4741 .code
4742 hosts_lookup = a.b.c \
4743                .include /some/file
4744 .endd
4745 Include processing happens after macro processing (see below). Its effect is to
4746 process the lines of the included file as if they occurred inline where the
4747 inclusion appears.
4748
4749
4750
4751 .section "Macros in the configuration file" "SECTmacrodefs"
4752 .cindex "macro" "description of"
4753 .cindex "configuration file" "macros"
4754 If a line in the main part of the configuration (that is, before the first
4755 &"begin"& line) begins with an upper case letter, it is taken as a macro
4756 definition, and must be of the form
4757 .display
4758 <&'name'&> = <&'rest of line'&>
4759 .endd
4760 The name must consist of letters, digits, and underscores, and need not all be
4761 in upper case, though that is recommended. The rest of the line, including any
4762 continuations, is the replacement text, and has leading and trailing white
4763 space removed. Quotes are not removed. The replacement text can never end with
4764 a backslash character, but this doesn't seem to be a serious limitation.
4765
4766 Macros may also be defined between router, transport, authenticator, or ACL
4767 definitions. They may not, however, be defined within an individual driver or
4768 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4769
4770 .section "Macro substitution" "SECID42"
4771 Once a macro is defined, all subsequent lines in the file (and any included
4772 files) are scanned for the macro name; if there are several macros, the line is
4773 scanned for each in turn, in the order in which the macros are defined. The
4774 replacement text is not re-scanned for the current macro, though it is scanned
4775 for subsequently defined macros. For this reason, a macro name may not contain
4776 the name of a previously defined macro as a substring. You could, for example,
4777 define
4778 .display
4779 &`ABCD_XYZ = `&<&'something'&>
4780 &`ABCD = `&<&'something else'&>
4781 .endd
4782 but putting the definitions in the opposite order would provoke a configuration
4783 error. Macro expansion is applied to individual physical lines from the file,
4784 before checking for line continuation or file inclusion (see above). If a line
4785 consists solely of a macro name, and the expansion of the macro is empty, the
4786 line is ignored. A macro at the start of a line may turn the line into a
4787 comment line or a &`.include`& line.
4788
4789
4790 .section "Redefining macros" "SECID43"
4791 Once defined, the value of a macro can be redefined later in the configuration
4792 (or in an included file). Redefinition is specified by using &'=='& instead of
4793 &'='&. For example:
4794 .code
4795 MAC =  initial value
4796 ...
4797 MAC == updated value
4798 .endd
4799 Redefinition does not alter the order in which the macros are applied to the
4800 subsequent lines of the configuration file. It is still the same order in which
4801 the macros were originally defined. All that changes is the macro's value.
4802 Redefinition makes it possible to accumulate values. For example:
4803 .code
4804 MAC =  initial value
4805 ...
4806 MAC == MAC and something added
4807 .endd
4808 This can be helpful in situations where the configuration file is built
4809 from a number of other files.
4810
4811 .section "Overriding macro values" "SECID44"
4812 The values set for macros in the configuration file can be overridden by the
4813 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4814 used, unless called by root or the Exim user. A definition on the command line
4815 using the &%-D%& option causes all definitions and redefinitions within the
4816 file to be ignored.
4817
4818
4819
4820 .section "Example of macro usage" "SECID45"
4821 As an example of macro usage, consider a configuration where aliases are looked
4822 up in a MySQL database. It helps to keep the file less cluttered if long
4823 strings such as SQL statements are defined separately as macros, for example:
4824 .code
4825 ALIAS_QUERY = select mailbox from user where \
4826               login='${quote_mysql:$local_part}';
4827 .endd
4828 This can then be used in a &(redirect)& router setting like this:
4829 .code
4830 data = ${lookup mysql{ALIAS_QUERY}}
4831 .endd
4832 In earlier versions of Exim macros were sometimes used for domain, host, or
4833 address lists. In Exim 4 these are handled better by named lists &-- see
4834 section &<<SECTnamedlists>>&.
4835
4836
4837 .section "Conditional skips in the configuration file" "SECID46"
4838 .cindex "configuration file" "conditional skips"
4839 .cindex "&`.ifdef`&"
4840 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4841 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4842 portions of the configuration file. The processing happens whenever the file is
4843 read (that is, when an Exim binary starts to run).
4844
4845 The implementation is very simple. Instances of the first four directives must
4846 be followed by text that includes the names of one or macros. The condition
4847 that is tested is whether or not any macro substitution has taken place in the
4848 line. Thus:
4849 .code
4850 .ifdef AAA
4851 message_size_limit = 50M
4852 .else
4853 message_size_limit = 100M
4854 .endif
4855 .endd
4856 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
4857 otherwise. If there is more than one macro named on the line, the condition
4858 is true if any of them are defined. That is, it is an &"or"& condition. To
4859 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
4860
4861 Although you can use a macro expansion to generate one of these directives,
4862 it is not very useful, because the condition &"there was a macro substitution
4863 in this line"& will always be true.
4864
4865 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
4866 to clarify complicated nestings.
4867
4868
4869
4870 .section "Common option syntax" "SECTcos"
4871 .cindex "common option syntax"
4872 .cindex "syntax of common options"
4873 .cindex "configuration file" "common option syntax"
4874 For the main set of options, driver options, and &[local_scan()]& options,
4875 each setting is on a line by itself, and starts with a name consisting of
4876 lower-case letters and underscores. Many options require a data value, and in
4877 these cases the name must be followed by an equals sign (with optional white
4878 space) and then the value. For example:
4879 .code
4880 qualify_domain = mydomain.example.com
4881 .endd
4882 .cindex "hiding configuration option values"
4883 .cindex "configuration options" "hiding value of"
4884 .cindex "options" "hiding value of"
4885 Some option settings may contain sensitive data, for example, passwords for
4886 accessing databases. To stop non-admin users from using the &%-bP%& command
4887 line option to read these values, you can precede the option settings with the
4888 word &"hide"&. For example:
4889 .code
4890 hide mysql_servers = localhost/users/admin/secret-password
4891 .endd
4892 For non-admin users, such options are displayed like this:
4893 .code
4894 mysql_servers = <value not displayable>
4895 .endd
4896 If &"hide"& is used on a driver option, it hides the value of that option on
4897 all instances of the same driver.
4898
4899 The following sections describe the syntax used for the different data types
4900 that are found in option settings.
4901
4902
4903 .section "Boolean options" "SECID47"
4904 .cindex "format" "boolean"
4905 .cindex "boolean configuration values"
4906 .oindex "&%no_%&&'xxx'&"
4907 .oindex "&%not_%&&'xxx'&"
4908 Options whose type is given as boolean are on/off switches. There are two
4909 different ways of specifying such options: with and without a data value. If
4910 the option name is specified on its own without data, the switch is turned on;
4911 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
4912 boolean options may be followed by an equals sign and one of the words
4913 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
4914 the following two settings have exactly the same effect:
4915 .code
4916 queue_only
4917 queue_only = true
4918 .endd
4919 The following two lines also have the same (opposite) effect:
4920 .code
4921 no_queue_only
4922 queue_only = false
4923 .endd
4924 You can use whichever syntax you prefer.
4925
4926
4927
4928
4929 .section "Integer values" "SECID48"
4930 .cindex "integer configuration values"
4931 .cindex "format" "integer"
4932 If an option's type is given as &"integer"&, the value can be given in decimal,
4933 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
4934 number is assumed. Otherwise, it is treated as an octal number unless it starts
4935 with the characters &"0x"&, in which case the remainder is interpreted as a
4936 hexadecimal number.
4937
4938 If an integer value is followed by the letter K, it is multiplied by 1024; if
4939 it is followed by the letter M, it is multiplied by 1024x1024. When the values
4940 of integer option settings are output, values which are an exact multiple of
4941 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
4942 and M. The printing style is independent of the actual input format that was
4943 used.
4944
4945
4946 .section "Octal integer values" "SECID49"
4947 .cindex "integer format"
4948 .cindex "format" "octal integer"
4949 If an option's type is given as &"octal integer"&, its value is always
4950 interpreted as an octal number, whether or not it starts with the digit zero.
4951 Such options are always output in octal.
4952
4953
4954 .section "Fixed point numbers" "SECID50"
4955 .cindex "fixed point configuration values"
4956 .cindex "format" "fixed point"
4957 If an option's type is given as &"fixed-point"&, its value must be a decimal
4958 integer, optionally followed by a decimal point and up to three further digits.
4959
4960
4961
4962 .section "Time intervals" "SECTtimeformat"
4963 .cindex "time interval" "specifying in configuration"
4964 .cindex "format" "time interval"
4965 A time interval is specified as a sequence of numbers, each followed by one of
4966 the following letters, with no intervening white space:
4967
4968 .table2 30pt
4969 .irow &%s%& seconds
4970 .irow &%m%& minutes
4971 .irow &%h%& hours
4972 .irow &%d%& days
4973 .irow &%w%& weeks
4974 .endtable
4975
4976 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
4977 intervals are output in the same format. Exim does not restrict the values; it
4978 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
4979
4980
4981
4982 .section "String values" "SECTstrings"
4983 .cindex "string" "format of configuration values"
4984 .cindex "format" "string"
4985 If an option's type is specified as &"string"&, the value can be specified with
4986 or without double-quotes. If it does not start with a double-quote, the value
4987 consists of the remainder of the line plus any continuation lines, starting at
4988 the first character after any leading white space, with trailing white space
4989 removed, and with no interpretation of the characters in the string. Because
4990 Exim removes comment lines (those beginning with #) at an early stage, they can
4991 appear in the middle of a multi-line string. The following two settings are
4992 therefore equivalent:
4993 .code
4994 trusted_users = uucp:mail
4995 trusted_users = uucp:\
4996                 # This comment line is ignored
4997                 mail
4998 .endd
4999 .cindex "string" "quoted"
5000 .cindex "escape characters in quoted strings"
5001 If a string does start with a double-quote, it must end with a closing
5002 double-quote, and any backslash characters other than those used for line
5003 continuation are interpreted as escape characters, as follows:
5004
5005 .table2 100pt
5006 .irow &`\\`&                     "single backslash"
5007 .irow &`\n`&                     "newline"
5008 .irow &`\r`&                     "carriage return"
5009 .irow &`\t`&                     "tab"
5010 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5011 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5012                                    character"
5013 .endtable
5014
5015 If a backslash is followed by some other character, including a double-quote
5016 character, that character replaces the pair.
5017
5018 Quoting is necessary only if you want to make use of the backslash escapes to
5019 insert special characters, or if you need to specify a value with leading or
5020 trailing spaces. These cases are rare, so quoting is almost never needed in
5021 current versions of Exim. In versions of Exim before 3.14, quoting was required
5022 in order to continue lines, so you may come across older configuration files
5023 and examples that apparently quote unnecessarily.
5024
5025
5026 .section "Expanded strings" "SECID51"
5027 .cindex "expansion" "definition of"
5028 Some strings in the configuration file are subjected to &'string expansion'&,
5029 by which means various parts of the string may be changed according to the
5030 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5031 is as just described; in particular, the handling of backslashes in quoted
5032 strings is done as part of the input process, before expansion takes place.
5033 However, backslash is also an escape character for the expander, so any
5034 backslashes that are required for that reason must be doubled if they are
5035 within a quoted configuration string.
5036
5037
5038 .section "User and group names" "SECID52"
5039 .cindex "user name" "format of"
5040 .cindex "format" "user name"
5041 .cindex "groups" "name format"
5042 .cindex "format" "group name"
5043 User and group names are specified as strings, using the syntax described
5044 above, but the strings are interpreted specially. A user or group name must
5045 either consist entirely of digits, or be a name that can be looked up using the
5046 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5047
5048
5049 .section "List construction" "SECTlistconstruct"
5050 .cindex "list" "syntax of in configuration"
5051 .cindex "format" "list item in configuration"
5052 .cindex "string" "list, definition of"
5053 The data for some configuration options is a list of items, with colon as the
5054 default separator. Many of these options are shown with type &"string list"& in
5055 the descriptions later in this document. Others are listed as &"domain list"&,
5056 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5057 are all the same; however, those other than &"string list"& are subject to
5058 particular kinds of interpretation, as described in chapter
5059 &<<CHAPdomhosaddlists>>&.
5060
5061 In all these cases, the entire list is treated as a single string as far as the
5062 input syntax is concerned. The &%trusted_users%& setting in section
5063 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5064 in a list, it must be entered as two colons. Leading and trailing white space
5065 on each item in a list is ignored. This makes it possible to include items that
5066 start with a colon, and in particular, certain forms of IPv6 address. For
5067 example, the list
5068 .code
5069 local_interfaces = 127.0.0.1 : ::::1
5070 .endd
5071 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5072
5073 &*Note*&: Although leading and trailing white space is ignored in individual
5074 list items, it is not ignored when parsing the list. The space after the first
5075 colon in the example above is necessary. If it were not there, the list would
5076 be interpreted as the two items 127.0.0.1:: and 1.
5077
5078 .section "Changing list separators" "SECID53"
5079 .cindex "list separator" "changing"
5080 .cindex "IPv6" "addresses in lists"
5081 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5082 introduced to allow the separator character to be changed. If a list begins
5083 with a left angle bracket, followed by any punctuation character, that
5084 character is used instead of colon as the list separator. For example, the list
5085 above can be rewritten to use a semicolon separator like this:
5086 .code
5087 local_interfaces = <; 127.0.0.1 ; ::1
5088 .endd
5089 This facility applies to all lists, with the exception of the list in
5090 &%log_file_path%&. It is recommended that the use of non-colon separators be
5091 confined to circumstances where they really are needed.
5092
5093 .cindex "list separator" "newline as"
5094 .cindex "newline" "as list separator"
5095 It is also possible to use newline and other control characters (those with
5096 code values less than 32, plus DEL) as separators in lists. Such separators
5097 must be provided literally at the time the list is processed. For options that
5098 are string-expanded, you can write the separator using a normal escape
5099 sequence. This will be processed by the expander before the string is
5100 interpreted as a list. For example, if a newline-separated list of domains is
5101 generated by a lookup, you can process it directly by a line such as this:
5102 .code
5103 domains = <\n ${lookup mysql{.....}}
5104 .endd
5105 This avoids having to change the list separator in such data. You are unlikely
5106 to want to use a control character as a separator in an option that is not
5107 expanded, because the value is literal text. However, it can be done by giving
5108 the value in quotes. For example:
5109 .code
5110 local_interfaces = "<\n 127.0.0.1 \n ::1"
5111 .endd
5112 Unlike printing character separators, which can be included in list items by
5113 doubling, it is not possible to include a control character as data when it is
5114 set as the separator. Two such characters in succession are interpreted as
5115 enclosing an empty list item.
5116
5117
5118
5119 .section "Empty items in lists" "SECTempitelis"
5120 .cindex "list" "empty item in"
5121 An empty item at the end of a list is always ignored. In other words, trailing
5122 separator characters are ignored. Thus, the list in
5123 .code
5124 senders = user@domain :
5125 .endd
5126 contains only a single item. If you want to include an empty string as one item
5127 in a list, it must not be the last item. For example, this list contains three
5128 items, the second of which is empty:
5129 .code
5130 senders = user1@domain : : user2@domain
5131 .endd
5132 &*Note*&: There must be white space between the two colons, as otherwise they
5133 are interpreted as representing a single colon data character (and the list
5134 would then contain just one item). If you want to specify a list that contains
5135 just one, empty item, you can do it as in this example:
5136 .code
5137 senders = :
5138 .endd
5139 In this case, the first item is empty, and the second is discarded because it
5140 is at the end of the list.
5141
5142
5143
5144
5145 .section "Format of driver configurations" "SECTfordricon"
5146 .cindex "drivers" "configuration format"
5147 There are separate parts in the configuration for defining routers, transports,
5148 and authenticators. In each part, you are defining a number of driver
5149 instances, each with its own set of options. Each driver instance is defined by
5150 a sequence of lines like this:
5151 .display
5152 <&'instance name'&>:
5153   <&'option'&>
5154   ...
5155   <&'option'&>
5156 .endd
5157 In the following example, the instance name is &(localuser)&, and it is
5158 followed by three options settings:
5159 .code
5160 localuser:
5161   driver = accept
5162   check_local_user
5163   transport = local_delivery
5164 .endd
5165 For each driver instance, you specify which Exim code module it uses &-- by the
5166 setting of the &%driver%& option &-- and (optionally) some configuration
5167 settings. For example, in the case of transports, if you want a transport to
5168 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5169 a local file you would use the &(appendfile)& driver. Each of the drivers is
5170 described in detail in its own separate chapter later in this manual.
5171
5172 You can have several routers, transports, or authenticators that are based on
5173 the same underlying driver (each must have a different instance name).
5174
5175 The order in which routers are defined is important, because addresses are
5176 passed to individual routers one by one, in order. The order in which
5177 transports are defined does not matter at all. The order in which
5178 authenticators are defined is used only when Exim, as a client, is searching
5179 them to find one that matches an authentication mechanism offered by the
5180 server.
5181
5182 .cindex "generic options"
5183 .cindex "options" "generic &-- definition of"
5184 Within a driver instance definition, there are two kinds of option: &'generic'&
5185 and &'private'&. The generic options are those that apply to all drivers of the
5186 same type (that is, all routers, all transports or all authenticators). The
5187 &%driver%& option is a generic option that must appear in every definition.
5188 .cindex "private options"
5189 The private options are special for each driver, and none need appear, because
5190 they all have default values.
5191
5192 The options may appear in any order, except that the &%driver%& option must
5193 precede any private options, since these depend on the particular driver. For
5194 this reason, it is recommended that &%driver%& always be the first option.
5195
5196 Driver instance names, which are used for reference in log entries and
5197 elsewhere, can be any sequence of letters, digits, and underscores (starting
5198 with a letter) and must be unique among drivers of the same type. A router and
5199 a transport (for example) can each have the same name, but no two router
5200 instances can have the same name. The name of a driver instance should not be
5201 confused with the name of the underlying driver module. For example, the
5202 configuration lines:
5203 .code
5204 remote_smtp:
5205   driver = smtp
5206 .endd
5207 create an instance of the &(smtp)& transport driver whose name is
5208 &(remote_smtp)&. The same driver code can be used more than once, with
5209 different instance names and different option settings each time. A second
5210 instance of the &(smtp)& transport, with different options, might be defined
5211 thus:
5212 .code
5213 special_smtp:
5214   driver = smtp
5215   port = 1234
5216   command_timeout = 10s
5217 .endd
5218 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5219 these transport instances from routers, and these names would appear in log
5220 lines.
5221
5222 Comment lines may be present in the middle of driver specifications. The full
5223 list of option settings for any particular driver instance, including all the
5224 defaulted values, can be extracted by making use of the &%-bP%& command line
5225 option.
5226
5227
5228
5229
5230
5231
5232 . ////////////////////////////////////////////////////////////////////////////
5233 . ////////////////////////////////////////////////////////////////////////////
5234
5235 .chapter "The default configuration file" "CHAPdefconfil"
5236 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5237 .cindex "default" "configuration file &""walk through""&"
5238 The default configuration file supplied with Exim as &_src/configure.default_&
5239 is sufficient for a host with simple mail requirements. As an introduction to
5240 the way Exim is configured, this chapter &"walks through"& the default
5241 configuration, giving brief explanations of the settings. Detailed descriptions
5242 of the options are given in subsequent chapters. The default configuration file
5243 itself contains extensive comments about ways you might want to modify the
5244 initial settings. However, note that there are many options that are not
5245 mentioned at all in the default configuration.
5246
5247
5248
5249 .section "Main configuration settings" "SECTdefconfmain"
5250 The main (global) configuration option settings must always come first in the
5251 file. The first thing you'll see in the file, after some initial comments, is
5252 the line
5253 .code
5254 # primary_hostname =
5255 .endd
5256 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5257 to know the official, fully qualified name of your host, and this is where you
5258 can specify it. However, in most cases you do not need to set this option. When
5259 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5260
5261 The first three non-comment configuration lines are as follows:
5262 .code
5263 domainlist local_domains = @
5264 domainlist relay_to_domains =
5265 hostlist   relay_from_hosts = 127.0.0.1
5266 .endd
5267 These are not, in fact, option settings. They are definitions of two named
5268 domain lists and one named host list. Exim allows you to give names to lists of
5269 domains, hosts, and email addresses, in order to make it easier to manage the
5270 configuration file (see section &<<SECTnamedlists>>&).
5271
5272 The first line defines a domain list called &'local_domains'&; this is used
5273 later in the configuration to identify domains that are to be delivered
5274 on the local host.
5275
5276 .cindex "@ in a domain list"
5277 There is just one item in this list, the string &"@"&. This is a special form
5278 of entry which means &"the name of the local host"&. Thus, if the local host is
5279 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5280 be delivered locally. Because the local host's name is referenced indirectly,
5281 the same configuration file can be used on different hosts.
5282
5283 The second line defines a domain list called &'relay_to_domains'&, but the
5284 list itself is empty. Later in the configuration we will come to the part that
5285 controls mail relaying through the local host; it allows relaying to any
5286 domains in this list. By default, therefore, no relaying on the basis of a mail
5287 domain is permitted.
5288
5289 The third line defines a host list called &'relay_from_hosts'&. This list is
5290 used later in the configuration to permit relaying from any host or IP address
5291 that matches the list. The default contains just the IP address of the IPv4
5292 loopback interface, which means that processes on the local host are able to
5293 submit mail for relaying by sending it over TCP/IP to that interface. No other
5294 hosts are permitted to submit messages for relaying.
5295
5296 Just to be sure there's no misunderstanding: at this point in the configuration
5297 we aren't actually setting up any controls. We are just defining some domains
5298 and hosts that will be used in the controls that are specified later.
5299
5300 The next two configuration lines are genuine option settings:
5301 .code
5302 acl_smtp_rcpt = acl_check_rcpt
5303 acl_smtp_data = acl_check_data
5304 .endd
5305 These options specify &'Access Control Lists'& (ACLs) that are to be used
5306 during an incoming SMTP session for every recipient of a message (every RCPT
5307 command), and after the contents of the message have been received,
5308 respectively. The names of the lists are &'acl_check_rcpt'& and
5309 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5310 section of the configuration. The RCPT ACL controls which recipients are
5311 accepted for an incoming message &-- if a configuration does not provide an ACL
5312 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5313 contents of a message to be checked.
5314
5315 Two commented-out option settings are next:
5316 .code
5317 # av_scanner = clamd:/tmp/clamd
5318 # spamd_address = 127.0.0.1 783
5319 .endd
5320 These are example settings that can be used when Exim is compiled with the
5321 content-scanning extension. The first specifies the interface to the virus
5322 scanner, and the second specifies the interface to SpamAssassin. Further
5323 details are given in chapter &<<CHAPexiscan>>&.
5324
5325 Three more commented-out option settings follow:
5326 .code
5327 # tls_advertise_hosts = *
5328 # tls_certificate = /etc/ssl/exim.crt
5329 # tls_privatekey = /etc/ssl/exim.pem
5330 .endd
5331 These are example settings that can be used when Exim is compiled with
5332 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5333 first one specifies the list of clients that are allowed to use TLS when
5334 connecting to this server; in this case the wildcard means all clients. The
5335 other options specify where Exim should find its TLS certificate and private
5336 key, which together prove the server's identity to any clients that connect.
5337 More details are given in chapter &<<CHAPTLS>>&.
5338
5339 Another two commented-out option settings follow:
5340 .code
5341 # daemon_smtp_ports = 25 : 465 : 587
5342 # tls_on_connect_ports = 465
5343 .endd
5344 .cindex "port" "465 and 587"
5345 .cindex "port" "for message submission"
5346 .cindex "message" "submission, ports for"
5347 .cindex "ssmtp protocol"
5348 .cindex "smtps protocol"
5349 .cindex "SMTP" "ssmtp protocol"
5350 .cindex "SMTP" "smtps protocol"
5351 These options provide better support for roaming users who wish to use this
5352 server for message submission. They are not much use unless you have turned on
5353 TLS (as described in the previous paragraph) and authentication (about which
5354 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5355 on end-user networks, so RFC 4409 specifies that message submission should use
5356 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5357 configured to use port 587 correctly, so these settings also enable the
5358 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5359 &<<SECTsupobssmt>>&).
5360
5361 Two more commented-out options settings follow:
5362 .code
5363 # qualify_domain =
5364 # qualify_recipient =
5365 .endd
5366 The first of these specifies a domain that Exim uses when it constructs a
5367 complete email address from a local login name. This is often needed when Exim
5368 receives a message from a local process. If you do not set &%qualify_domain%&,
5369 the value of &%primary_hostname%& is used. If you set both of these options,
5370 you can have different qualification domains for sender and recipient
5371 addresses. If you set only the first one, its value is used in both cases.
5372
5373 .cindex "domain literal" "recognizing format"
5374 The following line must be uncommented if you want Exim to recognize
5375 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5376 (an IP address within square brackets) instead of a named domain.
5377 .code
5378 # allow_domain_literals
5379 .endd
5380 The RFCs still require this form, but many people think that in the modern
5381 Internet it makes little sense to permit mail to be sent to specific hosts by
5382 quoting their IP addresses. This ancient format has been used by people who
5383 try to abuse hosts by using them for unwanted relaying. However, some
5384 people believe there are circumstances (for example, messages addressed to
5385 &'postmaster'&) where domain literals are still useful.
5386
5387 The next configuration line is a kind of trigger guard:
5388 .code
5389 never_users = root
5390 .endd
5391 It specifies that no delivery must ever be run as the root user. The normal
5392 convention is to set up &'root'& as an alias for the system administrator. This
5393 setting is a guard against slips in the configuration.
5394 The list of users specified by &%never_users%& is not, however, the complete
5395 list; the build-time configuration in &_Local/Makefile_& has an option called
5396 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5397 contents of &%never_users%& are added to this list. By default
5398 FIXED_NEVER_USERS also specifies root.
5399
5400 When a remote host connects to Exim in order to send mail, the only information
5401 Exim has about the host's identity is its IP address. The next configuration
5402 line,
5403 .code
5404 host_lookup = *
5405 .endd
5406 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5407 in order to get a host name. This improves the quality of the logging
5408 information, but if you feel it is too expensive, you can remove it entirely,
5409 or restrict the lookup to hosts on &"nearby"& networks.
5410 Note that it is not always possible to find a host name from an IP address,
5411 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5412 unreachable.
5413
5414 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5415 1413 (hence their names):
5416 .code
5417 rfc1413_hosts = *
5418 rfc1413_query_timeout = 5s
5419 .endd
5420 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5421 You can limit the hosts to which these calls are made, or change the timeout
5422 that is used. If you set the timeout to zero, all ident calls are disabled.
5423 Although they are cheap and can provide useful information for tracing problem
5424 messages, some hosts and firewalls have problems with ident calls. This can
5425 result in a timeout instead of an immediate refused connection, leading to
5426 delays on starting up an incoming SMTP session.
5427
5428 When Exim receives messages over SMTP connections, it expects all addresses to
5429 be fully qualified with a domain, as required by the SMTP definition. However,
5430 if you are running a server to which simple clients submit messages, you may
5431 find that they send unqualified addresses. The two commented-out options:
5432 .code
5433 # sender_unqualified_hosts =
5434 # recipient_unqualified_hosts =
5435 .endd
5436 show how you can specify hosts that are permitted to send unqualified sender
5437 and recipient addresses, respectively.
5438
5439 The &%percent_hack_domains%& option is also commented out:
5440 .code
5441 # percent_hack_domains =
5442 .endd
5443 It provides a list of domains for which the &"percent hack"& is to operate.
5444 This is an almost obsolete form of explicit email routing. If you do not know
5445 anything about it, you can safely ignore this topic.
5446
5447 The last two settings in the main part of the default configuration are
5448 concerned with messages that have been &"frozen"& on Exim's queue. When a
5449 message is frozen, Exim no longer continues to try to deliver it. Freezing
5450 occurs when a bounce message encounters a permanent failure because the sender
5451 address of the original message that caused the bounce is invalid, so the
5452 bounce cannot be delivered. This is probably the most common case, but there
5453 are also other conditions that cause freezing, and frozen messages are not
5454 always bounce messages.
5455 .code
5456 ignore_bounce_errors_after = 2d
5457 timeout_frozen_after = 7d
5458 .endd
5459 The first of these options specifies that failing bounce messages are to be
5460 discarded after 2 days on the queue. The second specifies that any frozen
5461 message (whether a bounce message or not) is to be timed out (and discarded)
5462 after a week. In this configuration, the first setting ensures that no failing
5463 bounce message ever lasts a week.
5464
5465
5466
5467 .section "ACL configuration" "SECID54"
5468 .cindex "default" "ACLs"
5469 .cindex "&ACL;" "default configuration"
5470 In the default configuration, the ACL section follows the main configuration.
5471 It starts with the line
5472 .code
5473 begin acl
5474 .endd
5475 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5476 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5477 and &%acl_smtp_data%& above.
5478
5479 .cindex "RCPT" "ACL for"
5480 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5481 RCPT command specifies one of the message's recipients. The ACL statements
5482 are considered in order, until the recipient address is either accepted or
5483 rejected. The RCPT command is then accepted or rejected, according to the
5484 result of the ACL processing.
5485 .code
5486 acl_check_rcpt:
5487 .endd
5488 This line, consisting of a name terminated by a colon, marks the start of the
5489 ACL, and names it.
5490 .code
5491 accept  hosts = :
5492 .endd
5493 This ACL statement accepts the recipient if the sending host matches the list.
5494 But what does that strange list mean? It doesn't actually contain any host
5495 names or IP addresses. The presence of the colon puts an empty item in the
5496 list; Exim matches this only if the incoming message did not come from a remote
5497 host, because in that case, the remote hostname is empty. The colon is
5498 important. Without it, the list itself is empty, and can never match anything.
5499
5500 What this statement is doing is to accept unconditionally all recipients in
5501 messages that are submitted by SMTP from local processes using the standard
5502 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5503 manner.
5504 .code
5505 deny    message       = Restricted characters in address
5506         domains       = +local_domains
5507         local_parts   = ^[.] : ^.*[@%!/|]
5508
5509 deny    message       = Restricted characters in address
5510         domains       = !+local_domains
5511         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5512 .endd
5513 These statements are concerned with local parts that contain any of the
5514 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5515 Although these characters are entirely legal in local parts (in the case of
5516 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5517 in Internet mail addresses.
5518
5519 The first three have in the past been associated with explicitly routed
5520 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5521 option). Addresses containing these characters are regularly tried by spammers
5522 in an attempt to bypass relaying restrictions, and also by open relay testing
5523 programs. Unless you really need them it is safest to reject these characters
5524 at this early stage. This configuration is heavy-handed in rejecting these
5525 characters for all messages it accepts from remote hosts. This is a deliberate
5526 policy of being as safe as possible.
5527
5528 The first rule above is stricter, and is applied to messages that are addressed
5529 to one of the local domains handled by this host. This is implemented by the
5530 first condition, which restricts it to domains that are listed in the
5531 &'local_domains'& domain list. The &"+"& character is used to indicate a
5532 reference to a named list. In this configuration, there is just one domain in
5533 &'local_domains'&, but in general there may be many.
5534
5535 The second condition on the first statement uses two regular expressions to
5536 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5537 or &"|"&. If you have local accounts that include these characters, you will
5538 have to modify this rule.
5539
5540 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5541 allows them because they have been encountered in practice. (Consider the
5542 common convention of local parts constructed as
5543 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5544 the author of Exim, who has no second initial.) However, a local part starting
5545 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5546 file name (for example, for a mailing list). This is also true for local parts
5547 that contain slashes. A pipe symbol can also be troublesome if the local part
5548 is incorporated unthinkingly into a shell command line.
5549
5550 The second rule above applies to all other domains, and is less strict. This
5551 allows your own users to send outgoing messages to sites that use slashes
5552 and vertical bars in their local parts. It blocks local parts that begin
5553 with a dot, slash, or vertical bar, but allows these characters within the
5554 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5555 and &"!"& is blocked, as before. The motivation here is to prevent your users
5556 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5557 .code
5558 accept  local_parts   = postmaster
5559         domains       = +local_domains
5560 .endd
5561 This statement, which has two conditions, accepts an incoming address if the
5562 local part is &'postmaster'& and the domain is one of those listed in the
5563 &'local_domains'& domain list. The &"+"& character is used to indicate a
5564 reference to a named list. In this configuration, there is just one domain in
5565 &'local_domains'&, but in general there may be many.
5566
5567 The presence of this statement means that mail to postmaster is never blocked
5568 by any of the subsequent tests. This can be helpful while sorting out problems
5569 in cases where the subsequent tests are incorrectly denying access.
5570 .code
5571 require verify        = sender
5572 .endd
5573 This statement requires the sender address to be verified before any subsequent
5574 ACL statement can be used. If verification fails, the incoming recipient
5575 address is refused. Verification consists of trying to route the address, to
5576 see if a bounce message could be delivered to it. In the case of remote
5577 addresses, basic verification checks only the domain, but &'callouts'& can be
5578 used for more verification if required. Section &<<SECTaddressverification>>&
5579 discusses the details of address verification.
5580 .code
5581 accept  hosts         = +relay_from_hosts
5582         control       = submission
5583 .endd
5584 This statement accepts the address if the message is coming from one of the
5585 hosts that are defined as being allowed to relay through this host. Recipient
5586 verification is omitted here, because in many cases the clients are dumb MUAs
5587 that do not cope well with SMTP error responses. For the same reason, the
5588 second line specifies &"submission mode"& for messages that are accepted. This
5589 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5590 messages that are deficient in some way, for example, because they lack a
5591 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5592 probably add recipient verification here, and disable submission mode.
5593 .code
5594 accept  authenticated = *
5595         control       = submission
5596 .endd
5597 This statement accepts the address if the client host has authenticated itself.
5598 Submission mode is again specified, on the grounds that such messages are most
5599 likely to come from MUAs. The default configuration does not define any
5600 authenticators, though it does include some nearly complete commented-out
5601 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5602 fact authenticate until you complete the authenticator definitions.
5603 .code
5604 require message = relay not permitted
5605         domains = +local_domains : +relay_domains
5606 .endd
5607 This statement rejects the address if its domain is neither a local domain nor
5608 one of the domains for which this host is a relay.
5609 .code
5610 require verify = recipient
5611 .endd
5612 This statement requires the recipient address to be verified; if verification
5613 fails, the address is rejected.
5614 .code
5615 # deny    message     = rejected because $sender_host_address \
5616 #                       is in a black list at $dnslist_domain\n\
5617 #                       $dnslist_text
5618 #         dnslists    = black.list.example
5619 #
5620 # warn    dnslists    = black.list.example
5621 #         add_header  = X-Warning: $sender_host_address is in \
5622 #                       a black list at $dnslist_domain
5623 #         log_message = found in $dnslist_domain
5624 .endd
5625 These commented-out lines are examples of how you could configure Exim to check
5626 sending hosts against a DNS black list. The first statement rejects messages
5627 from blacklisted hosts, whereas the second just inserts a warning header
5628 line.
5629 .code
5630 # require verify = csa
5631 .endd
5632 This commented-out line is an example of how you could turn on client SMTP
5633 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5634 records.
5635 .code
5636 accept
5637 .endd
5638 The final statement in the first ACL unconditionally accepts any recipient
5639 address that has successfully passed all the previous tests.
5640 .code
5641 acl_check_data:
5642 .endd
5643 This line marks the start of the second ACL, and names it. Most of the contents
5644 of this ACL are commented out:
5645 .code
5646 # deny    malware   = *
5647 #         message   = This message contains a virus \
5648 #                     ($malware_name).
5649 .endd
5650 These lines are examples of how to arrange for messages to be scanned for
5651 viruses when Exim has been compiled with the content-scanning extension, and a
5652 suitable virus scanner is installed. If the message is found to contain a
5653 virus, it is rejected with the given custom error message.
5654 .code
5655 # warn    spam      = nobody
5656 #         message   = X-Spam_score: $spam_score\n\
5657 #                     X-Spam_score_int: $spam_score_int\n\
5658 #                     X-Spam_bar: $spam_bar\n\
5659 #                     X-Spam_report: $spam_report
5660 .endd
5661 These lines are an example of how to arrange for messages to be scanned by
5662 SpamAssassin when Exim has been compiled with the content-scanning extension,
5663 and SpamAssassin has been installed. The SpamAssassin check is run with
5664 &`nobody`& as its user parameter, and the results are added to the message as a
5665 series of extra header line. In this case, the message is not rejected,
5666 whatever the spam score.
5667 .code
5668 accept
5669 .endd
5670 This final line in the DATA ACL accepts the message unconditionally.
5671
5672
5673 .section "Router configuration" "SECID55"
5674 .cindex "default" "routers"
5675 .cindex "routers" "default"
5676 The router configuration comes next in the default configuration, introduced
5677 by the line
5678 .code
5679 begin routers
5680 .endd
5681 Routers are the modules in Exim that make decisions about where to send
5682 messages. An address is passed to each router in turn, until it is either
5683 accepted, or failed. This means that the order in which you define the routers
5684 matters. Each router is fully described in its own chapter later in this
5685 manual. Here we give only brief overviews.
5686 .code
5687 # domain_literal:
5688 #   driver = ipliteral
5689 #   domains = !+local_domains
5690 #   transport = remote_smtp
5691 .endd
5692 .cindex "domain literal" "default router"
5693 This router is commented out because the majority of sites do not want to
5694 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5695 you uncomment this router, you also need to uncomment the setting of
5696 &%allow_domain_literals%& in the main part of the configuration.
5697 .code
5698 dnslookup:
5699   driver = dnslookup
5700   domains = ! +local_domains
5701   transport = remote_smtp
5702   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5703   no_more
5704 .endd
5705 The first uncommented router handles addresses that do not involve any local
5706 domains. This is specified by the line
5707 .code
5708 domains = ! +local_domains
5709 .endd
5710 The &%domains%& option lists the domains to which this router applies, but the
5711 exclamation mark is a negation sign, so the router is used only for domains
5712 that are not in the domain list called &'local_domains'& (which was defined at
5713 the start of the configuration). The plus sign before &'local_domains'&
5714 indicates that it is referring to a named list. Addresses in other domains are
5715 passed on to the following routers.
5716
5717 The name of the router driver is &(dnslookup)&,
5718 and is specified by the &%driver%& option. Do not be confused by the fact that
5719 the name of this router instance is the same as the name of the driver. The
5720 instance name is arbitrary, but the name set in the &%driver%& option must be
5721 one of the driver modules that is in the Exim binary.
5722
5723 The &(dnslookup)& router routes addresses by looking up their domains in the
5724 DNS in order to obtain a list of hosts to which the address is routed. If the
5725 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5726 specified by the &%transport%& option. If the router does not find the domain
5727 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5728 the address fails and is bounced.
5729
5730 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5731 be entirely ignored. This option is present because a number of cases have been
5732 encountered where MX records in the DNS point to host names
5733 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5734 Completely ignoring these IP addresses causes Exim to fail to route the
5735 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5736 continue to try to deliver the message periodically until the address timed
5737 out.
5738 .code
5739 system_aliases:
5740   driver = redirect
5741   allow_fail
5742   allow_defer
5743   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5744 # user = exim
5745   file_transport = address_file
5746   pipe_transport = address_pipe
5747 .endd
5748 Control reaches this and subsequent routers only for addresses in the local
5749 domains. This router checks to see whether the local part is defined as an
5750 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5751 data that it looks up from that file. If no data is found for the local part,
5752 the value of the &%data%& option is empty, causing the address to be passed to
5753 the next router.
5754
5755 &_/etc/aliases_& is a conventional name for the system aliases file that is
5756 often used. That is why it is referenced by from the default configuration
5757 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5758 &_Local/Makefile_& before building Exim.
5759 .code
5760 userforward:
5761   driver = redirect
5762   check_local_user
5763 # local_part_suffix = +* : -*
5764 # local_part_suffix_optional
5765   file = $home/.forward
5766 # allow_filter
5767   no_verify
5768   no_expn
5769   check_ancestor
5770   file_transport = address_file
5771   pipe_transport = address_pipe
5772   reply_transport = address_reply
5773 .endd
5774 This is the most complicated router in the default configuration. It is another
5775 redirection router, but this time it is looking for forwarding data set up by
5776 individual users. The &%check_local_user%& setting specifies a check that the
5777 local part of the address is the login name of a local user. If it is not, the
5778 router is skipped. The two commented options that follow &%check_local_user%&,
5779 namely:
5780 .code
5781 # local_part_suffix = +* : -*
5782 # local_part_suffix_optional
5783 .endd
5784 .vindex "&$local_part_suffix$&"
5785 show how you can specify the recognition of local part suffixes. If the first
5786 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5787 by any sequence of characters, is removed from the local part and placed in the
5788 variable &$local_part_suffix$&. The second suffix option specifies that the
5789 presence of a suffix in the local part is optional. When a suffix is present,
5790 the check for a local login uses the local part with the suffix removed.
5791
5792 When a local user account is found, the file called &_.forward_& in the user's
5793 home directory is consulted. If it does not exist, or is empty, the router
5794 declines. Otherwise, the contents of &_.forward_& are interpreted as
5795 redirection data (see chapter &<<CHAPredirect>>& for more details).
5796
5797 .cindex "Sieve filter" "enabling in default router"
5798 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5799 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5800 is commented out by default), the contents of the file are interpreted as a set
5801 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5802 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5803 separate document entitled &'Exim's interfaces to mail filtering'&.
5804
5805 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5806 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5807 There are two reasons for doing this:
5808
5809 .olist
5810 Whether or not a local user has a &_.forward_& file is not really relevant when
5811 checking an address for validity; it makes sense not to waste resources doing
5812 unnecessary work.
5813 .next
5814 More importantly, when Exim is verifying addresses or handling an EXPN
5815 command during an SMTP session, it is running as the Exim user, not as root.
5816 The group is the Exim group, and no additional groups are set up.
5817 It may therefore not be possible for Exim to read users' &_.forward_& files at
5818 this time.
5819 .endlist
5820
5821 The setting of &%check_ancestor%& prevents the router from generating a new
5822 address that is the same as any previous address that was redirected. (This
5823 works round a problem concerning a bad interaction between aliasing and
5824 forwarding &-- see section &<<SECTredlocmai>>&).
5825
5826 The final three option settings specify the transports that are to be used when
5827 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5828 auto-reply, respectively. For example, if a &_.forward_& file contains
5829 .code
5830 a.nother@elsewhere.example, /home/spqr/archive
5831 .endd
5832 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5833 transport.
5834 .code
5835 localuser:
5836   driver = accept
5837   check_local_user
5838 # local_part_suffix = +* : -*
5839 # local_part_suffix_optional
5840   transport = local_delivery
5841 .endd
5842 The final router sets up delivery into local mailboxes, provided that the local
5843 part is the name of a local login, by accepting the address and assigning it to
5844 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5845 routers, so the address is bounced. The commented suffix settings fulfil the
5846 same purpose as they do for the &(userforward)& router.
5847
5848
5849 .section "Transport configuration" "SECID56"
5850 .cindex "default" "transports"
5851 .cindex "transports" "default"
5852 Transports define mechanisms for actually delivering messages. They operate
5853 only when referenced from routers, so the order in which they are defined does
5854 not matter. The transports section of the configuration starts with
5855 .code
5856 begin transports
5857 .endd
5858 One remote transport and four local transports are defined.
5859 .code
5860 remote_smtp:
5861   driver = smtp
5862 .endd
5863 This transport is used for delivering messages over SMTP connections. All its
5864 options are defaulted. The list of remote hosts comes from the router.
5865 .code
5866 local_delivery:
5867   driver = appendfile
5868   file = /var/mail/$local_part
5869   delivery_date_add
5870   envelope_to_add
5871   return_path_add
5872 # group = mail
5873 # mode = 0660
5874 .endd
5875 This &(appendfile)& transport is used for local delivery to user mailboxes in
5876 traditional BSD mailbox format. By default it runs under the uid and gid of the
5877 local user, which requires the sticky bit to be set on the &_/var/mail_&
5878 directory. Some systems use the alternative approach of running mail deliveries
5879 under a particular group instead of using the sticky bit. The commented options
5880 show how this can be done.
5881
5882 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
5883 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
5884 similarly-named options above.
5885 .code
5886 address_pipe:
5887   driver = pipe
5888   return_output
5889 .endd
5890 This transport is used for handling deliveries to pipes that are generated by
5891 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
5892 option specifies that any output generated by the pipe is to be returned to the
5893 sender.
5894 .code
5895 address_file:
5896   driver = appendfile
5897   delivery_date_add
5898   envelope_to_add
5899   return_path_add
5900 .endd
5901 This transport is used for handling deliveries to files that are generated by
5902 redirection. The name of the file is not specified in this instance of
5903 &(appendfile)&, because it comes from the &(redirect)& router.
5904 .code
5905 address_reply:
5906   driver = autoreply
5907 .endd
5908 This transport is used for handling automatic replies generated by users'
5909 filter files.
5910
5911
5912
5913 .section "Default retry rule" "SECID57"
5914 .cindex "retry" "default rule"
5915 .cindex "default" "retry rule"
5916 The retry section of the configuration file contains rules which affect the way
5917 Exim retries deliveries that cannot be completed at the first attempt. It is
5918 introduced by the line
5919 .code
5920 begin retry
5921 .endd
5922 In the default configuration, there is just one rule, which applies to all
5923 errors:
5924 .code
5925 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
5926 .endd
5927 This causes any temporarily failing address to be retried every 15 minutes for
5928 2 hours, then at intervals starting at one hour and increasing by a factor of
5929 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
5930 is not delivered after 4 days of temporary failure, it is bounced.
5931
5932 If the retry section is removed from the configuration, or is empty (that is,
5933 if no retry rules are defined), Exim will not retry deliveries. This turns
5934 temporary errors into permanent errors.
5935
5936
5937 .section "Rewriting configuration" "SECID58"
5938 The rewriting section of the configuration, introduced by
5939 .code
5940 begin rewrite
5941 .endd
5942 contains rules for rewriting addresses in messages as they arrive. There are no
5943 rewriting rules in the default configuration file.
5944
5945
5946
5947 .section "Authenticators configuration" "SECTdefconfauth"
5948 .cindex "AUTH" "configuration"
5949 The authenticators section of the configuration, introduced by
5950 .code
5951 begin authenticators
5952 .endd
5953 defines mechanisms for the use of the SMTP AUTH command. The default
5954 configuration file contains two commented-out example authenticators
5955 which support plaintext username/password authentication using the
5956 standard PLAIN mechanism and the traditional but non-standard LOGIN
5957 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
5958 to support most MUA software.
5959
5960 The example PLAIN authenticator looks like this:
5961 .code
5962 #PLAIN:
5963 #  driver                  = plaintext
5964 #  server_set_id           = $auth2
5965 #  server_prompts          = :
5966 #  server_condition        = Authentication is not yet configured
5967 #  server_advertise_condition = ${if def:tls_cipher }
5968 .endd
5969 And the example LOGIN authenticator looks like this:
5970 .code
5971 #LOGIN:
5972 #  driver                  = plaintext
5973 #  server_set_id           = $auth1
5974 #  server_prompts          = <| Username: | Password:
5975 #  server_condition        = Authentication is not yet configured
5976 #  server_advertise_condition = ${if def:tls_cipher }
5977 .endd
5978
5979 The &%server_set_id%& option makes Exim remember the authenticated username
5980 in &$authenticated_id$&, which can be used later in ACLs or routers. The
5981 &%server_prompts%& option configures the &(plaintext)& authenticator so
5982 that it implements the details of the specific authentication mechanism,
5983 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
5984 when Exim offers authentication to clients; in the examples, this is only
5985 when TLS or SSL has been started, so to enable the authenticators you also
5986 need to add support for TLS as described in &<<SECTdefconfmain>>&.
5987
5988 The &%server_condition%& setting defines how to verify that the username and
5989 password are correct. In the examples it just produces an error message.
5990 To make the authenticators work, you can use a string expansion
5991 expression like one of the examples in &<<CHAPplaintext>>&.
5992
5993 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
5994 usercode and password are in different positions.  &<<CHAPplaintext>>&
5995 covers both.
5996
5997 .ecindex IIDconfiwal
5998
5999
6000
6001 . ////////////////////////////////////////////////////////////////////////////
6002 . ////////////////////////////////////////////////////////////////////////////
6003
6004 .chapter "Regular expressions" "CHAPregexp"
6005
6006 .cindex "regular expressions" "library"
6007 .cindex "PCRE"
6008 Exim supports the use of regular expressions in many of its options. It
6009 uses the PCRE regular expression library; this provides regular expression
6010 matching that is compatible with Perl 5. The syntax and semantics of
6011 regular expressions is discussed in many Perl reference books, and also in
6012 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6013 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6014
6015 The documentation for the syntax and semantics of the regular expressions that
6016 are supported by PCRE is included in the PCRE distribution, and no further
6017 description is included here. The PCRE functions are called from Exim using
6018 the default option settings (that is, with no PCRE options set), except that
6019 the PCRE_CASELESS option is set when the matching is required to be
6020 case-insensitive.
6021
6022 In most cases, when a regular expression is required in an Exim configuration,
6023 it has to start with a circumflex, in order to distinguish it from plain text
6024 or an &"ends with"& wildcard. In this example of a configuration setting, the
6025 second item in the colon-separated list is a regular expression.
6026 .code
6027 domains = a.b.c : ^\\d{3} : *.y.z : ...
6028 .endd
6029 The doubling of the backslash is required because of string expansion that
6030 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6031 of this issue, and a way of avoiding the need for doubling backslashes. The
6032 regular expression that is eventually used in this example contains just one
6033 backslash. The circumflex is included in the regular expression, and has the
6034 normal effect of &"anchoring"& it to the start of the string that is being
6035 matched.
6036
6037 There are, however, two cases where a circumflex is not required for the
6038 recognition of a regular expression: these are the &%match%& condition in a
6039 string expansion, and the &%matches%& condition in an Exim filter file. In
6040 these cases, the relevant string is always treated as a regular expression; if
6041 it does not start with a circumflex, the expression is not anchored, and can
6042 match anywhere in the subject string.
6043
6044 In all cases, if you want a regular expression to match at the end of a string,
6045 you must code the $ metacharacter to indicate this. For example:
6046 .code
6047 domains = ^\\d{3}\\.example
6048 .endd
6049 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6050 You need to use:
6051 .code
6052 domains = ^\\d{3}\\.example\$
6053 .endd
6054 if you want &'example'& to be the top-level domain. The backslash before the
6055 $ is needed because string expansion also interprets dollar characters.
6056
6057
6058
6059 . ////////////////////////////////////////////////////////////////////////////
6060 . ////////////////////////////////////////////////////////////////////////////
6061
6062 .chapter "File and database lookups" "CHAPfdlookup"
6063 .scindex IIDfidalo1 "file" "lookups"
6064 .scindex IIDfidalo2 "database" "lookups"
6065 .cindex "lookup" "description of"
6066 Exim can be configured to look up data in files or databases as it processes
6067 messages. Two different kinds of syntax are used:
6068
6069 .olist
6070 A string that is to be expanded may contain explicit lookup requests. These
6071 cause parts of the string to be replaced by data that is obtained from the
6072 lookup. Lookups of this type are conditional expansion items. Different results
6073 can be defined for the cases of lookup success and failure. See chapter
6074 &<<CHAPexpand>>&, where string expansions are described in detail.
6075 .next
6076 Lists of domains, hosts, and email addresses can contain lookup requests as a
6077 way of avoiding excessively long linear lists. In this case, the data that is
6078 returned by the lookup is often (but not always) discarded; whether the lookup
6079 succeeds or fails is what really counts. These kinds of list are described in
6080 chapter &<<CHAPdomhosaddlists>>&.
6081 .endlist
6082
6083 String expansions, lists, and lookups interact with each other in such a way
6084 that there is no order in which to describe any one of them that does not
6085 involve references to the others. Each of these three chapters makes more sense
6086 if you have read the other two first. If you are reading this for the first
6087 time, be aware that some of it will make a lot more sense after you have read
6088 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6089
6090 .section "Examples of different lookup syntax" "SECID60"
6091 It is easy to confuse the two different kinds of lookup, especially as the
6092 lists that may contain the second kind are always expanded before being
6093 processed as lists. Therefore, they may also contain lookups of the first kind.
6094 Be careful to distinguish between the following two examples:
6095 .code
6096 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6097 domains = lsearch;/some/file
6098 .endd
6099 The first uses a string expansion, the result of which must be a domain list.
6100 No strings have been specified for a successful or a failing lookup; the
6101 defaults in this case are the looked-up data and an empty string, respectively.
6102 The expansion takes place before the string is processed as a list, and the
6103 file that is searched could contain lines like this:
6104 .code
6105 192.168.3.4: domain1:domain2:...
6106 192.168.1.9: domain3:domain4:...
6107 .endd
6108 When the lookup succeeds, the result of the expansion is a list of domains (and
6109 possibly other types of item that are allowed in domain lists).
6110
6111 In the second example, the lookup is a single item in a domain list. It causes
6112 Exim to use a lookup to see if the domain that is being processed can be found
6113 in the file. The file could contains lines like this:
6114 .code
6115 domain1:
6116 domain2:
6117 .endd
6118 Any data that follows the keys is not relevant when checking that the domain
6119 matches the list item.
6120
6121 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6122 Consider a file containing lines like this:
6123 .code
6124 192.168.5.6: lsearch;/another/file
6125 .endd
6126 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6127 first &%domains%& setting above generates the second setting, which therefore
6128 causes a second lookup to occur.
6129
6130 The rest of this chapter describes the different lookup types that are
6131 available. Any of them can be used in any part of the configuration where a
6132 lookup is permitted.
6133
6134
6135 .section "Lookup types" "SECID61"
6136 .cindex "lookup" "types of"
6137 .cindex "single-key lookup" "definition of"
6138 Two different types of data lookup are implemented:
6139
6140 .ilist
6141 The &'single-key'& type requires the specification of a file in which to look,
6142 and a single key to search for. The key must be a non-empty string for the
6143 lookup to succeed. The lookup type determines how the file is searched.
6144 .next
6145 .cindex "query-style lookup" "definition of"
6146 The &'query-style'& type accepts a generalized database query. No particular
6147 key value is assumed by Exim for query-style lookups. You can use whichever
6148 Exim variables you need to construct the database query.
6149 .endlist
6150
6151 The code for each lookup type is in a separate source file that is included in
6152 the binary of Exim only if the corresponding compile-time option is set. The
6153 default settings in &_src/EDITME_& are:
6154 .code
6155 LOOKUP_DBM=yes
6156 LOOKUP_LSEARCH=yes
6157 .endd
6158 which means that only linear searching and DBM lookups are included by default.
6159 For some types of lookup (e.g. SQL databases), you need to install appropriate
6160 libraries and header files before building Exim.
6161
6162
6163
6164
6165 .section "Single-key lookup types" "SECTsinglekeylookups"
6166 .cindex "lookup" "single-key types"
6167 .cindex "single-key lookup" "list of types"
6168 The following single-key lookup types are implemented:
6169
6170 .ilist
6171 .cindex "cdb" "description of"
6172 .cindex "lookup" "cdb"
6173 .cindex "binary zero" "in lookup key"
6174 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6175 string without a terminating binary zero. The cdb format is designed for
6176 indexed files that are read frequently and never updated, except by total
6177 re-creation. As such, it is particularly suitable for large files containing
6178 aliases or other indexed data referenced by an MTA. Information about cdb can
6179 be found in several places:
6180 .display
6181 &url(http://www.pobox.com/~djb/cdb.html)
6182 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6183 &url(http://packages.debian.org/stable/utils/freecdb.html)
6184 .endd
6185 A cdb distribution is not needed in order to build Exim with cdb support,
6186 because the code for reading cdb files is included directly in Exim itself.
6187 However, no means of building or testing cdb files is provided with Exim, so
6188 you need to obtain a cdb distribution in order to do this.
6189 .next
6190 .cindex "DBM" "lookup type"
6191 .cindex "lookup" "dbm"
6192 .cindex "binary zero" "in lookup key"
6193 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6194 DBM file by looking up the record with the given key. A terminating binary
6195 zero is included in the key that is passed to the DBM library. See section
6196 &<<SECTdb>>& for a discussion of DBM libraries.
6197
6198 .cindex "Berkeley DB library" "file format"
6199 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6200 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6201 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6202 the DB_UNKNOWN option. This enables it to handle any of the types of database
6203 that the library supports, and can be useful for accessing DBM files created by
6204 other applications. (For earlier DB versions, DB_HASH is always used.)
6205 .next
6206 .cindex "lookup" "dbmnz"
6207 .cindex "lookup" "dbm &-- terminating zero"
6208 .cindex "binary zero" "in lookup key"
6209 .cindex "Courier"
6210 .cindex "&_/etc/userdbshadow.dat_&"
6211 .cindex "dmbnz lookup type"
6212 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6213 is not included in the key that is passed to the DBM library. You may need this
6214 if you want to look up data in files that are created by or shared with some
6215 other application that does not use terminating zeros. For example, you need to
6216 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6217 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6218 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6219 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6220 .next
6221 .cindex "lookup" "dsearch"
6222 .cindex "dsearch lookup type"
6223 &(dsearch)&: The given file must be a directory; this is searched for an entry
6224 whose name is the key by calling the &[lstat()]& function. The key may not
6225 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6226 the lookup is the name of the entry, which may be a file, directory,
6227 symbolic link, or any other kind of directory entry. An example of how this
6228 lookup can be used to support virtual domains is given in section
6229 &<<SECTvirtualdomains>>&.
6230 .next
6231 .cindex "lookup" "iplsearch"
6232 .cindex "iplsearch lookup type"
6233 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6234 terminated by a colon or white space or the end of the line. The keys in the
6235 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6236 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6237 being interpreted as a key terminator. For example:
6238 .code
6239 1.2.3.4:           data for 1.2.3.4
6240 192.168.0.0/16:    data for 192.168.0.0/16
6241 "abcd::cdab":      data for abcd::cdab
6242 "abcd:abcd::/32"   data for abcd:abcd::/32
6243 .endd
6244 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6245 file is searched linearly, using the CIDR masks where present, until a matching
6246 key is found. The first key that matches is used; there is no attempt to find a
6247 &"best"& match. Apart from the way the keys are matched, the processing for
6248 &(iplsearch)& is the same as for &(lsearch)&.
6249
6250 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6251 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6252 lookup types support only literal keys.
6253
6254 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6255 the implicit key is the host's IP address rather than its name (see section
6256 &<<SECThoslispatsikey>>&).
6257 .next
6258 .cindex "linear search"
6259 .cindex "lookup" "lsearch"
6260 .cindex "lsearch lookup type"
6261 .cindex "case sensitivity" "in lsearch lookup"
6262 &(lsearch)&: The given file is a text file that is searched linearly for a
6263 line beginning with the search key, terminated by a colon or white space or the
6264 end of the line. The search is case-insensitive; that is, upper and lower case
6265 letters are treated as the same. The first occurrence of the key that is found
6266 in the file is used.
6267
6268 White space between the key and the colon is permitted. The remainder of the
6269 line, with leading and trailing white space removed, is the data. This can be
6270 continued onto subsequent lines by starting them with any amount of white
6271 space, but only a single space character is included in the data at such a
6272 junction. If the data begins with a colon, the key must be terminated by a
6273 colon, for example:
6274 .code
6275 baduser:  :fail:
6276 .endd
6277 Empty lines and lines beginning with # are ignored, even if they occur in the
6278 middle of an item. This is the traditional textual format of alias files. Note
6279 that the keys in an &(lsearch)& file are literal strings. There is no
6280 wildcarding of any kind.
6281
6282 .cindex "lookup" "lsearch &-- colons in keys"
6283 .cindex "white space" "in lsearch key"
6284 In most &(lsearch)& files, keys are not required to contain colons or #
6285 characters, or white space. However, if you need this feature, it is available.
6286 If a key begins with a doublequote character, it is terminated only by a
6287 matching quote (or end of line), and the normal escaping rules apply to its
6288 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6289 quoted keys (exactly as for unquoted keys). There is no special handling of
6290 quotes for the data part of an &(lsearch)& line.
6291
6292 .next
6293 .cindex "NIS lookup type"
6294 .cindex "lookup" "NIS"
6295 .cindex "binary zero" "in lookup key"
6296 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6297 the given key, without a terminating binary zero. There is a variant called
6298 &(nis0)& which does include the terminating binary zero in the key. This is
6299 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6300 aliases; the full map names must be used.
6301
6302 .next
6303 .cindex "wildlsearch lookup type"
6304 .cindex "lookup" "wildlsearch"
6305 .cindex "nwildlsearch lookup type"
6306 .cindex "lookup" "nwildlsearch"
6307 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6308 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6309 the file may be wildcarded. The difference between these two lookup types is
6310 that for &(wildlsearch)&, each key in the file is string-expanded before being
6311 used, whereas for &(nwildlsearch)&, no expansion takes place.
6312
6313 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6314 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6315 file that are regular expressions can be made case-sensitive by the use of
6316 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6317
6318 . ==== As this is a nested list, any displays it contains must be indented
6319 . ==== as otherwise they are too far to the left.
6320
6321 .olist
6322 The string may begin with an asterisk to mean &"ends with"&. For example:
6323 .code
6324     *.a.b.c       data for anything.a.b.c
6325     *fish         data for anythingfish
6326 .endd
6327 .next
6328 The string may begin with a circumflex to indicate a regular expression. For
6329 example, for &(wildlsearch)&:
6330 .code
6331     ^\N\d+\.a\.b\N    data for <digits>.a.b
6332 .endd
6333 Note the use of &`\N`& to disable expansion of the contents of the regular
6334 expression. If you are using &(nwildlsearch)&, where the keys are not
6335 string-expanded, the equivalent entry is:
6336 .code
6337     ^\d+\.a\.b        data for <digits>.a.b
6338 .endd
6339 The case-insensitive flag is set at the start of compiling the regular
6340 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6341 For example, to make the entire pattern case-sensitive:
6342 .code
6343     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6344 .endd
6345
6346 If the regular expression contains white space or colon characters, you must
6347 either quote it (see &(lsearch)& above), or represent these characters in other
6348 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6349 colon. This may be easier than quoting, because if you quote, you have to
6350 escape all the backslashes inside the quotes.
6351
6352 &*Note*&: It is not possible to capture substrings in a regular expression
6353 match for later use, because the results of all lookups are cached. If a lookup
6354 is repeated, the result is taken from the cache, and no actual pattern matching
6355 takes place. The values of all the numeric variables are unset after a
6356 &((n)wildlsearch)& match.
6357
6358 .next
6359 Although I cannot see it being of much use, the general matching function that
6360 is used to implement &((n)wildlsearch)& means that the string may begin with a
6361 lookup name terminated by a semicolon, and followed by lookup data. For
6362 example:
6363 .code
6364     cdb;/some/file  data for keys that match the file
6365 .endd
6366 The data that is obtained from the nested lookup is discarded.
6367 .endlist olist
6368
6369 Keys that do not match any of these patterns are interpreted literally. The
6370 continuation rules for the data are the same as for &(lsearch)&, and keys may
6371 be followed by optional colons.
6372
6373 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6374 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6375 lookup types support only literal keys.
6376 .endlist ilist
6377
6378
6379 .section "Query-style lookup types" "SECID62"
6380 .cindex "lookup" "query-style types"
6381 .cindex "query-style lookup" "list of types"
6382 The supported query-style lookup types are listed below. Further details about
6383 many of them are given in later sections.
6384
6385 .ilist
6386 .cindex "DNS" "as a lookup type"
6387 .cindex "lookup" "DNS"
6388 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6389 are given in the supplied query. The resulting data is the contents of the
6390 records. See section &<<SECTdnsdb>>&.
6391 .next
6392 .cindex "InterBase lookup type"
6393 .cindex "lookup" "InterBase"
6394 &(ibase)&: This does a lookup in an InterBase database.
6395 .next
6396 .cindex "LDAP" "lookup type"
6397 .cindex "lookup" "LDAP"
6398 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6399 returns attributes from a single entry. There is a variant called &(ldapm)&
6400 that permits values from multiple entries to be returned. A third variant
6401 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6402 any attribute values. See section &<<SECTldap>>&.
6403 .next
6404 .cindex "MySQL" "lookup type"
6405 .cindex "lookup" "MySQL"
6406 &(mysql)&: The format of the query is an SQL statement that is passed to a
6407 MySQL database. See section &<<SECTsql>>&.
6408 .next
6409 .cindex "NIS+ lookup type"
6410 .cindex "lookup" "NIS+"
6411 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6412 the field to be returned. See section &<<SECTnisplus>>&.
6413 .next
6414 .cindex "Oracle" "lookup type"
6415 .cindex "lookup" "Oracle"
6416 &(oracle)&: The format of the query is an SQL statement that is passed to an
6417 Oracle database. See section &<<SECTsql>>&.
6418 .next
6419 .cindex "lookup" "passwd"
6420 .cindex "passwd lookup type"
6421 .cindex "&_/etc/passwd_&"
6422 &(passwd)& is a query-style lookup with queries that are just user names. The
6423 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6424 success, the result string is the same as you would get from an &(lsearch)&
6425 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6426 password value. For example:
6427 .code
6428 *:42:42:King Rat:/home/kr:/bin/bash
6429 .endd
6430 .next
6431 .cindex "PostgreSQL lookup type"
6432 .cindex "lookup" "PostgreSQL"
6433 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6434 PostgreSQL database. See section &<<SECTsql>>&.
6435
6436 .next
6437 .cindex "sqlite lookup type"
6438 .cindex "lookup" "sqlite"
6439 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6440 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6441
6442 .next
6443 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6444 not likely to be useful in normal operation.
6445 .next
6446 .cindex "whoson lookup type"
6447 .cindex "lookup" "whoson"
6448 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6449 allows a server to check whether a particular (dynamically allocated) IP
6450 address is currently allocated to a known (trusted) user and, optionally, to
6451 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6452 at one time for &"POP before SMTP"& authentication, but that approach has been
6453 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6454 &"POP before SMTP"& checking using ACL statements such as
6455 .code
6456 require condition = \
6457   ${lookup whoson {$sender_host_address}{yes}{no}}
6458 .endd
6459 The query consists of a single IP address. The value returned is the name of
6460 the authenticated user, which is stored in the variable &$value$&. However, in
6461 this example, the data in &$value$& is not used; the result of the lookup is
6462 one of the fixed strings &"yes"& or &"no"&.
6463 .endlist
6464
6465
6466
6467 .section "Temporary errors in lookups" "SECID63"
6468 .cindex "lookup" "temporary error in"
6469 Lookup functions can return temporary error codes if the lookup cannot be
6470 completed. For example, an SQL or LDAP database might be unavailable. For this
6471 reason, it is not advisable to use a lookup that might do this for critical
6472 options such as a list of local domains.
6473
6474 When a lookup cannot be completed in a router or transport, delivery
6475 of the message (to the relevant address) is deferred, as for any other
6476 temporary error. In other circumstances Exim may assume the lookup has failed,
6477 or may give up altogether.
6478
6479
6480
6481 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6482 .cindex "wildcard lookups"
6483 .cindex "lookup" "default values"
6484 .cindex "lookup" "wildcard"
6485 .cindex "lookup" "* added to type"
6486 .cindex "default" "in single-key lookups"
6487 In this context, a &"default value"& is a value specified by the administrator
6488 that is to be used if a lookup fails.
6489
6490 &*Note:*& This section applies only to single-key lookups. For query-style
6491 lookups, the facilities of the query language must be used. An attempt to
6492 specify a default for a query-style lookup provokes an error.
6493
6494 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6495 and the initial lookup fails, the key &"*"& is looked up in the file to
6496 provide a default value. See also the section on partial matching below.
6497
6498 .cindex "*@ with single-key lookup"
6499 .cindex "lookup" "*@ added to type"
6500 .cindex "alias file" "per-domain default"
6501 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6502 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6503 character, a second lookup is done with everything before the last @ replaced
6504 by *. This makes it possible to provide per-domain defaults in alias files
6505 that include the domains in the keys. If the second lookup fails (or doesn't
6506 take place because there is no @ in the key), &"*"& is looked up.
6507 For example, a &(redirect)& router might contain:
6508 .code
6509 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6510 .endd
6511 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6512 looks up these keys, in this order:
6513 .code
6514 jane@eyre.example
6515 *@eyre.example
6516 *
6517 .endd
6518 The data is taken from whichever key it finds first. &*Note*&: In an
6519 &(lsearch)& file, this does not mean the first of these keys in the file. A
6520 complete scan is done for each key, and only if it is not found at all does
6521 Exim move on to try the next key.
6522
6523
6524
6525 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6526 .cindex "partial matching"
6527 .cindex "wildcard lookups"
6528 .cindex "lookup" "partial matching"
6529 .cindex "lookup" "wildcard"
6530 .cindex "asterisk" "in search type"
6531 The normal operation of a single-key lookup is to search the file for an exact
6532 match with the given key. However, in a number of situations where domains are
6533 being looked up, it is useful to be able to do partial matching. In this case,
6534 information in the file that has a key starting with &"*."& is matched by any
6535 domain that ends with the components that follow the full stop. For example, if
6536 a key in a DBM file is
6537 .code
6538 *.dates.fict.example
6539 .endd
6540 then when partial matching is enabled this is matched by (amongst others)
6541 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6542 by &'dates.fict.example'&, if that does not appear as a separate key in the
6543 file.
6544
6545 &*Note*&: Partial matching is not available for query-style lookups. It is
6546 also not available for any lookup items in address lists (see section
6547 &<<SECTaddresslist>>&).
6548
6549 Partial matching is implemented by doing a series of separate lookups using
6550 keys constructed by modifying the original subject key. This means that it can
6551 be used with any of the single-key lookup types, provided that
6552 partial matching keys
6553 beginning with a special prefix (default &"*."&) are included in the data file.
6554 Keys in the file that do not begin with the prefix are matched only by
6555 unmodified subject keys when partial matching is in use.
6556
6557 Partial matching is requested by adding the string &"partial-"& to the front of
6558 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6559 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6560 is added at the start of the subject key, and it is looked up again. If that
6561 fails, further lookups are tried with dot-separated components removed from the
6562 start of the subject key, one-by-one, and &"*."& added on the front of what
6563 remains.
6564
6565 A minimum number of two non-* components are required. This can be adjusted
6566 by including a number before the hyphen in the search type. For example,
6567 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6568 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6569 subject key is &'2250.dates.fict.example'& then the following keys are looked
6570 up when the minimum number of non-* components is two:
6571 .code
6572 2250.dates.fict.example
6573 *.2250.dates.fict.example
6574 *.dates.fict.example
6575 *.fict.example
6576 .endd
6577 As soon as one key in the sequence is successfully looked up, the lookup
6578 finishes.
6579
6580 .cindex "lookup" "partial matching &-- changing prefix"
6581 .cindex "prefix" "for partial matching"
6582 The use of &"*."& as the partial matching prefix is a default that can be
6583 changed. The motivation for this feature is to allow Exim to operate with file
6584 formats that are used by other MTAs. A different prefix can be supplied in
6585 parentheses instead of the hyphen after &"partial"&. For example:
6586 .code
6587 domains = partial(.)lsearch;/some/file
6588 .endd
6589 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6590 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6591 components is unchanged). The prefix may consist of any punctuation characters
6592 other than a closing parenthesis. It may be empty, for example:
6593 .code
6594 domains = partial1()cdb;/some/file
6595 .endd
6596 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6597 &`a.b.c`&, &`b.c`&, and &`c`&.
6598
6599 If &"partial0"& is specified, what happens at the end (when the lookup with
6600 just one non-wild component has failed, and the original key is shortened right
6601 down to the null string) depends on the prefix:
6602
6603 .ilist
6604 If the prefix has zero length, the whole lookup fails.
6605 .next
6606 If the prefix has length 1, a lookup for just the prefix is done. For
6607 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6608 .next
6609 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6610 remainder is looked up. With the default prefix, therefore, the final lookup is
6611 for &"*"& on its own.
6612 .next
6613 Otherwise, the whole prefix is looked up.
6614 .endlist
6615
6616
6617 If the search type ends in &"*"& or &"*@"& (see section
6618 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6619 this implies happens after all partial lookups have failed. If &"partial0"& is
6620 specified, adding &"*"& to the search type has no effect with the default
6621 prefix, because the &"*"& key is already included in the sequence of partial
6622 lookups. However, there might be a use for lookup types such as
6623 &"partial0(.)lsearch*"&.
6624
6625 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6626 in domain lists and the like. Partial matching works only in terms of
6627 dot-separated components; a key such as &`*fict.example`&
6628 in a database file is useless, because the asterisk in a partial matching
6629 subject key is always followed by a dot.
6630
6631
6632
6633
6634 .section "Lookup caching" "SECID64"
6635 .cindex "lookup" "caching"
6636 .cindex "caching" "lookup data"
6637 Exim caches all lookup results in order to avoid needless repetition of
6638 lookups. However, because (apart from the daemon) Exim operates as a collection
6639 of independent, short-lived processes, this caching applies only within a
6640 single Exim process. There is no inter-process lookup caching facility.
6641
6642 For single-key lookups, Exim keeps the relevant files open in case there is
6643 another lookup that needs them. In some types of configuration this can lead to
6644 many files being kept open for messages with many recipients. To avoid hitting
6645 the operating system limit on the number of simultaneously open files, Exim
6646 closes the least recently used file when it needs to open more files than its
6647 own internal limit, which can be changed via the &%lookup_open_max%& option.
6648
6649 The single-key lookup files are closed and the lookup caches are flushed at
6650 strategic points during delivery &-- for example, after all routing is
6651 complete.
6652
6653
6654
6655
6656 .section "Quoting lookup data" "SECID65"
6657 .cindex "lookup" "quoting"
6658 .cindex "quoting" "in lookups"
6659 When data from an incoming message is included in a query-style lookup, there
6660 is the possibility of special characters in the data messing up the syntax of
6661 the query. For example, a NIS+ query that contains
6662 .code
6663 [name=$local_part]
6664 .endd
6665 will be broken if the local part happens to contain a closing square bracket.
6666 For NIS+, data can be enclosed in double quotes like this:
6667 .code
6668 [name="$local_part"]
6669 .endd
6670 but this still leaves the problem of a double quote in the data. The rule for
6671 NIS+ is that double quotes must be doubled. Other lookup types have different
6672 rules, and to cope with the differing requirements, an expansion operator
6673 of the following form is provided:
6674 .code
6675 ${quote_<lookup-type>:<string>}
6676 .endd
6677 For example, the safest way to write the NIS+ query is
6678 .code
6679 [name="${quote_nisplus:$local_part}"]
6680 .endd
6681 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6682 operator can be used for all lookup types, but has no effect for single-key
6683 lookups, since no quoting is ever needed in their key strings.
6684
6685
6686
6687
6688 .section "More about dnsdb" "SECTdnsdb"
6689 .cindex "dnsdb lookup"
6690 .cindex "lookup" "dnsdb"
6691 .cindex "DNS" "as a lookup type"
6692 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6693 of a record type and a domain name, separated by an equals sign. For example,
6694 an expansion string could contain:
6695 .code
6696 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6697 .endd
6698 If the lookup succeeds, the result is placed in &$value$&, which in this case
6699 is used on its own as the result. If the lookup does not succeed, the
6700 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6701 &<<SECTforexpfai>>& for an explanation of what this means.
6702
6703 The supported DNS record types are A, CNAME, MX, NS, PTR, SRV, and TXT, and,
6704 when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6705 configured). If no type is given, TXT is assumed. When the type is PTR,
6706 the data can be an IP address, written as normal; inversion and the addition of
6707 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6708 .code
6709 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6710 .endd
6711 If the data for a PTR record is not a syntactically valid IP address, it is not
6712 altered and nothing is added.
6713
6714 .cindex "MX record" "in &(dnsdb)& lookup"
6715 .cindex "SRV record" "in &(dnsdb)& lookup"
6716 For an MX lookup, both the preference value and the host name are returned for
6717 each record, separated by a space. For an SRV lookup, the priority, weight,
6718 port, and host name are returned for each record, separated by spaces.
6719
6720 For any record type, if multiple records are found (or, for A6 lookups, if a
6721 single record leads to multiple addresses), the data is returned as a
6722 concatenation, with newline as the default separator. The order, of course,
6723 depends on the DNS resolver. You can specify a different separator character
6724 between multiple records by putting a right angle-bracket followed immediately
6725 by the new separator at the start of the query. For example:
6726 .code
6727 ${lookup dnsdb{>: a=host1.example}}
6728 .endd
6729 It is permitted to specify a space as the separator character. Further
6730 white space is ignored.
6731
6732 .cindex "TXT record" "in &(dnsdb)& lookup"
6733 For TXT records with multiple items of data, only the first item is returned,
6734 unless a separator for them is specified using a comma after the separator
6735 character followed immediately by the TXT record item separator. To concatenate
6736 items without a separator, use a semicolon instead.
6737 .code
6738 ${lookup dnsdb{>\n,: txt=a.b.example}}
6739 ${lookup dnsdb{>\n; txt=a.b.example}}
6740 .endd
6741 It is permitted to specify a space as the separator character. Further
6742 white space is ignored.
6743
6744 .section "Pseudo dnsdb record types" "SECID66"
6745 .cindex "MX record" "in &(dnsdb)& lookup"
6746 By default, both the preference value and the host name are returned for
6747 each MX record, separated by a space. If you want only host names, you can use
6748 the pseudo-type MXH:
6749 .code
6750 ${lookup dnsdb{mxh=a.b.example}}
6751 .endd
6752 In this case, the preference values are omitted, and just the host names are
6753 returned.
6754
6755 .cindex "name server for enclosing domain"
6756 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6757 records on the given domain, but if none are found, it removes the first
6758 component of the domain name, and tries again. This process continues until NS
6759 records are found or there are no more components left (or there is a DNS
6760 error). In other words, it may return the name servers for a top-level domain,
6761 but it never returns the root name servers. If there are no NS records for the
6762 top-level domain, the lookup fails. Consider these examples:
6763 .code
6764 ${lookup dnsdb{zns=xxx.quercite.com}}
6765 ${lookup dnsdb{zns=xxx.edu}}
6766 .endd
6767 Assuming that in each case there are no NS records for the full domain name,
6768 the first returns the name servers for &%quercite.com%&, and the second returns
6769 the name servers for &%edu%&.
6770
6771 You should be careful about how you use this lookup because, unless the
6772 top-level domain does not exist, the lookup always returns some host names. The
6773 sort of use to which this might be put is for seeing if the name servers for a
6774 given domain are on a blacklist. You can probably assume that the name servers
6775 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6776 such a list.
6777
6778 .cindex "CSA" "in &(dnsdb)& lookup"
6779 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6780 records according to the CSA rules, which are described in section
6781 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6782 not sufficient because of the extra parent domain search behaviour of CSA. The
6783 result of a successful lookup such as:
6784 .code
6785 ${lookup dnsdb {csa=$sender_helo_name}}
6786 .endd
6787 has two space-separated fields: an authorization code and a target host name.
6788 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6789 authorization required but absent, or &"?"& for unknown.
6790
6791
6792 .section "Multiple dnsdb lookups" "SECID67"
6793 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6794 However, you can specify a list of domains or IP addresses in a single
6795 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6796 the default separator, but with the ability to change this. For example:
6797 .code
6798 ${lookup dnsdb{one.domain.com:two.domain.com}}
6799 ${lookup dnsdb{a=one.host.com:two.host.com}}
6800 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6801 .endd
6802 In order to retain backwards compatibility, there is one special case: if
6803 the lookup type is PTR and no change of separator is specified, Exim looks
6804 to see if the rest of the string is precisely one IPv6 address. In this
6805 case, it does not treat it as a list.
6806
6807 The data from each lookup is concatenated, with newline separators by default,
6808 in the same way that multiple DNS records for a single item are handled. A
6809 different separator can be specified, as described above.
6810
6811 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6812 temporary DNS error for any of them, the behaviour is controlled by
6813 an optional keyword followed by a comma that may appear before the record
6814 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6815 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6816 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6817 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6818 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6819 error causes the whole lookup to defer only if none of the other lookups
6820 succeed. The default is &"lax"&, so the following lookups are equivalent:
6821 .code
6822 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6823 ${lookup dnsdb{a=one.host.com:two.host.com}}
6824 .endd
6825 Thus, in the default case, as long as at least one of the DNS lookups
6826 yields some data, the lookup succeeds.
6827
6828
6829
6830
6831 .section "More about LDAP" "SECTldap"
6832 .cindex "LDAP" "lookup, more about"
6833 .cindex "lookup" "LDAP"
6834 .cindex "Solaris" "LDAP"
6835 The original LDAP implementation came from the University of Michigan; this has
6836 become &"Open LDAP"&, and there are now two different releases. Another
6837 implementation comes from Netscape, and Solaris 7 and subsequent releases
6838 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
6839 the lookup function level, their error handling is different. For this reason
6840 it is necessary to set a compile-time variable when building Exim with LDAP, to
6841 indicate which LDAP library is in use. One of the following should appear in
6842 your &_Local/Makefile_&:
6843 .code
6844 LDAP_LIB_TYPE=UMICHIGAN
6845 LDAP_LIB_TYPE=OPENLDAP1
6846 LDAP_LIB_TYPE=OPENLDAP2
6847 LDAP_LIB_TYPE=NETSCAPE
6848 LDAP_LIB_TYPE=SOLARIS
6849 .endd
6850 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
6851 same interface as the University of Michigan version.
6852
6853 There are three LDAP lookup types in Exim. These behave slightly differently in
6854 the way they handle the results of a query:
6855
6856 .ilist
6857 &(ldap)& requires the result to contain just one entry; if there are more, it
6858 gives an error.
6859 .next
6860 &(ldapdn)& also requires the result to contain just one entry, but it is the
6861 Distinguished Name that is returned rather than any attribute values.
6862 .next
6863 &(ldapm)& permits the result to contain more than one entry; the attributes
6864 from all of them are returned.
6865 .endlist
6866
6867
6868 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
6869 Exim behaves as if the entry did not exist, and the lookup fails. The format of
6870 the data returned by a successful lookup is described in the next section.
6871 First we explain how LDAP queries are coded.
6872
6873
6874 .section "Format of LDAP queries" "SECTforldaque"
6875 .cindex "LDAP" "query format"
6876 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
6877 the configuration of a &(redirect)& router one might have this setting:
6878 .code
6879 data = ${lookup ldap \
6880   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
6881   c=UK?mailbox?base?}}
6882 .endd
6883 .cindex "LDAP" "with TLS"
6884 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
6885 secure (encrypted) LDAP connections. The second of these ensures that an
6886 encrypted TLS connection is used.
6887
6888 .new
6889 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
6890 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
6891 See the &%ldap_start_tls%& option.
6892 .wen
6893
6894
6895 .section "LDAP quoting" "SECID68"
6896 .cindex "LDAP" "quoting"
6897 Two levels of quoting are required in LDAP queries, the first for LDAP itself
6898 and the second because the LDAP query is represented as a URL. Furthermore,
6899 within an LDAP query, two different kinds of quoting are required. For this
6900 reason, there are two different LDAP-specific quoting operators.
6901
6902 The &%quote_ldap%& operator is designed for use on strings that are part of
6903 filter specifications. Conceptually, it first does the following conversions on
6904 the string:
6905 .code
6906 *   =>   \2A
6907 (   =>   \28
6908 )   =>   \29
6909 \   =>   \5C
6910 .endd
6911 in accordance with RFC 2254. The resulting string is then quoted according
6912 to the rules for URLs, that is, all non-alphanumeric characters except
6913 .code
6914 ! $ ' - . _ ( ) * +
6915 .endd
6916 are converted to their hex values, preceded by a percent sign. For example:
6917 .code
6918 ${quote_ldap: a(bc)*, a<yz>; }
6919 .endd
6920 yields
6921 .code
6922 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
6923 .endd
6924 Removing the URL quoting, this is (with a leading and a trailing space):
6925 .code
6926 a\28bc\29\2A, a<yz>;
6927 .endd
6928 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
6929 base DN specifications in queries. Conceptually, it first converts the string
6930 by inserting a backslash in front of any of the following characters:
6931 .code
6932 , + " \ < > ;
6933 .endd
6934 It also inserts a backslash before any leading spaces or # characters, and
6935 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
6936 is then quoted according to the rules for URLs. For example:
6937 .code
6938 ${quote_ldap_dn: a(bc)*, a<yz>; }
6939 .endd
6940 yields
6941 .code
6942 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
6943 .endd
6944 Removing the URL quoting, this is (with a trailing space):
6945 .code
6946 \ a(bc)*\, a\<yz\>\;\
6947 .endd
6948 There are some further comments about quoting in the section on LDAP
6949 authentication below.
6950
6951
6952 .section "LDAP connections" "SECID69"
6953 .cindex "LDAP" "connections"
6954 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
6955 is in use, via a Unix domain socket. The example given above does not specify
6956 an LDAP server. A server that is reached by TCP/IP can be specified in a query
6957 by starting it with
6958 .code
6959 ldap://<hostname>:<port>/...
6960 .endd
6961 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
6962 used. When no server is specified in a query, a list of default servers is
6963 taken from the &%ldap_default_servers%& configuration option. This supplies a
6964 colon-separated list of servers which are tried in turn until one successfully
6965 handles a query, or there is a serious error. Successful handling either
6966 returns the requested data, or indicates that it does not exist. Serious errors
6967 are syntactical, or multiple values when only a single value is expected.
6968 Errors which cause the next server to be tried are connection failures, bind
6969 failures, and timeouts.
6970
6971 For each server name in the list, a port number can be given. The standard way
6972 of specifying a host and port is to use a colon separator (RFC 1738). Because
6973 &%ldap_default_servers%& is a colon-separated list, such colons have to be
6974 doubled. For example
6975 .code
6976 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
6977 .endd
6978 If &%ldap_default_servers%& is unset, a URL with no server name is passed
6979 to the LDAP library with no server name, and the library's default (normally
6980 the local host) is used.
6981
6982 If you are using the OpenLDAP library, you can connect to an LDAP server using
6983 a Unix domain socket instead of a TCP/IP connection. This is specified by using
6984 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
6985 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
6986 not available.
6987
6988 For this type of connection, instead of a host name for the server, a pathname
6989 for the socket is required, and the port number is not relevant. The pathname
6990 can be specified either as an item in &%ldap_default_servers%&, or inline in
6991 the query. In the former case, you can have settings such as
6992 .code
6993 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
6994 .endd
6995 When the pathname is given in the query, you have to escape the slashes as
6996 &`%2F`& to fit in with the LDAP URL syntax. For example:
6997 .code
6998 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
6999 .endd
7000 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7001 a pathname, it uses the Unix domain socket code, even if the query actually
7002 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7003 socket connection. This behaviour means that you can use a setting of
7004 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7005 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7006 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7007 backup host.
7008
7009 If an explicit &`ldapi`& type is given in a query when a host name is
7010 specified, an error is diagnosed. However, if there are more items in
7011 &%ldap_default_servers%&, they are tried. In other words:
7012
7013 .ilist
7014 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7015 interface.
7016 .next
7017 Using &`ldapi`& with a host name causes an error.
7018 .endlist
7019
7020
7021 Using &`ldapi`& with no host or path in the query, and no setting of
7022 &%ldap_default_servers%&, does whatever the library does by default.
7023
7024
7025
7026 .section "LDAP authentication and control information" "SECID70"
7027 .cindex "LDAP" "authentication"
7028 The LDAP URL syntax provides no way of passing authentication and other control
7029 information to the server. To make this possible, the URL in an LDAP query may
7030 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7031 spaces. If a value contains spaces it must be enclosed in double quotes, and
7032 when double quotes are used, backslash is interpreted in the usual way inside
7033 them. The following names are recognized:
7034 .display
7035 &`DEREFERENCE`&  set the dereferencing parameter
7036 &`NETTIME    `&  set a timeout for a network operation
7037 &`USER       `&  set the DN, for authenticating the LDAP bind
7038 &`PASS       `&  set the password, likewise
7039 &`REFERRALS  `&  set the referrals parameter
7040 &`SIZE       `&  set the limit for the number of entries returned
7041 &`TIME       `&  set the maximum waiting time for a query
7042 .endd
7043 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7044 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7045 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7046 library from trying to follow referrals issued by the LDAP server.
7047
7048 The name CONNECT is an obsolete name for NETTIME, retained for
7049 backwards compatibility. This timeout (specified as a number of seconds) is
7050 enforced from the client end for operations that can be carried out over a
7051 network. Specifically, it applies to network connections and calls to the
7052 &'ldap_result()'& function. If the value is greater than zero, it is used if
7053 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7054 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7055 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7056 Netscape SDK; for OpenLDAP no action is taken.
7057
7058 The TIME parameter (also a number of seconds) is passed to the server to
7059 set a server-side limit on the time taken to complete a search.
7060
7061
7062 Here is an example of an LDAP query in an Exim lookup that uses some of these
7063 values. This is a single line, folded to fit on the page:
7064 .code
7065 ${lookup ldap
7066   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7067   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7068   {$value}fail}
7069 .endd
7070 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7071 any of the auxiliary data. Exim configuration settings that include lookups
7072 which contain password information should be preceded by &"hide"& to prevent
7073 non-admin users from using the &%-bP%& option to see their values.
7074
7075 The auxiliary data items may be given in any order. The default is no
7076 connection timeout (the system timeout is used), no user or password, no limit
7077 on the number of entries returned, and no time limit on queries.
7078
7079 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7080 removes any URL quoting that it may contain before passing it LDAP. Apparently
7081 some libraries do this for themselves, but some do not. Removing the URL
7082 quoting has two advantages:
7083
7084 .ilist
7085 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7086 DNs as with DNs inside actual queries.
7087 .next
7088 It permits spaces inside USER= DNs.
7089 .endlist
7090
7091 For example, a setting such as
7092 .code
7093 USER=cn=${quote_ldap_dn:$1}
7094 .endd
7095 should work even if &$1$& contains spaces.
7096
7097 Expanded data for the PASS= value should be quoted using the &%quote%&
7098 expansion operator, rather than the LDAP quote operators. The only reason this
7099 field needs quoting is to ensure that it conforms to the Exim syntax, which
7100 does not allow unquoted spaces. For example:
7101 .code
7102 PASS=${quote:$3}
7103 .endd
7104 The LDAP authentication mechanism can be used to check passwords as part of
7105 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7106 &<<CHAPexpand>>&.
7107
7108
7109
7110 .section "Format of data returned by LDAP" "SECID71"
7111 .cindex "LDAP" "returned data formats"
7112 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7113 as a sequence of values, for example
7114 .code
7115 cn=manager, o=University of Cambridge, c=UK
7116 .endd
7117 The &(ldap)& lookup type generates an error if more than one entry matches the
7118 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7119 the result between the data from different entries. It is possible for multiple
7120 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7121 you know that whatever values are returned all came from a single entry in the
7122 directory.
7123
7124 In the common case where you specify a single attribute in your LDAP query, the
7125 result is not quoted, and does not contain the attribute name. If the attribute
7126 has multiple values, they are separated by commas.
7127
7128 If you specify multiple attributes, the result contains space-separated, quoted
7129 strings, each preceded by the attribute name and an equals sign. Within the
7130 quotes, the quote character, backslash, and newline are escaped with
7131 backslashes, and commas are used to separate multiple values for the attribute.
7132 Apart from the escaping, the string within quotes takes the same form as the
7133 output when a single attribute is requested. Specifying no attributes is the
7134 same as specifying all of an entry's attributes.
7135
7136 Here are some examples of the output format. The first line of each pair is an
7137 LDAP query, and the second is the data that is returned. The attribute called
7138 &%attr1%& has two values, whereas &%attr2%& has only one value:
7139 .code
7140 ldap:///o=base?attr1?sub?(uid=fred)
7141 value1.1, value1.2
7142
7143 ldap:///o=base?attr2?sub?(uid=fred)
7144 value two
7145
7146 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7147 attr1="value1.1, value1.2" attr2="value two"
7148
7149 ldap:///o=base??sub?(uid=fred)
7150 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7151 .endd
7152 The &%extract%& operator in string expansions can be used to pick out
7153 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7154 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7155 results of LDAP lookups.
7156
7157
7158
7159
7160 .section "More about NIS+" "SECTnisplus"
7161 .cindex "NIS+ lookup type"
7162 .cindex "lookup" "NIS+"
7163 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7164 and field name. If this is given, the result of a successful query is the
7165 contents of the named field; otherwise the result consists of a concatenation
7166 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7167 values containing spaces are quoted. For example, the query
7168 .code
7169 [name=mg1456],passwd.org_dir
7170 .endd
7171 might return the string
7172 .code
7173 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7174 home=/home/mg1456 shell=/bin/bash shadow=""
7175 .endd
7176 (split over two lines here to fit on the page), whereas
7177 .code
7178 [name=mg1456],passwd.org_dir:gcos
7179 .endd
7180 would just return
7181 .code
7182 Martin Guerre
7183 .endd
7184 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7185 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7186 operator is to double any quote characters within the text.
7187
7188
7189
7190 .section "SQL lookups" "SECTsql"
7191 .cindex "SQL lookup types"
7192 .cindex "MySQL" "lookup type"
7193 .cindex "PostgreSQL lookup type"
7194 .cindex "lookup" "MySQL"
7195 .cindex "lookup" "PostgreSQL"
7196 .cindex "Oracle" "lookup type"
7197 .cindex "lookup" "Oracle"
7198 .cindex "InterBase lookup type"
7199 .cindex "lookup" "InterBase"
7200 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7201 databases. Queries for these databases contain SQL statements, so an example
7202 might be
7203 .code
7204 ${lookup mysql{select mailbox from users where id='userx'}\
7205   {$value}fail}
7206 .endd
7207 If the result of the query contains more than one field, the data for each
7208 field in the row is returned, preceded by its name, so the result of
7209 .code
7210 ${lookup pgsql{select home,name from users where id='userx'}\
7211   {$value}}
7212 .endd
7213 might be
7214 .code
7215 home=/home/userx name="Mister X"
7216 .endd
7217 Empty values and values containing spaces are double quoted, with embedded
7218 quotes escaped by a backslash. If the result of the query contains just one
7219 field, the value is passed back verbatim, without a field name, for example:
7220 .code
7221 Mister X
7222 .endd
7223 If the result of the query yields more than one row, it is all concatenated,
7224 with a newline between the data for each row.
7225
7226
7227 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7228 .cindex "MySQL" "lookup type"
7229 .cindex "PostgreSQL lookup type"
7230 .cindex "lookup" "MySQL"
7231 .cindex "lookup" "PostgreSQL"
7232 .cindex "Oracle" "lookup type"
7233 .cindex "lookup" "Oracle"
7234 .cindex "InterBase lookup type"
7235 .cindex "lookup" "InterBase"
7236 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7237 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7238 option (as appropriate) must be set to a colon-separated list of server
7239 information.
7240 (For MySQL and PostgreSQL only, the global option need not be set if all
7241 queries contain their own server information &-- see section
7242 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7243 items: host name, database name, user name, and password. In the case of
7244 Oracle, the host name field is used for the &"service name"&, and the database
7245 name field is not used and should be empty. For example:
7246 .code
7247 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7248 .endd
7249 Because password data is sensitive, you should always precede the setting with
7250 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7251 option. Here is an example where two MySQL servers are listed:
7252 .code
7253 hide mysql_servers = localhost/users/root/secret:\
7254                      otherhost/users/root/othersecret
7255 .endd
7256 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7257 because this is a colon-separated list, the colon has to be doubled. For each
7258 query, these parameter groups are tried in order until a connection is made and
7259 a query is successfully processed. The result of a query may be that no data is
7260 found, but that is still a successful query. In other words, the list of
7261 servers provides a backup facility, not a list of different places to look.
7262
7263 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7264 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7265 respectively, and the characters single-quote, double-quote, and backslash
7266 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7267 addition, escapes the percent and underscore characters. This cannot be done
7268 for MySQL because these escapes are not recognized in contexts where these
7269 characters are not special.
7270
7271 .section "Specifying the server in the query" "SECTspeserque"
7272 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7273 it is possible to specify a list of servers with an individual query. This is
7274 done by starting the query with
7275 .display
7276 &`servers=`&&'server1:server2:server3:...'&&`;`&
7277 .endd
7278 Each item in the list may take one of two forms:
7279 .olist
7280 If it contains no slashes it is assumed to be just a host name. The appropriate
7281 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7282 of the same name, and the remaining parameters (database, user, password) are
7283 taken from there.
7284 .next
7285 If it contains any slashes, it is taken as a complete parameter set.
7286 .endlist
7287 The list of servers is used in exactly the same way as the global list.
7288 Once a connection to a server has happened and a query has been
7289 successfully executed, processing of the lookup ceases.
7290
7291 This feature is intended for use in master/slave situations where updates
7292 are occurring and you want to update the master rather than a slave. If the
7293 master is in the list as a backup for reading, you might have a global setting
7294 like this:
7295 .code
7296 mysql_servers = slave1/db/name/pw:\
7297                 slave2/db/name/pw:\
7298                 master/db/name/pw
7299 .endd
7300 In an updating lookup, you could then write:
7301 .code
7302 ${lookup mysql{servers=master; UPDATE ...} }
7303 .endd
7304 That query would then be sent only to the master server. If, on the other hand,
7305 the master is not to be used for reading, and so is not present in the global
7306 option, you can still update it by a query of this form:
7307 .code
7308 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7309 .endd
7310
7311
7312 .section "Special MySQL features" "SECID73"
7313 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7314 causes a connection to the server on the local host by means of a Unix domain
7315 socket. An alternate socket can be specified in parentheses. The full syntax of
7316 each item in &%mysql_servers%& is:
7317 .display
7318 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7319   <&'user'&>/<&'password'&>
7320 .endd
7321 Any of the three sub-parts of the first field can be omitted. For normal use on
7322 the local host it can be left blank or set to just &"localhost"&.
7323
7324 No database need be supplied &-- but if it is absent here, it must be given in
7325 the queries.
7326
7327 If a MySQL query is issued that does not request any data (an insert, update,
7328 or delete command), the result of the lookup is the number of rows affected.
7329
7330 &*Warning*&: This can be misleading. If an update does not actually change
7331 anything (for example, setting a field to the value it already has), the result
7332 is zero because no rows are affected.
7333
7334
7335 .section "Special PostgreSQL features" "SECID74"
7336 PostgreSQL lookups can also use Unix domain socket connections to the database.
7337 This is usually faster and costs less CPU time than a TCP/IP connection.
7338 However it can be used only if the mail server runs on the same machine as the
7339 database server. A configuration line for PostgreSQL via Unix domain sockets
7340 looks like this:
7341 .code
7342 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7343 .endd
7344 In other words, instead of supplying a host name, a path to the socket is
7345 given. The path name is enclosed in parentheses so that its slashes aren't
7346 visually confused with the delimiters for the other server parameters.
7347
7348 If a PostgreSQL query is issued that does not request any data (an insert,
7349 update, or delete command), the result of the lookup is the number of rows
7350 affected.
7351
7352 .section "More about SQLite" "SECTsqlite"
7353 .cindex "lookup" "SQLite"
7354 .cindex "sqlite lookup type"
7355 SQLite is different to the other SQL lookups because a file name is required in
7356 addition to the SQL query. An SQLite database is a single file, and there is no
7357 daemon as in the other SQL databases. The interface to Exim requires the name
7358 of the file, as an absolute path, to be given at the start of the query. It is
7359 separated from the query by white space. This means that the path name cannot
7360 contain white space. Here is a lookup expansion example:
7361 .code
7362 ${lookup sqlite {/some/thing/sqlitedb \
7363   select name from aliases where id='userx';}}
7364 .endd
7365 In a list, the syntax is similar. For example:
7366 .code
7367 domainlist relay_domains = sqlite;/some/thing/sqlitedb \
7368    select * from relays where ip='$sender_host_address';
7369 .endd
7370 The only character affected by the &%quote_sqlite%& operator is a single
7371 quote, which it doubles.
7372
7373 The SQLite library handles multiple simultaneous accesses to the database
7374 internally. Multiple readers are permitted, but only one process can
7375 update at once. Attempts to access the database while it is being updated
7376 are rejected after a timeout period, during which the SQLite library
7377 waits for the lock to be released. In Exim, the default timeout is set
7378 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7379 option.
7380 .ecindex IIDfidalo1
7381 .ecindex IIDfidalo2
7382
7383
7384 . ////////////////////////////////////////////////////////////////////////////
7385 . ////////////////////////////////////////////////////////////////////////////
7386
7387 .chapter "Domain, host, address, and local part lists" &&&
7388          "CHAPdomhosaddlists" &&&
7389          "Domain, host, and address lists"
7390 .scindex IIDdohoadli "lists of domains; hosts; etc."
7391 A number of Exim configuration options contain lists of domains, hosts,
7392 email addresses, or local parts. For example, the &%hold_domains%& option
7393 contains a list of domains whose delivery is currently suspended. These lists
7394 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7395 arguments to expansion conditions such as &%match_domain%&.
7396
7397 Each item in one of these lists is a pattern to be matched against a domain,
7398 host, email address, or local part, respectively. In the sections below, the
7399 different types of pattern for each case are described, but first we cover some
7400 general facilities that apply to all four kinds of list.
7401
7402
7403
7404 .section "Expansion of lists" "SECID75"
7405 .cindex "expansion" "of lists"
7406 Each list is expanded as a single string before it is used. The result of
7407 expansion must be a list, possibly containing empty items, which is split up
7408 into separate items for matching. By default, colon is the separator character,
7409 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7410 &<<SECTempitelis>>& for details of the list syntax; the second of these
7411 discusses the way to specify empty list items.
7412
7413
7414 If the string expansion is forced to fail, Exim behaves as if the item it is
7415 testing (domain, host, address, or local part) is not in the list. Other
7416 expansion failures cause temporary errors.
7417
7418 If an item in a list is a regular expression, backslashes, dollars and possibly
7419 other special characters in the expression must be protected against
7420 misinterpretation by the string expander. The easiest way to do this is to use
7421 the &`\N`& expansion feature to indicate that the contents of the regular
7422 expression should not be expanded. For example, in an ACL you might have:
7423 .code
7424 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7425                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7426 .endd
7427 The first item is a regular expression that is protected from expansion by
7428 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7429 senders based on the receiving domain.
7430
7431
7432
7433
7434 .section "Negated items in lists" "SECID76"
7435 .cindex "list" "negation"
7436 .cindex "negation" "in lists"
7437 Items in a list may be positive or negative. Negative items are indicated by a
7438 leading exclamation mark, which may be followed by optional white space. A list
7439 defines a set of items (domains, etc). When Exim processes one of these lists,
7440 it is trying to find out whether a domain, host, address, or local part
7441 (respectively) is in the set that is defined by the list. It works like this:
7442
7443 The list is scanned from left to right. If a positive item is matched, the
7444 subject that is being checked is in the set; if a negative item is matched, the
7445 subject is not in the set. If the end of the list is reached without the
7446 subject having matched any of the patterns, it is in the set if the last item
7447 was a negative one, but not if it was a positive one. For example, the list in
7448 .code
7449 domainlist relay_domains = !a.b.c : *.b.c
7450 .endd
7451 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7452 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7453 list is positive. However, if the setting were
7454 .code
7455 domainlist relay_domains = !a.b.c
7456 .endd
7457 then all domains other than &'a.b.c'& would match because the last item in the
7458 list is negative. In other words, a list that ends with a negative item behaves
7459 as if it had an extra item &`:*`& on the end.
7460
7461 Another way of thinking about positive and negative items in lists is to read
7462 the connector as &"or"& after a positive item and as &"and"& after a negative
7463 item.
7464
7465
7466
7467 .section "File names in lists" "SECTfilnamlis"
7468 .cindex "list" "file name in"
7469 If an item in a domain, host, address, or local part list is an absolute file
7470 name (beginning with a slash character), each line of the file is read and
7471 processed as if it were an independent item in the list, except that further
7472 file names are not allowed,
7473 and no expansion of the data from the file takes place.
7474 Empty lines in the file are ignored, and the file may also contain comment
7475 lines:
7476
7477 .ilist
7478 For domain and host lists, if a # character appears anywhere in a line of the
7479 file, it and all following characters are ignored.
7480 .next
7481 Because local parts may legitimately contain # characters, a comment in an
7482 address list or local part list file is recognized only if # is preceded by
7483 white space or the start of the line. For example:
7484 .code
7485 not#comment@x.y.z   # but this is a comment
7486 .endd
7487 .endlist
7488
7489 Putting a file name in a list has the same effect as inserting each line of the
7490 file as an item in the list (blank lines and comments excepted). However, there
7491 is one important difference: the file is read each time the list is processed,
7492 so if its contents vary over time, Exim's behaviour changes.
7493
7494 If a file name is preceded by an exclamation mark, the sense of any match
7495 within the file is inverted. For example, if
7496 .code
7497 hold_domains = !/etc/nohold-domains
7498 .endd
7499 and the file contains the lines
7500 .code
7501 !a.b.c
7502 *.b.c
7503 .endd
7504 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7505 any domain matching &`*.b.c`& is not.
7506
7507
7508
7509 .section "An lsearch file is not an out-of-line list" "SECID77"
7510 As will be described in the sections that follow, lookups can be used in lists
7511 to provide indexed methods of checking list membership. There has been some
7512 confusion about the way &(lsearch)& lookups work in lists. Because
7513 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7514 sometimes thought that it is allowed to contain wild cards and other kinds of
7515 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7516 always fixed strings, just as for any other single-key lookup type.
7517
7518 If you want to use a file to contain wild-card patterns that form part of a
7519 list, just give the file name on its own, without a search type, as described
7520 in the previous section. You could also use the &(wildlsearch)& or
7521 &(nwildlsearch)&, but there is no advantage in doing this.
7522
7523
7524
7525
7526 .section "Named lists" "SECTnamedlists"
7527 .cindex "named lists"
7528 .cindex "list" "named"
7529 A list of domains, hosts, email addresses, or local parts can be given a name
7530 which is then used to refer to the list elsewhere in the configuration. This is
7531 particularly convenient if the same list is required in several different
7532 places. It also allows lists to be given meaningful names, which can improve
7533 the readability of the configuration. For example, it is conventional to define
7534 a domain list called &'local_domains'& for all the domains that are handled
7535 locally on a host, using a configuration line such as
7536 .code
7537 domainlist local_domains = localhost:my.dom.example
7538 .endd
7539 Named lists are referenced by giving their name preceded by a plus sign, so,
7540 for example, a router that is intended to handle local domains would be
7541 configured with the line
7542 .code
7543 domains = +local_domains
7544 .endd
7545 The first router in a configuration is often one that handles all domains
7546 except the local ones, using a configuration with a negated item like this:
7547 .code
7548 dnslookup:
7549   driver = dnslookup
7550   domains = ! +local_domains
7551   transport = remote_smtp
7552   no_more
7553 .endd
7554 The four kinds of named list are created by configuration lines starting with
7555 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7556 respectively. Then there follows the name that you are defining, followed by an
7557 equals sign and the list itself. For example:
7558 .code
7559 hostlist    relay_hosts = 192.168.23.0/24 : my.friend.example
7560 addresslist bad_senders = cdb;/etc/badsenders
7561 .endd
7562 A named list may refer to other named lists:
7563 .code
7564 domainlist  dom1 = first.example : second.example
7565 domainlist  dom2 = +dom1 : third.example
7566 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7567 .endd
7568 &*Warning*&: If the last item in a referenced list is a negative one, the
7569 effect may not be what you intended, because the negation does not propagate
7570 out to the higher level. For example, consider:
7571 .code
7572 domainlist  dom1 = !a.b
7573 domainlist  dom2 = +dom1 : *.b
7574 .endd
7575 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7576 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7577 means it matches the second list as well. The effect is not the same as
7578 .code
7579 domainlist  dom2 = !a.b : *.b
7580 .endd
7581 where &'x.y'& does not match. It's best to avoid negation altogether in
7582 referenced lists if you can.
7583
7584 Named lists may have a performance advantage. When Exim is routing an
7585 address or checking an incoming message, it caches the result of tests on named
7586 lists. So, if you have a setting such as
7587 .code
7588 domains = +local_domains
7589 .endd
7590 on several of your routers
7591 or in several ACL statements,
7592 the actual test is done only for the first one. However, the caching works only
7593 if there are no expansions within the list itself or any sublists that it
7594 references. In other words, caching happens only for lists that are known to be
7595 the same each time they are referenced.
7596
7597 By default, there may be up to 16 named lists of each type. This limit can be
7598 extended by changing a compile-time variable. The use of domain and host lists
7599 is recommended for concepts such as local domains, relay domains, and relay
7600 hosts. The default configuration is set up like this.
7601
7602
7603
7604 .section "Named lists compared with macros" "SECID78"
7605 .cindex "list" "named compared with macro"
7606 .cindex "macro" "compared with named list"
7607 At first sight, named lists might seem to be no different from macros in the
7608 configuration file. However, macros are just textual substitutions. If you
7609 write
7610 .code
7611 ALIST = host1 : host2
7612 auth_advertise_hosts = !ALIST
7613 .endd
7614 it probably won't do what you want, because that is exactly the same as
7615 .code
7616 auth_advertise_hosts = !host1 : host2
7617 .endd
7618 Notice that the second host name is not negated. However, if you use a host
7619 list, and write
7620 .code
7621 hostlist alist = host1 : host2
7622 auth_advertise_hosts = ! +alist
7623 .endd
7624 the negation applies to the whole list, and so that is equivalent to
7625 .code
7626 auth_advertise_hosts = !host1 : !host2
7627 .endd
7628
7629
7630 .section "Named list caching" "SECID79"
7631 .cindex "list" "caching of named"
7632 .cindex "caching" "named lists"
7633 While processing a message, Exim caches the result of checking a named list if
7634 it is sure that the list is the same each time. In practice, this means that
7635 the cache operates only if the list contains no $ characters, which guarantees
7636 that it will not change when it is expanded. Sometimes, however, you may have
7637 an expanded list that you know will be the same each time within a given
7638 message. For example:
7639 .code
7640 domainlist special_domains = \
7641            ${lookup{$sender_host_address}cdb{/some/file}}
7642 .endd
7643 This provides a list of domains that depends only on the sending host's IP
7644 address. If this domain list is referenced a number of times (for example,
7645 in several ACL lines, or in several routers) the result of the check is not
7646 cached by default, because Exim does not know that it is going to be the
7647 same list each time.
7648
7649 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7650 cache the result anyway. For example:
7651 .code
7652 domainlist_cache special_domains = ${lookup{...
7653 .endd
7654 If you do this, you should be absolutely sure that caching is going to do
7655 the right thing in all cases. When in doubt, leave it out.
7656
7657
7658
7659 .section "Domain lists" "SECTdomainlist"
7660 .cindex "domain list" "patterns for"
7661 .cindex "list" "domain list"
7662 Domain lists contain patterns that are to be matched against a mail domain.
7663 The following types of item may appear in domain lists:
7664
7665 .ilist
7666 .cindex "primary host name"
7667 .cindex "host name" "matched in domain list"
7668 .oindex "&%primary_hostname%&"
7669 .cindex "domain list" "matching primary host name"
7670 .cindex "@ in a domain list"
7671 If a pattern consists of a single @ character, it matches the local host name,
7672 as set by the &%primary_hostname%& option (or defaulted). This makes it
7673 possible to use the same configuration file on several different hosts that
7674 differ only in their names.
7675 .next
7676 .cindex "@[] in a domain list"
7677 .cindex "domain list" "matching local IP interfaces"
7678 .cindex "domain literal"
7679 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7680 in square brackets (as in an email address that contains a domain literal), but
7681 only if that IP address is recognized as local for email routing purposes. The
7682 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7683 control which of a host's several IP addresses are treated as local.
7684 In today's Internet, the use of domain literals is controversial.
7685 .next
7686 .cindex "@mx_any"
7687 .cindex "@mx_primary"
7688 .cindex "@mx_secondary"
7689 .cindex "domain list" "matching MX pointers to local host"
7690 If a pattern consists of the string &`@mx_any`& it matches any domain that
7691 has an MX record pointing to the local host or to any host that is listed in
7692 .oindex "&%hosts_treat_as_local%&"
7693 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7694 are similar, except that the first matches only when a primary MX target is the
7695 local host, and the second only when no primary MX target is the local host,
7696 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7697 preference value &-- there may of course be more than one of them.
7698
7699 The MX lookup that takes place when matching a pattern of this type is
7700 performed with the resolver options for widening names turned off. Thus, for
7701 example, a single-component domain will &'not'& be expanded by adding the
7702 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7703 options of the &(dnslookup)& router for a discussion of domain widening.
7704
7705 Sometimes you may want to ignore certain IP addresses when using one of these
7706 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7707 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7708 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7709 on a router). For example:
7710 .code
7711 domains = @mx_any/ignore=127.0.0.1
7712 .endd
7713 This example matches any domain that has an MX record pointing to one of
7714 the local host's IP addresses other than 127.0.0.1.
7715
7716 The list of IP addresses is in fact processed by the same code that processes
7717 host lists, so it may contain CIDR-coded network specifications and it may also
7718 contain negative items.
7719
7720 Because the list of IP addresses is a sublist within a domain list, you have to
7721 be careful about delimiters if there is more than one address. Like any other
7722 list, the default delimiter can be changed. Thus, you might have:
7723 .code
7724 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7725           an.other.domain : ...
7726 .endd
7727 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7728 involved, it is easiest to change the delimiter for the main list as well:
7729 .code
7730 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7731           an.other.domain ? ...
7732 .endd
7733 .next
7734 .cindex "asterisk" "in domain list"
7735 .cindex "domain list" "asterisk in"
7736 .cindex "domain list" "matching &""ends with""&"
7737 If a pattern starts with an asterisk, the remaining characters of the pattern
7738 are compared with the terminating characters of the domain. The use of &"*"& in
7739 domain lists differs from its use in partial matching lookups. In a domain
7740 list, the character following the asterisk need not be a dot, whereas partial
7741 matching works only in terms of dot-separated components. For example, a domain
7742 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7743 &'cipher.key.ex'&.
7744
7745 .next
7746 .cindex "regular expressions" "in domain list"
7747 .cindex "domain list" "matching regular expression"
7748 If a pattern starts with a circumflex character, it is treated as a regular
7749 expression, and matched against the domain using a regular expression matching
7750 function. The circumflex is treated as part of the regular expression.
7751 Email domains are case-independent, so this regular expression match is by
7752 default case-independent, but you can make it case-dependent by starting it
7753 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7754 are given in chapter &<<CHAPregexp>>&.
7755
7756 &*Warning*&: Because domain lists are expanded before being processed, you
7757 must escape any backslash and dollar characters in the regular expression, or
7758 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7759 it is not to be expanded (unless you really do want to build a regular
7760 expression by expansion, of course).
7761 .next
7762 .cindex "lookup" "in domain list"
7763 .cindex "domain list" "matching by lookup"
7764 If a pattern starts with the name of a single-key lookup type followed by a
7765 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7766 must be a file name in a suitable format for the lookup type. For example, for
7767 &"cdb;"& it must be an absolute path:
7768 .code
7769 domains = cdb;/etc/mail/local_domains.cdb
7770 .endd
7771 The appropriate type of lookup is done on the file using the domain name as the
7772 key. In most cases, the data that is looked up is not used; Exim is interested
7773 only in whether or not the key is present in the file. However, when a lookup
7774 is used for the &%domains%& option on a router
7775 or a &%domains%& condition in an ACL statement, the data is preserved in the
7776 &$domain_data$& variable and can be referred to in other router options or
7777 other statements in the same ACL.
7778
7779 .next
7780 Any of the single-key lookup type names may be preceded by
7781 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7782 .code
7783 domains = partial-dbm;/partial/domains
7784 .endd
7785 This causes partial matching logic to be invoked; a description of how this
7786 works is given in section &<<SECTpartiallookup>>&.
7787
7788 .next
7789 .cindex "asterisk" "in lookup type"
7790 Any of the single-key lookup types may be followed by an asterisk. This causes
7791 a default lookup for a key consisting of a single asterisk to be done if the
7792 original lookup fails. This is not a useful feature when using a domain list to
7793 select particular domains (because any domain would match), but it might have
7794 value if the result of the lookup is being used via the &$domain_data$&
7795 expansion variable.
7796 .next
7797 If the pattern starts with the name of a query-style lookup type followed by a
7798 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7799 pattern must be an appropriate query for the lookup type, as described in
7800 chapter &<<CHAPfdlookup>>&. For example:
7801 .code
7802 hold_domains = mysql;select domain from holdlist \
7803   where domain = '$domain';
7804 .endd
7805 In most cases, the data that is looked up is not used (so for an SQL query, for
7806 example, it doesn't matter what field you select). Exim is interested only in
7807 whether or not the query succeeds. However, when a lookup is used for the
7808 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7809 variable and can be referred to in other options.
7810 .next
7811 .cindex "domain list" "matching literal domain name"
7812 If none of the above cases apply, a caseless textual comparison is made
7813 between the pattern and the domain.
7814 .endlist
7815
7816 Here is an example that uses several different kinds of pattern:
7817 .code
7818 domainlist funny_domains = \
7819   @ : \
7820   lib.unseen.edu : \
7821   *.foundation.fict.example : \
7822   \N^[1-2]\d{3}\.fict\.example$\N : \
7823   partial-dbm;/opt/data/penguin/book : \
7824   nis;domains.byname : \
7825   nisplus;[name=$domain,status=local],domains.org_dir
7826 .endd
7827 There are obvious processing trade-offs among the various matching modes. Using
7828 an asterisk is faster than a regular expression, and listing a few names
7829 explicitly probably is too. The use of a file or database lookup is expensive,
7830 but may be the only option if hundreds of names are required. Because the
7831 patterns are tested in order, it makes sense to put the most commonly matched
7832 patterns earlier.
7833
7834
7835
7836 .section "Host lists" "SECThostlist"
7837 .cindex "host list" "patterns in"
7838 .cindex "list" "host list"
7839 Host lists are used to control what remote hosts are allowed to do. For
7840 example, some hosts may be allowed to use the local host as a relay, and some
7841 may be permitted to use the SMTP ETRN command. Hosts can be identified in
7842 two different ways, by name or by IP address. In a host list, some types of
7843 pattern are matched to a host name, and some are matched to an IP address.
7844 You need to be particularly careful with this when single-key lookups are
7845 involved, to ensure that the right value is being used as the key.
7846
7847
7848 .section "Special host list patterns" "SECID80"
7849 .cindex "empty item in hosts list"
7850 .cindex "host list" "empty string in"
7851 If a host list item is the empty string, it matches only when no remote host is
7852 involved. This is the case when a message is being received from a local
7853 process using SMTP on the standard input, that is, when a TCP/IP connection is
7854 not used.
7855
7856 .cindex "asterisk" "in host list"
7857 The special pattern &"*"& in a host list matches any host or no host. Neither
7858 the IP address nor the name is actually inspected.
7859
7860
7861
7862 .section "Host list patterns that match by IP address" "SECThoslispatip"
7863 .cindex "host list" "matching IP addresses"
7864 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
7865 the incoming address actually appears in the IPv6 host as
7866 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
7867 list, it is converted into a traditional IPv4 address first. (Not all operating
7868 systems accept IPv4 calls on IPv6 sockets, as there have been some security
7869 concerns.)
7870
7871 The following types of pattern in a host list check the remote host by
7872 inspecting its IP address:
7873
7874 .ilist
7875 If the pattern is a plain domain name (not a regular expression, not starting
7876 with *, not a lookup of any kind), Exim calls the operating system function
7877 to find the associated IP address(es). Exim uses the newer
7878 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
7879 This typically causes a forward DNS lookup of the name. The result is compared
7880 with the IP address of the subject host.
7881
7882 If there is a temporary problem (such as a DNS timeout) with the host name
7883 lookup, a temporary error occurs. For example, if the list is being used in an
7884 ACL condition, the ACL gives a &"defer"& response, usually leading to a
7885 temporary SMTP error code. If no IP address can be found for the host name,
7886 what happens is described in section &<<SECTbehipnot>>& below.
7887
7888 .next
7889 .cindex "@ in a host list"
7890 If the pattern is &"@"&, the primary host name is substituted and used as a
7891 domain name, as just described.
7892
7893 .next
7894 If the pattern is an IP address, it is matched against the IP address of the
7895 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
7896 IPv6 addresses can be given in colon-separated format, but the colons have to
7897 be doubled so as not to be taken as item separators when the default list
7898 separator is used. IPv6 addresses are recognized even when Exim is compiled
7899 without IPv6 support. This means that if they appear in a host list on an
7900 IPv4-only host, Exim will not treat them as host names. They are just addresses
7901 that can never match a client host.
7902
7903 .next
7904 .cindex "@[] in a host list"
7905 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
7906 the local host. For example, if the local host is an IPv4 host with one
7907 interface address 10.45.23.56, these two ACL statements have the same effect:
7908 .code
7909 accept hosts = 127.0.0.1 : 10.45.23.56
7910 accept hosts = @[]
7911 .endd
7912 .next
7913 .cindex "CIDR notation"
7914 If the pattern is an IP address followed by a slash and a mask length (for
7915 example 10.11.42.0/24), it is matched against the IP address of the subject
7916 host under the given mask. This allows, an entire network of hosts to be
7917 included (or excluded) by a single item. The mask uses CIDR notation; it
7918 specifies the number of address bits that must match, starting from the most
7919 significant end of the address.
7920
7921 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
7922 of a range of addresses. It is the number of bits in the network portion of the
7923 address. The above example specifies a 24-bit netmask, so it matches all 256
7924 addresses in the 10.11.42.0 network. An item such as
7925 .code
7926 192.168.23.236/31
7927 .endd
7928 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
7929 32 for an IPv4 address is the same as no mask at all; just a single address
7930 matches.
7931
7932 Here is another example which shows an IPv4 and an IPv6 network:
7933 .code
7934 recipient_unqualified_hosts = 192.168.0.0/16: \
7935                               3ffe::ffff::836f::::/48
7936 .endd
7937 The doubling of list separator characters applies only when these items
7938 appear inline in a host list. It is not required when indirecting via a file.
7939 For example:
7940 .code
7941 recipient_unqualified_hosts = /opt/exim/unqualnets
7942 .endd
7943 could make use of a file containing
7944 .code
7945 172.16.0.0/12
7946 3ffe:ffff:836f::/48
7947 .endd
7948 to have exactly the same effect as the previous example. When listing IPv6
7949 addresses inline, it is usually more convenient to use the facility for
7950 changing separator characters. This list contains the same two networks:
7951 .code
7952 recipient_unqualified_hosts = <; 172.16.0.0/12; \
7953                                  3ffe:ffff:836f::/48
7954 .endd
7955 The separator is changed to semicolon by the leading &"<;"& at the start of the
7956 list.
7957 .endlist
7958
7959
7960
7961 .section "Host list patterns for single-key lookups by host address" &&&
7962          "SECThoslispatsikey"
7963 .cindex "host list" "lookup of IP address"
7964 When a host is to be identified by a single-key lookup of its complete IP
7965 address, the pattern takes this form:
7966 .display
7967 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
7968 .endd
7969 For example:
7970 .code
7971 hosts_lookup = net-cdb;/hosts-by-ip.db
7972 .endd
7973 The text form of the IP address of the subject host is used as the lookup key.
7974 IPv6 addresses are converted to an unabbreviated form, using lower case
7975 letters, with dots as separators because colon is the key terminator in
7976 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
7977 quoting the keys, but this is a facility that was added later.] The data
7978 returned by the lookup is not used.
7979
7980 .cindex "IP address" "masking"
7981 .cindex "host list" "masked IP address"
7982 Single-key lookups can also be performed using masked IP addresses, using
7983 patterns of this form:
7984 .display
7985 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
7986 .endd
7987 For example:
7988 .code
7989 net24-dbm;/networks.db
7990 .endd
7991 The IP address of the subject host is masked using <&'number'&> as the mask
7992 length. A textual string is constructed from the masked value, followed by the
7993 mask, and this is used as the lookup key. For example, if the host's IP address
7994 is 192.168.34.6, the key that is looked up for the above example is
7995 &"192.168.34.0/24"&.
7996
7997 When an IPv6 address is converted to a string, dots are normally used instead
7998 of colons, so that keys in &(lsearch)& files need not contain colons (which
7999 terminate &(lsearch)& keys). This was implemented some time before the ability
8000 to quote keys was made available in &(lsearch)& files. However, the more
8001 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8002 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8003 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8004 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8005 addresses are always used.
8006
8007 Ideally, it would be nice to tidy up this anomalous situation by changing to
8008 colons in all cases, given that quoting is now available for &(lsearch)&.
8009 However, this would be an incompatible change that might break some existing
8010 configurations.
8011
8012 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8013 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8014 the former case the key strings include the mask value, whereas in the latter
8015 case the IP address is used on its own.
8016
8017
8018
8019 .section "Host list patterns that match by host name" "SECThoslispatnam"
8020 .cindex "host" "lookup failures"
8021 .cindex "unknown host name"
8022 .cindex "host list" "matching host name"
8023 There are several types of pattern that require Exim to know the name of the
8024 remote host. These are either wildcard patterns or lookups by name. (If a
8025 complete hostname is given without any wildcarding, it is used to find an IP
8026 address to match against, as described in the section &<<SECThoslispatip>>&
8027 above.)
8028
8029 If the remote host name is not already known when Exim encounters one of these
8030 patterns, it has to be found from the IP address.
8031 Although many sites on the Internet are conscientious about maintaining reverse
8032 DNS data for their hosts, there are also many that do not do this.
8033 Consequently, a name cannot always be found, and this may lead to unwanted
8034 effects. Take care when configuring host lists with wildcarded name patterns.
8035 Consider what will happen if a name cannot be found.
8036
8037 Because of the problems of determining host names from IP addresses, matching
8038 against host names is not as common as matching against IP addresses.
8039
8040 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8041 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8042 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8043 are done can be changed by setting the &%host_lookup_order%& option. For
8044 security, once Exim has found one or more names, it looks up the IP addresses
8045 for these names and compares them with the IP address that it started with.
8046 Only those names whose IP addresses match are accepted. Any other names are
8047 discarded. If no names are left, Exim behaves as if the host name cannot be
8048 found. In the most common case there is only one name and one IP address.
8049
8050 There are some options that control what happens if a host name cannot be
8051 found. These are described in section &<<SECTbehipnot>>& below.
8052
8053 .cindex "host" "alias for"
8054 .cindex "alias for host"
8055 As a result of aliasing, hosts may have more than one name. When processing any
8056 of the following types of pattern, all the host's names are checked:
8057
8058 .ilist
8059 .cindex "asterisk" "in host list"
8060 If a pattern starts with &"*"& the remainder of the item must match the end of
8061 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8062 &'.b.c'&. This special simple form is provided because this is a very common
8063 requirement. Other kinds of wildcarding require the use of a regular
8064 expression.
8065 .next
8066 .cindex "regular expressions" "in host list"
8067 .cindex "host list" "regular expression in"
8068 If the item starts with &"^"& it is taken to be a regular expression which is
8069 matched against the host name. Host names are case-independent, so this regular
8070 expression match is by default case-independent, but you can make it
8071 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8072 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8073 example,
8074 .code
8075 ^(a|b)\.c\.d$
8076 .endd
8077 is a regular expression that matches either of the two hosts &'a.c.d'& or
8078 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8079 that backslash and dollar characters are not misinterpreted as part of the
8080 string expansion. The simplest way to do this is to use &`\N`& to mark that
8081 part of the string as non-expandable. For example:
8082 .code
8083 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8084 .endd
8085 &*Warning*&: If you want to match a complete host name, you must include the
8086 &`$`& terminating metacharacter in the regular expression, as in the above
8087 example. Without it, a match at the start of the host name is all that is
8088 required.
8089 .endlist
8090
8091
8092
8093
8094 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8095 .cindex "host" "lookup failures, permanent"
8096 While processing a host list, Exim may need to look up an IP address from a
8097 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8098 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8099 behaviour when it fails to find the information it is seeking is the same.
8100
8101 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8102 apply to temporary DNS errors, whose handling is described in the next section.
8103
8104 .cindex "&`+include_unknown`&"
8105 .cindex "&`+ignore_unknown`&"
8106 By default, Exim behaves as if the host does not match the list. This may not
8107 always be what you want to happen. To change Exim's behaviour, the special
8108 items &`+include_unknown`& or &`+ignore_unknown`& may appear in the list (at
8109 top level &-- they are not recognized in an indirected file).
8110
8111 .ilist
8112 If any item that follows &`+include_unknown`& requires information that
8113 cannot found, Exim behaves as if the host does match the list. For example,
8114 .code
8115 host_reject_connection = +include_unknown:*.enemy.ex
8116 .endd
8117 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8118 any hosts whose name it cannot find.
8119
8120 .next
8121 If any item that follows &`+ignore_unknown`& requires information that cannot
8122 be found, Exim ignores that item and proceeds to the rest of the list. For
8123 example:
8124 .code
8125 accept hosts = +ignore_unknown : friend.example : \
8126                192.168.4.5
8127 .endd
8128 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8129 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8130 name can be found for 192.168.4.5, it is rejected.
8131 .endlist
8132
8133 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8134 list. The effect of each one lasts until the next, or until the end of the
8135 list.
8136
8137
8138 .section "Temporary DNS errors when looking up host information" &&&
8139          "SECTtemdnserr"
8140 .cindex "host" "lookup failures, temporary"
8141 .cindex "&`+include_defer`&"
8142 .cindex "&`+ignore_defer`&"
8143 A temporary DNS lookup failure normally causes a defer action (except when
8144 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8145 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8146 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8147 section. These options should be used with care, probably only in non-critical
8148 host lists such as whitelists.
8149
8150
8151
8152 .section "Host list patterns for single-key lookups by host name" &&&
8153          "SECThoslispatnamsk"
8154 .cindex "unknown host name"
8155 .cindex "host list" "matching host name"
8156 If a pattern is of the form
8157 .display
8158 <&'single-key-search-type'&>;<&'search-data'&>
8159 .endd
8160 for example
8161 .code
8162 dbm;/host/accept/list
8163 .endd
8164 a single-key lookup is performed, using the host name as its key. If the
8165 lookup succeeds, the host matches the item. The actual data that is looked up
8166 is not used.
8167
8168 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8169 keys in the file, not IP addresses. If you want to do lookups based on IP
8170 addresses, you must precede the search type with &"net-"& (see section
8171 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8172 two items in the same list, one doing an address lookup and one doing a name
8173 lookup, both using the same file.
8174
8175
8176
8177 .section "Host list patterns for query-style lookups" "SECID81"
8178 If a pattern is of the form
8179 .display
8180 <&'query-style-search-type'&>;<&'query'&>
8181 .endd
8182 the query is obeyed, and if it succeeds, the host matches the item. The actual
8183 data that is looked up is not used. The variables &$sender_host_address$& and
8184 &$sender_host_name$& can be used in the query. For example:
8185 .code
8186 hosts_lookup = pgsql;\
8187   select ip from hostlist where ip='$sender_host_address'
8188 .endd
8189 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8190 can use the &%sg%& expansion item to change this if you need to. If you want to
8191 use masked IP addresses in database queries, you can use the &%mask%& expansion
8192 operator.
8193
8194 If the query contains a reference to &$sender_host_name$&, Exim automatically
8195 looks up the host name if has not already done so. (See section
8196 &<<SECThoslispatnam>>& for comments on finding host names.)
8197
8198 Historical note: prior to release 4.30, Exim would always attempt to find a
8199 host name before running the query, unless the search type was preceded by
8200 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8201 still recognized for query-style lookups, but its presence or absence has no
8202 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8203 See section &<<SECThoslispatsikey>>&.)
8204
8205
8206
8207 .section "Mixing wildcarded host names and addresses in host lists" &&&
8208          "SECTmixwilhos"
8209 .cindex "host list" "mixing names and addresses in"
8210 If you have name lookups or wildcarded host names and IP addresses in the same
8211 host list, you should normally put the IP addresses first. For example, in an
8212 ACL you could have:
8213 .code
8214 accept hosts = 10.9.8.7 : *.friend.example
8215 .endd
8216 The reason for this lies in the left-to-right way that Exim processes lists.
8217 It can test IP addresses without doing any DNS lookups, but when it reaches an
8218 item that requires a host name, it fails if it cannot find a host name to
8219 compare with the pattern. If the above list is given in the opposite order, the
8220 &%accept%& statement fails for a host whose name cannot be found, even if its
8221 IP address is 10.9.8.7.
8222
8223 If you really do want to do the name check first, and still recognize the IP
8224 address, you can rewrite the ACL like this:
8225 .code
8226 accept hosts = *.friend.example
8227 accept hosts = 10.9.8.7
8228 .endd
8229 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8230 &<<CHAPACL>>& for details of ACLs.
8231
8232
8233
8234
8235
8236 .section "Address lists" "SECTaddresslist"
8237 .cindex "list" "address list"
8238 .cindex "address list" "empty item"
8239 .cindex "address list" "patterns"
8240 Address lists contain patterns that are matched against mail addresses. There
8241 is one special case to be considered: the sender address of a bounce message is
8242 always empty. You can test for this by providing an empty item in an address
8243 list. For example, you can set up a router to process bounce messages by
8244 using this option setting:
8245 .code
8246 senders = :
8247 .endd
8248 The presence of the colon creates an empty item. If you do not provide any
8249 data, the list is empty and matches nothing. The empty sender can also be
8250 detected by a regular expression that matches an empty string,
8251 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8252
8253 Non-empty items in an address list can be straightforward email addresses. For
8254 example:
8255 .code
8256 senders = jbc@askone.example : hs@anacreon.example
8257 .endd
8258 A certain amount of wildcarding is permitted. If a pattern contains an @
8259 character, but is not a regular expression and does not begin with a
8260 semicolon-terminated lookup type (described below), the local part of the
8261 subject address is compared with the local part of the pattern, which may start
8262 with an asterisk. If the local parts match, the domain is checked in exactly
8263 the same way as for a pattern in a domain list. For example, the domain can be
8264 wildcarded, refer to a named list, or be a lookup:
8265 .code
8266 deny senders = *@*.spamming.site:\
8267                *@+hostile_domains:\
8268                bozo@partial-lsearch;/list/of/dodgy/sites:\
8269                *@dbm;/bad/domains.db
8270 .endd
8271 .cindex "local part" "starting with !"
8272 .cindex "address list" "local part starting with !"
8273 If a local part that begins with an exclamation mark is required, it has to be
8274 specified using a regular expression, because otherwise the exclamation mark is
8275 treated as a sign of negation, as is standard in lists.
8276
8277 If a non-empty pattern that is not a regular expression or a lookup does not
8278 contain an @ character, it is matched against the domain part of the subject
8279 address. The only two formats that are recognized this way are a literal
8280 domain, or a domain pattern that starts with *. In both these cases, the effect
8281 is the same as if &`*@`& preceded the pattern. For example:
8282 .code
8283 deny senders = enemy.domain : *.enemy.domain
8284 .endd
8285
8286 The following kinds of more complicated address list pattern can match any
8287 address, including the empty address that is characteristic of bounce message
8288 senders:
8289
8290 .ilist
8291 .cindex "regular expressions" "in address list"
8292 .cindex "address list" "regular expression in"
8293 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8294 done against the complete address, with the pattern as the regular expression.
8295 You must take care that backslash and dollar characters are not misinterpreted
8296 as part of the string expansion. The simplest way to do this is to use &`\N`&
8297 to mark that part of the string as non-expandable. For example:
8298 .code
8299 deny senders = \N^.*this.*@example\.com$\N : \
8300                \N^\d{8}.+@spamhaus.example$\N : ...
8301 .endd
8302 The &`\N`& sequences are removed by the expansion, so these items do indeed
8303 start with &"^"& by the time they are being interpreted as address patterns.
8304
8305 .next
8306 .cindex "address list" "lookup for complete address"
8307 Complete addresses can be looked up by using a pattern that starts with a
8308 lookup type terminated by a semicolon, followed by the data for the lookup. For
8309 example:
8310 .code
8311 deny senders = cdb;/etc/blocked.senders : \
8312   mysql;select address from blocked where \
8313   address='${quote_mysql:$sender_address}'
8314 .endd
8315 Both query-style and single-key lookup types can be used. For a single-key
8316 lookup type, Exim uses the complete address as the key. However, empty keys are
8317 not supported for single-key lookups, so a match against the empty address
8318 always fails. This restriction does not apply to query-style lookups.
8319
8320 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8321 cannot be used, and is ignored if specified, with an entry being written to the
8322 panic log.
8323 .cindex "*@ with single-key lookup"
8324 However, you can configure lookup defaults, as described in section
8325 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8326 default. For example, with this lookup:
8327 .code
8328 accept senders = lsearch*@;/some/file
8329 .endd
8330 the file could contains lines like this:
8331 .code
8332 user1@domain1.example
8333 *@domain2.example
8334 .endd
8335 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8336 that are tried is:
8337 .code
8338 nimrod@jaeger.example
8339 *@jaeger.example
8340 *
8341 .endd
8342 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8343 would mean that every address matches, thus rendering the test useless.
8344
8345 &*Warning 2*&: Do not confuse these two kinds of item:
8346 .code
8347 deny recipients = dbm*@;/some/file
8348 deny recipients = *@dbm;/some/file
8349 .endd
8350 The first does a whole address lookup, with defaulting, as just described,
8351 because it starts with a lookup type. The second matches the local part and
8352 domain independently, as described in a bullet point below.
8353 .endlist
8354
8355
8356 The following kinds of address list pattern can match only non-empty addresses.
8357 If the subject address is empty, a match against any of these pattern types
8358 always fails.
8359
8360
8361 .ilist
8362 .cindex "@@ with single-key lookup"
8363 .cindex "address list" "@@ lookup type"
8364 .cindex "address list" "split local part and domain"
8365 If a pattern starts with &"@@"& followed by a single-key lookup item
8366 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8367 split into a local part and a domain. The domain is looked up in the file. If
8368 it is not found, there is no match. If it is found, the data that is looked up
8369 from the file is treated as a colon-separated list of local part patterns, each
8370 of which is matched against the subject local part in turn.
8371
8372 .cindex "asterisk" "in address list"
8373 The lookup may be a partial one, and/or one involving a search for a default
8374 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8375 patterns that are looked up can be regular expressions or begin with &"*"&, or
8376 even be further lookups. They may also be independently negated. For example,
8377 with
8378 .code
8379 deny senders = @@dbm;/etc/reject-by-domain
8380 .endd
8381 the data from which the DBM file is built could contain lines like
8382 .code
8383 baddomain.com:  !postmaster : *
8384 .endd
8385 to reject all senders except &%postmaster%& from that domain.
8386
8387 .cindex "local part" "starting with !"
8388 If a local part that actually begins with an exclamation mark is required, it
8389 has to be specified using a regular expression. In &(lsearch)& files, an entry
8390 may be split over several lines by indenting the second and subsequent lines,
8391 but the separating colon must still be included at line breaks. White space
8392 surrounding the colons is ignored. For example:
8393 .code
8394 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8395 spammer3 : spammer4
8396 .endd
8397 As in all colon-separated lists in Exim, a colon can be included in an item by
8398 doubling.
8399
8400 If the last item in the list starts with a right angle-bracket, the remainder
8401 of the item is taken as a new key to look up in order to obtain a continuation
8402 list of local parts. The new key can be any sequence of characters. Thus one
8403 might have entries like
8404 .code
8405 aol.com: spammer1 : spammer 2 : >*
8406 xyz.com: spammer3 : >*
8407 *:       ^\d{8}$
8408 .endd
8409 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8410 local parts for all domains, in addition to the specific local parts listed for
8411 each domain. Of course, using this feature costs another lookup each time a
8412 chain is followed, but the effort needed to maintain the data is reduced.
8413
8414 .cindex "loop" "in lookups"
8415 It is possible to construct loops using this facility, and in order to catch
8416 them, the chains may be no more than fifty items long.
8417
8418 .next
8419 The @@<&'lookup'&> style of item can also be used with a query-style
8420 lookup, but in this case, the chaining facility is not available. The lookup
8421 can only return a single list of local parts.
8422 .endlist
8423
8424 &*Warning*&: There is an important difference between the address list items
8425 in these two examples:
8426 .code
8427 senders = +my_list
8428 senders = *@+my_list
8429 .endd
8430 In the first one, &`my_list`& is a named address list, whereas in the second
8431 example it is a named domain list.
8432
8433
8434
8435
8436 .section "Case of letters in address lists" "SECTcasletadd"
8437 .cindex "case of local parts"
8438 .cindex "address list" "case forcing"
8439 .cindex "case forcing in address lists"
8440 Domains in email addresses are always handled caselessly, but for local parts
8441 case may be significant on some systems (see &%caseful_local_part%& for how
8442 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8443 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8444 blocking lists should be done in a case-independent manner. Since most address
8445 lists in Exim are used for this kind of control, Exim attempts to do this by
8446 default.
8447
8448 The domain portion of an address is always lowercased before matching it to an
8449 address list. The local part is lowercased by default, and any string
8450 comparisons that take place are done caselessly. This means that the data in
8451 the address list itself, in files included as plain file names, and in any file
8452 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8453 keys in files that are looked up by a search type other than &(lsearch)& (which
8454 works caselessly) must be in lower case, because these lookups are not
8455 case-independent.
8456
8457 .cindex "&`+caseful`&"
8458 To allow for the possibility of caseful address list matching, if an item in
8459 an address list is the string &"+caseful"&, the original case of the local
8460 part is restored for any comparisons that follow, and string comparisons are no
8461 longer case-independent. This does not affect the domain, which remains in
8462 lower case. However, although independent matches on the domain alone are still
8463 performed caselessly, regular expressions that match against an entire address
8464 become case-sensitive after &"+caseful"& has been seen.
8465
8466
8467
8468 .section "Local part lists" "SECTlocparlis"
8469 .cindex "list" "local part list"
8470 .cindex "local part" "list"
8471 Case-sensitivity in local part lists is handled in the same way as for address
8472 lists, as just described. The &"+caseful"& item can be used if required. In a
8473 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8474 set false, the subject is lowercased and the matching is initially
8475 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8476 matching in the local part list, but not elsewhere in the router. If
8477 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8478 option is case-sensitive from the start.
8479
8480 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8481 comments are handled in the same way as address lists &-- they are recognized
8482 only if the # is preceded by white space or the start of the line.
8483 Otherwise, local part lists are matched in the same way as domain lists, except
8484 that the special items that refer to the local host (&`@`&, &`@[]`&,
8485 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8486 Refer to section &<<SECTdomainlist>>& for details of the other available item
8487 types.
8488 .ecindex IIDdohoadli
8489
8490
8491
8492
8493 . ////////////////////////////////////////////////////////////////////////////
8494 . ////////////////////////////////////////////////////////////////////////////
8495
8496 .chapter "String expansions" "CHAPexpand"
8497 .scindex IIDstrexp "expansion" "of strings"
8498 Many strings in Exim's run time configuration are expanded before use. Some of
8499 them are expanded every time they are used; others are expanded only once.
8500
8501 When a string is being expanded it is copied verbatim from left to right except
8502 when a dollar or backslash character is encountered. A dollar specifies the
8503 start of a portion of the string that is interpreted and replaced as described
8504 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8505 escape character, as described in the following section.
8506
8507
8508
8509 .section "Literal text in expanded strings" "SECTlittext"
8510 .cindex "expansion" "including literal text"
8511 An uninterpreted dollar can be included in an expanded string by putting a
8512 backslash in front of it. A backslash can be used to prevent any special
8513 character being treated specially in an expansion, including backslash itself.
8514 If the string appears in quotes in the configuration file, two backslashes are
8515 required because the quotes themselves cause interpretation of backslashes when
8516 the string is read in (see section &<<SECTstrings>>&).
8517
8518 .cindex "expansion" "non-expandable substrings"
8519 A portion of the string can specified as non-expandable by placing it between
8520 two occurrences of &`\N`&. This is particularly useful for protecting regular
8521 expressions, which often contain backslashes and dollar signs. For example:
8522 .code
8523 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8524 .endd
8525 On encountering the first &`\N`&, the expander copies subsequent characters
8526 without interpretation until it reaches the next &`\N`& or the end of the
8527 string.
8528
8529
8530
8531 .section "Character escape sequences in expanded strings" "SECID82"
8532 .cindex "expansion" "escape sequences"
8533 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8534 expanded string is recognized as an escape sequence for the character newline,
8535 carriage return, or tab, respectively. A backslash followed by up to three
8536 octal digits is recognized as an octal encoding for a single character, and a
8537 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8538 encoding.
8539
8540 These escape sequences are also recognized in quoted strings when they are read
8541 in. Their interpretation in expansions as well is useful for unquoted strings,
8542 and for other cases such as looked-up strings that are then expanded.
8543
8544
8545 .section "Testing string expansions" "SECID83"
8546 .cindex "expansion" "testing"
8547 .cindex "testing" "string expansion"
8548 .oindex "&%-be%&"
8549 Many expansions can be tested by calling Exim with the &%-be%& option. This
8550 takes the command arguments, or lines from the standard input if there are no
8551 arguments, runs them through the string expansion code, and writes the results
8552 to the standard output. Variables based on configuration values are set up, but
8553 since no message is being processed, variables such as &$local_part$& have no
8554 value. Nevertheless the &%-be%& option can be useful for checking out file and
8555 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8556 and &%nhash%&.
8557
8558 Exim gives up its root privilege when it is called with the &%-be%& option, and
8559 instead runs under the uid and gid it was called with, to prevent users from
8560 using &%-be%& for reading files to which they do not have access.
8561
8562 .oindex "&%-bem%&"
8563 If you want to test expansions that include variables whose values are taken
8564 from a message, there are two other options that can be used. The &%-bem%&
8565 option is like &%-be%& except that it is followed by a file name. The file is
8566 read as a message before doing the test expansions. For example:
8567 .code
8568 exim -bem /tmp/test.message '$h_subject:'
8569 .endd
8570 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8571 Exim message identifier. For example:
8572 .code
8573 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8574 .endd
8575 This loads the message from Exim's spool before doing the test expansions, and
8576 is therefore restricted to admin users.
8577
8578
8579 .section "Forced expansion failure" "SECTforexpfai"
8580 .cindex "expansion" "forced failure"
8581 A number of expansions that are described in the following section have
8582 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8583 (which are sometimes called &"curly brackets"&). Which of the two strings is
8584 used depends on some condition that is evaluated as part of the expansion. If,
8585 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8586 the entire string expansion fails in a way that can be detected by the code
8587 that requested the expansion. This is called &"forced expansion failure"&, and
8588 its consequences depend on the circumstances. In some cases it is no different
8589 from any other expansion failure, but in others a different action may be
8590 taken. Such variations are mentioned in the documentation of the option that is
8591 being expanded.
8592
8593
8594
8595
8596 .section "Expansion items" "SECTexpansionitems"
8597 The following items are recognized in expanded strings. White space may be used
8598 between sub-items that are keywords or substrings enclosed in braces inside an
8599 outer set of braces, to improve readability. &*Warning*&: Within braces,
8600 white space is significant.
8601
8602 .vlist
8603 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8604 .cindex "expansion" "variables"
8605 Substitute the contents of the named variable, for example:
8606 .code
8607 $local_part
8608 ${domain}
8609 .endd
8610 The second form can be used to separate the name from subsequent alphanumeric
8611 characters. This form (using braces) is available only for variables; it does
8612 &'not'& apply to message headers. The names of the variables are given in
8613 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8614 given, the expansion fails.
8615
8616 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8617 .cindex "expansion" "operators"
8618 The string is first itself expanded, and then the operation specified by
8619 <&'op'&> is applied to it. For example:
8620 .code
8621 ${lc:$local_part}
8622 .endd
8623 The string starts with the first character after the colon, which may be
8624 leading white space. A list of operators is given in section &<<SECTexpop>>&
8625 below. The operator notation is used for simple expansion items that have just
8626 one argument, because it reduces the number of braces and therefore makes the
8627 string easier to understand.
8628
8629 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8630 This item inserts &"basic"& header lines. It is described with the &%header%&
8631 expansion item below.
8632
8633 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8634        {*&<&'arg'&>&*}...}*&"
8635 .cindex &%dlfunc%&
8636 This expansion dynamically loads and then calls a locally-written C function.
8637 This functionality is available only if Exim is compiled with
8638 .code
8639 EXPAND_DLFUNC=yes
8640 .endd
8641 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8642 object so that it doesn't reload the same object file in the same Exim process
8643 (but of course Exim does start new processes frequently).
8644
8645 There may be from zero to eight arguments to the function. When compiling
8646 a local function that is to be called in this way, &_local_scan.h_& should be
8647 included. The Exim variables and functions that are defined by that API
8648 are also available for dynamically loaded functions. The function itself
8649 must have the following type:
8650 .code
8651 int dlfunction(uschar **yield, int argc, uschar *argv[])
8652 .endd
8653 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8654 function should return one of the following values:
8655
8656 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8657 into the expanded string that is being built.
8658
8659 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8660 from &'yield'&, if it is set.
8661
8662 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8663 taken from &'yield'& if it is set.
8664
8665 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8666
8667 When compiling a function that is to be used in this way with gcc,
8668 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8669 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8670
8671 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8672        {*&<&'string3'&>&*}}*&"
8673 .cindex "expansion" "extracting substrings by key"
8674 .cindex "&%extract%&" "substrings by key"
8675 The key and <&'string1'&> are first expanded separately. Leading and trailing
8676 white space is removed from the key (but not from any of the strings). The key
8677 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8678 form:
8679 .display
8680 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8681 .endd
8682 .vindex "&$value$&"
8683 where the equals signs and spaces (but not both) are optional. If any of the
8684 values contain white space, they must be enclosed in double quotes, and any
8685 values that are enclosed in double quotes are subject to escape processing as
8686 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8687 for the value that corresponds to the key. The search is case-insensitive. If
8688 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8689 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8690 variable &$value$& contains the value that has been extracted. Afterwards, it
8691 is restored to any previous value it might have had.
8692
8693 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8694 key is not found. If {<&'string2'&>} is also omitted, the value that was
8695 extracted is used. Thus, for example, these two expansions are identical, and
8696 yield &"2001"&:
8697 .code
8698 ${extract{gid}{uid=1984 gid=2001}}
8699 ${extract{gid}{uid=1984 gid=2001}{$value}}
8700 .endd
8701 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8702 appear, for example:
8703 .code
8704 ${extract{Z}{A=... B=...}{$value} fail }
8705 .endd
8706 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8707 {<&'string2'&>} must be present for &"fail"& to be recognized.
8708
8709
8710 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8711         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8712 .cindex "expansion" "extracting substrings by number"
8713 .cindex "&%extract%&" "substrings by number"
8714 The <&'number'&> argument must consist entirely of decimal digits,
8715 apart from leading and trailing white space, which is ignored.
8716 This is what distinguishes this form of &%extract%& from the previous kind. It
8717 behaves in the same way, except that, instead of extracting a named field, it
8718 extracts from <&'string1'&> the field whose number is given as the first
8719 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8720 <&'string3'&> as before.
8721
8722 The fields in the string are separated by any one of the characters in the
8723 separator string. These may include space or tab characters.
8724 The first field is numbered one. If the number is negative, the fields are
8725 counted from the end of the string, with the rightmost one numbered -1. If the
8726 number given is zero, the entire string is returned. If the modulus of the
8727 number is greater than the number of fields in the string, the result is the
8728 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8729 provided. For example:
8730 .code
8731 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8732 .endd
8733 yields &"42"&, and
8734 .code
8735 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8736 .endd
8737 yields &"99"&. Two successive separators mean that the field between them is
8738 empty (for example, the fifth field above).
8739
8740
8741 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8742 .cindex "list" "selecting by condition"
8743 .cindex "expansion" "selecting from list by condition"
8744 .vindex "&$item$&"
8745 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8746 default, but the separator can be changed in the usual way. For each item
8747 in this list, its value is place in &$item$&, and then the condition is
8748 evaluated. If the condition is true, &$item$& is added to the output as an
8749 item in a new list; if the condition is false, the item is discarded. The
8750 separator used for the output list is the same as the one used for the
8751 input, but a separator setting is not included in the output. For example:
8752 .code
8753 ${filter{a:b:c}{!eq{$item}{b}}
8754 .endd
8755 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8756 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8757
8758
8759 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8760 .cindex "hash function" "textual"
8761 .cindex "expansion" "textual hash"
8762 This is a textual hashing function, and was the first to be implemented in
8763 early versions of Exim. In current releases, there are other hashing functions
8764 (numeric, MD5, and SHA-1), which are described below.
8765
8766 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
8767 <&'n'&>. If you are using fixed values for these numbers, that is, if
8768 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
8769 use the simpler operator notation that avoids some of the braces:
8770 .code
8771 ${hash_<n>_<m>:<string>}
8772 .endd
8773 The second number is optional (in both notations). If <&'n'&> is greater than
8774 or equal to the length of the string, the expansion item returns the string.
8775 Otherwise it computes a new string of length <&'n'&> by applying a hashing
8776 function to the string. The new string consists of characters taken from the
8777 first <&'m'&> characters of the string
8778 .code
8779 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
8780 .endd
8781 If <&'m'&> is not present the value 26 is used, so that only lower case
8782 letters appear. For example:
8783 .display
8784 &`$hash{3}{monty}}           `&   yields  &`jmg`&
8785 &`$hash{5}{monty}}           `&   yields  &`monty`&
8786 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
8787 .endd
8788
8789 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
8790         &*$h_*&<&'header&~name'&>&*:*&" &&&
8791        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8792         &*$bh_*&<&'header&~name'&>&*:*&" &&&
8793        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8794         &*$rh_*&<&'header&~name'&>&*:*&"
8795 .cindex "expansion" "header insertion"
8796 .vindex "&$header_$&"
8797 .vindex "&$bheader_$&"
8798 .vindex "&$rheader_$&"
8799 .cindex "header lines" "in expansion strings"
8800 .cindex "header lines" "character sets"
8801 .cindex "header lines" "decoding"
8802 Substitute the contents of the named message header line, for example
8803 .code
8804 $header_reply-to:
8805 .endd
8806 The newline that terminates a header line is not included in the expansion, but
8807 internal newlines (caused by splitting the header line over several physical
8808 lines) may be present.
8809
8810 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
8811 the data in the header line is interpreted.
8812
8813 .ilist
8814 .cindex "white space" "in header lines"
8815 &%rheader%& gives the original &"raw"& content of the header line, with no
8816 processing at all, and without the removal of leading and trailing white space.
8817
8818 .next
8819 .cindex "base64 encoding" "in header lines"
8820 &%bheader%& removes leading and trailing white space, and then decodes base64
8821 or quoted-printable MIME &"words"& within the header text, but does no
8822 character set translation. If decoding of what looks superficially like a MIME
8823 &"word"& fails, the raw string is returned. If decoding
8824 .cindex "binary zero" "in header line"
8825 produces a binary zero character, it is replaced by a question mark &-- this is
8826 what Exim does for binary zeros that are actually received in header lines.
8827
8828 .next
8829 &%header%& tries to translate the string as decoded by &%bheader%& to a
8830 standard character set. This is an attempt to produce the same string as would
8831 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
8832 returned. Translation is attempted only on operating systems that support the
8833 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
8834 a system Makefile or in &_Local/Makefile_&.
8835 .endlist ilist
8836
8837 In a filter file, the target character set for &%header%& can be specified by a
8838 command of the following form:
8839 .code
8840 headers charset "UTF-8"
8841 .endd
8842 This command affects all references to &$h_$& (or &$header_$&) expansions in
8843 subsequently obeyed filter commands. In the absence of this command, the target
8844 character set in a filter is taken from the setting of the &%headers_charset%&
8845 option in the runtime configuration. The value of this option defaults to the
8846 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
8847 ISO-8859-1.
8848
8849 Header names follow the syntax of RFC 2822, which states that they may contain
8850 any printing characters except space and colon. Consequently, curly brackets
8851 &'do not'& terminate header names, and should not be used to enclose them as
8852 if they were variables. Attempting to do so causes a syntax error.
8853
8854 Only header lines that are common to all copies of a message are visible to
8855 this mechanism. These are the original header lines that are received with the
8856 message, and any that are added by an ACL statement or by a system
8857 filter. Header lines that are added to a particular copy of a message by a
8858 router or transport are not accessible.
8859
8860 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
8861 before the DATA ACL, because the header structure is not set up until the
8862 message is received. Header lines that are added in a RCPT ACL (for example)
8863 are saved until the message's incoming header lines are available, at which
8864 point they are added. When a DATA ACL is running, however, header lines added
8865 by earlier ACLs are visible.
8866
8867 Upper case and lower case letters are synonymous in header names. If the
8868 following character is white space, the terminating colon may be omitted, but
8869 this is not recommended, because you may then forget it when it is needed. When
8870 white space terminates the header name, it is included in the expanded string.
8871 If the message does not contain the given header, the expansion item is
8872 replaced by an empty string. (See the &%def%& condition in section
8873 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
8874
8875 If there is more than one header with the same name, they are all concatenated
8876 to form the substitution string, up to a maximum length of 64K. Unless
8877 &%rheader%& is being used, leading and trailing white space is removed from
8878 each header before concatenation, and a completely empty header is ignored. A
8879 newline character is then inserted between non-empty headers, but there is no
8880 newline at the very end. For the &%header%& and &%bheader%& expansion, for
8881 those headers that contain lists of addresses, a comma is also inserted at the
8882 junctions between headers. This does not happen for the &%rheader%& expansion.
8883
8884
8885 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
8886 .cindex "expansion" "hmac hashing"
8887 .cindex &%hmac%&
8888 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
8889 shared secret and some text into a message authentication code, as specified in
8890 RFC 2104. This differs from &`${md5:secret_text...}`& or
8891 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
8892 cryptographic hash, allowing for authentication that is not possible with MD5
8893 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
8894 present. For example:
8895 .code
8896 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
8897 .endd
8898 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
8899 produces:
8900 .code
8901 dd97e3ba5d1a61b5006108f8c8252953
8902 .endd
8903 As an example of how this might be used, you might put in the main part of
8904 an Exim configuration:
8905 .code
8906 SPAMSCAN_SECRET=cohgheeLei2thahw
8907 .endd
8908 In a router or a transport you could then have:
8909 .code
8910 headers_add = \
8911   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
8912   ${hmac{md5}{SPAMSCAN_SECRET}\
8913   {${primary_hostname},${message_exim_id},$h_message-id:}}
8914 .endd
8915 Then given a message, you can check where it was scanned by looking at the
8916 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
8917 this header line is authentic by recomputing the authentication code from the
8918 host name, message ID and the &'Message-id:'& header line. This can be done
8919 using Exim's &%-be%& option, or by other means, for example by using the
8920 &'hmac_md5_hex()'& function in Perl.
8921
8922
8923 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8924 .cindex "expansion" "conditional"
8925 .cindex "&%if%&, expansion item"
8926 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
8927 item; otherwise <&'string2'&> is used. The available conditions are described
8928 in section &<<SECTexpcond>>& below. For example:
8929 .code
8930 ${if eq {$local_part}{postmaster} {yes}{no} }
8931 .endd
8932 The second string need not be present; if it is not and the condition is not
8933 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
8934 be present instead of the second string (without any curly brackets). In this
8935 case, the expansion is forced to fail if the condition is not true (see section
8936 &<<SECTforexpfai>>&).
8937
8938 If both strings are omitted, the result is the string &`true`& if the condition
8939 is true, and the empty string if the condition is false. This makes it less
8940 cumbersome to write custom ACL and router conditions. For example, instead of
8941 .code
8942 condition = ${if >{$acl_m4}{3}{true}{false}}
8943 .endd
8944 you can use
8945 .code
8946 condition = ${if >{$acl_m4}{3}}
8947 .endd
8948
8949 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8950 .cindex "expansion" "string truncation"
8951 .cindex "&%length%& expansion item"
8952 The &%length%& item is used to extract the initial portion of a string. Both
8953 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
8954 you are using a fixed value for the number, that is, if <&'string1'&> does not
8955 change when expanded, you can use the simpler operator notation that avoids
8956 some of the braces:
8957 .code
8958 ${length_<n>:<string>}
8959 .endd
8960 The result of this item is either the first <&'n'&> characters or the whole
8961 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
8962 &%strlen%&, which gives the length of a string.
8963
8964
8965 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
8966         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
8967 This is the first of one of two different types of lookup item, which are both
8968 described in the next item.
8969
8970 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
8971         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
8972 .cindex "expansion" "lookup in"
8973 .cindex "file" "lookups"
8974 .cindex "lookup" "in expanded string"
8975 The two forms of lookup item specify data lookups in files and databases, as
8976 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
8977 lookups, and the second is used for query-style lookups. The <&'key'&>,
8978 <&'file'&>, and <&'query'&> strings are expanded before use.
8979
8980 If there is any white space in a lookup item which is part of a filter command,
8981 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
8982 other place where white space is significant, the lookup item must be enclosed
8983 in double quotes. The use of data lookups in users' filter files may be locked
8984 out by the system administrator.
8985
8986 .vindex "&$value$&"
8987 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
8988 During its expansion, the variable &$value$& contains the data returned by the
8989 lookup. Afterwards it reverts to the value it had previously (at the outer
8990 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
8991 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
8992 string on failure. If <&'string2'&> is provided, it can itself be a nested
8993 lookup, thus providing a mechanism for looking up a default value when the
8994 original lookup fails.
8995
8996 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
8997 data for the outer lookup while the parameters of the second lookup are
8998 expanded, and also while <&'string2'&> of the second lookup is expanded, should
8999 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9000 appear, and in this case, if the lookup fails, the entire expansion is forced
9001 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9002 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9003 successful lookup, and nothing in the case of failure.
9004
9005 For single-key lookups, the string &"partial"& is permitted to precede the
9006 search type in order to do partial matching, and * or *@ may follow a search
9007 type to request default lookups if the key does not match (see sections
9008 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9009
9010 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9011 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9012 and non-wild parts of the key during the expansion of the replacement text.
9013 They return to their previous values at the end of the lookup item.
9014
9015 This example looks up the postmaster alias in the conventional alias file:
9016 .code
9017 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9018 .endd
9019 This example uses NIS+ to look up the full name of the user corresponding to
9020 the local part of an address, forcing the expansion to fail if it is not found:
9021 .code
9022 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9023   {$value}fail}
9024 .endd
9025
9026
9027 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9028 .cindex "expansion" "list creation"
9029 .vindex "&$item$&"
9030 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9031 default, but the separator can be changed in the usual way. For each item
9032 in this list, its value is place in &$item$&, and then <&'string2'&> is
9033 expanded and added to the output as an item in a new list. The separator used
9034 for the output list is the same as the one used for the input, but a separator
9035 setting is not included in the output. For example:
9036 .code
9037 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9038 .endd
9039 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9040 value of &$item$& is restored to what it was before. See also the &*filter*&
9041 and &*reduce*& expansion items.
9042
9043 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9044 .cindex "expansion" "numeric hash"
9045 .cindex "hash function" "numeric"
9046 The three strings are expanded; the first two must yield numbers. Call them
9047 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9048 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9049 can use the simpler operator notation that avoids some of the braces:
9050 .code
9051 ${nhash_<n>_<m>:<string>}
9052 .endd
9053 The second number is optional (in both notations). If there is only one number,
9054 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9055 processed by a div/mod hash function that returns two numbers, separated by a
9056 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9057 example,
9058 .code
9059 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9060 .endd
9061 returns the string &"6/33"&.
9062
9063
9064
9065 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9066 .cindex "Perl" "use in expanded string"
9067 .cindex "expansion" "calling Perl from"
9068 This item is available only if Exim has been built to include an embedded Perl
9069 interpreter. The subroutine name and the arguments are first separately
9070 expanded, and then the Perl subroutine is called with those arguments. No
9071 additional arguments need be given; the maximum number permitted, including the
9072 name of the subroutine, is nine.
9073
9074 The return value of the subroutine is inserted into the expanded string, unless
9075 the return value is &%undef%&. In that case, the expansion fails in the same
9076 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9077 Whatever you return is evaluated in a scalar context. For example, if you
9078 return the name of a Perl vector, the return value is the size of the vector,
9079 not its contents.
9080
9081 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9082 with the error message that was passed to &%die%&. More details of the embedded
9083 Perl facility are given in chapter &<<CHAPperl>>&.
9084
9085 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9086 out the use of this expansion item in filter files.
9087
9088
9089 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9090 .cindex "&%prvs%& expansion item"
9091 The first argument is a complete email address and the second is secret
9092 keystring. The third argument, specifying a key number, is optional. If absent,
9093 it defaults to 0. The result of the expansion is a prvs-signed email address,
9094 to be typically used with the &%return_path%& option on an &(smtp)& transport
9095 as part of a bounce address tag validation (BATV) scheme. For more discussion
9096 and an example, see section &<<SECTverifyPRVS>>&.
9097
9098 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9099         {*&<&'string'&>&*}}*&"
9100 .cindex "&%prvscheck%& expansion item"
9101 This expansion item is the complement of the &%prvs%& item. It is used for
9102 checking prvs-signed addresses. If the expansion of the first argument does not
9103 yield a syntactically valid prvs-signed address, the whole item expands to the
9104 empty string. When the first argument does expand to a syntactically valid
9105 prvs-signed address, the second argument is expanded, with the prvs-decoded
9106 version of the address and the key number extracted from the address in the
9107 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9108
9109 These two variables can be used in the expansion of the second argument to
9110 retrieve the secret. The validity of the prvs-signed address is then checked
9111 against the secret. The result is stored in the variable &$prvscheck_result$&,
9112 which is empty for failure or &"1"& for success.
9113
9114 The third argument is optional; if it is missing, it defaults to an empty
9115 string. This argument is now expanded. If the result is an empty string, the
9116 result of the expansion is the decoded version of the address. This is the case
9117 whether or not the signature was valid. Otherwise, the result of the expansion
9118 is the expansion of the third argument.
9119
9120 All three variables can be used in the expansion of the third argument.
9121 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9122 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9123
9124 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9125 .cindex "expansion" "inserting an entire file"
9126 .cindex "file" "inserting into expansion"
9127 .cindex "&%readfile%& expansion item"
9128 The file name and end-of-line string are first expanded separately. The file is
9129 then read, and its contents replace the entire item. All newline characters in
9130 the file are replaced by the end-of-line string if it is present. Otherwise,
9131 newlines are left in the string.
9132 String expansion is not applied to the contents of the file. If you want this,
9133 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9134 the string expansion fails.
9135
9136 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9137 locks out the use of this expansion item in filter files.
9138
9139
9140
9141 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9142         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9143 .cindex "expansion" "inserting from a socket"
9144 .cindex "socket, use of in expansion"
9145 .cindex "&%readsocket%& expansion item"
9146 This item inserts data from a Unix domain or Internet socket into the expanded
9147 string. The minimal way of using it uses just two arguments, as in these
9148 examples:
9149 .code
9150 ${readsocket{/socket/name}{request string}}
9151 ${readsocket{inet:some.host:1234}{request string}}
9152 .endd
9153 For a Unix domain socket, the first substring must be the path to the socket.
9154 For an Internet socket, the first substring must contain &`inet:`& followed by
9155 a host name or IP address, followed by a colon and a port, which can be a
9156 number or the name of a TCP port in &_/etc/services_&. An IP address may
9157 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9158 example:
9159 .code
9160 ${readsocket{inet:[::1]:1234}{request string}}
9161 .endd
9162 Only a single host name may be given, but if looking it up yields more than
9163 one IP address, they are each tried in turn until a connection is made. For
9164 both kinds of socket, Exim makes a connection, writes the request string
9165 (unless it is an empty string) and reads from the socket until an end-of-file
9166 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9167 extend what can be done. Firstly, you can vary the timeout. For example:
9168 .code
9169 ${readsocket{/socket/name}{request string}{3s}}
9170 .endd
9171 A fourth argument allows you to change any newlines that are in the data
9172 that is read, in the same way as for &%readfile%& (see above). This example
9173 turns them into spaces:
9174 .code
9175 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9176 .endd
9177 As with all expansions, the substrings are expanded before the processing
9178 happens. Errors in these sub-expansions cause the expansion to fail. In
9179 addition, the following errors can occur:
9180
9181 .ilist
9182 Failure to create a socket file descriptor;
9183 .next
9184 Failure to connect the socket;
9185 .next
9186 Failure to write the request string;
9187 .next
9188 Timeout on reading from the socket.
9189 .endlist
9190
9191 By default, any of these errors causes the expansion to fail. However, if
9192 you supply a fifth substring, it is expanded and used when any of the above
9193 errors occurs. For example:
9194 .code
9195 ${readsocket{/socket/name}{request string}{3s}{\n}\
9196   {socket failure}}
9197 .endd
9198 You can test for the existence of a Unix domain socket by wrapping this
9199 expansion in &`${if exists`&, but there is a race condition between that test
9200 and the actual opening of the socket, so it is safer to use the fifth argument
9201 if you want to be absolutely sure of avoiding an expansion error for a
9202 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9203
9204 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9205 locks out the use of this expansion item in filter files.
9206
9207
9208 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9209 .cindex "expansion" "reducing a list to a scalar"
9210 .cindex "list" "reducing to a scalar"
9211 .vindex "&$value$&"
9212 .vindex "&$item$&"
9213 This operation reduces a list to a single, scalar string. After expansion,
9214 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9215 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9216 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9217 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9218 them. The result of that expansion is assigned to &$value$& before the next
9219 iteration. When the end of the list is reached, the final value of &$value$& is
9220 added to the expansion output. The &*reduce*& expansion item can be used in a
9221 number of ways. For example, to add up a list of numbers:
9222 .code
9223 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9224 .endd
9225 The result of that expansion would be &`6`&. The maximum of a list of numbers
9226 can be found:
9227 .code
9228 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9229 .endd
9230 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9231 restored to what they were before. See also the &*filter*& and &*map*&
9232 expansion items.
9233
9234 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9235 This item inserts &"raw"& header lines. It is described with the &%header%&
9236 expansion item above.
9237
9238 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9239         {*&<&'string2'&>&*}}*&"
9240 .cindex "expansion" "running a command"
9241 .cindex "&%run%& expansion item"
9242 The command and its arguments are first expanded separately, and then the
9243 command is run in a separate process, but under the same uid and gid. As in
9244 other command executions from Exim, a shell is not used by default. If you want
9245 a shell, you must explicitly code it.
9246
9247 The standard input for the command exists, but is empty. The standard output
9248 and standard error are set to the same file descriptor.
9249 .cindex "return code" "from &%run%& expansion"
9250 .vindex "&$value$&"
9251 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9252 and replaces the entire item; during this expansion, the standard output/error
9253 from the command is in the variable &$value$&. If the command fails,
9254 <&'string2'&>, if present, is expanded and used. Once again, during the
9255 expansion, the standard output/error from the command is in the variable
9256 &$value$&.
9257
9258 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9259 can be the word &"fail"& (not in braces) to force expansion failure if the
9260 command does not succeed. If both strings are omitted, the result is contents
9261 of the standard output/error on success, and nothing on failure.
9262
9263 .vindex "&$runrc$&"
9264 The return code from the command is put in the variable &$runrc$&, and this
9265 remains set afterwards, so in a filter file you can do things like this:
9266 .code
9267 if "${run{x y z}{}}$runrc" is 1 then ...
9268   elif $runrc is 2 then ...
9269   ...
9270 endif
9271 .endd
9272 If execution of the command fails (for example, the command does not exist),
9273 the return code is 127 &-- the same code that shells use for non-existent
9274 commands.
9275
9276 &*Warning*&: In a router or transport, you cannot assume the order in which
9277 option values are expanded, except for those preconditions whose order of
9278 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9279 by the expansion of one option, and use it in another.
9280
9281 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9282 out the use of this expansion item in filter files.
9283
9284
9285 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9286 .cindex "expansion" "string substitution"
9287 .cindex "&%sg%& expansion item"
9288 This item works like Perl's substitution operator (s) with the global (/g)
9289 option; hence its name. However, unlike the Perl equivalent, Exim does not
9290 modify the subject string; instead it returns the modified string for insertion
9291 into the overall expansion. The item takes three arguments: the subject string,
9292 a regular expression, and a substitution string. For example:
9293 .code
9294 ${sg{abcdefabcdef}{abc}{xyz}}
9295 .endd
9296 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9297 if any $ or \ characters are required in the regular expression or in the
9298 substitution string, they have to be escaped. For example:
9299 .code
9300 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9301 .endd
9302 yields &"defabc"&, and
9303 .code
9304 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9305 .endd
9306 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9307 the regular expression from string expansion.
9308
9309
9310
9311 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9312 .cindex "&%substr%& expansion item"
9313 .cindex "substring extraction"
9314 .cindex "expansion" "substring extraction"
9315 The three strings are expanded; the first two must yield numbers. Call them
9316 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9317 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9318 can use the simpler operator notation that avoids some of the braces:
9319 .code
9320 ${substr_<n>_<m>:<string>}
9321 .endd
9322 The second number is optional (in both notations).
9323 If it is absent in the simpler format, the preceding underscore must also be
9324 omitted.
9325
9326 The &%substr%& item can be used to extract more general substrings than
9327 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9328 length required. For example
9329 .code
9330 ${substr{3}{2}{$local_part}}
9331 .endd
9332 If the starting offset is greater than the string length the result is the
9333 null string; if the length plus starting offset is greater than the string
9334 length, the result is the right-hand part of the string, starting from the
9335 given offset. The first character in the string has offset zero.
9336
9337 The &%substr%& expansion item can take negative offset values to count
9338 from the right-hand end of its operand. The last character is offset -1, the
9339 second-last is offset -2, and so on. Thus, for example,
9340 .code
9341 ${substr{-5}{2}{1234567}}
9342 .endd
9343 yields &"34"&. If the absolute value of a negative offset is greater than the
9344 length of the string, the substring starts at the beginning of the string, and
9345 the length is reduced by the amount of overshoot. Thus, for example,
9346 .code
9347 ${substr{-5}{2}{12}}
9348 .endd
9349 yields an empty string, but
9350 .code
9351 ${substr{-3}{2}{12}}
9352 .endd
9353 yields &"1"&.
9354
9355 When the second number is omitted from &%substr%&, the remainder of the string
9356 is taken if the offset is positive. If it is negative, all characters in the
9357 string preceding the offset point are taken. For example, an offset of -1 and
9358 no length, as in these semantically identical examples:
9359 .code
9360 ${substr_-1:abcde}
9361 ${substr{-1}{abcde}}
9362 .endd
9363 yields all but the last character of the string, that is, &"abcd"&.
9364
9365
9366
9367 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9368         {*&<&'replacements'&>&*}}*&"
9369 .cindex "expansion" "character translation"
9370 .cindex "&%tr%& expansion item"
9371 This item does single-character translation on its subject string. The second
9372 argument is a list of characters to be translated in the subject string. Each
9373 matching character is replaced by the corresponding character from the
9374 replacement list. For example
9375 .code
9376 ${tr{abcdea}{ac}{13}}
9377 .endd
9378 yields &`1b3de1`&. If there are duplicates in the second character string, the
9379 last occurrence is used. If the third string is shorter than the second, its
9380 last character is replicated. However, if it is empty, no translation takes
9381 place.
9382 .endlist
9383
9384
9385
9386 .section "Expansion operators" "SECTexpop"
9387 .cindex "expansion" "operators"
9388 For expansion items that perform transformations on a single argument string,
9389 the &"operator"& notation is used because it is simpler and uses fewer braces.
9390 The substring is first expanded before the operation is applied to it. The
9391 following operations can be performed:
9392
9393 .vlist
9394 .vitem &*${address:*&<&'string'&>&*}*&
9395 .cindex "expansion" "RFC 2822 address handling"
9396 .cindex "&%address%& expansion item"
9397 The string is interpreted as an RFC 2822 address, as it might appear in a
9398 header line, and the effective address is extracted from it. If the string does
9399 not parse successfully, the result is empty.
9400
9401
9402 .vitem &*${addresses:*&<&'string'&>&*}*&
9403 .cindex "expansion" "RFC 2822 address handling"
9404 .cindex "&%addresses%& expansion item"
9405 The string (after expansion) is interpreted as a list of addresses in RFC
9406 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9407 operative address (&'local-part@domain'&) is extracted from each item, and the
9408 result of the expansion is a colon-separated list, with appropriate
9409 doubling of colons should any happen to be present in the email addresses.
9410 Syntactically invalid RFC2822 address items are omitted from the output.
9411
9412 It is possible to specify a character other than colon for the output
9413 separator by starting the string with > followed by the new separator
9414 character. For example:
9415 .code
9416 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9417 .endd
9418 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9419 expansion item, which extracts the working address from a single RFC2822
9420 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9421 processing lists.
9422
9423
9424 .vitem &*${base62:*&<&'digits'&>&*}*&
9425 .cindex "&%base62%& expansion item"
9426 .cindex "expansion" "conversion to base 62"
9427 The string must consist entirely of decimal digits. The number is converted to
9428 base 62 and output as a string of six characters, including leading zeros. In
9429 the few operating environments where Exim uses base 36 instead of base 62 for
9430 its message identifiers (because those systems do not have case-sensitive file
9431 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9432 be absolutely clear: this is &'not'& base64 encoding.
9433
9434 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9435 .cindex "&%base62d%& expansion item"
9436 .cindex "expansion" "conversion to base 62"
9437 The string must consist entirely of base-62 digits, or, in operating
9438 environments where Exim uses base 36 instead of base 62 for its message
9439 identifiers, base-36 digits. The number is converted to decimal and output as a
9440 string.
9441
9442 .vitem &*${domain:*&<&'string'&>&*}*&
9443 .cindex "domain" "extraction"
9444 .cindex "expansion" "domain extraction"
9445 The string is interpreted as an RFC 2822 address and the domain is extracted
9446 from it. If the string does not parse successfully, the result is empty.
9447
9448
9449 .vitem &*${escape:*&<&'string'&>&*}*&
9450 .cindex "expansion" "escaping non-printing characters"
9451 .cindex "&%escape%& expansion item"
9452 If the string contains any non-printing characters, they are converted to
9453 escape sequences starting with a backslash. Whether characters with the most
9454 significant bit set (so-called &"8-bit characters"&) count as printing or not
9455 is controlled by the &%print_topbitchars%& option.
9456
9457
9458 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9459 .cindex "expansion" "expression evaluation"
9460 .cindex "expansion" "arithmetic expression"
9461 .cindex "&%eval%& expansion item"
9462 These items supports simple arithmetic and bitwise logical operations in
9463 expansion strings. The string (after expansion) must be a conventional
9464 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9465 logical operators, and parentheses. All operations are carried out using
9466 integer arithmetic. The operator priorities are as follows (the same as in the
9467 C programming language):
9468 .table2 70pt 300pt
9469 .irow &'highest:'& "not (~), negate (-)"
9470 .irow ""   "multiply (*), divide (/), remainder (%)"
9471 .irow ""   "plus (+), minus (-)"
9472 .irow ""   "shift-left (<<), shift-right (>>)"
9473 .irow ""   "and (&&)"
9474 .irow ""   "xor (^)"
9475 .irow &'lowest:'&  "or (|)"
9476 .endtable
9477 Binary operators with the same priority are evaluated from left to right. White
9478 space is permitted before or after operators.
9479
9480 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9481 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9482 decimal, even if they start with a leading zero; hexadecimal numbers are not
9483 permitted. This can be useful when processing numbers extracted from dates or
9484 times, which often do have leading zeros.
9485
9486 A number may be followed by &"K"& or &"M"& to multiply it by 1024 or 1024*1024,
9487 respectively. Negative numbers are supported. The result of the computation is
9488 a decimal representation of the answer (without &"K"& or &"M"&). For example:
9489
9490 .display
9491 &`${eval:1+1}            `&  yields 2
9492 &`${eval:1+2*3}          `&  yields 7
9493 &`${eval:(1+2)*3}        `&  yields 9
9494 &`${eval:2+42%5}         `&  yields 4
9495 &`${eval:0xc&amp;5}          `&  yields 4
9496 &`${eval:0xc|5}          `&  yields 13
9497 &`${eval:0xc^5}          `&  yields 9
9498 &`${eval:0xc>>1}         `&  yields 6
9499 &`${eval:0xc<<1}         `&  yields 24
9500 &`${eval:~255&amp;0x1234}    `&  yields 4608
9501 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9502 .endd
9503
9504 As a more realistic example, in an ACL you might have
9505 .code
9506 deny   message = Too many bad recipients
9507        condition =                    \
9508          ${if and {                   \
9509            {>{$rcpt_count}{10}}       \
9510            {                          \
9511            <                          \
9512              {$recipients_count}      \
9513              {${eval:$rcpt_count/2}}  \
9514            }                          \
9515          }{yes}{no}}
9516 .endd
9517 The condition is true if there have been more than 10 RCPT commands and
9518 fewer than half of them have resulted in a valid recipient.
9519
9520
9521 .vitem &*${expand:*&<&'string'&>&*}*&
9522 .cindex "expansion" "re-expansion of substring"
9523 The &%expand%& operator causes a string to be expanded for a second time. For
9524 example,
9525 .code
9526 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9527 .endd
9528 first looks up a string in a file while expanding the operand for &%expand%&,
9529 and then re-expands what it has found.
9530
9531
9532 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9533 .cindex "Unicode"
9534 .cindex "UTF-8" "conversion from"
9535 .cindex "expansion" "UTF-8 conversion"
9536 .cindex "&%from_utf8%& expansion item"
9537 The world is slowly moving towards Unicode, although there are no standards for
9538 email yet. However, other applications (including some databases) are starting
9539 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9540 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9541 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9542 the result is an undefined sequence of bytes.
9543
9544 Unicode code points with values less than 256 are compatible with ASCII and
9545 ISO-8859-1 (also known as Latin-1).
9546 For example, character 169 is the copyright symbol in both cases, though the
9547 way it is encoded is different. In UTF-8, more than one byte is needed for
9548 characters with code values greater than 127, whereas ISO-8859-1 is a
9549 single-byte encoding (but thereby limited to 256 characters). This makes
9550 translation from UTF-8 to ISO-8859-1 straightforward.
9551
9552
9553 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9554 .cindex "hash function" "textual"
9555 .cindex "expansion" "textual hash"
9556 The &%hash%& operator is a simpler interface to the hashing function that can
9557 be used when the two parameters are fixed numbers (as opposed to strings that
9558 change when expanded). The effect is the same as
9559 .code
9560 ${hash{<n>}{<m>}{<string>}}
9561 .endd
9562 See the description of the general &%hash%& item above for details. The
9563 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9564
9565
9566
9567 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9568 .cindex "base64 encoding" "conversion from hex"
9569 .cindex "expansion" "hex to base64"
9570 .cindex "&%hex2b64%& expansion item"
9571 This operator converts a hex string into one that is base64 encoded. This can
9572 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9573
9574
9575 .vitem &*${lc:*&<&'string'&>&*}*&
9576 .cindex "case forcing in strings"
9577 .cindex "string" "case forcing"
9578 .cindex "lower casing"
9579 .cindex "expansion" "case forcing"
9580 .cindex "&%lc%& expansion item"
9581 This forces the letters in the string into lower-case, for example:
9582 .code
9583 ${lc:$local_part}
9584 .endd
9585
9586 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9587 .cindex "expansion" "string truncation"
9588 .cindex "&%length%& expansion item"
9589 The &%length%& operator is a simpler interface to the &%length%& function that
9590 can be used when the parameter is a fixed number (as opposed to a string that
9591 changes when expanded). The effect is the same as
9592 .code
9593 ${length{<number>}{<string>}}
9594 .endd
9595 See the description of the general &%length%& item above for details. Note that
9596 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9597 when &%length%& is used as an operator.
9598
9599
9600 .vitem &*${local_part:*&<&'string'&>&*}*&
9601 .cindex "expansion" "local part extraction"
9602 .cindex "&%local_part%& expansion item"
9603 The string is interpreted as an RFC 2822 address and the local part is
9604 extracted from it. If the string does not parse successfully, the result is
9605 empty.
9606
9607
9608 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9609 .cindex "masked IP address"
9610 .cindex "IP address" "masking"
9611 .cindex "CIDR notation"
9612 .cindex "expansion" "IP address masking"
9613 .cindex "&%mask%& expansion item"
9614 If the form of the string to be operated on is not an IP address followed by a
9615 slash and an integer (that is, a network address in CIDR notation), the
9616 expansion fails. Otherwise, this operator converts the IP address to binary,
9617 masks off the least significant bits according to the bit count, and converts
9618 the result back to text, with mask appended. For example,
9619 .code
9620 ${mask:10.111.131.206/28}
9621 .endd
9622 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9623 be mostly used for looking up masked addresses in files, the result for an IPv6
9624 address uses dots to separate components instead of colons, because colon
9625 terminates a key string in lsearch files. So, for example,
9626 .code
9627 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9628 .endd
9629 returns the string
9630 .code
9631 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9632 .endd
9633 Letters in IPv6 addresses are always output in lower case.
9634
9635
9636 .vitem &*${md5:*&<&'string'&>&*}*&
9637 .cindex "MD5 hash"
9638 .cindex "expansion" "MD5 hash"
9639 .cindex "&%md5%& expansion item"
9640 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9641 as a 32-digit hexadecimal number, in which any letters are in lower case.
9642
9643
9644 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9645 .cindex "expansion" "numeric hash"
9646 .cindex "hash function" "numeric"
9647 The &%nhash%& operator is a simpler interface to the numeric hashing function
9648 that can be used when the two parameters are fixed numbers (as opposed to
9649 strings that change when expanded). The effect is the same as
9650 .code
9651 ${nhash{<n>}{<m>}{<string>}}
9652 .endd
9653 See the description of the general &%nhash%& item above for details.
9654
9655
9656 .vitem &*${quote:*&<&'string'&>&*}*&
9657 .cindex "quoting" "in string expansions"
9658 .cindex "expansion" "quoting"
9659 .cindex "&%quote%& expansion item"
9660 The &%quote%& operator puts its argument into double quotes if it
9661 is an empty string or
9662 contains anything other than letters, digits, underscores, dots, and hyphens.
9663 Any occurrences of double quotes and backslashes are escaped with a backslash.
9664 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9665 respectively For example,
9666 .code
9667 ${quote:ab"*"cd}
9668 .endd
9669 becomes
9670 .code
9671 "ab\"*\"cd"
9672 .endd
9673 The place where this is useful is when the argument is a substitution from a
9674 variable or a message header.
9675
9676 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9677 .cindex "&%quote_local_part%& expansion item"
9678 This operator is like &%quote%&, except that it quotes the string only if
9679 required to do so by the rules of RFC 2822 for quoting local parts. For
9680 example, a plus sign would not cause quoting (but it would for &%quote%&).
9681 If you are creating a new email address from the contents of &$local_part$&
9682 (or any other unknown data), you should always use this operator.
9683
9684
9685 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9686 .cindex "quoting" "lookup-specific"
9687 This operator applies lookup-specific quoting rules to the string. Each
9688 query-style lookup type has its own quoting rules which are described with
9689 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9690 .code
9691 ${quote_ldap:two * two}
9692 .endd
9693 returns
9694 .code
9695 two%20%5C2A%20two
9696 .endd
9697 For single-key lookup types, no quoting is ever necessary and this operator
9698 yields an unchanged string.
9699
9700
9701 .vitem &*${randint:*&<&'n'&>&*}*&
9702 .cindex "random number"
9703 This operator returns a somewhat random number which is less than the
9704 supplied number and is at least 0.  The quality of this randomness depends
9705 on how Exim was built; the values are not suitable for keying material.
9706 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
9707 Otherwise, the implementation may be arc4random(), random() seeded by
9708 srandomdev() or srandom(), or a custom implementation even weaker than
9709 random().
9710
9711
9712 .new
9713 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
9714 .cindex "expansion" "IP address"
9715 This operator reverses an IP address; for IPv4 addresses, the result is in
9716 dotted-quad decimal form, while for IPv6 addreses the result is in
9717 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
9718 for DNS.  For example,
9719 .code
9720 ${reverse_ip:192.0.2.4} and ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.3}
9721 .endd
9722 returns
9723 .code
9724 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
9725 .endd
9726 .wen
9727
9728
9729 .vitem &*${rfc2047:*&<&'string'&>&*}*&
9730 .cindex "expansion" "RFC 2047"
9731 .cindex "RFC 2047" "expansion operator"
9732 .cindex "&%rfc2047%& expansion item"
9733 This operator encodes text according to the rules of RFC 2047. This is an
9734 encoding that is used in header lines to encode non-ASCII characters. It is
9735 assumed that the input string is in the encoding specified by the
9736 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
9737 contains only characters in the range 33&--126, and no instances of the
9738 characters
9739 .code
9740 ? = ( ) < > @ , ; : \ " . [ ] _
9741 .endd
9742 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
9743 string, using as many &"encoded words"& as necessary to encode all the
9744 characters.
9745
9746
9747 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
9748 .cindex "expansion" "RFC 2047"
9749 .cindex "RFC 2047" "decoding"
9750 .cindex "&%rfc2047d%& expansion item"
9751 This operator decodes strings that are encoded as per RFC 2047. Binary zero
9752 bytes are replaced by question marks. Characters are converted into the
9753 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
9754 not recognized unless &%check_rfc2047_length%& is set false.
9755
9756 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
9757 access a header line, RFC 2047 decoding is done automatically. You do not need
9758 to use this operator as well.
9759
9760
9761
9762 .vitem &*${rxquote:*&<&'string'&>&*}*&
9763 .cindex "quoting" "in regular expressions"
9764 .cindex "regular expressions" "quoting"
9765 .cindex "&%rxquote%& expansion item"
9766 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
9767 characters in its argument. This is useful when substituting the values of
9768 variables or headers inside regular expressions.
9769
9770
9771 .vitem &*${sha1:*&<&'string'&>&*}*&
9772 .cindex "SHA-1 hash"
9773 .cindex "expansion" "SHA-1 hashing"
9774 .cindex "&%sha2%& expansion item"
9775 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
9776 it as a 40-digit hexadecimal number, in which any letters are in upper case.
9777
9778
9779 .vitem &*${stat:*&<&'string'&>&*}*&
9780 .cindex "expansion" "statting a file"
9781 .cindex "file" "extracting characteristics"
9782 .cindex "&%stat%& expansion item"
9783 The string, after expansion, must be a file path. A call to the &[stat()]&
9784 function is made for this path. If &[stat()]& fails, an error occurs and the
9785 expansion fails. If it succeeds, the data from the stat replaces the item, as a
9786 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
9787 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
9788 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
9789 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
9790 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
9791 can extract individual fields using the &%extract%& expansion item.
9792
9793 The use of the &%stat%& expansion in users' filter files can be locked out by
9794 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
9795 systems for files larger than 2GB.
9796
9797 .vitem &*${str2b64:*&<&'string'&>&*}*&
9798 .cindex "expansion" "base64 encoding"
9799 .cindex "base64 encoding" "in string expansion"
9800 .cindex "&%str2b64%& expansion item"
9801 This operator converts a string into one that is base64 encoded.
9802
9803
9804
9805 .vitem &*${strlen:*&<&'string'&>&*}*&
9806 .cindex "expansion" "string length"
9807 .cindex "string" "length in expansion"
9808 .cindex "&%strlen%& expansion item"
9809 The item is replace by the length of the expanded string, expressed as a
9810 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
9811
9812
9813 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
9814 .cindex "&%substr%& expansion item"
9815 .cindex "substring extraction"
9816 .cindex "expansion" "substring expansion"
9817 The &%substr%& operator is a simpler interface to the &%substr%& function that
9818 can be used when the two parameters are fixed numbers (as opposed to strings
9819 that change when expanded). The effect is the same as
9820 .code
9821 ${substr{<start>}{<length>}{<string>}}
9822 .endd
9823 See the description of the general &%substr%& item above for details. The
9824 abbreviation &%s%& can be used when &%substr%& is used as an operator.
9825
9826 .vitem &*${time_eval:*&<&'string'&>&*}*&
9827 .cindex "&%time_eval%& expansion item"
9828 .cindex "time interval" "decoding"
9829 This item converts an Exim time interval such as &`2d4h5m`& into a number of
9830 seconds.
9831
9832 .vitem &*${time_interval:*&<&'string'&>&*}*&
9833 .cindex "&%time_interval%& expansion item"
9834 .cindex "time interval" "formatting"
9835 The argument (after sub-expansion) must be a sequence of decimal digits that
9836 represents an interval of time as a number of seconds. It is converted into a
9837 number of larger units and output in Exim's normal time format, for example,
9838 &`1w3d4h2m6s`&.
9839
9840 .vitem &*${uc:*&<&'string'&>&*}*&
9841 .cindex "case forcing in strings"
9842 .cindex "string" "case forcing"
9843 .cindex "upper casing"
9844 .cindex "expansion" "case forcing"
9845 .cindex "&%uc%& expansion item"
9846 This forces the letters in the string into upper-case.
9847 .endlist
9848
9849
9850
9851
9852
9853
9854 .section "Expansion conditions" "SECTexpcond"
9855 .scindex IIDexpcond "expansion" "conditions"
9856 The following conditions are available for testing by the &%${if%& construct
9857 while expanding strings:
9858
9859 .vlist
9860 .vitem &*!*&<&'condition'&>
9861 .cindex "expansion" "negating a condition"
9862 .cindex "negation" "in expansion condition"
9863 Preceding any condition with an exclamation mark negates the result of the
9864 condition.
9865
9866 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9867 .cindex "numeric comparison"
9868 .cindex "expansion" "numeric comparison"
9869 There are a number of symbolic operators for doing numeric comparisons. They
9870 are:
9871 .display
9872 &`=   `&   equal
9873 &`==  `&   equal
9874 &`>   `&   greater
9875 &`>=  `&   greater or equal
9876 &`<   `&   less
9877 &`<=  `&   less or equal
9878 .endd
9879 For example:
9880 .code
9881 ${if >{$message_size}{10M} ...
9882 .endd
9883 Note that the general negation operator provides for inequality testing. The
9884 two strings must take the form of optionally signed decimal integers,
9885 optionally followed by one of the letters &"K"& or &"M"& (in either upper or
9886 lower case), signifying multiplication by 1024 or 1024*1024, respectively.
9887 As a special case, the numerical value of an empty string is taken as
9888 zero.
9889
9890
9891 .new
9892 .vitem &*bool&~{*&<&'string'&>&*}*&
9893 .cindex "expansion" "boolean parsing"
9894 .cindex "&%bool%& expansion condition"
9895 This condition turns a string holding a true or false representation into
9896 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
9897 (case-insensitively); also positive integer numbers map to true if non-zero,
9898 false if zero.  Leading and trailing whitespace is ignored.
9899 All other string values will result in expansion failure.
9900
9901 When combined with ACL variables, this expansion condition will let you
9902 make decisions in one place and act on those decisions in another place.
9903 For example:
9904 .code
9905 ${if bool{$acl_m_privileged_sender} ...
9906 .endd
9907 .wen
9908
9909
9910 .new
9911 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
9912 .cindex "expansion" "boolean parsing"
9913 .cindex "&%bool_lax%& expansion condition"
9914 Like &%bool%&, this condition turns a string into a boolean state.  But
9915 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
9916 loose definition that the Router &%condition%& option uses.  The empty string
9917 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
9918 true.  Leading and trailing whitespace is ignored.
9919
9920 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
9921 .wen
9922 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9923 .cindex "expansion" "encrypted comparison"
9924 .cindex "encrypted strings, comparing"
9925 .cindex "&%crypteq%& expansion condition"
9926 This condition is included in the Exim binary if it is built to support any
9927 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
9928 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
9929 included in the binary.
9930
9931 The &%crypteq%& condition has two arguments. The first is encrypted and
9932 compared against the second, which is already encrypted. The second string may
9933 be in the LDAP form for storing encrypted strings, which starts with the
9934 encryption type in curly brackets, followed by the data. If the second string
9935 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
9936 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
9937 Typically this will be a field from a password file. An example of an encrypted
9938 string in LDAP form is:
9939 .code
9940 {md5}CY9rzUYh03PK3k6DJie09g==
9941 .endd
9942 If such a string appears directly in an expansion, the curly brackets have to
9943 be quoted, because they are part of the expansion syntax. For example:
9944 .code
9945 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
9946 .endd
9947 The following encryption types (whose names are matched case-independently) are
9948 supported:
9949
9950 .ilist
9951 .cindex "MD5 hash"
9952 .cindex "base64 encoding" "in encrypted password"
9953 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
9954 printable characters to compare with the remainder of the second string. If the
9955 length of the comparison string is 24, Exim assumes that it is base64 encoded
9956 (as in the above example). If the length is 32, Exim assumes that it is a
9957 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
9958 comparison fails.
9959
9960 .next
9961 .cindex "SHA-1 hash"
9962 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
9963 printable characters to compare with the remainder of the second string. If the
9964 length of the comparison string is 28, Exim assumes that it is base64 encoded.
9965 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
9966 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
9967
9968 .next
9969 .cindex "&[crypt()]&"
9970 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
9971 only the first eight characters of the password. However, in modern operating
9972 systems this is no longer true, and in many cases the entire password is used,
9973 whatever its length.
9974
9975 .next
9976 .cindex "&[crypt16()]&"
9977 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
9978 use up to 16 characters of the password in some operating systems. Again, in
9979 modern operating systems, more characters may be used.
9980 .endlist
9981 Exim has its own version of &[crypt16()]&, which is just a double call to
9982 &[crypt()]&. For operating systems that have their own version, setting
9983 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
9984 operating system version instead of its own. This option is set by default in
9985 the OS-dependent &_Makefile_& for those operating systems that are known to
9986 support &[crypt16()]&.
9987
9988 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
9989 it was not using the same algorithm as some operating systems' versions. It
9990 turns out that as well as &[crypt16()]& there is a function called
9991 &[bigcrypt()]& in some operating systems. This may or may not use the same
9992 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
9993
9994 However, since there is now a move away from the traditional &[crypt()]&
9995 functions towards using SHA1 and other algorithms, tidying up this area of
9996 Exim is seen as very low priority.
9997
9998 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
9999 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10000 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10001 default is &`{crypt}`&. Whatever the default, you can always use either
10002 function by specifying it explicitly in curly brackets.
10003
10004 .vitem &*def:*&<&'variable&~name'&>
10005 .cindex "expansion" "checking for empty variable"
10006 .cindex "&%def%& expansion condition"
10007 The &%def%& condition must be followed by the name of one of the expansion
10008 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10009 variable does not contain the empty string. For example:
10010 .code
10011 ${if def:sender_ident {from $sender_ident}}
10012 .endd
10013 Note that the variable name is given without a leading &%$%& character. If the
10014 variable does not exist, the expansion fails.
10015
10016 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10017         &~&*def:h_*&<&'header&~name'&>&*:*&"
10018 .cindex "expansion" "checking header line existence"
10019 This condition is true if a message is being processed and the named header
10020 exists in the message. For example,
10021 .code
10022 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10023 .endd
10024 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10025 the header name must be terminated by a colon if white space does not follow.
10026
10027 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10028        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10029 .cindex "string" "comparison"
10030 .cindex "expansion" "string comparison"
10031 .cindex "&%eq%& expansion condition"
10032 .cindex "&%eqi%& expansion condition"
10033 The two substrings are first expanded. The condition is true if the two
10034 resulting strings are identical. For &%eq%& the comparison includes the case of
10035 letters, whereas for &%eqi%& the comparison is case-independent.
10036
10037 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10038 .cindex "expansion" "file existence test"
10039 .cindex "file" "existence test"
10040 .cindex "&%exists%&, expansion condition"
10041 The substring is first expanded and then interpreted as an absolute path. The
10042 condition is true if the named file (or directory) exists. The existence test
10043 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10044 users' filter files may be locked out by the system administrator.
10045
10046 .vitem &*first_delivery*&
10047 .cindex "delivery" "first"
10048 .cindex "first delivery"
10049 .cindex "expansion" "first delivery test"
10050 .cindex "&%first_delivery%& expansion condition"
10051 This condition, which has no data, is true during a message's first delivery
10052 attempt. It is false during any subsequent delivery attempts.
10053
10054
10055 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10056        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10057 .cindex "list" "iterative conditions"
10058 .cindex "expansion" "&*forall*& condition"
10059 .cindex "expansion" "&*forany*& condition"
10060 .vindex "&$item$&"
10061 These conditions iterate over a list. The first argument is expanded to form
10062 the list. By default, the list separator is a colon, but it can be changed by
10063 the normal method. The second argument is interpreted as a condition that is to
10064 be applied to each item in the list in turn. During the interpretation of the
10065 condition, the current list item is placed in a variable called &$item$&.
10066 .ilist
10067 For &*forany*&, interpretation stops if the condition is true for any item, and
10068 the result of the whole condition is true. If the condition is false for all
10069 items in the list, the overall condition is false.
10070 .next
10071 For &*forall*&, interpretation stops if the condition is false for any item,
10072 and the result of the whole condition is false. If the condition is true for
10073 all items in the list, the overall condition is true.
10074 .endlist
10075 Note that negation of &*forany*& means that the condition must be false for all
10076 items for the overall condition to succeed, and negation of &*forall*& means
10077 that the condition must be false for at least one item. In this example, the
10078 list separator is changed to a comma:
10079 .code
10080 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10081 .endd
10082 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10083 being processed, to enable these expansion items to be nested.
10084
10085
10086 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10087        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10088 .cindex "string" "comparison"
10089 .cindex "expansion" "string comparison"
10090 .cindex "&%ge%& expansion condition"
10091 .cindex "&%gei%& expansion condition"
10092 The two substrings are first expanded. The condition is true if the first
10093 string is lexically greater than or equal to the second string. For &%ge%& the
10094 comparison includes the case of letters, whereas for &%gei%& the comparison is
10095 case-independent.
10096
10097 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10098        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10099 .cindex "string" "comparison"
10100 .cindex "expansion" "string comparison"
10101 .cindex "&%gt%& expansion condition"
10102 .cindex "&%gti%& expansion condition"
10103 The two substrings are first expanded. The condition is true if the first
10104 string is lexically greater than the second string. For &%gt%& the comparison
10105 includes the case of letters, whereas for &%gti%& the comparison is
10106 case-independent.
10107
10108 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10109        &*isip4&~{*&<&'string'&>&*}*& &&&
10110        &*isip6&~{*&<&'string'&>&*}*&
10111 .cindex "IP address" "testing string format"
10112 .cindex "string" "testing for IP address"
10113 .cindex "&%isip%& expansion condition"
10114 .cindex "&%isip4%& expansion condition"
10115 .cindex "&%isip6%& expansion condition"
10116 The substring is first expanded, and then tested to see if it has the form of
10117 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10118 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10119
10120 For an IPv4 address, the test is for four dot-separated components, each of
10121 which consists of from one to three digits. For an IPv6 address, up to eight
10122 colon-separated components are permitted, each containing from one to four
10123 hexadecimal digits. There may be fewer than eight components if an empty
10124 component (adjacent colons) is present. Only one empty component is permitted.
10125
10126 &*Note*&: The checks are just on the form of the address; actual numerical
10127 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10128 check. The main use of these tests is to distinguish between IP addresses and
10129 host names, or between IPv4 and IPv6 addresses. For example, you could use
10130 .code
10131 ${if isip4{$sender_host_address}...
10132 .endd
10133 to test which IP version an incoming SMTP connection is using.
10134
10135 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10136 .cindex "LDAP" "use for authentication"
10137 .cindex "expansion" "LDAP authentication test"
10138 .cindex "&%ldapauth%& expansion condition"
10139 This condition supports user authentication using LDAP. See section
10140 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10141 queries. For this use, the query must contain a user name and password. The
10142 query itself is not used, and can be empty. The condition is true if the
10143 password is not empty, and the user name and password are accepted by the LDAP
10144 server. An empty password is rejected without calling LDAP because LDAP binds
10145 with an empty password are considered anonymous regardless of the username, and
10146 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10147 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10148 this can be used.
10149
10150
10151 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10152        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10153 .cindex "string" "comparison"
10154 .cindex "expansion" "string comparison"
10155 .cindex "&%le%& expansion condition"
10156 .cindex "&%lei%& expansion condition"
10157 The two substrings are first expanded. The condition is true if the first
10158 string is lexically less than or equal to the second string. For &%le%& the
10159 comparison includes the case of letters, whereas for &%lei%& the comparison is
10160 case-independent.
10161
10162 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10163        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10164 .cindex "string" "comparison"
10165 .cindex "expansion" "string comparison"
10166 .cindex "&%lt%& expansion condition"
10167 .cindex "&%lti%& expansion condition"
10168 The two substrings are first expanded. The condition is true if the first
10169 string is lexically less than the second string. For &%lt%& the comparison
10170 includes the case of letters, whereas for &%lti%& the comparison is
10171 case-independent.
10172
10173
10174 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10175 .cindex "expansion" "regular expression comparison"
10176 .cindex "regular expressions" "match in expanded string"
10177 .cindex "&%match%& expansion condition"
10178 The two substrings are first expanded. The second is then treated as a regular
10179 expression and applied to the first. Because of the pre-expansion, if the
10180 regular expression contains dollar, or backslash characters, they must be
10181 escaped. Care must also be taken if the regular expression contains braces
10182 (curly brackets). A closing brace must be escaped so that it is not taken as a
10183 premature termination of <&'string2'&>. The easiest approach is to use the
10184 &`\N`& feature to disable expansion of the regular expression.
10185 For example,
10186 .code
10187 ${if match {$local_part}{\N^\d{3}\N} ...
10188 .endd
10189 If the whole expansion string is in double quotes, further escaping of
10190 backslashes is also required.
10191
10192 The condition is true if the regular expression match succeeds.
10193 The regular expression is not required to begin with a circumflex
10194 metacharacter, but if there is no circumflex, the expression is not anchored,
10195 and it may match anywhere in the subject, not just at the start. If you want
10196 the pattern to match at the end of the subject, you must include the &`$`&
10197 metacharacter at an appropriate point.
10198
10199 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10200 At the start of an &%if%& expansion the values of the numeric variable
10201 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10202 succeeds causes them to be reset to the substrings of that condition and they
10203 will have these values during the expansion of the success string. At the end
10204 of the &%if%& expansion, the previous values are restored. After testing a
10205 combination of conditions using &%or%&, the subsequent values of the numeric
10206 variables are those of the condition that succeeded.
10207
10208 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10209 .cindex "&%match_address%& expansion condition"
10210 See &*match_local_part*&.
10211
10212 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10213 .cindex "&%match_domain%& expansion condition"
10214 See &*match_local_part*&.
10215
10216 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10217 .cindex "&%match_ip%& expansion condition"
10218 This condition matches an IP address to a list of IP address patterns. It must
10219 be followed by two argument strings. The first (after expansion) must be an IP
10220 address or an empty string. The second (after expansion) is a restricted host
10221 list that can match only an IP address, not a host name. For example:
10222 .code
10223 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10224 .endd
10225 The specific types of host list item that are permitted in the list are:
10226
10227 .ilist
10228 An IP address, optionally with a CIDR mask.
10229 .next
10230 A single asterisk, which matches any IP address.
10231 .next
10232 An empty item, which matches only if the IP address is empty. This could be
10233 useful for testing for a locally submitted message or one from specific hosts
10234 in a single test such as
10235 . ==== As this is a nested list, any displays it contains must be indented
10236 . ==== as otherwise they are too far to the left. This comment applies to
10237 . ==== the use of xmlto plus fop. There's no problem when formatting with
10238 . ==== sdop, with or without the extra indent.
10239 .code
10240   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10241 .endd
10242 where the first item in the list is the empty string.
10243 .next
10244 The item @[] matches any of the local host's interface addresses.
10245 .next
10246 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10247 even if &`net-`& is not specified. There is never any attempt to turn the IP
10248 address into a host name. The most common type of linear search for
10249 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10250 masks. For example:
10251 .code
10252   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10253 .endd
10254 It is of course possible to use other kinds of lookup, and in such a case, you
10255 do need to specify the &`net-`& prefix if you want to specify a specific
10256 address mask, for example:
10257 .code
10258   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10259 .endd
10260 However, unless you are combining a &%match_ip%& condition with others, it is
10261 just as easy to use the fact that a lookup is itself a condition, and write:
10262 .code
10263   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10264 .endd
10265 .endlist ilist
10266
10267 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10268
10269 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10270 .cindex "domain list" "in expansion condition"
10271 .cindex "address list" "in expansion condition"
10272 .cindex "local part" "list, in expansion condition"
10273 .cindex "&%match_local_part%& expansion condition"
10274 This condition, together with &%match_address%& and &%match_domain%&, make it
10275 possible to test domain, address, and local part lists within expansions. Each
10276 condition requires two arguments: an item and a list to match. A trivial
10277 example is:
10278 .code
10279 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10280 .endd
10281 In each case, the second argument may contain any of the allowable items for a
10282 list of the appropriate type. Also, because the second argument (after
10283 expansion) is a standard form of list, it is possible to refer to a named list.
10284 Thus, you can use conditions like this:
10285 .code
10286 ${if match_domain{$domain}{+local_domains}{...
10287 .endd
10288 .cindex "&`+caseful`&"
10289 For address lists, the matching starts off caselessly, but the &`+caseful`&
10290 item can be used, as in all address lists, to cause subsequent items to
10291 have their local parts matched casefully. Domains are always matched
10292 caselessly.
10293
10294 &*Note*&: Host lists are &'not'& supported in this way. This is because
10295 hosts have two identities: a name and an IP address, and it is not clear
10296 how to specify cleanly how such a test would work. However, IP addresses can be
10297 matched using &%match_ip%&.
10298
10299 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10300 .cindex "PAM authentication"
10301 .cindex "AUTH" "with PAM"
10302 .cindex "Solaris" "PAM support"
10303 .cindex "expansion" "PAM authentication test"
10304 .cindex "&%pam%& expansion condition"
10305 &'Pluggable Authentication Modules'&
10306 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10307 available in the latest releases of Solaris and in some GNU/Linux
10308 distributions. The Exim support, which is intended for use in conjunction with
10309 the SMTP AUTH command, is available only if Exim is compiled with
10310 .code
10311 SUPPORT_PAM=yes
10312 .endd
10313 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10314 in some releases of GNU/Linux &%-ldl%& is also needed.
10315
10316 The argument string is first expanded, and the result must be a
10317 colon-separated list of strings. Leading and trailing white space is ignored.
10318 The PAM module is initialized with the service name &"exim"& and the user name
10319 taken from the first item in the colon-separated data string (<&'string1'&>).
10320 The remaining items in the data string are passed over in response to requests
10321 from the authentication function. In the simple case there will only be one
10322 request, for a password, so the data consists of just two strings.
10323
10324 There can be problems if any of the strings are permitted to contain colon
10325 characters. In the usual way, these have to be doubled to avoid being taken as
10326 separators. If the data is being inserted from a variable, the &%sg%& expansion
10327 item can be used to double any existing colons. For example, the configuration
10328 of a LOGIN authenticator might contain this setting:
10329 .code
10330 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10331 .endd
10332 For a PLAIN authenticator you could use:
10333 .code
10334 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10335 .endd
10336 In some operating systems, PAM authentication can be done only from a process
10337 running as root. Since Exim is running as the Exim user when receiving
10338 messages, this means that PAM cannot be used directly in those systems.
10339 A patched version of the &'pam_unix'& module that comes with the
10340 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10341 The patched module allows one special uid/gid combination, in addition to root,
10342 to authenticate. If you build the patched module to allow the Exim user and
10343 group, PAM can then be used from an Exim authenticator.
10344
10345
10346 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10347 .cindex "&'pwcheck'& daemon"
10348 .cindex "Cyrus"
10349 .cindex "expansion" "&'pwcheck'& authentication test"
10350 .cindex "&%pwcheck%& expansion condition"
10351 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10352 This is one way of making it possible for passwords to be checked by a process
10353 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10354 deprecated. Its replacement is &'saslauthd'& (see below).
10355
10356 The pwcheck support is not included in Exim by default. You need to specify
10357 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10358 building Exim. For example:
10359 .code
10360 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10361 .endd
10362 You do not need to install the full Cyrus software suite in order to use
10363 the pwcheck daemon. You can compile and install just the daemon alone
10364 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10365 access to the &_/var/pwcheck_& directory.
10366
10367 The &%pwcheck%& condition takes one argument, which must be the user name and
10368 password, separated by a colon. For example, in a LOGIN authenticator
10369 configuration, you might have this:
10370 .code
10371 server_condition = ${if pwcheck{$auth1:$auth2}}
10372 .endd
10373 Again, for a PLAIN authenticator configuration, this would be:
10374 .code
10375 server_condition = ${if pwcheck{$auth2:$auth3}}
10376 .endd
10377 .vitem &*queue_running*&
10378 .cindex "queue runner" "detecting when delivering from"
10379 .cindex "expansion" "queue runner test"
10380 .cindex "&%queue_running%& expansion condition"
10381 This condition, which has no data, is true during delivery attempts that are
10382 initiated by queue runner processes, and false otherwise.
10383
10384
10385 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10386 .cindex "Radius"
10387 .cindex "expansion" "Radius authentication"
10388 .cindex "&%radius%& expansion condition"
10389 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10390 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10391 the Radius client configuration file in order to build Exim with Radius
10392 support.
10393
10394 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10395 library, using the original API. If you are using release 0.4.0 or later of
10396 this library, you need to set
10397 .code
10398 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10399 .endd
10400 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10401 &%libradius%& library that comes with FreeBSD. To do this, set
10402 .code
10403 RADIUS_LIB_TYPE=RADLIB
10404 .endd
10405 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10406 You may also have to supply a suitable setting in EXTRALIBS so that the
10407 Radius library can be found when Exim is linked.
10408
10409 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10410 Radius client library, which calls the Radius server. The condition is true if
10411 the authentication is successful. For example:
10412 .code
10413 server_condition = ${if radius{<arguments>}}
10414 .endd
10415
10416
10417 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10418         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10419 .cindex "&'saslauthd'& daemon"
10420 .cindex "Cyrus"
10421 .cindex "expansion" "&'saslauthd'& authentication test"
10422 .cindex "&%saslauthd%& expansion condition"
10423 This condition supports user authentication using the Cyrus &'saslauthd'&
10424 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10425 Using this daemon is one way of making it possible for passwords to be checked
10426 by a process that is not running as root.
10427
10428 The saslauthd support is not included in Exim by default. You need to specify
10429 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10430 building Exim. For example:
10431 .code
10432 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10433 .endd
10434 You do not need to install the full Cyrus software suite in order to use
10435 the saslauthd daemon. You can compile and install just the daemon alone
10436 from the Cyrus SASL library.
10437
10438 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10439 two are mandatory. For example:
10440 .code
10441 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10442 .endd
10443 The service and the realm are optional (which is why the arguments are enclosed
10444 in their own set of braces). For details of the meaning of the service and
10445 realm, and how to run the daemon, consult the Cyrus documentation.
10446 .endlist vlist
10447
10448
10449
10450 .section "Combining expansion conditions" "SECID84"
10451 .cindex "expansion" "combining conditions"
10452 Several conditions can be tested at once by combining them using the &%and%&
10453 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10454 conditions on their own, and precede their lists of sub-conditions. Each
10455 sub-condition must be enclosed in braces within the overall braces that contain
10456 the list. No repetition of &%if%& is used.
10457
10458
10459 .vlist
10460 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10461 .cindex "&""or""& expansion condition"
10462 .cindex "expansion" "&""or""& of conditions"
10463 The sub-conditions are evaluated from left to right. The condition is true if
10464 any one of the sub-conditions is true.
10465 For example,
10466 .code
10467 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10468 .endd
10469 When a true sub-condition is found, the following ones are parsed but not
10470 evaluated. If there are several &"match"& sub-conditions the values of the
10471 numeric variables afterwards are taken from the first one that succeeds.
10472
10473 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10474 .cindex "&""and""& expansion condition"
10475 .cindex "expansion" "&""and""& of conditions"
10476 The sub-conditions are evaluated from left to right. The condition is true if
10477 all of the sub-conditions are true. If there are several &"match"&
10478 sub-conditions, the values of the numeric variables afterwards are taken from
10479 the last one. When a false sub-condition is found, the following ones are
10480 parsed but not evaluated.
10481 .endlist
10482 .ecindex IIDexpcond
10483
10484
10485
10486
10487 .section "Expansion variables" "SECTexpvar"
10488 .cindex "expansion" "variables, list of"
10489 This section contains an alphabetical list of all the expansion variables. Some
10490 of them are available only when Exim is compiled with specific options such as
10491 support for TLS or the content scanning extension.
10492
10493 .vlist
10494 .vitem "&$0$&, &$1$&, etc"
10495 .cindex "numerical variables (&$1$& &$2$& etc)"
10496 When a &%match%& expansion condition succeeds, these variables contain the
10497 captured substrings identified by the regular expression during subsequent
10498 processing of the success string of the containing &%if%& expansion item.
10499 However, they do not retain their values afterwards; in fact, their previous
10500 values are restored at the end of processing an &%if%& item. The numerical
10501 variables may also be set externally by some other matching process which
10502 precedes the expansion of the string. For example, the commands available in
10503 Exim filter files include an &%if%& command with its own regular expression
10504 matching condition.
10505
10506 .vitem "&$acl_c...$&"
10507 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10508 can be given any name that starts with &$acl_c$& and is at least six characters
10509 long, but the sixth character must be either a digit or an underscore. For
10510 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10511 variables persist throughout the lifetime of an SMTP connection. They can be
10512 used to pass information between ACLs and between different invocations of the
10513 same ACL. When a message is received, the values of these variables are saved
10514 with the message, and can be accessed by filters, routers, and transports
10515 during subsequent delivery.
10516
10517 .vitem "&$acl_m...$&"
10518 These variables are like the &$acl_c...$& variables, except that their values
10519 are reset after a message has been received. Thus, if several messages are
10520 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10521 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10522 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10523 message is received, the values of these variables are saved with the message,
10524 and can be accessed by filters, routers, and transports during subsequent
10525 delivery.
10526
10527 .vitem &$acl_verify_message$&
10528 .vindex "&$acl_verify_message$&"
10529 After an address verification has failed, this variable contains the failure
10530 message. It retains its value for use in subsequent modifiers. The message can
10531 be preserved by coding like this:
10532 .code
10533 warn !verify = sender
10534      set acl_m0 = $acl_verify_message
10535 .endd
10536 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10537 &%log_message%& modifiers, to include information about the verification
10538 failure.
10539
10540 .vitem &$address_data$&
10541 .vindex "&$address_data$&"
10542 This variable is set by means of the &%address_data%& option in routers. The
10543 value then remains with the address while it is processed by subsequent routers
10544 and eventually a transport. If the transport is handling multiple addresses,
10545 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10546 for more details. &*Note*&: The contents of &$address_data$& are visible in
10547 user filter files.
10548
10549 If &$address_data$& is set when the routers are called from an ACL to verify
10550 a recipient address, the final value is still in the variable for subsequent
10551 conditions and modifiers of the ACL statement. If routing the address caused it
10552 to be redirected to just one address, the child address is also routed as part
10553 of the verification, and in this case the final value of &$address_data$& is
10554 from the child's routing.
10555
10556 If &$address_data$& is set when the routers are called from an ACL to verify a
10557 sender address, the final value is also preserved, but this time in
10558 &$sender_address_data$&, to distinguish it from data from a recipient
10559 address.
10560
10561 In both cases (recipient and sender verification), the value does not persist
10562 after the end of the current ACL statement. If you want to preserve
10563 these values for longer, you can save them in ACL variables.
10564
10565 .vitem &$address_file$&
10566 .vindex "&$address_file$&"
10567 When, as a result of aliasing, forwarding, or filtering, a message is directed
10568 to a specific file, this variable holds the name of the file when the transport
10569 is running. At other times, the variable is empty. For example, using the
10570 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10571 .code
10572 /home/r2d2/savemail
10573 .endd
10574 then when the &(address_file)& transport is running, &$address_file$&
10575 contains the text string &`/home/r2d2/savemail`&.
10576 .cindex "Sieve filter" "value of &$address_file$&"
10577 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10578 then up to the transport configuration to generate an appropriate absolute path
10579 to the relevant file.
10580
10581 .vitem &$address_pipe$&
10582 .vindex "&$address_pipe$&"
10583 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10584 this variable holds the pipe command when the transport is running.
10585
10586 .vitem "&$auth1$& &-- &$auth3$&"
10587 .vindex "&$auth1$&, &$auth2$&, etc"
10588 These variables are used in SMTP authenticators (see chapters
10589 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10590
10591 .vitem &$authenticated_id$&
10592 .cindex "authentication" "id"
10593 .vindex "&$authenticated_id$&"
10594 When a server successfully authenticates a client it may be configured to
10595 preserve some of the authentication information in the variable
10596 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10597 user/password authenticator configuration might preserve the user name for use
10598 in the routers. Note that this is not the same information that is saved in
10599 &$sender_host_authenticated$&.
10600 When a message is submitted locally (that is, not over a TCP connection)
10601 the value of &$authenticated_id$& is normally the login name of the calling
10602 process. However, a trusted user can override this by means of the &%-oMai%&
10603 command line option.
10604
10605
10606
10607
10608 .vitem &$authenticated_sender$&
10609 .cindex "sender" "authenticated"
10610 .cindex "authentication" "sender"
10611 .cindex "AUTH" "on MAIL command"
10612 .vindex "&$authenticated_sender$&"
10613 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10614 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10615 described in section &<<SECTauthparamail>>&. Unless the data is the string
10616 &"<>"&, it is set as the authenticated sender of the message, and the value is
10617 available during delivery in the &$authenticated_sender$& variable. If the
10618 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10619
10620 .vindex "&$qualify_domain$&"
10621 When a message is submitted locally (that is, not over a TCP connection), the
10622 value of &$authenticated_sender$& is an address constructed from the login
10623 name of the calling process and &$qualify_domain$&, except that a trusted user
10624 can override this by means of the &%-oMas%& command line option.
10625
10626
10627 .vitem &$authentication_failed$&
10628 .cindex "authentication" "failure"
10629 .vindex "&$authentication_failed$&"
10630 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10631 command that does not succeed. Otherwise it is set to &"0"&. This makes it
10632 possible to distinguish between &"did not try to authenticate"&
10633 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
10634 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
10635 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
10636 negative response to an AUTH command, including (for example) an attempt to use
10637 an undefined mechanism.
10638
10639 .vitem &$body_linecount$&
10640 .cindex "message body" "line count"
10641 .cindex "body of message" "line count"
10642 .vindex "&$body_linecount$&"
10643 When a message is being received or delivered, this variable contains the
10644 number of lines in the message's body. See also &$message_linecount$&.
10645
10646 .vitem &$body_zerocount$&
10647 .cindex "message body" "binary zero count"
10648 .cindex "body of message" "binary zero count"
10649 .cindex "binary zero" "in message body"
10650 .vindex "&$body_zerocount$&"
10651 When a message is being received or delivered, this variable contains the
10652 number of binary zero bytes in the message's body.
10653
10654 .vitem &$bounce_recipient$&
10655 .vindex "&$bounce_recipient$&"
10656 This is set to the recipient address of a bounce message while Exim is creating
10657 it. It is useful if a customized bounce message text file is in use (see
10658 chapter &<<CHAPemsgcust>>&).
10659
10660 .vitem &$bounce_return_size_limit$&
10661 .vindex "&$bounce_return_size_limit$&"
10662 This contains the value set in the &%bounce_return_size_limit%& option, rounded
10663 up to a multiple of 1000. It is useful when a customized error message text
10664 file is in use (see chapter &<<CHAPemsgcust>>&).
10665
10666 .vitem &$caller_gid$&
10667 .cindex "gid (group id)" "caller"
10668 .vindex "&$caller_gid$&"
10669 The real group id under which the process that called Exim was running. This is
10670 not the same as the group id of the originator of a message (see
10671 &$originator_gid$&). If Exim re-execs itself, this variable in the new
10672 incarnation normally contains the Exim gid.
10673
10674 .vitem &$caller_uid$&
10675 .cindex "uid (user id)" "caller"
10676 .vindex "&$caller_uid$&"
10677 The real user id under which the process that called Exim was running. This is
10678 not the same as the user id of the originator of a message (see
10679 &$originator_uid$&). If Exim re-execs itself, this variable in the new
10680 incarnation normally contains the Exim uid.
10681
10682 .vitem &$compile_date$&
10683 .vindex "&$compile_date$&"
10684 The date on which the Exim binary was compiled.
10685
10686 .vitem &$compile_number$&
10687 .vindex "&$compile_number$&"
10688 The building process for Exim keeps a count of the number
10689 of times it has been compiled. This serves to distinguish different
10690 compilations of the same version of the program.
10691
10692 .vitem &$demime_errorlevel$&
10693 .vindex "&$demime_errorlevel$&"
10694 This variable is available when Exim is compiled with
10695 the content-scanning extension and the obsolete &%demime%& condition. For
10696 details, see section &<<SECTdemimecond>>&.
10697
10698 .vitem &$demime_reason$&
10699 .vindex "&$demime_reason$&"
10700 This variable is available when Exim is compiled with the
10701 content-scanning extension and the obsolete &%demime%& condition. For details,
10702 see section &<<SECTdemimecond>>&.
10703
10704 .vitem &$dnslist_domain$& &&&
10705        &$dnslist_matched$& &&&
10706        &$dnslist_text$& &&&
10707        &$dnslist_value$&
10708 .vindex "&$dnslist_domain$&"
10709 .vindex "&$dnslist_matched$&"
10710 .vindex "&$dnslist_text$&"
10711 .vindex "&$dnslist_value$&"
10712 .cindex "black list (DNS)"
10713 When a DNS (black) list lookup succeeds, these variables are set to contain
10714 the following data from the lookup: the list's domain name, the key that was
10715 looked up, the contents of any associated TXT record, and the value from the
10716 main A record. See section &<<SECID204>>& for more details.
10717
10718 .vitem &$domain$&
10719 .vindex "&$domain$&"
10720 When an address is being routed, or delivered on its own, this variable
10721 contains the domain. Uppercase letters in the domain are converted into lower
10722 case for &$domain$&.
10723
10724 Global address rewriting happens when a message is received, so the value of
10725 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
10726 is set during user filtering, but not during system filtering, because a
10727 message may have many recipients and the system filter is called just once.
10728
10729 When more than one address is being delivered at once (for example, several
10730 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
10731 have the same domain. Transports can be restricted to handling only one domain
10732 at a time if the value of &$domain$& is required at transport time &-- this is
10733 the default for local transports. For further details of the environment in
10734 which local transports are run, see chapter &<<CHAPenvironment>>&.
10735
10736 .oindex "&%delay_warning_condition%&"
10737 At the end of a delivery, if all deferred addresses have the same domain, it is
10738 set in &$domain$& during the expansion of &%delay_warning_condition%&.
10739
10740 The &$domain$& variable is also used in some other circumstances:
10741
10742 .ilist
10743 When an ACL is running for a RCPT command, &$domain$& contains the domain of
10744 the recipient address. The domain of the &'sender'& address is in
10745 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
10746 normally set during the running of the MAIL ACL. However, if the sender address
10747 is verified with a callout during the MAIL ACL, the sender domain is placed in
10748 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
10749 the &(smtp)& transport.
10750
10751 .next
10752 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10753 &$domain$& contains the domain portion of the address that is being rewritten;
10754 it can be used in the expansion of the replacement address, for example, to
10755 rewrite domains by file lookup.
10756
10757 .next
10758 With one important exception, whenever a domain list is being scanned,
10759 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
10760 a &%sender_domains%& condition in an ACL is being processed, the subject domain
10761 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
10762 that, in a RCPT ACL, the sender domain list can be dependent on the
10763 recipient domain (which is what is in &$domain$& at this time).
10764
10765 .next
10766 .cindex "ETRN" "value of &$domain$&"
10767 .oindex "&%smtp_etrn_command%&"
10768 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
10769 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
10770 .endlist
10771
10772
10773 .vitem &$domain_data$&
10774 .vindex "&$domain_data$&"
10775 When the &%domains%& option on a router matches a domain by
10776 means of a lookup, the data read by the lookup is available during the running
10777 of the router as &$domain_data$&. In addition, if the driver routes the
10778 address to a transport, the value is available in that transport. If the
10779 transport is handling multiple addresses, the value from the first address is
10780 used.
10781
10782 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
10783 domain by means of a lookup. The data read by the lookup is available during
10784 the rest of the ACL statement. In all other situations, this variable expands
10785 to nothing.
10786
10787 .vitem &$exim_gid$&
10788 .vindex "&$exim_gid$&"
10789 This variable contains the numerical value of the Exim group id.
10790
10791 .vitem &$exim_path$&
10792 .vindex "&$exim_path$&"
10793 This variable contains the path to the Exim binary.
10794
10795 .vitem &$exim_uid$&
10796 .vindex "&$exim_uid$&"
10797 This variable contains the numerical value of the Exim user id.
10798
10799 .vitem &$found_extension$&
10800 .vindex "&$found_extension$&"
10801 This variable is available when Exim is compiled with the
10802 content-scanning extension and the obsolete &%demime%& condition. For details,
10803 see section &<<SECTdemimecond>>&.
10804
10805 .vitem &$header_$&<&'name'&>
10806 This is not strictly an expansion variable. It is expansion syntax for
10807 inserting the message header line with the given name. Note that the name must
10808 be terminated by colon or white space, because it may contain a wide variety of
10809 characters. Note also that braces must &'not'& be used.
10810
10811 .vitem &$home$&
10812 .vindex "&$home$&"
10813 When the &%check_local_user%& option is set for a router, the user's home
10814 directory is placed in &$home$& when the check succeeds. In particular, this
10815 means it is set during the running of users' filter files. A router may also
10816 explicitly set a home directory for use by a transport; this can be overridden
10817 by a setting on the transport itself.
10818
10819 When running a filter test via the &%-bf%& option, &$home$& is set to the value
10820 of the environment variable HOME.
10821
10822 .vitem &$host$&
10823 .vindex "&$host$&"
10824 If a router assigns an address to a transport (any transport), and passes a
10825 list of hosts with the address, the value of &$host$& when the transport starts
10826 to run is the name of the first host on the list. Note that this applies both
10827 to local and remote transports.
10828
10829 .cindex "transport" "filter"
10830 .cindex "filter" "transport filter"
10831 For the &(smtp)& transport, if there is more than one host, the value of
10832 &$host$& changes as the transport works its way through the list. In
10833 particular, when the &(smtp)& transport is expanding its options for encryption
10834 using TLS, or for specifying a transport filter (see chapter
10835 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
10836 is connected.
10837
10838 When used in the client part of an authenticator configuration (see chapter
10839 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
10840 client is connected.
10841
10842
10843 .vitem &$host_address$&
10844 .vindex "&$host_address$&"
10845 This variable is set to the remote host's IP address whenever &$host$& is set
10846 for a remote connection. It is also set to the IP address that is being checked
10847 when the &%ignore_target_hosts%& option is being processed.
10848
10849 .vitem &$host_data$&
10850 .vindex "&$host_data$&"
10851 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
10852 result of the lookup is made available in the &$host_data$& variable. This
10853 allows you, for example, to do things like this:
10854 .code
10855 deny  hosts = net-lsearch;/some/file
10856 message = $host_data
10857 .endd
10858 .vitem &$host_lookup_deferred$&
10859 .cindex "host name" "lookup, failure of"
10860 .vindex "&$host_lookup_deferred$&"
10861 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
10862 message comes from a remote host and there is an attempt to look up the host's
10863 name from its IP address, and the attempt is not successful, one of these
10864 variables is set to &"1"&.
10865
10866 .ilist
10867 If the lookup receives a definite negative response (for example, a DNS lookup
10868 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
10869
10870 .next
10871 If there is any kind of problem during the lookup, such that Exim cannot
10872 tell whether or not the host name is defined (for example, a timeout for a DNS
10873 lookup), &$host_lookup_deferred$& is set to &"1"&.
10874 .endlist ilist
10875
10876 Looking up a host's name from its IP address consists of more than just a
10877 single reverse lookup. Exim checks that a forward lookup of at least one of the
10878 names it receives from a reverse lookup yields the original IP address. If this
10879 is not the case, Exim does not accept the looked up name(s), and
10880 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
10881 IP address (for example, the existence of a PTR record in the DNS) is not
10882 sufficient on its own for the success of a host name lookup. If the reverse
10883 lookup succeeds, but there is a lookup problem such as a timeout when checking
10884 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
10885 &"1"&. See also &$sender_host_name$&.
10886
10887 .vitem &$host_lookup_failed$&
10888 .vindex "&$host_lookup_failed$&"
10889 See &$host_lookup_deferred$&.
10890
10891
10892 .vitem &$inode$&
10893 .vindex "&$inode$&"
10894 The only time this variable is set is while expanding the &%directory_file%&
10895 option in the &(appendfile)& transport. The variable contains the inode number
10896 of the temporary file which is about to be renamed. It can be used to construct
10897 a unique name for the file.
10898
10899 .vitem &$interface_address$&
10900 .vindex "&$interface_address$&"
10901 This is an obsolete name for &$received_ip_address$&.
10902
10903 .vitem &$interface_port$&
10904 .vindex "&$interface_port$&"
10905 This is an obsolete name for &$received_port$&.
10906
10907 .vitem &$item$&
10908 .vindex "&$item$&"
10909 This variable is used during the expansion of &*forall*& and &*forany*&
10910 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
10911 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
10912 empty.
10913
10914 .vitem &$ldap_dn$&
10915 .vindex "&$ldap_dn$&"
10916 This variable, which is available only when Exim is compiled with LDAP support,
10917 contains the DN from the last entry in the most recently successful LDAP
10918 lookup.
10919
10920 .vitem &$load_average$&
10921 .vindex "&$load_average$&"
10922 This variable contains the system load average, multiplied by 1000 so that it
10923 is an integer. For example, if the load average is 0.21, the value of the
10924 variable is 210. The value is recomputed every time the variable is referenced.
10925
10926 .vitem &$local_part$&
10927 .vindex "&$local_part$&"
10928 When an address is being routed, or delivered on its own, this
10929 variable contains the local part. When a number of addresses are being
10930 delivered together (for example, multiple RCPT commands in an SMTP
10931 session), &$local_part$& is not set.
10932
10933 Global address rewriting happens when a message is received, so the value of
10934 &$local_part$& during routing and delivery is the value after rewriting.
10935 &$local_part$& is set during user filtering, but not during system filtering,
10936 because a message may have many recipients and the system filter is called just
10937 once.
10938
10939 .vindex "&$local_part_prefix$&"
10940 .vindex "&$local_part_suffix$&"
10941 If a local part prefix or suffix has been recognized, it is not included in the
10942 value of &$local_part$& during routing and subsequent delivery. The values of
10943 any prefix or suffix are in &$local_part_prefix$& and
10944 &$local_part_suffix$&, respectively.
10945
10946 When a message is being delivered to a file, pipe, or autoreply transport as a
10947 result of aliasing or forwarding, &$local_part$& is set to the local part of
10948 the parent address, not to the file name or command (see &$address_file$& and
10949 &$address_pipe$&).
10950
10951 When an ACL is running for a RCPT command, &$local_part$& contains the
10952 local part of the recipient address.
10953
10954 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10955 &$local_part$& contains the local part of the address that is being rewritten;
10956 it can be used in the expansion of the replacement address, for example.
10957
10958 In all cases, all quoting is removed from the local part. For example, for both
10959 the addresses
10960 .code
10961 "abc:xyz"@test.example
10962 abc\:xyz@test.example
10963 .endd
10964 the value of &$local_part$& is
10965 .code
10966 abc:xyz
10967 .endd
10968 If you use &$local_part$& to create another address, you should always wrap it
10969 inside a quoting operator. For example, in a &(redirect)& router you could
10970 have:
10971 .code
10972 data = ${quote_local_part:$local_part}@new.domain.example
10973 .endd
10974 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
10975 to process local parts in a case-dependent manner in a router, you can set the
10976 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
10977
10978 .vitem &$local_part_data$&
10979 .vindex "&$local_part_data$&"
10980 When the &%local_parts%& option on a router matches a local part by means of a
10981 lookup, the data read by the lookup is available during the running of the
10982 router as &$local_part_data$&. In addition, if the driver routes the address
10983 to a transport, the value is available in that transport. If the transport is
10984 handling multiple addresses, the value from the first address is used.
10985
10986 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
10987 matches a local part by means of a lookup. The data read by the lookup is
10988 available during the rest of the ACL statement. In all other situations, this
10989 variable expands to nothing.
10990
10991 .vitem &$local_part_prefix$&
10992 .vindex "&$local_part_prefix$&"
10993 When an address is being routed or delivered, and a
10994 specific prefix for the local part was recognized, it is available in this
10995 variable, having been removed from &$local_part$&.
10996
10997 .vitem &$local_part_suffix$&
10998 .vindex "&$local_part_suffix$&"
10999 When an address is being routed or delivered, and a
11000 specific suffix for the local part was recognized, it is available in this
11001 variable, having been removed from &$local_part$&.
11002
11003 .vitem &$local_scan_data$&
11004 .vindex "&$local_scan_data$&"
11005 This variable contains the text returned by the &[local_scan()]& function when
11006 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11007
11008 .vitem &$local_user_gid$&
11009 .vindex "&$local_user_gid$&"
11010 See &$local_user_uid$&.
11011
11012 .vitem &$local_user_uid$&
11013 .vindex "&$local_user_uid$&"
11014 This variable and &$local_user_gid$& are set to the uid and gid after the
11015 &%check_local_user%& router precondition succeeds. This means that their values
11016 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11017 and &%condition%&), for the &%address_data%& expansion, and for any
11018 router-specific expansions. At all other times, the values in these variables
11019 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11020
11021 .vitem &$localhost_number$&
11022 .vindex "&$localhost_number$&"
11023 This contains the expanded value of the
11024 &%localhost_number%& option. The expansion happens after the main options have
11025 been read.
11026
11027 .vitem &$log_inodes$&
11028 .vindex "&$log_inodes$&"
11029 The number of free inodes in the disk partition where Exim's
11030 log files are being written. The value is recalculated whenever the variable is
11031 referenced. If the relevant file system does not have the concept of inodes,
11032 the value of is -1. See also the &%check_log_inodes%& option.
11033
11034 .vitem &$log_space$&
11035 .vindex "&$log_space$&"
11036 The amount of free space (as a number of kilobytes) in the disk
11037 partition where Exim's log files are being written. The value is recalculated
11038 whenever the variable is referenced. If the operating system does not have the
11039 ability to find the amount of free space (only true for experimental systems),
11040 the space value is -1. See also the &%check_log_space%& option.
11041
11042
11043 .vitem &$mailstore_basename$&
11044 .vindex "&$mailstore_basename$&"
11045 This variable is set only when doing deliveries in &"mailstore"& format in the
11046 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11047 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11048 contains the basename of the files that are being written, that is, the name
11049 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11050 variable is empty.
11051
11052 .vitem &$malware_name$&
11053 .vindex "&$malware_name$&"
11054 This variable is available when Exim is compiled with the
11055 content-scanning extension. It is set to the name of the virus that was found
11056 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11057
11058 .vitem &$max_received_linelength$&
11059 .vindex "&$max_received_linelength$&"
11060 .cindex "maximum" "line length"
11061 .cindex "line length" "maximum"
11062 This variable contains the number of bytes in the longest line that was
11063 received as part of the message, not counting the line termination
11064 character(s).
11065
11066 .vitem &$message_age$&
11067 .cindex "message" "age of"
11068 .vindex "&$message_age$&"
11069 This variable is set at the start of a delivery attempt to contain the number
11070 of seconds since the message was received. It does not change during a single
11071 delivery attempt.
11072
11073 .vitem &$message_body$&
11074 .cindex "body of message" "expansion variable"
11075 .cindex "message body" "in expansion"
11076 .cindex "binary zero" "in message body"
11077 .vindex "&$message_body$&"
11078 .oindex "&%message_body_visible%&"
11079 This variable contains the initial portion of a message's body while it is
11080 being delivered, and is intended mainly for use in filter files. The maximum
11081 number of characters of the body that are put into the variable is set by the
11082 &%message_body_visible%& configuration option; the default is 500.
11083
11084 .oindex "&%message_body_newlines%&"
11085 By default, newlines are converted into spaces in &$message_body$&, to make it
11086 easier to search for phrases that might be split over a line break. However,
11087 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11088 zeros are always converted into spaces.
11089
11090 .vitem &$message_body_end$&
11091 .cindex "body of message" "expansion variable"
11092 .cindex "message body" "in expansion"
11093 .vindex "&$message_body_end$&"
11094 This variable contains the final portion of a message's
11095 body while it is being delivered. The format and maximum size are as for
11096 &$message_body$&.
11097
11098 .vitem &$message_body_size$&
11099 .cindex "body of message" "size"
11100 .cindex "message body" "size"
11101 .vindex "&$message_body_size$&"
11102 When a message is being delivered, this variable contains the size of the body
11103 in bytes. The count starts from the character after the blank line that
11104 separates the body from the header. Newlines are included in the count. See
11105 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11106
11107 .vitem &$message_exim_id$&
11108 .vindex "&$message_exim_id$&"
11109 When a message is being received or delivered, this variable contains the
11110 unique message id that is generated and used by Exim to identify the message.
11111 An id is not created for a message until after its header has been successfully
11112 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11113 line; it is the local id that Exim assigns to the message, for example:
11114 &`1BXTIK-0001yO-VA`&.
11115
11116 .vitem &$message_headers$&
11117 .vindex &$message_headers$&
11118 This variable contains a concatenation of all the header lines when a message
11119 is being processed, except for lines added by routers or transports. The header
11120 lines are separated by newline characters. Their contents are decoded in the
11121 same way as a header line that is inserted by &%bheader%&.
11122
11123 .vitem &$message_headers_raw$&
11124 .vindex &$message_headers_raw$&
11125 This variable is like &$message_headers$& except that no processing of the
11126 contents of header lines is done.
11127
11128 .vitem &$message_id$&
11129 This is an old name for &$message_exim_id$&, which is now deprecated.
11130
11131 .vitem &$message_linecount$&
11132 .vindex "&$message_linecount$&"
11133 This variable contains the total number of lines in the header and body of the
11134 message. Compare &$body_linecount$&, which is the count for the body only.
11135 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11136 number of lines received. Before delivery happens (that is, before filters,
11137 routers, and transports run) the count is increased to include the
11138 &'Received:'& header line that Exim standardly adds, and also any other header
11139 lines that are added by ACLs. The blank line that separates the message header
11140 from the body is not counted. Here is an example of the use of this variable in
11141 a DATA ACL:
11142 .code
11143 deny message   = Too many lines in message header
11144      condition = \
11145       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11146 .endd
11147 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11148 message has not yet been received.
11149
11150 .vitem &$message_size$&
11151 .cindex "size" "of message"
11152 .cindex "message" "size"
11153 .vindex "&$message_size$&"
11154 When a message is being processed, this variable contains its size in bytes. In
11155 most cases, the size includes those headers that were received with the
11156 message, but not those (such as &'Envelope-to:'&) that are added to individual
11157 deliveries as they are written. However, there is one special case: during the
11158 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11159 doing a delivery in maildir format, the value of &$message_size$& is the
11160 precise size of the file that has been written. See also
11161 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11162
11163 .cindex "RCPT" "value of &$message_size$&"
11164 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11165 contains the size supplied on the MAIL command, or -1 if no size was given. The
11166 value may not, of course, be truthful.
11167
11168 .vitem &$mime_$&&'xxx'&
11169 A number of variables whose names start with &$mime$& are
11170 available when Exim is compiled with the content-scanning extension. For
11171 details, see section &<<SECTscanmimepart>>&.
11172
11173 .vitem "&$n0$& &-- &$n9$&"
11174 These variables are counters that can be incremented by means
11175 of the &%add%& command in filter files.
11176
11177 .vitem &$original_domain$&
11178 .vindex "&$domain$&"
11179 .vindex "&$original_domain$&"
11180 When a top-level address is being processed for delivery, this contains the
11181 same value as &$domain$&. However, if a &"child"& address (for example,
11182 generated by an alias, forward, or filter file) is being processed, this
11183 variable contains the domain of the original address (lower cased). This
11184 differs from &$parent_domain$& only when there is more than one level of
11185 aliasing or forwarding. When more than one address is being delivered in a
11186 single transport run, &$original_domain$& is not set.
11187
11188 If a new address is created by means of a &%deliver%& command in a system
11189 filter, it is set up with an artificial &"parent"& address. This has the local
11190 part &'system-filter'& and the default qualify domain.
11191
11192 .vitem &$original_local_part$&
11193 .vindex "&$local_part$&"
11194 .vindex "&$original_local_part$&"
11195 When a top-level address is being processed for delivery, this contains the
11196 same value as &$local_part$&, unless a prefix or suffix was removed from the
11197 local part, because &$original_local_part$& always contains the full local
11198 part. When a &"child"& address (for example, generated by an alias, forward, or
11199 filter file) is being processed, this variable contains the full local part of
11200 the original address.
11201
11202 If the router that did the redirection processed the local part
11203 case-insensitively, the value in &$original_local_part$& is in lower case.
11204 This variable differs from &$parent_local_part$& only when there is more than
11205 one level of aliasing or forwarding. When more than one address is being
11206 delivered in a single transport run, &$original_local_part$& is not set.
11207
11208 If a new address is created by means of a &%deliver%& command in a system
11209 filter, it is set up with an artificial &"parent"& address. This has the local
11210 part &'system-filter'& and the default qualify domain.
11211
11212 .vitem &$originator_gid$&
11213 .cindex "gid (group id)" "of originating user"
11214 .cindex "sender" "gid"
11215 .vindex "&$caller_gid$&"
11216 .vindex "&$originator_gid$&"
11217 This variable contains the value of &$caller_gid$& that was set when the
11218 message was received. For messages received via the command line, this is the
11219 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11220 normally the gid of the Exim user.
11221
11222 .vitem &$originator_uid$&
11223 .cindex "uid (user id)" "of originating user"
11224 .cindex "sender" "uid"
11225 .vindex "&$caller_uid$&"
11226 .vindex "&$originaltor_uid$&"
11227 The value of &$caller_uid$& that was set when the message was received. For
11228 messages received via the command line, this is the uid of the sending user.
11229 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11230 user.
11231
11232 .vitem &$parent_domain$&
11233 .vindex "&$parent_domain$&"
11234 This variable is similar to &$original_domain$& (see
11235 above), except that it refers to the immediately preceding parent address.
11236
11237 .vitem &$parent_local_part$&
11238 .vindex "&$parent_local_part$&"
11239 This variable is similar to &$original_local_part$&
11240 (see above), except that it refers to the immediately preceding parent address.
11241
11242 .vitem &$pid$&
11243 .cindex "pid (process id)" "of current process"
11244 .vindex "&$pid$&"
11245 This variable contains the current process id.
11246
11247 .vitem &$pipe_addresses$&
11248 .cindex "filter" "transport filter"
11249 .cindex "transport" "filter"
11250 .vindex "&$pipe_addresses$&"
11251 This is not an expansion variable, but is mentioned here because the string
11252 &`$pipe_addresses`& is handled specially in the command specification for the
11253 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11254 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11255 It cannot be used in general expansion strings, and provokes an &"unknown
11256 variable"& error if encountered.
11257
11258 .vitem &$primary_hostname$&
11259 .vindex "&$primary_hostname$&"
11260 This variable contains the value set by &%primary_hostname%& in the
11261 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11262 a single-component name, Exim calls &[gethostbyname()]& (or
11263 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11264 qualified host name. See also &$smtp_active_hostname$&.
11265
11266
11267 .vitem &$prvscheck_address$&
11268 This variable is used in conjunction with the &%prvscheck%& expansion item,
11269 which is described in sections &<<SECTexpansionitems>>& and
11270 &<<SECTverifyPRVS>>&.
11271
11272 .vitem &$prvscheck_keynum$&
11273 This variable is used in conjunction with the &%prvscheck%& expansion item,
11274 which is described in sections &<<SECTexpansionitems>>& and
11275 &<<SECTverifyPRVS>>&.
11276
11277 .vitem &$prvscheck_result$&
11278 This variable is used in conjunction with the &%prvscheck%& expansion item,
11279 which is described in sections &<<SECTexpansionitems>>& and
11280 &<<SECTverifyPRVS>>&.
11281
11282 .vitem &$qualify_domain$&
11283 .vindex "&$qualify_domain$&"
11284 The value set for the &%qualify_domain%& option in the configuration file.
11285
11286 .vitem &$qualify_recipient$&
11287 .vindex "&$qualify_recipient$&"
11288 The value set for the &%qualify_recipient%& option in the configuration file,
11289 or if not set, the value of &$qualify_domain$&.
11290
11291 .vitem &$rcpt_count$&
11292 .vindex "&$rcpt_count$&"
11293 When a message is being received by SMTP, this variable contains the number of
11294 RCPT commands received for the current message. If this variable is used in a
11295 RCPT ACL, its value includes the current command.
11296
11297 .vitem &$rcpt_defer_count$&
11298 .vindex "&$rcpt_defer_count$&"
11299 .cindex "4&'xx'& responses" "count of"
11300 When a message is being received by SMTP, this variable contains the number of
11301 RCPT commands in the current message that have previously been rejected with a
11302 temporary (4&'xx'&) response.
11303
11304 .vitem &$rcpt_fail_count$&
11305 .vindex "&$rcpt_fail_count$&"
11306 When a message is being received by SMTP, this variable contains the number of
11307 RCPT commands in the current message that have previously been rejected with a
11308 permanent (5&'xx'&) response.
11309
11310 .vitem &$received_count$&
11311 .vindex "&$received_count$&"
11312 This variable contains the number of &'Received:'& header lines in the message,
11313 including the one added by Exim (so its value is always greater than zero). It
11314 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11315 delivering.
11316
11317 .vitem &$received_for$&
11318 .vindex "&$received_for$&"
11319 If there is only a single recipient address in an incoming message, this
11320 variable contains that address when the &'Received:'& header line is being
11321 built. The value is copied after recipient rewriting has happened, but before
11322 the &[local_scan()]& function is run.
11323
11324 .vitem &$received_ip_address$&
11325 .vindex "&$received_ip_address$&"
11326 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11327 variable is set to the address of the local IP interface, and &$received_port$&
11328 is set to the local port number. (The remote IP address and port are in
11329 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11330 the port value is -1 unless it has been set using the &%-oMi%& command line
11331 option.
11332
11333 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11334 could be used, for example, to make the file name for a TLS certificate depend
11335 on which interface and/or port is being used for the incoming connection. The
11336 values of &$received_ip_address$& and &$received_port$& are saved with any
11337 messages that are received, thus making these variables available at delivery
11338 time.
11339
11340 &*Note:*& There are no equivalent variables for outgoing connections, because
11341 the values are unknown (unless they are explicitly set by options of the
11342 &(smtp)& transport).
11343
11344 .vitem &$received_port$&
11345 .vindex "&$received_port$&"
11346 See &$received_ip_address$&.
11347
11348 .vitem &$received_protocol$&
11349 .vindex "&$received_protocol$&"
11350 When a message is being processed, this variable contains the name of the
11351 protocol by which it was received. Most of the names used by Exim are defined
11352 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11353 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11354 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11355 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11356 connection and the client was successfully authenticated.
11357
11358 Exim uses the protocol name &"smtps"& for the case when encryption is
11359 automatically set up on connection without the use of STARTTLS (see
11360 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11361 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11362 where the client initially uses EHLO, sets up an encrypted connection using
11363 STARTTLS, and then uses HELO afterwards.
11364
11365 The &%-oMr%& option provides a way of specifying a custom protocol name for
11366 messages that are injected locally by trusted callers. This is commonly used to
11367 identify messages that are being re-injected after some kind of scanning.
11368
11369 .vitem &$received_time$&
11370 .vindex "&$received_time$&"
11371 This variable contains the date and time when the current message was received,
11372 as a number of seconds since the start of the Unix epoch.
11373
11374 .vitem &$recipient_data$&
11375 .vindex "&$recipient_data$&"
11376 This variable is set after an indexing lookup success in an ACL &%recipients%&
11377 condition. It contains the data from the lookup, and the value remains set
11378 until the next &%recipients%& test. Thus, you can do things like this:
11379 .display
11380 &`require recipients  = cdb*@;/some/file`&
11381 &`deny    `&&'some further test involving'& &`$recipient_data`&
11382 .endd
11383 &*Warning*&: This variable is set only when a lookup is used as an indexing
11384 method in the address list, using the semicolon syntax as in the example above.
11385 The variable is not set for a lookup that is used as part of the string
11386 expansion that all such lists undergo before being interpreted.
11387
11388 .vitem &$recipient_verify_failure$&
11389 .vindex "&$recipient_verify_failure$&"
11390 In an ACL, when a recipient verification fails, this variable contains
11391 information about the failure. It is set to one of the following words:
11392
11393 .ilist
11394 &"qualify"&: The address was unqualified (no domain), and the message
11395 was neither local nor came from an exempted host.
11396
11397 .next
11398 &"route"&: Routing failed.
11399
11400 .next
11401 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11402 or before the MAIL command (that is, on initial connection, HELO, or
11403 MAIL).
11404
11405 .next
11406 &"recipient"&: The RCPT command in a callout was rejected.
11407 .next
11408
11409 &"postmaster"&: The postmaster check in a callout was rejected.
11410 .endlist
11411
11412 The main use of this variable is expected to be to distinguish between
11413 rejections of MAIL and rejections of RCPT.
11414
11415 .vitem &$recipients$&
11416 .vindex "&$recipients$&"
11417 This variable contains a list of envelope recipients for a message. A comma and
11418 a space separate the addresses in the replacement text. However, the variable
11419 is not generally available, to prevent exposure of Bcc recipients in
11420 unprivileged users' filter files. You can use &$recipients$& only in these
11421 cases:
11422
11423 .olist
11424 In a system filter file.
11425 .next
11426 In the ACLs associated with the DATA command and with non-SMTP messages, that
11427 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11428 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11429 &%acl_not_smtp_mime%&.
11430 .next
11431 From within a &[local_scan()]& function.
11432 .endlist
11433
11434
11435 .vitem &$recipients_count$&
11436 .vindex "&$recipients_count$&"
11437 When a message is being processed, this variable contains the number of
11438 envelope recipients that came with the message. Duplicates are not excluded
11439 from the count. While a message is being received over SMTP, the number
11440 increases for each accepted recipient. It can be referenced in an ACL.
11441
11442
11443 .vitem &$regex_match_string$&
11444 .vindex "&$regex_match_string$&"
11445 This variable is set to contain the matching regular expression after a
11446 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11447
11448
11449 .vitem &$reply_address$&
11450 .vindex "&$reply_address$&"
11451 When a message is being processed, this variable contains the contents of the
11452 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11453 contents of the &'From:'& header line. Apart from the removal of leading
11454 white space, the value is not processed in any way. In particular, no RFC 2047
11455 decoding or character code translation takes place.
11456
11457 .vitem &$return_path$&
11458 .vindex "&$return_path$&"
11459 When a message is being delivered, this variable contains the return path &--
11460 the sender field that will be sent as part of the envelope. It is not enclosed
11461 in <> characters. At the start of routing an address, &$return_path$& has the
11462 same value as &$sender_address$&, but if, for example, an incoming message to a
11463 mailing list has been expanded by a router which specifies a different address
11464 for bounce messages, &$return_path$& subsequently contains the new bounce
11465 address, whereas &$sender_address$& always contains the original sender address
11466 that was received with the message. In other words, &$sender_address$& contains
11467 the incoming envelope sender, and &$return_path$& contains the outgoing
11468 envelope sender.
11469
11470 .vitem &$return_size_limit$&
11471 .vindex "&$return_size_limit$&"
11472 This is an obsolete name for &$bounce_return_size_limit$&.
11473
11474 .vitem &$runrc$&
11475 .cindex "return code" "from &%run%& expansion"
11476 .vindex "&$runrc$&"
11477 This variable contains the return code from a command that is run by the
11478 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11479 assume the order in which option values are expanded, except for those
11480 preconditions whose order of testing is documented. Therefore, you cannot
11481 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11482 another.
11483
11484 .vitem &$self_hostname$&
11485 .oindex "&%self%&" "value of host name"
11486 .vindex "&$self_hostname$&"
11487 When an address is routed to a supposedly remote host that turns out to be the
11488 local host, what happens is controlled by the &%self%& generic router option.
11489 One of its values causes the address to be passed to another router. When this
11490 happens, &$self_hostname$& is set to the name of the local host that the
11491 original router encountered. In other circumstances its contents are null.
11492
11493 .vitem &$sender_address$&
11494 .vindex "&$sender_address$&"
11495 When a message is being processed, this variable contains the sender's address
11496 that was received in the message's envelope. The case of letters in the address
11497 is retained, in both the local part and the domain. For bounce messages, the
11498 value of this variable is the empty string. See also &$return_path$&.
11499
11500 .vitem &$sender_address_data$&
11501 .vindex "&$address_data$&"
11502 .vindex "&$sender_address_data$&"
11503 If &$address_data$& is set when the routers are called from an ACL to verify a
11504 sender address, the final value is preserved in &$sender_address_data$&, to
11505 distinguish it from data from a recipient address. The value does not persist
11506 after the end of the current ACL statement. If you want to preserve it for
11507 longer, you can save it in an ACL variable.
11508
11509 .vitem &$sender_address_domain$&
11510 .vindex "&$sender_address_domain$&"
11511 The domain portion of &$sender_address$&.
11512
11513 .vitem &$sender_address_local_part$&
11514 .vindex "&$sender_address_local_part$&"
11515 The local part portion of &$sender_address$&.
11516
11517 .vitem &$sender_data$&
11518 .vindex "&$sender_data$&"
11519 This variable is set after a lookup success in an ACL &%senders%& condition or
11520 in a router &%senders%& option. It contains the data from the lookup, and the
11521 value remains set until the next &%senders%& test. Thus, you can do things like
11522 this:
11523 .display
11524 &`require senders      = cdb*@;/some/file`&
11525 &`deny    `&&'some further test involving'& &`$sender_data`&
11526 .endd
11527 &*Warning*&: This variable is set only when a lookup is used as an indexing
11528 method in the address list, using the semicolon syntax as in the example above.
11529 The variable is not set for a lookup that is used as part of the string
11530 expansion that all such lists undergo before being interpreted.
11531
11532 .vitem &$sender_fullhost$&
11533 .vindex "&$sender_fullhost$&"
11534 When a message is received from a remote host, this variable contains the host
11535 name and IP address in a single string. It ends with the IP address in square
11536 brackets, followed by a colon and a port number if the logging of ports is
11537 enabled. The format of the rest of the string depends on whether the host
11538 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11539 looking up its IP address. (Looking up the IP address can be forced by the
11540 &%host_lookup%& option, independent of verification.) A plain host name at the
11541 start of the string is a verified host name; if this is not present,
11542 verification either failed or was not requested. A host name in parentheses is
11543 the argument of a HELO or EHLO command. This is omitted if it is identical to
11544 the verified host name or to the host's IP address in square brackets.
11545
11546 .vitem &$sender_helo_name$&
11547 .vindex "&$sender_helo_name$&"
11548 When a message is received from a remote host that has issued a HELO or EHLO
11549 command, the argument of that command is placed in this variable. It is also
11550 set if HELO or EHLO is used when a message is received using SMTP locally via
11551 the &%-bs%& or &%-bS%& options.
11552
11553 .vitem &$sender_host_address$&
11554 .vindex "&$sender_host_address$&"
11555 When a message is received from a remote host, this variable contains that
11556 host's IP address. For locally submitted messages, it is empty.
11557
11558 .vitem &$sender_host_authenticated$&
11559 .vindex "&$sender_host_authenticated$&"
11560 This variable contains the name (not the public name) of the authenticator
11561 driver that successfully authenticated the client from which the message was
11562 received. It is empty if there was no successful authentication. See also
11563 &$authenticated_id$&.
11564
11565 .vitem &$sender_host_name$&
11566 .vindex "&$sender_host_name$&"
11567 When a message is received from a remote host, this variable contains the
11568 host's name as obtained by looking up its IP address. For messages received by
11569 other means, this variable is empty.
11570
11571 .vindex "&$host_lookup_failed$&"
11572 If the host name has not previously been looked up, a reference to
11573 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11574 A looked up name is accepted only if it leads back to the original IP address
11575 via a forward lookup. If either the reverse or the forward lookup fails to find
11576 any data, or if the forward lookup does not yield the original IP address,
11577 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11578
11579 .vindex "&$host_lookup_deferred$&"
11580 However, if either of the lookups cannot be completed (for example, there is a
11581 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11582 &$host_lookup_failed$& remains set to &"0"&.
11583
11584 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
11585 host name again if there is a subsequent reference to &$sender_host_name$&
11586 in the same Exim process, but it does try again if &$host_lookup_deferred$&
11587 is set to &"1"&.
11588
11589 Exim does not automatically look up every calling host's name. If you want
11590 maximum efficiency, you should arrange your configuration so that it avoids
11591 these lookups altogether. The lookup happens only if one or more of the
11592 following are true:
11593
11594 .ilist
11595 A string containing &$sender_host_name$& is expanded.
11596 .next
11597 The calling host matches the list in &%host_lookup%&. In the default
11598 configuration, this option is set to *, so it must be changed if lookups are
11599 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
11600 .next
11601 Exim needs the host name in order to test an item in a host list. The items
11602 that require this are described in sections &<<SECThoslispatnam>>& and
11603 &<<SECThoslispatnamsk>>&.
11604 .next
11605 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
11606 In this case, the host name is required to compare with the name quoted in any
11607 EHLO or HELO commands that the client issues.
11608 .next
11609 The remote host issues a EHLO or HELO command that quotes one of the
11610 domains in &%helo_lookup_domains%&. The default value of this option is
11611 . ==== As this is a nested list, any displays it contains must be indented
11612 . ==== as otherwise they are too far to the left.
11613 .code
11614   helo_lookup_domains = @ : @[]
11615 .endd
11616 which causes a lookup if a remote host (incorrectly) gives the server's name or
11617 IP address in an EHLO or HELO command.
11618 .endlist
11619
11620
11621 .vitem &$sender_host_port$&
11622 .vindex "&$sender_host_port$&"
11623 When a message is received from a remote host, this variable contains the port
11624 number that was used on the remote host.
11625
11626 .vitem &$sender_ident$&
11627 .vindex "&$sender_ident$&"
11628 When a message is received from a remote host, this variable contains the
11629 identification received in response to an RFC 1413 request. When a message has
11630 been received locally, this variable contains the login name of the user that
11631 called Exim.
11632
11633 .vitem &$sender_rate_$&&'xxx'&
11634 A number of variables whose names begin &$sender_rate_$& are set as part of the
11635 &%ratelimit%& ACL condition. Details are given in section
11636 &<<SECTratelimiting>>&.
11637
11638 .vitem &$sender_rcvhost$&
11639 .cindex "DNS" "reverse lookup"
11640 .cindex "reverse DNS lookup"
11641 .vindex "&$sender_rcvhost$&"
11642 This is provided specifically for use in &'Received:'& headers. It starts with
11643 either the verified host name (as obtained from a reverse DNS lookup) or, if
11644 there is no verified host name, the IP address in square brackets. After that
11645 there may be text in parentheses. When the first item is a verified host name,
11646 the first thing in the parentheses is the IP address in square brackets,
11647 followed by a colon and a port number if port logging is enabled. When the
11648 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
11649 the parentheses.
11650
11651 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
11652 was used and its argument was not identical to the real host name or IP
11653 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
11654 all three items are present in the parentheses, a newline and tab are inserted
11655 into the string, to improve the formatting of the &'Received:'& header.
11656
11657 .vitem &$sender_verify_failure$&
11658 .vindex "&$sender_verify_failure$&"
11659 In an ACL, when a sender verification fails, this variable contains information
11660 about the failure. The details are the same as for
11661 &$recipient_verify_failure$&.
11662
11663 .vitem &$sending_ip_address$&
11664 .vindex "&$sending_ip_address$&"
11665 This variable is set whenever an outgoing SMTP connection to another host has
11666 been set up. It contains the IP address of the local interface that is being
11667 used. This is useful if a host that has more than one IP address wants to take
11668 on different personalities depending on which one is being used. For incoming
11669 connections, see &$received_ip_address$&.
11670
11671 .vitem &$sending_port$&
11672 .vindex "&$sending_port$&"
11673 This variable is set whenever an outgoing SMTP connection to another host has
11674 been set up. It contains the local port that is being used. For incoming
11675 connections, see &$received_port$&.
11676
11677 .vitem &$smtp_active_hostname$&
11678 .vindex "&$smtp_active_hostname$&"
11679 During an incoming SMTP session, this variable contains the value of the active
11680 host name, as specified by the &%smtp_active_hostname%& option. The value of
11681 &$smtp_active_hostname$& is saved with any message that is received, so its
11682 value can be consulted during routing and delivery.
11683
11684 .vitem &$smtp_command$&
11685 .vindex "&$smtp_command$&"
11686 During the processing of an incoming SMTP command, this variable contains the
11687 entire command. This makes it possible to distinguish between HELO and EHLO in
11688 the HELO ACL, and also to distinguish between commands such as these:
11689 .code
11690 MAIL FROM:<>
11691 MAIL FROM: <>
11692 .endd
11693 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
11694 command, the address in &$smtp_command$& is the original address before any
11695 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
11696 the address after SMTP-time rewriting.
11697
11698 .vitem &$smtp_command_argument$&
11699 .cindex "SMTP" "command, argument for"
11700 .vindex "&$smtp_command_argument$&"
11701 While an ACL is running to check an SMTP command, this variable contains the
11702 argument, that is, the text that follows the command name, with leading white
11703 space removed. Following the introduction of &$smtp_command$&, this variable is
11704 somewhat redundant, but is retained for backwards compatibility.
11705
11706 .vitem &$smtp_count_at_connection_start$&
11707 .vindex "&$smtp_count_at_connection_start$&"
11708 This variable is set greater than zero only in processes spawned by the Exim
11709 daemon for handling incoming SMTP connections. The name is deliberately long,
11710 in order to emphasize what the contents are. When the daemon accepts a new
11711 connection, it increments this variable. A copy of the variable is passed to
11712 the child process that handles the connection, but its value is fixed, and
11713 never changes. It is only an approximation of how many incoming connections
11714 there actually are, because many other connections may come and go while a
11715 single connection is being processed. When a child process terminates, the
11716 daemon decrements its copy of the variable.
11717
11718 .vitem "&$sn0$& &-- &$sn9$&"
11719 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
11720 that were current at the end of the system filter file. This allows a system
11721 filter file to set values that can be tested in users' filter files. For
11722 example, a system filter could set a value indicating how likely it is that a
11723 message is junk mail.
11724
11725 .vitem &$spam_$&&'xxx'&
11726 A number of variables whose names start with &$spam$& are available when Exim
11727 is compiled with the content-scanning extension. For details, see section
11728 &<<SECTscanspamass>>&.
11729
11730
11731 .vitem &$spool_directory$&
11732 .vindex "&$spool_directory$&"
11733 The name of Exim's spool directory.
11734
11735 .vitem &$spool_inodes$&
11736 .vindex "&$spool_inodes$&"
11737 The number of free inodes in the disk partition where Exim's spool files are
11738 being written. The value is recalculated whenever the variable is referenced.
11739 If the relevant file system does not have the concept of inodes, the value of
11740 is -1. See also the &%check_spool_inodes%& option.
11741
11742 .vitem &$spool_space$&
11743 .vindex "&$spool_space$&"
11744 The amount of free space (as a number of kilobytes) in the disk partition where
11745 Exim's spool files are being written. The value is recalculated whenever the
11746 variable is referenced. If the operating system does not have the ability to
11747 find the amount of free space (only true for experimental systems), the space
11748 value is -1. For example, to check in an ACL that there is at least 50
11749 megabytes free on the spool, you could write:
11750 .code
11751 condition = ${if > {$spool_space}{50000}}
11752 .endd
11753 See also the &%check_spool_space%& option.
11754
11755
11756 .vitem &$thisaddress$&
11757 .vindex "&$thisaddress$&"
11758 This variable is set only during the processing of the &%foranyaddress%&
11759 command in a filter file. Its use is explained in the description of that
11760 command, which can be found in the separate document entitled &'Exim's
11761 interfaces to mail filtering'&.
11762
11763 .vitem &$tls_certificate_verified$&
11764 .vindex "&$tls_certificate_verified$&"
11765 This variable is set to &"1"& if a TLS certificate was verified when the
11766 message was received, and &"0"& otherwise.
11767
11768 .vitem &$tls_cipher$&
11769 .vindex "&$tls_cipher$&"
11770 When a message is received from a remote host over an encrypted SMTP
11771 connection, this variable is set to the cipher suite that was negotiated, for
11772 example DES-CBC3-SHA. In other circumstances, in particular, for message
11773 received over unencrypted connections, the variable is empty. Testing
11774 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
11775 non-encrypted connections during ACL processing.
11776
11777 The &$tls_cipher$& variable retains its value during message delivery, except
11778 when an outward SMTP delivery takes place via the &(smtp)& transport. In this
11779 case, &$tls_cipher$& is cleared before any outgoing SMTP connection is made,
11780 and then set to the outgoing cipher suite if one is negotiated. See chapter
11781 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
11782 details of the &(smtp)& transport.
11783
11784 .vitem &$tls_peerdn$&
11785 .vindex "&$tls_peerdn$&"
11786 When a message is received from a remote host over an encrypted SMTP
11787 connection, and Exim is configured to request a certificate from the client,
11788 the value of the Distinguished Name of the certificate is made available in the
11789 &$tls_peerdn$& during subsequent processing. Like &$tls_cipher$&, the
11790 value is retained during message delivery, except during outbound SMTP
11791 deliveries.
11792
11793 .vitem &$tod_bsdinbox$&
11794 .vindex "&$tod_bsdinbox$&"
11795 The time of day and the date, in the format required for BSD-style mailbox
11796 files, for example: Thu Oct 17 17:14:09 1995.
11797
11798 .vitem &$tod_epoch$&
11799 .vindex "&$tod_epoch$&"
11800 The time and date as a number of seconds since the start of the Unix epoch.
11801
11802 .vitem &$tod_full$&
11803 .vindex "&$tod_full$&"
11804 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
11805 +0100. The timezone is always given as a numerical offset from UTC, with
11806 positive values used for timezones that are ahead (east) of UTC, and negative
11807 values for those that are behind (west).
11808
11809 .vitem &$tod_log$&
11810 .vindex "&$tod_log$&"
11811 The time and date in the format used for writing Exim's log files, for example:
11812 1995-10-12 15:32:29, but without a timezone.
11813
11814 .vitem &$tod_logfile$&
11815 .vindex "&$tod_logfile$&"
11816 This variable contains the date in the format yyyymmdd. This is the format that
11817 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
11818 flag.
11819
11820 .vitem &$tod_zone$&
11821 .vindex "&$tod_zone$&"
11822 This variable contains the numerical value of the local timezone, for example:
11823 -0500.
11824
11825 .vitem &$tod_zulu$&
11826 .vindex "&$tod_zulu$&"
11827 This variable contains the UTC date and time in &"Zulu"& format, as specified
11828 by ISO 8601, for example: 20030221154023Z.
11829
11830 .vitem &$value$&
11831 .vindex "&$value$&"
11832 This variable contains the result of an expansion lookup, extraction operation,
11833 or external command, as described above. It is also used during a
11834 &*reduce*& expansion.
11835
11836 .vitem &$version_number$&
11837 .vindex "&$version_number$&"
11838 The version number of Exim.
11839
11840 .vitem &$warn_message_delay$&
11841 .vindex "&$warn_message_delay$&"
11842 This variable is set only during the creation of a message warning about a
11843 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11844
11845 .vitem &$warn_message_recipients$&
11846 .vindex "&$warn_message_recipients$&"
11847 This variable is set only during the creation of a message warning about a
11848 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11849 .endlist
11850 .ecindex IIDstrexp
11851
11852
11853
11854 . ////////////////////////////////////////////////////////////////////////////
11855 . ////////////////////////////////////////////////////////////////////////////
11856
11857 .chapter "Embedded Perl" "CHAPperl"
11858 .scindex IIDperl "Perl" "calling from Exim"
11859 Exim can be built to include an embedded Perl interpreter. When this is done,
11860 Perl subroutines can be called as part of the string expansion process. To make
11861 use of the Perl support, you need version 5.004 or later of Perl installed on
11862 your system. To include the embedded interpreter in the Exim binary, include
11863 the line
11864 .code
11865 EXIM_PERL = perl.o
11866 .endd
11867 in your &_Local/Makefile_& and then build Exim in the normal way.
11868
11869
11870 .section "Setting up so Perl can be used" "SECID85"
11871 .oindex "&%perl_startup%&"
11872 Access to Perl subroutines is via a global configuration option called
11873 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
11874 no &%perl_startup%& option in the Exim configuration file then no Perl
11875 interpreter is started and there is almost no overhead for Exim (since none of
11876 the Perl library will be paged in unless used). If there is a &%perl_startup%&
11877 option then the associated value is taken to be Perl code which is executed in
11878 a newly created Perl interpreter.
11879
11880 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
11881 need backslashes before any characters to escape special meanings. The option
11882 should usually be something like
11883 .code
11884 perl_startup = do '/etc/exim.pl'
11885 .endd
11886 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
11887 use from Exim. Exim can be configured either to start up a Perl interpreter as
11888 soon as it is entered, or to wait until the first time it is needed. Starting
11889 the interpreter at the beginning ensures that it is done while Exim still has
11890 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
11891 fact used in a particular run. Also, note that this does not mean that Exim is
11892 necessarily running as root when Perl is called at a later time. By default,
11893 the interpreter is started only when it is needed, but this can be changed in
11894 two ways:
11895
11896 .ilist
11897 .oindex "&%perl_at_start%&"
11898 Setting &%perl_at_start%& (a boolean option) in the configuration requests
11899 a startup when Exim is entered.
11900 .next
11901 The command line option &%-ps%& also requests a startup when Exim is entered,
11902 overriding the setting of &%perl_at_start%&.
11903 .endlist
11904
11905 There is also a command line option &%-pd%& (for delay) which suppresses the
11906 initial startup, even if &%perl_at_start%& is set.
11907
11908
11909 .section "Calling Perl subroutines" "SECID86"
11910 When the configuration file includes a &%perl_startup%& option you can make use
11911 of the string expansion item to call the Perl subroutines that are defined
11912 by the &%perl_startup%& code. The operator is used in any of the following
11913 forms:
11914 .code
11915 ${perl{foo}}
11916 ${perl{foo}{argument}}
11917 ${perl{foo}{argument1}{argument2} ... }
11918 .endd
11919 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
11920 arguments may be passed. Passing more than this results in an expansion failure
11921 with an error message of the form
11922 .code
11923 Too many arguments passed to Perl subroutine "foo" (max is 8)
11924 .endd
11925 The return value of the Perl subroutine is evaluated in a scalar context before
11926 it is passed back to Exim to be inserted into the expanded string. If the
11927 return value is &'undef'&, the expansion is forced to fail in the same way as
11928 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
11929 by obeying Perl's &%die%& function, the expansion fails with the error message
11930 that was passed to &%die%&.
11931
11932
11933 .section "Calling Exim functions from Perl" "SECID87"
11934 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
11935 is available to call back into Exim's string expansion function. For example,
11936 the Perl code
11937 .code
11938 my $lp = Exim::expand_string('$local_part');
11939 .endd
11940 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
11941 Note those are single quotes and not double quotes to protect against
11942 &$local_part$& being interpolated as a Perl variable.
11943
11944 If the string expansion is forced to fail by a &"fail"& item, the result of
11945 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
11946 expansion string, the Perl call from the original expansion string fails with
11947 an appropriate error message, in the same way as if &%die%& were used.
11948
11949 .cindex "debugging" "from embedded Perl"
11950 .cindex "log" "writing from embedded Perl"
11951 Two other Exim functions are available for use from within Perl code.
11952 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
11953 debugging is enabled. If you want a newline at the end, you must supply it.
11954 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
11955 timestamp. In this case, you should not supply a terminating newline.
11956
11957
11958 .section "Use of standard output and error by Perl" "SECID88"
11959 .cindex "Perl" "standard output and error"
11960 You should not write to the standard error or output streams from within your
11961 Perl code, as it is not defined how these are set up. In versions of Exim
11962 before 4.50, it is possible for the standard output or error to refer to the
11963 SMTP connection during message reception via the daemon. Writing to this stream
11964 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
11965 error streams are connected to &_/dev/null_& in the daemon. The chaos is
11966 avoided, but the output is lost.
11967
11968 .cindex "Perl" "use of &%warn%&"
11969 The Perl &%warn%& statement writes to the standard error stream by default.
11970 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
11971 you have no control. When Exim starts up the Perl interpreter, it arranges for
11972 output from the &%warn%& statement to be written to the Exim main log. You can
11973 change this by including appropriate Perl magic somewhere in your Perl code.
11974 For example, to discard &%warn%& output completely, you need this:
11975 .code
11976 $SIG{__WARN__} = sub { };
11977 .endd
11978 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
11979 example, the code for the subroutine is empty, so it does nothing, but you can
11980 include any Perl code that you like. The text of the &%warn%& message is passed
11981 as the first subroutine argument.
11982 .ecindex IIDperl
11983
11984
11985 . ////////////////////////////////////////////////////////////////////////////
11986 . ////////////////////////////////////////////////////////////////////////////
11987
11988 .chapter "Starting the daemon and the use of network interfaces" &&&
11989          "CHAPinterfaces" &&&
11990          "Starting the daemon"
11991 .cindex "daemon" "starting"
11992 .cindex "interface" "listening"
11993 .cindex "network interface"
11994 .cindex "interface" "network"
11995 .cindex "IP address" "for listening"
11996 .cindex "daemon" "listening IP addresses"
11997 .cindex "TCP/IP" "setting listening interfaces"
11998 .cindex "TCP/IP" "setting listening ports"
11999 A host that is connected to a TCP/IP network may have one or more physical
12000 hardware network interfaces. Each of these interfaces may be configured as one
12001 or more &"logical"& interfaces, which are the entities that a program actually
12002 works with. Each of these logical interfaces is associated with an IP address.
12003 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12004 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12005 knowledge about the host's interfaces for use in three different circumstances:
12006
12007 .olist
12008 When a listening daemon is started, Exim needs to know which interfaces
12009 and ports to listen on.
12010 .next
12011 When Exim is routing an address, it needs to know which IP addresses
12012 are associated with local interfaces. This is required for the correct
12013 processing of MX lists by removing the local host and others with the
12014 same or higher priority values. Also, Exim needs to detect cases
12015 when an address is routed to an IP address that in fact belongs to the
12016 local host. Unless the &%self%& router option or the &%allow_localhost%&
12017 option of the smtp transport is set (as appropriate), this is treated
12018 as an error situation.
12019 .next
12020 When Exim connects to a remote host, it may need to know which interface to use
12021 for the outgoing connection.
12022 .endlist
12023
12024
12025 Exim's default behaviour is likely to be appropriate in the vast majority
12026 of cases. If your host has only one interface, and you want all its IP
12027 addresses to be treated in the same way, and you are using only the
12028 standard SMTP port, you should not need to take any special action. The
12029 rest of this chapter does not apply to you.
12030
12031 In a more complicated situation you may want to listen only on certain
12032 interfaces, or on different ports, and for this reason there are a number of
12033 options that can be used to influence Exim's behaviour. The rest of this
12034 chapter describes how they operate.
12035
12036 When a message is received over TCP/IP, the interface and port that were
12037 actually used are set in &$received_ip_address$& and &$received_port$&.
12038
12039
12040
12041 .section "Starting a listening daemon" "SECID89"
12042 When a listening daemon is started (by means of the &%-bd%& command line
12043 option), the interfaces and ports on which it listens are controlled by the
12044 following options:
12045
12046 .ilist
12047 &%daemon_smtp_ports%& contains a list of default ports. (For backward
12048 compatibility, this option can also be specified in the singular.)
12049 .next
12050 &%local_interfaces%& contains list of interface IP addresses on which to
12051 listen. Each item may optionally also specify a port.
12052 .endlist
12053
12054 The default list separator in both cases is a colon, but this can be changed as
12055 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12056 it is usually best to change the separator to avoid having to double all the
12057 colons. For example:
12058 .code
12059 local_interfaces = <; 127.0.0.1 ; \
12060                       192.168.23.65 ; \
12061                       ::1 ; \
12062                       3ffe:ffff:836f::fe86:a061
12063 .endd
12064 There are two different formats for specifying a port along with an IP address
12065 in &%local_interfaces%&:
12066
12067 .olist
12068 The port is added onto the address with a dot separator. For example, to listen
12069 on port 1234 on two different IP addresses:
12070 .code
12071 local_interfaces = <; 192.168.23.65.1234 ; \
12072                       3ffe:ffff:836f::fe86:a061.1234
12073 .endd
12074 .next
12075 The IP address is enclosed in square brackets, and the port is added
12076 with a colon separator, for example:
12077 .code
12078 local_interfaces = <; [192.168.23.65]:1234 ; \
12079                       [3ffe:ffff:836f::fe86:a061]:1234
12080 .endd
12081 .endlist
12082
12083 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12084 default setting contains just one port:
12085 .code
12086 daemon_smtp_ports = smtp
12087 .endd
12088 If more than one port is listed, each interface that does not have its own port
12089 specified listens on all of them. Ports that are listed in
12090 &%daemon_smtp_ports%& can be identified either by name (defined in
12091 &_/etc/services_&) or by number. However, when ports are given with individual
12092 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12093
12094
12095
12096 .section "Special IP listening addresses" "SECID90"
12097 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12098 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12099 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12100 instead of setting up separate listening sockets for each interface. The
12101 default value of &%local_interfaces%& is
12102 .code
12103 local_interfaces = 0.0.0.0
12104 .endd
12105 when Exim is built without IPv6 support; otherwise it is:
12106 .code
12107 local_interfaces = <; ::0 ; 0.0.0.0
12108 .endd
12109 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12110
12111
12112
12113 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12114 The &%-oX%& command line option can be used to override the values of
12115 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12116 instance. Another way of doing this would be to use macros and the &%-D%&
12117 option. However, &%-oX%& can be used by any admin user, whereas modification of
12118 the runtime configuration by &%-D%& is allowed only when the caller is root or
12119 exim.
12120
12121 The value of &%-oX%& is a list of items. The default colon separator can be
12122 changed in the usual way if required. If there are any items that do not
12123 contain dots or colons (that is, are not IP addresses), the value of
12124 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12125 items that do contain dots or colons, the value of &%local_interfaces%& is
12126 replaced by those items. Thus, for example,
12127 .code
12128 -oX 1225
12129 .endd
12130 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12131 whereas
12132 .code
12133 -oX 192.168.34.5.1125
12134 .endd
12135 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12136 (However, since &%local_interfaces%& now contains no items without ports, the
12137 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12138
12139
12140
12141 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12142 .cindex "ssmtp protocol"
12143 .cindex "smtps protocol"
12144 .cindex "SMTP" "ssmtp protocol"
12145 .cindex "SMTP" "smtps protocol"
12146 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12147 before the STARTTLS command was standardized for SMTP. Some legacy clients
12148 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12149 list of port numbers, connections to those ports must use SSMTP. The most
12150 common use of this option is expected to be
12151 .code
12152 tls_on_connect_ports = 465
12153 .endd
12154 because 465 is the usual port number used by the legacy clients. There is also
12155 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12156 this way when a daemon is started.
12157
12158 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12159 daemon to listen on those ports. You must still specify them in
12160 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12161 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12162 connections via the daemon.)
12163
12164
12165
12166
12167 .section "IPv6 address scopes" "SECID92"
12168 .cindex "IPv6" "address scopes"
12169 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12170 can, in principle, have the same link-local IPv6 address on different
12171 interfaces. Thus, additional information is needed, over and above the IP
12172 address, to distinguish individual interfaces. A convention of using a
12173 percent sign followed by something (often the interface name) has been
12174 adopted in some cases, leading to addresses like this:
12175 .code
12176 fe80::202:b3ff:fe03:45c1%eth0
12177 .endd
12178 To accommodate this usage, a percent sign followed by an arbitrary string is
12179 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12180 to convert a textual IPv6 address for actual use. This function recognizes the
12181 percent convention in operating systems that support it, and it processes the
12182 address appropriately. Unfortunately, some older libraries have problems with
12183 &[getaddrinfo()]&. If
12184 .code
12185 IPV6_USE_INET_PTON=yes
12186 .endd
12187 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12188 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12189 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12190 function.) Of course, this means that the additional functionality of
12191 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12192
12193 .section "Disabling IPv6" "SECID93"
12194 .cindex "IPv6" "disabling"
12195 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12196 run on a host whose kernel does not support IPv6. The binary will fall back to
12197 using IPv4, but it may waste resources looking up AAAA records, and trying to
12198 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12199 .oindex "&%disable_ipv6%&"
12200 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12201 activities take place. AAAA records are never looked up, and any IPv6 addresses
12202 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12203 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12204 to handle IPv6 literal addresses.
12205
12206 On the other hand, when IPv6 is in use, there may be times when you want to
12207 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12208 option to globally suppress the lookup of AAAA records for specified domains,
12209 and you can use the &%ignore_target_hosts%& generic router option to ignore
12210 IPv6 addresses in an individual router.
12211
12212
12213
12214 .section "Examples of starting a listening daemon" "SECID94"
12215 The default case in an IPv6 environment is
12216 .code
12217 daemon_smtp_ports = smtp
12218 local_interfaces = <; ::0 ; 0.0.0.0
12219 .endd
12220 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12221 Either one or two sockets may be used, depending on the characteristics of
12222 the TCP/IP stack. (This is complicated and messy; for more information,
12223 read the comments in the &_daemon.c_& source file.)
12224
12225 To specify listening on ports 25 and 26 on all interfaces:
12226 .code
12227 daemon_smtp_ports = 25 : 26
12228 .endd
12229 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12230 .code
12231 local_interfaces = <; ::0.25     ; ::0.26 \
12232                       0.0.0.0.25 ; 0.0.0.0.26
12233 .endd
12234 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12235 IPv4 loopback address only:
12236 .code
12237 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12238 .endd
12239 To specify listening on the default port on specific interfaces only:
12240 .code
12241 local_interfaces = 192.168.34.67 : 192.168.34.67
12242 .endd
12243 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12244
12245
12246
12247 .section "Recognizing the local host" "SECTreclocipadd"
12248 The &%local_interfaces%& option is also used when Exim needs to determine
12249 whether or not an IP address refers to the local host. That is, the IP
12250 addresses of all the interfaces on which a daemon is listening are always
12251 treated as local.
12252
12253 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12254 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12255 available interfaces from the operating system, and extracts the relevant
12256 (that is, IPv4 or IPv6) addresses to use for checking.
12257
12258 Some systems set up large numbers of virtual interfaces in order to provide
12259 many virtual web servers. In this situation, you may want to listen for
12260 email on only a few of the available interfaces, but nevertheless treat all
12261 interfaces as local when routing. You can do this by setting
12262 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12263 &"all"& wildcard values. These addresses are recognized as local, but are not
12264 used for listening. Consider this example:
12265 .code
12266 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12267                       192.168.53.235 ; \
12268                       3ffe:2101:12:1:a00:20ff:fe86:a061
12269
12270 extra_local_interfaces = <; ::0 ; 0.0.0.0
12271 .endd
12272 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12273 address, but all available interface addresses are treated as local when
12274 Exim is routing.
12275
12276 In some environments the local host name may be in an MX list, but with an IP
12277 address that is not assigned to any local interface. In other cases it may be
12278 desirable to treat other host names as if they referred to the local host. Both
12279 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12280 This contains host names rather than IP addresses. When a host is referenced
12281 during routing, either via an MX record or directly, it is treated as the local
12282 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12283 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12284
12285
12286
12287 .section "Delivering to a remote host" "SECID95"
12288 Delivery to a remote host is handled by the smtp transport. By default, it
12289 allows the system's TCP/IP functions to choose which interface to use (if
12290 there is more than one) when connecting to a remote host. However, the
12291 &%interface%& option can be set to specify which interface is used. See the
12292 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12293 details.
12294
12295
12296
12297
12298 . ////////////////////////////////////////////////////////////////////////////
12299 . ////////////////////////////////////////////////////////////////////////////
12300
12301 .chapter "Main configuration" "CHAPmainconfig"
12302 .scindex IIDconfima "configuration file" "main section"
12303 .scindex IIDmaiconf "main configuration"
12304 The first part of the run time configuration file contains three types of item:
12305
12306 .ilist
12307 Macro definitions: These lines start with an upper case letter. See section
12308 &<<SECTmacrodefs>>& for details of macro processing.
12309 .next
12310 Named list definitions: These lines start with one of the words &"domainlist"&,
12311 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12312 section &<<SECTnamedlists>>&.
12313 .next
12314 Main configuration settings: Each setting occupies one line of the file
12315 (with possible continuations). If any setting is preceded by the word
12316 &"hide"&, the &%-bP%& command line option displays its value to admin users
12317 only. See section &<<SECTcos>>& for a description of the syntax of these option
12318 settings.
12319 .endlist
12320
12321 This chapter specifies all the main configuration options, along with their
12322 types and default values. For ease of finding a particular option, they appear
12323 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12324 are now so many options, they are first listed briefly in functional groups, as
12325 an aid to finding the name of the option you are looking for. Some options are
12326 listed in more than one group.
12327
12328 .section "Miscellaneous" "SECID96"
12329 .table2
12330 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12331 .row &%disable_ipv6%&                "do no IPv6 processing"
12332 .row &%keep_malformed%&              "for broken files &-- should not happen"
12333 .row &%localhost_number%&            "for unique message ids in clusters"
12334 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12335 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12336 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12337 .row &%print_topbitchars%&           "top-bit characters are printing"
12338 .row &%timezone%&                    "force time zone"
12339 .endtable
12340
12341
12342 .section "Exim parameters" "SECID97"
12343 .table2
12344 .row &%exim_group%&                  "override compiled-in value"
12345 .row &%exim_path%&                   "override compiled-in value"
12346 .row &%exim_user%&                   "override compiled-in value"
12347 .row &%primary_hostname%&            "default from &[uname()]&"
12348 .row &%split_spool_directory%&       "use multiple directories"
12349 .row &%spool_directory%&             "override compiled-in value"
12350 .endtable
12351
12352
12353
12354 .section "Privilege controls" "SECID98"
12355 .table2
12356 .row &%admin_groups%&                "groups that are Exim admin users"
12357 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12358 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12359 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12360 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12361 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12362 .row &%never_users%&                 "do not run deliveries as these"
12363 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12364 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12365 .row &%trusted_groups%&              "groups that are trusted"
12366 .row &%trusted_users%&               "users that are trusted"
12367 .endtable
12368
12369
12370
12371 .section "Logging" "SECID99"
12372 .table2
12373 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12374 .row &%log_file_path%&               "override compiled-in value"
12375 .row &%log_selector%&                "set/unset optional logging"
12376 .row &%log_timezone%&                "add timezone to log lines"
12377 .row &%message_logs%&                "create per-message logs"
12378 .row &%preserve_message_logs%&       "after message completion"
12379 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12380 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12381 .row &%syslog_facility%&             "set syslog &""facility""& field"
12382 .row &%syslog_processname%&          "set syslog &""ident""& field"
12383 .row &%syslog_timestamp%&            "timestamp syslog lines"
12384 .row &%write_rejectlog%&             "control use of message log"
12385 .endtable
12386
12387
12388
12389 .section "Frozen messages" "SECID100"
12390 .table2
12391 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12392 .row &%freeze_tell%&                 "send message when freezing"
12393 .row &%move_frozen_messages%&        "to another directory"
12394 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12395 .endtable
12396
12397
12398
12399 .section "Data lookups" "SECID101"
12400 .table2
12401 .row &%ibase_servers%&               "InterBase servers"
12402 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
12403 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
12404 .row &%ldap_cert_file%&              "client cert file for LDAP"
12405 .row &%ldap_cert_key%&               "client key file for LDAP"
12406 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
12407 .row &%ldap_default_servers%&        "used if no server in query"
12408 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
12409 .row &%ldap_start_tls%&              "require TLS within LDAP"
12410 .row &%ldap_version%&                "set protocol version"
12411 .row &%lookup_open_max%&             "lookup files held open"
12412 .row &%mysql_servers%&               "default MySQL servers"
12413 .row &%oracle_servers%&              "Oracle servers"
12414 .row &%pgsql_servers%&               "default PostgreSQL servers"
12415 .row &%sqlite_lock_timeout%&         "as it says"
12416 .endtable
12417
12418
12419
12420 .section "Message ids" "SECID102"
12421 .table2
12422 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12423 .row &%message_id_header_text%&      "ditto"
12424 .endtable
12425
12426
12427
12428 .section "Embedded Perl Startup" "SECID103"
12429 .table2
12430 .row &%perl_at_start%&               "always start the interpreter"
12431 .row &%perl_startup%&                "code to obey when starting Perl"
12432 .endtable
12433
12434
12435
12436 .section "Daemon" "SECID104"
12437 .table2
12438 .row &%daemon_smtp_ports%&           "default ports"
12439 .row &%daemon_startup_retries%&      "number of times to retry"
12440 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12441 .row &%extra_local_interfaces%&      "not necessarily listened on"
12442 .row &%local_interfaces%&            "on which to listen, with optional ports"
12443 .row &%pid_file_path%&               "override compiled-in value"
12444 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12445 .endtable
12446
12447
12448
12449 .section "Resource control" "SECID105"
12450 .table2
12451 .row &%check_log_inodes%&            "before accepting a message"
12452 .row &%check_log_space%&             "before accepting a message"
12453 .row &%check_spool_inodes%&          "before accepting a message"
12454 .row &%check_spool_space%&           "before accepting a message"
12455 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12456 .row &%queue_only_load%&             "queue incoming if load high"
12457 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12458 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12459 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12460 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12461 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12462 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12463 .row &%smtp_accept_max_per_connection%& "messages per connection"
12464 .row &%smtp_accept_max_per_host%&    "connections from one host"
12465 .row &%smtp_accept_queue%&           "queue mail if more connections"
12466 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12467                                            connection"
12468 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12469 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12470 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12471 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12472 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12473 .endtable
12474
12475
12476
12477 .section "Policy controls" "SECID106"
12478 .table2
12479 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12480 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12481 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12482 .row &%acl_smtp_auth%&               "ACL for AUTH"
12483 .row &%acl_smtp_connect%&            "ACL for connection"
12484 .row &%acl_smtp_data%&               "ACL for DATA"
12485 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12486 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12487 .row &%acl_smtp_expn%&               "ACL for EXPN"
12488 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12489 .row &%acl_smtp_mail%&               "ACL for MAIL"
12490 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12491 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12492 .row &%acl_smtp_predata%&            "ACL for start of data"
12493 .row &%acl_smtp_quit%&               "ACL for QUIT"
12494 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12495 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
12496 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
12497 .row &%av_scanner%&                  "specify virus scanner"
12498 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12499                                       words""&"
12500 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
12501 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
12502 .row &%header_maxsize%&              "total size of message header"
12503 .row &%header_line_maxsize%&         "individual header line limit"
12504 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
12505 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
12506 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
12507 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
12508 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
12509 .row &%host_lookup%&                 "host name looked up for these hosts"
12510 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12511 .row &%host_reject_connection%&      "reject connection from these hosts"
12512 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
12513 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
12514 .row &%message_size_limit%&          "for all messages"
12515 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12516 .row &%spamd_address%&               "set interface to SpamAssassin"
12517 .row &%strict_acl_vars%&             "object to unset ACL variables"
12518 .endtable
12519
12520
12521
12522 .section "Callout cache" "SECID107"
12523 .table2
12524 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
12525                                          item"
12526 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
12527                                          item"
12528 .row &%callout_negative_expire%&     "timeout for negative address cache item"
12529 .row &%callout_positive_expire%&     "timeout for positive address cache item"
12530 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
12531 .endtable
12532
12533
12534
12535 .section "TLS" "SECID108"
12536 .table2
12537 .row &%gnutls_require_kx%&           "control GnuTLS key exchanges"
12538 .row &%gnutls_require_mac%&          "control GnuTLS MAC algorithms"
12539 .row &%gnutls_require_protocols%&    "control GnuTLS protocols"
12540 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
12541 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
12542 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12543 .row &%tls_certificate%&             "location of server certificate"
12544 .row &%tls_crl%&                     "certificate revocation list"
12545 .row &%tls_dhparam%&                 "DH parameters for server"
12546 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
12547 .row &%tls_privatekey%&              "location of server private key"
12548 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
12549 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
12550 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
12551 .row &%tls_verify_certificates%&     "expected client certificates"
12552 .row &%tls_verify_hosts%&            "insist on client certificate verify"
12553 .endtable
12554
12555
12556
12557 .section "Local user handling" "SECID109"
12558 .table2
12559 .row &%finduser_retries%&            "useful in NIS environments"
12560 .row &%gecos_name%&                  "used when creating &'Sender:'&"
12561 .row &%gecos_pattern%&               "ditto"
12562 .row &%max_username_length%&         "for systems that truncate"
12563 .row &%unknown_login%&               "used when no login name found"
12564 .row &%unknown_username%&            "ditto"
12565 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
12566 .row &%uucp_from_sender%&            "ditto"
12567 .endtable
12568
12569
12570
12571 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
12572 .table2
12573 .row &%header_maxsize%&              "total size of message header"
12574 .row &%header_line_maxsize%&         "individual header line limit"
12575 .row &%message_size_limit%&          "applies to all messages"
12576 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12577 .row &%received_header_text%&        "expanded to make &'Received:'&"
12578 .row &%received_headers_max%&        "for mail loop detection"
12579 .row &%recipients_max%&              "limit per message"
12580 .row &%recipients_max_reject%&       "permanently reject excess recipients"
12581 .endtable
12582
12583
12584
12585
12586 .section "Non-SMTP incoming messages" "SECID111"
12587 .table2
12588 .row &%receive_timeout%&             "for non-SMTP messages"
12589 .endtable
12590
12591
12592
12593
12594
12595 .section "Incoming SMTP messages" "SECID112"
12596 See also the &'Policy controls'& section above.
12597
12598 .table2
12599 .row &%host_lookup%&                 "host name looked up for these hosts"
12600 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12601 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
12602 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
12603 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
12604 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
12605 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
12606 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12607 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12608 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12609 .row &%smtp_accept_max_per_connection%& "messages per connection"
12610 .row &%smtp_accept_max_per_host%&    "connections from one host"
12611 .row &%smtp_accept_queue%&           "queue mail if more connections"
12612 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12613                                            connection"
12614 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12615 .row &%smtp_active_hostname%&        "host name to use in messages"
12616 .row &%smtp_banner%&                 "text for welcome banner"
12617 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12618 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12619 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
12620 .row &%smtp_etrn_command%&           "what to run for ETRN"
12621 .row &%smtp_etrn_serialize%&         "only one at once"
12622 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
12623 .row &%smtp_max_unknown_commands%&   "before dropping connection"
12624 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
12625 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
12626 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
12627 .row &%smtp_receive_timeout%&        "per command or data line"
12628 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12629 .row &%smtp_return_error_details%&   "give detail on rejections"
12630 .endtable
12631
12632
12633
12634 .section "SMTP extensions" "SECID113"
12635 .table2
12636 .row &%accept_8bitmime%&             "advertise 8BITMIME"
12637 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
12638 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
12639 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
12640 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
12641 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12642 .endtable
12643
12644
12645
12646 .section "Processing messages" "SECID114"
12647 .table2
12648 .row &%allow_domain_literals%&       "recognize domain literal syntax"
12649 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
12650 .row &%allow_utf8_domains%&          "in addresses"
12651 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12652                                       words""&"
12653 .row &%delivery_date_remove%&        "from incoming messages"
12654 .row &%envelope_to_remove%&          "from incoming messages"
12655 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
12656 .row &%headers_charset%&             "default for translations"
12657 .row &%qualify_domain%&              "default for senders"
12658 .row &%qualify_recipient%&           "default for recipients"
12659 .row &%return_path_remove%&          "from incoming messages"
12660 .row &%strip_excess_angle_brackets%& "in addresses"
12661 .row &%strip_trailing_dot%&          "at end of addresses"
12662 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
12663 .endtable
12664
12665
12666
12667 .section "System filter" "SECID115"
12668 .table2
12669 .row &%system_filter%&               "locate system filter"
12670 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
12671                                             directory"
12672 .row &%system_filter_file_transport%& "transport for delivery to a file"
12673 .row &%system_filter_group%&         "group for filter running"
12674 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
12675 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
12676 .row &%system_filter_user%&          "user for filter running"
12677 .endtable
12678
12679
12680
12681 .section "Routing and delivery" "SECID116"
12682 .table2
12683 .row &%disable_ipv6%&                "do no IPv6 processing"
12684 .row &%dns_again_means_nonexist%&    "for broken domains"
12685 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
12686 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
12687 .row &%dns_retrans%&                 "parameter for resolver"
12688 .row &%dns_retry%&                   "parameter for resolver"
12689 .row &%hold_domains%&                "hold delivery for these domains"
12690 .row &%local_interfaces%&            "for routing checks"
12691 .row &%queue_domains%&               "no immediate delivery for these"
12692 .row &%queue_only%&                  "no immediate delivery at all"
12693 .row &%queue_only_file%&             "no immediate delivery if file exists"
12694 .row &%queue_only_load%&             "no immediate delivery if load is high"
12695 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12696 .row &%queue_only_override%&         "allow command line to override"
12697 .row &%queue_run_in_order%&          "order of arrival"
12698 .row &%queue_run_max%&               "of simultaneous queue runners"
12699 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
12700 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12701 .row &%remote_sort_domains%&         "order of remote deliveries"
12702 .row &%retry_data_expire%&           "timeout for retry data"
12703 .row &%retry_interval_max%&          "safety net for retry rules"
12704 .endtable
12705
12706
12707
12708 .section "Bounce and warning messages" "SECID117"
12709 .table2
12710 .row &%bounce_message_file%&         "content of bounce"
12711 .row &%bounce_message_text%&         "content of bounce"
12712 .row &%bounce_return_body%&          "include body if returning message"
12713 .row &%bounce_return_message%&       "include original message in bounce"
12714 .row &%bounce_return_size_limit%&    "limit on returned message"
12715 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
12716 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
12717 .row &%errors_copy%&                 "copy bounce messages"
12718 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
12719 .row &%delay_warning%&               "time schedule"
12720 .row &%delay_warning_condition%&     "condition for warning messages"
12721 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
12722 .row &%smtp_return_error_details%&   "give detail on rejections"
12723 .row &%warn_message_file%&           "content of warning message"
12724 .endtable
12725
12726
12727
12728 .section "Alphabetical list of main options" "SECTalomo"
12729 Those options that undergo string expansion before use are marked with
12730 &dagger;.
12731
12732 .option accept_8bitmime main boolean false
12733 .cindex "8BITMIME"
12734 .cindex "8-bit characters"
12735 This option causes Exim to send 8BITMIME in its response to an SMTP
12736 EHLO command, and to accept the BODY= parameter on MAIL commands.
12737 However, though Exim is 8-bit clean, it is not a protocol converter, and it
12738 takes no steps to do anything special with messages received by this route.
12739 Consequently, this option is turned off by default.
12740
12741 .option acl_not_smtp main string&!! unset
12742 .cindex "&ACL;" "for non-SMTP messages"
12743 .cindex "non-SMTP messages" "ACLs for"
12744 This option defines the ACL that is run when a non-SMTP message has been
12745 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
12746 further details.
12747
12748 .option acl_not_smtp_mime main string&!! unset
12749 This option defines the ACL that is run for individual MIME parts of non-SMTP
12750 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
12751 SMTP messages.
12752
12753 .option acl_not_smtp_start main string&!! unset
12754 .cindex "&ACL;" "at start of non-SMTP message"
12755 .cindex "non-SMTP messages" "ACLs for"
12756 This option defines the ACL that is run before Exim starts reading a
12757 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
12758
12759 .option acl_smtp_auth main string&!! unset
12760 .cindex "&ACL;" "setting up for SMTP commands"
12761 .cindex "AUTH" "ACL for"
12762 This option defines the ACL that is run when an SMTP AUTH command is
12763 received. See chapter &<<CHAPACL>>& for further details.
12764
12765 .option acl_smtp_connect main string&!! unset
12766 .cindex "&ACL;" "on SMTP connection"
12767 This option defines the ACL that is run when an SMTP connection is received.
12768 See chapter &<<CHAPACL>>& for further details.
12769
12770 .option acl_smtp_data main string&!! unset
12771 .cindex "DATA" "ACL for"
12772 This option defines the ACL that is run after an SMTP DATA command has been
12773 processed and the message itself has been received, but before the final
12774 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
12775
12776 .option acl_smtp_etrn main string&!! unset
12777 .cindex "ETRN" "ACL for"
12778 This option defines the ACL that is run when an SMTP ETRN command is
12779 received. See chapter &<<CHAPACL>>& for further details.
12780
12781 .option acl_smtp_expn main string&!! unset
12782 .cindex "EXPN" "ACL for"
12783 This option defines the ACL that is run when an SMTP EXPN command is
12784 received. See chapter &<<CHAPACL>>& for further details.
12785
12786 .option acl_smtp_helo main string&!! unset
12787 .cindex "EHLO" "ACL for"
12788 .cindex "HELO" "ACL for"
12789 This option defines the ACL that is run when an SMTP EHLO or HELO
12790 command is received. See chapter &<<CHAPACL>>& for further details.
12791
12792
12793 .option acl_smtp_mail main string&!! unset
12794 .cindex "MAIL" "ACL for"
12795 This option defines the ACL that is run when an SMTP MAIL command is
12796 received. See chapter &<<CHAPACL>>& for further details.
12797
12798 .option acl_smtp_mailauth main string&!! unset
12799 .cindex "AUTH" "on MAIL command"
12800 This option defines the ACL that is run when there is an AUTH parameter on
12801 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
12802 &<<CHAPSMTPAUTH>>& for details of authentication.
12803
12804 .option acl_smtp_mime main string&!! unset
12805 .cindex "MIME content scanning" "ACL for"
12806 This option is available when Exim is built with the content-scanning
12807 extension. It defines the ACL that is run for each MIME part in a message. See
12808 section &<<SECTscanmimepart>>& for details.
12809
12810 .option acl_smtp_predata main string&!! unset
12811 This option defines the ACL that is run when an SMTP DATA command is
12812 received, before the message itself is received. See chapter &<<CHAPACL>>& for
12813 further details.
12814
12815 .option acl_smtp_quit main string&!! unset
12816 .cindex "QUIT, ACL for"
12817 This option defines the ACL that is run when an SMTP QUIT command is
12818 received. See chapter &<<CHAPACL>>& for further details.
12819
12820 .option acl_smtp_rcpt main string&!! unset
12821 .cindex "RCPT" "ACL for"
12822 This option defines the ACL that is run when an SMTP RCPT command is
12823 received. See chapter &<<CHAPACL>>& for further details.
12824
12825 .option acl_smtp_starttls main string&!! unset
12826 .cindex "STARTTLS, ACL for"
12827 This option defines the ACL that is run when an SMTP STARTTLS command is
12828 received. See chapter &<<CHAPACL>>& for further details.
12829
12830 .option acl_smtp_vrfy main string&!! unset
12831 .cindex "VRFY" "ACL for"
12832 This option defines the ACL that is run when an SMTP VRFY command is
12833 received. See chapter &<<CHAPACL>>& for further details.
12834
12835 .option admin_groups main "string list&!!" unset
12836 .cindex "admin user"
12837 This option is expanded just once, at the start of Exim's processing. If the
12838 current group or any of the supplementary groups of an Exim caller is in this
12839 colon-separated list, the caller has admin privileges. If all your system
12840 programmers are in a specific group, for example, you can give them all Exim
12841 admin privileges by putting that group in &%admin_groups%&. However, this does
12842 not permit them to read Exim's spool files (whose group owner is the Exim gid).
12843 To permit this, you have to add individuals to the Exim group.
12844
12845 .option allow_domain_literals main boolean false
12846 .cindex "domain literal"
12847 If this option is set, the RFC 2822 domain literal format is permitted in
12848 email addresses. The option is not set by default, because the domain literal
12849 format is not normally required these days, and few people know about it. It
12850 has, however, been exploited by mail abusers.
12851
12852 Unfortunately, it seems that some DNS black list maintainers are using this
12853 format to report black listing to postmasters. If you want to accept messages
12854 addressed to your hosts by IP address, you need to set
12855 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
12856 domains (defined in the named domain list &%local_domains%& in the default
12857 configuration). This &"magic string"& matches the domain literal form of all
12858 the local host's IP addresses.
12859
12860
12861 .option allow_mx_to_ip main boolean false
12862 .cindex "MX record" "pointing to IP address"
12863 It appears that more and more DNS zone administrators are breaking the rules
12864 and putting domain names that look like IP addresses on the right hand side of
12865 MX records. Exim follows the rules and rejects this, giving an error message
12866 that explains the mis-configuration. However, some other MTAs support this
12867 practice, so to avoid &"Why can't Exim do this?"& complaints,
12868 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
12869 recommended, except when you have no other choice.
12870
12871 .option allow_utf8_domains main boolean false
12872 .cindex "domain" "UTF-8 characters in"
12873 .cindex "UTF-8" "in domain name"
12874 Lots of discussion is going on about internationalized domain names. One
12875 camp is strongly in favour of just using UTF-8 characters, and it seems
12876 that at least two other MTAs permit this. This option allows Exim users to
12877 experiment if they wish.
12878
12879 If it is set true, Exim's domain parsing function allows valid
12880 UTF-8 multicharacters to appear in domain name components, in addition to
12881 letters, digits, and hyphens. However, just setting this option is not
12882 enough; if you want to look up these domain names in the DNS, you must also
12883 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
12884 suitable setting is:
12885 .code
12886 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
12887   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
12888 .endd
12889 Alternatively, you can just disable this feature by setting
12890 .code
12891 dns_check_names_pattern =
12892 .endd
12893 That is, set the option to an empty string so that no check is done.
12894
12895
12896 .option auth_advertise_hosts main "host list&!!" *
12897 .cindex "authentication" "advertising"
12898 .cindex "AUTH" "advertising"
12899 If any server authentication mechanisms are configured, Exim advertises them in
12900 response to an EHLO command only if the calling host matches this list.
12901 Otherwise, Exim does not advertise AUTH.
12902 Exim does not accept AUTH commands from clients to which it has not
12903 advertised the availability of AUTH. The advertising of individual
12904 authentication mechanisms can be controlled by the use of the
12905 &%server_advertise_condition%& generic authenticator option on the individual
12906 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
12907
12908 Certain mail clients (for example, Netscape) require the user to provide a name
12909 and password for authentication if AUTH is advertised, even though it may
12910 not be needed (the host may accept messages from hosts on its local LAN without
12911 authentication, for example). The &%auth_advertise_hosts%& option can be used
12912 to make these clients more friendly by excluding them from the set of hosts to
12913 which Exim advertises AUTH.
12914
12915 .cindex "AUTH" "advertising when encrypted"
12916 If you want to advertise the availability of AUTH only when the connection
12917 is encrypted using TLS, you can make use of the fact that the value of this
12918 option is expanded, with a setting like this:
12919 .code
12920 auth_advertise_hosts = ${if eq{$tls_cipher}{}{}{*}}
12921 .endd
12922 .vindex "&$tls_cipher$&"
12923 If &$tls_cipher$& is empty, the session is not encrypted, and the result of
12924 the expansion is empty, thus matching no hosts. Otherwise, the result of the
12925 expansion is *, which matches all hosts.
12926
12927
12928 .option auto_thaw main time 0s
12929 .cindex "thawing messages"
12930 .cindex "unfreezing messages"
12931 If this option is set to a time greater than zero, a queue runner will try a
12932 new delivery attempt on any frozen message, other than a bounce message, if
12933 this much time has passed since it was frozen. This may result in the message
12934 being re-frozen if nothing has changed since the last attempt. It is a way of
12935 saying &"keep on trying, even though there are big problems"&.
12936
12937 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
12938 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
12939 thought to be very useful any more, and its use should probably be avoided.
12940
12941 .new
12942 .option av_scanner main string "see below"
12943 This option is available if Exim is built with the content-scanning extension.
12944 It specifies which anti-virus scanner to use. The default value is:
12945 .code
12946 sophie:/var/run/sophie
12947 .endd
12948 If the value of &%av_scanner%& starts with a dollar character, it is expanded
12949 before use. See section &<<SECTscanvirus>>& for further details.
12950 .wen
12951
12952
12953 .option bi_command main string unset
12954 .oindex "&%-bi%&"
12955 This option supplies the name of a command that is run when Exim is called with
12956 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
12957 just the command name, it is not a complete command line. If an argument is
12958 required, it must come from the &%-oA%& command line option.
12959
12960
12961 .option bounce_message_file main string unset
12962 .cindex "bounce message" "customizing"
12963 .cindex "customizing" "bounce message"
12964 This option defines a template file containing paragraphs of text to be used
12965 for constructing bounce messages.  Details of the file's contents are given in
12966 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
12967
12968
12969 .option bounce_message_text main string unset
12970 When this option is set, its contents are included in the default bounce
12971 message immediately after &"This message was created automatically by mail
12972 delivery software."& It is not used if &%bounce_message_file%& is set.
12973
12974 .option bounce_return_body main boolean true
12975 .cindex "bounce message" "including body"
12976 This option controls whether the body of an incoming message is included in a
12977 bounce message when &%bounce_return_message%& is true. The default setting
12978 causes the entire message, both header and body, to be returned (subject to the
12979 value of &%bounce_return_size_limit%&). If this option is false, only the
12980 message header is included. In the case of a non-SMTP message containing an
12981 error that is detected during reception, only those header lines preceding the
12982 point at which the error was detected are returned.
12983 .cindex "bounce message" "including original"
12984
12985 .option bounce_return_message main boolean true
12986 If this option is set false, none of the original message is included in
12987 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
12988 &%bounce_return_body%&.
12989
12990
12991 .option bounce_return_size_limit main integer 100K
12992 .cindex "size" "of bounce, limit"
12993 .cindex "bounce message" "size limit"
12994 .cindex "limit" "bounce message size"
12995 This option sets a limit in bytes on the size of messages that are returned to
12996 senders as part of bounce messages when &%bounce_return_message%& is true. The
12997 limit should be less than the value of the global &%message_size_limit%& and of
12998 any &%message_size_limit%& settings on transports, to allow for the bounce text
12999 that Exim generates. If this option is set to zero there is no limit.
13000
13001 When the body of any message that is to be included in a bounce message is
13002 greater than the limit, it is truncated, and a comment pointing this out is
13003 added at the top. The actual cutoff may be greater than the value given, owing
13004 to the use of buffering for transferring the message in chunks (typically 8K in
13005 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13006 messages.
13007
13008 .option bounce_sender_authentication main string unset
13009 .cindex "bounce message" "sender authentication"
13010 .cindex "authentication" "bounce message"
13011 .cindex "AUTH" "on bounce message"
13012 This option provides an authenticated sender address that is sent with any
13013 bounce messages generated by Exim that are sent over an authenticated SMTP
13014 connection. A typical setting might be:
13015 .code
13016 bounce_sender_authentication = mailer-daemon@my.domain.example
13017 .endd
13018 which would cause bounce messages to be sent using the SMTP command:
13019 .code
13020 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13021 .endd
13022 The value of &%bounce_sender_authentication%& must always be a complete email
13023 address.
13024
13025 .option callout_domain_negative_expire main time 3h
13026 .cindex "caching" "callout timeouts"
13027 .cindex "callout" "caching timeouts"
13028 This option specifies the expiry time for negative callout cache data for a
13029 domain. See section &<<SECTcallver>>& for details of callout verification, and
13030 section &<<SECTcallvercache>>& for details of the caching.
13031
13032
13033 .option callout_domain_positive_expire main time 7d
13034 This option specifies the expiry time for positive callout cache data for a
13035 domain. See section &<<SECTcallver>>& for details of callout verification, and
13036 section &<<SECTcallvercache>>& for details of the caching.
13037
13038
13039 .option callout_negative_expire main time 2h
13040 This option specifies the expiry time for negative callout cache data for an
13041 address. See section &<<SECTcallver>>& for details of callout verification, and
13042 section &<<SECTcallvercache>>& for details of the caching.
13043
13044
13045 .option callout_positive_expire main time 24h
13046 This option specifies the expiry time for positive callout cache data for an
13047 address. See section &<<SECTcallver>>& for details of callout verification, and
13048 section &<<SECTcallvercache>>& for details of the caching.
13049
13050
13051 .option callout_random_local_part main string&!! "see below"
13052 This option defines the &"random"& local part that can be used as part of
13053 callout verification. The default value is
13054 .code
13055 $primary_host_name-$tod_epoch-testing
13056 .endd
13057 See section &<<CALLaddparcall>>& for details of how this value is used.
13058
13059
13060 .option check_log_inodes main integer 0
13061 See &%check_spool_space%& below.
13062
13063
13064 .option check_log_space main integer 0
13065 See &%check_spool_space%& below.
13066
13067 .oindex "&%check_rfc2047_length%&"
13068 .cindex "RFC 2047" "disabling length check"
13069 .option check_rfc2047_length main boolean true
13070 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13071 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13072 word; strings to be encoded that exceed this length are supposed to use
13073 multiple encoded words. By default, Exim does not recognize encoded words that
13074 exceed the maximum length. However, it seems that some software, in violation
13075 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13076 set false, Exim recognizes encoded words of any length.
13077
13078
13079 .option check_spool_inodes main integer 0
13080 See &%check_spool_space%& below.
13081
13082
13083 .option check_spool_space main integer 0
13084 .cindex "checking disk space"
13085 .cindex "disk space, checking"
13086 .cindex "spool directory" "checking space"
13087 The four &%check_...%& options allow for checking of disk resources before a
13088 message is accepted.
13089
13090 .vindex "&$log_inodes$&"
13091 .vindex "&$log_space$&"
13092 .vindex "&$spool_inodes$&"
13093 .vindex "&$spool_space$&"
13094 When any of these options are set, they apply to all incoming messages. If you
13095 want to apply different checks to different kinds of message, you can do so by
13096 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13097 &$spool_space$& in an ACL with appropriate additional conditions.
13098
13099
13100 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13101 either value is greater than zero, for example:
13102 .code
13103 check_spool_space = 10M
13104 check_spool_inodes = 100
13105 .endd
13106 The spool partition is the one that contains the directory defined by
13107 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13108 transit.
13109
13110 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13111 files are written if either is greater than zero. These should be set only if
13112 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13113
13114 If there is less space or fewer inodes than requested, Exim refuses to accept
13115 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13116 error response to the MAIL command. If ESMTP is in use and there was a
13117 SIZE parameter on the MAIL command, its value is added to the
13118 &%check_spool_space%& value, and the check is performed even if
13119 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13120
13121 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13122 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13123
13124 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13125 failure a message is written to stderr and Exim exits with a non-zero code, as
13126 it obviously cannot send an error message of any kind.
13127
13128 .option daemon_smtp_ports main string &`smtp`&
13129 .cindex "port" "for daemon"
13130 .cindex "TCP/IP" "setting listening ports"
13131 This option specifies one or more default SMTP ports on which the Exim daemon
13132 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13133 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13134
13135 .option daemon_startup_retries main integer 9
13136 .cindex "daemon startup, retrying"
13137 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13138 the daemon at startup when it cannot immediately bind a listening socket
13139 (typically because the socket is already in use): &%daemon_startup_retries%&
13140 defines the number of retries after the first failure, and
13141 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13142
13143 .option daemon_startup_sleep main time 30s
13144 See &%daemon_startup_retries%&.
13145
13146 .option delay_warning main "time list" 24h
13147 .cindex "warning of delay"
13148 .cindex "delay warning, specifying"
13149 When a message is delayed, Exim sends a warning message to the sender at
13150 intervals specified by this option. The data is a colon-separated list of times
13151 after which to send warning messages. If the value of the option is an empty
13152 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13153 message has been on the queue for longer than the last time, the last interval
13154 between the times is used to compute subsequent warning times. For example,
13155 with
13156 .code
13157 delay_warning = 4h:8h:24h
13158 .endd
13159 the first message is sent after 4 hours, the second after 8 hours, and
13160 the third one after 24 hours. After that, messages are sent every 16 hours,
13161 because that is the interval between the last two times on the list. If you set
13162 just one time, it specifies the repeat interval. For example, with:
13163 .code
13164 delay_warning = 6h
13165 .endd
13166 messages are repeated every six hours. To stop warnings after a given time, set
13167 a very large time at the end of the list. For example:
13168 .code
13169 delay_warning = 2h:12h:99d
13170 .endd
13171
13172 .option delay_warning_condition main string&!! "see below"
13173 .vindex "&$domain$&"
13174 The string is expanded at the time a warning message might be sent. If all the
13175 deferred addresses have the same domain, it is set in &$domain$& during the
13176 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13177 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13178 &"false"& (the comparison being done caselessly) then the warning message is
13179 not sent. The default is:
13180 .code
13181 delay_warning_condition = ${if or {\
13182   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13183   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13184   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13185   } {no}{yes}}
13186 .endd
13187 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13188 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13189 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13190 &"auto-replied"& in an &'Auto-Submitted:'& header.
13191
13192 .option deliver_drop_privilege main boolean false
13193 .cindex "unprivileged delivery"
13194 .cindex "delivery" "unprivileged"
13195 If this option is set true, Exim drops its root privilege at the start of a
13196 delivery process, and runs as the Exim user throughout. This severely restricts
13197 the kinds of local delivery that are possible, but is viable in certain types
13198 of configuration. There is a discussion about the use of root privilege in
13199 chapter &<<CHAPsecurity>>&.
13200
13201 .option deliver_queue_load_max main fixed-point unset
13202 .cindex "load average"
13203 .cindex "queue runner" "abandoning"
13204 When this option is set, a queue run is abandoned if the system load average
13205 becomes greater than the value of the option. The option has no effect on
13206 ancient operating systems on which Exim cannot determine the load average.
13207 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13208
13209
13210 .option delivery_date_remove main boolean true
13211 .cindex "&'Delivery-date:'& header line"
13212 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13213 message when it is delivered, in exactly the same way as &'Return-path:'& is
13214 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13215 should not be present in incoming messages, and this option causes them to be
13216 removed at the time the message is received, to avoid any problems that might
13217 occur when a delivered message is subsequently sent on to some other recipient.
13218
13219 .option disable_fsync main boolean false
13220 .cindex "&[fsync()]&, disabling"
13221 This option is available only if Exim was built with the compile-time option
13222 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13223 a runtime configuration generates an &"unknown option"& error. You should not
13224 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13225 really, really, really understand what you are doing. &'No pre-compiled
13226 distributions of Exim should ever make this option available.'&
13227
13228 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13229 updated files' data to be written to disc before continuing. Unexpected events
13230 such as crashes and power outages may cause data to be lost or scrambled.
13231 Here be Dragons. &*Beware.*&
13232
13233
13234 .option disable_ipv6 main boolean false
13235 .cindex "IPv6" "disabling"
13236 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13237 activities take place. AAAA records are never looked up, and any IPv6 addresses
13238 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13239 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13240 to handle IPv6 literal addresses.
13241
13242
13243 .option dns_again_means_nonexist main "domain list&!!" unset
13244 .cindex "DNS" "&""try again""& response; overriding"
13245 DNS lookups give a &"try again"& response for the DNS errors
13246 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13247 keep trying to deliver a message, or to give repeated temporary errors to
13248 incoming mail. Sometimes the effect is caused by a badly set up name server and
13249 may persist for a long time. If a domain which exhibits this problem matches
13250 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13251 This option should be used with care. You can make it apply to reverse lookups
13252 by a setting such as this:
13253 .code
13254 dns_again_means_nonexist = *.in-addr.arpa
13255 .endd
13256 This option applies to all DNS lookups that Exim does. It also applies when the
13257 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13258 since these are most likely to be caused by DNS lookup problems. The
13259 &(dnslookup)& router has some options of its own for controlling what happens
13260 when lookups for MX or SRV records give temporary errors. These more specific
13261 options are applied after this global option.
13262
13263 .option dns_check_names_pattern main string "see below"
13264 .cindex "DNS" "pre-check of name syntax"
13265 When this option is set to a non-empty string, it causes Exim to check domain
13266 names for characters that are not allowed in host names before handing them to
13267 the DNS resolver, because some resolvers give temporary errors for names that
13268 contain unusual characters. If a domain name contains any unwanted characters,
13269 a &"not found"& result is forced, and the resolver is not called. The check is
13270 done by matching the domain name against a regular expression, which is the
13271 value of this option. The default pattern is
13272 .code
13273 dns_check_names_pattern = \
13274   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13275 .endd
13276 which permits only letters, digits, slashes, and hyphens in components, but
13277 they must start and end with a letter or digit. Slashes are not, in fact,
13278 permitted in host names, but they are found in certain NS records (which can be
13279 accessed in Exim by using a &%dnsdb%& lookup). If you set
13280 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13281 empty string.
13282
13283 .option dns_csa_search_limit main integer 5
13284 This option controls the depth of parental searching for CSA SRV records in the
13285 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13286
13287 .option dns_csa_use_reverse main boolean true
13288 This option controls whether or not an IP address, given as a CSA domain, is
13289 reversed and looked up in the reverse DNS, as described in more detail in
13290 section &<<SECTverifyCSA>>&.
13291
13292 .option dns_ipv4_lookup main "domain list&!!" unset
13293 .cindex "IPv6" "DNS lookup for AAAA records"
13294 .cindex "DNS" "IPv6 lookup for AAAA records"
13295 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13296 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13297 (A records) when trying to find IP addresses for hosts, unless the host's
13298 domain matches this list.
13299
13300 This is a fudge to help with name servers that give big delays or otherwise do
13301 not work for the AAAA record type. In due course, when the world's name
13302 servers have all been upgraded, there should be no need for this option.
13303
13304
13305 .option dns_retrans main time 0s
13306 .cindex "DNS" "resolver options"
13307 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13308 retransmission and retry parameters for DNS lookups. Values of zero (the
13309 defaults) leave the system default settings unchanged. The first value is the
13310 time between retries, and the second is the number of retries. It isn't
13311 totally clear exactly how these settings affect the total time a DNS lookup may
13312 take. I haven't found any documentation about timeouts on DNS lookups; these
13313 parameter values are available in the external resolver interface structure,
13314 but nowhere does it seem to describe how they are used or what you might want
13315 to set in them.
13316
13317
13318 .option dns_retry main integer 0
13319 See &%dns_retrans%& above.
13320
13321
13322 .option drop_cr main boolean false
13323 This is an obsolete option that is now a no-op. It used to affect the way Exim
13324 handled CR and LF characters in incoming messages. What happens now is
13325 described in section &<<SECTlineendings>>&.
13326
13327 .option dsn_from main "string&!!" "see below"
13328 .cindex "&'From:'& header line" "in bounces"
13329 .cindex "bounce messages" "&'From:'& line, specifying"
13330 This option can be used to vary the contents of &'From:'& header lines in
13331 bounces and other automatically generated messages (&"Delivery Status
13332 Notifications"& &-- hence the name of the option). The default setting is:
13333 .code
13334 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13335 .endd
13336 The value is expanded every time it is needed. If the expansion fails, a
13337 panic is logged, and the default value is used.
13338
13339 .option envelope_to_remove main boolean true
13340 .cindex "&'Envelope-to:'& header line"
13341 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13342 message when it is delivered, in exactly the same way as &'Return-path:'& is
13343 handled. &'Envelope-to:'& records the original recipient address from the
13344 messages's envelope that caused the delivery to happen. Such headers should not
13345 be present in incoming messages, and this option causes them to be removed at
13346 the time the message is received, to avoid any problems that might occur when a
13347 delivered message is subsequently sent on to some other recipient.
13348
13349
13350 .option errors_copy main "string list&!!" unset
13351 .cindex "bounce message" "copy to other address"
13352 .cindex "copy of bounce message"
13353 Setting this option causes Exim to send bcc copies of bounce messages that it
13354 generates to other addresses. &*Note*&: This does not apply to bounce messages
13355 coming from elsewhere. The value of the option is a colon-separated list of
13356 items. Each item consists of a pattern, terminated by white space, followed by
13357 a comma-separated list of email addresses. If a pattern contains spaces, it
13358 must be enclosed in double quotes.
13359
13360 Each pattern is processed in the same way as a single item in an address list
13361 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13362 the bounce message, the message is copied to the addresses on the list. The
13363 items are scanned in order, and once a matching one is found, no further items
13364 are examined. For example:
13365 .code
13366 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13367               rqps@mydomain   hostmaster@mydomain.example,\
13368                               postmaster@mydomain.example
13369 .endd
13370 .vindex "&$domain$&"
13371 .vindex "&$local_part$&"
13372 The address list is expanded before use. The expansion variables &$local_part$&
13373 and &$domain$& are set from the original recipient of the error message, and if
13374 there was any wildcard matching in the pattern, the expansion
13375 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13376 variables &$0$&, &$1$&, etc. are set in the normal way.
13377
13378
13379 .option errors_reply_to main string unset
13380 .cindex "bounce message" "&'Reply-to:'& in"
13381 By default, Exim's bounce and delivery warning messages contain the header line
13382 .display
13383 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13384 .endd
13385 .oindex &%quota_warn_message%&
13386 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13387 A warning message that is generated by the &%quota_warn_message%& option in an
13388 &(appendfile)& transport may contain its own &'From:'& header line that
13389 overrides the default.
13390
13391 Experience shows that people reply to bounce messages. If the
13392 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13393 and warning messages. For example:
13394 .code
13395 errors_reply_to = postmaster@my.domain.example
13396 .endd
13397 The value of the option is not expanded. It must specify a valid RFC 2822
13398 address. However, if a warning message that is generated by the
13399 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13400 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13401 not used.
13402
13403
13404 .option exim_group main string "compile-time configured"
13405 .cindex "gid (group id)" "Exim's own"
13406 .cindex "Exim group"
13407 This option changes the gid under which Exim runs when it gives up root
13408 privilege. The default value is compiled into the binary. The value of this
13409 option is used only when &%exim_user%& is also set. Unless it consists entirely
13410 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13411 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13412 security issues.
13413
13414
13415 .option exim_path main string "see below"
13416 .cindex "Exim binary, path name"
13417 This option specifies the path name of the Exim binary, which is used when Exim
13418 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13419 the directory configured at compile time by the BIN_DIRECTORY setting. It
13420 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13421 other place.
13422 &*Warning*&: Do not use a macro to define the value of this option, because
13423 you will break those Exim utilities that scan the configuration file to find
13424 where the binary is. (They then use the &%-bP%& option to extract option
13425 settings such as the value of &%spool_directory%&.)
13426
13427
13428 .option exim_user main string "compile-time configured"
13429 .cindex "uid (user id)" "Exim's own"
13430 .cindex "Exim user"
13431 This option changes the uid under which Exim runs when it gives up root
13432 privilege. The default value is compiled into the binary. Ownership of the run
13433 time configuration file and the use of the &%-C%& and &%-D%& command line
13434 options is checked against the values in the binary, not what is set here.
13435
13436 Unless it consists entirely of digits, the string is looked up using
13437 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13438 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13439 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13440
13441
13442 .option extra_local_interfaces main "string list" unset
13443 This option defines network interfaces that are to be considered local when
13444 routing, but which are not used for listening by the daemon. See section
13445 &<<SECTreclocipadd>>& for details.
13446
13447
13448 . Allow this long option name to split; give it unsplit as a fifth argument
13449 . for the automatic .oindex that is generated by .option.
13450
13451 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13452          extract_addresses_remove_arguments
13453 .oindex "&%-t%&"
13454 .cindex "command line" "addresses with &%-t%&"
13455 .cindex "Sendmail compatibility" "&%-t%& option"
13456 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13457 are present on the command line when the &%-t%& option is used to build an
13458 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13459 line addresses are removed from the recipients list. This is also how Smail
13460 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13461 command line addresses are added to those obtained from the header lines. When
13462 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13463 argument headers. If it is set false, Exim adds rather than removes argument
13464 addresses.
13465
13466
13467 .option finduser_retries main integer 0
13468 .cindex "NIS, retrying user lookups"
13469 On systems running NIS or other schemes in which user and group information is
13470 distributed from a remote system, there can be times when &[getpwnam()]& and
13471 related functions fail, even when given valid data, because things time out.
13472 Unfortunately these failures cannot be distinguished from genuine &"not found"&
13473 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
13474 many extra times to find a user or a group, waiting for one second between
13475 retries.
13476
13477 .cindex "&_/etc/passwd_&" "multiple reading of"
13478 You should not set this option greater than zero if your user information is in
13479 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
13480 search the file multiple times for non-existent users, and also cause delay.
13481
13482
13483
13484 .option freeze_tell main "string list, comma separated" unset
13485 .cindex "freezing messages" "sending a message when freezing"
13486 On encountering certain errors, or when configured to do so in a system filter,
13487 ACL, or special router, Exim freezes a message. This means that no further
13488 delivery attempts take place until an administrator thaws the message, or the
13489 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
13490 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
13491 warning message whenever it freezes something, unless the message it is
13492 freezing is a locally-generated bounce message. (Without this exception there
13493 is the possibility of looping.) The warning message is sent to the addresses
13494 supplied as the comma-separated value of this option. If several of the
13495 message's addresses cause freezing, only a single message is sent. If the
13496 freezing was automatic, the reason(s) for freezing can be found in the message
13497 log. If you configure freezing in a filter or ACL, you must arrange for any
13498 logging that you require.
13499
13500
13501 .option gecos_name main string&!! unset
13502 .cindex "HP-UX"
13503 .cindex "&""gecos""& field, parsing"
13504 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
13505 password file to hold other information in addition to users' real names. Exim
13506 looks up this field for use when it is creating &'Sender:'& or &'From:'&
13507 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
13508 of the field are used unchanged, except that, if an ampersand is encountered,
13509 it is replaced by the user's login name with the first character forced to
13510 upper case, since this is a convention that is observed on many systems.
13511
13512 When these options are set, &%gecos_pattern%& is treated as a regular
13513 expression that is to be applied to the field (again with && replaced by the
13514 login name), and if it matches, &%gecos_name%& is expanded and used as the
13515 user's name.
13516
13517 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
13518 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
13519 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
13520 name terminates at the first comma, the following can be used:
13521 .code
13522 gecos_pattern = ([^,]*)
13523 gecos_name = $1
13524 .endd
13525
13526 .option gecos_pattern main string unset
13527 See &%gecos_name%& above.
13528
13529
13530 .option gnutls_require_kx main string unset
13531 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
13532 server. For details, see section &<<SECTreqciphgnu>>&.
13533
13534 .option gnutls_require_mac main string unset
13535 This option controls the MAC algorithms when GnuTLS is used in an Exim
13536 server. For details, see section &<<SECTreqciphgnu>>&.
13537
13538 .option gnutls_require_protocols main string unset
13539 This option controls the protocols when GnuTLS is used in an Exim
13540 server. For details, see section &<<SECTreqciphgnu>>&.
13541
13542 .option gnutls_compat_mode main boolean unset
13543 This option controls whether GnuTLS is used in compatibility mode in an Exim
13544 server. This reduces security slightly, but improves interworking with older
13545 implementations of TLS.
13546
13547 .option headers_charset main string "see below"
13548 This option sets a default character set for translating from encoded MIME
13549 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
13550 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
13551 ultimate default is ISO-8859-1. For more details see the description of header
13552 insertions in section &<<SECTexpansionitems>>&.
13553
13554
13555
13556 .option header_maxsize main integer "see below"
13557 .cindex "header section" "maximum size of"
13558 .cindex "limit" "size of message header section"
13559 This option controls the overall maximum size of a message's header
13560 section. The default is the value of HEADER_MAXSIZE in
13561 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
13562 sections are rejected.
13563
13564
13565 .option header_line_maxsize main integer 0
13566 .cindex "header lines" "maximum size of"
13567 .cindex "limit" "size of one header line"
13568 This option limits the length of any individual header line in a message, after
13569 all the continuations have been joined together. Messages with individual
13570 header lines that are longer than the limit are rejected. The default value of
13571 zero means &"no limit"&.
13572
13573
13574
13575
13576 .option helo_accept_junk_hosts main "host list&!!" unset
13577 .cindex "HELO" "accepting junk data"
13578 .cindex "EHLO" "accepting junk data"
13579 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
13580 mail, and gives an error response for invalid data. Unfortunately, there are
13581 some SMTP clients that send syntactic junk. They can be accommodated by setting
13582 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
13583 if you want to do semantic checking.
13584 See also &%helo_allow_chars%& for a way of extending the permitted character
13585 set.
13586
13587
13588 .option helo_allow_chars main string unset
13589 .cindex "HELO" "underscores in"
13590 .cindex "EHLO" "underscores in"
13591 .cindex "underscore in EHLO/HELO"
13592 This option can be set to a string of rogue characters that are permitted in
13593 all EHLO and HELO names in addition to the standard letters, digits,
13594 hyphens, and dots. If you really must allow underscores, you can set
13595 .code
13596 helo_allow_chars = _
13597 .endd
13598 Note that the value is one string, not a list.
13599
13600
13601 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
13602 .cindex "HELO" "forcing reverse lookup"
13603 .cindex "EHLO" "forcing reverse lookup"
13604 If the domain given by a client in a HELO or EHLO command matches this
13605 list, a reverse lookup is done in order to establish the host's true name. The
13606 default forces a lookup if the client host gives the server's name or any of
13607 its IP addresses (in brackets), something that broken clients have been seen to
13608 do.
13609
13610
13611 .option helo_try_verify_hosts main "host list&!!" unset
13612 .cindex "HELO verifying" "optional"
13613 .cindex "EHLO" "verifying, optional"
13614 By default, Exim just checks the syntax of HELO and EHLO commands (see
13615 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
13616 to do more extensive checking of the data supplied by these commands. The ACL
13617 condition &`verify = helo`& is provided to make this possible.
13618 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
13619 to force the check to occur. From release 4.53 onwards, this is no longer
13620 necessary. If the check has not been done before &`verify = helo`& is
13621 encountered, it is done at that time. Consequently, this option is obsolete.
13622 Its specification is retained here for backwards compatibility.
13623
13624 When an EHLO or HELO command is received, if the calling host matches
13625 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
13626 EHLO command either:
13627
13628 .ilist
13629 is an IP literal matching the calling address of the host, or
13630 .next
13631 .cindex "DNS" "reverse lookup"
13632 .cindex "reverse DNS lookup"
13633 matches the host name that Exim obtains by doing a reverse lookup of the
13634 calling host address, or
13635 .next
13636 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
13637 available) yields the calling host address.
13638 .endlist
13639
13640 However, the EHLO or HELO command is not rejected if any of the checks
13641 fail. Processing continues, but the result of the check is remembered, and can
13642 be detected later in an ACL by the &`verify = helo`& condition.
13643
13644 .option helo_verify_hosts main "host list&!!" unset
13645 .cindex "HELO verifying" "mandatory"
13646 .cindex "EHLO" "verifying, mandatory"
13647 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
13648 backwards compatibility. For hosts that match this option, Exim checks the host
13649 name given in the HELO or EHLO in the same way as for
13650 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
13651 rejected with a 550 error, and entries are written to the main and reject logs.
13652 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
13653 error.
13654
13655 .option hold_domains main "domain list&!!" unset
13656 .cindex "domain" "delaying delivery"
13657 .cindex "delivery" "delaying certain domains"
13658 This option allows mail for particular domains to be held on the queue
13659 manually. The option is overridden if a message delivery is forced with the
13660 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
13661 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
13662 item in &%hold_domains%&, no routing or delivery for that address is done, and
13663 it is deferred every time the message is looked at.
13664
13665 This option is intended as a temporary operational measure for delaying the
13666 delivery of mail while some problem is being sorted out, or some new
13667 configuration tested. If you just want to delay the processing of some
13668 domains until a queue run occurs, you should use &%queue_domains%& or
13669 &%queue_smtp_domains%&, not &%hold_domains%&.
13670
13671 A setting of &%hold_domains%& does not override Exim's code for removing
13672 messages from the queue if they have been there longer than the longest retry
13673 time in any retry rule. If you want to hold messages for longer than the normal
13674 retry times, insert a dummy retry rule with a long retry time.
13675
13676
13677 .option host_lookup main "host list&!!" unset
13678 .cindex "host name" "lookup, forcing"
13679 Exim does not look up the name of a calling host from its IP address unless it
13680 is required to compare against some host list, or the host matches
13681 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
13682 option (which normally contains IP addresses rather than host names). The
13683 default configuration file contains
13684 .code
13685 host_lookup = *
13686 .endd
13687 which causes a lookup to happen for all hosts. If the expense of these lookups
13688 is felt to be too great, the setting can be changed or removed.
13689
13690 After a successful reverse lookup, Exim does a forward lookup on the name it
13691 has obtained, to verify that it yields the IP address that it started with. If
13692 this check fails, Exim behaves as if the name lookup failed.
13693
13694 .vindex "&$host_lookup_failed$&"
13695 .vindex "&$sender_host_name$&"
13696 After any kind of failure, the host name (in &$sender_host_name$&) remains
13697 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
13698 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
13699 &`verify = reverse_host_lookup`& in ACLs.
13700
13701
13702 .option host_lookup_order main "string list" &`bydns:byaddr`&
13703 This option specifies the order of different lookup methods when Exim is trying
13704 to find a host name from an IP address. The default is to do a DNS lookup
13705 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
13706 if that fails. You can change the order of these lookups, or omit one entirely,
13707 if you want.
13708
13709 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
13710 multiple PTR records in the DNS and the IP address is not listed in
13711 &_/etc/hosts_&. Different operating systems give different results in this
13712 case. That is why the default tries a DNS lookup first.
13713
13714
13715
13716 .option host_reject_connection main "host list&!!" unset
13717 .cindex "host" "rejecting connections from"
13718 If this option is set, incoming SMTP calls from the hosts listed are rejected
13719 as soon as the connection is made.
13720 This option is obsolete, and retained only for backward compatibility, because
13721 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
13722 connections immediately.
13723
13724 The ability to give an immediate rejection (either by this option or using an
13725 ACL) is provided for use in unusual cases. Many hosts will just try again,
13726 sometimes without much delay. Normally, it is better to use an ACL to reject
13727 incoming messages at a later stage, such as after RCPT commands. See
13728 chapter &<<CHAPACL>>&.
13729
13730
13731 .option hosts_connection_nolog main "host list&!!" unset
13732 .cindex "host" "not logging connections from"
13733 This option defines a list of hosts for which connection logging does not
13734 happen, even though the &%smtp_connection%& log selector is set. For example,
13735 you might want not to log SMTP connections from local processes, or from
13736 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
13737 the daemon; you should therefore strive to restrict its value to a short inline
13738 list of IP addresses and networks. To disable logging SMTP connections from
13739 local processes, you must create a host list with an empty item. For example:
13740 .code
13741 hosts_connection_nolog = :
13742 .endd
13743 If the &%smtp_connection%& log selector is not set, this option has no effect.
13744
13745
13746
13747 .option hosts_treat_as_local main "domain list&!!" unset
13748 .cindex "local host" "domains treated as"
13749 .cindex "host" "treated as local"
13750 If this option is set, any host names that match the domain list are treated as
13751 if they were the local host when Exim is scanning host lists obtained from MX
13752 records
13753 or other sources. Note that the value of this option is a domain list, not a
13754 host list, because it is always used to check host names, not IP addresses.
13755
13756 This option also applies when Exim is matching the special items
13757 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
13758 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
13759 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
13760 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
13761 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
13762 interfaces and recognizing the local host.
13763
13764
13765 .option ibase_servers main "string list" unset
13766 .cindex "InterBase" "server list"
13767 This option provides a list of InterBase servers and associated connection data,
13768 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
13769 The option is available only if Exim has been built with InterBase support.
13770
13771
13772
13773 .option ignore_bounce_errors_after main time 10w
13774 .cindex "bounce message" "discarding"
13775 .cindex "discarding bounce message"
13776 This option affects the processing of bounce messages that cannot be delivered,
13777 that is, those that suffer a permanent delivery failure. (Bounce messages that
13778 suffer temporary delivery failures are of course retried in the usual way.)
13779
13780 After a permanent delivery failure, bounce messages are frozen,
13781 because there is no sender to whom they can be returned. When a frozen bounce
13782 message has been on the queue for more than the given time, it is unfrozen at
13783 the next queue run, and a further delivery is attempted. If delivery fails
13784 again, the bounce message is discarded. This makes it possible to keep failed
13785 bounce messages around for a shorter time than the normal maximum retry time
13786 for frozen messages. For example,
13787 .code
13788 ignore_bounce_errors_after = 12h
13789 .endd
13790 retries failed bounce message deliveries after 12 hours, discarding any further
13791 failures. If the value of this option is set to a zero time period, bounce
13792 failures are discarded immediately. Setting a very long time (as in the default
13793 value) has the effect of disabling this option. For ways of automatically
13794 dealing with other kinds of frozen message, see &%auto_thaw%& and
13795 &%timeout_frozen_after%&.
13796
13797
13798 .option ignore_fromline_hosts main "host list&!!" unset
13799 .cindex "&""From""& line"
13800 .cindex "UUCP" "&""From""& line"
13801 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
13802 the headers of a message. By default this is treated as the start of the
13803 message's body, which means that any following headers are not recognized as
13804 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
13805 match those hosts that insist on sending it. If the sender is actually a local
13806 process rather than a remote host, and is using &%-bs%& to inject the messages,
13807 &%ignore_fromline_local%& must be set to achieve this effect.
13808
13809
13810 .option ignore_fromline_local main boolean false
13811 See &%ignore_fromline_hosts%& above.
13812
13813
13814 .option keep_malformed main time 4d
13815 This option specifies the length of time to keep messages whose spool files
13816 have been corrupted in some way. This should, of course, never happen. At the
13817 next attempt to deliver such a message, it gets removed. The incident is
13818 logged.
13819
13820
13821 .new
13822 .option ldap_ca_cert_dir main string unset
13823 .cindex "LDAP", "TLS CA certificate directory"
13824 This option indicates which directory contains CA certificates for verifying
13825 a TLS certificate presented by an LDAP server.
13826 While Exim does not provide a default value, your SSL library may.
13827 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
13828 and constrained to be a directory.
13829 .wen
13830
13831
13832 .new
13833 .option ldap_ca_cert_file main string unset
13834 .cindex "LDAP", "TLS CA certificate file"
13835 This option indicates which file contains CA certificates for verifying
13836 a TLS certificate presented by an LDAP server.
13837 While Exim does not provide a default value, your SSL library may.
13838 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
13839 and constrained to be a file.
13840 .wen
13841
13842
13843 .new
13844 .option ldap_cert_file main string unset
13845 .cindex "LDAP" "TLS client certificate file"
13846 This option indicates which file contains an TLS client certificate which
13847 Exim should present to the LDAP server during TLS negotiation.
13848 Should be used together with &%ldap_cert_key%&.
13849 .wen
13850
13851
13852 .new
13853 .option ldap_cert_key main string unset
13854 .cindex "LDAP" "TLS client key file"
13855 This option indicates which file contains the secret/private key to use
13856 to prove identity to the LDAP server during TLS negotiation.
13857 Should be used together with &%ldap_cert_file%&, which contains the
13858 identity to be proven.
13859 .wen
13860
13861
13862 .new
13863 .option ldap_cipher_suite main string unset
13864 .cindex "LDAP" "TLS cipher suite"
13865 This controls the TLS cipher-suite negotiation during TLS negotiation with
13866 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
13867 cipher-suite options with OpenSSL (as used by LDAP client libraries).
13868 .wen
13869
13870
13871 .option ldap_default_servers main "string list" unset
13872 .cindex "LDAP" "default servers"
13873 This option provides a list of LDAP servers which are tried in turn when an
13874 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
13875 details of LDAP queries. This option is available only when Exim has been built
13876 with LDAP support.
13877
13878
13879 .new
13880 .option ldap_require_cert main string unset.
13881 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
13882 This should be one of the values "hard", "demand", "allow", "try" or "never".
13883 A value other than one of these is interpreted as "never".
13884 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
13885 Although Exim does not set a default, the LDAP library probably defaults
13886 to hard/demand.
13887 .wen
13888
13889
13890 .new
13891 .option ldap_start_tls main boolean false
13892 .cindex "LDAP" "whether or not to negotiate TLS"
13893 If set, Exim will attempt to negotiate TLS with the LDAP server when
13894 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
13895 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
13896 of SSL-on-connect.
13897 In the event of failure to negotiate TLS, the action taken is controlled
13898 by &%ldap_require_cert%&.
13899 .wen
13900
13901
13902 .option ldap_version main integer unset
13903 .cindex "LDAP" "protocol version, forcing"
13904 This option can be used to force Exim to set a specific protocol version for
13905 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
13906 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
13907 the LDAP headers; otherwise it is 2. This option is available only when Exim
13908 has been built with LDAP support.
13909
13910
13911
13912 .option local_from_check main boolean true
13913 .cindex "&'Sender:'& header line" "disabling addition of"
13914 .cindex "&'From:'& header line" "disabling checking of"
13915 When a message is submitted locally (that is, not over a TCP/IP connection) by
13916 an untrusted user, Exim removes any existing &'Sender:'& header line, and
13917 checks that the &'From:'& header line matches the login of the calling user and
13918 the domain specified by &%qualify_domain%&.
13919
13920 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
13921 locally submitted message is automatically qualified by Exim, unless the
13922 &%-bnq%& command line option is used.
13923
13924 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
13925 on the local part. If the &'From:'& header line does not match, Exim adds a
13926 &'Sender:'& header with an address constructed from the calling user's login
13927 and the default qualify domain.
13928
13929 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
13930 and no &'Sender:'& header is ever added. If, in addition, you want to retain
13931 &'Sender:'& header lines supplied by untrusted users, you must also set
13932 &%local_sender_retain%& to be true.
13933
13934 .cindex "envelope sender"
13935 These options affect only the header lines in the message. The envelope sender
13936 is still forced to be the login id at the qualify domain unless
13937 &%untrusted_set_sender%& permits the user to supply an envelope sender.
13938
13939 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
13940 request similar header line checking. See section &<<SECTthesenhea>>&, which
13941 has more details about &'Sender:'& processing.
13942
13943
13944
13945
13946 .option local_from_prefix main string unset
13947 When Exim checks the &'From:'& header line of locally submitted messages for
13948 matching the login id (see &%local_from_check%& above), it can be configured to
13949 ignore certain prefixes and suffixes in the local part of the address. This is
13950 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
13951 appropriate lists, in the same form as the &%local_part_prefix%& and
13952 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
13953 example, if
13954 .code
13955 local_from_prefix = *-
13956 .endd
13957 is set, a &'From:'& line containing
13958 .code
13959 From: anything-user@your.domain.example
13960 .endd
13961 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
13962 matches the actual sender address that is constructed from the login name and
13963 qualify domain.
13964
13965
13966 .option local_from_suffix main string unset
13967 See &%local_from_prefix%& above.
13968
13969
13970 .option local_interfaces main "string list" "see below"
13971 This option controls which network interfaces are used by the daemon for
13972 listening; they are also used to identify the local host when routing. Chapter
13973 &<<CHAPinterfaces>>& contains a full description of this option and the related
13974 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
13975 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
13976 &%local_interfaces%& is
13977 .code
13978 local_interfaces = 0.0.0.0
13979 .endd
13980 when Exim is built without IPv6 support; otherwise it is
13981 .code
13982 local_interfaces = <; ::0 ; 0.0.0.0
13983 .endd
13984
13985 .option local_scan_timeout main time 5m
13986 .cindex "timeout" "for &[local_scan()]& function"
13987 .cindex "&[local_scan()]& function" "timeout"
13988 This timeout applies to the &[local_scan()]& function (see chapter
13989 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
13990 the incoming message is rejected with a temporary error if it is an SMTP
13991 message. For a non-SMTP message, the message is dropped and Exim ends with a
13992 non-zero code. The incident is logged on the main and reject logs.
13993
13994
13995
13996 .option local_sender_retain main boolean false
13997 .cindex "&'Sender:'& header line" "retaining from local submission"
13998 When a message is submitted locally (that is, not over a TCP/IP connection) by
13999 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14000 do not want this to happen, you must set &%local_sender_retain%&, and you must
14001 also set &%local_from_check%& to be false (Exim will complain if you do not).
14002 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14003 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14004
14005
14006
14007
14008 .option localhost_number main string&!! unset
14009 .cindex "host" "locally unique number for"
14010 .cindex "message ids" "with multiple hosts"
14011 .vindex "&$localhost_number$&"
14012 Exim's message ids are normally unique only within the local host. If
14013 uniqueness among a set of hosts is required, each host must set a different
14014 value for the &%localhost_number%& option. The string is expanded immediately
14015 after reading the configuration file (so that a number can be computed from the
14016 host name, for example) and the result of the expansion must be a number in the
14017 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14018 systems). This is available in subsequent string expansions via the variable
14019 &$localhost_number$&. When &%localhost_number is set%&, the final two
14020 characters of the message id, instead of just being a fractional part of the
14021 time, are computed from the time and the local host number as described in
14022 section &<<SECTmessiden>>&.
14023
14024
14025
14026 .option log_file_path main "string list&!!" "set at compile time"
14027 .cindex "log" "file path for"
14028 This option sets the path which is used to determine the names of Exim's log
14029 files, or indicates that logging is to be to syslog, or both. It is expanded
14030 when Exim is entered, so it can, for example, contain a reference to the host
14031 name. If no specific path is set for the log files at compile or run time, they
14032 are written in a sub-directory called &_log_& in Exim's spool directory.
14033 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14034 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14035 used. If this string is fixed at your installation (contains no expansion
14036 variables) it is recommended that you do not set this option in the
14037 configuration file, but instead supply the path using LOG_FILE_PATH in
14038 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14039 early on &-- in particular, failure to read the configuration file.
14040
14041
14042 .option log_selector main string unset
14043 .cindex "log" "selectors"
14044 This option can be used to reduce or increase the number of things that Exim
14045 writes to its log files. Its argument is made up of names preceded by plus or
14046 minus characters. For example:
14047 .code
14048 log_selector = +arguments -retry_defer
14049 .endd
14050 A list of possible names and what they control is given in the chapter on
14051 logging, in section &<<SECTlogselector>>&.
14052
14053
14054 .option log_timezone main boolean false
14055 .cindex "log" "timezone for entries"
14056 .vindex "&$tod_log$&"
14057 .vindex "&$tod_zone$&"
14058 By default, the timestamps on log lines are in local time without the
14059 timezone. This means that if your timezone changes twice a year, the timestamps
14060 in log lines are ambiguous for an hour when the clocks go back. One way of
14061 avoiding this problem is to set the timezone to UTC. An alternative is to set
14062 &%log_timezone%& true. This turns on the addition of the timezone offset to
14063 timestamps in log lines. Turning on this option can add quite a lot to the size
14064 of log files because each line is extended by 6 characters. Note that the
14065 &$tod_log$& variable contains the log timestamp without the zone, but there is
14066 another variable called &$tod_zone$& that contains just the timezone offset.
14067
14068
14069 .option lookup_open_max main integer 25
14070 .cindex "too many open files"
14071 .cindex "open files, too many"
14072 .cindex "file" "too many open"
14073 .cindex "lookup" "maximum open files"
14074 .cindex "limit" "open files for lookups"
14075 This option limits the number of simultaneously open files for single-key
14076 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14077 Exim normally keeps these files open during routing, because often the same
14078 file is required several times. If the limit is reached, Exim closes the least
14079 recently used file. Note that if you are using the &'ndbm'& library, it
14080 actually opens two files for each logical DBM database, though it still counts
14081 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14082 open files"& errors with NDBM, you need to reduce the value of
14083 &%lookup_open_max%&.
14084
14085
14086 .option max_username_length main integer 0
14087 .cindex "length of login name"
14088 .cindex "user name" "maximum length"
14089 .cindex "limit" "user name length"
14090 Some operating systems are broken in that they truncate long arguments to
14091 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14092 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14093 an argument that is longer behaves as if &[getpwnam()]& failed.
14094
14095
14096 .option message_body_newlines main bool false
14097 .cindex "message body" "newlines in variables"
14098 .cindex "newline" "in message body variables"
14099 .vindex "&$message_body$&"
14100 .vindex "&$message_body_end$&"
14101 By default, newlines in the message body are replaced by spaces when setting
14102 the &$message_body$& and &$message_body_end$& expansion variables. If this
14103 option is set true, this no longer happens.
14104
14105
14106 .option message_body_visible main integer 500
14107 .cindex "body of message" "visible size"
14108 .cindex "message body" "visible size"
14109 .vindex "&$message_body$&"
14110 .vindex "&$message_body_end$&"
14111 This option specifies how much of a message's body is to be included in the
14112 &$message_body$& and &$message_body_end$& expansion variables.
14113
14114
14115 .option message_id_header_domain main string&!! unset
14116 .cindex "&'Message-ID:'& header line"
14117 If this option is set, the string is expanded and used as the right hand side
14118 (domain) of the &'Message-ID:'& header that Exim creates if a
14119 locally-originated incoming message does not have one. &"Locally-originated"&
14120 means &"not received over TCP/IP."&
14121 Otherwise, the primary host name is used.
14122 Only letters, digits, dot and hyphen are accepted; any other characters are
14123 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14124 empty string, the option is ignored.
14125
14126
14127 .option message_id_header_text main string&!! unset
14128 If this variable is set, the string is expanded and used to augment the text of
14129 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14130 message does not have one. The text of this header is required by RFC 2822 to
14131 take the form of an address. By default, Exim uses its internal message id as
14132 the local part, and the primary host name as the domain. If this option is set,
14133 it is expanded, and provided the expansion is not forced to fail, and does not
14134 yield an empty string, the result is inserted into the header immediately
14135 before the @, separated from the internal message id by a dot. Any characters
14136 that are illegal in an address are automatically converted into hyphens. This
14137 means that variables such as &$tod_log$& can be used, because the spaces and
14138 colons will become hyphens.
14139
14140
14141 .option message_logs main boolean true
14142 .cindex "message logs" "disabling"
14143 .cindex "log" "message log; disabling"
14144 If this option is turned off, per-message log files are not created in the
14145 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14146 Exim, by reducing the number of files involved in handling a message from a
14147 minimum of four (header spool file, body spool file, delivery journal, and
14148 per-message log) to three. The other major I/O activity is Exim's main log,
14149 which is not affected by this option.
14150
14151
14152 .option message_size_limit main string&!! 50M
14153 .cindex "message" "size limit"
14154 .cindex "limit" "message size"
14155 .cindex "size" "of message, limit"
14156 This option limits the maximum size of message that Exim will process. The
14157 value is expanded for each incoming connection so, for example, it can be made
14158 to depend on the IP address of the remote host for messages arriving via
14159 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14160 optionally followed by K or M.
14161
14162 &*Note*&: This limit cannot be made to depend on a message's sender or any
14163 other properties of an individual message, because it has to be advertised in
14164 the server's response to EHLO. String expansion failure causes a temporary
14165 error. A value of zero means no limit, but its use is not recommended. See also
14166 &%bounce_return_size_limit%&.
14167
14168 Incoming SMTP messages are failed with a 552 error if the limit is
14169 exceeded; locally-generated messages either get a stderr message or a delivery
14170 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14171 an oversized message is logged in both the main and the reject logs. See also
14172 the generic transport option &%message_size_limit%&, which limits the size of
14173 message that an individual transport can process.
14174
14175 .new
14176 If you use a virus-scanner and set this option to to a value larger than the
14177 maximum size that your virus-scanner is configured to support, you may get
14178 failures triggered by large mails.  The right size to configure for the
14179 virus-scanner depends upon what data is passed and the options in use but it's
14180 probably safest to just set it to a little larger than this value.  Eg, with a
14181 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14182 some problems may result.
14183 .wen
14184
14185
14186 .option move_frozen_messages main boolean false
14187 .cindex "frozen messages" "moving"
14188 This option, which is available only if Exim has been built with the setting
14189 .code
14190 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14191 .endd
14192 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14193 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14194 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14195 standard utilities for handling such moved messages, and they do not show up in
14196 lists generated by &%-bp%& or by the Exim monitor.
14197
14198
14199 .option mua_wrapper main boolean false
14200 Setting this option true causes Exim to run in a very restrictive mode in which
14201 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14202 contains a full description of this facility.
14203
14204
14205
14206 .option mysql_servers main "string list" unset
14207 .cindex "MySQL" "server list"
14208 This option provides a list of MySQL servers and associated connection data, to
14209 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14210 option is available only if Exim has been built with MySQL support.
14211
14212
14213 .option never_users main "string list&!!" unset
14214 This option is expanded just once, at the start of Exim's processing. Local
14215 message deliveries are normally run in processes that are setuid to the
14216 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14217 It is usually desirable to prevent any deliveries from running as root, as a
14218 safety precaution.
14219
14220 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14221 list of users that must not be used for local deliveries. This list is fixed in
14222 the binary and cannot be overridden by the configuration file. By default, it
14223 contains just the single user name &"root"&. The &%never_users%& runtime option
14224 can be used to add more users to the fixed list.
14225
14226 If a message is to be delivered as one of the users on the fixed list or the
14227 &%never_users%& list, an error occurs, and delivery is deferred. A common
14228 example is
14229 .code
14230 never_users = root:daemon:bin
14231 .endd
14232 Including root is redundant if it is also on the fixed list, but it does no
14233 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14234 transport driver.
14235
14236
14237 .new
14238 .option openssl_options main "string list" +dont_insert_empty_fragments
14239 .cindex "OpenSSL "compatibility options"
14240 This option allows an administrator to adjust the SSL options applied
14241 by OpenSSL to connections.  It is given as a space-separated list of items,
14242 each one to be +added or -subtracted from the current value.  The default
14243 value is one option which happens to have been set historically.  You can
14244 remove all options with:
14245 .code
14246 openssl_options = -all
14247 .endd
14248 This option is only available if Exim is built against OpenSSL.  The values
14249 available for this option vary according to the age of your OpenSSL install.
14250 The &"all"& value controls a subset of flags which are available, typically
14251 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14252 list the values known on your system and Exim should support all the
14253 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14254 names lose the leading &"SSL_OP_"& and are lower-cased.
14255
14256 Note that adjusting the options can have severe impact upon the security of
14257 SSL as used by Exim.  It is possible to disable safety checks and shoot
14258 yourself in the foot in various unpleasant ways.  This option should not be
14259 adjusted lightly.  An unrecognised item will be detected at by invoking Exim
14260 with the &%-bV%& flag.
14261
14262 An example:
14263 .code
14264 openssl_options = -all +microsoft_big_sslv3_buffer
14265 .endd
14266 .wen
14267
14268
14269 .option oracle_servers main "string list" unset
14270 .cindex "Oracle" "server list"
14271 This option provides a list of Oracle servers and associated connection data,
14272 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14273 The option is available only if Exim has been built with Oracle support.
14274
14275
14276 .option percent_hack_domains main "domain list&!!" unset
14277 .cindex "&""percent hack""&"
14278 .cindex "source routing" "in email address"
14279 .cindex "address" "source-routed"
14280 The &"percent hack"& is the convention whereby a local part containing a
14281 percent sign is re-interpreted as a new email address, with the percent
14282 replaced by @. This is sometimes called &"source routing"&, though that term is
14283 also applied to RFC 2822 addresses that begin with an @ character. If this
14284 option is set, Exim implements the percent facility for those domains listed,
14285 but no others. This happens before an incoming SMTP address is tested against
14286 an ACL.
14287
14288 &*Warning*&: The &"percent hack"& has often been abused by people who are
14289 trying to get round relaying restrictions. For this reason, it is best avoided
14290 if at all possible. Unfortunately, a number of less security-conscious MTAs
14291 implement it unconditionally. If you are running Exim on a gateway host, and
14292 routing mail through to internal MTAs without processing the local parts, it is
14293 a good idea to reject recipient addresses with percent characters in their
14294 local parts. Exim's default configuration does this.
14295
14296
14297 .option perl_at_start main boolean false
14298 This option is available only when Exim is built with an embedded Perl
14299 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14300
14301
14302 .option perl_startup main string unset
14303 This option is available only when Exim is built with an embedded Perl
14304 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14305
14306
14307 .option pgsql_servers main "string list" unset
14308 .cindex "PostgreSQL lookup type" "server list"
14309 This option provides a list of PostgreSQL servers and associated connection
14310 data, to be used in conjunction with &(pgsql)& lookups (see section
14311 &<<SECID72>>&). The option is available only if Exim has been built with
14312 PostgreSQL support.
14313
14314
14315 .option pid_file_path main string&!! "set at compile time"
14316 .cindex "daemon" "pid file path"
14317 .cindex "pid file, path for"
14318 This option sets the name of the file to which the Exim daemon writes its
14319 process id. The string is expanded, so it can contain, for example, references
14320 to the host name:
14321 .code
14322 pid_file_path = /var/log/$primary_hostname/exim.pid
14323 .endd
14324 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14325 spool directory.
14326 The value set by the option can be overridden by the &%-oP%& command line
14327 option. A pid file is not written if a &"non-standard"& daemon is run by means
14328 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14329
14330
14331 .option pipelining_advertise_hosts main "host list&!!" *
14332 .cindex "PIPELINING" "suppressing advertising"
14333 This option can be used to suppress the advertisement of the SMTP
14334 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14335 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14336 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14337 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14338 that clients will use it; &"out of order"& commands that are &"expected"& do
14339 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14340
14341
14342 .option preserve_message_logs main boolean false
14343 .cindex "message logs" "preserving"
14344 If this option is set, message log files are not deleted when messages are
14345 completed. Instead, they are moved to a sub-directory of the spool directory
14346 called &_msglog.OLD_&, where they remain available for statistical or debugging
14347 purposes. This is a dangerous option to set on systems with any appreciable
14348 volume of mail. Use with care!
14349
14350
14351 .option primary_hostname main string "see below"
14352 .cindex "name" "of local host"
14353 .cindex "host" "name of local"
14354 .cindex "local host" "name of"
14355 .vindex "&$primary_hostname$&"
14356 This specifies the name of the current host. It is used in the default EHLO or
14357 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14358 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14359 The value is also used by default in some SMTP response messages from an Exim
14360 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14361
14362 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14363 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14364 contains only one component, Exim passes it to &[gethostbyname()]& (or
14365 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14366 version. The variable &$primary_hostname$& contains the host name, whether set
14367 explicitly by this option, or defaulted.
14368
14369
14370 .option print_topbitchars main boolean false
14371 .cindex "printing characters"
14372 .cindex "8-bit characters"
14373 By default, Exim considers only those characters whose codes lie in the range
14374 32&--126 to be printing characters. In a number of circumstances (for example,
14375 when writing log entries) non-printing characters are converted into escape
14376 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14377 is set, code values of 128 and above are also considered to be printing
14378 characters.
14379
14380 This option also affects the header syntax checks performed by the
14381 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14382 the user's full name when constructing From: and Sender: addresses (as
14383 described in section &<<SECTconstr>>&). Setting this option can cause
14384 Exim to generate eight bit message headers that do not conform to the
14385 standards.
14386
14387
14388 .option process_log_path main string unset
14389 .cindex "process log path"
14390 .cindex "log" "process log"
14391 .cindex "&'exiwhat'&"
14392 This option sets the name of the file to which an Exim process writes its
14393 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14394 utility script. If this option is unset, the file called &_exim-process.info_&
14395 in Exim's spool directory is used. The ability to specify the name explicitly
14396 can be useful in environments where two different Exims are running, using
14397 different spool directories.
14398
14399
14400 .option prod_requires_admin main boolean true
14401 .oindex "&%-M%&"
14402 .oindex "&%-R%&"
14403 .oindex "&%-q%&"
14404 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14405 admin user unless &%prod_requires_admin%& is set false. See also
14406 &%queue_list_requires_admin%&.
14407
14408
14409 .option qualify_domain main string "see below"
14410 .cindex "domain" "for qualifying addresses"
14411 .cindex "address" "qualification"
14412 This option specifies the domain name that is added to any envelope sender
14413 addresses that do not have a domain qualification. It also applies to
14414 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
14415 are accepted by default only for locally-generated messages. Qualification is
14416 also applied to addresses in header lines such as &'From:'& and &'To:'& for
14417 locally-generated messages, unless the &%-bnq%& command line option is used.
14418
14419 Messages from external sources must always contain fully qualified addresses,
14420 unless the sending host matches &%sender_unqualified_hosts%& or
14421 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
14422 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
14423 necessary. Internally, Exim always works with fully qualified envelope
14424 addresses. If &%qualify_domain%& is not set, it defaults to the
14425 &%primary_hostname%& value.
14426
14427
14428 .option qualify_recipient main string "see below"
14429 This option allows you to specify a different domain for qualifying recipient
14430 addresses to the one that is used for senders. See &%qualify_domain%& above.
14431
14432
14433
14434 .option queue_domains main "domain list&!!" unset
14435 .cindex "domain" "specifying non-immediate delivery"
14436 .cindex "queueing incoming messages"
14437 .cindex "message" "queueing certain domains"
14438 This option lists domains for which immediate delivery is not required.
14439 A delivery process is started whenever a message is received, but only those
14440 domains that do not match are processed. All other deliveries wait until the
14441 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
14442
14443
14444 .option queue_list_requires_admin main boolean true
14445 .oindex "&%-bp%&"
14446 The &%-bp%& command-line option, which lists the messages that are on the
14447 queue, requires the caller to be an admin user unless
14448 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
14449
14450
14451 .option queue_only main boolean false
14452 .cindex "queueing incoming messages"
14453 .cindex "message" "queueing unconditionally"
14454 If &%queue_only%& is set, a delivery process is not automatically started
14455 whenever a message is received. Instead, the message waits on the queue for the
14456 next queue run. Even if &%queue_only%& is false, incoming messages may not get
14457 delivered immediately when certain conditions (such as heavy load) occur.
14458
14459 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
14460 and &%-odi%& command line options override &%queue_only%& unless
14461 &%queue_only_override%& is set false. See also &%queue_only_file%&,
14462 &%queue_only_load%&, and &%smtp_accept_queue%&.
14463
14464
14465 .option queue_only_file main string unset
14466 .cindex "queueing incoming messages"
14467 .cindex "message" "queueing by file existence"
14468 This option can be set to a colon-separated list of absolute path names, each
14469 one optionally preceded by &"smtp"&. When Exim is receiving a message,
14470 it tests for the existence of each listed path using a call to &[stat()]&. For
14471 each path that exists, the corresponding queueing option is set.
14472 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
14473 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
14474 .code
14475 queue_only_file = smtp/some/file
14476 .endd
14477 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
14478 &_/some/file_& exists.
14479
14480
14481 .option queue_only_load main fixed-point unset
14482 .cindex "load average"
14483 .cindex "queueing incoming messages"
14484 .cindex "message" "queueing by load"
14485 If the system load average is higher than this value, incoming messages from
14486 all sources are queued, and no automatic deliveries are started. If this
14487 happens during local or remote SMTP input, all subsequent messages received on
14488 the same SMTP connection are queued by default, whatever happens to the load in
14489 the meantime, but this can be changed by setting &%queue_only_load_latch%&
14490 false.
14491
14492 Deliveries will subsequently be performed by queue runner processes. This
14493 option has no effect on ancient operating systems on which Exim cannot
14494 determine the load average. See also &%deliver_queue_load_max%& and
14495 &%smtp_load_reserve%&.
14496
14497
14498 .option queue_only_load_latch main boolean true
14499 .cindex "load average" "re-evaluating per message"
14500 When this option is true (the default), once one message has been queued
14501 because the load average is higher than the value set by &%queue_only_load%&,
14502 all subsequent messages received on the same SMTP connection are also queued.
14503 This is a deliberate choice; even though the load average may fall below the
14504 threshold, it doesn't seem right to deliver later messages on the same
14505 connection when not delivering earlier ones. However, there are special
14506 circumstances such as very long-lived connections from scanning appliances
14507 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
14508 should be set false. This causes the value of the load average to be
14509 re-evaluated for each message.
14510
14511
14512 .option queue_only_override main boolean true
14513 .cindex "queueing incoming messages"
14514 When this option is true, the &%-od%&&'x'& command line options override the
14515 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
14516 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
14517 to override; they are accepted, but ignored.
14518
14519
14520 .option queue_run_in_order main boolean false
14521 .cindex "queue runner" "processing messages in order"
14522 If this option is set, queue runs happen in order of message arrival instead of
14523 in an arbitrary order. For this to happen, a complete list of the entire queue
14524 must be set up before the deliveries start. When the queue is all held in a
14525 single directory (the default), a single list is created for both the ordered
14526 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
14527 single list is not created when &%queue_run_in_order%& is false. In this case,
14528 the sub-directories are processed one at a time (in a random order), and this
14529 avoids setting up one huge list for the whole queue. Thus, setting
14530 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
14531 when the queue is large, because of the extra work in setting up the single,
14532 large list. In most situations, &%queue_run_in_order%& should not be set.
14533
14534
14535
14536 .option queue_run_max main integer 5
14537 .cindex "queue runner" "maximum number of"
14538 This controls the maximum number of queue runner processes that an Exim daemon
14539 can run simultaneously. This does not mean that it starts them all at once,
14540 but rather that if the maximum number are still running when the time comes to
14541 start another one, it refrains from starting another one. This can happen with
14542 very large queues and/or very sluggish deliveries. This option does not,
14543 however, interlock with other processes, so additional queue runners can be
14544 started by other means, or by killing and restarting the daemon.
14545
14546 Setting this option to zero does not suppress queue runs; rather, it disables
14547 the limit, allowing any number of simultaneous queue runner processes to be
14548 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
14549 the daemon's command line.
14550
14551 .option queue_smtp_domains main "domain list&!!" unset
14552 .cindex "queueing incoming messages"
14553 .cindex "message" "queueing remote deliveries"
14554 When this option is set, a delivery process is started whenever a message is
14555 received, routing is performed, and local deliveries take place.
14556 However, if any SMTP deliveries are required for domains that match
14557 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
14558 message waits on the queue for the next queue run. Since routing of the message
14559 has taken place, Exim knows to which remote hosts it must be delivered, and so
14560 when the queue run happens, multiple messages for the same host are delivered
14561 over a single SMTP connection. The &%-odqs%& command line option causes all
14562 SMTP deliveries to be queued in this way, and is equivalent to setting
14563 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
14564 &%queue_domains%&.
14565
14566
14567 .option receive_timeout main time 0s
14568 .cindex "timeout" "for non-SMTP input"
14569 This option sets the timeout for accepting a non-SMTP message, that is, the
14570 maximum time that Exim waits when reading a message on the standard input. If
14571 the value is zero, it will wait for ever. This setting is overridden by the
14572 &%-or%& command line option. The timeout for incoming SMTP messages is
14573 controlled by &%smtp_receive_timeout%&.
14574
14575 .option received_header_text main string&!! "see below"
14576 .cindex "customizing" "&'Received:'& header"
14577 .cindex "&'Received:'& header line" "customizing"
14578 This string defines the contents of the &'Received:'& message header that is
14579 added to each message, except for the timestamp, which is automatically added
14580 on at the end (preceded by a semicolon). The string is expanded each time it is
14581 used. If the expansion yields an empty string, no &'Received:'& header line is
14582 added to the message. Otherwise, the string should start with the text
14583 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
14584 header lines. The default setting is:
14585
14586 .code
14587 received_header_text = Received: \
14588   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
14589   {${if def:sender_ident \
14590   {from ${quote_local_part:$sender_ident} }}\
14591   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
14592   by $primary_hostname \
14593   ${if def:received_protocol {with $received_protocol}} \
14594   ${if def:tls_cipher {($tls_cipher)\n\t}}\
14595   (Exim $version_number)\n\t\
14596   ${if def:sender_address \
14597   {(envelope-from <$sender_address>)\n\t}}\
14598   id $message_exim_id\
14599   ${if def:received_for {\n\tfor $received_for}}
14600 .endd
14601
14602 The reference to the TLS cipher is omitted when Exim is built without TLS
14603 support. The use of conditional expansions ensures that this works for both
14604 locally generated messages and messages received from remote hosts, giving
14605 header lines such as the following:
14606 .code
14607 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
14608 by marley.carol.example with esmtp (Exim 4.00)
14609 (envelope-from <bob@carol.example>)
14610 id 16IOWa-00019l-00
14611 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
14612 Received: by scrooge.carol.example with local (Exim 4.00)
14613 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
14614 .endd
14615 Until the body of the message has been received, the timestamp is the time when
14616 the message started to be received. Once the body has arrived, and all policy
14617 checks have taken place, the timestamp is updated to the time at which the
14618 message was accepted.
14619
14620
14621 .option received_headers_max main integer 30
14622 .cindex "loop" "prevention"
14623 .cindex "mail loop prevention"
14624 .cindex "&'Received:'& header line" "counting"
14625 When a message is to be delivered, the number of &'Received:'& headers is
14626 counted, and if it is greater than this parameter, a mail loop is assumed to
14627 have occurred, the delivery is abandoned, and an error message is generated.
14628 This applies to both local and remote deliveries.
14629
14630
14631 .option recipient_unqualified_hosts main "host list&!!" unset
14632 .cindex "unqualified addresses"
14633 .cindex "host" "unqualified addresses from"
14634 This option lists those hosts from which Exim is prepared to accept unqualified
14635 recipient addresses in message envelopes. The addresses are made fully
14636 qualified by the addition of the &%qualify_recipient%& value. This option also
14637 affects message header lines. Exim does not reject unqualified recipient
14638 addresses in headers, but it qualifies them only if the message came from a
14639 host that matches &%recipient_unqualified_hosts%&,
14640 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
14641 option was not set.
14642
14643
14644 .option recipients_max main integer 0
14645 .cindex "limit" "number of recipients"
14646 .cindex "recipient" "maximum number"
14647 If this option is set greater than zero, it specifies the maximum number of
14648 original recipients for any message. Additional recipients that are generated
14649 by aliasing or forwarding do not count. SMTP messages get a 452 response for
14650 all recipients over the limit; earlier recipients are delivered as normal.
14651 Non-SMTP messages with too many recipients are failed, and no deliveries are
14652 done.
14653
14654 .cindex "RCPT" "maximum number of incoming"
14655 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
14656 RCPT commands in a single message.
14657
14658
14659 .option recipients_max_reject main boolean false
14660 If this option is set true, Exim rejects SMTP messages containing too many
14661 recipients by giving 552 errors to the surplus RCPT commands, and a 554
14662 error to the eventual DATA command. Otherwise (the default) it gives a 452
14663 error to the surplus RCPT commands and accepts the message on behalf of the
14664 initial set of recipients. The remote server should then re-send the message
14665 for the remaining recipients at a later time.
14666
14667
14668 .option remote_max_parallel main integer 2
14669 .cindex "delivery" "parallelism for remote"
14670 This option controls parallel delivery of one message to a number of remote
14671 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
14672 does all the remote deliveries for a message one by one. Otherwise, if a single
14673 message has to be delivered to more than one remote host, or if several copies
14674 have to be sent to the same remote host, up to &%remote_max_parallel%&
14675 deliveries are done simultaneously. If more than &%remote_max_parallel%&
14676 deliveries are required, the maximum number of processes are started, and as
14677 each one finishes, another is begun. The order of starting processes is the
14678 same as if sequential delivery were being done, and can be controlled by the
14679 &%remote_sort_domains%& option. If parallel delivery takes place while running
14680 with debugging turned on, the debugging output from each delivery process is
14681 tagged with its process id.
14682
14683 This option controls only the maximum number of parallel deliveries for one
14684 message in one Exim delivery process. Because Exim has no central queue
14685 manager, there is no way of controlling the total number of simultaneous
14686 deliveries if the configuration allows a delivery attempt as soon as a message
14687 is received.
14688
14689 .cindex "number of deliveries"
14690 .cindex "delivery" "maximum number of"
14691 If you want to control the total number of deliveries on the system, you
14692 need to set the &%queue_only%& option. This ensures that all incoming messages
14693 are added to the queue without starting a delivery process. Then set up an Exim
14694 daemon to start queue runner processes at appropriate intervals (probably
14695 fairly often, for example, every minute), and limit the total number of queue
14696 runners by setting the &%queue_run_max%& parameter. Because each queue runner
14697 delivers only one message at a time, the maximum number of deliveries that can
14698 then take place at once is &%queue_run_max%& multiplied by
14699 &%remote_max_parallel%&.
14700
14701 If it is purely remote deliveries you want to control, use
14702 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
14703 doing the SMTP routing before queueing, so that several messages for the same
14704 host will eventually get delivered down the same connection.
14705
14706
14707 .option remote_sort_domains main "domain list&!!" unset
14708 .cindex "sorting remote deliveries"
14709 .cindex "delivery" "sorting remote"
14710 When there are a number of remote deliveries for a message, they are sorted by
14711 domain into the order given by this list. For example,
14712 .code
14713 remote_sort_domains = *.cam.ac.uk:*.uk
14714 .endd
14715 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
14716 then to those in the &%uk%& domain, then to any others.
14717
14718
14719 .option retry_data_expire main time 7d
14720 .cindex "hints database" "data expiry"
14721 This option sets a &"use before"& time on retry information in Exim's hints
14722 database. Any older retry data is ignored. This means that, for example, once a
14723 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
14724 past failures.
14725
14726
14727 .option retry_interval_max main time 24h
14728 .cindex "retry" "limit on interval"
14729 .cindex "limit" "on retry interval"
14730 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
14731 intervals between delivery attempts for messages that cannot be delivered
14732 straight away. This option sets an overall limit to the length of time between
14733 retries. It cannot be set greater than 24 hours; any attempt to do so forces
14734 the default value.
14735
14736
14737 .option return_path_remove main boolean true
14738 .cindex "&'Return-path:'& header line" "removing"
14739 RFC 2821, section 4.4, states that an SMTP server must insert a
14740 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
14741 The &'Return-path:'& header preserves the sender address as received in the
14742 MAIL command. This description implies that this header should not be present
14743 in an incoming message. If &%return_path_remove%& is true, any existing
14744 &'Return-path:'& headers are removed from messages at the time they are
14745 received. Exim's transports have options for adding &'Return-path:'& headers at
14746 the time of delivery. They are normally used only for final local deliveries.
14747
14748
14749 .option return_size_limit main integer 100K
14750 This option is an obsolete synonym for &%bounce_return_size_limit%&.
14751
14752
14753 .option rfc1413_hosts main "host list&!!" *
14754 .cindex "RFC 1413"
14755 .cindex "host" "for RFC 1413 calls"
14756 RFC 1413 identification calls are made to any client host which matches an item
14757 in the list.
14758
14759 .option rfc1413_query_timeout main time 5s
14760 .cindex "RFC 1413" "query timeout"
14761 .cindex "timeout" "for RFC 1413 call"
14762 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
14763 no RFC 1413 calls are ever made.
14764
14765
14766 .option sender_unqualified_hosts main "host list&!!" unset
14767 .cindex "unqualified addresses"
14768 .cindex "host" "unqualified addresses from"
14769 This option lists those hosts from which Exim is prepared to accept unqualified
14770 sender addresses. The addresses are made fully qualified by the addition of
14771 &%qualify_domain%&. This option also affects message header lines. Exim does
14772 not reject unqualified addresses in headers that contain sender addresses, but
14773 it qualifies them only if the message came from a host that matches
14774 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
14775 using TCP/IP), and the &%-bnq%& option was not set.
14776
14777
14778 .option smtp_accept_keepalive main boolean true
14779 .cindex "keepalive" "on incoming connection"
14780 This option controls the setting of the SO_KEEPALIVE option on incoming
14781 TCP/IP socket connections. When set, it causes the kernel to probe idle
14782 connections periodically, by sending packets with &"old"& sequence numbers. The
14783 other end of the connection should send an acknowledgment if the connection is
14784 still okay or a reset if the connection has been aborted. The reason for doing
14785 this is that it has the beneficial effect of freeing up certain types of
14786 connection that can get stuck when the remote host is disconnected without
14787 tidying up the TCP/IP call properly. The keepalive mechanism takes several
14788 hours to detect unreachable hosts.
14789
14790
14791
14792 .option smtp_accept_max main integer 20
14793 .cindex "limit" "incoming SMTP connections"
14794 .cindex "SMTP" "incoming connection count"
14795 .cindex "inetd"
14796 This option specifies the maximum number of simultaneous incoming SMTP calls
14797 that Exim will accept. It applies only to the listening daemon; there is no
14798 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
14799 value is set to zero, no limit is applied. However, it is required to be
14800 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
14801 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
14802
14803 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
14804 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
14805 that limit has not been reached for the client host, &%smtp_accept_reserve%&
14806 and &%smtp_load_reserve%& are then checked before accepting the connection.
14807
14808
14809 .option smtp_accept_max_nonmail main integer 10
14810 .cindex "limit" "non-mail SMTP commands"
14811 .cindex "SMTP" "limiting non-mail commands"
14812 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
14813 the connection if there are too many. This option defines &"too many"&. The
14814 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
14815 client looping sending EHLO, for example. The check is applied only if the
14816 client host matches &%smtp_accept_max_nonmail_hosts%&.
14817
14818 When a new message is expected, one occurrence of RSET is not counted. This
14819 allows a client to send one RSET between messages (this is not necessary,
14820 but some clients do it). Exim also allows one uncounted occurrence of HELO
14821 or EHLO, and one occurrence of STARTTLS between messages. After
14822 starting up a TLS session, another EHLO is expected, and so it too is not
14823 counted. The first occurrence of AUTH in a connection, or immediately
14824 following STARTTLS is not counted. Otherwise, all commands other than
14825 MAIL, RCPT, DATA, and QUIT are counted.
14826
14827
14828 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
14829 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
14830 check by setting this option. The default value makes it apply to all hosts. By
14831 changing the value, you can exclude any badly-behaved hosts that you have to
14832 live with.
14833
14834
14835 . Allow this long option name to split; give it unsplit as a fifth argument
14836 . for the automatic .oindex that is generated by .option.
14837
14838 .option "smtp_accept_max_per_ &~&~connection" main integer 1000 &&&
14839          smtp_accept_max_per_connection
14840 .cindex "SMTP" "limiting incoming message count"
14841 .cindex "limit" "messages per SMTP connection"
14842 The value of this option limits the number of MAIL commands that Exim is
14843 prepared to accept over a single SMTP connection, whether or not each command
14844 results in the transfer of a message. After the limit is reached, a 421
14845 response is given to subsequent MAIL commands. This limit is a safety
14846 precaution against a client that goes mad (incidents of this type have been
14847 seen).
14848
14849
14850 .option smtp_accept_max_per_host main string&!! unset
14851 .cindex "limit" "SMTP connections from one host"
14852 .cindex "host" "limiting SMTP connections from"
14853 This option restricts the number of simultaneous IP connections from a single
14854 host (strictly, from a single IP address) to the Exim daemon. The option is
14855 expanded, to enable different limits to be applied to different hosts by
14856 reference to &$sender_host_address$&. Once the limit is reached, additional
14857 connection attempts from the same host are rejected with error code 421. This
14858 is entirely independent of &%smtp_accept_reserve%&. The option's default value
14859 of zero imposes no limit. If this option is set greater than zero, it is
14860 required that &%smtp_accept_max%& be non-zero.
14861
14862 &*Warning*&: When setting this option you should not use any expansion
14863 constructions that take an appreciable amount of time. The expansion and test
14864 happen in the main daemon loop, in order to reject additional connections
14865 without forking additional processes (otherwise a denial-of-service attack
14866 could cause a vast number or processes to be created). While the daemon is
14867 doing this processing, it cannot accept any other incoming connections.
14868
14869
14870
14871 .option smtp_accept_queue main integer 0
14872 .cindex "SMTP" "incoming connection count"
14873 .cindex "queueing incoming messages"
14874 .cindex "message" "queueing by SMTP connection count"
14875 If the number of simultaneous incoming SMTP connections being handled via the
14876 listening daemon exceeds this value, messages received by SMTP are just placed
14877 on the queue; no delivery processes are started automatically. The count is
14878 fixed at the start of an SMTP connection. It cannot be updated in the
14879 subprocess that receives messages, and so the queueing or not queueing applies
14880 to all messages received in the same connection.
14881
14882 A value of zero implies no limit, and clearly any non-zero value is useful only
14883 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
14884 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
14885 various &%-od%&&'x'& command line options.
14886
14887
14888 . Allow this long option name to split; give it unsplit as a fifth argument
14889 . for the automatic .oindex that is generated by .option.
14890
14891 .option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&&
14892          smtp_accept_queue_per_connection
14893 .cindex "queueing incoming messages"
14894 .cindex "message" "queueing by message count"
14895 This option limits the number of delivery processes that Exim starts
14896 automatically when receiving messages via SMTP, whether via the daemon or by
14897 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
14898 and the number of messages received in a single SMTP session exceeds this
14899 number, subsequent messages are placed on the queue, but no delivery processes
14900 are started. This helps to limit the number of Exim processes when a server
14901 restarts after downtime and there is a lot of mail waiting for it on other
14902 systems. On large systems, the default should probably be increased, and on
14903 dial-in client systems it should probably be set to zero (that is, disabled).
14904
14905
14906 .option smtp_accept_reserve main integer 0
14907 .cindex "SMTP" "incoming call count"
14908 .cindex "host" "reserved"
14909 When &%smtp_accept_max%& is set greater than zero, this option specifies a
14910 number of SMTP connections that are reserved for connections from the hosts
14911 that are specified in &%smtp_reserve_hosts%&. The value set in
14912 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
14913 restricted to this number of connections; the option specifies a minimum number
14914 of connection slots for them, not a maximum. It is a guarantee that this group
14915 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
14916 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
14917 individual host.
14918
14919 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
14920 set to 5, once there are 45 active connections (from any hosts), new
14921 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
14922 provided the other criteria for acceptance are met.
14923
14924
14925 .option smtp_active_hostname main string&!! unset
14926 .cindex "host" "name in SMTP responses"
14927 .cindex "SMTP" "host name in responses"
14928 .vindex "&$primary_hostname$&"
14929 This option is provided for multi-homed servers that want to masquerade as
14930 several different hosts. At the start of an incoming SMTP connection, its value
14931 is expanded and used instead of the value of &$primary_hostname$& in SMTP
14932 responses. For example, it is used as domain name in the response to an
14933 incoming HELO or EHLO command.
14934
14935 .vindex "&$smtp_active_hostname$&"
14936 The active hostname is placed in the &$smtp_active_hostname$& variable, which
14937 is saved with any messages that are received. It is therefore available for use
14938 in routers and transports when the message is later delivered.
14939
14940 If this option is unset, or if its expansion is forced to fail, or if the
14941 expansion results in an empty string, the value of &$primary_hostname$& is
14942 used. Other expansion failures cause a message to be written to the main and
14943 panic logs, and the SMTP command receives a temporary error. Typically, the
14944 value of &%smtp_active_hostname%& depends on the incoming interface address.
14945 For example:
14946 .code
14947 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
14948   {cox.mydomain}{box.mydomain}}
14949 .endd
14950
14951 Although &$smtp_active_hostname$& is primarily concerned with incoming
14952 messages, it is also used as the default for HELO commands in callout
14953 verification if there is no remote transport from which to obtain a
14954 &%helo_data%& value.
14955
14956 .option smtp_banner main string&!! "see below"
14957 .cindex "SMTP" "welcome banner"
14958 .cindex "banner for SMTP"
14959 .cindex "welcome banner for SMTP"
14960 .cindex "customizing" "SMTP banner"
14961 This string, which is expanded every time it is used, is output as the initial
14962 positive response to an SMTP connection. The default setting is:
14963 .code
14964 smtp_banner = $smtp_active_hostname ESMTP Exim \
14965   $version_number $tod_full
14966 .endd
14967 Failure to expand the string causes a panic error. If you want to create a
14968 multiline response to the initial SMTP connection, use &"\n"& in the string at
14969 appropriate points, but not at the end. Note that the 220 code is not included
14970 in this string. Exim adds it automatically (several times in the case of a
14971 multiline response).
14972
14973
14974 .option smtp_check_spool_space main boolean true
14975 .cindex "checking disk space"
14976 .cindex "disk space, checking"
14977 .cindex "spool directory" "checking space"
14978 When this option is set, if an incoming SMTP session encounters the SIZE
14979 option on a MAIL command, it checks that there is enough space in the
14980 spool directory's partition to accept a message of that size, while still
14981 leaving free the amount specified by &%check_spool_space%& (even if that value
14982 is zero). If there isn't enough space, a temporary error code is returned.
14983
14984
14985 .option smtp_connect_backlog main integer 20
14986 .cindex "connection backlog"
14987 .cindex "SMTP" "connection backlog"
14988 .cindex "backlog of connections"
14989 This option specifies a maximum number of waiting SMTP connections. Exim passes
14990 this value to the TCP/IP system when it sets up its listener. Once this number
14991 of connections are waiting for the daemon's attention, subsequent connection
14992 attempts are refused at the TCP/IP level. At least, that is what the manuals
14993 say; in some circumstances such connection attempts have been observed to time
14994 out instead. For large systems it is probably a good idea to increase the
14995 value (to 50, say). It also gives some protection against denial-of-service
14996 attacks by SYN flooding.
14997
14998
14999 .option smtp_enforce_sync main boolean true
15000 .cindex "SMTP" "synchronization checking"
15001 .cindex "synchronization checking in SMTP"
15002 The SMTP protocol specification requires the client to wait for a response from
15003 the server at certain points in the dialogue. Without PIPELINING these
15004 synchronization points are after every command; with PIPELINING they are
15005 fewer, but they still exist.
15006
15007 Some spamming sites send out a complete set of SMTP commands without waiting
15008 for any response. Exim protects against this by rejecting a message if the
15009 client has sent further input when it should not have. The error response &"554
15010 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15011 for this error cannot be perfect because of transmission delays (unexpected
15012 input may be on its way but not yet received when Exim checks). However, it
15013 does detect many instances.
15014
15015 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15016 If you want to disable the check selectively (for example, only for certain
15017 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15018 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15019
15020
15021
15022 .option smtp_etrn_command main string&!! unset
15023 .cindex "ETRN" "command to be run"
15024 .vindex "&$domain$&"
15025 If this option is set, the given command is run whenever an SMTP ETRN
15026 command is received from a host that is permitted to issue such commands (see
15027 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15028 are independently expanded. The expansion variable &$domain$& is set to the
15029 argument of the ETRN command, and no syntax checking is done on it. For
15030 example:
15031 .code
15032 smtp_etrn_command = /etc/etrn_command $domain \
15033                     $sender_host_address
15034 .endd
15035 A new process is created to run the command, but Exim does not wait for it to
15036 complete. Consequently, its status cannot be checked. If the command cannot be
15037 run, a line is written to the panic log, but the ETRN caller still receives
15038 a 250 success response. Exim is normally running under its own uid when
15039 receiving SMTP, so it is not possible for it to change the uid before running
15040 the command.
15041
15042
15043 .option smtp_etrn_serialize main boolean true
15044 .cindex "ETRN" "serializing"
15045 When this option is set, it prevents the simultaneous execution of more than
15046 one identical command as a result of ETRN in an SMTP connection. See
15047 section &<<SECTETRN>>& for details.
15048
15049
15050 .option smtp_load_reserve main fixed-point unset
15051 .cindex "load average"
15052 If the system load average ever gets higher than this, incoming SMTP calls are
15053 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15054 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15055 the load is over the limit. The option has no effect on ancient operating
15056 systems on which Exim cannot determine the load average. See also
15057 &%deliver_queue_load_max%& and &%queue_only_load%&.
15058
15059
15060
15061 .option smtp_max_synprot_errors main integer 3
15062 .cindex "SMTP" "limiting syntax and protocol errors"
15063 .cindex "limit" "SMTP syntax and protocol errors"
15064 Exim rejects SMTP commands that contain syntax or protocol errors. In
15065 particular, a syntactically invalid email address, as in this command:
15066 .code
15067 RCPT TO:<abc xyz@a.b.c>
15068 .endd
15069 causes immediate rejection of the command, before any other tests are done.
15070 (The ACL cannot be run if there is no valid address to set up for it.) An
15071 example of a protocol error is receiving RCPT before MAIL. If there are
15072 too many syntax or protocol errors in one SMTP session, the connection is
15073 dropped. The limit is set by this option.
15074
15075 .cindex "PIPELINING" "expected errors"
15076 When the PIPELINING extension to SMTP is in use, some protocol errors are
15077 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15078 Exim assumes that PIPELINING will be used if it advertises it (see
15079 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15080 not count towards the limit.
15081
15082
15083
15084 .option smtp_max_unknown_commands main integer 3
15085 .cindex "SMTP" "limiting unknown commands"
15086 .cindex "limit" "unknown SMTP commands"
15087 If there are too many unrecognized commands in an incoming SMTP session, an
15088 Exim server drops the connection. This is a defence against some kinds of abuse
15089 that subvert web
15090 clients
15091 into making connections to SMTP ports; in these circumstances, a number of
15092 non-SMTP command lines are sent first.
15093
15094
15095
15096 .option smtp_ratelimit_hosts main "host list&!!" unset
15097 .cindex "SMTP" "rate limiting"
15098 .cindex "limit" "rate of message arrival"
15099 .cindex "RCPT" "rate limiting"
15100 Some sites find it helpful to be able to limit the rate at which certain hosts
15101 can send them messages, and the rate at which an individual message can specify
15102 recipients.
15103
15104 Exim has two rate-limiting facilities. This section describes the older
15105 facility, which can limit rates within a single connection. The newer
15106 &%ratelimit%& ACL condition can limit rates across all connections. See section
15107 &<<SECTratelimiting>>& for details of the newer facility.
15108
15109 When a host matches &%smtp_ratelimit_hosts%&, the values of
15110 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15111 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15112 respectively. Each option, if set, must contain a set of four comma-separated
15113 values:
15114
15115 .ilist
15116 A threshold, before which there is no rate limiting.
15117 .next
15118 An initial time delay. Unlike other times in Exim, numbers with decimal
15119 fractional parts are allowed here.
15120 .next
15121 A factor by which to increase the delay each time.
15122 .next
15123 A maximum value for the delay. This should normally be less than 5 minutes,
15124 because after that time, the client is liable to timeout the SMTP command.
15125 .endlist
15126
15127 For example, these settings have been used successfully at the site which
15128 first suggested this feature, for controlling mail from their customers:
15129 .code
15130 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15131 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15132 .endd
15133 The first setting specifies delays that are applied to MAIL commands after
15134 two have been received over a single connection. The initial delay is 0.5
15135 seconds, increasing by a factor of 1.05 each time. The second setting applies
15136 delays to RCPT commands when more than four occur in a single message.
15137
15138
15139 .option smtp_ratelimit_mail main string unset
15140 See &%smtp_ratelimit_hosts%& above.
15141
15142
15143 .option smtp_ratelimit_rcpt main string unset
15144 See &%smtp_ratelimit_hosts%& above.
15145
15146
15147 .option smtp_receive_timeout main time 5m
15148 .cindex "timeout" "for SMTP input"
15149 .cindex "SMTP" "input timeout"
15150 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15151 input, including batch SMTP. If a line of input (either an SMTP command or a
15152 data line) is not received within this time, the SMTP connection is dropped and
15153 the message is abandoned.
15154 A line is written to the log containing one of the following messages:
15155 .code
15156 SMTP command timeout on connection from...
15157 SMTP data timeout on connection from...
15158 .endd
15159 The former means that Exim was expecting to read an SMTP command; the latter
15160 means that it was in the DATA phase, reading the contents of a message.
15161
15162
15163 .oindex "&%-os%&"
15164 The value set by this option can be overridden by the
15165 &%-os%& command-line option. A setting of zero time disables the timeout, but
15166 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15167 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15168 timeout is controlled by &%receive_timeout%& and &%-or%&.
15169
15170
15171 .option smtp_reserve_hosts main "host list&!!" unset
15172 This option defines hosts for which SMTP connections are reserved; see
15173 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15174
15175
15176 .option smtp_return_error_details main boolean false
15177 .cindex "SMTP" "details policy failures"
15178 .cindex "policy control" "rejection, returning details"
15179 In the default state, Exim uses bland messages such as
15180 &"Administrative prohibition"& when it rejects SMTP commands for policy
15181 reasons. Many sysadmins like this because it gives away little information
15182 to spammers. However, some other sysadmins who are applying strict checking
15183 policies want to give out much fuller information about failures. Setting
15184 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15185 example, instead of &"Administrative prohibition"&, it might give:
15186 .code
15187 550-Rejected after DATA: '>' missing at end of address:
15188 550 failing address in "From" header is: <user@dom.ain
15189 .endd
15190
15191 .option spamd_address main string "see below"
15192 This option is available when Exim is compiled with the content-scanning
15193 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15194 The default value is
15195 .code
15196 127.0.0.1 783
15197 .endd
15198 See section &<<SECTscanspamass>>& for more details.
15199
15200
15201
15202 .option split_spool_directory main boolean false
15203 .cindex "multiple spool directories"
15204 .cindex "spool directory" "split"
15205 .cindex "directories, multiple"
15206 If this option is set, it causes Exim to split its input directory into 62
15207 subdirectories, each with a single alphanumeric character as its name. The
15208 sixth character of the message id is used to allocate messages to
15209 subdirectories; this is the least significant base-62 digit of the time of
15210 arrival of the message.
15211
15212 Splitting up the spool in this way may provide better performance on systems
15213 where there are long mail queues, by reducing the number of files in any one
15214 directory. The msglog directory is also split up in a similar way to the input
15215 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15216 are still placed in the single directory &_msglog.OLD_&.
15217
15218 It is not necessary to take any special action for existing messages when
15219 changing &%split_spool_directory%&. Exim notices messages that are in the
15220 &"wrong"& place, and continues to process them. If the option is turned off
15221 after a period of being on, the subdirectories will eventually empty and be
15222 automatically deleted.
15223
15224 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15225 changes. Instead of creating a list of all messages in the queue, and then
15226 trying to deliver each one in turn, it constructs a list of those in one
15227 sub-directory and tries to deliver them, before moving on to the next
15228 sub-directory. The sub-directories are processed in a random order. This
15229 spreads out the scanning of the input directories, and uses less memory. It is
15230 particularly beneficial when there are lots of messages on the queue. However,
15231 if &%queue_run_in_order%& is set, none of this new processing happens. The
15232 entire queue has to be scanned and sorted before any deliveries can start.
15233
15234
15235 .option spool_directory main string&!! "set at compile time"
15236 .cindex "spool directory" "path to"
15237 This defines the directory in which Exim keeps its spool, that is, the messages
15238 it is waiting to deliver. The default value is taken from the compile-time
15239 configuration setting, if there is one. If not, this option must be set. The
15240 string is expanded, so it can contain, for example, a reference to
15241 &$primary_hostname$&.
15242
15243 If the spool directory name is fixed on your installation, it is recommended
15244 that you set it at build time rather than from this option, particularly if the
15245 log files are being written to the spool directory (see &%log_file_path%&).
15246 Otherwise log files cannot be used for errors that are detected early on, such
15247 as failures in the configuration file.
15248
15249 By using this option to override the compiled-in path, it is possible to run
15250 tests of Exim without using the standard spool.
15251
15252 .option sqlite_lock_timeout main time 5s
15253 .cindex "sqlite lookup type" "lock timeout"
15254 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15255 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15256
15257 .option strict_acl_vars main boolean false
15258 .cindex "&ACL;" "variables, handling unset"
15259 This option controls what happens if a syntactically valid but undefined ACL
15260 variable is referenced. If it is false (the default), an empty string
15261 is substituted; if it is true, an error is generated. See section
15262 &<<SECTaclvariables>>& for details of ACL variables.
15263
15264 .option strip_excess_angle_brackets main boolean false
15265 .cindex "angle brackets, excess"
15266 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15267 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15268 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15269 passed on to another MTA, the excess angle brackets are not passed on. If this
15270 option is not set, multiple pairs of angle brackets cause a syntax error.
15271
15272
15273 .option strip_trailing_dot main boolean false
15274 .cindex "trailing dot on domain"
15275 .cindex "dot" "trailing on domain"
15276 If this option is set, a trailing dot at the end of a domain in an address is
15277 ignored. If this is in the envelope and the message is passed on to another
15278 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15279 domain causes a syntax error.
15280 However, addresses in header lines are checked only when an ACL requests header
15281 syntax checking.
15282
15283
15284 .option syslog_duplication main boolean true
15285 .cindex "syslog" "duplicate log lines; suppressing"
15286 When Exim is logging to syslog, it writes the log lines for its three
15287 separate logs at different syslog priorities so that they can in principle
15288 be separated on the logging hosts. Some installations do not require this
15289 separation, and in those cases, the duplication of certain log lines is a
15290 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15291 particular log line is written to syslog. For lines that normally go to
15292 both the main log and the reject log, the reject log version (possibly
15293 containing message header lines) is written, at LOG_NOTICE priority.
15294 Lines that normally go to both the main and the panic log are written at
15295 the LOG_ALERT priority.
15296
15297
15298 .option syslog_facility main string unset
15299 .cindex "syslog" "facility; setting"
15300 This option sets the syslog &"facility"& name, used when Exim is logging to
15301 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15302 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15303 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15304 details of Exim's logging.
15305
15306
15307
15308 .option syslog_processname main string &`exim`&
15309 .cindex "syslog" "process name; setting"
15310 This option sets the syslog &"ident"& name, used when Exim is logging to
15311 syslog. The value must be no longer than 32 characters. See chapter
15312 &<<CHAPlog>>& for details of Exim's logging.
15313
15314
15315
15316 .option syslog_timestamp main boolean true
15317 .cindex "syslog" "timestamps"
15318 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15319 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15320 details of Exim's logging.
15321
15322
15323 .option system_filter main string&!! unset
15324 .cindex "filter" "system filter"
15325 .cindex "system filter" "specifying"
15326 .cindex "Sieve filter" "not available for system filter"
15327 This option specifies an Exim filter file that is applied to all messages at
15328 the start of each delivery attempt, before any routing is done. System filters
15329 must be Exim filters; they cannot be Sieve filters. If the system filter
15330 generates any deliveries to files or pipes, or any new mail messages, the
15331 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15332 which transports are to be used. Details of this facility are given in chapter
15333 &<<CHAPsystemfilter>>&.
15334
15335
15336 .option system_filter_directory_transport main string&!! unset
15337 .vindex "&$address_file$&"
15338 This sets the name of the transport driver that is to be used when the
15339 &%save%& command in a system message filter specifies a path ending in &"/"&,
15340 implying delivery of each message into a separate file in some directory.
15341 During the delivery, the variable &$address_file$& contains the path name.
15342
15343
15344 .option system_filter_file_transport main string&!! unset
15345 .cindex "file" "transport for system filter"
15346 This sets the name of the transport driver that is to be used when the &%save%&
15347 command in a system message filter specifies a path not ending in &"/"&. During
15348 the delivery, the variable &$address_file$& contains the path name.
15349
15350 .option system_filter_group main string unset
15351 .cindex "gid (group id)" "system filter"
15352 This option is used only when &%system_filter_user%& is also set. It sets the
15353 gid under which the system filter is run, overriding any gid that is associated
15354 with the user. The value may be numerical or symbolic.
15355
15356 .option system_filter_pipe_transport main string&!! unset
15357 .cindex "&(pipe)& transport" "for system filter"
15358 .vindex "&$address_pipe$&"
15359 This specifies the transport driver that is to be used when a &%pipe%& command
15360 is used in a system filter. During the delivery, the variable &$address_pipe$&
15361 contains the pipe command.
15362
15363
15364 .option system_filter_reply_transport main string&!! unset
15365 .cindex "&(autoreply)& transport" "for system filter"
15366 This specifies the transport driver that is to be used when a &%mail%& command
15367 is used in a system filter.
15368
15369 .new
15370 .option system_filter_user main string unset
15371 .cindex "uid (user id)" "system filter"
15372 If this option is set to root, the system filter is run in the main Exim
15373 delivery process, as root.  Otherwise, the system filter runs in a separate
15374 process, as the given user, defaulting to the Exim run-time user.
15375 Unless the string consists entirely of digits, it
15376 is looked up in the password data. Failure to find the named user causes a
15377 configuration error. The gid is either taken from the password data, or
15378 specified by &%system_filter_group%&. When the uid is specified numerically,
15379 &%system_filter_group%& is required to be set.
15380
15381 If the system filter generates any pipe, file, or reply deliveries, the uid
15382 under which the filter is run is used when transporting them, unless a
15383 transport option overrides.
15384 .wen
15385
15386
15387 .option tcp_nodelay main boolean true
15388 .cindex "daemon" "TCP_NODELAY on sockets"
15389 .cindex "Nagle algorithm"
15390 .cindex "TCP_NODELAY on listening sockets"
15391 If this option is set false, it stops the Exim daemon setting the
15392 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15393 turns off the &"Nagle algorithm"&, which is a way of improving network
15394 performance in interactive (character-by-character) situations. Turning it off
15395 should improve Exim's performance a bit, so that is what happens by default.
15396 However, it appears that some broken clients cannot cope, and time out. Hence
15397 this option. It affects only those sockets that are set up for listening by the
15398 daemon. Sockets created by the smtp transport for delivering mail always set
15399 TCP_NODELAY.
15400
15401
15402 .option timeout_frozen_after main time 0s
15403 .cindex "frozen messages" "timing out"
15404 .cindex "timeout" "frozen messages"
15405 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15406 message of any kind that has been on the queue for longer than the given time
15407 is automatically cancelled at the next queue run. If the frozen message is a
15408 bounce message, it is just discarded; otherwise, a bounce is sent to the
15409 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
15410 If you want to timeout frozen bounce messages earlier than other kinds of
15411 frozen message, see &%ignore_bounce_errors_after%&.
15412
15413 &*Note:*& the default value of zero means no timeouts; with this setting,
15414 frozen messages remain on the queue forever (except for any frozen bounce
15415 messages that are released by &%ignore_bounce_errors_after%&).
15416
15417
15418 .option timezone main string unset
15419 .cindex "timezone, setting"
15420 The value of &%timezone%& is used to set the environment variable TZ while
15421 running Exim (if it is different on entry). This ensures that all timestamps
15422 created by Exim are in the required timezone. If you want all your timestamps
15423 to be in UTC (aka GMT) you should set
15424 .code
15425 timezone = UTC
15426 .endd
15427 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
15428 or, if that is not set, from the value of the TZ environment variable when Exim
15429 is built. If &%timezone%& is set to the empty string, either at build or run
15430 time, any existing TZ variable is removed from the environment when Exim
15431 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
15432 unfortunately not all, operating systems.
15433
15434
15435 .option tls_advertise_hosts main "host list&!!" unset
15436 .cindex "TLS" "advertising"
15437 .cindex "encryption" "on SMTP connection"
15438 .cindex "SMTP" "encrypted connection"
15439 When Exim is built with support for TLS encrypted connections, the availability
15440 of the STARTTLS command to set up an encrypted session is advertised in
15441 response to EHLO only to those client hosts that match this option. See
15442 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
15443
15444
15445 .option tls_certificate main string&!! unset
15446 .cindex "TLS" "server certificate; location of"
15447 .cindex "certificate" "server, location of"
15448 The value of this option is expanded, and must then be the absolute path to a
15449 file which contains the server's certificates. The server's private key is also
15450 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
15451 &<<CHAPTLS>>& for further details.
15452
15453 &*Note*&: The certificates defined by this option are used only when Exim is
15454 receiving incoming messages as a server. If you want to supply certificates for
15455 use when sending messages as a client, you must set the &%tls_certificate%&
15456 option in the relevant &(smtp)& transport.
15457
15458
15459 .option tls_crl main string&!! unset
15460 .cindex "TLS" "server certificate revocation list"
15461 .cindex "certificate" "revocation list for server"
15462 This option specifies a certificate revocation list. The expanded value must
15463 be the name of a file that contains a CRL in PEM format.
15464
15465
15466 .option tls_dhparam main string&!! unset
15467 .cindex "TLS" "D-H parameters for server"
15468 The value of this option is expanded, and must then be the absolute path to
15469 a file which contains the server's DH parameter values.
15470 This is used only for OpenSSL. When Exim is linked with GnuTLS, this option is
15471 ignored. See section &<<SECTopenvsgnu>>& for further details.
15472
15473
15474 .option tls_on_connect_ports main "string list" unset
15475 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
15476 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
15477 set up without waiting for the client to issue a STARTTLS command. For
15478 further details, see section &<<SECTsupobssmt>>&.
15479
15480
15481
15482 .option tls_privatekey main string&!! unset
15483 .cindex "TLS" "server private key; location of"
15484 The value of this option is expanded, and must then be the absolute path to a
15485 file which contains the server's private key. If this option is unset, or if
15486 the expansion is forced to fail, or the result is an empty string, the private
15487 key is assumed to be in the same file as the server's certificates. See chapter
15488 &<<CHAPTLS>>& for further details.
15489
15490
15491 .option tls_remember_esmtp main boolean false
15492 .cindex "TLS" "esmtp state; remembering"
15493 .cindex "TLS" "broken clients"
15494 If this option is set true, Exim violates the RFCs by remembering that it is in
15495 &"esmtp"& state after successfully negotiating a TLS session. This provides
15496 support for broken clients that fail to send a new EHLO after starting a
15497 TLS session.
15498
15499
15500 .option tls_require_ciphers main string&!! unset
15501 .cindex "TLS" "requiring specific ciphers"
15502 .cindex "cipher" "requiring specific"
15503 This option controls which ciphers can be used for incoming TLS connections.
15504 The &(smtp)& transport has an option of the same name for controlling outgoing
15505 connections. This option is expanded for each connection, so can be varied for
15506 different clients if required. The value of this option must be a list of
15507 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
15508 in somewhat different ways. If GnuTLS is being used, the client controls the
15509 preference order of the available ciphers. Details are given in sections
15510 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
15511
15512
15513 .option tls_try_verify_hosts main "host list&!!" unset
15514 .cindex "TLS" "client certificate verification"
15515 .cindex "certificate" "verification of client"
15516 See &%tls_verify_hosts%& below.
15517
15518
15519 .option tls_verify_certificates main string&!! unset
15520 .cindex "TLS" "client certificate verification"
15521 .cindex "certificate" "verification of client"
15522 The value of this option is expanded, and must then be the absolute path to
15523 a file containing permitted certificates for clients that
15524 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
15525 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
15526 directory containing certificate files. This does not work with GnuTLS; the
15527 option must be set to the name of a single file if you are using GnuTLS.
15528
15529 .new
15530 These certificates should be for the certificate authorities trusted, rather
15531 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
15532 the value is a file then the certificates are sent by Exim as a server to
15533 connecting clients, defining the list of accepted certificate authorities.
15534 Thus the values defined should be considered public data.  To avoid this,
15535 use OpenSSL with a directory.
15536 .wen
15537
15538 .option tls_verify_hosts main "host list&!!" unset
15539 .cindex "TLS" "client certificate verification"
15540 .cindex "certificate" "verification of client"
15541 This option, along with &%tls_try_verify_hosts%&, controls the checking of
15542 certificates from clients. The expected certificates are defined by
15543 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
15544 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
15545 &%tls_verify_certificates%& is not set.
15546
15547 Any client that matches &%tls_verify_hosts%& is constrained by
15548 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
15549 present one of the listed certificates. If it does not, the connection is
15550 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
15551 the host to use TLS. It can still send SMTP commands through unencrypted
15552 connections. Forcing a client to use TLS has to be done separately using an
15553 ACL to reject inappropriate commands when the connection is not encrypted.
15554
15555 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
15556 matches this option (but not &%tls_verify_hosts%&), Exim requests a
15557 certificate and checks it against &%tls_verify_certificates%&, but does not
15558 abort the connection if there is no certificate or if it does not match. This
15559 state can be detected in an ACL, which makes it possible to implement policies
15560 such as &"accept for relay only if a verified certificate has been received,
15561 but accept for local delivery if encrypted, even without a verified
15562 certificate"&.
15563
15564 Client hosts that match neither of these lists are not asked to present
15565 certificates.
15566
15567
15568 .option trusted_groups main "string list&!!" unset
15569 .cindex "trusted groups"
15570 .cindex "groups" "trusted"
15571 This option is expanded just once, at the start of Exim's processing. If this
15572 option is set, any process that is running in one of the listed groups, or
15573 which has one of them as a supplementary group, is trusted. The groups can be
15574 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
15575 details of what trusted callers are permitted to do. If neither
15576 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
15577 are trusted.
15578
15579 .option trusted_users main "string list&!!" unset
15580 .cindex "trusted users"
15581 .cindex "user" "trusted"
15582 This option is expanded just once, at the start of Exim's processing. If this
15583 option is set, any process that is running as one of the listed users is
15584 trusted. The users can be specified numerically or by name. See section
15585 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
15586 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
15587 Exim user are trusted.
15588
15589 .option unknown_login main string&!! unset
15590 .cindex "uid (user id)" "unknown caller"
15591 .vindex "&$caller_uid$&"
15592 This is a specialized feature for use in unusual configurations. By default, if
15593 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
15594 gives up. The &%unknown_login%& option can be used to set a login name to be
15595 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
15596 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
15597 is used for the user's real name (gecos field), unless this has been set by the
15598 &%-F%& option.
15599
15600 .option unknown_username main string unset
15601 See &%unknown_login%&.
15602
15603 .option untrusted_set_sender main "address list&!!" unset
15604 .cindex "trusted users"
15605 .cindex "sender" "setting by untrusted user"
15606 .cindex "untrusted user setting sender"
15607 .cindex "user" "untrusted setting sender"
15608 .cindex "envelope sender"
15609 When an untrusted user submits a message to Exim using the standard input, Exim
15610 normally creates an envelope sender address from the user's login and the
15611 default qualification domain. Data from the &%-f%& option (for setting envelope
15612 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
15613 is used) is ignored.
15614
15615 However, untrusted users are permitted to set an empty envelope sender address,
15616 to declare that a message should never generate any bounces. For example:
15617 .code
15618 exim -f '<>' user@domain.example
15619 .endd
15620 .vindex "&$sender_ident$&"
15621 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
15622 other envelope sender addresses in a controlled way. When it is set, untrusted
15623 users are allowed to set envelope sender addresses that match any of the
15624 patterns in the list. Like all address lists, the string is expanded. The
15625 identity of the user is in &$sender_ident$&, so you can, for example, restrict
15626 users to setting senders that start with their login ids
15627 followed by a hyphen
15628 by a setting like this:
15629 .code
15630 untrusted_set_sender = ^$sender_ident-
15631 .endd
15632 If you want to allow untrusted users to set envelope sender addresses without
15633 restriction, you can use
15634 .code
15635 untrusted_set_sender = *
15636 .endd
15637 The &%untrusted_set_sender%& option applies to all forms of local input, but
15638 only to the setting of the envelope sender. It does not permit untrusted users
15639 to use the other options which trusted user can use to override message
15640 parameters. Furthermore, it does not stop Exim from removing an existing
15641 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
15642 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
15643 overriding these actions. The handling of the &'Sender:'& header is also
15644 described in section &<<SECTthesenhea>>&.
15645
15646 The log line for a message's arrival shows the envelope sender following
15647 &"<="&. For local messages, the user's login always follows, after &"U="&. In
15648 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
15649 envelope sender address, the user's login is shown in parentheses after the
15650 sender address.
15651
15652
15653 .option uucp_from_pattern main string "see below"
15654 .cindex "&""From""& line"
15655 .cindex "UUCP" "&""From""& line"
15656 Some applications that pass messages to an MTA via a command line interface use
15657 an initial line starting with &"From&~"& to pass the envelope sender. In
15658 particular, this is used by UUCP software. Exim recognizes such a line by means
15659 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
15660 matches, the sender address is constructed by expanding the contents of
15661 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
15662 default pattern recognizes lines in the following two forms:
15663 .code
15664 From ph10 Fri Jan  5 12:35 GMT 1996
15665 From ph10 Fri, 7 Jan 97 14:00:00 GMT
15666 .endd
15667 The pattern can be seen by running
15668 .code
15669 exim -bP uucp_from_pattern
15670 .endd
15671 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
15672 year in the second case. The first word after &"From&~"& is matched in the
15673 regular expression by a parenthesized subpattern. The default value for
15674 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
15675 (&"ph10"& in the example above) as the message's sender. See also
15676 &%ignore_fromline_hosts%&.
15677
15678
15679 .option uucp_from_sender main string&!! &`$1`&
15680 See &%uucp_from_pattern%& above.
15681
15682
15683 .option warn_message_file main string unset
15684 .cindex "warning of delay" "customizing the message"
15685 .cindex "customizing" "warning message"
15686 This option defines a template file containing paragraphs of text to be used
15687 for constructing the warning message which is sent by Exim when a message has
15688 been on the queue for a specified amount of time, as specified by
15689 &%delay_warning%&. Details of the file's contents are given in chapter
15690 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
15691
15692
15693 .option write_rejectlog main boolean true
15694 .cindex "reject log" "disabling"
15695 If this option is set false, Exim no longer writes anything to the reject log.
15696 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
15697 .ecindex IIDconfima
15698 .ecindex IIDmaiconf
15699
15700
15701
15702
15703 . ////////////////////////////////////////////////////////////////////////////
15704 . ////////////////////////////////////////////////////////////////////////////
15705
15706 .chapter "Generic options for routers" "CHAProutergeneric"
15707 .scindex IIDgenoprou1 "options" "generic; for routers"
15708 .scindex IIDgenoprou2 "generic options" "router"
15709 This chapter describes the generic options that apply to all routers.
15710 Those that are preconditions are marked with &Dagger; in the &"use"& field.
15711
15712 For a general description of how a router operates, see sections
15713 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
15714 which the preconditions are tested. The order of expansion of the options that
15715 provide data for a transport is: &%errors_to%&, &%headers_add%&,
15716 &%headers_remove%&, &%transport%&.
15717
15718
15719
15720 .option address_data routers string&!! unset
15721 .cindex "router" "data attached to address"
15722 The string is expanded just before the router is run, that is, after all the
15723 precondition tests have succeeded. If the expansion is forced to fail, the
15724 router declines, the value of &%address_data%& remains unchanged, and the
15725 &%more%& option controls what happens next. Other expansion failures cause
15726 delivery of the address to be deferred.
15727
15728 .vindex "&$address_data$&"
15729 When the expansion succeeds, the value is retained with the address, and can be
15730 accessed using the variable &$address_data$& in the current router, subsequent
15731 routers, and the eventual transport.
15732
15733 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
15734 that runs a user's filter file, the contents of &$address_data$& are accessible
15735 in the filter. This is not normally a problem, because such data is usually
15736 either not confidential or it &"belongs"& to the current user, but if you do
15737 put confidential data into &$address_data$& you need to remember this point.
15738
15739 Even if the router declines or passes, the value of &$address_data$& remains
15740 with the address, though it can be changed by another &%address_data%& setting
15741 on a subsequent router. If a router generates child addresses, the value of
15742 &$address_data$& propagates to them. This also applies to the special kind of
15743 &"child"& that is generated by a router with the &%unseen%& option.
15744
15745 The idea of &%address_data%& is that you can use it to look up a lot of data
15746 for the address once, and then pick out parts of the data later. For example,
15747 you could use a single LDAP lookup to return a string of the form
15748 .code
15749 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
15750 .endd
15751 In the transport you could pick out the mailbox by a setting such as
15752 .code
15753 file = ${extract{mailbox}{$address_data}}
15754 .endd
15755 This makes the configuration file less messy, and also reduces the number of
15756 lookups (though Exim does cache lookups).
15757
15758 .vindex "&$sender_address_data$&"
15759 .vindex "&$address_data$&"
15760 The &%address_data%& facility is also useful as a means of passing information
15761 from one router to another, and from a router to a transport. In addition, if
15762 &$address_data$& is set by a router when verifying a recipient address from an
15763 ACL, it remains available for use in the rest of the ACL statement. After
15764 verifying a sender, the value is transferred to &$sender_address_data$&.
15765
15766
15767
15768 .option address_test routers&!? boolean true
15769 .oindex "&%-bt%&"
15770 .cindex "router" "skipping when address testing"
15771 If this option is set false, the router is skipped when routing is being tested
15772 by means of the &%-bt%& command line option. This can be a convenience when
15773 your first router sends messages to an external scanner, because it saves you
15774 having to set the &"already scanned"& indicator when testing real address
15775 routing.
15776
15777
15778
15779 .option cannot_route_message routers string&!! unset
15780 .cindex "router" "customizing &""cannot route""& message"
15781 .cindex "customizing" "&""cannot route""& message"
15782 This option specifies a text message that is used when an address cannot be
15783 routed because Exim has run out of routers. The default message is
15784 &"Unrouteable address"&. This option is useful only on routers that have
15785 &%more%& set false, or on the very last router in a configuration, because the
15786 value that is used is taken from the last router that is considered. This
15787 includes a router that is skipped because its preconditions are not met, as
15788 well as a router that declines. For example, using the default configuration,
15789 you could put:
15790 .code
15791 cannot_route_message = Remote domain not found in DNS
15792 .endd
15793 on the first router, which is a &(dnslookup)& router with &%more%& set false,
15794 and
15795 .code
15796 cannot_route_message = Unknown local user
15797 .endd
15798 on the final router that checks for local users. If string expansion fails for
15799 this option, the default message is used. Unless the expansion failure was
15800 explicitly forced, a message about the failure is written to the main and panic
15801 logs, in addition to the normal message about the routing failure.
15802
15803
15804 .option caseful_local_part routers boolean false
15805 .cindex "case of local parts"
15806 .cindex "router" "case of local parts"
15807 By default, routers handle the local parts of addresses in a case-insensitive
15808 manner, though the actual case is preserved for transmission with the message.
15809 If you want the case of letters to be significant in a router, you must set
15810 this option true. For individual router options that contain address or local
15811 part lists (for example, &%local_parts%&), case-sensitive matching can be
15812 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
15813 more details.
15814
15815 .vindex "&$local_part$&"
15816 .vindex "&$original_local_part$&"
15817 .vindex "&$parent_local_part$&"
15818 The value of the &$local_part$& variable is forced to lower case while a
15819 router is running unless &%caseful_local_part%& is set. When a router assigns
15820 an address to a transport, the value of &$local_part$& when the transport runs
15821 is the same as it was in the router. Similarly, when a router generates child
15822 addresses by aliasing or forwarding, the values of &$original_local_part$&
15823 and &$parent_local_part$& are those that were used by the redirecting router.
15824
15825 This option applies to the processing of an address by a router. When a
15826 recipient address is being processed in an ACL, there is a separate &%control%&
15827 modifier that can be used to specify case-sensitive processing within the ACL
15828 (see section &<<SECTcontrols>>&).
15829
15830
15831
15832 .option check_local_user routers&!? boolean false
15833 .cindex "local user, checking in router"
15834 .cindex "router" "checking for local user"
15835 .cindex "&_/etc/passwd_&"
15836 .vindex "&$home$&"
15837 When this option is true, Exim checks that the local part of the recipient
15838 address (with affixes removed if relevant) is the name of an account on the
15839 local system. The check is done by calling the &[getpwnam()]& function rather
15840 than trying to read &_/etc/passwd_& directly. This means that other methods of
15841 holding password data (such as NIS) are supported. If the local part is a local
15842 user, &$home$& is set from the password data, and can be tested in other
15843 preconditions that are evaluated after this one (the order of evaluation is
15844 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
15845 overridden by &%router_home_directory%&. If the local part is not a local user,
15846 the router is skipped.
15847
15848 If you want to check that the local part is either the name of a local user
15849 or matches something else, you cannot combine &%check_local_user%& with a
15850 setting of &%local_parts%&, because that specifies the logical &'and'& of the
15851 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
15852 setting to achieve this. For example:
15853 .code
15854 local_parts = passwd;$local_part : lsearch;/etc/other/users
15855 .endd
15856 Note, however, that the side effects of &%check_local_user%& (such as setting
15857 up a home directory) do not occur when a &(passwd)& lookup is used in a
15858 &%local_parts%& (or any other) precondition.
15859
15860
15861
15862 .option condition routers&!? string&!! unset
15863 .cindex "router" "customized precondition"
15864 This option specifies a general precondition test that has to succeed for the
15865 router to be called. The &%condition%& option is the last precondition to be
15866 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
15867 result is a forced failure, or an empty string, or one of the strings &"0"& or
15868 &"no"& or &"false"& (checked without regard to the case of the letters), the
15869 router is skipped, and the address is offered to the next one.
15870
15871 If the result is any other value, the router is run (as this is the last
15872 precondition to be evaluated, all the other preconditions must be true).
15873
15874 .new
15875 This option is unique in that multiple &%condition%& options may be present.
15876 All &%condition%& options must succeed.
15877 .wen
15878
15879 .new
15880 The &%condition%& option provides a means of applying custom conditions to the
15881 running of routers. Note that in the case of a simple conditional expansion,
15882 the default expansion values are exactly what is wanted. For example:
15883 .code
15884 condition = ${if >{$message_age}{600}}
15885 .endd
15886 Because of the default behaviour of the string expansion, this is equivalent to
15887 .code
15888 condition = ${if >{$message_age}{600}{true}{}}
15889 .endd
15890
15891 A multiple condition example, which succeeds:
15892 .code
15893 condition = ${if >{$message_age}{600}}
15894 condition = ${if !eq{${lc:$local_part}}{postmaster}}
15895 condition = foobar
15896 .endd
15897
15898 If the expansion fails (other than forced failure) delivery is deferred. Some
15899 of the other precondition options are common special cases that could in fact
15900 be specified using &%condition%&.
15901 .wen
15902
15903
15904 .option debug_print routers string&!! unset
15905 .cindex "testing" "variables in drivers"
15906 If this option is set and debugging is enabled (see the &%-d%& command line
15907 option), the string is expanded and included in the debugging output.
15908 If expansion of the string fails, the error message is written to the debugging
15909 output, and Exim carries on processing.
15910 This option is provided to help with checking out the values of variables and
15911 so on when debugging router configurations. For example, if a &%condition%&
15912 option appears not to be working, &%debug_print%& can be used to output the
15913 variables it references. The output happens after checks for &%domains%&,
15914 &%local_parts%&, and &%check_local_user%& but before any other preconditions
15915 are tested. A newline is added to the text if it does not end with one.
15916
15917
15918
15919 .option disable_logging routers boolean false
15920 If this option is set true, nothing is logged for any routing errors
15921 or for any deliveries caused by this router. You should not set this option
15922 unless you really, really know what you are doing. See also the generic
15923 transport option of the same name.
15924
15925
15926 .option domains routers&!? "domain list&!!" unset
15927 .cindex "router" "restricting to specific domains"
15928 .vindex "&$domain_data$&"
15929 If this option is set, the router is skipped unless the current domain matches
15930 the list. If the match is achieved by means of a file lookup, the data that the
15931 lookup returned for the domain is placed in &$domain_data$& for use in string
15932 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
15933 a list of the order in which preconditions are evaluated.
15934
15935
15936
15937 .option driver routers string unset
15938 This option must always be set. It specifies which of the available routers is
15939 to be used.
15940
15941
15942
15943 .option errors_to routers string&!! unset
15944 .cindex "envelope sender"
15945 .cindex "router" "changing address for errors"
15946 If a router successfully handles an address, it may assign the address to a
15947 transport for delivery or it may generate child addresses. In both cases, if
15948 there is a delivery problem during later processing, the resulting bounce
15949 message is sent to the address that results from expanding this string,
15950 provided that the address verifies successfully. The &%errors_to%& option is
15951 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
15952
15953 The &%errors_to%& setting associated with an address can be overridden if it
15954 subsequently passes through other routers that have their own &%errors_to%&
15955 settings, or if the message is delivered by a transport with a &%return_path%&
15956 setting.
15957
15958 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
15959 the expansion fails to verify, the errors address associated with the incoming
15960 address is used. At top level, this is the envelope sender. A non-forced
15961 expansion failure causes delivery to be deferred.
15962
15963 If an address for which &%errors_to%& has been set ends up being delivered over
15964 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
15965 any bounces that are generated by other MTAs on the delivery route are also
15966 sent there. You can set &%errors_to%& to the empty string by either of these
15967 settings:
15968 .code
15969 errors_to =
15970 errors_to = ""
15971 .endd
15972 An expansion item that yields an empty string has the same effect. If you do
15973 this, a locally detected delivery error for addresses processed by this router
15974 no longer gives rise to a bounce message; the error is discarded. If the
15975 address is delivered to a remote host, the return path is set to &`<>`&, unless
15976 overridden by the &%return_path%& option on the transport.
15977
15978 .vindex "&$address_data$&"
15979 If for some reason you want to discard local errors, but use a non-empty
15980 MAIL command for remote delivery, you can preserve the original return
15981 path in &$address_data$& in the router, and reinstate it in the transport by
15982 setting &%return_path%&.
15983
15984 The most common use of &%errors_to%& is to direct mailing list bounces to the
15985 manager of the list, as described in section &<<SECTmailinglists>>&, or to
15986 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
15987
15988
15989
15990 .option expn routers&!? boolean true
15991 .cindex "address" "testing"
15992 .cindex "testing" "addresses"
15993 .cindex "EXPN" "router skipping"
15994 .cindex "router" "skipping for EXPN"
15995 If this option is turned off, the router is skipped when testing an address
15996 as a result of processing an SMTP EXPN command. You might, for example,
15997 want to turn it off on a router for users' &_.forward_& files, while leaving it
15998 on for the system alias file.
15999 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16000 are evaluated.
16001
16002 The use of the SMTP EXPN command is controlled by an ACL (see chapter
16003 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
16004 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
16005
16006
16007
16008 .option fail_verify routers boolean false
16009 .cindex "router" "forcing verification failure"
16010 Setting this option has the effect of setting both &%fail_verify_sender%& and
16011 &%fail_verify_recipient%& to the same value.
16012
16013
16014
16015 .option fail_verify_recipient routers boolean false
16016 If this option is true and an address is accepted by this router when
16017 verifying a recipient, verification fails.
16018
16019
16020
16021 .option fail_verify_sender routers boolean false
16022 If this option is true and an address is accepted by this router when
16023 verifying a sender, verification fails.
16024
16025
16026
16027 .option fallback_hosts routers "string list" unset
16028 .cindex "router" "fallback hosts"
16029 .cindex "fallback" "hosts specified on router"
16030 String expansion is not applied to this option. The argument must be a
16031 colon-separated list of host names or IP addresses. The list separator can be
16032 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
16033 each name or address. In fact, the format of each item is exactly the same as
16034 defined for the list of hosts in a &(manualroute)& router (see section
16035 &<<SECTformatonehostitem>>&).
16036
16037 If a router queues an address for a remote transport, this host list is
16038 associated with the address, and used instead of the transport's fallback host
16039 list. If &%hosts_randomize%& is set on the transport, the order of the list is
16040 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
16041 transport for further details.
16042
16043
16044 .option group routers string&!! "see below"
16045 .cindex "gid (group id)" "local delivery"
16046 .cindex "local transports" "uid and gid"
16047 .cindex "transport" "local"
16048 .cindex "router" "setting group"
16049 When a router queues an address for a transport, and the transport does not
16050 specify a group, the group given here is used when running the delivery
16051 process.
16052 The group may be specified numerically or by name. If expansion fails, the
16053 error is logged and delivery is deferred.
16054 The default is unset, unless &%check_local_user%& is set, when the default
16055 is taken from the password information. See also &%initgroups%& and &%user%&
16056 and the discussion in chapter &<<CHAPenvironment>>&.
16057
16058
16059
16060 .option headers_add routers string&!! unset
16061 .cindex "header lines" "adding"
16062 .cindex "router" "adding header lines"
16063 This option specifies a string of text that is expanded at routing time, and
16064 associated with any addresses that are accepted by the router. However, this
16065 option has no effect when an address is just being verified. The way in which
16066 the text is used to add header lines at transport time is described in section
16067 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
16068 message is in the process of being transported. This means that references to
16069 header lines in string expansions in the transport's configuration do not
16070 &"see"& the added header lines.
16071
16072 The &%headers_add%& option is expanded after &%errors_to%&, but before
16073 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
16074 the expansion is forced to fail, the option has no effect. Other expansion
16075 failures are treated as configuration errors.
16076
16077 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
16078 router that has the &%one_time%& option set.
16079
16080 .cindex "duplicate addresses"
16081 .oindex "&%unseen%&"
16082 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16083 additions are deleted when the address is passed on to subsequent routers.
16084 For a &%redirect%& router, if a generated address is the same as the incoming
16085 address, this can lead to duplicate addresses with different header
16086 modifications. Exim does not do duplicate deliveries (except, in certain
16087 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
16088 which of the duplicates is discarded, so this ambiguous situation should be
16089 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
16090
16091
16092
16093 .option headers_remove routers string&!! unset
16094 .cindex "header lines" "removing"
16095 .cindex "router" "removing header lines"
16096 This option specifies a string of text that is expanded at routing time, and
16097 associated with any addresses that are accepted by the router. However, this
16098 option has no effect when an address is just being verified. The way in which
16099 the text is used to remove header lines at transport time is described in
16100 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
16101 the message is in the process of being transported. This means that references
16102 to header lines in string expansions in the transport's configuration still
16103 &"see"& the original header lines.
16104
16105 The &%headers_remove%& option is expanded after &%errors_to%& and
16106 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
16107 the option has no effect. Other expansion failures are treated as configuration
16108 errors.
16109
16110 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
16111 router that has the &%one_time%& option set.
16112
16113 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16114 removal requests are deleted when the address is passed on to subsequent
16115 routers, and this can lead to problems with duplicates -- see the similar
16116 warning for &%headers_add%& above.
16117
16118
16119 .option ignore_target_hosts routers "host list&!!" unset
16120 .cindex "IP address" "discarding"
16121 .cindex "router" "discarding IP addresses"
16122 Although this option is a host list, it should normally contain IP address
16123 entries rather than names. If any host that is looked up by the router has an
16124 IP address that matches an item in this list, Exim behaves as if that IP
16125 address did not exist. This option allows you to cope with rogue DNS entries
16126 like
16127 .code
16128 remote.domain.example.  A  127.0.0.1
16129 .endd
16130 by setting
16131 .code
16132 ignore_target_hosts = 127.0.0.1
16133 .endd
16134 on the relevant router. If all the hosts found by a &(dnslookup)& router are
16135 discarded in this way, the router declines. In a conventional configuration, an
16136 attempt to mail to such a domain would normally provoke the &"unrouteable
16137 domain"& error, and an attempt to verify an address in the domain would fail.
16138 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
16139 router declines if presented with one of the listed addresses.
16140
16141 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
16142 means of the first or the second of the following settings, respectively:
16143 .code
16144 ignore_target_hosts = 0.0.0.0/0
16145 ignore_target_hosts = <; 0::0/0
16146 .endd
16147 The pattern in the first line matches all IPv4 addresses, whereas the pattern
16148 in the second line matches all IPv6 addresses.
16149
16150 This option may also be useful for ignoring link-local and site-local IPv6
16151 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
16152 is expanded before use as a list, it is possible to make it dependent on the
16153 domain that is being routed.
16154
16155 .vindex "&$host_address$&"
16156 During its expansion, &$host_address$& is set to the IP address that is being
16157 checked.
16158
16159 .option initgroups routers boolean false
16160 .cindex "additional groups"
16161 .cindex "groups" "additional"
16162 .cindex "local transports" "uid and gid"
16163 .cindex "transport" "local"
16164 If the router queues an address for a transport, and this option is true, and
16165 the uid supplied by the router is not overridden by the transport, the
16166 &[initgroups()]& function is called when running the transport to ensure that
16167 any additional groups associated with the uid are set up. See also &%group%&
16168 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16169
16170
16171
16172 .option local_part_prefix routers&!? "string list" unset
16173 .cindex "router" "prefix for local part"
16174 .cindex "prefix" "for local part, used in router"
16175 If this option is set, the router is skipped unless the local part starts with
16176 one of the given strings, or &%local_part_prefix_optional%& is true. See
16177 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16178 evaluated.
16179
16180 The list is scanned from left to right, and the first prefix that matches is
16181 used. A limited form of wildcard is available; if the prefix begins with an
16182 asterisk, it matches the longest possible sequence of arbitrary characters at
16183 the start of the local part. An asterisk should therefore always be followed by
16184 some character that does not occur in normal local parts.
16185 .cindex "multiple mailboxes"
16186 .cindex "mailbox" "multiple"
16187 Wildcarding can be used to set up multiple user mailboxes, as described in
16188 section &<<SECTmulbox>>&.
16189
16190 .vindex "&$local_part$&"
16191 .vindex "&$local_part_prefix$&"
16192 During the testing of the &%local_parts%& option, and while the router is
16193 running, the prefix is removed from the local part, and is available in the
16194 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16195 the router accepts the address, this remains true during subsequent delivery by
16196 a transport. In particular, the local part that is transmitted in the RCPT
16197 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16198 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16199 the relevant transport.
16200
16201 When an address is being verified, &%local_part_prefix%& affects only the
16202 behaviour of the router. If the callout feature of verification is in use, this
16203 means that the full address, including the prefix, will be used during the
16204 callout.
16205
16206 The prefix facility is commonly used to handle local parts of the form
16207 &%owner-something%&. Another common use is to support local parts of the form
16208 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16209 to tell a user their forwarding is broken &-- by placing a router like this one
16210 immediately before the router that handles &_.forward_& files:
16211 .code
16212 real_localuser:
16213   driver = accept
16214   local_part_prefix = real-
16215   check_local_user
16216   transport = local_delivery
16217 .endd
16218 For security, it would probably be a good idea to restrict the use of this
16219 router to locally-generated messages, using a condition such as this:
16220 .code
16221   condition = ${if match {$sender_host_address}\
16222                          {\N^(|127\.0\.0\.1)$\N}}
16223 .endd
16224
16225 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16226 both conditions must be met if not optional. Care must be taken if wildcards
16227 are used in both a prefix and a suffix on the same router. Different
16228 separator characters must be used to avoid ambiguity.
16229
16230
16231 .option local_part_prefix_optional routers boolean false
16232 See &%local_part_prefix%& above.
16233
16234
16235
16236 .option local_part_suffix routers&!? "string list" unset
16237 .cindex "router" "suffix for local part"
16238 .cindex "suffix for local part" "used in router"
16239 This option operates in the same way as &%local_part_prefix%&, except that the
16240 local part must end (rather than start) with the given string, the
16241 &%local_part_suffix_optional%& option determines whether the suffix is
16242 mandatory, and the wildcard * character, if present, must be the last
16243 character of the suffix. This option facility is commonly used to handle local
16244 parts of the form &%something-request%& and multiple user mailboxes of the form
16245 &%username-foo%&.
16246
16247
16248 .option local_part_suffix_optional routers boolean false
16249 See &%local_part_suffix%& above.
16250
16251
16252
16253 .option local_parts routers&!? "local part list&!!" unset
16254 .cindex "router" "restricting to specific local parts"
16255 .cindex "local part" "checking in router"
16256 The router is run only if the local part of the address matches the list.
16257 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16258 are evaluated, and
16259 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16260 string is expanded, it is possible to make it depend on the domain, for
16261 example:
16262 .code
16263 local_parts = dbm;/usr/local/specials/$domain
16264 .endd
16265 .vindex "&$local_part_data$&"
16266 If the match is achieved by a lookup, the data that the lookup returned
16267 for the local part is placed in the variable &$local_part_data$& for use in
16268 expansions of the router's private options. You might use this option, for
16269 example, if you have a large number of local virtual domains, and you want to
16270 send all postmaster mail to the same place without having to set up an alias in
16271 each virtual domain:
16272 .code
16273 postmaster:
16274   driver = redirect
16275   local_parts = postmaster
16276   data = postmaster@real.domain.example
16277 .endd
16278
16279
16280 .option log_as_local routers boolean "see below"
16281 .cindex "log" "delivery line"
16282 .cindex "delivery" "log line format"
16283 Exim has two logging styles for delivery, the idea being to make local
16284 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16285 recipient address is given just as the local part, without a domain. The use of
16286 this style is controlled by this option. It defaults to true for the &(accept)&
16287 router, and false for all the others. This option applies only when a
16288 router assigns an address to a transport. It has no effect on routers that
16289 redirect addresses.
16290
16291
16292
16293 .option more routers boolean&!! true
16294 The result of string expansion for this option must be a valid boolean value,
16295 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16296 result causes an error, and delivery is deferred. If the expansion is forced to
16297 fail, the default value for the option (true) is used. Other failures cause
16298 delivery to be deferred.
16299
16300 If this option is set false, and the router declines to handle the address, no
16301 further routers are tried, routing fails, and the address is bounced.
16302 .oindex "&%self%&"
16303 However, if the router explicitly passes an address to the following router by
16304 means of the setting
16305 .code
16306 self = pass
16307 .endd
16308 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16309 does not affect the behaviour if one of the precondition tests fails. In that
16310 case, the address is always passed to the next router.
16311
16312 Note that &%address_data%& is not considered to be a precondition. If its
16313 expansion is forced to fail, the router declines, and the value of &%more%&
16314 controls what happens next.
16315
16316
16317 .option pass_on_timeout routers boolean false
16318 .cindex "timeout" "of router"
16319 .cindex "router" "timeout"
16320 If a router times out during a host lookup, it normally causes deferral of the
16321 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16322 router, overriding &%no_more%&. This may be helpful for systems that are
16323 intermittently connected to the Internet, or those that want to pass to a smart
16324 host any messages that cannot immediately be delivered.
16325
16326 There are occasional other temporary errors that can occur while doing DNS
16327 lookups. They are treated in the same way as a timeout, and this option
16328 applies to all of them.
16329
16330
16331
16332 .option pass_router routers string unset
16333 .cindex "router" "go to after &""pass""&"
16334 Routers that recognize the generic &%self%& option (&(dnslookup)&,
16335 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
16336 routing to continue, and overriding a false setting of &%more%&. When one of
16337 these routers returns &"pass"&, the address is normally handed on to the next
16338 router in sequence. This can be changed by setting &%pass_router%& to the name
16339 of another router. However (unlike &%redirect_router%&) the named router must
16340 be below the current router, to avoid loops. Note that this option applies only
16341 to the special case of &"pass"&. It does not apply when a router returns
16342 &"decline"& because it cannot handle an address.
16343
16344
16345
16346 .option redirect_router routers string unset
16347 .cindex "router" "start at after redirection"
16348 Sometimes an administrator knows that it is pointless to reprocess addresses
16349 generated from alias or forward files with the same router again. For
16350 example, if an alias file translates real names into login ids there is no
16351 point searching the alias file a second time, especially if it is a large file.
16352
16353 The &%redirect_router%& option can be set to the name of any router instance.
16354 It causes the routing of any generated addresses to start at the named router
16355 instead of at the first router. This option has no effect if the router in
16356 which it is set does not generate new addresses.
16357
16358
16359
16360 .option require_files routers&!? "string list&!!" unset
16361 .cindex "file" "requiring for router"
16362 .cindex "router" "requiring file existence"
16363 This option provides a general mechanism for predicating the running of a
16364 router on the existence or non-existence of certain files or directories.
16365 Before running a router, as one of its precondition tests, Exim works its way
16366 through the &%require_files%& list, expanding each item separately.
16367
16368 Because the list is split before expansion, any colons in expansion items must
16369 be doubled, or the facility for using a different list separator must be used.
16370 If any expansion is forced to fail, the item is ignored. Other expansion
16371 failures cause routing of the address to be deferred.
16372
16373 If any expanded string is empty, it is ignored. Otherwise, except as described
16374 below, each string must be a fully qualified file path, optionally preceded by
16375 &"!"&. The paths are passed to the &[stat()]& function to test for the
16376 existence of the files or directories. The router is skipped if any paths not
16377 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
16378
16379 .cindex "NFS"
16380 If &[stat()]& cannot determine whether a file exists or not, delivery of
16381 the message is deferred. This can happen when NFS-mounted filesystems are
16382 unavailable.
16383
16384 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
16385 options, so you cannot use it to check for the existence of a file in which to
16386 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
16387 full list of the order in which preconditions are evaluated.) However, as
16388 these options are all expanded, you can use the &%exists%& expansion condition
16389 to make such tests. The &%require_files%& option is intended for checking files
16390 that the router may be going to use internally, or which are needed by a
16391 transport (for example &_.procmailrc_&).
16392
16393 During delivery, the &[stat()]& function is run as root, but there is a
16394 facility for some checking of the accessibility of a file by another user.
16395 This is not a proper permissions check, but just a &"rough"& check that
16396 operates as follows:
16397
16398 If an item in a &%require_files%& list does not contain any forward slash
16399 characters, it is taken to be the user (and optional group, separated by a
16400 comma) to be checked for subsequent files in the list. If no group is specified
16401 but the user is specified symbolically, the gid associated with the uid is
16402 used. For example:
16403 .code
16404 require_files = mail:/some/file
16405 require_files = $local_part:$home/.procmailrc
16406 .endd
16407 If a user or group name in a &%require_files%& list does not exist, the
16408 &%require_files%& condition fails.
16409
16410 Exim performs the check by scanning along the components of the file path, and
16411 checking the access for the given uid and gid. It checks for &"x"& access on
16412 directories, and &"r"& access on the final file. Note that this means that file
16413 access control lists, if the operating system has them, are ignored.
16414
16415 &*Warning 1*&: When the router is being run to verify addresses for an
16416 incoming SMTP message, Exim is not running as root, but under its own uid. This
16417 may affect the result of a &%require_files%& check. In particular, &[stat()]&
16418 may yield the error EACCES (&"Permission denied"&). This means that the Exim
16419 user is not permitted to read one of the directories on the file's path.
16420
16421 &*Warning 2*&: Even when Exim is running as root while delivering a message,
16422 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
16423 without root access. In this case, if a check for access by a particular user
16424 is requested, Exim creates a subprocess that runs as that user, and tries the
16425 check again in that process.
16426
16427 The default action for handling an unresolved EACCES is to consider it to
16428 be caused by a configuration error, and routing is deferred because the
16429 existence or non-existence of the file cannot be determined. However, in some
16430 circumstances it may be desirable to treat this condition as if the file did
16431 not exist. If the file name (or the exclamation mark that precedes the file
16432 name for non-existence) is preceded by a plus sign, the EACCES error is treated
16433 as if the file did not exist. For example:
16434 .code
16435 require_files = +/some/file
16436 .endd
16437 If the router is not an essential part of verification (for example, it
16438 handles users' &_.forward_& files), another solution is to set the &%verify%&
16439 option false so that the router is skipped when verifying.
16440
16441
16442
16443 .option retry_use_local_part routers boolean "see below"
16444 .cindex "hints database" "retry keys"
16445 .cindex "local part" "in retry keys"
16446 When a delivery suffers a temporary routing failure, a retry record is created
16447 in Exim's hints database. For addresses whose routing depends only on the
16448 domain, the key for the retry record should not involve the local part, but for
16449 other addresses, both the domain and the local part should be included.
16450 Usually, remote routing is of the former kind, and local routing is of the
16451 latter kind.
16452
16453 This option controls whether the local part is used to form the key for retry
16454 hints for addresses that suffer temporary errors while being handled by this
16455 router. The default value is true for any router that has &%check_local_user%&
16456 set, and false otherwise. Note that this option does not apply to hints keys
16457 for transport delays; they are controlled by a generic transport option of the
16458 same name.
16459
16460 The setting of &%retry_use_local_part%& applies only to the router on which it
16461 appears. If the router generates child addresses, they are routed
16462 independently; this setting does not become attached to them.
16463
16464
16465
16466 .option router_home_directory routers string&!! unset
16467 .cindex "router" "home directory for"
16468 .cindex "home directory" "for router"
16469 .vindex "&$home$&"
16470 This option sets a home directory for use while the router is running. (Compare
16471 &%transport_home_directory%&, which sets a home directory for later
16472 transporting.) In particular, if used on a &(redirect)& router, this option
16473 sets a value for &$home$& while a filter is running. The value is expanded;
16474 forced expansion failure causes the option to be ignored &-- other failures
16475 cause the router to defer.
16476
16477 Expansion of &%router_home_directory%& happens immediately after the
16478 &%check_local_user%& test (if configured), before any further expansions take
16479 place.
16480 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16481 are evaluated.)
16482 While the router is running, &%router_home_directory%& overrides the value of
16483 &$home$& that came from &%check_local_user%&.
16484
16485 When a router accepts an address and assigns it to a local transport (including
16486 the cases when a &(redirect)& router generates a pipe, file, or autoreply
16487 delivery), the home directory setting for the transport is taken from the first
16488 of these values that is set:
16489
16490 .ilist
16491 The &%home_directory%& option on the transport;
16492 .next
16493 The &%transport_home_directory%& option on the router;
16494 .next
16495 The password data if &%check_local_user%& is set on the router;
16496 .next
16497 The &%router_home_directory%& option on the router.
16498 .endlist
16499
16500 In other words, &%router_home_directory%& overrides the password data for the
16501 router, but not for the transport.
16502
16503
16504
16505 .option self routers string freeze
16506 .cindex "MX record" "pointing to local host"
16507 .cindex "local host" "MX pointing to"
16508 This option applies to those routers that use a recipient address to find a
16509 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
16510 and &(manualroute)& routers.
16511 Certain configurations of the &(queryprogram)& router can also specify a list
16512 of remote hosts.
16513 Usually such routers are configured to send the message to a remote host via an
16514 &(smtp)& transport. The &%self%& option specifies what happens when the first
16515 host on the list turns out to be the local host.
16516 The way in which Exim checks for the local host is described in section
16517 &<<SECTreclocipadd>>&.
16518
16519 Normally this situation indicates either an error in Exim's configuration (for
16520 example, the router should be configured not to process this domain), or an
16521 error in the DNS (for example, the MX should not point to this host). For this
16522 reason, the default action is to log the incident, defer the address, and
16523 freeze the message. The following alternatives are provided for use in special
16524 cases:
16525
16526 .vlist
16527 .vitem &%defer%&
16528 Delivery of the message is tried again later, but the message is not frozen.
16529
16530 .vitem "&%reroute%&: <&'domain'&>"
16531 The domain is changed to the given domain, and the address is passed back to
16532 be reprocessed by the routers. No rewriting of headers takes place. This
16533 behaviour is essentially a redirection.
16534
16535 .vitem "&%reroute: rewrite:%& <&'domain'&>"
16536 The domain is changed to the given domain, and the address is passed back to be
16537 reprocessed by the routers. Any headers that contain the original domain are
16538 rewritten.
16539
16540 .vitem &%pass%&
16541 .oindex "&%more%&"
16542 .vindex "&$self_hostname$&"
16543 The router passes the address to the next router, or to the router named in the
16544 &%pass_router%& option if it is set. This overrides &%no_more%&. During
16545 subsequent routing and delivery, the variable &$self_hostname$& contains the
16546 name of the local host that the router encountered. This can be used to
16547 distinguish between different cases for hosts with multiple names. The
16548 combination
16549 .code
16550 self = pass
16551 no_more
16552 .endd
16553 ensures that only those addresses that routed to the local host are passed on.
16554 Without &%no_more%&, addresses that were declined for other reasons would also
16555 be passed to the next router.
16556
16557 .vitem &%fail%&
16558 Delivery fails and an error report is generated.
16559
16560 .vitem &%send%&
16561 .cindex "local host" "sending to"
16562 The anomaly is ignored and the address is queued for the transport. This
16563 setting should be used with extreme caution. For an &(smtp)& transport, it
16564 makes sense only in cases where the program that is listening on the SMTP port
16565 is not this version of Exim. That is, it must be some other MTA, or Exim with a
16566 different configuration file that handles the domain in another way.
16567 .endlist
16568
16569
16570
16571 .option senders routers&!? "address list&!!" unset
16572 .cindex "router" "checking senders"
16573 If this option is set, the router is skipped unless the message's sender
16574 address matches something on the list.
16575 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16576 are evaluated.
16577
16578 There are issues concerning verification when the running of routers is
16579 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
16580 setting, it sets the sender to the null string. When using the &%-bt%& option
16581 to check a configuration file, it is necessary also to use the &%-f%& option to
16582 set an appropriate sender. For incoming mail, the sender is unset when
16583 verifying the sender, but is available when verifying any recipients. If the
16584 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
16585 matters.
16586
16587
16588 .option translate_ip_address routers string&!! unset
16589 .cindex "IP address" "translating"
16590 .cindex "packet radio"
16591 .cindex "router" "IP address translation"
16592 There exist some rare networking situations (for example, packet radio) where
16593 it is helpful to be able to translate IP addresses generated by normal routing
16594 mechanisms into other IP addresses, thus performing a kind of manual IP
16595 routing. This should be done only if the normal IP routing of the TCP/IP stack
16596 is inadequate or broken. Because this is an extremely uncommon requirement, the
16597 code to support this option is not included in the Exim binary unless
16598 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
16599
16600 .vindex "&$host_address$&"
16601 The &%translate_ip_address%& string is expanded for every IP address generated
16602 by the router, with the generated address set in &$host_address$&. If the
16603 expansion is forced to fail, no action is taken.
16604 For any other expansion error, delivery of the message is deferred.
16605 If the result of the expansion is an IP address, that replaces the original
16606 address; otherwise the result is assumed to be a host name &-- this is looked
16607 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
16608 produce one or more replacement IP addresses. For example, to subvert all IP
16609 addresses in some specific networks, this could be added to a router:
16610 .code
16611 translate_ip_address = \
16612   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
16613     {$value}fail}}
16614 .endd
16615 The file would contain lines like
16616 .code
16617 10.2.3.128/26    some.host
16618 10.8.4.34/26     10.44.8.15
16619 .endd
16620 You should not make use of this facility unless you really understand what you
16621 are doing.
16622
16623
16624
16625 .option transport routers string&!! unset
16626 This option specifies the transport to be used when a router accepts an address
16627 and sets it up for delivery. A transport is never needed if a router is used
16628 only for verification. The value of the option is expanded at routing time,
16629 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
16630 and result must be the name of one of the configured transports. If it is not,
16631 delivery is deferred.
16632
16633 The &%transport%& option is not used by the &(redirect)& router, but it does
16634 have some private options that set up transports for pipe and file deliveries
16635 (see chapter &<<CHAPredirect>>&).
16636
16637
16638
16639 .option transport_current_directory routers string&!! unset
16640 .cindex "current directory for local transport"
16641 This option associates a current directory with any address that is routed
16642 to a local transport. This can happen either because a transport is
16643 explicitly configured for the router, or because it generates a delivery to a
16644 file or a pipe. During the delivery process (that is, at transport time), this
16645 option string is expanded and is set as the current directory, unless
16646 overridden by a setting on the transport.
16647 If the expansion fails for any reason, including forced failure, an error is
16648 logged, and delivery is deferred.
16649 See chapter &<<CHAPenvironment>>& for details of the local delivery
16650 environment.
16651
16652
16653
16654
16655 .option transport_home_directory routers string&!! "see below"
16656 .cindex "home directory" "for local transport"
16657 This option associates a home directory with any address that is routed to a
16658 local transport. This can happen either because a transport is explicitly
16659 configured for the router, or because it generates a delivery to a file or a
16660 pipe. During the delivery process (that is, at transport time), the option
16661 string is expanded and is set as the home directory, unless overridden by a
16662 setting of &%home_directory%& on the transport.
16663 If the expansion fails for any reason, including forced failure, an error is
16664 logged, and delivery is deferred.
16665
16666 If the transport does not specify a home directory, and
16667 &%transport_home_directory%& is not set for the router, the home directory for
16668 the transport is taken from the password data if &%check_local_user%& is set for
16669 the router. Otherwise it is taken from &%router_home_directory%& if that option
16670 is set; if not, no home directory is set for the transport.
16671
16672 See chapter &<<CHAPenvironment>>& for further details of the local delivery
16673 environment.
16674
16675
16676
16677
16678 .option unseen routers boolean&!! false
16679 .cindex "router" "carrying on after success"
16680 The result of string expansion for this option must be a valid boolean value,
16681 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16682 result causes an error, and delivery is deferred. If the expansion is forced to
16683 fail, the default value for the option (false) is used. Other failures cause
16684 delivery to be deferred.
16685
16686 When this option is set true, routing does not cease if the router accepts the
16687 address. Instead, a copy of the incoming address is passed to the next router,
16688 overriding a false setting of &%more%&. There is little point in setting
16689 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
16690 the value of &%unseen%& contains expansion items (and therefore, presumably, is
16691 sometimes true and sometimes false).
16692
16693 .cindex "copy of message (&%unseen%& option)"
16694 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
16695 qualifier in filter files. It can be used to cause copies of messages to be
16696 delivered to some other destination, while also carrying out a normal delivery.
16697 In effect, the current address is made into a &"parent"& that has two children
16698 &-- one that is delivered as specified by this router, and a clone that goes on
16699 to be routed further. For this reason, &%unseen%& may not be combined with the
16700 &%one_time%& option in a &(redirect)& router.
16701
16702 &*Warning*&: Header lines added to the address (or specified for removal) by
16703 this router or by previous routers affect the &"unseen"& copy of the message
16704 only. The clone that continues to be processed by further routers starts with
16705 no added headers and none specified for removal. For a &%redirect%& router, if
16706 a generated address is the same as the incoming address, this can lead to
16707 duplicate addresses with different header modifications. Exim does not do
16708 duplicate deliveries (except, in certain circumstances, to pipes -- see section
16709 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
16710 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
16711 &%redirect%& router may be of help.
16712
16713 Unlike the handling of header modifications, any data that was set by the
16714 &%address_data%& option in the current or previous routers &'is'& passed on to
16715 subsequent routers.
16716
16717
16718 .option user routers string&!! "see below"
16719 .cindex "uid (user id)" "local delivery"
16720 .cindex "local transports" "uid and gid"
16721 .cindex "transport" "local"
16722 .cindex "router" "user for filter processing"
16723 .cindex "filter" "user for processing"
16724 When a router queues an address for a transport, and the transport does not
16725 specify a user, the user given here is used when running the delivery process.
16726 The user may be specified numerically or by name. If expansion fails, the
16727 error is logged and delivery is deferred.
16728 This user is also used by the &(redirect)& router when running a filter file.
16729 The default is unset, except when &%check_local_user%& is set. In this case,
16730 the default is taken from the password information. If the user is specified as
16731 a name, and &%group%& is not set, the group associated with the user is used.
16732 See also &%initgroups%& and &%group%& and the discussion in chapter
16733 &<<CHAPenvironment>>&.
16734
16735
16736
16737 .option verify routers&!? boolean true
16738 Setting this option has the effect of setting &%verify_sender%& and
16739 &%verify_recipient%& to the same value.
16740
16741
16742 .option verify_only routers&!? boolean false
16743 .cindex "EXPN" "with &%verify_only%&"
16744 .oindex "&%-bv%&"
16745 .cindex "router" "used only when verifying"
16746 If this option is set, the router is used only when verifying an address or
16747 testing with the &%-bv%& option, not when actually doing a delivery, testing
16748 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
16749 restricted to verifying only senders or recipients by means of
16750 &%verify_sender%& and &%verify_recipient%&.
16751
16752 &*Warning*&: When the router is being run to verify addresses for an incoming
16753 SMTP message, Exim is not running as root, but under its own uid. If the router
16754 accesses any files, you need to make sure that they are accessible to the Exim
16755 user or group.
16756
16757
16758 .option verify_recipient routers&!? boolean true
16759 If this option is false, the router is skipped when verifying recipient
16760 addresses
16761 or testing recipient verification using &%-bv%&.
16762 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16763 are evaluated.
16764
16765
16766 .option verify_sender routers&!? boolean true
16767 If this option is false, the router is skipped when verifying sender addresses
16768 or testing sender verification using &%-bvs%&.
16769 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16770 are evaluated.
16771 .ecindex IIDgenoprou1
16772 .ecindex IIDgenoprou2
16773
16774
16775
16776
16777
16778
16779 . ////////////////////////////////////////////////////////////////////////////
16780 . ////////////////////////////////////////////////////////////////////////////
16781
16782 .chapter "The accept router" "CHID4"
16783 .cindex "&(accept)& router"
16784 .cindex "routers" "&(accept)&"
16785 The &(accept)& router has no private options of its own. Unless it is being
16786 used purely for verification (see &%verify_only%&) a transport is required to
16787 be defined by the generic &%transport%& option. If the preconditions that are
16788 specified by generic options are met, the router accepts the address and queues
16789 it for the given transport. The most common use of this router is for setting
16790 up deliveries to local mailboxes. For example:
16791 .code
16792 localusers:
16793   driver = accept
16794   domains = mydomain.example
16795   check_local_user
16796   transport = local_delivery
16797 .endd
16798 The &%domains%& condition in this example checks the domain of the address, and
16799 &%check_local_user%& checks that the local part is the login of a local user.
16800 When both preconditions are met, the &(accept)& router runs, and queues the
16801 address for the &(local_delivery)& transport.
16802
16803
16804
16805
16806
16807
16808 . ////////////////////////////////////////////////////////////////////////////
16809 . ////////////////////////////////////////////////////////////////////////////
16810
16811 .chapter "The dnslookup router" "CHAPdnslookup"
16812 .scindex IIDdnsrou1 "&(dnslookup)& router"
16813 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
16814 The &(dnslookup)& router looks up the hosts that handle mail for the
16815 recipient's domain in the DNS. A transport must always be set for this router,
16816 unless &%verify_only%& is set.
16817
16818 If SRV support is configured (see &%check_srv%& below), Exim first searches for
16819 SRV records. If none are found, or if SRV support is not configured,
16820 MX records are looked up. If no MX records exist, address records are sought.
16821 However, &%mx_domains%& can be set to disable the direct use of address
16822 records.
16823
16824 MX records of equal priority are sorted by Exim into a random order. Exim then
16825 looks for address records for the host names obtained from MX or SRV records.
16826 When a host has more than one IP address, they are sorted into a random order,
16827 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
16828 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
16829 generic option, the router declines.
16830
16831 Unless they have the highest priority (lowest MX value), MX records that point
16832 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
16833 are discarded, together with any other MX records of equal or lower priority.
16834
16835 .cindex "MX record" "pointing to local host"
16836 .cindex "local host" "MX pointing to"
16837 .oindex "&%self%&" "in &(dnslookup)& router"
16838 If the host pointed to by the highest priority MX record, or looked up as an
16839 address record, is the local host, or matches &%hosts_treat_as_local%&, what
16840 happens is controlled by the generic &%self%& option.
16841
16842
16843 .section "Problems with DNS lookups" "SECTprowitdnsloo"
16844 There have been problems with DNS servers when SRV records are looked up.
16845 Some mis-behaving servers return a DNS error or timeout when a non-existent
16846 SRV record is sought. Similar problems have in the past been reported for
16847 MX records. The global &%dns_again_means_nonexist%& option can help with this
16848 problem, but it is heavy-handed because it is a global option.
16849
16850 For this reason, there are two options, &%srv_fail_domains%& and
16851 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
16852 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
16853 an attempt to look up an SRV or MX record causes one of these results, and the
16854 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
16855 such record"&. In the case of an SRV lookup, this means that the router
16856 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
16857 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
16858 case routing fails.
16859
16860
16861
16862
16863 .section "Private options for dnslookup" "SECID118"
16864 .cindex "options" "&(dnslookup)& router"
16865 The private options for the &(dnslookup)& router are as follows:
16866
16867 .option check_secondary_mx dnslookup boolean false
16868 .cindex "MX record" "checking for secondary"
16869 If this option is set, the router declines unless the local host is found in
16870 (and removed from) the list of hosts obtained by MX lookup. This can be used to
16871 process domains for which the local host is a secondary mail exchanger
16872 differently to other domains. The way in which Exim decides whether a host is
16873 the local host is described in section &<<SECTreclocipadd>>&.
16874
16875
16876 .option check_srv dnslookup string&!! unset
16877 .cindex "SRV record" "enabling use of"
16878 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
16879 addition to MX and address records. The support is disabled by default. To
16880 enable SRV support, set the &%check_srv%& option to the name of the service
16881 required. For example,
16882 .code
16883 check_srv = smtp
16884 .endd
16885 looks for SRV records that refer to the normal smtp service. The option is
16886 expanded, so the service name can vary from message to message or address
16887 to address. This might be helpful if SRV records are being used for a
16888 submission service. If the expansion is forced to fail, the &%check_srv%&
16889 option is ignored, and the router proceeds to look for MX records in the
16890 normal way.
16891
16892 When the expansion succeeds, the router searches first for SRV records for
16893 the given service (it assumes TCP protocol). A single SRV record with a
16894 host name that consists of just a single dot indicates &"no such service for
16895 this domain"&; if this is encountered, the router declines. If other kinds of
16896 SRV record are found, they are used to construct a host list for delivery
16897 according to the rules of RFC 2782. MX records are not sought in this case.
16898
16899 When no SRV records are found, MX records (and address records) are sought in
16900 the traditional way. In other words, SRV records take precedence over MX
16901 records, just as MX records take precedence over address records. Note that
16902 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
16903 defined it. It is apparently believed that MX records are sufficient for email
16904 and that SRV records should not be used for this purpose. However, SRV records
16905 have an additional &"weight"& feature which some people might find useful when
16906 trying to split an SMTP load between hosts of different power.
16907
16908 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
16909 when there is a DNS lookup error.
16910
16911
16912
16913 .option mx_domains dnslookup "domain list&!!" unset
16914 .cindex "MX record" "required to exist"
16915 .cindex "SRV record" "required to exist"
16916 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
16917 record in order to be recognized. (The name of this option could be improved.)
16918 For example, if all the mail hosts in &'fict.example'& are known to have MX
16919 records, except for those in &'discworld.fict.example'&, you could use this
16920 setting:
16921 .code
16922 mx_domains = ! *.discworld.fict.example : *.fict.example
16923 .endd
16924 This specifies that messages addressed to a domain that matches the list but
16925 has no MX record should be bounced immediately instead of being routed using
16926 the address record.
16927
16928
16929 .option mx_fail_domains dnslookup "domain list&!!" unset
16930 If the DNS lookup for MX records for one of the domains in this list causes a
16931 DNS lookup error, Exim behaves as if no MX records were found. See section
16932 &<<SECTprowitdnsloo>>& for more discussion.
16933
16934
16935
16936
16937 .option qualify_single dnslookup boolean true
16938 .cindex "DNS" "resolver options"
16939 .cindex "DNS" "qualifying single-component names"
16940 When this option is true, the resolver option RES_DEFNAMES is set for DNS
16941 lookups. Typically, but not standardly, this causes the resolver to qualify
16942 single-component names with the default domain. For example, on a machine
16943 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
16944 &'thesaurus.ref.example'& inside the resolver. For details of what your
16945 resolver actually does, consult your man pages for &'resolver'& and
16946 &'resolv.conf'&.
16947
16948
16949
16950 .option rewrite_headers dnslookup boolean true
16951 .cindex "rewriting" "header lines"
16952 .cindex "header lines" "rewriting"
16953 If the domain name in the address that is being processed is not fully
16954 qualified, it may be expanded to its full form by a DNS lookup. For example, if
16955 an address is specified as &'dormouse@teaparty'&, the domain might be
16956 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
16957 occur as a result of setting the &%widen_domains%& option. If
16958 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
16959 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
16960 header lines of the message are rewritten with the full domain name.
16961
16962 This option should be turned off only when it is known that no message is
16963 ever going to be sent outside an environment where the abbreviation makes
16964 sense.
16965
16966 When an MX record is looked up in the DNS and matches a wildcard record, name
16967 servers normally return a record containing the name that has been looked up,
16968 making it impossible to detect whether a wildcard was present or not. However,
16969 some name servers have recently been seen to return the wildcard entry. If the
16970 name returned by a DNS lookup begins with an asterisk, it is not used for
16971 header rewriting.
16972
16973
16974 .option same_domain_copy_routing dnslookup boolean false
16975 .cindex "address" "copying routing"
16976 Addresses with the same domain are normally routed by the &(dnslookup)& router
16977 to the same list of hosts. However, this cannot be presumed, because the router
16978 options and preconditions may refer to the local part of the address. By
16979 default, therefore, Exim routes each address in a message independently. DNS
16980 servers run caches, so repeated DNS lookups are not normally expensive, and in
16981 any case, personal messages rarely have more than a few recipients.
16982
16983 If you are running mailing lists with large numbers of subscribers at the same
16984 domain, and you are using a &(dnslookup)& router which is independent of the
16985 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
16986 lookups for identical domains in one message. In this case, when &(dnslookup)&
16987 routes an address to a remote transport, any other unrouted addresses in the
16988 message that have the same domain are automatically given the same routing
16989 without processing them independently,
16990 provided the following conditions are met:
16991
16992 .ilist
16993 No router that processed the address specified &%headers_add%& or
16994 &%headers_remove%&.
16995 .next
16996 The router did not change the address in any way, for example, by &"widening"&
16997 the domain.
16998 .endlist
16999
17000
17001
17002
17003 .option search_parents dnslookup boolean false
17004 .cindex "DNS" "resolver options"
17005 When this option is true, the resolver option RES_DNSRCH is set for DNS
17006 lookups. This is different from the &%qualify_single%& option in that it
17007 applies to domains containing dots. Typically, but not standardly, it causes
17008 the resolver to search for the name in the current domain and in parent
17009 domains. For example, on a machine in the &'fict.example'& domain, if looking
17010 up &'teaparty.wonderland'& failed, the resolver would try
17011 &'teaparty.wonderland.fict.example'&. For details of what your resolver
17012 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
17013
17014 Setting this option true can cause problems in domains that have a wildcard MX
17015 record, because any domain that does not have its own MX record matches the
17016 local wildcard.
17017
17018
17019
17020 .option srv_fail_domains dnslookup "domain list&!!" unset
17021 If the DNS lookup for SRV records for one of the domains in this list causes a
17022 DNS lookup error, Exim behaves as if no SRV records were found. See section
17023 &<<SECTprowitdnsloo>>& for more discussion.
17024
17025
17026
17027
17028 .option widen_domains dnslookup "string list" unset
17029 .cindex "domain" "partial; widening"
17030 If a DNS lookup fails and this option is set, each of its strings in turn is
17031 added onto the end of the domain, and the lookup is tried again. For example,
17032 if
17033 .code
17034 widen_domains = fict.example:ref.example
17035 .endd
17036 is set and a lookup of &'klingon.dictionary'& fails,
17037 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
17038 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
17039 and &%search_parents%& options can cause some widening to be undertaken inside
17040 the DNS resolver. &%widen_domains%& is not applied to sender addresses
17041 when verifying, unless &%rewrite_headers%& is false (not the default).
17042
17043
17044 .section "Effect of qualify_single and search_parents" "SECID119"
17045 When a domain from an envelope recipient is changed by the resolver as a result
17046 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
17047 corresponding address in the message's header lines unless &%rewrite_headers%&
17048 is set false. Exim then re-routes the address, using the full domain.
17049
17050 These two options affect only the DNS lookup that takes place inside the router
17051 for the domain of the address that is being routed. They do not affect lookups
17052 such as that implied by
17053 .code
17054 domains = @mx_any
17055 .endd
17056 that may happen while processing a router precondition before the router is
17057 entered. No widening ever takes place for these lookups.
17058 .ecindex IIDdnsrou1
17059 .ecindex IIDdnsrou2
17060
17061
17062
17063
17064
17065
17066
17067
17068
17069 . ////////////////////////////////////////////////////////////////////////////
17070 . ////////////////////////////////////////////////////////////////////////////
17071
17072 .chapter "The ipliteral router" "CHID5"
17073 .cindex "&(ipliteral)& router"
17074 .cindex "domain literal" "routing"
17075 .cindex "routers" "&(ipliteral)&"
17076 This router has no private options. Unless it is being used purely for
17077 verification (see &%verify_only%&) a transport is required to be defined by the
17078 generic &%transport%& option. The router accepts the address if its domain part
17079 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
17080 router handles the address
17081 .code
17082 root@[192.168.1.1]
17083 .endd
17084 by setting up delivery to the host with that IP address. IPv4 domain literals
17085 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
17086 are similar, but the address is preceded by &`ipv6:`&. For example:
17087 .code
17088 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
17089 .endd
17090 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
17091 grounds that sooner or later somebody will try it.
17092
17093 .oindex "&%self%&" "in &(ipliteral)& router"
17094 If the IP address matches something in &%ignore_target_hosts%&, the router
17095 declines. If an IP literal turns out to refer to the local host, the generic
17096 &%self%& option determines what happens.
17097
17098 The RFCs require support for domain literals; however, their use is
17099 controversial in today's Internet. If you want to use this router, you must
17100 also set the main configuration option &%allow_domain_literals%&. Otherwise,
17101 Exim will not recognize the domain literal syntax in addresses.
17102
17103
17104
17105 . ////////////////////////////////////////////////////////////////////////////
17106 . ////////////////////////////////////////////////////////////////////////////
17107
17108 .chapter "The iplookup router" "CHID6"
17109 .cindex "&(iplookup)& router"
17110 .cindex "routers" "&(iplookup)&"
17111 The &(iplookup)& router was written to fulfil a specific requirement in
17112 Cambridge University (which in fact no longer exists). For this reason, it is
17113 not included in the binary of Exim by default. If you want to include it, you
17114 must set
17115 .code
17116 ROUTER_IPLOOKUP=yes
17117 .endd
17118 in your &_Local/Makefile_& configuration file.
17119
17120 The &(iplookup)& router routes an address by sending it over a TCP or UDP
17121 connection to one or more specific hosts. The host can then return the same or
17122 a different address &-- in effect rewriting the recipient address in the
17123 message's envelope. The new address is then passed on to subsequent routers. If
17124 this process fails, the address can be passed on to other routers, or delivery
17125 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
17126 must not be specified for it.
17127
17128 .cindex "options" "&(iplookup)& router"
17129 .option hosts iplookup string unset
17130 This option must be supplied. Its value is a colon-separated list of host
17131 names. The hosts are looked up using &[gethostbyname()]&
17132 (or &[getipnodebyname()]& when available)
17133 and are tried in order until one responds to the query. If none respond, what
17134 happens is controlled by &%optional%&.
17135
17136
17137 .option optional iplookup boolean false
17138 If &%optional%& is true, if no response is obtained from any host, the address
17139 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
17140 delivery to the address is deferred.
17141
17142
17143 .option port iplookup integer 0
17144 .cindex "port" "&(iplookup)& router"
17145 This option must be supplied. It specifies the port number for the TCP or UDP
17146 call.
17147
17148
17149 .option protocol iplookup string udp
17150 This option can be set to &"udp"& or &"tcp"& to specify which of the two
17151 protocols is to be used.
17152
17153
17154 .option query iplookup string&!! "see below"
17155 This defines the content of the query that is sent to the remote hosts. The
17156 default value is:
17157 .code
17158 $local_part@$domain $local_part@$domain
17159 .endd
17160 The repetition serves as a way of checking that a response is to the correct
17161 query in the default case (see &%response_pattern%& below).
17162
17163
17164 .option reroute iplookup string&!! unset
17165 If this option is not set, the rerouted address is precisely the byte string
17166 returned by the remote host, up to the first white space, if any. If set, the
17167 string is expanded to form the rerouted address. It can include parts matched
17168 in the response by &%response_pattern%& by means of numeric variables such as
17169 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17170 whether or not a pattern is in use. In all cases, the rerouted address must end
17171 up in the form &'local_part@domain'&.
17172
17173
17174 .option response_pattern iplookup string unset
17175 This option can be set to a regular expression that is applied to the string
17176 returned from the remote host. If the pattern does not match the response, the
17177 router declines. If &%response_pattern%& is not set, no checking of the
17178 response is done, unless the query was defaulted, in which case there is a
17179 check that the text returned after the first white space is the original
17180 address. This checks that the answer that has been received is in response to
17181 the correct question. For example, if the response is just a new domain, the
17182 following could be used:
17183 .code
17184 response_pattern = ^([^@]+)$
17185 reroute = $local_part@$1
17186 .endd
17187
17188 .option timeout iplookup time 5s
17189 This specifies the amount of time to wait for a response from the remote
17190 machine. The same timeout is used for the &[connect()]& function for a TCP
17191 call. It does not apply to UDP.
17192
17193
17194
17195
17196 . ////////////////////////////////////////////////////////////////////////////
17197 . ////////////////////////////////////////////////////////////////////////////
17198
17199 .chapter "The manualroute router" "CHID7"
17200 .scindex IIDmanrou1 "&(manualroute)& router"
17201 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17202 .cindex "domain" "manually routing"
17203 The &(manualroute)& router is so-called because it provides a way of manually
17204 routing an address according to its domain. It is mainly used when you want to
17205 route addresses to remote hosts according to your own rules, bypassing the
17206 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17207 route to local transports, a facility that may be useful if you want to save
17208 messages for dial-in hosts in local files.
17209
17210 The &(manualroute)& router compares a list of domain patterns with the domain
17211 it is trying to route. If there is no match, the router declines. Each pattern
17212 has associated with it a list of hosts and some other optional data, which may
17213 include a transport. The combination of a pattern and its data is called a
17214 &"routing rule"&. For patterns that do not have an associated transport, the
17215 generic &%transport%& option must specify a transport, unless the router is
17216 being used purely for verification (see &%verify_only%&).
17217
17218 .vindex "&$host$&"
17219 In the case of verification, matching the domain pattern is sufficient for the
17220 router to accept the address. When actually routing an address for delivery,
17221 an address that matches a domain pattern is queued for the associated
17222 transport. If the transport is not a local one, a host list must be associated
17223 with the pattern; IP addresses are looked up for the hosts, and these are
17224 passed to the transport along with the mail address. For local transports, a
17225 host list is optional. If it is present, it is passed in &$host$& as a single
17226 text string.
17227
17228 The list of routing rules can be provided as an inline string in
17229 &%route_list%&, or the data can be obtained by looking up the domain in a file
17230 or database by setting &%route_data%&. Only one of these settings may appear in
17231 any one instance of &(manualroute)&. The format of routing rules is described
17232 below, following the list of private options.
17233
17234
17235 .section "Private options for manualroute" "SECTprioptman"
17236
17237 .cindex "options" "&(manualroute)& router"
17238 The private options for the &(manualroute)& router are as follows:
17239
17240 .option host_all_ignored manualroute string defer
17241 See &%host_find_failed%&.
17242
17243 .option host_find_failed manualroute string freeze
17244 This option controls what happens when &(manualroute)& tries to find an IP
17245 address for a host, and the host does not exist. The option can be set to one
17246 of the following values:
17247 .code
17248 decline
17249 defer
17250 fail
17251 freeze
17252 ignore
17253 pass
17254 .endd
17255 The default (&"freeze"&) assumes that this state is a serious configuration
17256 error. The difference between &"pass"& and &"decline"& is that the former
17257 forces the address to be passed to the next router (or the router defined by
17258 &%pass_router%&),
17259 .oindex "&%more%&"
17260 overriding &%no_more%&, whereas the latter passes the address to the next
17261 router only if &%more%& is true.
17262
17263 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17264 cannot be found. If all the hosts in the list are ignored, the behaviour is
17265 controlled by the &%host_all_ignored%& option. This takes the same values
17266 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17267
17268 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17269 state; if a host lookup gets a temporary error, delivery is deferred unless the
17270 generic &%pass_on_timeout%& option is set.
17271
17272
17273 .option hosts_randomize manualroute boolean false
17274 .cindex "randomized host list"
17275 .cindex "host" "list of; randomized"
17276 If this option is set, the order of the items in a host list in a routing rule
17277 is randomized each time the list is used, unless an option in the routing rule
17278 overrides (see below). Randomizing the order of a host list can be used to do
17279 crude load sharing. However, if more than one mail address is routed by the
17280 same router to the same host list, the host lists are considered to be the same
17281 (even though they may be randomized into different orders) for the purpose of
17282 deciding whether to batch the deliveries into a single SMTP transaction.
17283
17284 When &%hosts_randomize%& is true, a host list may be split
17285 into groups whose order is separately randomized. This makes it possible to
17286 set up MX-like behaviour. The boundaries between groups are indicated by an
17287 item that is just &`+`& in the host list. For example:
17288 .code
17289 route_list = * host1:host2:host3:+:host4:host5
17290 .endd
17291 The order of the first three hosts and the order of the last two hosts is
17292 randomized for each use, but the first three always end up before the last two.
17293 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
17294 randomized host list is passed to an &(smtp)& transport that also has
17295 &%hosts_randomize set%&, the list is not re-randomized.
17296
17297
17298 .option route_data manualroute string&!! unset
17299 If this option is set, it must expand to yield the data part of a routing rule.
17300 Typically, the expansion string includes a lookup based on the domain. For
17301 example:
17302 .code
17303 route_data = ${lookup{$domain}dbm{/etc/routes}}
17304 .endd
17305 If the expansion is forced to fail, or the result is an empty string, the
17306 router declines. Other kinds of expansion failure cause delivery to be
17307 deferred.
17308
17309
17310 .option route_list manualroute "string list" unset
17311 This string is a list of routing rules, in the form defined below. Note that,
17312 unlike most string lists, the items are separated by semicolons. This is so
17313 that they may contain colon-separated host lists.
17314
17315
17316 .option same_domain_copy_routing manualroute boolean false
17317 .cindex "address" "copying routing"
17318 Addresses with the same domain are normally routed by the &(manualroute)&
17319 router to the same list of hosts. However, this cannot be presumed, because the
17320 router options and preconditions may refer to the local part of the address. By
17321 default, therefore, Exim routes each address in a message independently. DNS
17322 servers run caches, so repeated DNS lookups are not normally expensive, and in
17323 any case, personal messages rarely have more than a few recipients.
17324
17325 If you are running mailing lists with large numbers of subscribers at the same
17326 domain, and you are using a &(manualroute)& router which is independent of the
17327 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17328 lookups for identical domains in one message. In this case, when
17329 &(manualroute)& routes an address to a remote transport, any other unrouted
17330 addresses in the message that have the same domain are automatically given the
17331 same routing without processing them independently. However, this is only done
17332 if &%headers_add%& and &%headers_remove%& are unset.
17333
17334
17335
17336
17337 .section "Routing rules in route_list" "SECID120"
17338 The value of &%route_list%& is a string consisting of a sequence of routing
17339 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
17340 entered as two semicolons. Alternatively, the list separator can be changed as
17341 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
17342 Empty rules are ignored. The format of each rule is
17343 .display
17344 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
17345 .endd
17346 The following example contains two rules, each with a simple domain pattern and
17347 no options:
17348 .code
17349 route_list = \
17350   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
17351   thes.ref.example  mail-3.ref.example:mail-4.ref.example
17352 .endd
17353 The three parts of a rule are separated by white space. The pattern and the
17354 list of hosts can be enclosed in quotes if necessary, and if they are, the
17355 usual quoting rules apply. Each rule in a &%route_list%& must start with a
17356 single domain pattern, which is the only mandatory item in the rule. The
17357 pattern is in the same format as one item in a domain list (see section
17358 &<<SECTdomainlist>>&),
17359 except that it may not be the name of an interpolated file.
17360 That is, it may be wildcarded, or a regular expression, or a file or database
17361 lookup (with semicolons doubled, because of the use of semicolon as a separator
17362 in a &%route_list%&).
17363
17364 The rules in &%route_list%& are searched in order until one of the patterns
17365 matches the domain that is being routed. The list of hosts and then options are
17366 then used as described below. If there is no match, the router declines. When
17367 &%route_list%& is set, &%route_data%& must not be set.
17368
17369
17370
17371 .section "Routing rules in route_data" "SECID121"
17372 The use of &%route_list%& is convenient when there are only a small number of
17373 routing rules. For larger numbers, it is easier to use a file or database to
17374 hold the routing information, and use the &%route_data%& option instead.
17375 The value of &%route_data%& is a list of hosts, followed by (optional) options.
17376 Most commonly, &%route_data%& is set as a string that contains an
17377 expansion lookup. For example, suppose we place two routing rules in a file
17378 like this:
17379 .code
17380 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
17381 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
17382 .endd
17383 This data can be accessed by setting
17384 .code
17385 route_data = ${lookup{$domain}lsearch{/the/file/name}}
17386 .endd
17387 Failure of the lookup results in an empty string, causing the router to
17388 decline. However, you do not have to use a lookup in &%route_data%&. The only
17389 requirement is that the result of expanding the string is a list of hosts,
17390 possibly followed by options, separated by white space. The list of hosts must
17391 be enclosed in quotes if it contains white space.
17392
17393
17394
17395
17396 .section "Format of the list of hosts" "SECID122"
17397 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
17398 always separately expanded before use. If the expansion fails, the router
17399 declines. The result of the expansion must be a colon-separated list of names
17400 and/or IP addresses, optionally also including ports. The format of each item
17401 in the list is described in the next section. The list separator can be changed
17402 as described in section &<<SECTlistconstruct>>&.
17403
17404 If the list of hosts was obtained from a &%route_list%& item, the following
17405 variables are set during its expansion:
17406
17407 .ilist
17408 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
17409 If the domain was matched against a regular expression, the numeric variables
17410 &$1$&, &$2$&, etc. may be set. For example:
17411 .code
17412 route_list = ^domain(\d+)   host-$1.text.example
17413 .endd
17414 .next
17415 &$0$& is always set to the entire domain.
17416 .next
17417 &$1$& is also set when partial matching is done in a file lookup.
17418
17419 .next
17420 .vindex "&$value$&"
17421 If the pattern that matched the domain was a lookup item, the data that was
17422 looked up is available in the expansion variable &$value$&. For example:
17423 .code
17424 route_list = lsearch;;/some/file.routes  $value
17425 .endd
17426 .endlist
17427
17428 Note the doubling of the semicolon in the pattern that is necessary because
17429 semicolon is the default route list separator.
17430
17431
17432
17433 .section "Format of one host item" "SECTformatonehostitem"
17434 Each item in the list of hosts is either a host name or an IP address,
17435 optionally with an attached port number. When no port is given, an IP address
17436 is not enclosed in brackets. When a port is specified, it overrides the port
17437 specification on the transport. The port is separated from the name or address
17438 by a colon. This leads to some complications:
17439
17440 .ilist
17441 Because colon is the default separator for the list of hosts, either
17442 the colon that specifies a port must be doubled, or the list separator must
17443 be changed. The following two examples have the same effect:
17444 .code
17445 route_list = * "host1.tld::1225 : host2.tld::1226"
17446 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
17447 .endd
17448 .next
17449 When IPv6 addresses are involved, it gets worse, because they contain
17450 colons of their own. To make this case easier, it is permitted to
17451 enclose an IP address (either v4 or v6) in square brackets if a port
17452 number follows. For example:
17453 .code
17454 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
17455 .endd
17456 .endlist
17457
17458 .section "How the list of hosts is used" "SECThostshowused"
17459 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
17460 the hosts is tried, in the order specified, when carrying out the SMTP
17461 delivery. However, the order can be changed by setting the &%hosts_randomize%&
17462 option, either on the router (see section &<<SECTprioptman>>& above), or on the
17463 transport.
17464
17465 Hosts may be listed by name or by IP address. An unadorned name in the list of
17466 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
17467 interpreted as an indirection to a sublist of hosts obtained by looking up MX
17468 records in the DNS. For example:
17469 .code
17470 route_list = *  x.y.z:p.q.r/MX:e.f.g
17471 .endd
17472 If this feature is used with a port specifier, the port must come last. For
17473 example:
17474 .code
17475 route_list = *  dom1.tld/mx::1225
17476 .endd
17477 If the &%hosts_randomize%& option is set, the order of the items in the list is
17478 randomized before any lookups are done. Exim then scans the list; for any name
17479 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
17480 be an interface on the local host and the item is not the first in the list,
17481 Exim discards it and any subsequent items. If it is the first item, what
17482 happens is controlled by the
17483 .oindex "&%self%&" "in &(manualroute)& router"
17484 &%self%& option of the router.
17485
17486 A name on the list that is followed by &`/MX`& is replaced with the list of
17487 hosts obtained by looking up MX records for the name. This is always a DNS
17488 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
17489 below) are not relevant here. The order of these hosts is determined by the
17490 preference values in the MX records, according to the usual rules. Because
17491 randomizing happens before the MX lookup, it does not affect the order that is
17492 defined by MX preferences.
17493
17494 If the local host is present in the sublist obtained from MX records, but is
17495 not the most preferred host in that list, it and any equally or less
17496 preferred hosts are removed before the sublist is inserted into the main list.
17497
17498 If the local host is the most preferred host in the MX list, what happens
17499 depends on where in the original list of hosts the &`/MX`& item appears. If it
17500 is not the first item (that is, there are previous hosts in the main list),
17501 Exim discards this name and any subsequent items in the main list.
17502
17503 If the MX item is first in the list of hosts, and the local host is the
17504 most preferred host, what happens is controlled by the &%self%& option of the
17505 router.
17506
17507 DNS failures when lookup up the MX records are treated in the same way as DNS
17508 failures when looking up IP addresses: &%pass_on_timeout%& and
17509 &%host_find_failed%& are used when relevant.
17510
17511 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
17512 whether obtained from an MX lookup or not.
17513
17514
17515
17516 .section "How the options are used" "SECThowoptused"
17517 The options are a sequence of words; in practice no more than three are ever
17518 present. One of the words can be the name of a transport; this overrides the
17519 &%transport%& option on the router for this particular routing rule only. The
17520 other words (if present) control randomization of the list of hosts on a
17521 per-rule basis, and how the IP addresses of the hosts are to be found when
17522 routing to a remote transport. These options are as follows:
17523
17524 .ilist
17525 &%randomize%&: randomize the order of the hosts in this list, overriding the
17526 setting of &%hosts_randomize%& for this routing rule only.
17527 .next
17528 &%no_randomize%&: do not randomize the order of the hosts in this list,
17529 overriding the setting of &%hosts_randomize%& for this routing rule only.
17530 .next
17531 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
17532 find IP addresses. This function may ultimately cause a DNS lookup, but it may
17533 also look in &_/etc/hosts_& or other sources of information.
17534 .next
17535 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
17536 no address records are found. If there is a temporary DNS error (such as a
17537 timeout), delivery is deferred.
17538 .endlist
17539
17540 For example:
17541 .code
17542 route_list = domain1  host1:host2:host3  randomize bydns;\
17543              domain2  host4:host5
17544 .endd
17545 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
17546 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
17547 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
17548 or &[gethostbyname()]&, and the result of the lookup is the result of that
17549 call.
17550
17551 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
17552 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
17553 instead of TRY_AGAIN. That is why the default action is to try a DNS
17554 lookup first. Only if that gives a definite &"no such host"& is the local
17555 function called.
17556
17557
17558
17559 If no IP address for a host can be found, what happens is controlled by the
17560 &%host_find_failed%& option.
17561
17562 .vindex "&$host$&"
17563 When an address is routed to a local transport, IP addresses are not looked up.
17564 The host list is passed to the transport in the &$host$& variable.
17565
17566
17567
17568 .section "Manualroute examples" "SECID123"
17569 In some of the examples that follow, the presence of the &%remote_smtp%&
17570 transport, as defined in the default configuration file, is assumed:
17571
17572 .ilist
17573 .cindex "smart host" "example router"
17574 The &(manualroute)& router can be used to forward all external mail to a
17575 &'smart host'&. If you have set up, in the main part of the configuration, a
17576 named domain list that contains your local domains, for example:
17577 .code
17578 domainlist local_domains = my.domain.example
17579 .endd
17580 You can arrange for all other domains to be routed to a smart host by making
17581 your first router something like this:
17582 .code
17583 smart_route:
17584   driver = manualroute
17585   domains = !+local_domains
17586   transport = remote_smtp
17587   route_list = * smarthost.ref.example
17588 .endd
17589 This causes all non-local addresses to be sent to the single host
17590 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
17591 they are tried in order
17592 (but you can use &%hosts_randomize%& to vary the order each time).
17593 Another way of configuring the same thing is this:
17594 .code
17595 smart_route:
17596   driver = manualroute
17597   transport = remote_smtp
17598   route_list = !+local_domains  smarthost.ref.example
17599 .endd
17600 There is no difference in behaviour between these two routers as they stand.
17601 However, they behave differently if &%no_more%& is added to them. In the first
17602 example, the router is skipped if the domain does not match the &%domains%&
17603 precondition; the following router is always tried. If the router runs, it
17604 always matches the domain and so can never decline. Therefore, &%no_more%&
17605 would have no effect. In the second case, the router is never skipped; it
17606 always runs. However, if it doesn't match the domain, it declines. In this case
17607 &%no_more%& would prevent subsequent routers from running.
17608
17609 .next
17610 .cindex "mail hub example"
17611 A &'mail hub'& is a host which receives mail for a number of domains via MX
17612 records in the DNS and delivers it via its own private routing mechanism. Often
17613 the final destinations are behind a firewall, with the mail hub being the one
17614 machine that can connect to machines both inside and outside the firewall. The
17615 &(manualroute)& router is usually used on a mail hub to route incoming messages
17616 to the correct hosts. For a small number of domains, the routing can be inline,
17617 using the &%route_list%& option, but for a larger number a file or database
17618 lookup is easier to manage.
17619
17620 If the domain names are in fact the names of the machines to which the mail is
17621 to be sent by the mail hub, the configuration can be quite simple. For
17622 example:
17623 .code
17624 hub_route:
17625   driver = manualroute
17626   transport = remote_smtp
17627   route_list = *.rhodes.tvs.example  $domain
17628 .endd
17629 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
17630 whose names are the same as the mail domains. A similar approach can be taken
17631 if the host name can be obtained from the domain name by a string manipulation
17632 that the expansion facilities can handle. Otherwise, a lookup based on the
17633 domain can be used to find the host:
17634 .code
17635 through_firewall:
17636   driver = manualroute
17637   transport = remote_smtp
17638   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
17639 .endd
17640 The result of the lookup must be the name or IP address of the host (or
17641 hosts) to which the address is to be routed. If the lookup fails, the route
17642 data is empty, causing the router to decline. The address then passes to the
17643 next router.
17644
17645 .next
17646 .cindex "batched SMTP output example"
17647 .cindex "SMTP" "batched outgoing; example"
17648 You can use &(manualroute)& to deliver messages to pipes or files in batched
17649 SMTP format for onward transportation by some other means. This is one way of
17650 storing mail for a dial-up host when it is not connected. The route list entry
17651 can be as simple as a single domain name in a configuration like this:
17652 .code
17653 save_in_file:
17654   driver = manualroute
17655   transport = batchsmtp_appendfile
17656   route_list = saved.domain.example
17657 .endd
17658 though often a pattern is used to pick up more than one domain. If there are
17659 several domains or groups of domains with different transport requirements,
17660 different transports can be listed in the routing information:
17661 .code
17662 save_in_file:
17663   driver = manualroute
17664   route_list = \
17665     *.saved.domain1.example  $domain  batch_appendfile; \
17666     *.saved.domain2.example  \
17667       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
17668       batch_pipe
17669 .endd
17670 .vindex "&$domain$&"
17671 .vindex "&$host$&"
17672 The first of these just passes the domain in the &$host$& variable, which
17673 doesn't achieve much (since it is also in &$domain$&), but the second does a
17674 file lookup to find a value to pass, causing the router to decline to handle
17675 the address if the lookup fails.
17676
17677 .next
17678 .cindex "UUCP" "example of router for"
17679 Routing mail directly to UUCP software is a specific case of the use of
17680 &(manualroute)& in a gateway to another mail environment. This is an example of
17681 one way it can be done:
17682 .code
17683 # Transport
17684 uucp:
17685   driver = pipe
17686   user = nobody
17687   command = /usr/local/bin/uux -r - \
17688     ${substr_-5:$host}!rmail ${local_part}
17689   return_fail_output = true
17690
17691 # Router
17692 uucphost:
17693   transport = uucp
17694   driver = manualroute
17695   route_data = \
17696     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
17697 .endd
17698 The file &_/usr/local/exim/uucphosts_& contains entries like
17699 .code
17700 darksite.ethereal.example:           darksite.UUCP
17701 .endd
17702 It can be set up more simply without adding and removing &".UUCP"& but this way
17703 makes clear the distinction between the domain name
17704 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
17705 .endlist
17706 .ecindex IIDmanrou1
17707 .ecindex IIDmanrou2
17708
17709
17710
17711
17712
17713
17714
17715
17716 . ////////////////////////////////////////////////////////////////////////////
17717 . ////////////////////////////////////////////////////////////////////////////
17718
17719 .chapter "The queryprogram router" "CHAPdriverlast"
17720 .scindex IIDquerou1 "&(queryprogram)& router"
17721 .scindex IIDquerou2 "routers" "&(queryprogram)&"
17722 .cindex "routing" "by external program"
17723 The &(queryprogram)& router routes an address by running an external command
17724 and acting on its output. This is an expensive way to route, and is intended
17725 mainly for use in lightly-loaded systems, or for performing experiments.
17726 However, if it is possible to use the precondition options (&%domains%&,
17727 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
17728 be used in special cases, even on a busy host. There are the following private
17729 options:
17730 .cindex "options" "&(queryprogram)& router"
17731
17732 .option command queryprogram string&!! unset
17733 This option must be set. It specifies the command that is to be run. The
17734 command is split up into a command name and arguments, and then each is
17735 expanded separately (exactly as for a &(pipe)& transport, described in chapter
17736 &<<CHAPpipetransport>>&).
17737
17738
17739 .option command_group queryprogram string unset
17740 .cindex "gid (group id)" "in &(queryprogram)& router"
17741 This option specifies a gid to be set when running the command while routing an
17742 address for deliver. It must be set if &%command_user%& specifies a numerical
17743 uid. If it begins with a digit, it is interpreted as the numerical value of the
17744 gid. Otherwise it is looked up using &[getgrnam()]&.
17745
17746
17747 .option command_user queryprogram string unset
17748 .cindex "uid (user id)" "for &(queryprogram)&"
17749 This option must be set. It specifies the uid which is set when running the
17750 command while routing an address for delivery. If the value begins with a digit,
17751 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
17752 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
17753 not set, a value for the gid also.
17754
17755 &*Warning:*& Changing uid and gid is possible only when Exim is running as
17756 root, which it does during a normal delivery in a conventional configuration.
17757 However, when an address is being verified during message reception, Exim is
17758 usually running as the Exim user, not as root. If the &(queryprogram)& router
17759 is called from a non-root process, Exim cannot change uid or gid before running
17760 the command. In this circumstance the command runs under the current uid and
17761 gid.
17762
17763
17764 .option current_directory queryprogram string /
17765 This option specifies an absolute path which is made the current directory
17766 before running the command.
17767
17768
17769 .option timeout queryprogram time 1h
17770 If the command does not complete within the timeout period, its process group
17771 is killed and the message is frozen. A value of zero time specifies no
17772 timeout.
17773
17774
17775 The standard output of the command is connected to a pipe, which is read when
17776 the command terminates. It should consist of a single line of output,
17777 containing up to five fields, separated by white space. The maximum length of
17778 the line is 1023 characters. Longer lines are silently truncated. The first
17779 field is one of the following words (case-insensitive):
17780
17781 .ilist
17782 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
17783 below).
17784 .next
17785 &'Decline'&: the router declines; pass the address to the next router, unless
17786 &%no_more%& is set.
17787 .next
17788 &'Fail'&: routing failed; do not pass the address to any more routers. Any
17789 subsequent text on the line is an error message. If the router is run as part
17790 of address verification during an incoming SMTP message, the message is
17791 included in the SMTP response.
17792 .next
17793 &'Defer'&: routing could not be completed at this time; try again later. Any
17794 subsequent text on the line is an error message which is logged. It is not
17795 included in any SMTP response.
17796 .next
17797 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
17798 .next
17799 &'Pass'&: pass the address to the next router (or the router specified by
17800 &%pass_router%&), overriding &%no_more%&.
17801 .next
17802 &'Redirect'&: the message is redirected. The remainder of the line is a list of
17803 new addresses, which are routed independently, starting with the first router,
17804 or the router specified by &%redirect_router%&, if set.
17805 .endlist
17806
17807 When the first word is &'accept'&, the remainder of the line consists of a
17808 number of keyed data values, as follows (split into two lines here, to fit on
17809 the page):
17810 .code
17811 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
17812 LOOKUP=byname|bydns DATA=<text>
17813 .endd
17814 The data items can be given in any order, and all are optional. If no transport
17815 is included, the transport specified by the generic &%transport%& option is
17816 used. The list of hosts and the lookup type are needed only if the transport is
17817 an &(smtp)& transport that does not itself supply a list of hosts.
17818
17819 The format of the list of hosts is the same as for the &(manualroute)& router.
17820 As well as host names and IP addresses with optional port numbers, as described
17821 in section &<<SECTformatonehostitem>>&, it may contain names followed by
17822 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
17823 (see section &<<SECThostshowused>>&).
17824
17825 If the lookup type is not specified, Exim behaves as follows when trying to
17826 find an IP address for each host: First, a DNS lookup is done. If this yields
17827 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
17828 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
17829 result of the lookup is the result of that call.
17830
17831 .vindex "&$address_data$&"
17832 If the DATA field is set, its value is placed in the &$address_data$&
17833 variable. For example, this return line
17834 .code
17835 accept hosts=x1.y.example:x2.y.example data="rule1"
17836 .endd
17837 routes the address to the default transport, passing a list of two hosts. When
17838 the transport runs, the string &"rule1"& is in &$address_data$&.
17839 .ecindex IIDquerou1
17840 .ecindex IIDquerou2
17841
17842
17843
17844
17845 . ////////////////////////////////////////////////////////////////////////////
17846 . ////////////////////////////////////////////////////////////////////////////
17847
17848 .chapter "The redirect router" "CHAPredirect"
17849 .scindex IIDredrou1 "&(redirect)& router"
17850 .scindex IIDredrou2 "routers" "&(redirect)&"
17851 .cindex "alias file" "in a &(redirect)& router"
17852 .cindex "address redirection" "&(redirect)& router"
17853 The &(redirect)& router handles several kinds of address redirection. Its most
17854 common uses are for resolving local part aliases from a central alias file
17855 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
17856 files, but it has many other potential uses. The incoming address can be
17857 redirected in several different ways:
17858
17859 .ilist
17860 It can be replaced by one or more new addresses which are themselves routed
17861 independently.
17862 .next
17863 It can be routed to be delivered to a given file or directory.
17864 .next
17865 It can be routed to be delivered to a specified pipe command.
17866 .next
17867 It can cause an automatic reply to be generated.
17868 .next
17869 It can be forced to fail, optionally with a custom error message.
17870 .next
17871 It can be temporarily deferred, optionally with a custom message.
17872 .next
17873 It can be discarded.
17874 .endlist
17875
17876 The generic &%transport%& option must not be set for &(redirect)& routers.
17877 However, there are some private options which define transports for delivery to
17878 files and pipes, and for generating autoreplies. See the &%file_transport%&,
17879 &%pipe_transport%& and &%reply_transport%& descriptions below.
17880
17881
17882
17883 .section "Redirection data" "SECID124"
17884 The router operates by interpreting a text string which it obtains either by
17885 expanding the contents of the &%data%& option, or by reading the entire
17886 contents of a file whose name is given in the &%file%& option. These two
17887 options are mutually exclusive. The first is commonly used for handling system
17888 aliases, in a configuration like this:
17889 .code
17890 system_aliases:
17891   driver = redirect
17892   data = ${lookup{$local_part}lsearch{/etc/aliases}}
17893 .endd
17894 If the lookup fails, the expanded string in this example is empty. When the
17895 expansion of &%data%& results in an empty string, the router declines. A forced
17896 expansion failure also causes the router to decline; other expansion failures
17897 cause delivery to be deferred.
17898
17899 A configuration using &%file%& is commonly used for handling users'
17900 &_.forward_& files, like this:
17901 .code
17902 userforward:
17903   driver = redirect
17904   check_local_user
17905   file = $home/.forward
17906   no_verify
17907 .endd
17908 If the file does not exist, or causes no action to be taken (for example, it is
17909 empty or consists only of comments), the router declines. &*Warning*&: This
17910 is not the case when the file contains syntactically valid items that happen to
17911 yield empty addresses, for example, items containing only RFC 2822 address
17912 comments.
17913
17914
17915
17916 .section "Forward files and address verification" "SECID125"
17917 .cindex "address redirection" "while verifying"
17918 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
17919 &_.forward_& files, as in the example above. There are two reasons for this:
17920
17921 .ilist
17922 When Exim is receiving an incoming SMTP message from a remote host, it is
17923 running under the Exim uid, not as root. Exim is unable to change uid to read
17924 the file as the user, and it may not be able to read it as the Exim user. So in
17925 practice the router may not be able to operate.
17926 .next
17927 However, even when the router can operate, the existence of a &_.forward_& file
17928 is unimportant when verifying an address. What should be checked is whether the
17929 local part is a valid user name or not. Cutting out the redirection processing
17930 saves some resources.
17931 .endlist
17932
17933
17934
17935
17936
17937
17938 .section "Interpreting redirection data" "SECID126"
17939 .cindex "Sieve filter" "specifying in redirection data"
17940 .cindex "filter" "specifying in redirection data"
17941 The contents of the data string, whether obtained from &%data%& or &%file%&,
17942 can be interpreted in two different ways:
17943
17944 .ilist
17945 If the &%allow_filter%& option is set true, and the data begins with the text
17946 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
17947 &'filtering'& instructions in the form of an Exim or Sieve filter file,
17948 respectively. Details of the syntax and semantics of filter files are described
17949 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
17950 document is intended for use by end users.
17951 .next
17952 Otherwise, the data must be a comma-separated list of redirection items, as
17953 described in the next section.
17954 .endlist
17955
17956 When a message is redirected to a file (a &"mail folder"&), the file name given
17957 in a non-filter redirection list must always be an absolute path. A filter may
17958 generate a relative path &-- how this is handled depends on the transport's
17959 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
17960 for the &(appendfile)& transport.
17961
17962
17963
17964 .section "Items in a non-filter redirection list" "SECTitenonfilred"
17965 .cindex "address redirection" "non-filter list items"
17966 When the redirection data is not an Exim or Sieve filter, for example, if it
17967 comes from a conventional alias or forward file, it consists of a list of
17968 addresses, file names, pipe commands, or certain special items (see section
17969 &<<SECTspecitredli>>& below). The special items can be individually enabled or
17970 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
17971 depending on their default values. The items in the list are separated by
17972 commas or newlines.
17973 If a comma is required in an item, the entire item must be enclosed in double
17974 quotes.
17975
17976 Lines starting with a # character are comments, and are ignored, and # may
17977 also appear following a comma, in which case everything between the # and the
17978 next newline character is ignored.
17979
17980 If an item is entirely enclosed in double quotes, these are removed. Otherwise
17981 double quotes are retained because some forms of mail address require their use
17982 (but never to enclose the entire address). In the following description,
17983 &"item"& refers to what remains after any surrounding double quotes have been
17984 removed.
17985
17986 .vindex "&$local_part$&"
17987 &*Warning*&: If you use an Exim expansion to construct a redirection address,
17988 and the expansion contains a reference to &$local_part$&, you should make use
17989 of the &%quote_local_part%& expansion operator, in case the local part contains
17990 special characters. For example, to redirect all mail for the domain
17991 &'obsolete.example'&, retaining the existing local part, you could use this
17992 setting:
17993 .code
17994 data = ${quote_local_part:$local_part}@newdomain.example
17995 .endd
17996
17997
17998 .section "Redirecting to a local mailbox" "SECTredlocmai"
17999 .cindex "routing" "loops in"
18000 .cindex "loop" "while routing, avoidance of"
18001 .cindex "address redirection" "to local mailbox"
18002 A redirection item may safely be the same as the address currently under
18003 consideration. This does not cause a routing loop, because a router is
18004 automatically skipped if any ancestor of the address that is being processed
18005 is the same as the current address and was processed by the current router.
18006 Such an address is therefore passed to the following routers, so it is handled
18007 as if there were no redirection. When making this loop-avoidance test, the
18008 complete local part, including any prefix or suffix, is used.
18009
18010 .cindex "address redirection" "local part without domain"
18011 Specifying the same local part without a domain is a common usage in personal
18012 filter files when the user wants to have messages delivered to the local
18013 mailbox and also forwarded elsewhere. For example, the user whose login is
18014 &'cleo'& might have a &_.forward_& file containing this:
18015 .code
18016 cleo, cleopatra@egypt.example
18017 .endd
18018 .cindex "backslash in alias file"
18019 .cindex "alias file" "backslash in"
18020 For compatibility with other MTAs, such unqualified local parts may be
18021 preceded by &"\"&, but this is not a requirement for loop prevention. However,
18022 it does make a difference if more than one domain is being handled
18023 synonymously.
18024
18025 If an item begins with &"\"& and the rest of the item parses as a valid RFC
18026 2822 address that does not include a domain, the item is qualified using the
18027 domain of the incoming address. In the absence of a leading &"\"&, unqualified
18028 addresses are qualified using the value in &%qualify_recipient%&, but you can
18029 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
18030
18031 Care must be taken if there are alias names for local users.
18032 Consider an MTA handling a single local domain where the system alias file
18033 contains:
18034 .code
18035 Sam.Reman: spqr
18036 .endd
18037 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
18038 messages in the local mailbox, and also forward copies elsewhere. He creates
18039 this forward file:
18040 .code
18041 Sam.Reman, spqr@reme.elsewhere.example
18042 .endd
18043 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
18044 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
18045 second time round, because it has previously routed it,
18046 and the following routers presumably cannot handle the alias. The forward file
18047 should really contain
18048 .code
18049 spqr, spqr@reme.elsewhere.example
18050 .endd
18051 but because this is such a common error, the &%check_ancestor%& option (see
18052 below) exists to provide a way to get round it. This is normally set on a
18053 &(redirect)& router that is handling users' &_.forward_& files.
18054
18055
18056
18057 .section "Special items in redirection lists" "SECTspecitredli"
18058 In addition to addresses, the following types of item may appear in redirection
18059 lists (that is, in non-filter redirection data):
18060
18061 .ilist
18062 .cindex "pipe" "in redirection list"
18063 .cindex "address redirection" "to pipe"
18064 An item is treated as a pipe command if it begins with &"|"& and does not parse
18065 as a valid RFC 2822 address that includes a domain. A transport for running the
18066 command must be specified by the &%pipe_transport%& option.
18067 Normally, either the router or the transport specifies a user and a group under
18068 which to run the delivery. The default is to use the Exim user and group.
18069
18070 Single or double quotes can be used for enclosing the individual arguments of
18071 the pipe command; no interpretation of escapes is done for single quotes. If
18072 the command contains a comma character, it is necessary to put the whole item
18073 in double quotes, for example:
18074 .code
18075 "|/some/command ready,steady,go"
18076 .endd
18077 since items in redirection lists are terminated by commas. Do not, however,
18078 quote just the command. An item such as
18079 .code
18080 |"/some/command ready,steady,go"
18081 .endd
18082 is interpreted as a pipe with a rather strange command name, and no arguments.
18083
18084 .next
18085 .cindex "file" "in redirection list"
18086 .cindex "address redirection" "to file"
18087 An item is interpreted as a path name if it begins with &"/"& and does not
18088 parse as a valid RFC 2822 address that includes a domain. For example,
18089 .code
18090 /home/world/minbari
18091 .endd
18092 is treated as a file name, but
18093 .code
18094 /s=molari/o=babylon/@x400gate.way
18095 .endd
18096 is treated as an address. For a file name, a transport must be specified using
18097 the &%file_transport%& option. However, if the generated path name ends with a
18098 forward slash character, it is interpreted as a directory name rather than a
18099 file name, and &%directory_transport%& is used instead.
18100
18101 Normally, either the router or the transport specifies a user and a group under
18102 which to run the delivery. The default is to use the Exim user and group.
18103
18104 .cindex "&_/dev/null_&"
18105 However, if a redirection item is the path &_/dev/null_&, delivery to it is
18106 bypassed at a high level, and the log entry shows &"**bypassed**"&
18107 instead of a transport name. In this case the user and group are not used.
18108
18109 .next
18110 .cindex "included address list"
18111 .cindex "address redirection" "included external list"
18112 If an item is of the form
18113 .code
18114 :include:<path name>
18115 .endd
18116 a list of further items is taken from the given file and included at that
18117 point. &*Note*&: Such a file can not be a filter file; it is just an
18118 out-of-line addition to the list. The items in the included list are separated
18119 by commas or newlines and are not subject to expansion. If this is the first
18120 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
18121 the alias name. This example is incorrect:
18122 .code
18123 list1    :include:/opt/lists/list1
18124 .endd
18125 It must be given as
18126 .code
18127 list1:   :include:/opt/lists/list1
18128 .endd
18129 .next
18130 .cindex "address redirection" "to black hole"
18131 Sometimes you want to throw away mail to a particular local part. Making the
18132 &%data%& option expand to an empty string does not work, because that causes
18133 the router to decline. Instead, the alias item
18134 .cindex "black hole"
18135 .cindex "abandoning mail"
18136 &':blackhole:'& can be used. It does what its name implies. No delivery is
18137 done, and no error message is generated. This has the same effect as specifing
18138 &_/dev/null_& as a destination, but it can be independently disabled.
18139
18140 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
18141 delivery is done for the original local part, even if other redirection items
18142 are present. If you are generating a multi-item list (for example, by reading a
18143 database) and need the ability to provide a no-op item, you must use
18144 &_/dev/null_&.
18145
18146 .next
18147 .cindex "delivery" "forcing failure"
18148 .cindex "delivery" "forcing deferral"
18149 .cindex "failing delivery" "forcing"
18150 .cindex "deferred delivery, forcing"
18151 .cindex "customizing" "failure message"
18152 An attempt to deliver a particular address can be deferred or forced to fail by
18153 redirection items of the form
18154 .code
18155 :defer:
18156 :fail:
18157 .endd
18158 respectively. When a redirection list contains such an item, it applies
18159 to the entire redirection; any other items in the list are ignored. Any
18160 text following &':fail:'& or &':defer:'& is placed in the error text
18161 associated with the failure. For example, an alias file might contain:
18162 .code
18163 X.Employee:  :fail: Gone away, no forwarding address
18164 .endd
18165 In the case of an address that is being verified from an ACL or as the subject
18166 of a
18167 .cindex "VRFY" "error text, display of"
18168 VRFY command, the text is included in the SMTP error response by
18169 default.
18170 .cindex "EXPN" "error text, display of"
18171 The text is not included in the response to an EXPN command. In non-SMTP cases
18172 the text is included in the error message that Exim generates.
18173
18174 .cindex "SMTP" "error codes"
18175 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18176 &':fail:'&. However, if the message starts with three digits followed by a
18177 space, optionally followed by an extended code of the form &'n.n.n'&, also
18178 followed by a space, and the very first digit is the same as the default error
18179 code, the code from the message is used instead. If the very first digit is
18180 incorrect, a panic error is logged, and the default code is used. You can
18181 suppress the use of the supplied code in a redirect router by setting the
18182 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18183 ignored.
18184
18185 .vindex "&$acl_verify_message$&"
18186 In an ACL, an explicitly provided message overrides the default, but the
18187 default message is available in the variable &$acl_verify_message$& and can
18188 therefore be included in a custom message if this is desired.
18189
18190 Normally the error text is the rest of the redirection list &-- a comma does
18191 not terminate it &-- but a newline does act as a terminator. Newlines are not
18192 normally present in alias expansions. In &(lsearch)& lookups they are removed
18193 as part of the continuation process, but they may exist in other kinds of
18194 lookup and in &':include:'& files.
18195
18196 During routing for message delivery (as opposed to verification), a redirection
18197 containing &':fail:'& causes an immediate failure of the incoming address,
18198 whereas &':defer:'& causes the message to remain on the queue so that a
18199 subsequent delivery attempt can happen at a later time. If an address is
18200 deferred for too long, it will ultimately fail, because the normal retry
18201 rules still apply.
18202
18203 .next
18204 .cindex "alias file" "exception to default"
18205 Sometimes it is useful to use a single-key search type with a default (see
18206 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18207 for exceptions to the default. These can be handled by aliasing them to
18208 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18209 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18210 results in an empty redirection list has the same effect.
18211 .endlist
18212
18213
18214 .section "Duplicate addresses" "SECTdupaddr"
18215 .cindex "duplicate addresses"
18216 .cindex "address duplicate, discarding"
18217 .cindex "pipe" "duplicated"
18218 Exim removes duplicate addresses from the list to which it is delivering, so as
18219 to deliver just one copy to each address. This does not apply to deliveries
18220 routed to pipes by different immediate parent addresses, but an indirect
18221 aliasing scheme of the type
18222 .code
18223 pipe:       |/some/command $local_part
18224 localpart1: pipe
18225 localpart2: pipe
18226 .endd
18227 does not work with a message that is addressed to both local parts, because
18228 when the second is aliased to the intermediate local part &"pipe"& it gets
18229 discarded as being the same as a previously handled address. However, a scheme
18230 such as
18231 .code
18232 localpart1: |/some/command $local_part
18233 localpart2: |/some/command $local_part
18234 .endd
18235 does result in two different pipe deliveries, because the immediate parents of
18236 the pipes are distinct.
18237
18238
18239
18240 .section "Repeated redirection expansion" "SECID128"
18241 .cindex "repeated redirection expansion"
18242 .cindex "address redirection" "repeated for each delivery attempt"
18243 When a message cannot be delivered to all of its recipients immediately,
18244 leading to two or more delivery attempts, redirection expansion is carried out
18245 afresh each time for those addresses whose children were not all previously
18246 delivered. If redirection is being used as a mailing list, this can lead to new
18247 members of the list receiving copies of old messages. The &%one_time%& option
18248 can be used to avoid this.
18249
18250
18251 .section "Errors in redirection lists" "SECID129"
18252 .cindex "address redirection" "errors"
18253 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18254 error is skipped, and an entry is written to the main log. This may be useful
18255 for mailing lists that are automatically managed. Otherwise, if an error is
18256 detected while generating the list of new addresses, the original address is
18257 deferred. See also &%syntax_errors_to%&.
18258
18259
18260
18261 .section "Private options for the redirect router" "SECID130"
18262
18263 .cindex "options" "&(redirect)& router"
18264 The private options for the &(redirect)& router are as follows:
18265
18266
18267 .option allow_defer redirect boolean false
18268 Setting this option allows the use of &':defer:'& in non-filter redirection
18269 data, or the &%defer%& command in an Exim filter file.
18270
18271
18272 .option allow_fail redirect boolean false
18273 .cindex "failing delivery" "from filter"
18274 If this option is true, the &':fail:'& item can be used in a redirection list,
18275 and the &%fail%& command may be used in an Exim filter file.
18276
18277
18278 .option allow_filter redirect boolean false
18279 .cindex "filter" "enabling use of"
18280 .cindex "Sieve filter" "enabling use of"
18281 Setting this option allows Exim to interpret redirection data that starts with
18282 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
18283 are some features of Exim filter files that some administrators may wish to
18284 lock out; see the &%forbid_filter_%&&'xxx'& options below.
18285
18286 It is also possible to lock out Exim filters or Sieve filters while allowing
18287 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
18288
18289
18290 The filter is run using the uid and gid set by the generic &%user%& and
18291 &%group%& options. These take their defaults from the password data if
18292 &%check_local_user%& is set, so in the normal case of users' personal filter
18293 files, the filter is run as the relevant user. When &%allow_filter%& is set
18294 true, Exim insists that either &%check_local_user%& or &%user%& is set.
18295
18296
18297
18298 .option allow_freeze redirect boolean false
18299 .cindex "freezing messages" "allowing in filter"
18300 Setting this option allows the use of the &%freeze%& command in an Exim filter.
18301 This command is more normally encountered in system filters, and is disabled by
18302 default for redirection filters because it isn't something you usually want to
18303 let ordinary users do.
18304
18305
18306
18307 .option check_ancestor redirect boolean false
18308 This option is concerned with handling generated addresses that are the same
18309 as some address in the list of redirection ancestors of the current address.
18310 Although it is turned off by default in the code, it is set in the default
18311 configuration file for handling users' &_.forward_& files. It is recommended
18312 for this use of the &(redirect)& router.
18313
18314 When &%check_ancestor%& is set, if a generated address (including the domain)
18315 is the same as any ancestor of the current address, it is replaced by a copy of
18316 the current address. This helps in the case where local part A is aliased to B,
18317 and B has a &_.forward_& file pointing back to A. For example, within a single
18318 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
18319 &_&~jb/.forward_& contains:
18320 .code
18321 \Joe.Bloggs, <other item(s)>
18322 .endd
18323 Without the &%check_ancestor%& setting, either local part (&"jb"& or
18324 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
18325 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
18326 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
18327 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
18328 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
18329 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
18330 original address. See also the &%repeat_use%& option below.
18331
18332
18333 .option check_group redirect boolean "see below"
18334 When the &%file%& option is used, the group owner of the file is checked only
18335 when this option is set. The permitted groups are those listed in the
18336 &%owngroups%& option, together with the user's default group if
18337 &%check_local_user%& is set. If the file has the wrong group, routing is
18338 deferred. The default setting for this option is true if &%check_local_user%&
18339 is set and the &%modemask%& option permits the group write bit, or if the
18340 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
18341
18342
18343
18344 .option check_owner redirect boolean "see below"
18345 When the &%file%& option is used, the owner of the file is checked only when
18346 this option is set. If &%check_local_user%& is set, the local user is
18347 permitted; otherwise the owner must be one of those listed in the &%owners%&
18348 option. The default value for this option is true if &%check_local_user%& or
18349 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
18350
18351
18352 .option data redirect string&!! unset
18353 This option is mutually exclusive with &%file%&. One or other of them must be
18354 set, but not both. The contents of &%data%& are expanded, and then used as the
18355 list of forwarding items, or as a set of filtering instructions. If the
18356 expansion is forced to fail, or the result is an empty string or a string that
18357 has no effect (consists entirely of comments), the router declines.
18358
18359 When filtering instructions are used, the string must begin with &"#Exim
18360 filter"&, and all comments in the string, including this initial one, must be
18361 terminated with newline characters. For example:
18362 .code
18363 data = #Exim filter\n\
18364        if $h_to: contains Exim then save $home/mail/exim endif
18365 .endd
18366 If you are reading the data from a database where newlines cannot be included,
18367 you can use the &${sg}$& expansion item to turn the escape string of your
18368 choice into a newline.
18369
18370
18371 .option directory_transport redirect string&!! unset
18372 A &(redirect)& router sets up a direct delivery to a directory when a path name
18373 ending with a slash is specified as a new &"address"&. The transport used is
18374 specified by this option, which, after expansion, must be the name of a
18375 configured transport. This should normally be an &(appendfile)& transport.
18376
18377
18378 .option file redirect string&!! unset
18379 This option specifies the name of a file that contains the redirection data. It
18380 is mutually exclusive with the &%data%& option. The string is expanded before
18381 use; if the expansion is forced to fail, the router declines. Other expansion
18382 failures cause delivery to be deferred. The result of a successful expansion
18383 must be an absolute path. The entire file is read and used as the redirection
18384 data. If the data is an empty string or a string that has no effect (consists
18385 entirely of comments), the router declines.
18386
18387 .cindex "NFS" "checking for file existence"
18388 If the attempt to open the file fails with a &"does not exist"& error, Exim
18389 runs a check on the containing directory,
18390 unless &%ignore_enotdir%& is true (see below).
18391 If the directory does not appear to exist, delivery is deferred. This can
18392 happen when users' &_.forward_& files are in NFS-mounted directories, and there
18393 is a mount problem. If the containing directory does exist, but the file does
18394 not, the router declines.
18395
18396
18397 .option file_transport redirect string&!! unset
18398 .vindex "&$address_file$&"
18399 A &(redirect)& router sets up a direct delivery to a file when a path name not
18400 ending in a slash is specified as a new &"address"&. The transport used is
18401 specified by this option, which, after expansion, must be the name of a
18402 configured transport. This should normally be an &(appendfile)& transport. When
18403 it is running, the file name is in &$address_file$&.
18404
18405
18406 .option filter_prepend_home redirect boolean true
18407 When this option is true, if a &(save)& command in an Exim filter specifies a
18408 relative path, and &$home$& is defined, it is automatically prepended to the
18409 relative path. If this option is set false, this action does not happen. The
18410 relative path is then passed to the transport unmodified.
18411
18412
18413 .option forbid_blackhole redirect boolean false
18414 If this option is true, the &':blackhole:'& item may not appear in a
18415 redirection list.
18416
18417
18418 .option forbid_exim_filter redirect boolean false
18419 If this option is set true, only Sieve filters are permitted when
18420 &%allow_filter%& is true.
18421
18422
18423
18424
18425 .option forbid_file redirect boolean false
18426 .cindex "delivery" "to file; forbidding"
18427 .cindex "Sieve filter" "forbidding delivery to a file"
18428 .cindex "Sieve filter" "&""keep""& facility; disabling"
18429 If this option is true, this router may not generate a new address that
18430 specifies delivery to a local file or directory, either from a filter or from a
18431 conventional forward file. This option is forced to be true if &%one_time%& is
18432 set. It applies to Sieve filters as well as to Exim filters, but if true, it
18433 locks out the Sieve's &"keep"& facility.
18434
18435
18436 .option forbid_filter_dlfunc redirect boolean false
18437 .cindex "filter" "locking out certain features"
18438 If this option is true, string expansions in Exim filters are not allowed to
18439 make use of the &%dlfunc%& expansion facility to run dynamically loaded
18440 functions.
18441
18442 .option forbid_filter_existstest redirect boolean false
18443 .cindex "expansion" "statting a file"
18444 If this option is true, string expansions in Exim filters are not allowed to
18445 make use of the &%exists%& condition or the &%stat%& expansion item.
18446
18447 .option forbid_filter_logwrite redirect boolean false
18448 If this option is true, use of the logging facility in Exim filters is not
18449 permitted. Logging is in any case available only if the filter is being run
18450 under some unprivileged uid (which is normally the case for ordinary users'
18451 &_.forward_& files).
18452
18453
18454 .option forbid_filter_lookup redirect boolean false
18455 If this option is true, string expansions in Exim filter files are not allowed
18456 to make use of &%lookup%& items.
18457
18458
18459 .option forbid_filter_perl redirect boolean false
18460 This option has an effect only if Exim is built with embedded Perl support. If
18461 it is true, string expansions in Exim filter files are not allowed to make use
18462 of the embedded Perl support.
18463
18464
18465 .option forbid_filter_readfile redirect boolean false
18466 If this option is true, string expansions in Exim filter files are not allowed
18467 to make use of &%readfile%& items.
18468
18469
18470 .option forbid_filter_readsocket redirect boolean false
18471 If this option is true, string expansions in Exim filter files are not allowed
18472 to make use of &%readsocket%& items.
18473
18474
18475 .option forbid_filter_reply redirect boolean false
18476 If this option is true, this router may not generate an automatic reply
18477 message. Automatic replies can be generated only from Exim or Sieve filter
18478 files, not from traditional forward files. This option is forced to be true if
18479 &%one_time%& is set.
18480
18481
18482 .option forbid_filter_run redirect boolean false
18483 If this option is true, string expansions in Exim filter files are not allowed
18484 to make use of &%run%& items.
18485
18486
18487 .option forbid_include redirect boolean false
18488 If this option is true, items of the form
18489 .code
18490 :include:<path name>
18491 .endd
18492 are not permitted in non-filter redirection lists.
18493
18494
18495 .option forbid_pipe redirect boolean false
18496 .cindex "delivery" "to pipe; forbidding"
18497 If this option is true, this router may not generate a new address which
18498 specifies delivery to a pipe, either from an Exim filter or from a conventional
18499 forward file. This option is forced to be true if &%one_time%& is set.
18500
18501
18502 .option forbid_sieve_filter redirect boolean false
18503 If this option is set true, only Exim filters are permitted when
18504 &%allow_filter%& is true.
18505
18506
18507 .cindex "SMTP" "error codes"
18508 .option forbid_smtp_code redirect boolean false
18509 If this option is set true, any SMTP error codes that are present at the start
18510 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
18511 the default codes (451 and 550, respectively) are always used.
18512
18513
18514
18515
18516 .option hide_child_in_errmsg redirect boolean false
18517 .cindex "bounce message" "redirection details; suppressing"
18518 If this option is true, it prevents Exim from quoting a child address if it
18519 generates a bounce or delay message for it. Instead it says &"an address
18520 generated from <&'the top level address'&>"&. Of course, this applies only to
18521 bounces generated locally. If a message is forwarded to another host, &'its'&
18522 bounce may well quote the generated address.
18523
18524
18525 .option ignore_eacces redirect boolean false
18526 .cindex "EACCES"
18527 If this option is set and an attempt to open a redirection file yields the
18528 EACCES error (permission denied), the &(redirect)& router behaves as if the
18529 file did not exist.
18530
18531
18532 .option ignore_enotdir redirect boolean false
18533 .cindex "ENOTDIR"
18534 If this option is set and an attempt to open a redirection file yields the
18535 ENOTDIR error (something on the path is not a directory), the &(redirect)&
18536 router behaves as if the file did not exist.
18537
18538 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
18539 router that has the &%file%& option set discovers that the file does not exist
18540 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
18541 against unmounted NFS directories. If the parent can not be statted, delivery
18542 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
18543 is set, because that option tells Exim to ignore &"something on the path is not
18544 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
18545 that some operating systems give ENOENT where others give ENOTDIR.
18546
18547
18548
18549 .option include_directory redirect string unset
18550 If this option is set, the path names of any &':include:'& items in a
18551 redirection list must start with this directory.
18552
18553
18554 .option modemask redirect "octal integer" 022
18555 This specifies mode bits which must not be set for a file specified by the
18556 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
18557
18558
18559 .option one_time redirect boolean false
18560 .cindex "one-time aliasing/forwarding expansion"
18561 .cindex "alias file" "one-time expansion"
18562 .cindex "forward file" "one-time expansion"
18563 .cindex "mailing lists" "one-time expansion"
18564 .cindex "address redirection" "one-time expansion"
18565 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
18566 files each time it tries to deliver a message causes a problem when one or more
18567 of the generated addresses fails be delivered at the first attempt. The problem
18568 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
18569 but of what happens when the redirection list changes during the time that the
18570 message is on Exim's queue. This is particularly true in the case of mailing
18571 lists, where new subscribers might receive copies of messages that were posted
18572 before they subscribed.
18573
18574 If &%one_time%& is set and any addresses generated by the router fail to
18575 deliver at the first attempt, the failing addresses are added to the message as
18576 &"top level"& addresses, and the parent address that generated them is marked
18577 &"delivered"&. Thus, redirection does not happen again at the next delivery
18578 attempt.
18579
18580 &*Warning 1*&: Any header line addition or removal that is specified by this
18581 router would be lost if delivery did not succeed at the first attempt. For this
18582 reason, the &%headers_add%& and &%headers_remove%& generic options are not
18583 permitted when &%one_time%& is set.
18584
18585 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
18586 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
18587 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
18588
18589 &*Warning 3*&: The &%unseen%& generic router option may not be set with
18590 &%one_time%&.
18591
18592 The original top-level address is remembered with each of the generated
18593 addresses, and is output in any log messages. However, any intermediate parent
18594 addresses are not recorded. This makes a difference to the log only if
18595 &%all_parents%& log selector is set. It is expected that &%one_time%& will
18596 typically be used for mailing lists, where there is normally just one level of
18597 expansion.
18598
18599
18600 .option owners redirect "string list" unset
18601 .cindex "ownership" "alias file"
18602 .cindex "ownership" "forward file"
18603 .cindex "alias file" "ownership"
18604 .cindex "forward file" "ownership"
18605 This specifies a list of permitted owners for the file specified by &%file%&.
18606 This list is in addition to the local user when &%check_local_user%& is set.
18607 See &%check_owner%& above.
18608
18609
18610 .option owngroups redirect "string list" unset
18611 This specifies a list of permitted groups for the file specified by &%file%&.
18612 The list is in addition to the local user's primary group when
18613 &%check_local_user%& is set. See &%check_group%& above.
18614
18615
18616 .option pipe_transport redirect string&!! unset
18617 .vindex "&$address_pipe$&"
18618 A &(redirect)& router sets up a direct delivery to a pipe when a string
18619 starting with a vertical bar character is specified as a new &"address"&. The
18620 transport used is specified by this option, which, after expansion, must be the
18621 name of a configured transport. This should normally be a &(pipe)& transport.
18622 When the transport is run, the pipe command is in &$address_pipe$&.
18623
18624
18625 .option qualify_domain redirect string&!! unset
18626 .vindex "&$qualify_recipient$&"
18627 If this option is set, and an unqualified address (one without a domain) is
18628 generated, and that address would normally be qualified by the global setting
18629 in &%qualify_recipient%&, it is instead qualified with the domain specified by
18630 expanding this string. If the expansion fails, the router declines. If you want
18631 to revert to the default, you can have the expansion generate
18632 &$qualify_recipient$&.
18633
18634 This option applies to all unqualified addresses generated by Exim filters,
18635 but for traditional &_.forward_& files, it applies only to addresses that are
18636 not preceded by a backslash. Sieve filters cannot generate unqualified
18637 addresses.
18638
18639 .option qualify_preserve_domain redirect boolean false
18640 .cindex "domain" "in redirection; preserving"
18641 .cindex "preserving domain in redirection"
18642 .cindex "address redirection" "domain; preserving"
18643 If this option is set, the router's local &%qualify_domain%& option must not be
18644 set (a configuration error occurs if it is). If an unqualified address (one
18645 without a domain) is generated, it is qualified with the domain of the parent
18646 address (the immediately preceding ancestor) instead of the global
18647 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
18648 this applies whether or not the address is preceded by a backslash.
18649
18650
18651 .option repeat_use redirect boolean true
18652 If this option is set false, the router is skipped for a child address that has
18653 any ancestor that was routed by this router. This test happens before any of
18654 the other preconditions are tested. Exim's default anti-looping rules skip
18655 only when the ancestor is the same as the current address. See also
18656 &%check_ancestor%& above and the generic &%redirect_router%& option.
18657
18658
18659 .option reply_transport redirect string&!! unset
18660 A &(redirect)& router sets up an automatic reply when a &%mail%& or
18661 &%vacation%& command is used in a filter file. The transport used is specified
18662 by this option, which, after expansion, must be the name of a configured
18663 transport. This should normally be an &(autoreply)& transport. Other transports
18664 are unlikely to do anything sensible or useful.
18665
18666
18667 .option rewrite redirect boolean true
18668 .cindex "address redirection" "disabling rewriting"
18669 If this option is set false, addresses generated by the router are not
18670 subject to address rewriting. Otherwise, they are treated like new addresses
18671 and are rewritten according to the global rewriting rules.
18672
18673
18674 .option sieve_subaddress redirect string&!! unset
18675 The value of this option is passed to a Sieve filter to specify the
18676 :subaddress part of an address.
18677
18678 .option sieve_useraddress redirect string&!! unset
18679 The value of this option is passed to a Sieve filter to specify the :user part
18680 of an address. However, if it is unset, the entire original local part
18681 (including any prefix or suffix) is used for :user.
18682
18683
18684 .option sieve_vacation_directory redirect string&!! unset
18685 .cindex "Sieve filter" "vacation directory"
18686 To enable the &"vacation"& extension for Sieve filters, you must set
18687 &%sieve_vacation_directory%& to the directory where vacation databases are held
18688 (do not put anything else in that directory), and ensure that the
18689 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
18690 needs their own directory; Exim will create it if necessary.
18691
18692
18693
18694 .option skip_syntax_errors redirect boolean false
18695 .cindex "forward file" "broken"
18696 .cindex "address redirection" "broken files"
18697 .cindex "alias file" "broken"
18698 .cindex "broken alias or forward files"
18699 .cindex "ignoring faulty addresses"
18700 .cindex "skipping faulty addresses"
18701 .cindex "error" "skipping bad syntax"
18702 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
18703 non-filter redirection data are skipped, and each failing address is logged. If
18704 &%syntax_errors_to%& is set, a message is sent to the address it defines,
18705 giving details of the failures. If &%syntax_errors_text%& is set, its contents
18706 are expanded and placed at the head of the error message generated by
18707 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
18708 be the same address as the generic &%errors_to%& option. The
18709 &%skip_syntax_errors%& option is often used when handling mailing lists.
18710
18711 If all the addresses in a redirection list are skipped because of syntax
18712 errors, the router declines to handle the original address, and it is passed to
18713 the following routers.
18714
18715 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
18716 error in the filter causes filtering to be abandoned without any action being
18717 taken. The incident is logged, and the router declines to handle the address,
18718 so it is passed to the following routers.
18719
18720 .cindex "Sieve filter" "syntax errors in"
18721 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
18722 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
18723 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
18724
18725 &%skip_syntax_errors%& can be used to specify that errors in users' forward
18726 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
18727 option, used with an address that does not get redirected, can be used to
18728 notify users of these errors, by means of a router like this:
18729 .code
18730 userforward:
18731   driver = redirect
18732   allow_filter
18733   check_local_user
18734   file = $home/.forward
18735   file_transport = address_file
18736   pipe_transport = address_pipe
18737   reply_transport = address_reply
18738   no_verify
18739   skip_syntax_errors
18740   syntax_errors_to = real-$local_part@$domain
18741   syntax_errors_text = \
18742    This is an automatically generated message. An error has\n\
18743    been found in your .forward file. Details of the error are\n\
18744    reported below. While this error persists, you will receive\n\
18745    a copy of this message for every message that is addressed\n\
18746    to you. If your .forward file is a filter file, or if it is\n\
18747    a non-filter file containing no valid forwarding addresses,\n\
18748    a copy of each incoming message will be put in your normal\n\
18749    mailbox. If a non-filter file contains at least one valid\n\
18750    forwarding address, forwarding to the valid addresses will\n\
18751    happen, and those will be the only deliveries that occur.
18752 .endd
18753 You also need a router to ensure that local addresses that are prefixed by
18754 &`real-`& are recognized, but not forwarded or filtered. For example, you could
18755 put this immediately before the &(userforward)& router:
18756 .code
18757 real_localuser:
18758   driver = accept
18759   check_local_user
18760   local_part_prefix = real-
18761   transport = local_delivery
18762 .endd
18763 For security, it would probably be a good idea to restrict the use of this
18764 router to locally-generated messages, using a condition such as this:
18765 .code
18766   condition = ${if match {$sender_host_address}\
18767                          {\N^(|127\.0\.0\.1)$\N}}
18768 .endd
18769
18770
18771 .option syntax_errors_text redirect string&!! unset
18772 See &%skip_syntax_errors%& above.
18773
18774
18775 .option syntax_errors_to redirect string unset
18776 See &%skip_syntax_errors%& above.
18777 .ecindex IIDredrou1
18778 .ecindex IIDredrou2
18779
18780
18781
18782
18783
18784
18785 . ////////////////////////////////////////////////////////////////////////////
18786 . ////////////////////////////////////////////////////////////////////////////
18787
18788 .chapter "Environment for running local transports" "CHAPenvironment" &&&
18789          "Environment for local transports"
18790 .scindex IIDenvlotra1 "local transports" "environment for"
18791 .scindex IIDenvlotra2 "environment for local transports"
18792 .scindex IIDenvlotra3 "transport" "local; environment for"
18793 Local transports handle deliveries to files and pipes. (The &(autoreply)&
18794 transport can be thought of as similar to a pipe.) Exim always runs transports
18795 in subprocesses, under specified uids and gids. Typical deliveries to local
18796 mailboxes run under the uid and gid of the local user.
18797
18798 Exim also sets a specific current directory while running the transport; for
18799 some transports a home directory setting is also relevant. The &(pipe)&
18800 transport is the only one that sets up environment variables; see section
18801 &<<SECTpipeenv>>& for details.
18802
18803 The values used for the uid, gid, and the directories may come from several
18804 different places. In many cases, the router that handles the address associates
18805 settings with that address as a result of its &%check_local_user%&, &%group%&,
18806 or &%user%& options. However, values may also be given in the transport's own
18807 configuration, and these override anything that comes from the router.
18808
18809
18810
18811 .section "Concurrent deliveries" "SECID131"
18812 .cindex "concurrent deliveries"
18813 .cindex "simultaneous deliveries"
18814 If two different messages for the same local recipient arrive more or less
18815 simultaneously, the two delivery processes are likely to run concurrently. When
18816 the &(appendfile)& transport is used to write to a file, Exim applies locking
18817 rules to stop concurrent processes from writing to the same file at the same
18818 time.
18819
18820 However, when you use a &(pipe)& transport, it is up to you to arrange any
18821 locking that is needed. Here is a silly example:
18822 .code
18823 my_transport:
18824   driver = pipe
18825   command = /bin/sh -c 'cat >>/some/file'
18826 .endd
18827 This is supposed to write the message at the end of the file. However, if two
18828 messages arrive at the same time, the file will be scrambled. You can use the
18829 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
18830 file using the same algorithm that Exim itself uses.
18831
18832
18833
18834
18835 .section "Uids and gids" "SECTenvuidgid"
18836 .cindex "local transports" "uid and gid"
18837 .cindex "transport" "local; uid and gid"
18838 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
18839 overrides any group that the router set in the address, even if &%user%& is not
18840 set for the transport. This makes it possible, for example, to run local mail
18841 delivery under the uid of the recipient (set by the router), but in a special
18842 group (set by the transport). For example:
18843 .code
18844 # Routers ...
18845 # User/group are set by check_local_user in this router
18846 local_users:
18847   driver = accept
18848   check_local_user
18849   transport = group_delivery
18850
18851 # Transports ...
18852 # This transport overrides the group
18853 group_delivery:
18854   driver = appendfile
18855   file = /var/spool/mail/$local_part
18856   group = mail
18857 .endd
18858 If &%user%& is set for a transport, its value overrides what is set in the
18859 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
18860 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
18861 set.
18862
18863 .oindex "&%initgroups%&"
18864 When the uid is taken from the transport's configuration, the &[initgroups()]&
18865 function is called for the groups associated with that uid if the
18866 &%initgroups%& option is set for the transport. When the uid is not specified
18867 by the transport, but is associated with the address by a router, the option
18868 for calling &[initgroups()]& is taken from the router configuration.
18869
18870 .cindex "&(pipe)& transport" "uid for"
18871 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
18872 is set and &%user%& is not set, the uid of the process that called Exim to
18873 receive the message is used, and if &%group%& is not set, the corresponding
18874 original gid is also used.
18875
18876 This is the detailed preference order for obtaining a gid; the first of the
18877 following that is set is used:
18878
18879 .ilist
18880 A &%group%& setting of the transport;
18881 .next
18882 A &%group%& setting of the router;
18883 .next
18884 A gid associated with a user setting of the router, either as a result of
18885 &%check_local_user%& or an explicit non-numeric &%user%& setting;
18886 .next
18887 The group associated with a non-numeric &%user%& setting of the transport;
18888 .next
18889 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
18890 the uid is the creator's uid;
18891 .next
18892 The Exim gid if the Exim uid is being used as a default.
18893 .endlist
18894
18895 If, for example, the user is specified numerically on the router and there are
18896 no group settings, no gid is available. In this situation, an error occurs.
18897 This is different for the uid, for which there always is an ultimate default.
18898 The first of the following that is set is used:
18899
18900 .ilist
18901 A &%user%& setting of the transport;
18902 .next
18903 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
18904 .next
18905 A &%user%& setting of the router;
18906 .next
18907 A &%check_local_user%& setting of the router;
18908 .next
18909 The Exim uid.
18910 .endlist
18911
18912 Of course, an error will still occur if the uid that is chosen is on the
18913 &%never_users%& list.
18914
18915
18916
18917
18918
18919 .section "Current and home directories" "SECID132"
18920 .cindex "current directory for local transport"
18921 .cindex "home directory" "for local transport"
18922 .cindex "transport" "local; home directory for"
18923 .cindex "transport" "local; current directory for"
18924 Routers may set current and home directories for local transports by means of
18925 the &%transport_current_directory%& and &%transport_home_directory%& options.
18926 However, if the transport's &%current_directory%& or &%home_directory%& options
18927 are set, they override the router's values. In detail, the home directory
18928 for a local transport is taken from the first of these values that is set:
18929
18930 .ilist
18931 The &%home_directory%& option on the transport;
18932 .next
18933 The &%transport_home_directory%& option on the router;
18934 .next
18935 The password data if &%check_local_user%& is set on the router;
18936 .next
18937 The &%router_home_directory%& option on the router.
18938 .endlist
18939
18940 The current directory is taken from the first of these values that is set:
18941
18942 .ilist
18943 The &%current_directory%& option on the transport;
18944 .next
18945 The &%transport_current_directory%& option on the router.
18946 .endlist
18947
18948
18949 If neither the router nor the transport sets a current directory, Exim uses the
18950 value of the home directory, if it is set. Otherwise it sets the current
18951 directory to &_/_& before running a local transport.
18952
18953
18954
18955 .section "Expansion variables derived from the address" "SECID133"
18956 .vindex "&$domain$&"
18957 .vindex "&$local_part$&"
18958 .vindex "&$original_domain$&"
18959 Normally a local delivery is handling a single address, and in that case the
18960 variables such as &$domain$& and &$local_part$& are set during local
18961 deliveries. However, in some circumstances more than one address may be handled
18962 at once (for example, while writing batch SMTP for onward transmission by some
18963 other means). In this case, the variables associated with the local part are
18964 never set, &$domain$& is set only if all the addresses have the same domain,
18965 and &$original_domain$& is never set.
18966 .ecindex IIDenvlotra1
18967 .ecindex IIDenvlotra2
18968 .ecindex IIDenvlotra3
18969
18970
18971
18972
18973
18974
18975
18976 . ////////////////////////////////////////////////////////////////////////////
18977 . ////////////////////////////////////////////////////////////////////////////
18978
18979 .chapter "Generic options for transports" "CHAPtransportgeneric"
18980 .scindex IIDgenoptra1 "generic options" "transport"
18981 .scindex IIDgenoptra2 "options" "generic; for transports"
18982 .scindex IIDgenoptra3 "transport" "generic options for"
18983 The following generic options apply to all transports:
18984
18985
18986 .option body_only transports boolean false
18987 .cindex "transport" "body only"
18988 .cindex "message" "transporting body only"
18989 .cindex "body of message" "transporting"
18990 If this option is set, the message's headers are not transported. It is
18991 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
18992 or &(pipe)& transports, the settings of &%message_prefix%& and
18993 &%message_suffix%& should be checked, because this option does not
18994 automatically suppress them.
18995
18996
18997 .option current_directory transports string&!! unset
18998 .cindex "transport" "current directory for"
18999 This specifies the current directory that is to be set while running the
19000 transport, overriding any value that may have been set by the router.
19001 If the expansion fails for any reason, including forced failure, an error is
19002 logged, and delivery is deferred.
19003
19004
19005 .option disable_logging transports boolean false
19006 If this option is set true, nothing is logged for any
19007 deliveries by the transport or for any
19008 transport errors. You should not set this option unless you really, really know
19009 what you are doing.
19010
19011
19012 .option debug_print transports string&!! unset
19013 .cindex "testing" "variables in drivers"
19014 If this option is set and debugging is enabled (see the &%-d%& command line
19015 option), the string is expanded and included in the debugging output when the
19016 transport is run.
19017 If expansion of the string fails, the error message is written to the debugging
19018 output, and Exim carries on processing.
19019 This facility is provided to help with checking out the values of variables and
19020 so on when debugging driver configurations. For example, if a &%headers_add%&
19021 option is not working properly, &%debug_print%& could be used to output the
19022 variables it references. A newline is added to the text if it does not end with
19023 one.
19024
19025
19026 .option delivery_date_add transports boolean false
19027 .cindex "&'Delivery-date:'& header line"
19028 If this option is true, a &'Delivery-date:'& header is added to the message.
19029 This gives the actual time the delivery was made. As this is not a standard
19030 header, Exim has a configuration option (&%delivery_date_remove%&) which
19031 requests its removal from incoming messages, so that delivered messages can
19032 safely be resent to other recipients.
19033
19034
19035 .option driver transports string unset
19036 This specifies which of the available transport drivers is to be used.
19037 There is no default, and this option must be set for every transport.
19038
19039
19040 .option envelope_to_add transports boolean false
19041 .cindex "&'Envelope-to:'& header line"
19042 If this option is true, an &'Envelope-to:'& header is added to the message.
19043 This gives the original address(es) in the incoming envelope that caused this
19044 delivery to happen. More than one address may be present if the transport is
19045 configured to handle several addresses at once, or if more than one original
19046 address was redirected to the same final address. As this is not a standard
19047 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
19048 its removal from incoming messages, so that delivered messages can safely be
19049 resent to other recipients.
19050
19051
19052 .option group transports string&!! "Exim group"
19053 .cindex "transport" "group; specifying"
19054 This option specifies a gid for running the transport process, overriding any
19055 value that the router supplies, and also overriding any value associated with
19056 &%user%& (see below).
19057
19058
19059 .option headers_add transports string&!! unset
19060 .cindex "header lines" "adding in transport"
19061 .cindex "transport" "header lines; adding"
19062 This option specifies a string of text that is expanded and added to the header
19063 portion of a message as it is transported, as described in section
19064 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
19065 routers. If the result of the expansion is an empty string, or if the expansion
19066 is forced to fail, no action is taken. Other expansion failures are treated as
19067 errors and cause the delivery to be deferred.
19068
19069
19070
19071 .option headers_only transports boolean false
19072 .cindex "transport" "header lines only"
19073 .cindex "message" "transporting headers only"
19074 .cindex "header lines" "transporting"
19075 If this option is set, the message's body is not transported. It is mutually
19076 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
19077 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
19078 checked, since this option does not automatically suppress them.
19079
19080
19081 .option headers_remove transports string&!! unset
19082 .cindex "header lines" "removing"
19083 .cindex "transport" "header lines; removing"
19084 This option specifies a string that is expanded into a list of header names;
19085 these headers are omitted from the message as it is transported, as described
19086 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
19087 routers. If the result of the expansion is an empty string, or if the expansion
19088 is forced to fail, no action is taken. Other expansion failures are treated as
19089 errors and cause the delivery to be deferred.
19090
19091
19092
19093 .option headers_rewrite transports string unset
19094 .cindex "transport" "header lines; rewriting"
19095 .cindex "rewriting" "at transport time"
19096 This option allows addresses in header lines to be rewritten at transport time,
19097 that is, as the message is being copied to its destination. The contents of the
19098 option are a colon-separated list of rewriting rules. Each rule is in exactly
19099 the same form as one of the general rewriting rules that are applied when a
19100 message is received. These are described in chapter &<<CHAPrewrite>>&. For
19101 example,
19102 .code
19103 headers_rewrite = a@b c@d f : \
19104                   x@y w@z
19105 .endd
19106 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
19107 &'w@z'& in all address-bearing header lines. The rules are applied to the
19108 header lines just before they are written out at transport time, so they affect
19109 only those copies of the message that pass through the transport. However, only
19110 the message's original header lines, and any that were added by a system
19111 filter, are rewritten. If a router or transport adds header lines, they are not
19112 affected by this option. These rewriting rules are &'not'& applied to the
19113 envelope. You can change the return path using &%return_path%&, but you cannot
19114 change envelope recipients at this time.
19115
19116
19117 .option home_directory transports string&!! unset
19118 .cindex "transport" "home directory for"
19119 .vindex "&$home$&"
19120 This option specifies a home directory setting for a local transport,
19121 overriding any value that may be set by the router. The home directory is
19122 placed in &$home$& while expanding the transport's private options. It is also
19123 used as the current directory if no current directory is set by the
19124 &%current_directory%& option on the transport or the
19125 &%transport_current_directory%& option on the router. If the expansion fails
19126 for any reason, including forced failure, an error is logged, and delivery is
19127 deferred.
19128
19129
19130 .option initgroups transports boolean false
19131 .cindex "additional groups"
19132 .cindex "groups" "additional"
19133 .cindex "transport" "group; additional"
19134 If this option is true and the uid for the delivery process is provided by the
19135 transport, the &[initgroups()]& function is called when running the transport
19136 to ensure that any additional groups associated with the uid are set up.
19137
19138
19139 .option message_size_limit transports string&!! 0
19140 .cindex "limit" "message size per transport"
19141 .cindex "size" "of message, limit"
19142 .cindex "transport" "message size; limiting"
19143 This option controls the size of messages passed through the transport. It is
19144 expanded before use; the result of the expansion must be a sequence of decimal
19145 digits, optionally followed by K or M. If the expansion fails for any reason,
19146 including forced failure, or if the result is not of the required form,
19147 delivery is deferred. If the value is greater than zero and the size of a
19148 message exceeds this limit, the address is failed. If there is any chance that
19149 the resulting bounce message could be routed to the same transport, you should
19150 ensure that &%return_size_limit%& is less than the transport's
19151 &%message_size_limit%&, as otherwise the bounce message will fail to get
19152 delivered.
19153
19154
19155
19156 .option rcpt_include_affixes transports boolean false
19157 .cindex "prefix" "for local part, including in envelope"
19158 .cindex "suffix for local part" "including in envelope"
19159 .cindex "local part" "prefix"
19160 .cindex "local part" "suffix"
19161 When this option is false (the default), and an address that has had any
19162 affixes (prefixes or suffixes) removed from the local part is delivered by any
19163 form of SMTP or LMTP, the affixes are not included. For example, if a router
19164 that contains
19165 .code
19166 local_part_prefix = *-
19167 .endd
19168 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19169 is delivered with
19170 .code
19171 RCPT TO:<xyz@some.domain>
19172 .endd
19173 This is also the case when an ACL-time callout is being used to verify a
19174 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19175 whole local part is included in the RCPT command. This option applies to BSMTP
19176 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19177 &(lmtp)& and &(smtp)& transports.
19178
19179
19180 .option retry_use_local_part transports boolean "see below"
19181 .cindex "hints database" "retry keys"
19182 When a delivery suffers a temporary failure, a retry record is created
19183 in Exim's hints database. For remote deliveries, the key for the retry record
19184 is based on the name and/or IP address of the failing remote host. For local
19185 deliveries, the key is normally the entire address, including both the local
19186 part and the domain. This is suitable for most common cases of local delivery
19187 temporary failure &-- for example, exceeding a mailbox quota should delay only
19188 deliveries to that mailbox, not to the whole domain.
19189
19190 However, in some special cases you may want to treat a temporary local delivery
19191 as a failure associated with the domain, and not with a particular local part.
19192 (For example, if you are storing all mail for some domain in files.) You can do
19193 this by setting &%retry_use_local_part%& false.
19194
19195 For all the local transports, its default value is true. For remote transports,
19196 the default value is false for tidiness, but changing the value has no effect
19197 on a remote transport in the current implementation.
19198
19199
19200 .option return_path transports string&!! unset
19201 .cindex "envelope sender"
19202 .cindex "transport" "return path; changing"
19203 .cindex "return path" "changing in transport"
19204 If this option is set, the string is expanded at transport time and replaces
19205 the existing return path (envelope sender) value in the copy of the message
19206 that is being delivered. An empty return path is permitted. This feature is
19207 designed for remote deliveries, where the value of this option is used in the
19208 SMTP MAIL command. If you set &%return_path%& for a local transport, the
19209 only effect is to change the address that is placed in the &'Return-path:'&
19210 header line, if one is added to the message (see the next option).
19211
19212 &*Note:*& A changed return path is not logged unless you add
19213 &%return_path_on_delivery%& to the log selector.
19214
19215 .vindex "&$return_path$&"
19216 The expansion can refer to the existing value via &$return_path$&. This is
19217 either the message's envelope sender, or an address set by the
19218 &%errors_to%& option on a router. If the expansion is forced to fail, no
19219 replacement occurs; if it fails for another reason, delivery is deferred. This
19220 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19221 section &<<SECTverp>>&.
19222
19223 &*Note*&: If a delivery error is detected locally, including the case when a
19224 remote server rejects a message at SMTP time, the bounce message is not sent to
19225 the value of this option. It is sent to the previously set errors address.
19226 This defaults to the incoming sender address, but can be changed by setting
19227 &%errors_to%& in a router.
19228
19229
19230
19231 .option return_path_add transports boolean false
19232 .cindex "&'Return-path:'& header line"
19233 If this option is true, a &'Return-path:'& header is added to the message.
19234 Although the return path is normally available in the prefix line of BSD
19235 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19236 have easy access to it.
19237
19238 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19239 the delivery SMTP server makes the final delivery"&. This implies that this
19240 header should not be present in incoming messages. Exim has a configuration
19241 option, &%return_path_remove%&, which requests removal of this header from
19242 incoming messages, so that delivered messages can safely be resent to other
19243 recipients.
19244
19245
19246 .option shadow_condition transports string&!! unset
19247 See &%shadow_transport%& below.
19248
19249
19250 .option shadow_transport transports string unset
19251 .cindex "shadow transport"
19252 .cindex "transport" "shadow"
19253 A local transport may set the &%shadow_transport%& option to the name of
19254 another local transport. Shadow remote transports are not supported.
19255
19256 Whenever a delivery to the main transport succeeds, and either
19257 &%shadow_condition%& is unset, or its expansion does not result in the empty
19258 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
19259 passed to the shadow transport, with the same delivery address or addresses. If
19260 expansion fails, no action is taken except that non-forced expansion failures
19261 cause a log line to be written.
19262
19263 The result of the shadow transport is discarded and does not affect the
19264 subsequent processing of the message. Only a single level of shadowing is
19265 provided; the &%shadow_transport%& option is ignored on any transport when it
19266 is running as a shadow. Options concerned with output from pipes are also
19267 ignored. The log line for the successful delivery has an item added on the end,
19268 of the form
19269 .code
19270 ST=<shadow transport name>
19271 .endd
19272 If the shadow transport did not succeed, the error message is put in
19273 parentheses afterwards. Shadow transports can be used for a number of different
19274 purposes, including keeping more detailed log information than Exim normally
19275 provides, and implementing automatic acknowledgment policies based on message
19276 headers that some sites insist on.
19277
19278
19279 .option transport_filter transports string&!! unset
19280 .cindex "transport" "filter"
19281 .cindex "filter" "transport filter"
19282 This option sets up a filtering (in the Unix shell sense) process for messages
19283 at transport time. It should not be confused with mail filtering as set up by
19284 individual users or via a system filter.
19285
19286 When the message is about to be written out, the command specified by
19287 &%transport_filter%& is started up in a separate, parallel process, and
19288 the entire message, including the header lines, is passed to it on its standard
19289 input (this in fact is done from a third process, to avoid deadlock). The
19290 command must be specified as an absolute path.
19291
19292 The lines of the message that are written to the transport filter are
19293 terminated by newline (&"\n"&). The message is passed to the filter before any
19294 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
19295 lines beginning with a dot, and also before any processing implied by the
19296 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
19297 &(pipe)& transports.
19298
19299 The standard error for the filter process is set to the same destination as its
19300 standard output; this is read and written to the message's ultimate
19301 destination. The process that writes the message to the filter, the
19302 filter itself, and the original process that reads the result and delivers it
19303 are all run in parallel, like a shell pipeline.
19304
19305 The filter can perform any transformations it likes, but of course should take
19306 care not to break RFC 2822 syntax. Exim does not check the result, except to
19307 test for a final newline when SMTP is in use. All messages transmitted over
19308 SMTP must end with a newline, so Exim supplies one if it is missing.
19309
19310 .cindex "content scanning" "per user"
19311 A transport filter can be used to provide content-scanning on a per-user basis
19312 at delivery time if the only required effect of the scan is to modify the
19313 message. For example, a content scan could insert a new header line containing
19314 a spam score. This could be interpreted by a filter in the user's MUA. It is
19315 not possible to discard a message at this stage.
19316
19317 .cindex "SMTP" "SIZE"
19318 A problem might arise if the filter increases the size of a message that is
19319 being sent down an SMTP connection. If the receiving SMTP server has indicated
19320 support for the SIZE parameter, Exim will have sent the size of the message
19321 at the start of the SMTP session. If what is actually sent is substantially
19322 more, the server might reject the message. This can be worked round by setting
19323 the &%size_addition%& option on the &(smtp)& transport, either to allow for
19324 additions to the message, or to disable the use of SIZE altogether.
19325
19326 .vindex "&$pipe_addresses$&"
19327 The value of the &%transport_filter%& option is the command string for starting
19328 the filter, which is run directly from Exim, not under a shell. The string is
19329 parsed by Exim in the same way as a command string for the &(pipe)& transport:
19330 Exim breaks it up into arguments and then expands each argument separately (see
19331 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
19332 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
19333 of arguments, one for each address that applies to this delivery. (This isn't
19334 an ideal name for this feature here, but as it was already implemented for the
19335 &(pipe)& transport, it seemed sensible not to change it.)
19336
19337 .vindex "&$host$&"
19338 .vindex "&$host_address$&"
19339 The expansion variables &$host$& and &$host_address$& are available when the
19340 transport is a remote one. They contain the name and IP address of the host to
19341 which the message is being sent. For example:
19342 .code
19343 transport_filter = /some/directory/transport-filter.pl \
19344   $host $host_address $sender_address $pipe_addresses
19345 .endd
19346
19347 Two problems arise if you want to use more complicated expansion items to
19348 generate transport filter commands, both of which due to the fact that the
19349 command is split up &'before'& expansion.
19350 .ilist
19351 If an expansion item contains white space, you must quote it, so that it is all
19352 part of the same command item. If the entire option setting is one such
19353 expansion item, you have to take care what kind of quoting you use. For
19354 example:
19355 .code
19356 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
19357 .endd
19358 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
19359 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
19360 stripped by Exim when it read the option's value. When the value is used, if
19361 the single quotes were missing, the line would be split into two items,
19362 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
19363 Exim tried to expand the first one.
19364 .next
19365 Except for the special case of &$pipe_addresses$& that is mentioned above, an
19366 expansion cannot generate multiple arguments, or a command name followed by
19367 arguments. Consider this example:
19368 .code
19369 transport_filter = ${lookup{$host}lsearch{/a/file}\
19370                     {$value}{/bin/cat}}
19371 .endd
19372 The result of the lookup is interpreted as the name of the command, even
19373 if it contains white space. The simplest way round this is to use a shell:
19374 .code
19375 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
19376                                {$value}{/bin/cat}}
19377 .endd
19378 .endlist
19379
19380 The filter process is run under the same uid and gid as the normal delivery.
19381 For remote deliveries this is the Exim uid/gid by default. The command should
19382 normally yield a zero return code. Transport filters are not supposed to fail.
19383 A non-zero code is taken to mean that the transport filter encountered some
19384 serious problem. Delivery of the message is deferred; the message remains on
19385 the queue and is tried again later. It is not possible to cause a message to be
19386 bounced from a transport filter.
19387
19388 If a transport filter is set on an autoreply transport, the original message is
19389 passed through the filter as it is being copied into the newly generated
19390 message, which happens if the &%return_message%& option is set.
19391
19392
19393 .option transport_filter_timeout transports time 5m
19394 .cindex "transport" "filter, timeout"
19395 When Exim is reading the output of a transport filter, it a applies a timeout
19396 that can be set by this option. Exceeding the timeout is normally treated as a
19397 temporary delivery failure. However, if a transport filter is used with a
19398 &(pipe)& transport, a timeout in the transport filter is treated in the same
19399 way as a timeout in the pipe command itself. By default, a timeout is a hard
19400 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
19401 becomes a temporary error.
19402
19403
19404 .option user transports string&!! "Exim user"
19405 .cindex "uid (user id)" "local delivery"
19406 .cindex "transport" "user, specifying"
19407 This option specifies the user under whose uid the delivery process is to be
19408 run, overriding any uid that may have been set by the router. If the user is
19409 given as a name, the uid is looked up from the password data, and the
19410 associated group is taken as the value of the gid to be used if the &%group%&
19411 option is not set.
19412
19413 For deliveries that use local transports, a user and group are normally
19414 specified explicitly or implicitly (for example, as a result of
19415 &%check_local_user%&) by the router or transport.
19416
19417 .cindex "hints database" "access by remote transport"
19418 For remote transports, you should leave this option unset unless you really are
19419 sure you know what you are doing. When a remote transport is running, it needs
19420 to be able to access Exim's hints databases, because each host may have its own
19421 retry data.
19422 .ecindex IIDgenoptra1
19423 .ecindex IIDgenoptra2
19424 .ecindex IIDgenoptra3
19425
19426
19427
19428
19429
19430
19431 . ////////////////////////////////////////////////////////////////////////////
19432 . ////////////////////////////////////////////////////////////////////////////
19433
19434 .chapter "Address batching in local transports" "CHAPbatching" &&&
19435          "Address batching"
19436 .cindex "transport" "local; address batching in"
19437 The only remote transport (&(smtp)&) is normally configured to handle more than
19438 one address at a time, so that when several addresses are routed to the same
19439 remote host, just one copy of the message is sent. Local transports, however,
19440 normally handle one address at a time. That is, a separate instance of the
19441 transport is run for each address that is routed to the transport. A separate
19442 copy of the message is delivered each time.
19443
19444 .cindex "batched local delivery"
19445 .oindex "&%batch_max%&"
19446 .oindex "&%batch_id%&"
19447 In special cases, it may be desirable to handle several addresses at once in a
19448 local transport, for example:
19449
19450 .ilist
19451 In an &(appendfile)& transport, when storing messages in files for later
19452 delivery by some other means, a single copy of the message with multiple
19453 recipients saves space.
19454 .next
19455 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
19456 a single copy saves time, and is the normal way LMTP is expected to work.
19457 .next
19458 In a &(pipe)& transport, when passing the message
19459 to a scanner program or
19460 to some other delivery mechanism such as UUCP, multiple recipients may be
19461 acceptable.
19462 .endlist
19463
19464 These three local transports all have the same options for controlling multiple
19465 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
19466 repeating the information for each transport, these options are described here.
19467
19468 The &%batch_max%& option specifies the maximum number of addresses that can be
19469 delivered together in a single run of the transport. Its default value is one
19470 (no batching). When more than one address is routed to a transport that has a
19471 &%batch_max%& value greater than one, the addresses are delivered in a batch
19472 (that is, in a single run of the transport with multiple recipients), subject
19473 to certain conditions:
19474
19475 .ilist
19476 .vindex "&$local_part$&"
19477 If any of the transport's options contain a reference to &$local_part$&, no
19478 batching is possible.
19479 .next
19480 .vindex "&$domain$&"
19481 If any of the transport's options contain a reference to &$domain$&, only
19482 addresses with the same domain are batched.
19483 .next
19484 .cindex "customizing" "batching condition"
19485 If &%batch_id%& is set, it is expanded for each address, and only those
19486 addresses with the same expanded value are batched. This allows you to specify
19487 customized batching conditions. Failure of the expansion for any reason,
19488 including forced failure, disables batching, but it does not stop the delivery
19489 from taking place.
19490 .next
19491 Batched addresses must also have the same errors address (where to send
19492 delivery errors), the same header additions and removals, the same user and
19493 group for the transport, and if a host list is present, the first host must
19494 be the same.
19495 .endlist
19496
19497 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
19498 both when the file or pipe command is specified in the transport, and when it
19499 is specified by a &(redirect)& router, but all the batched addresses must of
19500 course be routed to the same file or pipe command. These two transports have an
19501 option called &%use_bsmtp%&, which causes them to deliver the message in
19502 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
19503 &%check_string%& and &%escape_string%& options are forced to the values
19504 .code
19505 check_string = "."
19506 escape_string = ".."
19507 .endd
19508 when batched SMTP is in use. A full description of the batch SMTP mechanism is
19509 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
19510 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
19511
19512 .cindex "&'Envelope-to:'& header line"
19513 If the generic &%envelope_to_add%& option is set for a batching transport, the
19514 &'Envelope-to:'& header that is added to the message contains all the addresses
19515 that are being processed together. If you are using a batching &(appendfile)&
19516 transport without &%use_bsmtp%&, the only way to preserve the recipient
19517 addresses is to set the &%envelope_to_add%& option.
19518
19519 .cindex "&(pipe)& transport" "with multiple addresses"
19520 .vindex "&$pipe_addresses$&"
19521 If you are using a &(pipe)& transport without BSMTP, and setting the
19522 transport's &%command%& option, you can include &$pipe_addresses$& as part of
19523 the command. This is not a true variable; it is a bit of magic that causes each
19524 of the recipient addresses to be inserted into the command as a separate
19525 argument. This provides a way of accessing all the addresses that are being
19526 delivered in the batch. &*Note:*& This is not possible for pipe commands that
19527 are specified by a &(redirect)& router.
19528
19529
19530
19531
19532 . ////////////////////////////////////////////////////////////////////////////
19533 . ////////////////////////////////////////////////////////////////////////////
19534
19535 .chapter "The appendfile transport" "CHAPappendfile"
19536 .scindex IIDapptra1 "&(appendfile)& transport"
19537 .scindex IIDapptra2 "transports" "&(appendfile)&"
19538 .cindex "directory creation"
19539 .cindex "creating directories"
19540 The &(appendfile)& transport delivers a message by appending it to an existing
19541 file, or by creating an entirely new file in a specified directory. Single
19542 files to which messages are appended can be in the traditional Unix mailbox
19543 format, or optionally in the MBX format supported by the Pine MUA and
19544 University of Washington IMAP daemon, &'inter alia'&. When each message is
19545 being delivered as a separate file, &"maildir"& format can optionally be used
19546 to give added protection against failures that happen part-way through the
19547 delivery. A third form of separate-file delivery known as &"mailstore"& is also
19548 supported. For all file formats, Exim attempts to create as many levels of
19549 directory as necessary, provided that &%create_directory%& is set.
19550
19551 The code for the optional formats is not included in the Exim binary by
19552 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
19553 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
19554 included.
19555
19556 .cindex "quota" "system"
19557 Exim recognizes system quota errors, and generates an appropriate message. Exim
19558 also supports its own quota control within the transport, for use when the
19559 system facility is unavailable or cannot be used for some reason.
19560
19561 If there is an error while appending to a file (for example, quota exceeded or
19562 partition filled), Exim attempts to reset the file's length and last
19563 modification time back to what they were before. If there is an error while
19564 creating an entirely new file, the new file is removed.
19565
19566 Before appending to a file, a number of security checks are made, and the
19567 file is locked. A detailed description is given below, after the list of
19568 private options.
19569
19570 The &(appendfile)& transport is most commonly used for local deliveries to
19571 users' mailboxes. However, it can also be used as a pseudo-remote transport for
19572 putting messages into files for remote delivery by some means other than Exim.
19573 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
19574 option).
19575
19576
19577
19578 .section "The file and directory options" "SECTfildiropt"
19579 The &%file%& option specifies a single file, to which the message is appended;
19580 the &%directory%& option specifies a directory, in which a new file containing
19581 the message is created. Only one of these two options can be set, and for
19582 normal deliveries to mailboxes, one of them &'must'& be set.
19583
19584 .vindex "&$address_file$&"
19585 .vindex "&$local_part$&"
19586 However, &(appendfile)& is also used for delivering messages to files or
19587 directories whose names (or parts of names) are obtained from alias,
19588 forwarding, or filtering operations (for example, a &%save%& command in a
19589 user's Exim filter). When such a transport is running, &$local_part$& contains
19590 the local part that was aliased or forwarded, and &$address_file$& contains the
19591 name (or partial name) of the file or directory generated by the redirection
19592 operation. There are two cases:
19593
19594 .ilist
19595 If neither &%file%& nor &%directory%& is set, the redirection operation
19596 must specify an absolute path (one that begins with &`/`&). This is the most
19597 common case when users with local accounts use filtering to sort mail into
19598 different folders. See for example, the &(address_file)& transport in the
19599 default configuration. If the path ends with a slash, it is assumed to be the
19600 name of a directory. A delivery to a directory can also be forced by setting
19601 &%maildir_format%& or &%mailstore_format%&.
19602 .next
19603 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
19604 used to determine the file or directory name for the delivery. Normally, the
19605 contents of &$address_file$& are used in some way in the string expansion.
19606 .endlist
19607
19608
19609 .cindex "Sieve filter" "configuring &(appendfile)&"
19610 .cindex "Sieve filter" "relative mailbox path handling"
19611 As an example of the second case, consider an environment where users do not
19612 have home directories. They may be permitted to use Exim filter commands of the
19613 form:
19614 .code
19615 save folder23
19616 .endd
19617 or Sieve filter commands of the form:
19618 .code
19619 require "fileinto";
19620 fileinto "folder23";
19621 .endd
19622 In this situation, the expansion of &%file%& or &%directory%& in the transport
19623 must transform the relative path into an appropriate absolute file name. In the
19624 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
19625 is used as a result of a &"keep"& action in the filter. This example shows one
19626 way of handling this requirement:
19627 .code
19628 file = ${if eq{$address_file}{inbox} \
19629             {/var/mail/$local_part} \
19630             {${if eq{${substr_0_1:$address_file}}{/} \
19631                   {$address_file} \
19632                   {$home/mail/$address_file} \
19633             }} \
19634        }
19635 .endd
19636 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
19637 location, absolute paths are used without change, and other folders are in the
19638 &_mail_& directory within the home directory.
19639
19640 &*Note 1*&: While processing an Exim filter, a relative path such as
19641 &_folder23_& is turned into an absolute path if a home directory is known to
19642 the router. In particular, this is the case if &%check_local_user%& is set. If
19643 you want to prevent this happening at routing time, you can set
19644 &%router_home_directory%& empty. This forces the router to pass the relative
19645 path to the transport.
19646
19647 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
19648 the &%file%& or &%directory%& option is still used if it is set.
19649
19650
19651
19652
19653 .section "Private options for appendfile" "SECID134"
19654 .cindex "options" "&(appendfile)& transport"
19655
19656
19657
19658 .option allow_fifo appendfile boolean false
19659 .cindex "fifo (named pipe)"
19660 .cindex "named pipe (fifo)"
19661 .cindex "pipe" "named (fifo)"
19662 Setting this option permits delivery to named pipes (FIFOs) as well as to
19663 regular files. If no process is reading the named pipe at delivery time, the
19664 delivery is deferred.
19665
19666
19667 .option allow_symlink appendfile boolean false
19668 .cindex "symbolic link" "to mailbox"
19669 .cindex "mailbox" "symbolic link"
19670 By default, &(appendfile)& will not deliver if the path name for the file is
19671 that of a symbolic link. Setting this option relaxes that constraint, but there
19672 are security issues involved in the use of symbolic links. Be sure you know
19673 what you are doing if you set this. Details of exactly what this option affects
19674 are included in the discussion which follows this list of options.
19675
19676
19677 .option batch_id appendfile string&!! unset
19678 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19679 However, batching is automatically disabled for &(appendfile)& deliveries that
19680 happen as a result of forwarding or aliasing or other redirection directly to a
19681 file.
19682
19683
19684 .option batch_max appendfile integer 1
19685 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19686
19687
19688 .option check_group appendfile boolean false
19689 When this option is set, the group owner of the file defined by the &%file%&
19690 option is checked to see that it is the same as the group under which the
19691 delivery process is running. The default setting is false because the default
19692 file mode is 0600, which means that the group is irrelevant.
19693
19694
19695 .option check_owner appendfile boolean true
19696 When this option is set, the owner of the file defined by the &%file%& option
19697 is checked to ensure that it is the same as the user under which the delivery
19698 process is running.
19699
19700
19701 .option check_string appendfile string "see below"
19702 .cindex "&""From""& line"
19703 As &(appendfile)& writes the message, the start of each line is tested for
19704 matching &%check_string%&, and if it does, the initial matching characters are
19705 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
19706 a literal string, not a regular expression, and the case of any letters it
19707 contains is significant.
19708
19709 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
19710 are forced to &"."& and &".."& respectively, and any settings in the
19711 configuration are ignored. Otherwise, they default to &"From&~"& and
19712 &">From&~"& when the &%file%& option is set, and unset when any of the
19713 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
19714
19715 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
19716 suitable for traditional &"BSD"& mailboxes, where a line beginning with
19717 &"From&~"& indicates the start of a new message. All four options need changing
19718 if another format is used. For example, to deliver to mailboxes in MMDF format:
19719 .cindex "MMDF format mailbox"
19720 .cindex "mailbox" "MMDF format"
19721 .code
19722 check_string = "\1\1\1\1\n"
19723 escape_string = "\1\1\1\1 \n"
19724 message_prefix = "\1\1\1\1\n"
19725 message_suffix = "\1\1\1\1\n"
19726 .endd
19727 .option create_directory appendfile boolean true
19728 .cindex "directory creation"
19729 When this option is true, Exim attempts to create any missing superior
19730 directories for the file that it is about to write. A created directory's mode
19731 is given by the &%directory_mode%& option.
19732
19733 The group ownership of a newly created directory is highly dependent on the
19734 operating system (and possibly the file system) that is being used. For
19735 example, in Solaris, if the parent directory has the setgid bit set, its group
19736 is propagated to the child; if not, the currently set group is used. However,
19737 in FreeBSD, the parent's group is always used.
19738
19739
19740
19741 .option create_file appendfile string anywhere
19742 This option constrains the location of files and directories that are created
19743 by this transport. It applies to files defined by the &%file%& option and
19744 directories defined by the &%directory%& option. In the case of maildir
19745 delivery, it applies to the top level directory, not the maildir directories
19746 beneath.
19747
19748 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
19749 &"belowhome"&. In the second and third cases, a home directory must have been
19750 set for the transport. This option is not useful when an explicit file name is
19751 given for normal mailbox deliveries. It is intended for the case when file
19752 names are generated from users' &_.forward_& files. These are usually handled
19753 by an &(appendfile)& transport called &%address_file%&. See also
19754 &%file_must_exist%&.
19755
19756
19757 .option directory appendfile string&!! unset
19758 This option is mutually exclusive with the &%file%& option, but one of &%file%&
19759 or &%directory%& must be set, unless the delivery is the direct result of a
19760 redirection (see section &<<SECTfildiropt>>&).
19761
19762 When &%directory%& is set, the string is expanded, and the message is delivered
19763 into a new file or files in or below the given directory, instead of being
19764 appended to a single mailbox file. A number of different formats are provided
19765 (see &%maildir_format%& and &%mailstore_format%&), and see section
19766 &<<SECTopdir>>& for further details of this form of delivery.
19767
19768
19769 .option directory_file appendfile string&!! "see below"
19770 .cindex "base62"
19771 .vindex "&$inode$&"
19772 When &%directory%& is set, but neither &%maildir_format%& nor
19773 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
19774 whose name is obtained by expanding this string. The default value is:
19775 .code
19776 q${base62:$tod_epoch}-$inode
19777 .endd
19778 This generates a unique name from the current time, in base 62 form, and the
19779 inode of the file. The variable &$inode$& is available only when expanding this
19780 option.
19781
19782
19783 .option directory_mode appendfile "octal integer" 0700
19784 If &(appendfile)& creates any directories as a result of the
19785 &%create_directory%& option, their mode is specified by this option.
19786
19787
19788 .option escape_string appendfile string "see description"
19789 See &%check_string%& above.
19790
19791
19792 .option file appendfile string&!! unset
19793 This option is mutually exclusive with the &%directory%& option, but one of
19794 &%file%& or &%directory%& must be set, unless the delivery is the direct result
19795 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
19796 specifies a single file, to which the message is appended. One or more of
19797 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
19798 &%file%&.
19799
19800 .cindex "NFS" "lock file"
19801 .cindex "locking files"
19802 .cindex "lock files"
19803 If you are using more than one host to deliver over NFS into the same
19804 mailboxes, you should always use lock files.
19805
19806 The string value is expanded for each delivery, and must yield an absolute
19807 path. The most common settings of this option are variations on one of these
19808 examples:
19809 .code
19810 file = /var/spool/mail/$local_part
19811 file = /home/$local_part/inbox
19812 file = $home/inbox
19813 .endd
19814 .cindex "&""sticky""& bit"
19815 In the first example, all deliveries are done into the same directory. If Exim
19816 is configured to use lock files (see &%use_lockfile%& below) it must be able to
19817 create a file in the directory, so the &"sticky"& bit must be turned on for
19818 deliveries to be possible, or alternatively the &%group%& option can be used to
19819 run the delivery under a group id which has write access to the directory.
19820
19821
19822
19823 .option file_format appendfile string unset
19824 .cindex "file" "mailbox; checking existing format"
19825 This option requests the transport to check the format of an existing file
19826 before adding to it. The check consists of matching a specific string at the
19827 start of the file. The value of the option consists of an even number of
19828 colon-separated strings. The first of each pair is the test string, and the
19829 second is the name of a transport. If the transport associated with a matched
19830 string is not the current transport, control is passed over to the other
19831 transport. For example, suppose the standard &(local_delivery)& transport has
19832 this added to it:
19833 .code
19834 file_format = "From       : local_delivery :\
19835                \1\1\1\1\n : local_mmdf_delivery"
19836 .endd
19837 Mailboxes that begin with &"From"& are still handled by this transport, but if
19838 a mailbox begins with four binary ones followed by a newline, control is passed
19839 to a transport called &%local_mmdf_delivery%&, which presumably is configured
19840 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
19841 is assumed to match the current transport. If the start of a mailbox doesn't
19842 match any string, or if the transport named for a given string is not defined,
19843 delivery is deferred.
19844
19845
19846 .option file_must_exist appendfile boolean false
19847 If this option is true, the file specified by the &%file%& option must exist.
19848 A temporary error occurs if it does not, causing delivery to be deferred.
19849 If this option is false, the file is created if it does not exist.
19850
19851
19852 .option lock_fcntl_timeout appendfile time 0s
19853 .cindex "timeout" "mailbox locking"
19854 .cindex "mailbox" "locking, blocking and non-blocking"
19855 .cindex "locking files"
19856 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
19857 when locking an open mailbox file. If the call fails, the delivery process
19858 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
19859 Non-blocking calls are used so that the file is not kept open during the wait
19860 for the lock; the reason for this is to make it as safe as possible for
19861 deliveries over NFS in the case when processes might be accessing an NFS
19862 mailbox without using a lock file. This should not be done, but
19863 misunderstandings and hence misconfigurations are not unknown.
19864
19865 On a busy system, however, the performance of a non-blocking lock approach is
19866 not as good as using a blocking lock with a timeout. In this case, the waiting
19867 is done inside the system call, and Exim's delivery process acquires the lock
19868 and can proceed as soon as the previous lock holder releases it.
19869
19870 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
19871 timeout, are used. There may still be some retrying: the maximum number of
19872 retries is
19873 .code
19874 (lock_retries * lock_interval) / lock_fcntl_timeout
19875 .endd
19876 rounded up to the next whole number. In other words, the total time during
19877 which &(appendfile)& is trying to get a lock is roughly the same, unless
19878 &%lock_fcntl_timeout%& is set very large.
19879
19880 You should consider setting this option if you are getting a lot of delayed
19881 local deliveries because of errors of the form
19882 .code
19883 failed to lock mailbox /some/file (fcntl)
19884 .endd
19885
19886 .option lock_flock_timeout appendfile time 0s
19887 This timeout applies to file locking when using &[flock()]& (see
19888 &%use_flock%&); the timeout operates in a similar manner to
19889 &%lock_fcntl_timeout%&.
19890
19891
19892 .option lock_interval appendfile time 3s
19893 This specifies the time to wait between attempts to lock the file. See below
19894 for details of locking.
19895
19896
19897 .option lock_retries appendfile integer 10
19898 This specifies the maximum number of attempts to lock the file. A value of zero
19899 is treated as 1. See below for details of locking.
19900
19901
19902 .option lockfile_mode appendfile "octal integer" 0600
19903 This specifies the mode of the created lock file, when a lock file is being
19904 used (see &%use_lockfile%& and &%use_mbx_lock%&).
19905
19906
19907 .option lockfile_timeout appendfile time 30m
19908 .cindex "timeout" "mailbox locking"
19909 When a lock file is being used (see &%use_lockfile%&), if a lock file already
19910 exists and is older than this value, it is assumed to have been left behind by
19911 accident, and Exim attempts to remove it.
19912
19913
19914 .option mailbox_filecount appendfile string&!! unset
19915 .cindex "mailbox" "specifying size of"
19916 .cindex "size" "of mailbox"
19917 If this option is set, it is expanded, and the result is taken as the current
19918 number of files in the mailbox. It must be a decimal number, optionally
19919 followed by K or M. This provides a way of obtaining this information from an
19920 external source that maintains the data.
19921
19922
19923 .option mailbox_size appendfile string&!! unset
19924 .cindex "mailbox" "specifying size of"
19925 .cindex "size" "of mailbox"
19926 If this option is set, it is expanded, and the result is taken as the current
19927 size the mailbox. It must be a decimal number, optionally followed by K or M.
19928 This provides a way of obtaining this information from an external source that
19929 maintains the data. This is likely to be helpful for maildir deliveries where
19930 it is computationally expensive to compute the size of a mailbox.
19931
19932
19933
19934 .option maildir_format appendfile boolean false
19935 .cindex "maildir format" "specifying"
19936 If this option is set with the &%directory%& option, the delivery is into a new
19937 file, in the &"maildir"& format that is used by other mail software. When the
19938 transport is activated directly from a &(redirect)& router (for example, the
19939 &(address_file)& transport in the default configuration), setting
19940 &%maildir_format%& causes the path received from the router to be treated as a
19941 directory, whether or not it ends with &`/`&. This option is available only if
19942 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
19943 &<<SECTmaildirdelivery>>& below for further details.
19944
19945
19946 .option maildir_quota_directory_regex appendfile string "See below"
19947 .cindex "maildir format" "quota; directories included in"
19948 .cindex "quota" "maildir; directories included in"
19949 This option is relevant only when &%maildir_use_size_file%& is set. It defines
19950 a regular expression for specifying directories, relative to the quota
19951 directory (see &%quota_directory%&), that should be included in the quota
19952 calculation. The default value is:
19953 .code
19954 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
19955 .endd
19956 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
19957 (directories whose names begin with a dot). If you want to exclude the
19958 &_Trash_&
19959 folder from the count (as some sites do), you need to change this setting to
19960 .code
19961 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
19962 .endd
19963 This uses a negative lookahead in the regular expression to exclude the
19964 directory whose name is &_.Trash_&. When a directory is excluded from quota
19965 calculations, quota processing is bypassed for any messages that are delivered
19966 directly into that directory.
19967
19968
19969 .option maildir_retries appendfile integer 10
19970 This option specifies the number of times to retry when writing a file in
19971 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
19972
19973
19974 .option maildir_tag appendfile string&!! unset
19975 This option applies only to deliveries in maildir format, and is described in
19976 section &<<SECTmaildirdelivery>>& below.
19977
19978
19979 .option maildir_use_size_file appendfile boolean false
19980 .cindex "maildir format" "&_maildirsize_& file"
19981 Setting this option true enables support for &_maildirsize_& files. Exim
19982 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
19983 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
19984 value is zero. See &%maildir_quota_directory_regex%& above and section
19985 &<<SECTmaildirdelivery>>& below for further details.
19986
19987 .option maildirfolder_create_regex appendfile string unset
19988 .cindex "maildir format" "&_maildirfolder_& file"
19989 .cindex "&_maildirfolder_&, creating"
19990 The value of this option is a regular expression. If it is unset, it has no
19991 effect. Otherwise, before a maildir delivery takes place, the pattern is
19992 matched against the name of the maildir directory, that is, the directory
19993 containing the &_new_& and &_tmp_& subdirectories that will be used for the
19994 delivery. If there is a match, Exim checks for the existence of a file called
19995 &_maildirfolder_& in the directory, and creates it if it does not exist.
19996 See section &<<SECTmaildirdelivery>>& for more details.
19997
19998
19999 .option mailstore_format appendfile boolean false
20000 .cindex "mailstore format" "specifying"
20001 If this option is set with the &%directory%& option, the delivery is into two
20002 new files in  &"mailstore"& format. The option is available only if
20003 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
20004 below for further details.
20005
20006
20007 .option mailstore_prefix appendfile string&!! unset
20008 This option applies only to deliveries in mailstore format, and is described in
20009 section &<<SECTopdir>>& below.
20010
20011
20012 .option mailstore_suffix appendfile string&!! unset
20013 This option applies only to deliveries in mailstore format, and is described in
20014 section &<<SECTopdir>>& below.
20015
20016
20017 .option mbx_format appendfile boolean false
20018 .cindex "locking files"
20019 .cindex "file" "locking"
20020 .cindex "file" "MBX format"
20021 .cindex "MBX format, specifying"
20022 This option is available only if Exim has been compiled with SUPPORT_MBX
20023 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
20024 the message is appended to the mailbox file in MBX format instead of
20025 traditional Unix format. This format is supported by Pine4 and its associated
20026 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
20027
20028 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
20029 automatically changed by the use of &%mbx_format%&. They should normally be set
20030 empty when using MBX format, so this option almost always appears in this
20031 combination:
20032 .code
20033 mbx_format = true
20034 message_prefix =
20035 message_suffix =
20036 .endd
20037 If none of the locking options are mentioned in the configuration,
20038 &%use_mbx_lock%& is assumed and the other locking options default to false. It
20039 is possible to specify the other kinds of locking with &%mbx_format%&, but
20040 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
20041 interworks with &'c-client'&, providing for shared access to the mailbox. It
20042 should not be used if any program that does not use this form of locking is
20043 going to access the mailbox, nor should it be used if the mailbox file is NFS
20044 mounted, because it works only when the mailbox is accessed from a single host.
20045
20046 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
20047 the standard version of &'c-client'&, because as long as it has a mailbox open
20048 (this means for the whole of a Pine or IMAP session), Exim will not be able to
20049 append messages to it.
20050
20051
20052 .option message_prefix appendfile string&!! "see below"
20053 .cindex "&""From""& line"
20054 The string specified here is expanded and output at the start of every message.
20055 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20056 in which case it is:
20057 .code
20058 message_prefix = "From ${if def:return_path{$return_path}\
20059   {MAILER-DAEMON}} $tod_bsdinbox\n"
20060 .endd
20061 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20062 &`\n`& to &`\r\n`& in &%message_prefix%&.
20063
20064 .option message_suffix appendfile string&!! "see below"
20065 The string specified here is expanded and output at the end of every message.
20066 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20067 in which case it is a single newline character. The suffix can be suppressed by
20068 setting
20069 .code
20070 message_suffix =
20071 .endd
20072 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20073 &`\n`& to &`\r\n`& in &%message_suffix%&.
20074
20075 .option mode appendfile "octal integer" 0600
20076 If the output file is created, it is given this mode. If it already exists and
20077 has wider permissions, they are reduced to this mode. If it has narrower
20078 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
20079 if the delivery is the result of a &%save%& command in a filter file specifying
20080 a particular mode, the mode of the output file is always forced to take that
20081 value, and this option is ignored.
20082
20083
20084 .option mode_fail_narrower appendfile boolean true
20085 This option applies in the case when an existing mailbox file has a narrower
20086 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
20087 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
20088 continues with the delivery attempt, using the existing mode of the file.
20089
20090
20091 .option notify_comsat appendfile boolean false
20092 If this option is true, the &'comsat'& daemon is notified after every
20093 successful delivery to a user mailbox. This is the daemon that notifies logged
20094 on users about incoming mail.
20095
20096
20097 .option quota appendfile string&!! unset
20098 .cindex "quota" "imposed by Exim"
20099 This option imposes a limit on the size of the file to which Exim is appending,
20100 or to the total space used in the directory tree when the &%directory%& option
20101 is set. In the latter case, computation of the space used is expensive, because
20102 all the files in the directory (and any sub-directories) have to be
20103 individually inspected and their sizes summed. (See &%quota_size_regex%& and
20104 &%maildir_use_size_file%& for ways to avoid this in environments where users
20105 have no shell access to their mailboxes).
20106
20107 As there is no interlock against two simultaneous deliveries into a
20108 multi-file mailbox, it is possible for the quota to be overrun in this case.
20109 For single-file mailboxes, of course, an interlock is a necessity.
20110
20111 A file's size is taken as its &'used'& value. Because of blocking effects, this
20112 may be a lot less than the actual amount of disk space allocated to the file.
20113 If the sizes of a number of files are being added up, the rounding effect can
20114 become quite noticeable, especially on systems that have large block sizes.
20115 Nevertheless, it seems best to stick to the &'used'& figure, because this is
20116 the obvious value which users understand most easily.
20117
20118 The value of the option is expanded, and must then be a numerical value
20119 (decimal point allowed), optionally followed by one of the letters K, M, or G,
20120 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
20121 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
20122 be handled.
20123
20124 &*Note*&: A value of zero is interpreted as &"no quota"&.
20125
20126 The expansion happens while Exim is running as root, before it changes uid for
20127 the delivery. This means that files that are inaccessible to the end user can
20128 be used to hold quota values that are looked up in the expansion. When delivery
20129 fails because this quota is exceeded, the handling of the error is as for
20130 system quota failures.
20131
20132 By default, Exim's quota checking mimics system quotas, and restricts the
20133 mailbox to the specified maximum size, though the value is not accurate to the
20134 last byte, owing to separator lines and additional headers that may get added
20135 during message delivery. When a mailbox is nearly full, large messages may get
20136 refused even though small ones are accepted, because the size of the current
20137 message is added to the quota when the check is made. This behaviour can be
20138 changed by setting &%quota_is_inclusive%& false. When this is done, the check
20139 for exceeding the quota does not include the current message. Thus, deliveries
20140 continue until the quota has been exceeded; thereafter, no further messages are
20141 delivered. See also &%quota_warn_threshold%&.
20142
20143
20144 .option quota_directory appendfile string&!! unset
20145 This option defines the directory to check for quota purposes when delivering
20146 into individual files. The default is the delivery directory, or, if a file
20147 called &_maildirfolder_& exists in a maildir directory, the parent of the
20148 delivery directory.
20149
20150
20151 .option quota_filecount appendfile string&!! 0
20152 This option applies when the &%directory%& option is set. It limits the total
20153 number of files in the directory (compare the inode limit in system quotas). It
20154 can only be used if &%quota%& is also set. The value is expanded; an expansion
20155 failure causes delivery to be deferred. A value of zero is interpreted as
20156 &"no quota"&.
20157
20158
20159 .option quota_is_inclusive appendfile boolean true
20160 See &%quota%& above.
20161
20162
20163 .option quota_size_regex appendfile string unset
20164 This option applies when one of the delivery modes that writes a separate file
20165 for each message is being used. When Exim wants to find the size of one of
20166 these files in order to test the quota, it first checks &%quota_size_regex%&.
20167 If this is set to a regular expression that matches the file name, and it
20168 captures one string, that string is interpreted as a representation of the
20169 file's size. The value of &%quota_size_regex%& is not expanded.
20170
20171 This feature is useful only when users have no shell access to their mailboxes
20172 &-- otherwise they could defeat the quota simply by renaming the files. This
20173 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20174 the file length to the file name. For example:
20175 .code
20176 maildir_tag = ,S=$message_size
20177 quota_size_regex = ,S=(\d+)
20178 .endd
20179 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20180 number of lines in the message.
20181
20182 The regular expression should not assume that the length is at the end of the
20183 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20184 sometimes add other information onto the ends of message file names.
20185
20186
20187
20188 .option quota_warn_message appendfile string&!! "see below"
20189 See below for the use of this option. If it is not set when
20190 &%quota_warn_threshold%& is set, it defaults to
20191 .code
20192 quota_warn_message = "\
20193   To: $local_part@$domain\n\
20194   Subject: Your mailbox\n\n\
20195   This message is automatically created \
20196   by mail delivery software.\n\n\
20197   The size of your mailbox has exceeded \
20198   a warning threshold that is\n\
20199   set by the system administrator.\n"
20200 .endd
20201
20202
20203 .option quota_warn_threshold appendfile string&!! 0
20204 .cindex "quota" "warning threshold"
20205 .cindex "mailbox" "size warning"
20206 .cindex "size" "of mailbox"
20207 This option is expanded in the same way as &%quota%& (see above). If the
20208 resulting value is greater than zero, and delivery of the message causes the
20209 size of the file or total space in the directory tree to cross the given
20210 threshold, a warning message is sent. If &%quota%& is also set, the threshold
20211 may be specified as a percentage of it by following the value with a percent
20212 sign. For example:
20213 .code
20214 quota = 10M
20215 quota_warn_threshold = 75%
20216 .endd
20217 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20218 percent sign is ignored.
20219
20220 The warning message itself is specified by the &%quota_warn_message%& option,
20221 and it must start with a &'To:'& header line containing the recipient(s) of the
20222 warning message. These do not necessarily have to include the recipient(s) of
20223 the original message. A &'Subject:'& line should also normally be supplied. You
20224 can include any other header lines that you want. If you do not include a
20225 &'From:'& line, the default is:
20226 .code
20227 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20228 .endd
20229 .oindex &%errors_reply_to%&
20230 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20231 option.
20232
20233 The &%quota%& option does not have to be set in order to use this option; they
20234 are independent of one another except when the threshold is specified as a
20235 percentage.
20236
20237
20238 .option use_bsmtp appendfile boolean false
20239 .cindex "envelope sender"
20240 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20241 format, with the envelope sender and recipient(s) included as SMTP commands. If
20242 you want to include a leading HELO command with such messages, you can do
20243 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20244 for details of batch SMTP.
20245
20246
20247 .option use_crlf appendfile boolean false
20248 .cindex "carriage return"
20249 .cindex "linefeed"
20250 This option causes lines to be terminated with the two-character CRLF sequence
20251 (carriage return, linefeed) instead of just a linefeed character. In the case
20252 of batched SMTP, the byte sequence written to the file is then an exact image
20253 of what would be sent down a real SMTP connection.
20254
20255 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
20256 (which are used to supply the traditional &"From&~"& and blank line separators
20257 in Berkeley-style mailboxes) are written verbatim, so must contain their own
20258 carriage return characters if these are needed. In cases where these options
20259 have non-empty defaults, the values end with a single linefeed, so they must be
20260 changed to end with &`\r\n`& if &%use_crlf%& is set.
20261
20262
20263 .option use_fcntl_lock appendfile boolean "see below"
20264 This option controls the use of the &[fcntl()]& function to lock a file for
20265 exclusive use when a message is being appended. It is set by default unless
20266 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
20267 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
20268 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
20269
20270
20271 .option use_flock_lock appendfile boolean false
20272 This option is provided to support the use of &[flock()]& for file locking, for
20273 the few situations where it is needed. Most modern operating systems support
20274 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
20275 each other. Exim uses &[fcntl()]& locking by default.
20276
20277 This option is required only if you are using an operating system where
20278 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
20279 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
20280 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
20281
20282 .cindex "Solaris" "&[flock()]& support"
20283 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
20284 have it (and some, I think, provide a not quite right version built on top of
20285 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
20286 the ability to use it, and any attempt to do so will cause a configuration
20287 error.
20288
20289 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
20290 is just being mapped onto &[fcntl()]& by the OS).
20291
20292
20293 .option use_lockfile appendfile boolean "see below"
20294 If this option is turned off, Exim does not attempt to create a lock file when
20295 appending to a mailbox file. In this situation, the only locking is by
20296 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
20297 sure that every MUA that is ever going to look at your users' mailboxes uses
20298 &[fcntl()]& rather than a lock file, and even then only when you are not
20299 delivering over NFS from more than one host.
20300
20301 .cindex "NFS" "lock file"
20302 In order to append to an NFS file safely from more than one host, it is
20303 necessary to take out a lock &'before'& opening the file, and the lock file
20304 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
20305 file corruption.
20306
20307 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
20308 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
20309 except when &%mbx_format%& is set.
20310
20311
20312 .option use_mbx_lock appendfile boolean "see below"
20313 This option is available only if Exim has been compiled with SUPPORT_MBX
20314 set in &_Local/Makefile_&. Setting the option specifies that special MBX
20315 locking rules be used. It is set by default if &%mbx_format%& is set and none
20316 of the locking options are mentioned in the configuration. The locking rules
20317 are the same as are used by the &'c-client'& library that underlies Pine and
20318 the IMAP4 and POP daemons that come with it (see the discussion below). The
20319 rules allow for shared access to the mailbox. However, this kind of locking
20320 does not work when the mailbox is NFS mounted.
20321
20322 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
20323 &%use_flock_lock%& to control what kind of locking is used in implementing the
20324 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
20325 without &%use_fcntl_lock%& or &%use_flock_lock%&.
20326
20327
20328
20329
20330 .section "Operational details for appending" "SECTopappend"
20331 .cindex "appending to a file"
20332 .cindex "file" "appending"
20333 Before appending to a file, the following preparations are made:
20334
20335 .ilist
20336 If the name of the file is &_/dev/null_&, no action is taken, and a success
20337 return is given.
20338
20339 .next
20340 .cindex "directory creation"
20341 If any directories on the file's path are missing, Exim creates them if the
20342 &%create_directory%& option is set. A created directory's mode is given by the
20343 &%directory_mode%& option.
20344
20345 .next
20346 If &%file_format%& is set, the format of an existing file is checked. If this
20347 indicates that a different transport should be used, control is passed to that
20348 transport.
20349
20350 .next
20351 .cindex "file" "locking"
20352 .cindex "locking files"
20353 .cindex "NFS" "lock file"
20354 If &%use_lockfile%& is set, a lock file is built in a way that will work
20355 reliably over NFS, as follows:
20356
20357 .olist
20358 Create a &"hitching post"& file whose name is that of the lock file with the
20359 current time, primary host name, and process id added, by opening for writing
20360 as a new file. If this fails with an access error, delivery is deferred.
20361 .next
20362 Close the hitching post file, and hard link it to the lock file name.
20363 .next
20364 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
20365 Unlink the hitching post name.
20366 .next
20367 Otherwise, use &[stat()]& to get information about the hitching post file, and
20368 then unlink hitching post name. If the number of links is exactly two, creation
20369 of the lock file succeeded but something (for example, an NFS server crash and
20370 restart) caused this fact not to be communicated to the &[link()]& call.
20371 .next
20372 If creation of the lock file failed, wait for &%lock_interval%& and try again,
20373 up to &%lock_retries%& times. However, since any program that writes to a
20374 mailbox should complete its task very quickly, it is reasonable to time out old
20375 lock files that are normally the result of user agent and system crashes. If an
20376 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
20377 it before trying again.
20378 .endlist olist
20379
20380 .next
20381 A call is made to &[lstat()]& to discover whether the main file exists, and if
20382 so, what its characteristics are. If &[lstat()]& fails for any reason other
20383 than non-existence, delivery is deferred.
20384
20385 .next
20386 .cindex "symbolic link" "to mailbox"
20387 .cindex "mailbox" "symbolic link"
20388 If the file does exist and is a symbolic link, delivery is deferred, unless the
20389 &%allow_symlink%& option is set, in which case the ownership of the link is
20390 checked, and then &[stat()]& is called to find out about the real file, which
20391 is then subjected to the checks below. The check on the top-level link
20392 ownership prevents one user creating a link for another's mailbox in a sticky
20393 directory, though allowing symbolic links in this case is definitely not a good
20394 idea. If there is a chain of symbolic links, the intermediate ones are not
20395 checked.
20396
20397 .next
20398 If the file already exists but is not a regular file, or if the file's owner
20399 and group (if the group is being checked &-- see &%check_group%& above) are
20400 different from the user and group under which the delivery is running,
20401 delivery is deferred.
20402
20403 .next
20404 If the file's permissions are more generous than specified, they are reduced.
20405 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
20406 is set false, in which case the delivery is tried using the existing
20407 permissions.
20408
20409 .next
20410 The file's inode number is saved, and the file is then opened for appending.
20411 If this fails because the file has vanished, &(appendfile)& behaves as if it
20412 hadn't existed (see below). For any other failures, delivery is deferred.
20413
20414 .next
20415 If the file is opened successfully, check that the inode number hasn't
20416 changed, that it is still a regular file, and that the owner and permissions
20417 have not changed. If anything is wrong, defer delivery and freeze the message.
20418
20419 .next
20420 If the file did not exist originally, defer delivery if the &%file_must_exist%&
20421 option is set. Otherwise, check that the file is being created in a permitted
20422 directory if the &%create_file%& option is set (deferring on failure), and then
20423 open for writing as a new file, with the O_EXCL and O_CREAT options,
20424 except when dealing with a symbolic link (the &%allow_symlink%& option must be
20425 set). In this case, which can happen if the link points to a non-existent file,
20426 the file is opened for writing using O_CREAT but not O_EXCL, because
20427 that prevents link following.
20428
20429 .next
20430 .cindex "loop" "while file testing"
20431 If opening fails because the file exists, obey the tests given above for
20432 existing files. However, to avoid looping in a situation where the file is
20433 being continuously created and destroyed, the exists/not-exists loop is broken
20434 after 10 repetitions, and the message is then frozen.
20435
20436 .next
20437 If opening fails with any other error, defer delivery.
20438
20439 .next
20440 .cindex "file" "locking"
20441 .cindex "locking files"
20442 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
20443 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
20444 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
20445 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
20446 file, and an exclusive lock on the file whose name is
20447 .code
20448 /tmp/.<device-number>.<inode-number>
20449 .endd
20450 using the device and inode numbers of the open mailbox file, in accordance with
20451 the MBX locking rules. This file is created with a mode that is specified by
20452 the &%lockfile_mode%& option.
20453
20454 If Exim fails to lock the file, there are two possible courses of action,
20455 depending on the value of the locking timeout. This is obtained from
20456 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
20457
20458 If the timeout value is zero, the file is closed, Exim waits for
20459 &%lock_interval%&, and then goes back and re-opens the file as above and tries
20460 to lock it again. This happens up to &%lock_retries%& times, after which the
20461 delivery is deferred.
20462
20463 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
20464 &[flock()]& are used (with the given timeout), so there has already been some
20465 waiting involved by the time locking fails. Nevertheless, Exim does not give up
20466 immediately. It retries up to
20467 .code
20468 (lock_retries * lock_interval) / <timeout>
20469 .endd
20470 times (rounded up).
20471 .endlist
20472
20473 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
20474 and/or &[flock()]& locks) and then deletes the lock file if one was created.
20475
20476
20477 .section "Operational details for delivery to a new file" "SECTopdir"
20478 .cindex "delivery" "to single file"
20479 .cindex "&""From""& line"
20480 When the &%directory%& option is set instead of &%file%&, each message is
20481 delivered into a newly-created file or set of files. When &(appendfile)& is
20482 activated directly from a &(redirect)& router, neither &%file%& nor
20483 &%directory%& is normally set, because the path for delivery is supplied by the
20484 router. (See for example, the &(address_file)& transport in the default
20485 configuration.) In this case, delivery is to a new file if either the path name
20486 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
20487
20488 No locking is required while writing the message to a new file, so the various
20489 locking options of the transport are ignored. The &"From"& line that by default
20490 separates messages in a single file is not normally needed, nor is the escaping
20491 of message lines that start with &"From"&, and there is no need to ensure a
20492 newline at the end of each message. Consequently, the default values for
20493 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
20494 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
20495
20496 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
20497 the files in the delivery directory by default. However, you can specify a
20498 different directory by setting &%quota_directory%&. Also, for maildir
20499 deliveries (see below) the &_maildirfolder_& convention is honoured.
20500
20501
20502 .cindex "maildir format"
20503 .cindex "mailstore format"
20504 There are three different ways in which delivery to individual files can be
20505 done, controlled by the settings of the &%maildir_format%& and
20506 &%mailstore_format%& options. Note that code to support maildir or mailstore
20507 formats is not included in the binary unless SUPPORT_MAILDIR or
20508 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
20509
20510 .cindex "directory creation"
20511 In all three cases an attempt is made to create the directory and any necessary
20512 sub-directories if they do not exist, provided that the &%create_directory%&
20513 option is set (the default). The location of a created directory can be
20514 constrained by setting &%create_file%&. A created directory's mode is given by
20515 the &%directory_mode%& option. If creation fails, or if the
20516 &%create_directory%& option is not set when creation is required, delivery is
20517 deferred.
20518
20519
20520
20521 .section "Maildir delivery" "SECTmaildirdelivery"
20522 .cindex "maildir format" "description of"
20523 If the &%maildir_format%& option is true, Exim delivers each message by writing
20524 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
20525 directory that is defined by the &%directory%& option (the &"delivery
20526 directory"&). If the delivery is successful, the file is renamed into the
20527 &_new_& subdirectory.
20528
20529 In the file name, <&'stime'&> is the current time of day in seconds, and
20530 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
20531 Exim checks that the time-of-day clock has moved on by at least one microsecond
20532 before terminating the delivery process. This guarantees uniqueness for the
20533 file name. However, as a precaution, Exim calls &[stat()]& for the file before
20534 opening it. If any response other than ENOENT (does not exist) is given,
20535 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
20536
20537 Before Exim carries out a maildir delivery, it ensures that subdirectories
20538 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
20539 do not exist, Exim tries to create them and any superior directories in their
20540 path, subject to the &%create_directory%& and &%create_file%& options. If the
20541 &%maildirfolder_create_regex%& option is set, and the regular expression it
20542 contains matches the delivery directory, Exim also ensures that a file called
20543 &_maildirfolder_& exists in the delivery directory. If a missing directory or
20544 &_maildirfolder_& file cannot be created, delivery is deferred.
20545
20546 These features make it possible to use Exim to create all the necessary files
20547 and directories in a maildir mailbox, including subdirectories for maildir++
20548 folders. Consider this example:
20549 .code
20550 maildir_format = true
20551 directory = /var/mail/$local_part\
20552            ${if eq{$local_part_suffix}{}{}\
20553            {/.${substr_1:$local_part_suffix}}}
20554 maildirfolder_create_regex = /\.[^/]+$
20555 .endd
20556 If &$local_part_suffix$& is empty (there was no suffix for the local part),
20557 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
20558 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
20559 not match this name, so Exim will not look for or create the file
20560 &_/var/mail/pimbo/maildirfolder_&, though it will create
20561 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
20562
20563 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
20564 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
20565 does match &%maildirfolder_create_regex%&. In this case, Exim will create
20566 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
20567 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
20568
20569 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
20570 not inadvertently match the toplevel maildir directory, because a
20571 &_maildirfolder_& file at top level would completely break quota calculations.
20572
20573 .cindex "quota" "in maildir delivery"
20574 .cindex "maildir++"
20575 If Exim is required to check a &%quota%& setting before a maildir delivery, and
20576 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
20577 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
20578 Exim assumes the directory is a maildir++ folder directory, which is one level
20579 down from the user's top level mailbox directory. This causes it to start at
20580 the parent directory instead of the current directory when calculating the
20581 amount of space used.
20582
20583 One problem with delivering into a multi-file mailbox is that it is
20584 computationally expensive to compute the size of the mailbox for quota
20585 checking. Various approaches have been taken to reduce the amount of work
20586 needed. The next two sections describe two of them. A third alternative is to
20587 use some external process for maintaining the size data, and use the expansion
20588 of the &%mailbox_size%& option as a way of importing it into Exim.
20589
20590
20591
20592
20593 .section "Using tags to record message sizes" "SECID135"
20594 If &%maildir_tag%& is set, the string is expanded for each delivery.
20595 When the maildir file is renamed into the &_new_& sub-directory, the
20596 tag is added to its name. However, if adding the tag takes the length of the
20597 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
20598 the tag is dropped and the maildir file is created with no tag.
20599
20600 .vindex "&$message_size$&"
20601 Tags can be used to encode the size of files in their names; see
20602 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
20603 happens after the message has been written. The value of the &$message_size$&
20604 variable is set to the number of bytes actually written. If the expansion is
20605 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
20606 be deferred. The expanded tag may contain any printing characters except &"/"&.
20607 Non-printing characters in the string are ignored; if the resulting string is
20608 empty, it is ignored. If it starts with an alphanumeric character, a leading
20609 colon is inserted.
20610
20611
20612
20613 .section "Using a maildirsize file" "SECID136"
20614 .cindex "quota" "in maildir delivery"
20615 .cindex "maildir format" "&_maildirsize_& file"
20616 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
20617 storing quota and message size information in a file called &_maildirsize_&
20618 within the toplevel maildir directory. If this file does not exist, Exim
20619 creates it, setting the quota from the &%quota%& option of the transport. If
20620 the maildir directory itself does not exist, it is created before any attempt
20621 to write a &_maildirsize_& file.
20622
20623 The &_maildirsize_& file is used to hold information about the sizes of
20624 messages in the maildir, thus speeding up quota calculations. The quota value
20625 in the file is just a cache; if the quota is changed in the transport, the new
20626 value overrides the cached value when the next message is delivered. The cache
20627 is maintained for the benefit of other programs that access the maildir and
20628 need to know the quota.
20629
20630 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
20631 file is maintained (with a zero quota setting), but no quota is imposed.
20632
20633 A regular expression is available for controlling which directories in the
20634 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
20635 See the description of the &%maildir_quota_directory_regex%& option above for
20636 details.
20637
20638
20639 .section "Mailstore delivery" "SECID137"
20640 .cindex "mailstore format" "description of"
20641 If the &%mailstore_format%& option is true, each message is written as two
20642 files in the given directory. A unique base name is constructed from the
20643 message id and the current delivery process, and the files that are written use
20644 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
20645 contains the message's envelope, and the &_.msg_& file contains the message
20646 itself. The base name is placed in the variable &$mailstore_basename$&.
20647
20648 During delivery, the envelope is first written to a file with the suffix
20649 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
20650 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
20651 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
20652 file before accessing either of them. An alternative approach is to wait for
20653 the absence of a &_.tmp_& file.
20654
20655 The envelope file starts with any text defined by the &%mailstore_prefix%&
20656 option, expanded and terminated by a newline if there isn't one. Then follows
20657 the sender address on one line, then all the recipient addresses, one per line.
20658 There can be more than one recipient only if the &%batch_max%& option is set
20659 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
20660 appended to the file, followed by a newline if it does not end with one.
20661
20662 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
20663 failure, it is ignored. Other expansion errors are treated as serious
20664 configuration errors, and delivery is deferred. The variable
20665 &$mailstore_basename$& is available for use during these expansions.
20666
20667
20668 .section "Non-special new file delivery" "SECID138"
20669 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
20670 file is created directly in the named directory. For example, when delivering
20671 messages into files in batched SMTP format for later delivery to some host (see
20672 section &<<SECTbatchSMTP>>&), a setting such as
20673 .code
20674 directory = /var/bsmtp/$host
20675 .endd
20676 might be used. A message is written to a file with a temporary name, which is
20677 then renamed when the delivery is complete. The final name is obtained by
20678 expanding the contents of the &%directory_file%& option.
20679 .ecindex IIDapptra1
20680 .ecindex IIDapptra2
20681
20682
20683
20684
20685
20686
20687 . ////////////////////////////////////////////////////////////////////////////
20688 . ////////////////////////////////////////////////////////////////////////////
20689
20690 .chapter "The autoreply transport" "CHID8"
20691 .scindex IIDauttra1 "transports" "&(autoreply)&"
20692 .scindex IIDauttra2 "&(autoreply)& transport"
20693 The &(autoreply)& transport is not a true transport in that it does not cause
20694 the message to be transmitted. Instead, it generates a new mail message as an
20695 automatic reply to the incoming message. &'References:'& and
20696 &'Auto-Submitted:'& header lines are included. These are constructed according
20697 to the rules in RFCs 2822 and 3834, respectively.
20698
20699 If the router that passes the message to this transport does not have the
20700 &%unseen%& option set, the original message (for the current recipient) is not
20701 delivered anywhere. However, when the &%unseen%& option is set on the router
20702 that passes the message to this transport, routing of the address continues, so
20703 another router can set up a normal message delivery.
20704
20705
20706 The &(autoreply)& transport is usually run as the result of mail filtering, a
20707 &"vacation"& message being the standard example. However, it can also be run
20708 directly from a router like any other transport. To reduce the possibility of
20709 message cascades, messages created by the &(autoreply)& transport always have
20710 empty envelope sender addresses, like bounce messages.
20711
20712 The parameters of the message to be sent can be specified in the configuration
20713 by options described below. However, these are used only when the address
20714 passed to the transport does not contain its own reply information. When the
20715 transport is run as a consequence of a
20716 &%mail%&
20717 or &%vacation%& command in a filter file, the parameters of the message are
20718 supplied by the filter, and passed with the address. The transport's options
20719 that define the message are then ignored (so they are not usually set in this
20720 case). The message is specified entirely by the filter or by the transport; it
20721 is never built from a mixture of options. However, the &%file_optional%&,
20722 &%mode%&, and &%return_message%& options apply in all cases.
20723
20724 &(Autoreply)& is implemented as a local transport. When used as a result of a
20725 command in a user's filter file, &(autoreply)& normally runs under the uid and
20726 gid of the user, and with appropriate current and home directories (see chapter
20727 &<<CHAPenvironment>>&).
20728
20729 There is a subtle difference between routing a message to a &(pipe)& transport
20730 that generates some text to be returned to the sender, and routing it to an
20731 &(autoreply)& transport. This difference is noticeable only if more than one
20732 address from the same message is so handled. In the case of a pipe, the
20733 separate outputs from the different addresses are gathered up and returned to
20734 the sender in a single message, whereas if &(autoreply)& is used, a separate
20735 message is generated for each address that is passed to it.
20736
20737 Non-printing characters are not permitted in the header lines generated for the
20738 message that &(autoreply)& creates, with the exception of newlines that are
20739 immediately followed by white space. If any non-printing characters are found,
20740 the transport defers.
20741 Whether characters with the top bit set count as printing characters or not is
20742 controlled by the &%print_topbitchars%& global option.
20743
20744 If any of the generic options for manipulating headers (for example,
20745 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
20746 of the original message that is included in the generated message when
20747 &%return_message%& is set. They do not apply to the generated message itself.
20748
20749 .vindex "&$sender_address$&"
20750 If the &(autoreply)& transport receives return code 2 from Exim when it submits
20751 the message, indicating that there were no recipients, it does not treat this
20752 as an error. This means that autoreplies sent to &$sender_address$& when this
20753 is empty (because the incoming message is a bounce message) do not cause
20754 problems. They are just discarded.
20755
20756
20757
20758 .section "Private options for autoreply" "SECID139"
20759 .cindex "options" "&(autoreply)& transport"
20760
20761 .option bcc autoreply string&!! unset
20762 This specifies the addresses that are to receive &"blind carbon copies"& of the
20763 message when the message is specified by the transport.
20764
20765
20766 .option cc autoreply string&!! unset
20767 This specifies recipients of the message and the contents of the &'Cc:'& header
20768 when the message is specified by the transport.
20769
20770
20771 .option file autoreply string&!! unset
20772 The contents of the file are sent as the body of the message when the message
20773 is specified by the transport. If both &%file%& and &%text%& are set, the text
20774 string comes first.
20775
20776
20777 .option file_expand autoreply boolean false
20778 If this is set, the contents of the file named by the &%file%& option are
20779 subjected to string expansion as they are added to the message.
20780
20781
20782 .option file_optional autoreply boolean false
20783 If this option is true, no error is generated if the file named by the &%file%&
20784 option or passed with the address does not exist or cannot be read.
20785
20786
20787 .option from autoreply string&!! unset
20788 This specifies the contents of the &'From:'& header when the message is
20789 specified by the transport.
20790
20791
20792 .option headers autoreply string&!! unset
20793 This specifies additional RFC 2822 headers that are to be added to the message
20794 when the message is specified by the transport. Several can be given by using
20795 &"\n"& to separate them. There is no check on the format.
20796
20797
20798 .option log autoreply string&!! unset
20799 This option names a file in which a record of every message sent is logged when
20800 the message is specified by the transport.
20801
20802
20803 .option mode autoreply "octal integer" 0600
20804 If either the log file or the &"once"& file has to be created, this mode is
20805 used.
20806
20807
20808 .option never_mail autoreply "address list&!!" unset
20809 If any run of the transport creates a message with a recipient that matches any
20810 item in the list, that recipient is quietly discarded. If all recipients are
20811 discarded, no message is created. This applies both when the recipients are
20812 generated by a filter and when they are specified in the transport.
20813
20814
20815
20816 .option once autoreply string&!! unset
20817 This option names a file or DBM database in which a record of each &'To:'&
20818 recipient is kept when the message is specified by the transport. &*Note*&:
20819 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
20820
20821 If &%once%& is unset, or is set to an empty string, the message is always sent.
20822 By default, if &%once%& is set to a non-empty file name, the message
20823 is not sent if a potential recipient is already listed in the database.
20824 However, if the &%once_repeat%& option specifies a time greater than zero, the
20825 message is sent if that much time has elapsed since a message was last sent to
20826 this recipient. A setting of zero time for &%once_repeat%& (the default)
20827 prevents a message from being sent a second time &-- in this case, zero means
20828 infinity.
20829
20830 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
20831 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
20832 greater than zero, it changes the way Exim implements the &%once%& option.
20833 Instead of using a DBM file to record every recipient it sends to, it uses a
20834 regular file, whose size will never get larger than the given value.
20835
20836 In the file, Exim keeps a linear list of recipient addresses and the times at
20837 which they were sent messages. If the file is full when a new address needs to
20838 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
20839 means that a given recipient may receive multiple messages, but at
20840 unpredictable intervals that depend on the rate of turnover of addresses in the
20841 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
20842
20843
20844 .option once_file_size autoreply integer 0
20845 See &%once%& above.
20846
20847
20848 .option once_repeat autoreply time&!! 0s
20849 See &%once%& above.
20850 After expansion, the value of this option must be a valid time value.
20851
20852
20853 .option reply_to autoreply string&!! unset
20854 This specifies the contents of the &'Reply-To:'& header when the message is
20855 specified by the transport.
20856
20857
20858 .option return_message autoreply boolean false
20859 If this is set, a copy of the original message is returned with the new
20860 message, subject to the maximum size set in the &%return_size_limit%& global
20861 configuration option.
20862
20863
20864 .option subject autoreply string&!! unset
20865 This specifies the contents of the &'Subject:'& header when the message is
20866 specified by the transport. It is tempting to quote the original subject in
20867 automatic responses. For example:
20868 .code
20869 subject = Re: $h_subject:
20870 .endd
20871 There is a danger in doing this, however. It may allow a third party to
20872 subscribe your users to an opt-in mailing list, provided that the list accepts
20873 bounce messages as subscription confirmations. Well-managed lists require a
20874 non-bounce message to confirm a subscription, so the danger is relatively
20875 small.
20876
20877
20878
20879 .option text autoreply string&!! unset
20880 This specifies a single string to be used as the body of the message when the
20881 message is specified by the transport. If both &%text%& and &%file%& are set,
20882 the text comes first.
20883
20884
20885 .option to autoreply string&!! unset
20886 This specifies recipients of the message and the contents of the &'To:'& header
20887 when the message is specified by the transport.
20888 .ecindex IIDauttra1
20889 .ecindex IIDauttra2
20890
20891
20892
20893
20894 . ////////////////////////////////////////////////////////////////////////////
20895 . ////////////////////////////////////////////////////////////////////////////
20896
20897 .chapter "The lmtp transport" "CHAPLMTP"
20898 .cindex "transports" "&(lmtp)&"
20899 .cindex "&(lmtp)& transport"
20900 .cindex "LMTP" "over a pipe"
20901 .cindex "LMTP" "over a socket"
20902 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
20903 specified command
20904 or by interacting with a Unix domain socket.
20905 This transport is something of a cross between the &(pipe)& and &(smtp)&
20906 transports. Exim also has support for using LMTP over TCP/IP; this is
20907 implemented as an option for the &(smtp)& transport. Because LMTP is expected
20908 to be of minority interest, the default build-time configure in &_src/EDITME_&
20909 has it commented out. You need to ensure that
20910 .code
20911 TRANSPORT_LMTP=yes
20912 .endd
20913 .cindex "options" "&(lmtp)& transport"
20914 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
20915 included in the Exim binary. The private options of the &(lmtp)& transport are
20916 as follows:
20917
20918 .option batch_id lmtp string&!! unset
20919 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20920
20921
20922 .option batch_max lmtp integer 1
20923 This limits the number of addresses that can be handled in a single delivery.
20924 Most LMTP servers can handle several addresses at once, so it is normally a
20925 good idea to increase this value. See the description of local delivery
20926 batching in chapter &<<CHAPbatching>>&.
20927
20928
20929 .option command lmtp string&!! unset
20930 This option must be set if &%socket%& is not set. The string is a command which
20931 is run in a separate process. It is split up into a command name and list of
20932 arguments, each of which is separately expanded (so expansion cannot change the
20933 number of arguments). The command is run directly, not via a shell. The message
20934 is passed to the new process using the standard input and output to operate the
20935 LMTP protocol.
20936
20937 .option ignore_quota lmtp boolean false
20938 .cindex "LMTP" "ignoring quota errors"
20939 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
20940 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
20941 in its response to the LHLO command.
20942
20943 .option socket lmtp string&!! unset
20944 This option must be set if &%command%& is not set. The result of expansion must
20945 be the name of a Unix domain socket. The transport connects to the socket and
20946 delivers the message to it using the LMTP protocol.
20947
20948
20949 .option timeout lmtp time 5m
20950 The transport is aborted if the created process or Unix domain socket does not
20951 respond to LMTP commands or message input within this timeout. Delivery
20952 is deferred, and will be tried again later. Here is an example of a typical
20953 LMTP transport:
20954 .code
20955 lmtp:
20956   driver = lmtp
20957   command = /some/local/lmtp/delivery/program
20958   batch_max = 20
20959   user = exim
20960 .endd
20961 This delivers up to 20 addresses at a time, in a mixture of domains if
20962 necessary, running as the user &'exim'&.
20963
20964
20965
20966 . ////////////////////////////////////////////////////////////////////////////
20967 . ////////////////////////////////////////////////////////////////////////////
20968
20969 .chapter "The pipe transport" "CHAPpipetransport"
20970 .scindex IIDpiptra1 "transports" "&(pipe)&"
20971 .scindex IIDpiptra2 "&(pipe)& transport"
20972 The &(pipe)& transport is used to deliver messages via a pipe to a command
20973 running in another process. One example is the use of &(pipe)& as a
20974 pseudo-remote transport for passing messages to some other delivery mechanism
20975 (such as UUCP). Another is the use by individual users to automatically process
20976 their incoming messages. The &(pipe)& transport can be used in one of the
20977 following ways:
20978
20979 .ilist
20980 .vindex "&$local_part$&"
20981 A router routes one address to a transport in the normal way, and the
20982 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
20983 contains the local part of the address (as usual), and the command that is run
20984 is specified by the &%command%& option on the transport.
20985 .next
20986 .vindex "&$pipe_addresses$&"
20987 If the &%batch_max%& option is set greater than 1 (the default is 1), the
20988 transport can handle more than one address in a single run. In this case, when
20989 more than one address is routed to the transport, &$local_part$& is not set
20990 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
20991 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
20992 that are routed to the transport.
20993 .next
20994 .vindex "&$address_pipe$&"
20995 A router redirects an address directly to a pipe command (for example, from an
20996 alias or forward file). In this case, &$address_pipe$& contains the text of the
20997 pipe command, and the &%command%& option on the transport is ignored. If only
20998 one address is being transported (&%batch_max%& is not greater than one, or
20999 only one address was redirected to this pipe command), &$local_part$& contains
21000 the local part that was redirected.
21001 .endlist
21002
21003
21004 The &(pipe)& transport is a non-interactive delivery method. Exim can also
21005 deliver messages over pipes using the LMTP interactive protocol. This is
21006 implemented by the &(lmtp)& transport.
21007
21008 In the case when &(pipe)& is run as a consequence of an entry in a local user's
21009 &_.forward_& file, the command runs under the uid and gid of that user. In
21010 other cases, the uid and gid have to be specified explicitly, either on the
21011 transport or on the router that handles the address. Current and &"home"&
21012 directories are also controllable. See chapter &<<CHAPenvironment>>& for
21013 details of the local delivery environment and chapter &<<CHAPbatching>>&
21014 for a discussion of local delivery batching.
21015
21016
21017 .section "Concurrent delivery" "SECID140"
21018 If two messages arrive at almost the same time, and both are routed to a pipe
21019 delivery, the two pipe transports may be run concurrently. You must ensure that
21020 any pipe commands you set up are robust against this happening. If the commands
21021 write to a file, the &%exim_lock%& utility might be of use.
21022
21023
21024
21025
21026 .section "Returned status and data" "SECID141"
21027 .cindex "&(pipe)& transport" "returned data"
21028 If the command exits with a non-zero return code, the delivery is deemed to
21029 have failed, unless either the &%ignore_status%& option is set (in which case
21030 the return code is treated as zero), or the return code is one of those listed
21031 in the &%temp_errors%& option, which are interpreted as meaning &"try again
21032 later"&. In this case, delivery is deferred. Details of a permanent failure are
21033 logged, but are not included in the bounce message, which merely contains
21034 &"local delivery failed"&.
21035
21036 If the command exits on a signal and the &%freeze_signal%& option is set then
21037 the message will be frozen in the queue. If that option is not set, a bounce
21038 will be sent as normal.
21039
21040 If the return code is greater than 128 and the command being run is a shell
21041 script, it normally means that the script was terminated by a signal whose
21042 value is the return code minus 128. The &%freeze_signal%& option does not
21043 apply in this case.
21044
21045 If Exim is unable to run the command (that is, if &[execve()]& fails), the
21046 return code is set to 127. This is the value that a shell returns if it is
21047 asked to run a non-existent command. The wording for the log line suggests that
21048 a non-existent command may be the problem.
21049
21050 The &%return_output%& option can affect the result of a pipe delivery. If it is
21051 set and the command produces any output on its standard output or standard
21052 error streams, the command is considered to have failed, even if it gave a zero
21053 return code or if &%ignore_status%& is set. The output from the command is
21054 included as part of the bounce message. The &%return_fail_output%& option is
21055 similar, except that output is returned only when the command exits with a
21056 failure return code, that is, a value other than zero or a code that matches
21057 &%temp_errors%&.
21058
21059
21060
21061 .section "How the command is run" "SECThowcommandrun"
21062 .cindex "&(pipe)& transport" "path for command"
21063 The command line is (by default) broken down into a command name and arguments
21064 by the &(pipe)& transport itself. The &%allow_commands%& and
21065 &%restrict_to_path%& options can be used to restrict the commands that may be
21066 run.
21067
21068 .cindex "quoting" "in pipe command"
21069 Unquoted arguments are delimited by white space. If an argument appears in
21070 double quotes, backslash is interpreted as an escape character in the usual
21071 way. If an argument appears in single quotes, no escaping is done.
21072
21073 String expansion is applied to the command line except when it comes from a
21074 traditional &_.forward_& file (commands from a filter file are expanded). The
21075 expansion is applied to each argument in turn rather than to the whole line.
21076 For this reason, any string expansion item that contains white space must be
21077 quoted so as to be contained within a single argument. A setting such as
21078 .code
21079 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
21080 .endd
21081 will not work, because the expansion item gets split between several
21082 arguments. You have to write
21083 .code
21084 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
21085 .endd
21086 to ensure that it is all in one argument. The expansion is done in this way,
21087 argument by argument, so that the number of arguments cannot be changed as a
21088 result of expansion, and quotes or backslashes in inserted variables do not
21089 interact with external quoting. However, this leads to problems if you want to
21090 generate multiple arguments (or the command name plus arguments) from a single
21091 expansion. In this situation, the simplest solution is to use a shell. For
21092 example:
21093 .code
21094 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
21095 .endd
21096
21097 .cindex "transport" "filter"
21098 .cindex "filter" "transport filter"
21099 .vindex "&$pipe_addresses$&"
21100 Special handling takes place when an argument consists of precisely the text
21101 &`$pipe_addresses`&. This is not a general expansion variable; the only
21102 place this string is recognized is when it appears as an argument for a pipe or
21103 transport filter command. It causes each address that is being handled to be
21104 inserted in the argument list at that point &'as a separate argument'&. This
21105 avoids any problems with spaces or shell metacharacters, and is of use when a
21106 &(pipe)& transport is handling groups of addresses in a batch.
21107
21108 After splitting up into arguments and expansion, the resulting command is run
21109 in a subprocess directly from the transport, &'not'& under a shell. The
21110 message that is being delivered is supplied on the standard input, and the
21111 standard output and standard error are both connected to a single pipe that is
21112 read by Exim. The &%max_output%& option controls how much output the command
21113 may produce, and the &%return_output%& and &%return_fail_output%& options
21114 control what is done with it.
21115
21116 Not running the command under a shell (by default) lessens the security risks
21117 in cases when a command from a user's filter file is built out of data that was
21118 taken from an incoming message. If a shell is required, it can of course be
21119 explicitly specified as the command to be run. However, there are circumstances
21120 where existing commands (for example, in &_.forward_& files) expect to be run
21121 under a shell and cannot easily be modified. To allow for these cases, there is
21122 an option called &%use_shell%&, which changes the way the &(pipe)& transport
21123 works. Instead of breaking up the command line as just described, it expands it
21124 as a single string and passes the result to &_/bin/sh_&. The
21125 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
21126 with &%use_shell%&, and the whole mechanism is inherently less secure.
21127
21128
21129
21130 .section "Environment variables" "SECTpipeenv"
21131 .cindex "&(pipe)& transport" "environment for command"
21132 .cindex "environment for pipe transport"
21133 The environment variables listed below are set up when the command is invoked.
21134 This list is a compromise for maximum compatibility with other MTAs. Note that
21135 the &%environment%& option can be used to add additional variables to this
21136 environment.
21137 .display
21138 &`DOMAIN            `&   the domain of the address
21139 &`HOME              `&   the home directory, if set
21140 &`HOST              `&   the host name when called from a router (see below)
21141 &`LOCAL_PART        `&   see below
21142 &`LOCAL_PART_PREFIX `&   see below
21143 &`LOCAL_PART_SUFFIX `&   see below
21144 &`LOGNAME           `&   see below
21145 &`MESSAGE_ID        `&   Exim's local ID for the message
21146 &`PATH              `&   as specified by the &%path%& option below
21147 &`QUALIFY_DOMAIN    `&   the sender qualification domain
21148 &`RECIPIENT         `&   the complete recipient address
21149 &`SENDER            `&   the sender of the message (empty if a bounce)
21150 &`SHELL             `&   &`/bin/sh`&
21151 &`TZ                `&   the value of the &%timezone%& option, if set
21152 &`USER              `&   see below
21153 .endd
21154 When a &(pipe)& transport is called directly from (for example) an &(accept)&
21155 router, LOCAL_PART is set to the local part of the address. When it is
21156 called as a result of a forward or alias expansion, LOCAL_PART is set to
21157 the local part of the address that was expanded. In both cases, any affixes are
21158 removed from the local part, and made available in LOCAL_PART_PREFIX and
21159 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
21160 same value as LOCAL_PART for compatibility with other MTAs.
21161
21162 .cindex "HOST"
21163 HOST is set only when a &(pipe)& transport is called from a router that
21164 associates hosts with an address, typically when using &(pipe)& as a
21165 pseudo-remote transport. HOST is set to the first host name specified by
21166 the router.
21167
21168 .cindex "HOME"
21169 If the transport's generic &%home_directory%& option is set, its value is used
21170 for the HOME environment variable. Otherwise, a home directory may be set
21171 by the router's &%transport_home_directory%& option, which defaults to the
21172 user's home directory if &%check_local_user%& is set.
21173
21174
21175 .section "Private options for pipe" "SECID142"
21176 .cindex "options" "&(pipe)& transport"
21177
21178
21179
21180 .option allow_commands pipe "string list&!!" unset
21181 .cindex "&(pipe)& transport" "permitted commands"
21182 The string is expanded, and is then interpreted as a colon-separated list of
21183 permitted commands. If &%restrict_to_path%& is not set, the only commands
21184 permitted are those in the &%allow_commands%& list. They need not be absolute
21185 paths; the &%path%& option is still used for relative paths. If
21186 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
21187 in the &%allow_commands%& list, or a name without any slashes that is found on
21188 the path. In other words, if neither &%allow_commands%& nor
21189 &%restrict_to_path%& is set, there is no restriction on the command, but
21190 otherwise only commands that are permitted by one or the other are allowed. For
21191 example, if
21192 .code
21193 allow_commands = /usr/bin/vacation
21194 .endd
21195 and &%restrict_to_path%& is not set, the only permitted command is
21196 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
21197 &%use_shell%& is set.
21198
21199
21200 .option batch_id pipe string&!! unset
21201 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21202
21203
21204 .option batch_max pipe integer 1
21205 This limits the number of addresses that can be handled in a single delivery.
21206 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21207
21208
21209 .option check_string pipe string unset
21210 As &(pipe)& writes the message, the start of each line is tested for matching
21211 &%check_string%&, and if it does, the initial matching characters are replaced
21212 by the contents of &%escape_string%&, provided both are set. The value of
21213 &%check_string%& is a literal string, not a regular expression, and the case of
21214 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
21215 of &%check_string%& and &%escape_string%& are forced to values that implement
21216 the SMTP escaping protocol. Any settings made in the configuration file are
21217 ignored.
21218
21219
21220 .option command pipe string&!! unset
21221 This option need not be set when &(pipe)& is being used to deliver to pipes
21222 obtained directly from address redirections. In other cases, the option must be
21223 set, to provide a command to be run. It need not yield an absolute path (see
21224 the &%path%& option below). The command is split up into separate arguments by
21225 Exim, and each argument is separately expanded, as described in section
21226 &<<SECThowcommandrun>>& above.
21227
21228
21229 .option environment pipe string&!! unset
21230 .cindex "&(pipe)& transport" "environment for command"
21231 .cindex "environment for &(pipe)& transport"
21232 This option is used to add additional variables to the environment in which the
21233 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
21234 a string which is expanded, and then interpreted as a colon-separated list of
21235 environment settings of the form <&'name'&>=<&'value'&>.
21236
21237
21238 .option escape_string pipe string unset
21239 See &%check_string%& above.
21240
21241
21242 .option freeze_exec_fail pipe boolean false
21243 .cindex "exec failure"
21244 .cindex "failure of exec"
21245 .cindex "&(pipe)& transport" "failure of exec"
21246 Failure to exec the command in a pipe transport is by default treated like
21247 any other failure while running the command. However, if &%freeze_exec_fail%&
21248 is set, failure to exec is treated specially, and causes the message to be
21249 frozen, whatever the setting of &%ignore_status%&.
21250
21251
21252 .new
21253 .otion freeze_signal pipe boolean false
21254 .cindex "signal exit"
21255 .cidenx "&(pipe)& transport", "signal exit"
21256 Normally if the process run by a command in a pipe transport exits on a signal,
21257 a bounce message is sent. If &%freeze_signal%& is set, the message will be
21258 frozen in Exim's queue instead.
21259 .wen
21260
21261
21262 .option ignore_status pipe boolean false
21263 If this option is true, the status returned by the subprocess that is set up to
21264 run the command is ignored, and Exim behaves as if zero had been returned.
21265 Otherwise, a non-zero status or termination by signal causes an error return
21266 from the transport unless the status value is one of those listed in
21267 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
21268
21269 &*Note*&: This option does not apply to timeouts, which do not return a status.
21270 See the &%timeout_defer%& option for how timeouts are handled.
21271
21272 .option log_defer_output pipe boolean false
21273 .cindex "&(pipe)& transport" "logging output"
21274 If this option is set, and the status returned by the command is
21275 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
21276 and any output was produced, the first line of it is written to the main log.
21277
21278
21279 .option log_fail_output pipe boolean false
21280 If this option is set, and the command returns any output, and also ends with a
21281 return code that is neither zero nor one of the return codes listed in
21282 &%temp_errors%& (that is, the delivery failed), the first line of output is
21283 written to the main log. This option and &%log_output%& are mutually exclusive.
21284 Only one of them may be set.
21285
21286
21287
21288 .option log_output pipe boolean false
21289 If this option is set and the command returns any output, the first line of
21290 output is written to the main log, whatever the return code. This option and
21291 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
21292
21293
21294
21295 .option max_output pipe integer 20K
21296 This specifies the maximum amount of output that the command may produce on its
21297 standard output and standard error file combined. If the limit is exceeded, the
21298 process running the command is killed. This is intended as a safety measure to
21299 catch runaway processes. The limit is applied independently of the settings of
21300 the options that control what is done with such output (for example,
21301 &%return_output%&). Because of buffering effects, the amount of output may
21302 exceed the limit by a small amount before Exim notices.
21303
21304
21305 .option message_prefix pipe string&!! "see below"
21306 The string specified here is expanded and output at the start of every message.
21307 The default is unset if &%use_bsmtp%& is set. Otherwise it is
21308 .code
21309 message_prefix = \
21310   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
21311   ${tod_bsdinbox}\n
21312 .endd
21313 .cindex "Cyrus"
21314 .cindex "&%tmail%&"
21315 .cindex "&""From""& line"
21316 This is required by the commonly used &_/usr/bin/vacation_& program.
21317 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
21318 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
21319 setting
21320 .code
21321 message_prefix =
21322 .endd
21323 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21324 &`\n`& to &`\r\n`& in &%message_prefix%&.
21325
21326
21327 .option message_suffix pipe string&!! "see below"
21328 The string specified here is expanded and output at the end of every message.
21329 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
21330 The suffix can be suppressed by setting
21331 .code
21332 message_suffix =
21333 .endd
21334 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21335 &`\n`& to &`\r\n`& in &%message_suffix%&.
21336
21337
21338 .option path pipe string "see below"
21339 This option specifies the string that is set up in the PATH environment
21340 variable of the subprocess. The default is:
21341 .code
21342 /bin:/usr/bin
21343 .endd
21344 If the &%command%& option does not yield an absolute path name, the command is
21345 sought in the PATH directories, in the usual way. &*Warning*&: This does not
21346 apply to a command specified as a transport filter.
21347
21348
21349 .new
21350 .option permit_coredump pipe boolean false
21351 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
21352 a core-dump of a pipe command, enable this command.  This enables core-dumps
21353 during delivery and affects both the Exim binary and the pipe command run.
21354 It is recommended that this option remain off unless and until you have a need
21355 for it and that this only be enabled when needed, as the risk of excessive
21356 resource consumption can be quite high.  Note also that Exim is typically
21357 installed as a setuid binary and most operating systems will inhibit coredumps
21358 of these by default, so further OS-specific action may be required.
21359 .wen
21360
21361
21362 .option pipe_as_creator pipe boolean false
21363 .cindex "uid (user id)" "local delivery"
21364 If the generic &%user%& option is not set and this option is true, the delivery
21365 process is run under the uid that was in force when Exim was originally called
21366 to accept the message. If the group id is not otherwise set (via the generic
21367 &%group%& option), the gid that was in force when Exim was originally called to
21368 accept the message is used.
21369
21370
21371 .option restrict_to_path pipe boolean false
21372 When this option is set, any command name not listed in &%allow_commands%& must
21373 contain no slashes. The command is searched for only in the directories listed
21374 in the &%path%& option. This option is intended for use in the case when a pipe
21375 command has been generated from a user's &_.forward_& file. This is usually
21376 handled by a &(pipe)& transport called &%address_pipe%&.
21377
21378
21379 .option return_fail_output pipe boolean false
21380 If this option is true, and the command produced any output and ended with a
21381 return code other than zero or one of the codes listed in &%temp_errors%& (that
21382 is, the delivery failed), the output is returned in the bounce message.
21383 However, if the message has a null sender (that is, it is itself a bounce
21384 message), output from the command is discarded. This option and
21385 &%return_output%& are mutually exclusive. Only one of them may be set.
21386
21387
21388
21389 .option return_output pipe boolean false
21390 If this option is true, and the command produced any output, the delivery is
21391 deemed to have failed whatever the return code from the command, and the output
21392 is returned in the bounce message. Otherwise, the output is just discarded.
21393 However, if the message has a null sender (that is, it is a bounce message),
21394 output from the command is always discarded, whatever the setting of this
21395 option. This option and &%return_fail_output%& are mutually exclusive. Only one
21396 of them may be set.
21397
21398
21399
21400 .option temp_errors pipe "string list" "see below"
21401 .cindex "&(pipe)& transport" "temporary failure"
21402 This option contains either a colon-separated list of numbers, or a single
21403 asterisk. If &%ignore_status%& is false
21404 and &%return_output%& is not set,
21405 and the command exits with a non-zero return code, the failure is treated as
21406 temporary and the delivery is deferred if the return code matches one of the
21407 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
21408 codes are treated as permanent errors. The default setting contains the codes
21409 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
21410 compiled on a system that does not define these macros, it assumes values of 75
21411 and 73, respectively.
21412
21413
21414 .option timeout pipe time 1h
21415 If the command fails to complete within this time, it is killed. This normally
21416 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
21417 specifies no timeout. In order to ensure that any subprocesses created by the
21418 command are also killed, Exim makes the initial process a process group leader,
21419 and kills the whole process group on a timeout. However, this can be defeated
21420 if one of the processes starts a new process group.
21421
21422 .option timeout_defer pipe boolean false
21423 A timeout in a &(pipe)& transport, either in the command that the transport
21424 runs, or in a transport filter that is associated with it, is by default
21425 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
21426 is set true, both kinds of timeout become temporary errors, causing the
21427 delivery to be deferred.
21428
21429 .option umask pipe "octal integer" 022
21430 This specifies the umask setting for the subprocess that runs the command.
21431
21432
21433 .option use_bsmtp pipe boolean false
21434 .cindex "envelope sender"
21435 If this option is set true, the &(pipe)& transport writes messages in &"batch
21436 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
21437 commands. If you want to include a leading HELO command with such messages,
21438 you can do so by setting the &%message_prefix%& option. See section
21439 &<<SECTbatchSMTP>>& for details of batch SMTP.
21440
21441 .option use_classresources pipe boolean false
21442 .cindex "class resources (BSD)"
21443 This option is available only when Exim is running on FreeBSD, NetBSD, or
21444 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
21445 resource limits when a &(pipe)& transport is run to perform a delivery. The
21446 limits for the uid under which the pipe is to run are obtained from the login
21447 class database.
21448
21449
21450 .option use_crlf pipe boolean false
21451 .cindex "carriage return"
21452 .cindex "linefeed"
21453 This option causes lines to be terminated with the two-character CRLF sequence
21454 (carriage return, linefeed) instead of just a linefeed character. In the case
21455 of batched SMTP, the byte sequence written to the pipe is then an exact image
21456 of what would be sent down a real SMTP connection.
21457
21458 The contents of the &%message_prefix%& and &%message_suffix%& options are
21459 written verbatim, so must contain their own carriage return characters if these
21460 are needed. When &%use_bsmtp%& is not set, the default values for both
21461 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
21462 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
21463
21464
21465 .option use_shell pipe boolean false
21466 .vindex "&$pipe_addresses$&"
21467 If this option is set, it causes the command to be passed to &_/bin/sh_&
21468 instead of being run directly from the transport, as described in section
21469 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
21470 where the command is expected to be run under a shell and cannot easily be
21471 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
21472 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
21473 command is expanded as a single string, and handed to &_/bin/sh_& as data for
21474 its &%-c%& option.
21475
21476
21477
21478 .section "Using an external local delivery agent" "SECID143"
21479 .cindex "local delivery" "using an external agent"
21480 .cindex "&'procmail'&"
21481 .cindex "external local delivery"
21482 .cindex "delivery" "&'procmail'&"
21483 .cindex "delivery" "by external agent"
21484 The &(pipe)& transport can be used to pass all messages that require local
21485 delivery to a separate local delivery agent such as &%procmail%&. When doing
21486 this, care must be taken to ensure that the pipe is run under an appropriate
21487 uid and gid. In some configurations one wants this to be a uid that is trusted
21488 by the delivery agent to supply the correct sender of the message. It may be
21489 necessary to recompile or reconfigure the delivery agent so that it trusts an
21490 appropriate user. The following is an example transport and router
21491 configuration for &%procmail%&:
21492 .code
21493 # transport
21494 procmail_pipe:
21495   driver = pipe
21496   command = /usr/local/bin/procmail -d $local_part
21497   return_path_add
21498   delivery_date_add
21499   envelope_to_add
21500   check_string = "From "
21501   escape_string = ">From "
21502   umask = 077
21503   user = $local_part
21504   group = mail
21505
21506 # router
21507 procmail:
21508   driver = accept
21509   check_local_user
21510   transport = procmail_pipe
21511 .endd
21512 In this example, the pipe is run as the local user, but with the group set to
21513 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
21514 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
21515 user to supply a correct sender address. If you do not specify either a
21516 &%group%& or a &%user%& option, the pipe command is run as the local user. The
21517 home directory is the user's home directory by default.
21518
21519 &*Note*&: The command that the pipe transport runs does &'not'& begin with
21520 .code
21521 IFS=" "
21522 .endd
21523 as shown in some &%procmail%& documentation, because Exim does not by default
21524 use a shell to run pipe commands.
21525
21526 .cindex "Cyrus"
21527 The next example shows a transport and a router for a system where local
21528 deliveries are handled by the Cyrus IMAP server.
21529 .code
21530 # transport
21531 local_delivery_cyrus:
21532   driver = pipe
21533   command = /usr/cyrus/bin/deliver \
21534             -m ${substr_1:$local_part_suffix} -- $local_part
21535   user = cyrus
21536   group = mail
21537   return_output
21538   log_output
21539   message_prefix =
21540   message_suffix =
21541
21542 # router
21543 local_user_cyrus:
21544   driver = accept
21545   check_local_user
21546   local_part_suffix = .*
21547   transport = local_delivery_cyrus
21548 .endd
21549 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
21550 &%return_output%& to cause any text written by Cyrus to be returned to the
21551 sender.
21552 .ecindex IIDpiptra1
21553 .ecindex IIDpiptra2
21554
21555
21556 . ////////////////////////////////////////////////////////////////////////////
21557 . ////////////////////////////////////////////////////////////////////////////
21558
21559 .chapter "The smtp transport" "CHAPsmtptrans"
21560 .scindex IIDsmttra1 "transports" "&(smtp)&"
21561 .scindex IIDsmttra2 "&(smtp)& transport"
21562 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
21563 or LMTP protocol. The list of hosts to try can either be taken from the address
21564 that is being processed (having been set up by the router), or specified
21565 explicitly for the transport. Timeout and retry processing (see chapter
21566 &<<CHAPretry>>&) is applied to each IP address independently.
21567
21568
21569 .section "Multiple messages on a single connection" "SECID144"
21570 The sending of multiple messages over a single TCP/IP connection can arise in
21571 two ways:
21572
21573 .ilist
21574 If a message contains more than &%max_rcpt%& (see below) addresses that are
21575 routed to the same host, more than one copy of the message has to be sent to
21576 that host. In this situation, multiple copies may be sent in a single run of
21577 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
21578 does when it has too many addresses to send in one message also depends on the
21579 value of the global &%remote_max_parallel%& option. Details are given in
21580 section &<<SECToutSMTPTCP>>&.)
21581 .next
21582 .cindex "hints database" "remembering routing"
21583 When a message has been successfully delivered over a TCP/IP connection, Exim
21584 looks in its hints database to see if there are any other messages awaiting a
21585 connection to the same host. If there are, a new delivery process is started
21586 for one of them, and the current TCP/IP connection is passed on to it. The new
21587 process may in turn send multiple copies and possibly create yet another
21588 process.
21589 .endlist
21590
21591
21592 For each copy sent over the same TCP/IP connection, a sequence counter is
21593 incremented, and if it ever gets to the value of &%connection_max_messages%&,
21594 no further messages are sent over that connection.
21595
21596
21597
21598 .section "Use of the $host and $host_address variables" "SECID145"
21599 .vindex "&$host$&"
21600 .vindex "&$host_address$&"
21601 At the start of a run of the &(smtp)& transport, the values of &$host$& and
21602 &$host_address$& are the name and IP address of the first host on the host list
21603 passed by the router. However, when the transport is about to connect to a
21604 specific host, and while it is connected to that host, &$host$& and
21605 &$host_address$& are set to the values for that host. These are the values
21606 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
21607 &%serialize_hosts%&, and the various TLS options are expanded.
21608
21609
21610 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
21611 .vindex &$tls_cipher$&
21612 .vindex &$tls_peerdn$&
21613 At the start of a run of the &(smtp)& transport, the values of &$tls_cipher$&
21614 and &$tls_peerdn$& are the values that were set when the message was received.
21615 These are the values that are used for options that are expanded before any
21616 SMTP connections are made. Just before each connection is made, these two
21617 variables are emptied. If TLS is subsequently started, they are set to the
21618 appropriate values for the outgoing connection, and these are the values that
21619 are in force when any authenticators are run and when the
21620 &%authenticated_sender%& option is expanded.
21621
21622
21623 .section "Private options for smtp" "SECID146"
21624 .cindex "options" "&(smtp)& transport"
21625 The private options of the &(smtp)& transport are as follows:
21626
21627
21628 .option address_retry_include_sender smtp boolean true
21629 .cindex "4&'xx'& responses" "retrying after"
21630 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
21631 is the combination of sender and recipient that is delayed in subsequent queue
21632 runs until the retry time is reached. You can delay the recipient without
21633 reference to the sender (which is what earlier versions of Exim did), by
21634 setting &%address_retry_include_sender%& false. However, this can lead to
21635 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
21636
21637 .option allow_localhost smtp boolean false
21638 .cindex "local host" "sending to"
21639 .cindex "fallback" "hosts specified on transport"
21640 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
21641 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
21642 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
21643 the delivery anyway. This should be used only in special cases when the
21644 configuration ensures that no looping will result (for example, a differently
21645 configured Exim is listening on the port to which the message is sent).
21646
21647
21648 .option authenticated_sender smtp string&!! unset
21649 .cindex "Cyrus"
21650 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
21651 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
21652 overriding any existing authenticated sender value. If the string expansion is
21653 forced to fail, the option is ignored. Other expansion failures cause delivery
21654 to be deferred. If the result of expansion is an empty string, that is also
21655 ignored.
21656
21657 The expansion happens after the outgoing connection has been made and TLS
21658 started, if required. This means that the &$host$&, &$host_address$&,
21659 &$tls_cipher$&, and &$tls_peerdn$& variables are set according to the
21660 particular connection.
21661
21662 If the SMTP session is not authenticated, the expansion of
21663 &%authenticated_sender%& still happens (and can cause the delivery to be
21664 deferred if it fails), but no AUTH= item is added to MAIL commands
21665 unless &%authenticated_sender_force%& is true.
21666
21667 This option allows you to use the &(smtp)& transport in LMTP mode to
21668 deliver mail to Cyrus IMAP and provide the proper local part as the
21669 &"authenticated sender"&, via a setting such as:
21670 .code
21671 authenticated_sender = $local_part
21672 .endd
21673 This removes the need for IMAP subfolders to be assigned special ACLs to
21674 allow direct delivery to those subfolders.
21675
21676 Because of expected uses such as that just described for Cyrus (when no
21677 domain is involved), there is no checking on the syntax of the provided
21678 value.
21679
21680
21681 .option authenticated_sender_force smtp boolean false
21682 If this option is set true, the &%authenticated_sender%& option's value
21683 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
21684 authenticated as a client.
21685
21686
21687 .option command_timeout smtp time 5m
21688 This sets a timeout for receiving a response to an SMTP command that has been
21689 sent out. It is also used when waiting for the initial banner line from the
21690 remote host. Its value must not be zero.
21691
21692
21693 .option connect_timeout smtp time 5m
21694 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
21695 to a remote host. A setting of zero allows the system timeout (typically
21696 several minutes) to act. To have any effect, the value of this option must be
21697 less than the system timeout. However, it has been observed that on some
21698 systems there is no system timeout, which is why the default value for this
21699 option is 5 minutes, a value recommended by RFC 1123.
21700
21701
21702 .option connection_max_messages smtp integer 500
21703 .cindex "SMTP" "passed connection"
21704 .cindex "SMTP" "multiple deliveries"
21705 .cindex "multiple SMTP deliveries"
21706 This controls the maximum number of separate message deliveries that are sent
21707 over a single TCP/IP connection. If the value is zero, there is no limit.
21708 For testing purposes, this value can be overridden by the &%-oB%& command line
21709 option.
21710
21711
21712 .option data_timeout smtp time 5m
21713 This sets a timeout for the transmission of each block in the data portion of
21714 the message. As a result, the overall timeout for a message depends on the size
21715 of the message. Its value must not be zero. See also &%final_timeout%&.
21716
21717
21718 .option delay_after_cutoff smtp boolean true
21719 This option controls what happens when all remote IP addresses for a given
21720 domain have been inaccessible for so long that they have passed their retry
21721 cutoff times.
21722
21723 In the default state, if the next retry time has not been reached for any of
21724 them, the address is bounced without trying any deliveries. In other words,
21725 Exim delays retrying an IP address after the final cutoff time until a new
21726 retry time is reached, and can therefore bounce an address without ever trying
21727 a delivery, when machines have been down for a long time. Some people are
21728 unhappy at this prospect, so...
21729
21730 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
21731 addresses are past their final cutoff time, Exim tries to deliver to those
21732 IP addresses that have not been tried since the message arrived. If there are
21733 none, of if they all fail, the address is bounced. In other words, it does not
21734 delay when a new message arrives, but immediately tries those expired IP
21735 addresses that haven't been tried since the message arrived. If there is a
21736 continuous stream of messages for the dead hosts, unsetting
21737 &%delay_after_cutoff%& means that there will be many more attempts to deliver
21738 to them.
21739
21740
21741 .option dns_qualify_single smtp boolean true
21742 If the &%hosts%& or &%fallback_hosts%& option is being used,
21743 and the &%gethostbyname%& option is false,
21744 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
21745 in chapter &<<CHAPdnslookup>>& for more details.
21746
21747
21748 .option dns_search_parents smtp boolean false
21749 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
21750 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
21751 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
21752 details.
21753
21754
21755
21756 .option fallback_hosts smtp "string list" unset
21757 .cindex "fallback" "hosts specified on transport"
21758 String expansion is not applied to this option. The argument must be a
21759 colon-separated list of host names or IP addresses, optionally also including
21760 port numbers, though the separator can be changed, as described in section
21761 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
21762 item in a &%route_list%& setting for the &(manualroute)& router, as described
21763 in section &<<SECTformatonehostitem>>&.
21764
21765 Fallback hosts can also be specified on routers, which associate them with the
21766 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
21767 &%fallback_hosts%& specified on the transport is used only if the address does
21768 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
21769 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
21770 However, &%hosts_randomize%& does apply to fallback host lists.
21771
21772 If Exim is unable to deliver to any of the hosts for a particular address, and
21773 the errors are not permanent rejections, the address is put on a separate
21774 transport queue with its host list replaced by the fallback hosts, unless the
21775 address was routed via MX records and the current host was in the original MX
21776 list. In that situation, the fallback host list is not used.
21777
21778 Once normal deliveries are complete, the fallback queue is delivered by
21779 re-running the same transports with the new host lists. If several failing
21780 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
21781 copy of the message is sent.
21782
21783 The resolution of the host names on the fallback list is controlled by the
21784 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
21785 both to cases when the host list comes with the address and when it is taken
21786 from &%hosts%&. This option provides a &"use a smart host only if delivery
21787 fails"& facility.
21788
21789
21790 .option final_timeout smtp time 10m
21791 This is the timeout that applies while waiting for the response to the final
21792 line containing just &"."& that terminates a message. Its value must not be
21793 zero.
21794
21795 .option gethostbyname smtp boolean false
21796 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
21797 being used, names are looked up using &[gethostbyname()]&
21798 (or &[getipnodebyname()]& when available)
21799 instead of using the DNS. Of course, that function may in fact use the DNS, but
21800 it may also consult other sources of information such as &_/etc/hosts_&.
21801
21802 .option gnutls_require_kx smtp string unset
21803 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
21804 client. For details, see section &<<SECTreqciphgnu>>&.
21805
21806 .option gnutls_require_mac smtp string unset
21807 This option controls the MAC algorithms when GnuTLS is used in an Exim
21808 client. For details, see section &<<SECTreqciphgnu>>&.
21809
21810 .option gnutls_require_protocols smtp string unset
21811 This option controls the protocols when GnuTLS is used in an Exim
21812 client. For details, see section &<<SECTreqciphgnu>>&.
21813
21814 .option gnutls_compat_mode smtp boolean unset
21815 This option controls whether GnuTLS is used in compatibility mode in an Exim
21816 server. This reduces security slightly, but improves interworking with older
21817 implementations of TLS.
21818
21819 .option helo_data smtp string&!! "see below"
21820 .cindex "HELO" "argument, setting"
21821 .cindex "EHLO" "argument, setting"
21822 .cindex "LHLO argument setting"
21823 The value of this option is expanded after a connection to a another host has
21824 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
21825 command that starts the outgoing SMTP or LMTP session. The default value of the
21826 option is:
21827 .code
21828 $primary_hostname
21829 .endd
21830 During the expansion, the variables &$host$& and &$host_address$& are set to
21831 the identity of the remote host, and the variables &$sending_ip_address$& and
21832 &$sending_port$& are set to the local IP address and port number that are being
21833 used. These variables can be used to generate different values for different
21834 servers or different local IP addresses. For example, if you want the string
21835 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
21836 interface address, you could use this:
21837 .code
21838 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
21839   {$primary_hostname}}
21840 .endd
21841 The use of &%helo_data%& applies both to sending messages and when doing
21842 callouts.
21843
21844 .option hosts smtp "string list&!!" unset
21845 Hosts are associated with an address by a router such as &(dnslookup)&, which
21846 finds the hosts by looking up the address domain in the DNS, or by
21847 &(manualroute)&, which has lists of hosts in its configuration. However,
21848 email addresses can be passed to the &(smtp)& transport by any router, and not
21849 all of them can provide an associated list of hosts.
21850
21851 The &%hosts%& option specifies a list of hosts to be used if the address being
21852 processed does not have any hosts associated with it. The hosts specified by
21853 &%hosts%& are also used, whether or not the address has its own hosts, if
21854 &%hosts_override%& is set.
21855
21856 The string is first expanded, before being interpreted as a colon-separated
21857 list of host names or IP addresses, possibly including port numbers. The
21858 separator may be changed to something other than colon, as described in section
21859 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
21860 item in a &%route_list%& setting for the &(manualroute)& router, as described
21861 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
21862 of the &(manualroute)& router is not available here.
21863
21864 If the expansion fails, delivery is deferred. Unless the failure was caused by
21865 the inability to complete a lookup, the error is logged to the panic log as
21866 well as the main log. Host names are looked up either by searching directly for
21867 address records in the DNS or by calling &[gethostbyname()]& (or
21868 &[getipnodebyname()]& when available), depending on the setting of the
21869 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
21870 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
21871 address are used.
21872
21873 During delivery, the hosts are tried in order, subject to their retry status,
21874 unless &%hosts_randomize%& is set.
21875
21876
21877 .option hosts_avoid_esmtp smtp "host list&!!" unset
21878 .cindex "ESMTP, avoiding use of"
21879 .cindex "HELO" "forcing use of"
21880 .cindex "EHLO" "avoiding use of"
21881 .cindex "PIPELINING" "avoiding the use of"
21882 This option is for use with broken hosts that announce ESMTP facilities (for
21883 example, PIPELINING) and then fail to implement them properly. When a host
21884 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
21885 start of the SMTP session. This means that it cannot use any of the ESMTP
21886 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
21887
21888
21889 .option hosts_avoid_pipelining smtp "host list&!!" unset
21890 .cindex "PIPELINING" "avoiding the use of"
21891 Exim will not use the SMTP PIPELINING extension when delivering to any host
21892 that matches this list, even if the server host advertises PIPELINING support.
21893
21894
21895 .option hosts_avoid_tls smtp "host list&!!" unset
21896 .cindex "TLS" "avoiding for certain hosts"
21897 Exim will not try to start a TLS session when delivering to any host that
21898 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
21899
21900
21901 .option hosts_max_try smtp integer 5
21902 .cindex "host" "maximum number to try"
21903 .cindex "limit" "number of hosts tried"
21904 .cindex "limit" "number of MX tried"
21905 .cindex "MX record" "maximum tried"
21906 This option limits the number of IP addresses that are tried for any one
21907 delivery in cases where there are temporary delivery errors. Section
21908 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
21909
21910
21911 .option hosts_max_try_hardlimit smtp integer 50
21912 This is an additional check on the maximum number of IP addresses that Exim
21913 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
21914 why it exists.
21915
21916
21917
21918 .option hosts_nopass_tls smtp "host list&!!" unset
21919 .cindex "TLS" "passing connection"
21920 .cindex "multiple SMTP deliveries"
21921 .cindex "TLS" "multiple message deliveries"
21922 For any host that matches this list, a connection on which a TLS session has
21923 been started will not be passed to a new delivery process for sending another
21924 message on the same connection. See section &<<SECTmulmessam>>& for an
21925 explanation of when this might be needed.
21926
21927
21928 .option hosts_override smtp boolean false
21929 If this option is set and the &%hosts%& option is also set, any hosts that are
21930 attached to the address are ignored, and instead the hosts specified by the
21931 &%hosts%& option are always used. This option does not apply to
21932 &%fallback_hosts%&.
21933
21934
21935 .option hosts_randomize smtp boolean false
21936 .cindex "randomized host list"
21937 .cindex "host" "list of; randomized"
21938 .cindex "fallback" "randomized hosts"
21939 If this option is set, and either the list of hosts is taken from the
21940 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
21941 were not obtained from MX records (this includes fallback hosts from the
21942 router), and were not randomized by the router, the order of trying the hosts
21943 is randomized each time the transport runs. Randomizing the order of a host
21944 list can be used to do crude load sharing.
21945
21946 When &%hosts_randomize%& is true, a host list may be split into groups whose
21947 order is separately randomized. This makes it possible to set up MX-like
21948 behaviour. The boundaries between groups are indicated by an item that is just
21949 &`+`& in the host list. For example:
21950 .code
21951 hosts = host1:host2:host3:+:host4:host5
21952 .endd
21953 The order of the first three hosts and the order of the last two hosts is
21954 randomized for each use, but the first three always end up before the last two.
21955 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
21956
21957 .option hosts_require_auth smtp "host list&!!" unset
21958 .cindex "authentication" "required by client"
21959 This option provides a list of servers for which authentication must succeed
21960 before Exim will try to transfer a message. If authentication fails for
21961 servers which are not in this list, Exim tries to send unauthenticated. If
21962 authentication fails for one of these servers, delivery is deferred. This
21963 temporary error is detectable in the retry rules, so it can be turned into a
21964 hard failure if required. See also &%hosts_try_auth%&, and chapter
21965 &<<CHAPSMTPAUTH>>& for details of authentication.
21966
21967
21968 .option hosts_require_tls smtp "host list&!!" unset
21969 .cindex "TLS" "requiring for certain servers"
21970 Exim will insist on using a TLS session when delivering to any host that
21971 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
21972 &*Note*&: This option affects outgoing mail only. To insist on TLS for
21973 incoming messages, use an appropriate ACL.
21974
21975 .option hosts_try_auth smtp "host list&!!" unset
21976 .cindex "authentication" "optional in client"
21977 This option provides a list of servers to which, provided they announce
21978 authentication support, Exim will attempt to authenticate as a client when it
21979 connects. If authentication fails, Exim will try to transfer the message
21980 unauthenticated. See also &%hosts_require_auth%&, and chapter
21981 &<<CHAPSMTPAUTH>>& for details of authentication.
21982
21983 .option interface smtp "string list&!!" unset
21984 .cindex "bind IP address"
21985 .cindex "IP address" "binding"
21986 .vindex "&$host$&"
21987 .vindex "&$host_address$&"
21988 This option specifies which interface to bind to when making an outgoing SMTP
21989 call. The value is an IP address, not an interface name such as
21990 &`eth0`&. Do not confuse this with the interface address that was used when a
21991 message was received, which is in &$received_ip_address$&, formerly known as
21992 &$interface_address$&. The name was changed to minimize confusion with the
21993 outgoing interface address. There is no variable that contains an outgoing
21994 interface address because, unless it is set by this option, its value is
21995 unknown.
21996
21997 During the expansion of the &%interface%& option the variables &$host$& and
21998 &$host_address$& refer to the host to which a connection is about to be made
21999 during the expansion of the string. Forced expansion failure, or an empty
22000 string result causes the option to be ignored. Otherwise, after expansion, the
22001 string must be a list of IP addresses, colon-separated by default, but the
22002 separator can be changed in the usual way. For example:
22003 .code
22004 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
22005 .endd
22006 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
22007 connection. If none of them are the correct type, the option is ignored. If
22008 &%interface%& is not set, or is ignored, the system's IP functions choose which
22009 interface to use if the host has more than one.
22010
22011
22012 .option keepalive smtp boolean true
22013 .cindex "keepalive" "on outgoing connection"
22014 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
22015 connections. When set, it causes the kernel to probe idle connections
22016 periodically, by sending packets with &"old"& sequence numbers. The other end
22017 of the connection should send a acknowledgment if the connection is still okay
22018 or a reset if the connection has been aborted. The reason for doing this is
22019 that it has the beneficial effect of freeing up certain types of connection
22020 that can get stuck when the remote host is disconnected without tidying up the
22021 TCP/IP call properly. The keepalive mechanism takes several hours to detect
22022 unreachable hosts.
22023
22024
22025 .option lmtp_ignore_quota smtp boolean false
22026 .cindex "LMTP" "ignoring quota errors"
22027 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
22028 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
22029 has advertised support for IGNOREQUOTA in its response to the LHLO command.
22030
22031 .option max_rcpt smtp integer 100
22032 .cindex "RCPT" "maximum number of outgoing"
22033 This option limits the number of RCPT commands that are sent in a single
22034 SMTP message transaction. Each set of addresses is treated independently, and
22035 so can cause parallel connections to the same host if &%remote_max_parallel%&
22036 permits this.
22037
22038
22039 .option multi_domain smtp boolean true
22040 .vindex "&$domain$&"
22041 When this option is set, the &(smtp)& transport can handle a number of
22042 addresses containing a mixture of different domains provided they all resolve
22043 to the same list of hosts. Turning the option off restricts the transport to
22044 handling only one domain at a time. This is useful if you want to use
22045 &$domain$& in an expansion for the transport, because it is set only when there
22046 is a single domain involved in a remote delivery.
22047
22048
22049 .option port smtp string&!! "see below"
22050 .cindex "port" "sending TCP/IP"
22051 .cindex "TCP/IP" "setting outgoing port"
22052 This option specifies the TCP/IP port on the server to which Exim connects.
22053 &*Note:*& Do not confuse this with the port that was used when a message was
22054 received, which is in &$received_port$&, formerly known as &$interface_port$&.
22055 The name was changed to minimize confusion with the outgoing port. There is no
22056 variable that contains an outgoing port.
22057
22058 If the value of this option begins with a digit it is taken as a port number;
22059 otherwise it is looked up using &[getservbyname()]&. The default value is
22060 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
22061 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
22062 is deferred.
22063
22064
22065
22066 .option protocol smtp string smtp
22067 .cindex "LMTP" "over TCP/IP"
22068 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
22069 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
22070 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
22071 deliveries into closed message stores. Exim also has support for running LMTP
22072 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
22073
22074
22075 .option retry_include_ip_address smtp boolean true
22076 Exim normally includes both the host name and the IP address in the key it
22077 constructs for indexing retry data after a temporary delivery failure. This
22078 means that when one of several IP addresses for a host is failing, it gets
22079 tried periodically (controlled by the retry rules), but use of the other IP
22080 addresses is not affected.
22081
22082 However, in some dialup environments hosts are assigned a different IP address
22083 each time they connect. In this situation the use of the IP address as part of
22084 the retry key leads to undesirable behaviour. Setting this option false causes
22085 Exim to use only the host name. This should normally be done on a separate
22086 instance of the &(smtp)& transport, set up specially to handle the dialup
22087 hosts.
22088
22089
22090 .option serialize_hosts smtp "host list&!!" unset
22091 .cindex "serializing connections"
22092 .cindex "host" "serializing connections"
22093 Because Exim operates in a distributed manner, if several messages for the same
22094 host arrive at around the same time, more than one simultaneous connection to
22095 the remote host can occur. This is not usually a problem except when there is a
22096 slow link between the hosts. In that situation it may be helpful to restrict
22097 Exim to one connection at a time. This can be done by setting
22098 &%serialize_hosts%& to match the relevant hosts.
22099
22100 .cindex "hints database" "serializing deliveries to a host"
22101 Exim implements serialization by means of a hints database in which a record is
22102 written whenever a process connects to one of the restricted hosts. The record
22103 is deleted when the connection is completed. Obviously there is scope for
22104 records to get left lying around if there is a system or program crash. To
22105 guard against this, Exim ignores any records that are more than six hours old.
22106
22107 If you set up this kind of serialization, you should also arrange to delete the
22108 relevant hints database whenever your system reboots. The names of the files
22109 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22110 may be one or two files, depending on the type of DBM in use. The same files
22111 are used for ETRN serialization.
22112
22113
22114 .option size_addition smtp integer 1024
22115 .cindex "SMTP" "SIZE"
22116 .cindex "message" "size issue for transport filter"
22117 .cindex "size" "of message"
22118 .cindex "transport" "filter"
22119 .cindex "filter" "transport filter"
22120 If a remote SMTP server indicates that it supports the SIZE option of the
22121 MAIL command, Exim uses this to pass over the message size at the start of
22122 an SMTP transaction. It adds the value of &%size_addition%& to the value it
22123 sends, to allow for headers and other text that may be added during delivery by
22124 configuration options or in a transport filter. It may be necessary to increase
22125 this if a lot of text is added to messages.
22126
22127 Alternatively, if the value of &%size_addition%& is set negative, it disables
22128 the use of the SIZE option altogether.
22129
22130
22131 .option tls_certificate smtp string&!! unset
22132 .cindex "TLS" "client certificate, location of"
22133 .cindex "certificate" "client, location of"
22134 .vindex "&$host$&"
22135 .vindex "&$host_address$&"
22136 The value of this option must be the absolute path to a file which contains the
22137 client's certificate, for possible use when sending a message over an encrypted
22138 connection. The values of &$host$& and &$host_address$& are set to the name and
22139 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
22140 details of TLS.
22141
22142 &*Note*&: This option must be set if you want Exim to be able to use a TLS
22143 certificate when sending messages as a client. The global option of the same
22144 name specifies the certificate for Exim as a server; it is not automatically
22145 assumed that the same certificate should be used when Exim is operating as a
22146 client.
22147
22148
22149 .option tls_crl smtp string&!! unset
22150 .cindex "TLS" "client certificate revocation list"
22151 .cindex "certificate" "revocation list for client"
22152 This option specifies a certificate revocation list. The expanded value must
22153 be the name of a file that contains a CRL in PEM format.
22154
22155
22156 .option tls_privatekey smtp string&!! unset
22157 .cindex "TLS" "client private key, location of"
22158 .vindex "&$host$&"
22159 .vindex "&$host_address$&"
22160 The value of this option must be the absolute path to a file which contains the
22161 client's private key. This is used when sending a message over an encrypted
22162 connection using a client certificate. The values of &$host$& and
22163 &$host_address$& are set to the name and address of the server during the
22164 expansion. If this option is unset, or the expansion is forced to fail, or the
22165 result is an empty string, the private key is assumed to be in the same file as
22166 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
22167
22168
22169 .option tls_require_ciphers smtp string&!! unset
22170 .cindex "TLS" "requiring specific ciphers"
22171 .cindex "cipher" "requiring specific"
22172 .vindex "&$host$&"
22173 .vindex "&$host_address$&"
22174 The value of this option must be a list of permitted cipher suites, for use
22175 when setting up an outgoing encrypted connection. (There is a global option of
22176 the same name for controlling incoming connections.) The values of &$host$& and
22177 &$host_address$& are set to the name and address of the server during the
22178 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
22179 is used in different ways by OpenSSL and GnuTLS (see sections
22180 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
22181 ciphers is a preference order.
22182
22183
22184
22185 .option tls_tempfail_tryclear smtp boolean true
22186 .cindex "4&'xx'& responses" "to STARTTLS"
22187 When the server host is not in &%hosts_require_tls%&, and there is a problem in
22188 setting up a TLS session, this option determines whether or not Exim should try
22189 to deliver the message unencrypted. If it is set false, delivery to the
22190 current host is deferred; if there are other hosts, they are tried. If this
22191 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
22192 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
22193 TLS negotiation fails, Exim closes the current connection (because it is in an
22194 unknown state), opens a new one to the same host, and then tries the delivery
22195 in clear.
22196
22197
22198 .option tls_verify_certificates smtp string&!! unset
22199 .cindex "TLS" "server certificate verification"
22200 .cindex "certificate" "verification of server"
22201 .vindex "&$host$&"
22202 .vindex "&$host_address$&"
22203 The value of this option must be the absolute path to a file containing
22204 permitted server certificates, for use when setting up an encrypted connection.
22205 Alternatively, if you are using OpenSSL, you can set
22206 &%tls_verify_certificates%& to the name of a directory containing certificate
22207 files. This does not work with GnuTLS; the option must be set to the name of a
22208 single file if you are using GnuTLS. The values of &$host$& and
22209 &$host_address$& are set to the name and address of the server during the
22210 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
22211
22212
22213
22214
22215 .section "How the limits for the number of hosts to try are used" &&&
22216          "SECTvalhosmax"
22217 .cindex "host" "maximum number to try"
22218 .cindex "limit" "hosts; maximum number tried"
22219 There are two options that are concerned with the number of hosts that are
22220 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
22221 &%hosts_max_try_hardlimit%&.
22222
22223
22224 The &%hosts_max_try%& option limits the number of hosts that are tried
22225 for a single delivery. However, despite the term &"host"& in its name, the
22226 option actually applies to each IP address independently. In other words, a
22227 multihomed host is treated as several independent hosts, just as it is for
22228 retrying.
22229
22230 Many of the larger ISPs have multiple MX records which often point to
22231 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
22232 created as a result of routing one of these domains.
22233
22234 Trying every single IP address on such a long list does not seem sensible; if
22235 several at the top of the list fail, it is reasonable to assume there is some
22236 problem that is likely to affect all of them. Roughly speaking, the value of
22237 &%hosts_max_try%& is the maximum number that are tried before deferring the
22238 delivery. However, the logic cannot be quite that simple.
22239
22240 Firstly, IP addresses that are skipped because their retry times have not
22241 arrived do not count, and in addition, addresses that are past their retry
22242 limits are also not counted, even when they are tried. This means that when
22243 some IP addresses are past their retry limits, more than the value of
22244 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
22245 that all IP addresses are considered before timing out an email address (but
22246 see below for an exception).
22247
22248 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
22249 list to see if there is a subsequent host with a different (higher valued) MX.
22250 If there is, that host is considered next, and the current IP address is used
22251 but not counted. This behaviour helps in the case of a domain with a retry rule
22252 that hardly ever delays any hosts, as is now explained:
22253
22254 Consider the case of a long list of hosts with one MX value, and a few with a
22255 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
22256 hosts at the top of the list are tried at first. With the default retry rule,
22257 which specifies increasing retry times, the higher MX hosts are eventually
22258 tried when those at the top of the list are skipped because they have not
22259 reached their retry times.
22260
22261 However, it is common practice to put a fixed short retry time on domains for
22262 large ISPs, on the grounds that their servers are rarely down for very long.
22263 Unfortunately, these are exactly the domains that tend to resolve to long lists
22264 of hosts. The short retry time means that the lowest MX hosts are tried every
22265 time. The attempts may be in a different order because of random sorting, but
22266 without the special MX check, the higher MX hosts would never be tried until
22267 all the lower MX hosts had timed out (which might be several days), because
22268 there are always some lower MX hosts that have reached their retry times. With
22269 the special check, Exim considers at least one IP address from each MX value at
22270 every delivery attempt, even if the &%hosts_max_try%& limit has already been
22271 reached.
22272
22273 The above logic means that &%hosts_max_try%& is not a hard limit, and in
22274 particular, Exim normally eventually tries all the IP addresses before timing
22275 out an email address. When &%hosts_max_try%& was implemented, this seemed a
22276 reasonable thing to do. Recently, however, some lunatic DNS configurations have
22277 been set up with hundreds of IP addresses for some domains. It can
22278 take a very long time indeed for an address to time out in these cases.
22279
22280 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
22281 Exim never tries more than this number of IP addresses; if it hits this limit
22282 and they are all timed out, the email address is bounced, even though not all
22283 possible IP addresses have been tried.
22284 .ecindex IIDsmttra1
22285 .ecindex IIDsmttra2
22286
22287
22288
22289
22290
22291 . ////////////////////////////////////////////////////////////////////////////
22292 . ////////////////////////////////////////////////////////////////////////////
22293
22294 .chapter "Address rewriting" "CHAPrewrite"
22295 .scindex IIDaddrew "rewriting" "addresses"
22296 There are some circumstances in which Exim automatically rewrites domains in
22297 addresses. The two most common are when an address is given without a domain
22298 (referred to as an &"unqualified address"&) or when an address contains an
22299 abbreviated domain that is expanded by DNS lookup.
22300
22301 Unqualified envelope addresses are accepted only for locally submitted
22302 messages, or for messages that are received from hosts matching
22303 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
22304 appropriate. Unqualified addresses in header lines are qualified if they are in
22305 locally submitted messages, or messages from hosts that are permitted to send
22306 unqualified envelope addresses. Otherwise, unqualified addresses in header
22307 lines are neither qualified nor rewritten.
22308
22309 One situation in which Exim does &'not'& automatically rewrite a domain is
22310 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
22311 such a domain should be rewritten using the &"canonical"& name, and some MTAs
22312 do this. The new RFCs do not contain this suggestion.
22313
22314
22315 .section "Explicitly configured address rewriting" "SECID147"
22316 This chapter describes the rewriting rules that can be used in the
22317 main rewrite section of the configuration file, and also in the generic
22318 &%headers_rewrite%& option that can be set on any transport.
22319
22320 Some people believe that configured address rewriting is a Mortal Sin.
22321 Others believe that life is not possible without it. Exim provides the
22322 facility; you do not have to use it.
22323
22324 The main rewriting rules that appear in the &"rewrite"& section of the
22325 configuration file are applied to addresses in incoming messages, both envelope
22326 addresses and addresses in header lines. Each rule specifies the types of
22327 address to which it applies.
22328
22329 Whether or not addresses in header lines are rewritten depends on the origin of
22330 the headers and the type of rewriting. Global rewriting, that is, rewriting
22331 rules from the rewrite section of the configuration file, is applied only to
22332 those headers that were received with the message. Header lines that are added
22333 by ACLs or by a system filter or by individual routers or transports (which
22334 are specific to individual recipient addresses) are not rewritten by the global
22335 rules.
22336
22337 Rewriting at transport time, by means of the &%headers_rewrite%& option,
22338 applies all headers except those added by routers and transports. That is, as
22339 well as the headers that were received with the message, it also applies to
22340 headers that were added by an ACL or a system filter.
22341
22342
22343 In general, rewriting addresses from your own system or domain has some
22344 legitimacy. Rewriting other addresses should be done only with great care and
22345 in special circumstances. The author of Exim believes that rewriting should be
22346 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
22347 Although it can sometimes be used as a routing tool, this is very strongly
22348 discouraged.
22349
22350 There are two commonly encountered circumstances where rewriting is used, as
22351 illustrated by these examples:
22352
22353 .ilist
22354 The company whose domain is &'hitch.fict.example'& has a number of hosts that
22355 exchange mail with each other behind a firewall, but there is only a single
22356 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
22357 &'hitch.fict.example'& when sending mail off-site.
22358 .next
22359 A host rewrites the local parts of its own users so that, for example,
22360 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
22361 .endlist
22362
22363
22364
22365 .section "When does rewriting happen?" "SECID148"
22366 .cindex "rewriting" "timing of"
22367 .cindex "&ACL;" "rewriting addresses in"
22368 Configured address rewriting can take place at several different stages of a
22369 message's processing.
22370
22371 .vindex "&$sender_address$&"
22372 At the start of an ACL for MAIL, the sender address may have been rewritten
22373 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
22374 ordinary rewrite rules have yet been applied. If, however, the sender address
22375 is verified in the ACL, it is rewritten before verification, and remains
22376 rewritten thereafter. The subsequent value of &$sender_address$& is the
22377 rewritten address. This also applies if sender verification happens in a
22378 RCPT ACL. Otherwise, when the sender address is not verified, it is
22379 rewritten as soon as a message's header lines have been received.
22380
22381 .vindex "&$domain$&"
22382 .vindex "&$local_part$&"
22383 Similarly, at the start of an ACL for RCPT, the current recipient's address
22384 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
22385 rewrite rules have yet been applied to it. However, the behaviour is different
22386 from the sender address when a recipient is verified. The address is rewritten
22387 for the verification, but the rewriting is not remembered at this stage. The
22388 value of &$local_part$& and &$domain$& after verification are always the same
22389 as they were before (that is, they contain the unrewritten &-- except for
22390 SMTP-time rewriting &-- address).
22391
22392 As soon as a message's header lines have been received, all the envelope
22393 recipient addresses are permanently rewritten, and rewriting is also applied to
22394 the addresses in the header lines (if configured). This happens before adding
22395 any header lines that were specified in MAIL or RCPT ACLs, and
22396 .cindex "&[local_scan()]& function" "address rewriting; timing of"
22397 before the DATA ACL and &[local_scan()]& functions are run.
22398
22399 When an address is being routed, either for delivery or for verification,
22400 rewriting is applied immediately to child addresses that are generated by
22401 redirection, unless &%no_rewrite%& is set on the router.
22402
22403 .cindex "envelope sender" "rewriting at transport time"
22404 .cindex "rewriting" "at transport time"
22405 .cindex "header lines" "rewriting at transport time"
22406 At transport time, additional rewriting of addresses in header lines can be
22407 specified by setting the generic &%headers_rewrite%& option on a transport.
22408 This option contains rules that are identical in form to those in the rewrite
22409 section of the configuration file. They are applied to the original message
22410 header lines and any that were added by ACLs or a system filter. They are not
22411 applied to header lines that are added by routers or the transport.
22412
22413 The outgoing envelope sender can be rewritten by means of the &%return_path%&
22414 transport option. However, it is not possible to rewrite envelope recipients at
22415 transport time.
22416
22417
22418
22419
22420 .section "Testing the rewriting rules that apply on input" "SECID149"
22421 .cindex "rewriting" "testing"
22422 .cindex "testing" "rewriting"
22423 Exim's input rewriting configuration appears in a part of the run time
22424 configuration file headed by &"begin rewrite"&. It can be tested by the
22425 &%-brw%& command line option. This takes an address (which can be a full RFC
22426 2822 address) as its argument. The output is a list of how the address would be
22427 transformed by the rewriting rules for each of the different places it might
22428 appear in an incoming message, that is, for each different header and for the
22429 envelope sender and recipient fields. For example,
22430 .code
22431 exim -brw ph10@exim.workshop.example
22432 .endd
22433 might produce the output
22434 .code
22435 sender: Philip.Hazel@exim.workshop.example
22436 from: Philip.Hazel@exim.workshop.example
22437 to: ph10@exim.workshop.example
22438 cc: ph10@exim.workshop.example
22439 bcc: ph10@exim.workshop.example
22440 reply-to: Philip.Hazel@exim.workshop.example
22441 env-from: Philip.Hazel@exim.workshop.example
22442 env-to: ph10@exim.workshop.example
22443 .endd
22444 which shows that rewriting has been set up for that address when used in any of
22445 the source fields, but not when it appears as a recipient address. At the
22446 present time, there is no equivalent way of testing rewriting rules that are
22447 set for a particular transport.
22448
22449
22450 .section "Rewriting rules" "SECID150"
22451 .cindex "rewriting" "rules"
22452 The rewrite section of the configuration file consists of lines of rewriting
22453 rules in the form
22454 .display
22455 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
22456 .endd
22457 Rewriting rules that are specified for the &%headers_rewrite%& generic
22458 transport option are given as a colon-separated list. Each item in the list
22459 takes the same form as a line in the main rewriting configuration (except that
22460 any colons must be doubled, of course).
22461
22462 The formats of source patterns and replacement strings are described below.
22463 Each is terminated by white space, unless enclosed in double quotes, in which
22464 case normal quoting conventions apply inside the quotes. The flags are single
22465 characters which may appear in any order. Spaces and tabs between them are
22466 ignored.
22467
22468 For each address that could potentially be rewritten, the rules are scanned in
22469 order, and replacements for the address from earlier rules can themselves be
22470 replaced by later rules (but see the &"q"& and &"R"& flags).
22471
22472 The order in which addresses are rewritten is undefined, may change between
22473 releases, and must not be relied on, with one exception: when a message is
22474 received, the envelope sender is always rewritten first, before any header
22475 lines are rewritten. For example, the replacement string for a rewrite of an
22476 address in &'To:'& must not assume that the message's address in &'From:'& has
22477 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
22478 that the envelope sender has already been rewritten.
22479
22480 .vindex "&$domain$&"
22481 .vindex "&$local_part$&"
22482 The variables &$local_part$& and &$domain$& can be used in the replacement
22483 string to refer to the address that is being rewritten. Note that lookup-driven
22484 rewriting can be done by a rule of the form
22485 .code
22486 *@*   ${lookup ...
22487 .endd
22488 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
22489 refer to the address that is being rewritten.
22490
22491
22492 .section "Rewriting patterns" "SECID151"
22493 .cindex "rewriting" "patterns"
22494 .cindex "address list" "in a rewriting pattern"
22495 The source pattern in a rewriting rule is any item which may appear in an
22496 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
22497 single-item address list, which means that it is expanded before being tested
22498 against the address. As always, if you use a regular expression as a pattern,
22499 you must take care to escape dollar and backslash characters, or use the &`\N`&
22500 facility to suppress string expansion within the regular expression.
22501
22502 Domains in patterns should be given in lower case. Local parts in patterns are
22503 case-sensitive. If you want to do case-insensitive matching of local parts, you
22504 can use a regular expression that starts with &`^(?i)`&.
22505
22506 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
22507 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
22508 depending on the type of match which occurred. These can be used in the
22509 replacement string to insert portions of the incoming address. &$0$& always
22510 refers to the complete incoming address. When a regular expression is used, the
22511 numerical variables are set from its capturing subexpressions. For other types
22512 of pattern they are set as follows:
22513
22514 .ilist
22515 If a local part or domain starts with an asterisk, the numerical variables
22516 refer to the character strings matched by asterisks, with &$1$& associated with
22517 the first asterisk, and &$2$& with the second, if present. For example, if the
22518 pattern
22519 .code
22520 *queen@*.fict.example
22521 .endd
22522 is matched against the address &'hearts-queen@wonderland.fict.example'& then
22523 .code
22524 $0 = hearts-queen@wonderland.fict.example
22525 $1 = hearts-
22526 $2 = wonderland
22527 .endd
22528 Note that if the local part does not start with an asterisk, but the domain
22529 does, it is &$1$& that contains the wild part of the domain.
22530
22531 .next
22532 If the domain part of the pattern is a partial lookup, the wild and fixed parts
22533 of the domain are placed in the next available numerical variables. Suppose,
22534 for example, that the address &'foo@bar.baz.example'& is processed by a
22535 rewriting rule of the form
22536 .display
22537 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
22538 .endd
22539 and the key in the file that matches the domain is &`*.baz.example`&. Then
22540 .code
22541 $1 = foo
22542 $2 = bar
22543 $3 = baz.example
22544 .endd
22545 If the address &'foo@baz.example'& is looked up, this matches the same
22546 wildcard file entry, and in this case &$2$& is set to the empty string, but
22547 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
22548 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
22549 whole domain. For non-partial domain lookups, no numerical variables are set.
22550 .endlist
22551
22552
22553 .section "Rewriting replacements" "SECID152"
22554 .cindex "rewriting" "replacements"
22555 If the replacement string for a rule is a single asterisk, addresses that
22556 match the pattern and the flags are &'not'& rewritten, and no subsequent
22557 rewriting rules are scanned. For example,
22558 .code
22559 hatta@lookingglass.fict.example  *  f
22560 .endd
22561 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
22562 &'From:'& headers.
22563
22564 .vindex "&$domain$&"
22565 .vindex "&$local_part$&"
22566 If the replacement string is not a single asterisk, it is expanded, and must
22567 yield a fully qualified address. Within the expansion, the variables
22568 &$local_part$& and &$domain$& refer to the address that is being rewritten.
22569 Any letters they contain retain their original case &-- they are not lower
22570 cased. The numerical variables are set up according to the type of pattern that
22571 matched the address, as described above. If the expansion is forced to fail by
22572 the presence of &"fail"& in a conditional or lookup item, rewriting by the
22573 current rule is abandoned, but subsequent rules may take effect. Any other
22574 expansion failure causes the entire rewriting operation to be abandoned, and an
22575 entry written to the panic log.
22576
22577
22578
22579 .section "Rewriting flags" "SECID153"
22580 There are three different kinds of flag that may appear on rewriting rules:
22581
22582 .ilist
22583 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
22584 c, f, h, r, s, t.
22585 .next
22586 A flag that specifies rewriting at SMTP time: S.
22587 .next
22588 Flags that control the rewriting process: Q, q, R, w.
22589 .endlist
22590
22591 For rules that are part of the &%headers_rewrite%& generic transport option,
22592 E, F, T, and S are not permitted.
22593
22594
22595
22596 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
22597          "SECID154"
22598 .cindex "rewriting" "flags"
22599 If none of the following flag letters, nor the &"S"& flag (see section
22600 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
22601 and to both the sender and recipient fields of the envelope, whereas a
22602 transport-time rewriting rule just applies to all headers. Otherwise, the
22603 rewriting rule is skipped unless the relevant addresses are being processed.
22604 .display
22605 &`E`&       rewrite all envelope fields
22606 &`F`&       rewrite the envelope From field
22607 &`T`&       rewrite the envelope To field
22608 &`b`&       rewrite the &'Bcc:'& header
22609 &`c`&       rewrite the &'Cc:'& header
22610 &`f`&       rewrite the &'From:'& header
22611 &`h`&       rewrite all headers
22612 &`r`&       rewrite the &'Reply-To:'& header
22613 &`s`&       rewrite the &'Sender:'& header
22614 &`t`&       rewrite the &'To:'& header
22615 .endd
22616 "All headers" means all of the headers listed above that can be selected
22617 individually, plus their &'Resent-'& versions. It does not include
22618 other headers such as &'Subject:'& etc.
22619
22620 You should be particularly careful about rewriting &'Sender:'& headers, and
22621 restrict this to special known cases in your own domains.
22622
22623
22624 .section "The SMTP-time rewriting flag" "SECTrewriteS"
22625 .cindex "SMTP" "rewriting malformed addresses"
22626 .cindex "RCPT" "rewriting argument of"
22627 .cindex "MAIL" "rewriting argument of"
22628 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
22629 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
22630 before any other processing; even before syntax checking. The pattern is
22631 required to be a regular expression, and it is matched against the whole of the
22632 data for the command, including any surrounding angle brackets.
22633
22634 .vindex "&$domain$&"
22635 .vindex "&$local_part$&"
22636 This form of rewrite rule allows for the handling of addresses that are not
22637 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
22638 input). Because the input is not required to be a syntactically valid address,
22639 the variables &$local_part$& and &$domain$& are not available during the
22640 expansion of the replacement string. The result of rewriting replaces the
22641 original address in the MAIL or RCPT command.
22642
22643
22644 .section "Flags controlling the rewriting process" "SECID155"
22645 There are four flags which control the way the rewriting process works. These
22646 take effect only when a rule is invoked, that is, when the address is of the
22647 correct type (matches the flags) and matches the pattern:
22648
22649 .ilist
22650 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
22651 unqualified local part. It is qualified with &%qualify_recipient%&. In the
22652 absence of &"Q"& the rewritten address must always include a domain.
22653 .next
22654 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
22655 even if no rewriting actually takes place because of a &"fail"& in the
22656 expansion. The &"q"& flag is not effective if the address is of the wrong type
22657 (does not match the flags) or does not match the pattern.
22658 .next
22659 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
22660 address, up to ten times. It can be combined with the &"q"& flag, to stop
22661 rewriting once it fails to match (after at least one successful rewrite).
22662 .next
22663 .cindex "rewriting" "whole addresses"
22664 When an address in a header is rewritten, the rewriting normally applies only
22665 to the working part of the address, with any comments and RFC 2822 &"phrase"&
22666 left unchanged. For example, rewriting might change
22667 .code
22668 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
22669 .endd
22670 into
22671 .code
22672 From: Ford Prefect <prefectf@hitch.fict.example>
22673 .endd
22674 .cindex "RFC 2047"
22675 Sometimes there is a need to replace the whole address item, and this can be
22676 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
22677 causes an address in a header line to be rewritten, the entire address is
22678 replaced, not just the working part. The replacement must be a complete RFC
22679 2822 address, including the angle brackets if necessary. If text outside angle
22680 brackets contains a character whose value is greater than 126 or less than 32
22681 (except for tab), the text is encoded according to RFC 2047. The character set
22682 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
22683
22684 When the &"w"& flag is set on a rule that causes an envelope address to be
22685 rewritten, all but the working part of the replacement address is discarded.
22686 .endlist
22687
22688
22689 .section "Rewriting examples" "SECID156"
22690 Here is an example of the two common rewriting paradigms:
22691 .code
22692 *@*.hitch.fict.example  $1@hitch.fict.example
22693 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
22694                      {$value}fail}@hitch.fict.example bctfrF
22695 .endd
22696 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
22697 the string expansion to fail if the lookup does not succeed. In this context it
22698 has the effect of leaving the original address unchanged, but Exim goes on to
22699 consider subsequent rewriting rules, if any, because the &"q"& flag is not
22700 present in that rule. An alternative to &"fail"& would be to supply &$1$&
22701 explicitly, which would cause the rewritten address to be the same as before,
22702 at the cost of a small bit of processing. Not supplying either of these is an
22703 error, since the rewritten address would then contain no local part.
22704
22705 The first example above replaces the domain with a superior, more general
22706 domain. This may not be desirable for certain local parts. If the rule
22707 .code
22708 root@*.hitch.fict.example  *
22709 .endd
22710 were inserted before the first rule, rewriting would be suppressed for the
22711 local part &'root'& at any domain ending in &'hitch.fict.example'&.
22712
22713 Rewriting can be made conditional on a number of tests, by making use of
22714 &${if$& in the expansion item. For example, to apply a rewriting rule only to
22715 messages that originate outside the local host:
22716 .code
22717 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
22718                          {$1@hitch.fict.example}fail}"
22719 .endd
22720 The replacement string is quoted in this example because it contains white
22721 space.
22722
22723 .cindex "rewriting" "bang paths"
22724 .cindex "bang paths" "rewriting"
22725 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
22726 an address it treats it as an unqualified local part which it qualifies with
22727 the local qualification domain (if the source of the message is local or if the
22728 remote host is permitted to send unqualified addresses). Rewriting can
22729 sometimes be used to handle simple bang paths with a fixed number of
22730 components. For example, the rule
22731 .code
22732 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
22733 .endd
22734 rewrites a two-component bang path &'host.name!user'& as the domain address
22735 &'user@host.name'&. However, there is a security implication in using this as
22736 a global rewriting rule for envelope addresses. It can provide a backdoor
22737 method for using your system as a relay, because the incoming addresses appear
22738 to be local. If the bang path addresses are received via SMTP, it is safer to
22739 use the &"S"& flag to rewrite them as they are received, so that relay checking
22740 can be done on the rewritten addresses.
22741 .ecindex IIDaddrew
22742
22743
22744
22745
22746
22747 . ////////////////////////////////////////////////////////////////////////////
22748 . ////////////////////////////////////////////////////////////////////////////
22749
22750 .chapter "Retry configuration" "CHAPretry"
22751 .scindex IIDretconf1 "retry" "configuration, description of"
22752 .scindex IIDregconf2 "configuration file" "retry section"
22753 The &"retry"& section of the runtime configuration file contains a list of
22754 retry rules that control how often Exim tries to deliver messages that cannot
22755 be delivered at the first attempt. If there are no retry rules (the section is
22756 empty or not present), there are no retries. In this situation, temporary
22757 errors are treated as permanent. The default configuration contains a single,
22758 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
22759 line option can be used to test which retry rule will be used for a given
22760 address, domain and error.
22761
22762 The most common cause of retries is temporary failure to deliver to a remote
22763 host because the host is down, or inaccessible because of a network problem.
22764 Exim's retry processing in this case is applied on a per-host (strictly, per IP
22765 address) basis, not on a per-message basis. Thus, if one message has recently
22766 been delayed, delivery of a new message to the same host is not immediately
22767 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
22768 log selector is set, the message
22769 .cindex "retry" "time not reached"
22770 &"retry time not reached"& is written to the main log whenever a delivery is
22771 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
22772 the handling of errors during remote deliveries.
22773
22774 Retry processing applies to routing as well as to delivering, except as covered
22775 in the next paragraph. The retry rules do not distinguish between these
22776 actions. It is not possible, for example, to specify different behaviour for
22777 failures to route the domain &'snark.fict.example'& and failures to deliver to
22778 the host &'snark.fict.example'&. I didn't think anyone would ever need this
22779 added complication, so did not implement it. However, although they share the
22780 same retry rule, the actual retry times for routing and transporting a given
22781 domain are maintained independently.
22782
22783 When a delivery is not part of a queue run (typically an immediate delivery on
22784 receipt of a message), the routers are always run, and local deliveries are
22785 always attempted, even if retry times are set for them. This makes for better
22786 behaviour if one particular message is causing problems (for example, causing
22787 quota overflow, or provoking an error in a filter file). If such a delivery
22788 suffers a temporary failure, the retry data is updated as normal, and
22789 subsequent delivery attempts from queue runs occur only when the retry time for
22790 the local address is reached.
22791
22792 .section "Changing retry rules" "SECID157"
22793 If you change the retry rules in your configuration, you should consider
22794 whether or not to delete the retry data that is stored in Exim's spool area in
22795 files with names like &_db/retry_&. Deleting any of Exim's hints files is
22796 always safe; that is why they are called &"hints"&.
22797
22798 The hints retry data contains suggested retry times based on the previous
22799 rules. In the case of a long-running problem with a remote host, it might
22800 record the fact that the host has timed out. If your new rules increase the
22801 timeout time for such a host, you should definitely remove the old retry data
22802 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
22803 messages that it should now be retaining.
22804
22805
22806
22807 .section "Format of retry rules" "SECID158"
22808 .cindex "retry" "rules"
22809 Each retry rule occupies one line and consists of three or four parts,
22810 separated by white space: a pattern, an error name, an optional list of sender
22811 addresses, and a list of retry parameters. The pattern and sender lists must be
22812 enclosed in double quotes if they contain white space. The rules are searched
22813 in order until one is found where the pattern, error name, and sender list (if
22814 present) match the failing host or address, the error that occurred, and the
22815 message's sender, respectively.
22816
22817
22818 The pattern is any single item that may appear in an address list (see section
22819 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
22820 which means that it is expanded before being tested against the address that
22821 has been delayed. A negated address list item is permitted. Address
22822 list processing treats a plain domain name as if it were preceded by &"*@"&,
22823 which makes it possible for many retry rules to start with just a domain. For
22824 example,
22825 .code
22826 lookingglass.fict.example        *  F,24h,30m;
22827 .endd
22828 provides a rule for any address in the &'lookingglass.fict.example'& domain,
22829 whereas
22830 .code
22831 alice@lookingglass.fict.example  *  F,24h,30m;
22832 .endd
22833 applies only to temporary failures involving the local part &%alice%&.
22834 In practice, almost all rules start with a domain name pattern without a local
22835 part.
22836
22837 .cindex "regular expressions" "in retry rules"
22838 &*Warning*&: If you use a regular expression in a routing rule pattern, it
22839 must match a complete address, not just a domain, because that is how regular
22840 expressions work in address lists.
22841 .display
22842 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
22843 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
22844 .endd
22845
22846
22847 .section "Choosing which retry rule to use for address errors" "SECID159"
22848 When Exim is looking for a retry rule after a routing attempt has failed (for
22849 example, after a DNS timeout), each line in the retry configuration is tested
22850 against the complete address only if &%retry_use_local_part%& is set for the
22851 router. Otherwise, only the domain is used, except when matching against a
22852 regular expression, when the local part of the address is replaced with &"*"&.
22853 A domain on its own can match a domain pattern, or a pattern that starts with
22854 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
22855 &%check_local_user%& is true, and false for other routers.
22856
22857 Similarly, when Exim is looking for a retry rule after a local delivery has
22858 failed (for example, after a mailbox full error), each line in the retry
22859 configuration is tested against the complete address only if
22860 &%retry_use_local_part%& is set for the transport (it defaults true for all
22861 local transports).
22862
22863 .cindex "4&'xx'& responses" "retry rules for"
22864 However, when Exim is looking for a retry rule after a remote delivery attempt
22865 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
22866 whole address is always used as the key when searching the retry rules. The
22867 rule that is found is used to create a retry time for the combination of the
22868 failing address and the message's sender. It is the combination of sender and
22869 recipient that is delayed in subsequent queue runs until its retry time is
22870 reached. You can delay the recipient without regard to the sender by setting
22871 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
22872 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
22873 commands.
22874
22875
22876
22877 .section "Choosing which retry rule to use for host and message errors" &&&
22878          "SECID160"
22879 For a temporary error that is not related to an individual address (for
22880 example, a connection timeout), each line in the retry configuration is checked
22881 twice. First, the name of the remote host is used as a domain name (preceded by
22882 &"*@"& when matching a regular expression). If this does not match the line,
22883 the domain from the email address is tried in a similar fashion. For example,
22884 suppose the MX records for &'a.b.c.example'& are
22885 .code
22886 a.b.c.example  MX  5  x.y.z.example
22887                MX  6  p.q.r.example
22888                MX  7  m.n.o.example
22889 .endd
22890 and the retry rules are
22891 .code
22892 p.q.r.example    *      F,24h,30m;
22893 a.b.c.example    *      F,4d,45m;
22894 .endd
22895 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
22896 first rule matches neither the host nor the domain, so Exim looks at the second
22897 rule. This does not match the host, but it does match the domain, so it is used
22898 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
22899 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
22900 first retry rule is used, because it matches the host.
22901
22902 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
22903 first rule to determine retry times, but for all the other hosts for the domain
22904 &'a.b.c.example'&, the second rule is used. The second rule is also used if
22905 routing to &'a.b.c.example'& suffers a temporary failure.
22906
22907 &*Note*&: The host name is used when matching the patterns, not its IP address.
22908 However, if a message is routed directly to an IP address without the use of a
22909 host name, for example, if a &(manualroute)& router contains a setting such as:
22910 .code
22911 route_list = *.a.example  192.168.34.23
22912 .endd
22913 then the &"host name"& that is used when searching for a retry rule is the
22914 textual form of the IP address.
22915
22916 .section "Retry rules for specific errors" "SECID161"
22917 .cindex "retry" "specific errors; specifying"
22918 The second field in a retry rule is the name of a particular error, or an
22919 asterisk, which matches any error. The errors that can be tested for are:
22920
22921 .vlist
22922 .vitem &%auth_failed%&
22923 Authentication failed when trying to send to a host in the
22924 &%hosts_require_auth%& list in an &(smtp)& transport.
22925
22926 .vitem &%data_4xx%&
22927 A 4&'xx'& error was received for an outgoing DATA command, either immediately
22928 after the command, or after sending the message's data.
22929
22930 .vitem &%mail_4xx%&
22931 A 4&'xx'& error was received for an outgoing MAIL command.
22932
22933 .vitem &%rcpt_4xx%&
22934 A 4&'xx'& error was received for an outgoing RCPT command.
22935 .endlist
22936
22937 For the three 4&'xx'& errors, either the first or both of the x's can be given
22938 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
22939 recognize 452 errors given to RCPT commands for addresses in a certain domain,
22940 and have retries every ten minutes with a one-hour timeout, you could set up a
22941 retry rule of this form:
22942 .code
22943 the.domain.name  rcpt_452   F,1h,10m
22944 .endd
22945 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
22946 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
22947
22948 .vlist
22949 .vitem &%lost_connection%&
22950 A server unexpectedly closed the SMTP connection. There may, of course,
22951 legitimate reasons for this (host died, network died), but if it repeats a lot
22952 for the same host, it indicates something odd.
22953
22954 .vitem &%refused_MX%&
22955 A connection to a host obtained from an MX record was refused.
22956
22957 .vitem &%refused_A%&
22958 A connection to a host not obtained from an MX record was refused.
22959
22960 .vitem &%refused%&
22961 A connection was refused.
22962
22963 .vitem &%timeout_connect_MX%&
22964 A connection attempt to a host obtained from an MX record timed out.
22965
22966 .vitem &%timeout_connect_A%&
22967 A connection attempt to a host not obtained from an MX record timed out.
22968
22969 .vitem &%timeout_connect%&
22970 A connection attempt timed out.
22971
22972 .vitem &%timeout_MX%&
22973 There was a timeout while connecting or during an SMTP session with a host
22974 obtained from an MX record.
22975
22976 .vitem &%timeout_A%&
22977 There was a timeout while connecting or during an SMTP session with a host not
22978 obtained from an MX record.
22979
22980 .vitem &%timeout%&
22981 There was a timeout while connecting or during an SMTP session.
22982
22983 .vitem &%tls_required%&
22984 The server was required to use TLS (it matched &%hosts_require_tls%& in the
22985 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
22986 to STARTTLS, or there was a problem setting up the TLS connection.
22987
22988 .vitem &%quota%&
22989 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
22990 transport.
22991
22992 .vitem &%quota_%&<&'time'&>
22993 .cindex "quota" "error testing in retry rule"
22994 .cindex "retry" "quota error testing"
22995 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
22996 transport, and the mailbox has not been accessed for <&'time'&>. For example,
22997 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
22998 for four days.
22999 .endlist
23000
23001 .cindex "mailbox" "time of last read"
23002 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
23003 timeouts when the mailbox is full and is not being read by its owner. Ideally,
23004 it should be based on the last time that the user accessed the mailbox.
23005 However, it is not always possible to determine this. Exim uses the following
23006 heuristic rules:
23007
23008 .ilist
23009 If the mailbox is a single file, the time of last access (the &"atime"&) is
23010 used. As no new messages are being delivered (because the mailbox is over
23011 quota), Exim does not access the file, so this is the time of last user access.
23012 .next
23013 .cindex "maildir format" "time of last read"
23014 For a maildir delivery, the time of last modification of the &_new_&
23015 subdirectory is used. As the mailbox is over quota, no new files are created in
23016 the &_new_& subdirectory, because no new messages are being delivered. Any
23017 change to the &_new_& subdirectory is therefore assumed to be the result of an
23018 MUA moving a new message to the &_cur_& directory when it is first read. The
23019 time that is used is therefore the last time that the user read a new message.
23020 .next
23021 For other kinds of multi-file mailbox, the time of last access cannot be
23022 obtained, so a retry rule that uses this type of error field is never matched.
23023 .endlist
23024
23025 The quota errors apply both to system-enforced quotas and to Exim's own quota
23026 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
23027 when a local delivery is deferred because a partition is full (the ENOSPC
23028 error).
23029
23030
23031
23032 .section "Retry rules for specified senders" "SECID162"
23033 .cindex "retry" "rules; sender-specific"
23034 You can specify retry rules that apply only when the failing message has a
23035 specific sender. In particular, this can be used to define retry rules that
23036 apply only to bounce messages. The third item in a retry rule can be of this
23037 form:
23038 .display
23039 &`senders=`&<&'address list'&>
23040 .endd
23041 The retry timings themselves are then the fourth item. For example:
23042 .code
23043 *   rcpt_4xx   senders=:   F,1h,30m
23044 .endd
23045 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
23046 host. If the address list contains white space, it must be enclosed in quotes.
23047 For example:
23048 .code
23049 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
23050 .endd
23051 &*Warning*&: This facility can be unhelpful if it is used for host errors
23052 (which do not depend on the recipient). The reason is that the sender is used
23053 only to match the retry rule. Once the rule has been found for a host error,
23054 its contents are used to set a retry time for the host, and this will apply to
23055 all messages, not just those with specific senders.
23056
23057 When testing retry rules using &%-brt%&, you can supply a sender using the
23058 &%-f%& command line option, like this:
23059 .code
23060 exim -f "" -brt user@dom.ain
23061 .endd
23062 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
23063 list is never matched.
23064
23065
23066
23067
23068
23069 .section "Retry parameters" "SECID163"
23070 .cindex "retry" "parameters in rules"
23071 The third (or fourth, if a senders list is present) field in a retry rule is a
23072 sequence of retry parameter sets, separated by semicolons. Each set consists of
23073 .display
23074 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
23075 .endd
23076 The letter identifies the algorithm for computing a new retry time; the cutoff
23077 time is the time beyond which this algorithm no longer applies, and the
23078 arguments vary the algorithm's action. The cutoff time is measured from the
23079 time that the first failure for the domain (combined with the local part if
23080 relevant) was detected, not from the time the message was received.
23081
23082 .cindex "retry" "algorithms"
23083 .cindex "retry" "fixed intervals"
23084 .cindex "retry" "increasing intervals"
23085 .cindex "retry" "random intervals"
23086 The available algorithms are:
23087
23088 .ilist
23089 &'F'&: retry at fixed intervals. There is a single time parameter specifying
23090 the interval.
23091 .next
23092 &'G'&: retry at geometrically increasing intervals. The first argument
23093 specifies a starting value for the interval, and the second a multiplier, which
23094 is used to increase the size of the interval at each retry.
23095 .next
23096 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
23097 retry, the previous interval is multiplied by the factor in order to get a
23098 maximum for the next interval. The minimum interval is the first argument of
23099 the parameter, and an actual interval is chosen randomly between them. Such a
23100 rule has been found to be helpful in cluster configurations when all the
23101 members of the cluster restart at once, and may therefore synchronize their
23102 queue processing times.
23103 .endlist
23104
23105 When computing the next retry time, the algorithm definitions are scanned in
23106 order until one whose cutoff time has not yet passed is reached. This is then
23107 used to compute a new retry time that is later than the current time. In the
23108 case of fixed interval retries, this simply means adding the interval to the
23109 current time. For geometrically increasing intervals, retry intervals are
23110 computed from the rule's parameters until one that is greater than the previous
23111 interval is found. The main configuration variable
23112 .cindex "limit" "retry interval"
23113 .cindex "retry" "interval, maximum"
23114 .oindex "&%retry_interval_max%&"
23115 &%retry_interval_max%& limits the maximum interval between retries. It
23116 cannot be set greater than &`24h`&, which is its default value.
23117
23118 A single remote domain may have a number of hosts associated with it, and each
23119 host may have more than one IP address. Retry algorithms are selected on the
23120 basis of the domain name, but are applied to each IP address independently. If,
23121 for example, a host has two IP addresses and one is unusable, Exim will
23122 generate retry times for it and will not try to use it until its next retry
23123 time comes. Thus the good IP address is likely to be tried first most of the
23124 time.
23125
23126 .cindex "hints database" "use for retrying"
23127 Retry times are hints rather than promises. Exim does not make any attempt to
23128 run deliveries exactly at the computed times. Instead, a queue runner process
23129 starts delivery processes for delayed messages periodically, and these attempt
23130 new deliveries only for those addresses that have passed their next retry time.
23131 If a new message arrives for a deferred address, an immediate delivery attempt
23132 occurs only if the address has passed its retry time. In the absence of new
23133 messages, the minimum time between retries is the interval between queue runner
23134 processes. There is not much point in setting retry times of five minutes if
23135 your queue runners happen only once an hour, unless there are a significant
23136 number of incoming messages (which might be the case on a system that is
23137 sending everything to a smart host, for example).
23138
23139 The data in the retry hints database can be inspected by using the
23140 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
23141 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
23142 &'exinext'& utility script can be used to find out what the next retry times
23143 are for the hosts associated with a particular mail domain, and also for local
23144 deliveries that have been deferred.
23145
23146
23147 .section "Retry rule examples" "SECID164"
23148 Here are some example retry rules:
23149 .code
23150 alice@wonderland.fict.example quota_5d  F,7d,3h
23151 wonderland.fict.example       quota_5d
23152 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
23153 lookingglass.fict.example     *         F,24h,30m;
23154 *                 refused_A   F,2h,20m;
23155 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
23156 .endd
23157 The first rule sets up special handling for mail to
23158 &'alice@wonderland.fict.example'& when there is an over-quota error and the
23159 mailbox has not been read for at least 5 days. Retries continue every three
23160 hours for 7 days. The second rule handles over-quota errors for all other local
23161 parts at &'wonderland.fict.example'&; the absence of a local part has the same
23162 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
23163 fail are bounced immediately if the mailbox has not been read for at least 5
23164 days.
23165
23166 The third rule handles all other errors at &'wonderland.fict.example'&; retries
23167 happen every 15 minutes for an hour, then with geometrically increasing
23168 intervals until two days have passed since a delivery first failed. After the
23169 first hour there is a delay of one hour, then two hours, then four hours, and
23170 so on (this is a rather extreme example).
23171
23172 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
23173 They happen every 30 minutes for 24 hours only. The remaining two rules handle
23174 all other domains, with special action for connection refusal from hosts that
23175 were not obtained from an MX record.
23176
23177 The final rule in a retry configuration should always have asterisks in the
23178 first two fields so as to provide a general catch-all for any addresses that do
23179 not have their own special handling. This example tries every 15 minutes for 2
23180 hours, then with intervals starting at one hour and increasing by a factor of
23181 1.5 up to 16 hours, then every 8 hours up to 5 days.
23182
23183
23184
23185 .section "Timeout of retry data" "SECID165"
23186 .cindex "timeout" "of retry data"
23187 .oindex "&%retry_data_expire%&"
23188 .cindex "hints database" "data expiry"
23189 .cindex "retry" "timeout of data"
23190 Exim timestamps the data that it writes to its retry hints database. When it
23191 consults the data during a delivery it ignores any that is older than the value
23192 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
23193 been tried for 7 days, Exim will try to deliver to it immediately a message
23194 arrives, and if that fails, it will calculate a retry time as if it were
23195 failing for the first time.
23196
23197 This improves the behaviour for messages routed to rarely-used hosts such as MX
23198 backups. If such a host was down at one time, and happens to be down again when
23199 Exim tries a month later, using the old retry data would imply that it had been
23200 down all the time, which is not a justified assumption.
23201
23202 If a host really is permanently dead, this behaviour causes a burst of retries
23203 every now and again, but only if messages routed to it are rare. If there is a
23204 message at least once every 7 days the retry data never expires.
23205
23206
23207
23208
23209 .section "Long-term failures" "SECID166"
23210 .cindex "delivery failure, long-term"
23211 .cindex "retry" "after long-term failure"
23212 Special processing happens when an email address has been failing for so long
23213 that the cutoff time for the last algorithm is reached. For example, using the
23214 default retry rule:
23215 .code
23216 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
23217 .endd
23218 the cutoff time is four days. Reaching the retry cutoff is independent of how
23219 long any specific message has been failing; it is the length of continuous
23220 failure for the recipient address that counts.
23221
23222 When the cutoff time is reached for a local delivery, or for all the IP
23223 addresses associated with a remote delivery, a subsequent delivery failure
23224 causes Exim to give up on the address, and a bounce message is generated.
23225 In order to cater for new messages that use the failing address, a next retry
23226 time is still computed from the final algorithm, and is used as follows:
23227
23228 For local deliveries, one delivery attempt is always made for any subsequent
23229 messages. If this delivery fails, the address fails immediately. The
23230 post-cutoff retry time is not used.
23231
23232 If the delivery is remote, there are two possibilities, controlled by the
23233 .oindex "&%delay_after_cutoff%&"
23234 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
23235 default. Until the post-cutoff retry time for one of the IP addresses is
23236 reached, the failing email address is bounced immediately, without a delivery
23237 attempt taking place. After that time, one new delivery attempt is made to
23238 those IP addresses that are past their retry times, and if that still fails,
23239 the address is bounced and new retry times are computed.
23240
23241 In other words, when all the hosts for a given email address have been failing
23242 for a long time, Exim bounces rather then defers until one of the hosts' retry
23243 times is reached. Then it tries once, and bounces if that attempt fails. This
23244 behaviour ensures that few resources are wasted in repeatedly trying to deliver
23245 to a broken destination, but if the host does recover, Exim will eventually
23246 notice.
23247
23248 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23249 addresses are past their final cutoff time, Exim tries to deliver to those IP
23250 addresses that have not been tried since the message arrived. If there are
23251 no suitable IP addresses, or if they all fail, the address is bounced. In other
23252 words, it does not delay when a new message arrives, but tries the expired
23253 addresses immediately, unless they have been tried since the message arrived.
23254 If there is a continuous stream of messages for the failing domains, setting
23255 &%delay_after_cutoff%& false means that there will be many more attempts to
23256 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
23257 true.
23258
23259 .section "Deliveries that work intermittently" "SECID167"
23260 .cindex "retry" "intermittently working deliveries"
23261 Some additional logic is needed to cope with cases where a host is
23262 intermittently available, or when a message has some attribute that prevents
23263 its delivery when others to the same address get through. In this situation,
23264 because some messages are successfully delivered, the &"retry clock"& for the
23265 host or address keeps getting reset by the successful deliveries, and so
23266 failing messages remain on the queue for ever because the cutoff time is never
23267 reached.
23268
23269 Two exceptional actions are applied to prevent this happening. The first
23270 applies to errors that are related to a message rather than a remote host.
23271 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
23272 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
23273 commands, and quota failures. For this type of error, if a message's arrival
23274 time is earlier than the &"first failed"& time for the error, the earlier time
23275 is used when scanning the retry rules to decide when to try next and when to
23276 time out the address.
23277
23278 The exceptional second action applies in all cases. If a message has been on
23279 the queue for longer than the cutoff time of any applicable retry rule for a
23280 given address, a delivery is attempted for that address, even if it is not yet
23281 time, and if this delivery fails, the address is timed out. A new retry time is
23282 not computed in this case, so that other messages for the same address are
23283 considered immediately.
23284 .ecindex IIDretconf1
23285 .ecindex IIDregconf2
23286
23287
23288
23289
23290
23291
23292 . ////////////////////////////////////////////////////////////////////////////
23293 . ////////////////////////////////////////////////////////////////////////////
23294
23295 .chapter "SMTP authentication" "CHAPSMTPAUTH"
23296 .scindex IIDauthconf1 "SMTP" "authentication configuration"
23297 .scindex IIDauthconf2 "authentication"
23298 The &"authenticators"& section of Exim's run time configuration is concerned
23299 with SMTP authentication. This facility is an extension to the SMTP protocol,
23300 described in RFC 2554, which allows a client SMTP host to authenticate itself
23301 to a server. This is a common way for a server to recognize clients that are
23302 permitted to use it as a relay. SMTP authentication is not of relevance to the
23303 transfer of mail between servers that have no managerial connection with each
23304 other.
23305
23306 .cindex "AUTH" "description of"
23307 Very briefly, the way SMTP authentication works is as follows:
23308
23309 .ilist
23310 The server advertises a number of authentication &'mechanisms'& in response to
23311 the client's EHLO command.
23312 .next
23313 The client issues an AUTH command, naming a specific mechanism. The command
23314 may, optionally, contain some authentication data.
23315 .next
23316 The server may issue one or more &'challenges'&, to which the client must send
23317 appropriate responses. In simple authentication mechanisms, the challenges are
23318 just prompts for user names and passwords. The server does not have to issue
23319 any challenges &-- in some mechanisms the relevant data may all be transmitted
23320 with the AUTH command.
23321 .next
23322 The server either accepts or denies authentication.
23323 .next
23324 If authentication succeeds, the client may optionally make use of the AUTH
23325 option on the MAIL command to pass an authenticated sender in subsequent
23326 mail transactions. Authentication lasts for the remainder of the SMTP
23327 connection.
23328 .next
23329 If authentication fails, the client may give up, or it may try a different
23330 authentication mechanism, or it may try transferring mail over the
23331 unauthenticated connection.
23332 .endlist
23333
23334 If you are setting up a client, and want to know which authentication
23335 mechanisms the server supports, you can use Telnet to connect to port 25 (the
23336 SMTP port) on the server, and issue an EHLO command. The response to this
23337 includes the list of supported mechanisms. For example:
23338 .display
23339 &`$ `&&*&`telnet server.example 25`&*&
23340 &`Trying 192.168.34.25...`&
23341 &`Connected to server.example.`&
23342 &`Escape character is &#x0027;^]&#x0027;.`&
23343 &`220 server.example ESMTP Exim 4.20 ...`&
23344 &*&`ehlo client.example`&*&
23345 &`250-server.example Hello client.example [10.8.4.5]`&
23346 &`250-SIZE 52428800`&
23347 &`250-PIPELINING`&
23348 &`250-AUTH PLAIN`&
23349 &`250 HELP`&
23350 .endd
23351 The second-last line of this example output shows that the server supports
23352 authentication using the PLAIN mechanism. In Exim, the different authentication
23353 mechanisms are configured by specifying &'authenticator'& drivers. Like the
23354 routers and transports, which authenticators are included in the binary is
23355 controlled by build-time definitions. The following are currently available,
23356 included by setting
23357 .code
23358 AUTH_CRAM_MD5=yes
23359 AUTH_CYRUS_SASL=yes
23360 AUTH_PLAINTEXT=yes
23361 AUTH_SPA=yes
23362 .endd
23363 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
23364 authentication mechanism (RFC 2195), and the second provides an interface to
23365 the Cyrus SASL authentication library. The third can be configured to support
23366 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
23367 not formally documented, but used by several MUAs. The fourth authenticator
23368 supports Microsoft's &'Secure Password Authentication'& mechanism.
23369
23370 The authenticators are configured using the same syntax as other drivers (see
23371 section &<<SECTfordricon>>&). If no authenticators are required, no
23372 authentication section need be present in the configuration file. Each
23373 authenticator can in principle have both server and client functions. When Exim
23374 is receiving SMTP mail, it is acting as a server; when it is sending out
23375 messages over SMTP, it is acting as a client. Authenticator configuration
23376 options are provided for use in both these circumstances.
23377
23378 To make it clear which options apply to which situation, the prefixes
23379 &%server_%& and &%client_%& are used on option names that are specific to
23380 either the server or the client function, respectively. Server and client
23381 functions are disabled if none of their options are set. If an authenticator is
23382 to be used for both server and client functions, a single definition, using
23383 both sets of options, is required. For example:
23384 .code
23385 cram:
23386   driver = cram_md5
23387   public_name = CRAM-MD5
23388   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
23389   client_name = ph10
23390   client_secret = secret2
23391 .endd
23392 The &%server_%& option is used when Exim is acting as a server, and the
23393 &%client_%& options when it is acting as a client.
23394
23395 Descriptions of the individual authenticators are given in subsequent chapters.
23396 The remainder of this chapter covers the generic options for the
23397 authenticators, followed by general discussion of the way authentication works
23398 in Exim.
23399
23400
23401
23402 .section "Generic options for authenticators" "SECID168"
23403 .cindex "authentication" "generic options"
23404 .cindex "options" "generic; for authenticators"
23405
23406 .option client_condition authenticators string&!! unset
23407 When Exim is authenticating as a client, it skips any authenticator whose
23408 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
23409 used, for example, to skip plain text authenticators when the connection is not
23410 encrypted by a setting such as:
23411 .code
23412 client_condition = ${if !eq{$tls_cipher}{}}
23413 .endd
23414 (Older documentation incorrectly states that &$tls_cipher$& contains the cipher
23415 used for incoming messages. In fact, during SMTP delivery, it contains the
23416 cipher used for the delivery.)
23417
23418
23419 .option driver authenticators string unset
23420 This option must always be set. It specifies which of the available
23421 authenticators is to be used.
23422
23423
23424 .option public_name authenticators string unset
23425 This option specifies the name of the authentication mechanism that the driver
23426 implements, and by which it is known to the outside world. These names should
23427 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
23428 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
23429 defaults to the driver's instance name.
23430
23431
23432 .option server_advertise_condition authenticators string&!! unset
23433 When a server is about to advertise an authentication mechanism, the condition
23434 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
23435 mechanism is not advertised.
23436 If the expansion fails, the mechanism is not advertised. If the failure was not
23437 forced, and was not caused by a lookup defer, the incident is logged.
23438 See section &<<SECTauthexiser>>& below for further discussion.
23439
23440
23441 .option server_condition authenticators string&!! unset
23442 This option must be set for a &%plaintext%& server authenticator, where it
23443 is used directly to control authentication. See section &<<SECTplainserver>>&
23444 for details.
23445
23446 For the other authenticators, &%server_condition%& can be used as an additional
23447 authentication or authorization mechanism that is applied after the other
23448 authenticator conditions succeed. If it is set, it is expanded when the
23449 authenticator would otherwise return a success code. If the expansion is forced
23450 to fail, authentication fails. Any other expansion failure causes a temporary
23451 error code to be returned. If the result of a successful expansion is an empty
23452 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23453 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
23454 other result, a temporary error code is returned, with the expanded string as
23455 the error text.
23456
23457
23458 .option server_debug_print authenticators string&!! unset
23459 If this option is set and authentication debugging is enabled (see the &%-d%&
23460 command line option), the string is expanded and included in the debugging
23461 output when the authenticator is run as a server. This can help with checking
23462 out the values of variables.
23463 If expansion of the string fails, the error message is written to the debugging
23464 output, and Exim carries on processing.
23465
23466
23467 .option server_set_id authenticators string&!! unset
23468 .vindex "&$authenticated_id$&"
23469 When an Exim server successfully authenticates a client, this string is
23470 expanded using data from the authentication, and preserved for any incoming
23471 messages in the variable &$authenticated_id$&. It is also included in the log
23472 lines for incoming messages. For example, a user/password authenticator
23473 configuration might preserve the user name that was used to authenticate, and
23474 refer to it subsequently during delivery of the message.
23475 If expansion fails, the option is ignored.
23476
23477
23478 .option server_mail_auth_condition authenticators string&!! unset
23479 This option allows a server to discard authenticated sender addresses supplied
23480 as part of MAIL commands in SMTP connections that are authenticated by the
23481 driver on which &%server_mail_auth_condition%& is set. The option is not used
23482 as part of the authentication process; instead its (unexpanded) value is
23483 remembered for later use.
23484 How it is used is described in the following section.
23485
23486
23487
23488
23489
23490 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
23491 .cindex "authentication" "sender; authenticated"
23492 .cindex "AUTH" "on MAIL command"
23493 When a client supplied an AUTH= item on a MAIL command, Exim applies
23494 the following checks before accepting it as the authenticated sender of the
23495 message:
23496
23497 .ilist
23498 If the connection is not using extended SMTP (that is, HELO was used rather
23499 than EHLO), the use of AUTH= is a syntax error.
23500 .next
23501 If the value of the AUTH= parameter is &"<>"&, it is ignored.
23502 .next
23503 .vindex "&$authenticated_sender$&"
23504 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
23505 running, the value of &$authenticated_sender$& is set to the value obtained
23506 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
23507 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
23508 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
23509 given for the MAIL command.
23510 .next
23511 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
23512 is accepted and placed in &$authenticated_sender$& only if the client has
23513 authenticated.
23514 .next
23515 If the AUTH= value was accepted by either of the two previous rules, and
23516 the client has authenticated, and the authenticator has a setting for the
23517 &%server_mail_auth_condition%&, the condition is checked at this point. The
23518 valued that was saved from the authenticator is expanded. If the expansion
23519 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
23520 &$authenticated_sender$& is deleted. If the expansion yields any other value,
23521 the value of &$authenticated_sender$& is retained and passed on with the
23522 message.
23523 .endlist
23524
23525
23526 When &$authenticated_sender$& is set for a message, it is passed on to other
23527 hosts to which Exim authenticates as a client. Do not confuse this value with
23528 &$authenticated_id$&, which is a string obtained from the authentication
23529 process, and which is not usually a complete email address.
23530
23531 .vindex "&$sender_address$&"
23532 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
23533 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
23534 therefore make use of &$authenticated_sender$&. The converse is not true: the
23535 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
23536 ACL is run.
23537
23538
23539
23540 .section "Authentication on an Exim server" "SECTauthexiser"
23541 .cindex "authentication" "on an Exim server"
23542 When Exim receives an EHLO command, it advertises the public names of those
23543 authenticators that are configured as servers, subject to the following
23544 conditions:
23545
23546 .ilist
23547 The client host must match &%auth_advertise_hosts%& (default *).
23548 .next
23549 It the &%server_advertise_condition%& option is set, its expansion must not
23550 yield the empty string, &"0"&, &"no"&, or &"false"&.
23551 .endlist
23552
23553 The order in which the authenticators are defined controls the order in which
23554 the mechanisms are advertised.
23555
23556 Some mail clients (for example, some versions of Netscape) require the user to
23557 provide a name and password for authentication whenever AUTH is advertised,
23558 even though authentication may not in fact be needed (for example, Exim may be
23559 set up to allow unconditional relaying from the client by an IP address check).
23560 You can make such clients more friendly by not advertising AUTH to them.
23561 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
23562 that runs for RCPT) to relay without authentication, you should set
23563 .code
23564 auth_advertise_hosts = ! 10.9.8.0/24
23565 .endd
23566 so that no authentication mechanisms are advertised to them.
23567
23568 The &%server_advertise_condition%& controls the advertisement of individual
23569 authentication mechanisms. For example, it can be used to restrict the
23570 advertisement of a particular mechanism to encrypted connections, by a setting
23571 such as:
23572 .code
23573 server_advertise_condition = ${if eq{$tls_cipher}{}{no}{yes}}
23574 .endd
23575 .vindex "&$tls_cipher$&"
23576 If the session is encrypted, &$tls_cipher$& is not empty, and so the expansion
23577 yields &"yes"&, which allows the advertisement to happen.
23578
23579 When an Exim server receives an AUTH command from a client, it rejects it
23580 immediately if AUTH was not advertised in response to an earlier EHLO
23581 command. This is the case if
23582
23583 .ilist
23584 The client host does not match &%auth_advertise_hosts%&; or
23585 .next
23586 No authenticators are configured with server options; or
23587 .next
23588 Expansion of &%server_advertise_condition%& blocked the advertising of all the
23589 server authenticators.
23590 .endlist
23591
23592
23593 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
23594 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
23595 AUTH is accepted from any client host.
23596
23597 If AUTH is not rejected by the ACL, Exim searches its configuration for a
23598 server authentication mechanism that was advertised in response to EHLO and
23599 that matches the one named in the AUTH command. If it finds one, it runs
23600 the appropriate authentication protocol, and authentication either succeeds or
23601 fails. If there is no matching advertised mechanism, the AUTH command is
23602 rejected with a 504 error.
23603
23604 .vindex "&$received_protocol$&"
23605 .vindex "&$sender_host_authenticated$&"
23606 When a message is received from an authenticated host, the value of
23607 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
23608 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
23609 public name) of the authenticator driver that successfully authenticated the
23610 client from which the message was received. This variable is empty if there was
23611 no successful authentication.
23612
23613
23614
23615
23616 .section "Testing server authentication" "SECID169"
23617 .cindex "authentication" "testing a server"
23618 .cindex "AUTH" "testing a server"
23619 .cindex "base64 encoding" "creating authentication test data"
23620 Exim's &%-bh%& option can be useful for testing server authentication
23621 configurations. The data for the AUTH command has to be sent using base64
23622 encoding. A quick way to produce such data for testing is the following Perl
23623 script:
23624 .code
23625 use MIME::Base64;
23626 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
23627 .endd
23628 .cindex "binary zero" "in authentication data"
23629 This interprets its argument as a Perl string, and then encodes it. The
23630 interpretation as a Perl string allows binary zeros, which are required for
23631 some kinds of authentication, to be included in the data. For example, a
23632 command line to run this script on such data might be
23633 .code
23634 encode '\0user\0password'
23635 .endd
23636 Note the use of single quotes to prevent the shell interpreting the
23637 backslashes, so that they can be interpreted by Perl to specify characters
23638 whose code value is zero.
23639
23640 &*Warning 1*&: If either of the user or password strings starts with an octal
23641 digit, you must use three zeros instead of one after the leading backslash. If
23642 you do not, the octal digit that starts your string will be incorrectly
23643 interpreted as part of the code for the first character.
23644
23645 &*Warning 2*&: If there are characters in the strings that Perl interprets
23646 specially, you must use a Perl escape to prevent them being misinterpreted. For
23647 example, a command such as
23648 .code
23649 encode '\0user@domain.com\0pas$$word'
23650 .endd
23651 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
23652
23653 If you have the &%mimencode%& command installed, another way to do produce
23654 base64-encoded strings is to run the command
23655 .code
23656 echo -e -n `\0user\0password' | mimencode
23657 .endd
23658 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
23659 in the argument, and the &%-n%& option specifies no newline at the end of its
23660 output. However, not all versions of &%echo%& recognize these options, so you
23661 should check your version before relying on this suggestion.
23662
23663
23664
23665 .section "Authentication by an Exim client" "SECID170"
23666 .cindex "authentication" "on an Exim client"
23667 The &(smtp)& transport has two options called &%hosts_require_auth%& and
23668 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
23669 announces support for authentication, and the host matches an entry in either
23670 of these options, Exim (as a client) tries to authenticate as follows:
23671
23672 .ilist
23673 For each authenticator that is configured as a client, in the order in which
23674 they are defined in the configuration, it searches the authentication
23675 mechanisms announced by the server for one whose name matches the public name
23676 of the authenticator.
23677 .next
23678 .vindex "&$host$&"
23679 .vindex "&$host_address$&"
23680 When it finds one that matches, it runs the authenticator's client code. The
23681 variables &$host$& and &$host_address$& are available for any string expansions
23682 that the client might do. They are set to the server's name and IP address. If
23683 any expansion is forced to fail, the authentication attempt is abandoned, and
23684 Exim moves on to the next authenticator. Otherwise an expansion failure causes
23685 delivery to be deferred.
23686 .next
23687 If the result of the authentication attempt is a temporary error or a timeout,
23688 Exim abandons trying to send the message to the host for the moment. It will
23689 try again later. If there are any backup hosts available, they are tried in the
23690 usual way.
23691 .next
23692 If the response to authentication is a permanent error (5&'xx'& code), Exim
23693 carries on searching the list of authenticators and tries another one if
23694 possible. If all authentication attempts give permanent errors, or if there are
23695 no attempts because no mechanisms match (or option expansions force failure),
23696 what happens depends on whether the host matches &%hosts_require_auth%& or
23697 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
23698 delivery is deferred. The error can be detected in the retry rules, and thereby
23699 turned into a permanent error if you wish. In the second case, Exim tries to
23700 deliver the message unauthenticated.
23701 .endlist
23702
23703 .cindex "AUTH" "on MAIL command"
23704 When Exim has authenticated itself to a remote server, it adds the AUTH
23705 parameter to the MAIL commands it sends, if it has an authenticated sender for
23706 the message. If the message came from a remote host, the authenticated sender
23707 is the one that was receiving on an incoming MAIL command, provided that the
23708 incoming connection was authenticated and the &%server_mail_auth%& condition
23709 allowed the authenticated sender to be retained. If a local process calls Exim
23710 to send a message, the sender address that is built from the login name and
23711 &%qualify_domain%& is treated as authenticated. However, if the
23712 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
23713 the authenticated sender that was received with the message.
23714 .ecindex IIDauthconf1
23715 .ecindex IIDauthconf2
23716
23717
23718
23719
23720
23721
23722 . ////////////////////////////////////////////////////////////////////////////
23723 . ////////////////////////////////////////////////////////////////////////////
23724
23725 .chapter "The plaintext authenticator" "CHAPplaintext"
23726 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
23727 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
23728 The &(plaintext)& authenticator can be configured to support the PLAIN and
23729 LOGIN authentication mechanisms, both of which transfer authentication data as
23730 plain (unencrypted) text (though base64 encoded). The use of plain text is a
23731 security risk; you are strongly advised to insist on the use of SMTP encryption
23732 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
23733 use unencrypted plain text, you should not use the same passwords for SMTP
23734 connections as you do for login accounts.
23735
23736 .section "Plaintext options" "SECID171"
23737 .cindex "options" "&(plaintext)& authenticator (server)"
23738 When configured as a server, &(plaintext)& uses the following options:
23739
23740 .option server_condition authenticators string&!! unset
23741 This is actually a global authentication option, but it must be set in order to
23742 configure the &(plaintext)& driver as a server. Its use is described below.
23743
23744 .option server_prompts plaintext string&!! unset
23745 The contents of this option, after expansion, must be a colon-separated list of
23746 prompt strings. If expansion fails, a temporary authentication rejection is
23747 given.
23748
23749 .section "Using plaintext in a server" "SECTplainserver"
23750 .cindex "AUTH" "in &(plaintext)& authenticator"
23751 .cindex "binary zero" "in &(plaintext)& authenticator"
23752 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
23753         "in &(plaintext)& authenticator"
23754 .vindex "&$auth1$&, &$auth2$&, etc"
23755 .cindex "base64 encoding" "in &(plaintext)& authenticator"
23756
23757 When running as a server, &(plaintext)& performs the authentication test by
23758 expanding a string. The data sent by the client with the AUTH command, or in
23759 response to subsequent prompts, is base64 encoded, and so may contain any byte
23760 values when decoded. If any data is supplied with the command, it is treated as
23761 a list of strings, separated by NULs (binary zeros), the first three of which
23762 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
23763 (neither LOGIN nor PLAIN uses more than three strings).
23764
23765 For compatibility with previous releases of Exim, the values are also placed in
23766 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
23767 variables for this purpose is now deprecated, as it can lead to confusion in
23768 string expansions that also use them for other things.
23769
23770 If there are more strings in &%server_prompts%& than the number of strings
23771 supplied with the AUTH command, the remaining prompts are used to obtain more
23772 data. Each response from the client may be a list of NUL-separated strings.
23773
23774 .vindex "&$authenticated_id$&"
23775 Once a sufficient number of data strings have been received,
23776 &%server_condition%& is expanded. If the expansion is forced to fail,
23777 authentication fails. Any other expansion failure causes a temporary error code
23778 to be returned. If the result of a successful expansion is an empty string,
23779 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23780 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
23781 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
23782 For any other result, a temporary error code is returned, with the expanded
23783 string as the error text.
23784
23785 &*Warning*&: If you use a lookup in the expansion to find the user's
23786 password, be sure to make the authentication fail if the user is unknown.
23787 There are good and bad examples at the end of the next section.
23788
23789
23790
23791 .section "The PLAIN authentication mechanism" "SECID172"
23792 .cindex "PLAIN authentication mechanism"
23793 .cindex "authentication" "PLAIN mechanism"
23794 .cindex "binary zero" "in &(plaintext)& authenticator"
23795 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
23796 sent as one item of data (that is, one combined string containing two NUL
23797 separators). The data is sent either as part of the AUTH command, or
23798 subsequently in response to an empty prompt from the server.
23799
23800 The second and third strings are a user name and a corresponding password.
23801 Using a single fixed user name and password as an example, this could be
23802 configured as follows:
23803 .code
23804 fixed_plain:
23805   driver = plaintext
23806   public_name = PLAIN
23807   server_prompts = :
23808   server_condition = \
23809     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
23810   server_set_id = $auth2
23811 .endd
23812 Note that the default result strings from &%if%& (&"true"& or an empty string)
23813 are exactly what we want here, so they need not be specified. Obviously, if the
23814 password contains expansion-significant characters such as dollar, backslash,
23815 or closing brace, they have to be escaped.
23816
23817 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
23818 the end of a string list are ignored). If all the data comes as part of the
23819 AUTH command, as is commonly the case, the prompt is not used. This
23820 authenticator is advertised in the response to EHLO as
23821 .code
23822 250-AUTH PLAIN
23823 .endd
23824 and a client host can authenticate itself by sending the command
23825 .code
23826 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
23827 .endd
23828 As this contains three strings (more than the number of prompts), no further
23829 data is required from the client. Alternatively, the client may just send
23830 .code
23831 AUTH PLAIN
23832 .endd
23833 to initiate authentication, in which case the server replies with an empty
23834 prompt. The client must respond with the combined data string.
23835
23836 The data string is base64 encoded, as required by the RFC. This example,
23837 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
23838 represents a zero byte. This is split up into three strings, the first of which
23839 is empty. The &%server_condition%& option in the authenticator checks that the
23840 second two are &`username`& and &`mysecret`& respectively.
23841
23842 Having just one fixed user name and password, as in this example, is not very
23843 realistic, though for a small organization with only a handful of
23844 authenticating clients it could make sense.
23845
23846 A more sophisticated instance of this authenticator could use the user name in
23847 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
23848 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
23849 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
23850 This is an incorrect example:
23851 .code
23852 server_condition = \
23853   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
23854 .endd
23855 The expansion uses the user name (&$auth2$&) as the key to look up a password,
23856 which it then compares to the supplied password (&$auth3$&). Why is this example
23857 incorrect? It works fine for existing users, but consider what happens if a
23858 non-existent user name is given. The lookup fails, but as no success/failure
23859 strings are given for the lookup, it yields an empty string. Thus, to defeat
23860 the authentication, all a client has to do is to supply a non-existent user
23861 name and an empty password. The correct way of writing this test is:
23862 .code
23863 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
23864   {${if eq{$value}{$auth3}}} {false}}
23865 .endd
23866 In this case, if the lookup succeeds, the result is checked; if the lookup
23867 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
23868 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
23869 always fails if its second argument is empty. However, the second way of
23870 writing the test makes the logic clearer.
23871
23872
23873 .section "The LOGIN authentication mechanism" "SECID173"
23874 .cindex "LOGIN authentication mechanism"
23875 .cindex "authentication" "LOGIN mechanism"
23876 The LOGIN authentication mechanism is not documented in any RFC, but is in use
23877 in a number of programs. No data is sent with the AUTH command. Instead, a
23878 user name and password are supplied separately, in response to prompts. The
23879 plaintext authenticator can be configured to support this as in this example:
23880 .code
23881 fixed_login:
23882   driver = plaintext
23883   public_name = LOGIN
23884   server_prompts = User Name : Password
23885   server_condition = \
23886     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
23887   server_set_id = $auth1
23888 .endd
23889 Because of the way plaintext operates, this authenticator accepts data supplied
23890 with the AUTH command (in contravention of the specification of LOGIN), but
23891 if the client does not supply it (as is the case for LOGIN clients), the prompt
23892 strings are used to obtain two data items.
23893
23894 .new
23895 Some clients are very particular about the precise text of the prompts. For
23896 example, Outlook Express is reported to recognize only &"Username:"& and
23897 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
23898 strings. It uses the &%ldapauth%& expansion condition to check the user
23899 name and password by binding to an LDAP server:
23900 .code
23901 login:
23902   driver = plaintext
23903   public_name = LOGIN
23904   server_prompts = Username:: : Password::
23905   server_condition = ${if and{{ \
23906     !eq{}{$auth1} }{ \
23907     ldapauth{user="cn=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
23908              pass=${quote:$auth2} \
23909              ldap://ldap.example.org/} }} }
23910   server_set_id = uid=$auth1,ou=people,o=example.org
23911 .endd
23912 We have to check that the username is not empty before using it, because LDAP
23913 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
23914 operator to correctly quote the DN for authentication. However, the basic
23915 &%quote%& operator, rather than any of the LDAP quoting operators, is the
23916 correct one to use for the password, because quoting is needed only to make
23917 the password conform to the Exim syntax. At the LDAP level, the password is an
23918 uninterpreted string.
23919 .wen
23920
23921 .section "Support for different kinds of authentication" "SECID174"
23922 A number of string expansion features are provided for the purpose of
23923 interfacing to different ways of user authentication. These include checking
23924 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
23925 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
23926 &<<SECTexpcond>>&.
23927
23928
23929
23930
23931 .section "Using plaintext in a client" "SECID175"
23932 .cindex "options" "&(plaintext)& authenticator (client)"
23933 The &(plaintext)& authenticator has two client options:
23934
23935 .option client_ignore_invalid_base64 plaintext boolean false
23936 If the client receives a server prompt that is not a valid base64 string,
23937 authentication is abandoned by default. However, if this option is set true,
23938 the error in the challenge is ignored and the client sends the response as
23939 usual.
23940
23941 .option client_send plaintext string&!! unset
23942 The string is a colon-separated list of authentication data strings. Each
23943 string is independently expanded before being sent to the server. The first
23944 string is sent with the AUTH command; any more strings are sent in response
23945 to prompts from the server. Before each string is expanded, the value of the
23946 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
23947 with &$auth1$& for the first prompt. Up to three prompts are stored in this
23948 way. Thus, the prompt that is received in response to sending the first string
23949 (with the AUTH command) can be used in the expansion of the second string, and
23950 so on. If an invalid base64 string is received when
23951 &%client_ignore_invalid_base64%& is set, an empty string is put in the
23952 &$auth$&<&'n'&> variable.
23953
23954 &*Note*&: You cannot use expansion to create multiple strings, because
23955 splitting takes priority and happens first.
23956
23957 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
23958 the data, further processing is applied to each string before it is sent. If
23959 there are any single circumflex characters in the string, they are converted to
23960 NULs. Should an actual circumflex be required as data, it must be doubled in
23961 the string.
23962
23963 This is an example of a client configuration that implements the PLAIN
23964 authentication mechanism with a fixed user name and password:
23965 .code
23966 fixed_plain:
23967   driver = plaintext
23968   public_name = PLAIN
23969   client_send = ^username^mysecret
23970 .endd
23971 The lack of colons means that the entire text is sent with the AUTH
23972 command, with the circumflex characters converted to NULs. A similar example
23973 that uses the LOGIN mechanism is:
23974 .code
23975 fixed_login:
23976   driver = plaintext
23977   public_name = LOGIN
23978   client_send = : username : mysecret
23979 .endd
23980 The initial colon means that the first string is empty, so no data is sent with
23981 the AUTH command itself. The remaining strings are sent in response to
23982 prompts.
23983 .ecindex IIDplaiauth1
23984 .ecindex IIDplaiauth2
23985
23986
23987
23988
23989 . ////////////////////////////////////////////////////////////////////////////
23990 . ////////////////////////////////////////////////////////////////////////////
23991
23992 .chapter "The cram_md5 authenticator" "CHID9"
23993 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
23994 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
23995 .cindex "CRAM-MD5 authentication mechanism"
23996 .cindex "authentication" "CRAM-MD5 mechanism"
23997 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
23998 sends a challenge string to the client, and the response consists of a user
23999 name and the CRAM-MD5 digest of the challenge string combined with a secret
24000 string (password) which is known to both server and client. Thus, the secret
24001 is not sent over the network as plain text, which makes this authenticator more
24002 secure than &(plaintext)&. However, the downside is that the secret has to be
24003 available in plain text at either end.
24004
24005
24006 .section "Using cram_md5 as a server" "SECID176"
24007 .cindex "options" "&(cram_md5)& authenticator (server)"
24008 This authenticator has one server option, which must be set to configure the
24009 authenticator as a server:
24010
24011 .option server_secret cram_md5 string&!! unset
24012 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
24013 When the server receives the client's response, the user name is placed in
24014 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
24015 obtain the password for that user. The server then computes the CRAM-MD5 digest
24016 that the client should have sent, and checks that it received the correct
24017 string. If the expansion of &%server_secret%& is forced to fail, authentication
24018 fails. If the expansion fails for some other reason, a temporary error code is
24019 returned to the client.
24020
24021 For compatibility with previous releases of Exim, the user name is also placed
24022 in &$1$&. However, the use of this variables for this purpose is now
24023 deprecated, as it can lead to confusion in string expansions that also use
24024 numeric variables for other things.
24025
24026 For example, the following authenticator checks that the user name given by the
24027 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
24028 user name, authentication fails.
24029 .code
24030 fixed_cram:
24031   driver = cram_md5
24032   public_name = CRAM-MD5
24033   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
24034   server_set_id = $auth1
24035 .endd
24036 .vindex "&$authenticated_id$&"
24037 If authentication succeeds, the setting of &%server_set_id%& preserves the user
24038 name in &$authenticated_id$&. A more typical configuration might look up the
24039 secret string in a file, using the user name as the key. For example:
24040 .code
24041 lookup_cram:
24042   driver = cram_md5
24043   public_name = CRAM-MD5
24044   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
24045                   {$value}fail}
24046   server_set_id = $auth1
24047 .endd
24048 Note that this expansion explicitly forces failure if the lookup fails
24049 because &$auth1$& contains an unknown user name.
24050
24051
24052 .section "Using cram_md5 as a client" "SECID177"
24053 .cindex "options" "&(cram_md5)& authenticator (client)"
24054 When used as a client, the &(cram_md5)& authenticator has two options:
24055
24056
24057
24058 .option client_name cram_md5 string&!! "the primary host name"
24059 This string is expanded, and the result used as the user name data when
24060 computing the response to the server's challenge.
24061
24062
24063 .option client_secret cram_md5 string&!! unset
24064 This option must be set for the authenticator to work as a client. Its value is
24065 expanded and the result used as the secret string when computing the response.
24066
24067
24068 .vindex "&$host$&"
24069 .vindex "&$host_address$&"
24070 Different user names and secrets can be used for different servers by referring
24071 to &$host$& or &$host_address$& in the options. Forced failure of either
24072 expansion string is treated as an indication that this authenticator is not
24073 prepared to handle this case. Exim moves on to the next configured client
24074 authenticator. Any other expansion failure causes Exim to give up trying to
24075 send the message to the current server.
24076
24077 A simple example configuration of a &(cram_md5)& authenticator, using fixed
24078 strings, is:
24079 .code
24080 fixed_cram:
24081   driver = cram_md5
24082   public_name = CRAM-MD5
24083   client_name = ph10
24084   client_secret = secret
24085 .endd
24086 .ecindex IIDcramauth1
24087 .ecindex IIDcramauth2
24088
24089
24090
24091 . ////////////////////////////////////////////////////////////////////////////
24092 . ////////////////////////////////////////////////////////////////////////////
24093
24094 .chapter "The cyrus_sasl authenticator" "CHID10"
24095 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
24096 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
24097 .cindex "Cyrus" "SASL library"
24098 .cindex "Kerberos"
24099 The code for this authenticator was provided by Matthew Byng-Maddick of A L
24100 Digital Ltd (&url(http://www.aldigital.co.uk)).
24101
24102 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
24103 library implementation of the RFC 2222 (&"Simple Authentication and Security
24104 Layer"&). This library supports a number of authentication mechanisms,
24105 including PLAIN and LOGIN, but also several others that Exim does not support
24106 directly. In particular, there is support for Kerberos authentication.
24107
24108 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
24109 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
24110 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
24111 name of the driver to determine which mechanism to support.
24112
24113 Where access to some kind of secret file is required, for example in GSSAPI
24114 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
24115 user, and that the Cyrus SASL library has no way of escalating privileges
24116 by default. You may also find you need to set environment variables,
24117 depending on the driver you are using.
24118
24119 The application name provided by Exim is &"exim"&, so various SASL options may
24120 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
24121 Kerberos, note that because of limitations in the GSSAPI interface,
24122 changing the server keytab might need to be communicated down to the Kerberos
24123 layer independently. The mechanism for doing so is dependent upon the Kerberos
24124 implementation. For example, for Heimdal, the environment variable KRB5_KTNAME
24125 may be set to point to an alternative keytab file. Exim will pass this
24126 variable through from its own inherited environment when started as root or the
24127 Exim user. The keytab file needs to be readable by the Exim user.
24128
24129
24130 .section "Using cyrus_sasl as a server" "SECID178"
24131 The &(cyrus_sasl)& authenticator has four private options. It puts the username
24132 (on a successful authentication) into &$auth1$&. For compatibility with
24133 previous releases of Exim, the username is also placed in &$1$&. However, the
24134 use of this variable for this purpose is now deprecated, as it can lead to
24135 confusion in string expansions that also use numeric variables for other
24136 things.
24137
24138
24139 .option server_hostname cyrus_sasl string&!! "see below"
24140 This option selects the hostname that is used when communicating with the
24141 library. The default value is &`$primary_hostname`&. It is up to the underlying
24142 SASL plug-in what it does with this data.
24143
24144
24145 .option server_mech cyrus_sasl string "see below"
24146 This option selects the authentication mechanism this driver should use. The
24147 default is the value of the generic &%public_name%& option. This option allows
24148 you to use a different underlying mechanism from the advertised name. For
24149 example:
24150 .code
24151 sasl:
24152   driver = cyrus_sasl
24153   public_name = X-ANYTHING
24154   server_mech = CRAM-MD5
24155   server_set_id = $auth1
24156 .endd
24157
24158 .option server_realm cyrus_sasl string unset
24159 This specifies the SASL realm that the server claims to be in.
24160
24161
24162 .option server_service cyrus_sasl string &`smtp`&
24163 This is the SASL service that the server claims to implement.
24164
24165
24166 For straightforward cases, you do not need to set any of the authenticator's
24167 private options. All you need to do is to specify an appropriate mechanism as
24168 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
24169 PLAIN, you could have two authenticators as follows:
24170 .code
24171 sasl_cram_md5:
24172   driver = cyrus_sasl
24173   public_name = CRAM-MD5
24174   server_set_id = $auth1
24175
24176 sasl_plain:
24177   driver = cyrus_sasl
24178   public_name = PLAIN
24179   server_set_id = $auth2
24180 .endd
24181 Cyrus SASL does implement the LOGIN authentication method, even though it is
24182 not a standard method. It is disabled by default in the source distribution,
24183 but it is present in many binary distributions.
24184 .ecindex IIDcyrauth1
24185 .ecindex IIDcyrauth2
24186
24187
24188
24189
24190 . ////////////////////////////////////////////////////////////////////////////
24191 . ////////////////////////////////////////////////////////////////////////////
24192 .chapter "The dovecot authenticator" "CHAPdovecot"
24193 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
24194 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
24195 This authenticator is an interface to the authentication facility of the
24196 Dovecot POP/IMAP server, which can support a number of authentication methods.
24197 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
24198 to use the same mechanisms for SMTP authentication. This is a server
24199 authenticator only. There is only one option:
24200
24201 .option server_socket dovecot string unset
24202
24203 This option must specify the socket that is the interface to Dovecot
24204 authentication. The &%public_name%& option must specify an authentication
24205 mechanism that Dovecot is configured to support. You can have several
24206 authenticators for different mechanisms. For example:
24207 .code
24208 dovecot_plain:
24209   driver = dovecot
24210   public_name = PLAIN
24211   server_socket = /var/run/dovecot/auth-client
24212   server_set_id = $auth2
24213
24214 dovecot_ntlm:
24215   driver = dovecot
24216   public_name = NTLM
24217   server_socket = /var/run/dovecot/auth-client
24218   server_set_id = $auth1
24219 .endd
24220 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
24221 &$received_ip_address$& (that is, the connection is local), the &"secured"&
24222 option is passed in the Dovecot authentication command. If, for a TLS
24223 connection, a client certificate has been verified, the &"valid-client-cert"&
24224 option is passed. When authentication succeeds, the identity of the user
24225 who authenticated is placed in &$auth1$&.
24226 .ecindex IIDdcotauth1
24227 .ecindex IIDdcotauth2
24228
24229
24230 . ////////////////////////////////////////////////////////////////////////////
24231 . ////////////////////////////////////////////////////////////////////////////
24232
24233 .chapter "The spa authenticator" "CHAPspa"
24234 .scindex IIDspaauth1 "&(spa)& authenticator"
24235 .scindex IIDspaauth2 "authenticators" "&(spa)&"
24236 .cindex "authentication" "Microsoft Secure Password"
24237 .cindex "authentication" "NTLM"
24238 .cindex "Microsoft Secure Password Authentication"
24239 .cindex "NTLM authentication"
24240 The &(spa)& authenticator provides client support for Microsoft's &'Secure
24241 Password Authentication'& mechanism,
24242 which is also sometimes known as NTLM (NT LanMan). The code for client side of
24243 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
24244 taken from the Samba project (&url(http://www.samba.org)). The code for the
24245 server side was subsequently contributed by Tom Kistner. The mechanism works as
24246 follows:
24247
24248 .ilist
24249 After the AUTH command has been accepted, the client sends an SPA
24250 authentication request based on the user name and optional domain.
24251 .next
24252 The server sends back a challenge.
24253 .next
24254 The client builds a challenge response which makes use of the user's password
24255 and sends it to the server, which then accepts or rejects it.
24256 .endlist
24257
24258 Encryption is used to protect the password in transit.
24259
24260
24261
24262 .section "Using spa as a server" "SECID179"
24263 .cindex "options" "&(spa)& authenticator (server)"
24264 The &(spa)& authenticator has just one server option:
24265
24266 .option server_password spa string&!! unset
24267 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
24268 This option is expanded, and the result must be the cleartext password for the
24269 authenticating user, whose name is at this point in &$auth1$&. For
24270 compatibility with previous releases of Exim, the user name is also placed in
24271 &$1$&. However, the use of this variable for this purpose is now deprecated, as
24272 it can lead to confusion in string expansions that also use numeric variables
24273 for other things. For example:
24274 .code
24275 spa:
24276   driver = spa
24277   public_name = NTLM
24278   server_password = \
24279     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
24280 .endd
24281 If the expansion is forced to fail, authentication fails. Any other expansion
24282 failure causes a temporary error code to be returned.
24283
24284
24285
24286
24287
24288 .section "Using spa as a client" "SECID180"
24289 .cindex "options" "&(spa)& authenticator (client)"
24290 The &(spa)& authenticator has the following client options:
24291
24292
24293
24294 .option client_domain spa string&!! unset
24295 This option specifies an optional domain for the authentication.
24296
24297
24298 .option client_password spa string&!! unset
24299 This option specifies the user's password, and must be set.
24300
24301
24302 .option client_username spa string&!! unset
24303 This option specifies the user name, and must be set. Here is an example of a
24304 configuration of this authenticator for use with the mail servers at
24305 &'msn.com'&:
24306 .code
24307 msn:
24308   driver = spa
24309   public_name = MSN
24310   client_username = msn/msn_username
24311   client_password = msn_plaintext_password
24312   client_domain = DOMAIN_OR_UNSET
24313 .endd
24314 .ecindex IIDspaauth1
24315 .ecindex IIDspaauth2
24316
24317
24318
24319
24320
24321 . ////////////////////////////////////////////////////////////////////////////
24322 . ////////////////////////////////////////////////////////////////////////////
24323
24324 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
24325          "Encrypted SMTP connections"
24326 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
24327 .scindex IIDencsmtp2 "SMTP" "encryption"
24328 .cindex "TLS" "on SMTP connection"
24329 .cindex "OpenSSL"
24330 .cindex "GnuTLS"
24331 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
24332 Sockets Layer), is implemented by making use of the OpenSSL library or the
24333 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
24334 cryptographic code in the Exim distribution itself for implementing TLS. In
24335 order to use this feature you must install OpenSSL or GnuTLS, and then build a
24336 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
24337 You also need to understand the basic concepts of encryption at a managerial
24338 level, and in particular, the way that public keys, private keys, and
24339 certificates are used.
24340
24341 RFC 3207 defines how SMTP connections can make use of encryption. Once a
24342 connection is established, the client issues a STARTTLS command. If the
24343 server accepts this, the client and the server negotiate an encryption
24344 mechanism. If the negotiation succeeds, the data that subsequently passes
24345 between them is encrypted.
24346
24347 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
24348 and if so, what cipher suite is in use, whether the client supplied a
24349 certificate, and whether or not that certificate was verified. This makes it
24350 possible for an Exim server to deny or accept certain commands based on the
24351 encryption state.
24352
24353 &*Warning*&: Certain types of firewall and certain anti-virus products can
24354 disrupt TLS connections. You need to turn off SMTP scanning for these products
24355 in order to get TLS to work.
24356
24357
24358
24359 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
24360          "SECID284"
24361 .cindex "ssmtp protocol"
24362 .cindex "smtps protocol"
24363 .cindex "SMTP" "ssmtp protocol"
24364 .cindex "SMTP" "smtps protocol"
24365 Early implementations of encrypted SMTP used a different TCP port from normal
24366 SMTP, and expected an encryption negotiation to start immediately, instead of
24367 waiting for a STARTTLS command from the client using the standard SMTP
24368 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
24369 allocated for this purpose.
24370
24371 This approach was abandoned when encrypted SMTP was standardized, but there are
24372 still some legacy clients that use it. Exim supports these clients by means of
24373 the &%tls_on_connect_ports%& global option. Its value must be a list of port
24374 numbers; the most common use is expected to be:
24375 .code
24376 tls_on_connect_ports = 465
24377 .endd
24378 The port numbers specified by this option apply to all SMTP connections, both
24379 via the daemon and via &'inetd'&. You still need to specify all the ports that
24380 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
24381 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
24382 an extra port &-- rather, it specifies different behaviour on a port that is
24383 defined elsewhere.
24384
24385 There is also a &%-tls-on-connect%& command line option. This overrides
24386 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
24387
24388
24389
24390
24391
24392
24393 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
24394 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
24395 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
24396 followed later, when the first versions of GnuTLS were released. To build Exim
24397 to use GnuTLS, you need to set
24398 .code
24399 USE_GNUTLS=yes
24400 .endd
24401 in Local/Makefile, in addition to
24402 .code
24403 SUPPORT_TLS=yes
24404 .endd
24405 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
24406 include files and libraries for GnuTLS can be found.
24407
24408 There are some differences in usage when using GnuTLS instead of OpenSSL:
24409
24410 .ilist
24411 The &%tls_verify_certificates%& option must contain the name of a file, not the
24412 name of a directory (for OpenSSL it can be either).
24413 .next
24414 The &%tls_dhparam%& option is ignored, because early versions of GnuTLS had no
24415 facility for varying its Diffie-Hellman parameters. I understand that this has
24416 changed, but Exim has not been updated to provide this facility.
24417 .next
24418 .vindex "&$tls_peerdn$&"
24419 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
24420 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
24421 affects the value of the &$tls_peerdn$& variable.
24422 .next
24423 OpenSSL identifies cipher suites using hyphens as separators, for example:
24424 DES-CBC3-SHA. GnuTLS uses underscores, for example: RSA_ARCFOUR_SHA. What is
24425 more, OpenSSL complains if underscores are present in a cipher list. To make
24426 life simpler, Exim changes underscores to hyphens for OpenSSL and hyphens to
24427 underscores for GnuTLS when processing lists of cipher suites in the
24428 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
24429 option).
24430 .next
24431 The &%tls_require_ciphers%& options operate differently, as described in the
24432 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
24433 .endlist
24434
24435
24436 .section "GnuTLS parameter computation" "SECID181"
24437 GnuTLS uses D-H parameters that may take a substantial amount of time
24438 to compute. It is unreasonable to re-compute them for every TLS session.
24439 Therefore, Exim keeps this data in a file in its spool directory, called
24440 &_gnutls-params_&. The file is owned by the Exim user and is readable only by
24441 its owner. Every Exim process that start up GnuTLS reads the D-H
24442 parameters from this file. If the file does not exist, the first Exim process
24443 that needs it computes the data and writes it to a temporary file which is
24444 renamed once it is complete. It does not matter if several Exim processes do
24445 this simultaneously (apart from wasting a few resources). Once a file is in
24446 place, new Exim processes immediately start using it.
24447
24448 For maximum security, the parameters that are stored in this file should be
24449 recalculated periodically, the frequency depending on your paranoia level.
24450 Arranging this is easy in principle; just delete the file when you want new
24451 values to be computed. However, there may be a problem. The calculation of new
24452 parameters needs random numbers, and these are obtained from &_/dev/random_&.
24453 If the system is not very active, &_/dev/random_& may delay returning data
24454 until enough randomness (entropy) is available. This may cause Exim to hang for
24455 a substantial amount of time, causing timeouts on incoming connections.
24456
24457 The solution is to generate the parameters externally to Exim. They are stored
24458 in &_gnutls-params_& in PEM format, which means that they can be generated
24459 externally using the &(certtool)& command that is part of GnuTLS.
24460
24461 To replace the parameters with new ones, instead of deleting the file
24462 and letting Exim re-create it, you can generate new parameters using
24463 &(certtool)& and, when this has been done, replace Exim's cache file by
24464 renaming. The relevant commands are something like this:
24465 .code
24466 # rm -f new-params
24467 # touch new-params
24468 # chown exim:exim new-params
24469 # chmod 0400 new-params
24470 # certtool --generate-privkey --bits 512 >new-params
24471 # echo "" >>new-params
24472 # certtool --generate-dh-params --bits 1024 >> new-params
24473 # mv new-params gnutls-params
24474 .endd
24475 If Exim never has to generate the parameters itself, the possibility of
24476 stalling is removed.
24477
24478
24479 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
24480 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
24481 .oindex "&%tls_require_ciphers%&" "OpenSSL"
24482 There is a function in the OpenSSL library that can be passed a list of cipher
24483 suites before the cipher negotiation takes place. This specifies which ciphers
24484 are acceptable. The list is colon separated and may contain names like
24485 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
24486 directly to this function call. The following quotation from the OpenSSL
24487 documentation specifies what forms of item are allowed in the cipher string:
24488
24489 .ilist
24490 It can consist of a single cipher suite such as RC4-SHA.
24491 .next
24492 It can represent a list of cipher suites containing a certain algorithm,
24493 or cipher suites of a certain type. For example SHA1 represents all
24494 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
24495 SSL v3 algorithms.
24496 .next
24497 Lists of cipher suites can be combined in a single cipher string using
24498 the + character. This is used as a logical and operation. For example
24499 SHA1+DES represents all cipher suites containing the SHA1 and the DES
24500 algorithms.
24501 .endlist
24502
24503 Each cipher string can be optionally preceded by one of the characters &`!`&,
24504 &`-`& or &`+`&.
24505 .ilist
24506 If &`!`& is used, the ciphers are permanently deleted from the list. The
24507 ciphers deleted can never reappear in the list even if they are explicitly
24508 stated.
24509 .next
24510 If &`-`& is used, the ciphers are deleted from the list, but some or all
24511 of the ciphers can be added again by later options.
24512 .next
24513 If &`+`& is used, the ciphers are moved to the end of the list. This
24514 option does not add any new ciphers; it just moves matching existing ones.
24515 .endlist
24516
24517 If none of these characters is present, the string is interpreted as
24518 a list of ciphers to be appended to the current preference list. If the list
24519 includes any ciphers already present they will be ignored: that is, they will
24520 not be moved to the end of the list.
24521 .endlist
24522
24523
24524
24525 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
24526          "SECTreqciphgnu"
24527 .cindex "GnuTLS" "specifying parameters for"
24528 .cindex "TLS" "specifying ciphers (GnuTLS)"
24529 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
24530 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
24531 .cindex "TLS" "specifying protocols (GnuTLS)"
24532 .oindex "&%tls_require_ciphers%&" "GnuTLS"
24533 The GnuTLS library allows the caller to specify separate lists of permitted key
24534 exchange methods, main cipher algorithms, MAC algorithms, and protocols.
24535 Unfortunately, these lists are numerical, and the library does not have a
24536 function for turning names into numbers. Consequently, lists of recognized
24537 names have to be built into the application. The permitted key exchange
24538 methods, ciphers, and MAC algorithms may be used in any combination to form a
24539 cipher suite. This is unlike OpenSSL, where complete cipher suite names are
24540 passed to its control function.
24541
24542 For compatibility with OpenSSL, the &%tls_require_ciphers%& option can be set
24543 to complete cipher suite names such as RSA_ARCFOUR_SHA, but for GnuTLS this
24544 option controls only the cipher algorithms. Exim searches each item in the
24545 list for the name of an available algorithm. For example, if the list
24546 contains RSA_AES_SHA, then AES is recognized, and the behaviour is exactly
24547 the same as if just AES were given.
24548
24549 .oindex "&%gnutls_require_kx%&"
24550 .oindex "&%gnutls_require_mac%&"
24551 .oindex "&%gnutls_require_protocols%&"
24552 There are additional options called &%gnutls_require_kx%&,
24553 &%gnutls_require_mac%&, and &%gnutls_require_protocols%& that can be used to
24554 restrict the key exchange methods, MAC algorithms, and protocols, respectively.
24555 These options are ignored if OpenSSL is in use.
24556
24557 All four options are available as global options, controlling how Exim
24558 behaves as a server, and also as options of the &(smtp)& transport, controlling
24559 how Exim behaves as a client. All the values are string expanded. After
24560 expansion, the values must be colon-separated lists, though the separator
24561 can be changed in the usual way.
24562
24563 Each of the four lists starts out with a default set of algorithms. If the
24564 first item in a list does &'not'& start with an exclamation mark, all the
24565 default items are deleted. In this case, only those that are explicitly
24566 specified can be used. If the first item in a list &'does'& start with an
24567 exclamation mark, the defaults are left on the list.
24568
24569 Then, any item that starts with an exclamation mark causes the relevant
24570 entry to be removed from the list, and any item that does not start with an
24571 exclamation mark causes a new entry to be added to the list. Unrecognized
24572 items in the list are ignored. Thus:
24573 .code
24574 tls_require_ciphers = !ARCFOUR
24575 .endd
24576 allows all the defaults except ARCFOUR, whereas
24577 .code
24578 tls_require_ciphers = AES : 3DES
24579 .endd
24580 allows only cipher suites that use AES or 3DES.
24581
24582 For &%tls_require_ciphers%& the recognized names are AES_256, AES_128, AES
24583 (both of the preceding), 3DES, ARCFOUR_128, ARCFOUR_40, and ARCFOUR (both of
24584 the preceding). The default list does not contain all of these; it just has
24585 AES_256, AES_128, 3DES, and ARCFOUR_128.
24586
24587 For &%gnutls_require_kx%&, the recognized names are DHE_RSA, RSA (which
24588 includes DHE_RSA), DHE_DSS, and DHE (which includes both DHE_RSA and
24589 DHE_DSS). The default list contains RSA, DHE_DSS, DHE_RSA.
24590
24591 For &%gnutls_require_mac%&, the recognized names are SHA (synonym SHA1), and
24592 MD5. The default list contains SHA, MD5.
24593
24594 For &%gnutls_require_protocols%&, the recognized names are TLS1 and SSL3.
24595 The default list contains TLS1, SSL3.
24596
24597 In a server, the order of items in these lists is unimportant. The server
24598 advertises the availability of all the relevant cipher suites. However, in a
24599 client, the order in the &%tls_require_ciphers%& list specifies a preference
24600 order for the cipher algorithms. The first one in the client's list that is
24601 also advertised by the server is tried first. The default order is as listed
24602 above.
24603
24604
24605
24606 .section "Configuring an Exim server to use TLS" "SECID182"
24607 .cindex "TLS" "configuring an Exim server"
24608 When Exim has been built with TLS support, it advertises the availability of
24609 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
24610 but not to any others. The default value of this option is unset, which means
24611 that STARTTLS is not advertised at all. This default is chosen because you
24612 need to set some other options in order to make TLS available, and also it is
24613 sensible for systems that want to use TLS only as a client.
24614
24615 If a client issues a STARTTLS command and there is some configuration
24616 problem in the server, the command is rejected with a 454 error. If the client
24617 persists in trying to issue SMTP commands, all except QUIT are rejected
24618 with the error
24619 .code
24620 554 Security failure
24621 .endd
24622 If a STARTTLS command is issued within an existing TLS session, it is
24623 rejected with a 554 error code.
24624
24625 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
24626 match some hosts. You can, of course, set it to * to match all hosts.
24627 However, this is not all you need to do. TLS sessions to a server won't work
24628 without some further configuration at the server end.
24629
24630 It is rumoured that all existing clients that support TLS/SSL use RSA
24631 encryption. To make this work you need to set, in the server,
24632 .code
24633 tls_certificate = /some/file/name
24634 tls_privatekey = /some/file/name
24635 .endd
24636 These options are, in fact, expanded strings, so you can make them depend on
24637 the identity of the client that is connected if you wish. The first file
24638 contains the server's X509 certificate, and the second contains the private key
24639 that goes with it. These files need to be readable by the Exim user, and must
24640 always be given as full path names. They can be the same file if both the
24641 certificate and the key are contained within it. If &%tls_privatekey%& is not
24642 set, or if its expansion is forced to fail or results in an empty string, this
24643 is assumed to be the case. The certificate file may also contain intermediate
24644 certificates that need to be sent to the client to enable it to authenticate
24645 the server's certificate.
24646
24647 If you do not understand about certificates and keys, please try to find a
24648 source of this background information, which is not Exim-specific. (There are a
24649 few comments below in section &<<SECTcerandall>>&.)
24650
24651 &*Note*&: These options do not apply when Exim is operating as a client &--
24652 they apply only in the case of a server. If you need to use a certificate in an
24653 Exim client, you must set the options of the same names in an &(smtp)&
24654 transport.
24655
24656 With just these options, an Exim server will be able to use TLS. It does not
24657 require the client to have a certificate (but see below for how to insist on
24658 this). There is one other option that may be needed in other situations. If
24659 .code
24660 tls_dhparam = /some/file/name
24661 .endd
24662 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
24663 with the parameters contained in the file. This increases the set of cipher
24664 suites that the server supports. See the command
24665 .code
24666 openssl dhparam
24667 .endd
24668 for a way of generating this data. At present, &%tls_dhparam%& is used only
24669 when Exim is linked with OpenSSL. It is ignored if GnuTLS is being used.
24670
24671 The strings supplied for these three options are expanded every time a client
24672 host connects. It is therefore possible to use different certificates and keys
24673 for different hosts, if you so wish, by making use of the client's IP address
24674 in &$sender_host_address$& to control the expansion. If a string expansion is
24675 forced to fail, Exim behaves as if the option is not set.
24676
24677 .cindex "cipher" "logging"
24678 .cindex "log" "TLS cipher"
24679 .vindex "&$tls_cipher$&"
24680 The variable &$tls_cipher$& is set to the cipher suite that was negotiated for
24681 an incoming TLS connection. It is included in the &'Received:'& header of an
24682 incoming message (by default &-- you can, of course, change this), and it is
24683 also included in the log line that records a message's arrival, keyed by
24684 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
24685 condition can be used to test for specific cipher suites in ACLs.
24686 (For outgoing SMTP deliveries, &$tls_cipher$& is reset &-- see section
24687 &<<SECID185>>&.)
24688
24689 Once TLS has been established, the ACLs that run for subsequent SMTP commands
24690 can check the name of the cipher suite and vary their actions accordingly. The
24691 cipher suite names vary, depending on which TLS library is being used. For
24692 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
24693 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
24694 documentation for more details.
24695
24696
24697 .section "Requesting and verifying client certificates" "SECID183"
24698 .cindex "certificate" "verification of client"
24699 .cindex "TLS" "client certificate verification"
24700 If you want an Exim server to request a certificate when negotiating a TLS
24701 session with a client, you must set either &%tls_verify_hosts%& or
24702 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
24703 apply to all TLS connections. For any host that matches one of these options,
24704 Exim requests a certificate as part of the setup of the TLS session. The
24705 contents of the certificate are verified by comparing it with a list of
24706 expected certificates. These must be available in a file or,
24707 for OpenSSL only (not GnuTLS), a directory, identified by
24708 &%tls_verify_certificates%&.
24709
24710 A file can contain multiple certificates, concatenated end to end. If a
24711 directory is used
24712 (OpenSSL only),
24713 each certificate must be in a separate file, with a name (or a symbolic link)
24714 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
24715 certificate. You can compute the relevant hash by running the command
24716 .code
24717 openssl x509 -hash -noout -in /cert/file
24718 .endd
24719 where &_/cert/file_& contains a single certificate.
24720
24721 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
24722 what happens if the client does not supply a certificate, or if the certificate
24723 does not match any of the certificates in the collection named by
24724 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
24725 attempt to set up a TLS session is aborted, and the incoming connection is
24726 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
24727 session continues. ACLs that run for subsequent SMTP commands can detect the
24728 fact that no certificate was verified, and vary their actions accordingly. For
24729 example, you can insist on a certificate before accepting a message for
24730 relaying, but not when the message is destined for local delivery.
24731
24732 .vindex "&$tls_peerdn$&"
24733 When a client supplies a certificate (whether it verifies or not), the value of
24734 the Distinguished Name of the certificate is made available in the variable
24735 &$tls_peerdn$& during subsequent processing of the message.
24736
24737 .cindex "log" "distinguished name"
24738 Because it is often a long text string, it is not included in the log line or
24739 &'Received:'& header by default. You can arrange for it to be logged, keyed by
24740 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
24741 &%received_header_text%& to change the &'Received:'& header. When no
24742 certificate is supplied, &$tls_peerdn$& is empty.
24743
24744
24745 .section "Revoked certificates" "SECID184"
24746 .cindex "TLS" "revoked certificates"
24747 .cindex "revocation list"
24748 .cindex "certificate" "revocation list"
24749 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
24750 certificates are revoked. If you have such a list, you can pass it to an Exim
24751 server using the global option called &%tls_crl%& and to an Exim client using
24752 an identically named option for the &(smtp)& transport. In each case, the value
24753 of the option is expanded and must then be the name of a file that contains a
24754 CRL in PEM format.
24755
24756
24757 .section "Configuring an Exim client to use TLS" "SECID185"
24758 .cindex "cipher" "logging"
24759 .cindex "log" "TLS cipher"
24760 .cindex "log" "distinguished name"
24761 .cindex "TLS" "configuring an Exim client"
24762 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
24763 deliveries as well as to incoming, the latter one causing logging of the
24764 server certificate's DN. The remaining client configuration for TLS is all
24765 within the &(smtp)& transport.
24766
24767 It is not necessary to set any options to have TLS work in the &(smtp)&
24768 transport. If Exim is built with TLS support, and TLS is advertised by a
24769 server, the &(smtp)& transport always tries to start a TLS session. However,
24770 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
24771 transport) to a list of server hosts for which TLS should not be used.
24772
24773 If you do not want Exim to attempt to send messages unencrypted when an attempt
24774 to set up an encrypted connection fails in any way, you can set
24775 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
24776 those hosts, delivery is always deferred if an encrypted connection cannot be
24777 set up. If there are any other hosts for the address, they are tried in the
24778 usual way.
24779
24780 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
24781 the message unencrypted. It always does this if the response to STARTTLS is
24782 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
24783 session after a success response code, what happens is controlled by the
24784 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
24785 delivery to this host is deferred, and other hosts (if available) are tried. If
24786 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
24787 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
24788 negotiation fails, Exim closes the current connection (because it is in an
24789 unknown state), opens a new one to the same host, and then tries the delivery
24790 unencrypted.
24791
24792 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
24793 transport provide the client with a certificate, which is passed to the server
24794 if it requests it. If the server is Exim, it will request a certificate only if
24795 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
24796
24797 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
24798 must name a file or,
24799 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
24800 expected server certificates. The client verifies the server's certificate
24801 against this collection, taking into account any revoked certificates that are
24802 in the list defined by &%tls_crl%&.
24803
24804 If
24805 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
24806 list of permitted cipher suites. If either of these checks fails, delivery to
24807 the current host is abandoned, and the &(smtp)& transport tries to deliver to
24808 alternative hosts, if any.
24809
24810  &*Note*&:
24811 These options must be set in the &(smtp)& transport for Exim to use TLS when it
24812 is operating as a client. Exim does not assume that a server certificate (set
24813 by the global options of the same name) should also be used when operating as a
24814 client.
24815
24816 .vindex "&$host$&"
24817 .vindex "&$host_address$&"
24818 All the TLS options in the &(smtp)& transport are expanded before use, with
24819 &$host$& and &$host_address$& containing the name and address of the server to
24820 which the client is connected. Forced failure of an expansion causes Exim to
24821 behave as if the relevant option were unset.
24822
24823 .vindex &$tls_cipher$&
24824 .vindex &$tls_peerdn$&
24825 Before an SMTP connection is established, the &$tls_cipher$& and &$tls_peerdn$&
24826 variables are emptied. (Until the first connection, they contain the values
24827 that were set when the message was received.) If STARTTLS is subsequently
24828 successfully obeyed, these variables are set to the relevant values for the
24829 outgoing connection.
24830
24831
24832
24833 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
24834          "SECTmulmessam"
24835 .cindex "multiple SMTP deliveries with TLS"
24836 .cindex "TLS" "multiple message deliveries"
24837 Exim sends multiple messages down the same TCP/IP connection by starting up
24838 an entirely new delivery process for each message, passing the socket from
24839 one process to the next. This implementation does not fit well with the use
24840 of TLS, because there is quite a lot of state information associated with a TLS
24841 connection, not just a socket identification. Passing all the state information
24842 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
24843 session before passing the socket to a new process. The new process may then
24844 try to start a new TLS session, and if successful, may try to re-authenticate
24845 if AUTH is in use, before sending the next message.
24846
24847 The RFC is not clear as to whether or not an SMTP session continues in clear
24848 after TLS has been shut down, or whether TLS may be restarted again later, as
24849 just described. However, if the server is Exim, this shutdown and
24850 reinitialization works. It is not known which (if any) other servers operate
24851 successfully if the client closes a TLS session and continues with unencrypted
24852 SMTP, but there are certainly some that do not work. For such servers, Exim
24853 should not pass the socket to another process, because the failure of the
24854 subsequent attempt to use it would cause Exim to record a temporary host error,
24855 and delay other deliveries to that host.
24856
24857 To test for this case, Exim sends an EHLO command to the server after
24858 closing down the TLS session. If this fails in any way, the connection is
24859 closed instead of being passed to a new delivery process, but no retry
24860 information is recorded.
24861
24862 There is also a manual override; you can set &%hosts_nopass_tls%& on the
24863 &(smtp)& transport to match those hosts for which Exim should not pass
24864 connections to new processes if TLS has been used.
24865
24866
24867
24868
24869 .section "Certificates and all that" "SECTcerandall"
24870 .cindex "certificate" "references to discussion"
24871 In order to understand fully how TLS works, you need to know about
24872 certificates, certificate signing, and certificate authorities. This is not the
24873 place to give a tutorial, especially as I do not know very much about it
24874 myself. Some helpful introduction can be found in the FAQ for the SSL addition
24875 to Apache, currently at
24876 .display
24877 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
24878 .endd
24879 Other parts of the &'modssl'& documentation are also helpful, and have
24880 links to further files.
24881 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
24882 0-201-61598-3), contains both introductory and more in-depth descriptions.
24883 Some sample programs taken from the book are available from
24884 .display
24885 &url(http://www.rtfm.com/openssl-examples/)
24886 .endd
24887
24888
24889 .section "Certificate chains" "SECID186"
24890 The file named by &%tls_certificate%& may contain more than one
24891 certificate. This is useful in the case where the certificate that is being
24892 sent is validated by an intermediate certificate which the other end does
24893 not have. Multiple certificates must be in the correct order in the file.
24894 First the host's certificate itself, then the first intermediate
24895 certificate to validate the issuer of the host certificate, then the next
24896 intermediate certificate to validate the issuer of the first intermediate
24897 certificate, and so on, until finally (optionally) the root certificate.
24898 The root certificate must already be trusted by the recipient for
24899 validation to succeed, of course, but if it's not preinstalled, sending the
24900 root certificate along with the rest makes it available for the user to
24901 install if the receiving end is a client MUA that can interact with a user.
24902
24903
24904 .section "Self-signed certificates" "SECID187"
24905 .cindex "certificate" "self-signed"
24906 You can create a self-signed certificate using the &'req'& command provided
24907 with OpenSSL, like this:
24908 .code
24909 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
24910             -days 9999 -nodes
24911 .endd
24912 &_file1_& and &_file2_& can be the same file; the key and the certificate are
24913 delimited and so can be identified independently. The &%-days%& option
24914 specifies a period for which the certificate is valid. The &%-nodes%& option is
24915 important: if you do not set it, the key is encrypted with a passphrase
24916 that you are prompted for, and any use that is made of the key causes more
24917 prompting for the passphrase. This is not helpful if you are going to use
24918 this certificate and key in an MTA, where prompting is not possible.
24919
24920 A self-signed certificate made in this way is sufficient for testing, and
24921 may be adequate for all your requirements if you are mainly interested in
24922 encrypting transfers, and not in secure identification.
24923
24924 However, many clients require that the certificate presented by the server be a
24925 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
24926 certificate. In this situation, the self-signed certificate described above
24927 must be installed on the client host as a trusted root &'certification
24928 authority'& (CA), and the certificate used by Exim must be a user certificate
24929 signed with that self-signed certificate.
24930
24931 For information on creating self-signed CA certificates and using them to sign
24932 user certificates, see the &'General implementation overview'& chapter of the
24933 Open-source PKI book, available online at
24934 &url(http://ospkibook.sourceforge.net/).
24935 .ecindex IIDencsmtp1
24936 .ecindex IIDencsmtp2
24937
24938
24939
24940 . ////////////////////////////////////////////////////////////////////////////
24941 . ////////////////////////////////////////////////////////////////////////////
24942
24943 .chapter "Access control lists" "CHAPACL"
24944 .scindex IIDacl "&ACL;" "description"
24945 .cindex "control of incoming mail"
24946 .cindex "message" "controlling incoming"
24947 .cindex "policy control" "access control lists"
24948 Access Control Lists (ACLs) are defined in a separate section of the run time
24949 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
24950 name, terminated by a colon. Here is a complete ACL section that contains just
24951 one very small ACL:
24952 .code
24953 begin acl
24954 small_acl:
24955   accept   hosts = one.host.only
24956 .endd
24957 You can have as many lists as you like in the ACL section, and the order in
24958 which they appear does not matter. The lists are self-terminating.
24959
24960 The majority of ACLs are used to control Exim's behaviour when it receives
24961 certain SMTP commands. This applies both to incoming TCP/IP connections, and
24962 when a local process submits a message using SMTP by specifying the &%-bs%&
24963 option. The most common use is for controlling which recipients are accepted
24964 in incoming messages. In addition, you can define an ACL that is used to check
24965 local non-SMTP messages. The default configuration file contains an example of
24966 a realistic ACL for checking RCPT commands. This is discussed in chapter
24967 &<<CHAPdefconfil>>&.
24968
24969
24970 .section "Testing ACLs" "SECID188"
24971 The &%-bh%& command line option provides a way of testing your ACL
24972 configuration locally by running a fake SMTP session with which you interact.
24973 The host &'relay-test.mail-abuse.org'& provides a service for checking your
24974 relaying configuration (see section &<<SECTcheralcon>>& for more details).
24975
24976
24977
24978 .section "Specifying when ACLs are used" "SECID189"
24979 .cindex "&ACL;" "options for specifying"
24980 In order to cause an ACL to be used, you have to name it in one of the relevant
24981 options in the main part of the configuration. These options are:
24982 .cindex "AUTH" "ACL for"
24983 .cindex "DATA" "ACLs for"
24984 .cindex "ETRN" "ACL for"
24985 .cindex "EXPN" "ACL for"
24986 .cindex "HELO" "ACL for"
24987 .cindex "EHLO" "ACL for"
24988 .cindex "MAIL" "ACL for"
24989 .cindex "QUIT, ACL for"
24990 .cindex "RCPT" "ACL for"
24991 .cindex "STARTTLS, ACL for"
24992 .cindex "VRFY" "ACL for"
24993 .cindex "SMTP" "connection, ACL for"
24994 .cindex "non-SMTP messages" "ACLs for"
24995 .cindex "MIME content scanning" "ACL for"
24996
24997 .table2 140pt
24998 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
24999 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
25000 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
25001 .irow &%acl_smtp_auth%&        "ACL for AUTH"
25002 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
25003 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
25004 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
25005 .irow &%acl_smtp_expn%&        "ACL for EXPN"
25006 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
25007 .irow &%acl_smtp_mail%&        "ACL for MAIL"
25008 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
25009 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
25010 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
25011 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
25012 .irow &%acl_smtp_quit%&        "ACL for QUIT"
25013 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
25014 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
25015 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
25016 .endtable
25017
25018 For example, if you set
25019 .code
25020 acl_smtp_rcpt = small_acl
25021 .endd
25022 the little ACL defined above is used whenever Exim receives a RCPT command
25023 in an SMTP dialogue. The majority of policy tests on incoming messages can be
25024 done when RCPT commands arrive. A rejection of RCPT should cause the
25025 sending MTA to give up on the recipient address contained in the RCPT
25026 command, whereas rejection at other times may cause the client MTA to keep on
25027 trying to deliver the message. It is therefore recommended that you do as much
25028 testing as possible at RCPT time.
25029
25030
25031 .section "The non-SMTP ACLs" "SECID190"
25032 .cindex "non-SMTP messages" "ACLs for"
25033 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
25034 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
25035 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
25036 the state of the SMTP connection such as encryption and authentication) are not
25037 relevant and are forbidden in these ACLs. However, the sender and recipients
25038 are known, so the &%senders%& and &%sender_domains%& conditions and the
25039 &$sender_address$& and &$recipients$& variables can be used. Variables such as
25040 &$authenticated_sender$& are also available. You can specify added header lines
25041 in any of these ACLs.
25042
25043 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
25044 non-SMTP message, before any of the message has been read. (This is the
25045 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
25046 batched SMTP input, it runs after the DATA command has been reached. The
25047 result of this ACL is ignored; it cannot be used to reject a message. If you
25048 really need to, you could set a value in an ACL variable here and reject based
25049 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
25050 controls, and in particular, it can be used to set
25051 .code
25052 control = suppress_local_fixups
25053 .endd
25054 This cannot be used in the other non-SMTP ACLs because by the time they are
25055 run, it is too late.
25056
25057 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
25058 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
25059
25060 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
25061 kind of rejection is treated as permanent, because there is no way of sending a
25062 temporary error for these kinds of message.
25063
25064
25065 .section "The SMTP connect ACL" "SECID191"
25066 .cindex "SMTP" "connection, ACL for"
25067 .oindex &%smtp_banner%&
25068 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
25069 session, after the test specified by &%host_reject_connection%& (which is now
25070 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
25071 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
25072 the message override the banner message that is otherwise specified by the
25073 &%smtp_banner%& option.
25074
25075
25076 .section "The EHLO/HELO ACL" "SECID192"
25077 .cindex "EHLO" "ACL for"
25078 .cindex "HELO" "ACL for"
25079 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
25080 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
25081 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
25082 Note that a client may issue more than one EHLO or HELO command in an SMTP
25083 session, and indeed is required to issue a new EHLO or HELO after successfully
25084 setting up encryption following a STARTTLS command.
25085
25086 If the command is accepted by an &%accept%& verb that has a &%message%&
25087 modifier, the message may not contain more than one line (it will be truncated
25088 at the first newline and a panic logged if it does). Such a message cannot
25089 affect the EHLO options that are listed on the second and subsequent lines of
25090 an EHLO response.
25091
25092
25093 .section "The DATA ACLs" "SECID193"
25094 .cindex "DATA" "ACLs for"
25095 Two ACLs are associated with the DATA command, because it is two-stage
25096 command, with two responses being sent to the client.
25097 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
25098 is obeyed. This gives you control after all the RCPT commands, but before
25099 the message itself is received. It offers the opportunity to give a negative
25100 response to the DATA command before the data is transmitted. Header lines
25101 added by MAIL or RCPT ACLs are not visible at this time, but any that
25102 are defined here are visible when the &%acl_smtp_data%& ACL is run.
25103
25104 You cannot test the contents of the message, for example, to verify addresses
25105 in the headers, at RCPT time or when the DATA command is received. Such
25106 tests have to appear in the ACL that is run after the message itself has been
25107 received, before the final response to the DATA command is sent. This is
25108 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
25109 associated with the DATA command.
25110
25111 For both of these ACLs, it is not possible to reject individual recipients. An
25112 error response rejects the entire message. Unfortunately, it is known that some
25113 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
25114 before or after the data) correctly &-- they keep the message on their queues
25115 and try again later, but that is their problem, though it does waste some of
25116 your resources.
25117
25118
25119 .new
25120 .section "The SMTP DKIM ACL" "SECTDKIMACL"
25121 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
25122 enabled (which is the default).
25123
25124 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
25125 received, and is executed for each DKIM signature found in a message.  If not
25126 otherwise specified, the default action is to accept.
25127
25128 For details on the operation of DKIM, see chapter &<<CHID12>>&.
25129 .wen
25130
25131
25132 .section "The SMTP MIME ACL" "SECID194"
25133 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
25134 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
25135
25136
25137 .section "The QUIT ACL" "SECTQUITACL"
25138 .cindex "QUIT, ACL for"
25139 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
25140 does not affect the response code to QUIT, which is always 221. Thus, the ACL
25141 does not in fact control any access. For this reason, the only verbs that are
25142 permitted are &%accept%& and &%warn%&.
25143
25144 This ACL can be used for tasks such as custom logging at the end of an SMTP
25145 session. For example, you can use ACL variables in other ACLs to count
25146 messages, recipients, etc., and log the totals at QUIT time using one or
25147 more &%logwrite%& modifiers on a &%warn%& verb.
25148
25149 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
25150 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
25151
25152 You do not need to have a final &%accept%&, but if you do, you can use a
25153 &%message%& modifier to specify custom text that is sent as part of the 221
25154 response to QUIT.
25155
25156 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
25157 failure (for example, failure to open a log file, or when Exim is bombing out
25158 because it has detected an unrecoverable error), all SMTP commands from the
25159 client are given temporary error responses until QUIT is received or the
25160 connection is closed. In these special cases, the QUIT ACL does not run.
25161
25162
25163 .section "The not-QUIT ACL" "SECTNOTQUITACL"
25164 .vindex &$acl_smtp_notquit$&
25165 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
25166 an SMTP session ends without sending QUIT. However, when Exim itself is is bad
25167 trouble, such as being unable to write to its log files, this ACL is not run,
25168 because it might try to do things (such as write to log files) that make the
25169 situation even worse.
25170
25171 Like the QUIT ACL, this ACL is provided to make it possible to do customized
25172 logging or to gather statistics, and its outcome is ignored. The &%delay%&
25173 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
25174 and &%warn%&.
25175
25176 .vindex &$smtp_notquit_reason$&
25177 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
25178 to a string that indicates the reason for the termination of the SMTP
25179 connection. The possible values are:
25180 .table2
25181 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
25182 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
25183 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
25184 .irow &`connection-lost`&          "The SMTP connection has been lost"
25185 .irow &`data-timeout`&             "Timeout while reading message data"
25186 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
25187 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
25188 .irow &`signal-exit`&              "SIGTERM or SIGINT"
25189 .irow &`synchronization-error`&    "SMTP synchronization error"
25190 .irow &`tls-failed`&               "TLS failed to start"
25191 .endtable
25192 In most cases when an SMTP connection is closed without having received QUIT,
25193 Exim sends an SMTP response message before actually closing the connection.
25194 With the exception of the &`acl-drop`& case, the default message can be
25195 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
25196 &%drop%& verb in another ACL, it is the message from the other ACL that is
25197 used.
25198
25199
25200 .section "Finding an ACL to use" "SECID195"
25201 .cindex "&ACL;" "finding which to use"
25202 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
25203 you can use different ACLs in different circumstances. For example,
25204 .code
25205 acl_smtp_rcpt = ${if ={25}{$interface_port} \
25206                      {acl_check_rcpt} {acl_check_rcpt_submit} }
25207 .endd
25208 In the default configuration file there are some example settings for
25209 providing an RFC 4409 message submission service on port 587 and a
25210 non-standard &"smtps"& service on port 465. You can use a string
25211 expansion like this to choose an ACL for MUAs on these ports which is
25212 more appropriate for this purpose than the default ACL on port 25.
25213
25214 The expanded string does not have to be the name of an ACL in the
25215 configuration file; there are other possibilities. Having expanded the
25216 string, Exim searches for an ACL as follows:
25217
25218 .ilist
25219 If the string begins with a slash, Exim uses it as a file name, and reads its
25220 contents as an ACL. The lines are processed in the same way as lines in the
25221 Exim configuration file. In particular, continuation lines are supported, blank
25222 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
25223 If the file does not exist or cannot be read, an error occurs (typically
25224 causing a temporary failure of whatever caused the ACL to be run). For example:
25225 .code
25226 acl_smtp_data = /etc/acls/\
25227   ${lookup{$sender_host_address}lsearch\
25228   {/etc/acllist}{$value}{default}}
25229 .endd
25230 This looks up an ACL file to use on the basis of the host's IP address, falling
25231 back to a default if the lookup fails. If an ACL is successfully read from a
25232 file, it is retained in memory for the duration of the Exim process, so that it
25233 can be re-used without having to re-read the file.
25234 .next
25235 If the string does not start with a slash, and does not contain any spaces,
25236 Exim searches the ACL section of the configuration for an ACL whose name
25237 matches the string.
25238 .next
25239 If no named ACL is found, or if the string contains spaces, Exim parses
25240 the string as an inline ACL. This can save typing in cases where you just
25241 want to have something like
25242 .code
25243 acl_smtp_vrfy = accept
25244 .endd
25245 in order to allow free use of the VRFY command. Such a string may contain
25246 newlines; it is processed in the same way as an ACL that is read from a file.
25247 .endlist
25248
25249
25250
25251
25252 .section "ACL return codes" "SECID196"
25253 .cindex "&ACL;" "return codes"
25254 Except for the QUIT ACL, which does not affect the SMTP return code (see
25255 section &<<SECTQUITACL>>& above), the result of running an ACL is either
25256 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
25257 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
25258 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
25259 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
25260 This also causes a 4&'xx'& return code.
25261
25262 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
25263 &"deny"&, because there is no mechanism for passing temporary errors to the
25264 submitters of non-SMTP messages.
25265
25266
25267 ACLs that are relevant to message reception may also return &"discard"&. This
25268 has the effect of &"accept"&, but causes either the entire message or an
25269 individual recipient address to be discarded. In other words, it is a
25270 blackholing facility. Use it with care.
25271
25272 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
25273 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
25274 RCPT ACL is to discard just the one recipient address. If there are no
25275 recipients left when the message's data is received, the DATA ACL is not
25276 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
25277 remaining recipients. The &"discard"& return is not permitted for the
25278 &%acl_smtp_predata%& ACL.
25279
25280
25281 .cindex "&[local_scan()]& function" "when all recipients discarded"
25282 The &[local_scan()]& function is always run, even if there are no remaining
25283 recipients; it may create new recipients.
25284
25285
25286
25287 .section "Unset ACL options" "SECID197"
25288 .cindex "&ACL;" "unset options"
25289 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
25290 all the same. &*Note*&: These defaults apply only when the relevant ACL is
25291 not defined at all. For any defined ACL, the default action when control
25292 reaches the end of the ACL statements is &"deny"&.
25293
25294 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
25295 these two are ACLs that are used only for their side effects. They cannot be
25296 used to accept or reject anything.
25297
25298 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
25299 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
25300 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
25301 when the ACL is not defined is &"accept"&.
25302
25303 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
25304 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
25305 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
25306 messages over an SMTP connection. For an example, see the ACL in the default
25307 configuration file.
25308
25309
25310
25311
25312 .section "Data for message ACLs" "SECID198"
25313 .cindex "&ACL;" "data for message ACL"
25314 .vindex &$domain$&
25315 .vindex &$local_part$&
25316 .vindex &$sender_address$&
25317 .vindex &$sender_host_address$&
25318 .vindex &$smtp_command$&
25319 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
25320 that contain information about the host and the message's sender (for example,
25321 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
25322 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
25323 &$local_part$& are set from the argument address. The entire SMTP command
25324 is available in &$smtp_command$&.
25325
25326 When an ACL for the AUTH parameter of MAIL is running, the variables that
25327 contain information about the host are set, but &$sender_address$& is not yet
25328 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
25329 how it is used.
25330
25331 .vindex "&$message_size$&"
25332 The &$message_size$& variable is set to the value of the SIZE parameter on
25333 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
25334 that parameter is not given. The value is updated to the true message size by
25335 the time the final DATA ACL is run (after the message data has been
25336 received).
25337
25338 .vindex "&$rcpt_count$&"
25339 .vindex "&$recipients_count$&"
25340 The &$rcpt_count$& variable increases by one for each RCPT command received.
25341 The &$recipients_count$& variable increases by one each time a RCPT command is
25342 accepted, so while an ACL for RCPT is being processed, it contains the number
25343 of previously accepted recipients. At DATA time (for both the DATA ACLs),
25344 &$rcpt_count$& contains the total number of RCPT commands, and
25345 &$recipients_count$& contains the total number of accepted recipients.
25346
25347
25348
25349
25350
25351 .section "Data for non-message ACLs" "SECTdatfornon"
25352 .cindex "&ACL;" "data for non-message ACL"
25353 .vindex &$smtp_command_argument$&
25354 .vindex &$smtp_command$&
25355 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
25356 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
25357 and the entire SMTP command is available in &$smtp_command$&.
25358 These variables can be tested using a &%condition%& condition. For example,
25359 here is an ACL for use with AUTH, which insists that either the session is
25360 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
25361 does not permit authentication methods that use cleartext passwords on
25362 unencrypted connections.
25363 .code
25364 acl_check_auth:
25365   accept encrypted = *
25366   accept condition = ${if eq{${uc:$smtp_command_argument}}\
25367                      {CRAM-MD5}}
25368   deny   message   = TLS encryption or CRAM-MD5 required
25369 .endd
25370 (Another way of applying this restriction is to arrange for the authenticators
25371 that use cleartext passwords not to be advertised when the connection is not
25372 encrypted. You can use the generic &%server_advertise_condition%& authenticator
25373 option to do this.)
25374
25375
25376
25377 .section "Format of an ACL" "SECID199"
25378 .cindex "&ACL;" "format of"
25379 .cindex "&ACL;" "verbs, definition of"
25380 An individual ACL consists of a number of statements. Each statement starts
25381 with a verb, optionally followed by a number of conditions and &"modifiers"&.
25382 Modifiers can change the way the verb operates, define error and log messages,
25383 set variables, insert delays, and vary the processing of accepted messages.
25384
25385 If all the conditions are met, the verb is obeyed. The same condition may be
25386 used (with different arguments) more than once in the same statement. This
25387 provides a means of specifying an &"and"& conjunction between conditions. For
25388 example:
25389 .code
25390 deny  dnslists = list1.example
25391 dnslists = list2.example
25392 .endd
25393 If there are no conditions, the verb is always obeyed. Exim stops evaluating
25394 the conditions and modifiers when it reaches a condition that fails. What
25395 happens then depends on the verb (and in one case, on a special modifier). Not
25396 all the conditions make sense at every testing point. For example, you cannot
25397 test a sender address in the ACL that is run for a VRFY command.
25398
25399
25400 .section "ACL verbs" "SECID200"
25401 The ACL verbs are as follows:
25402
25403 .ilist
25404 .cindex "&%accept%& ACL verb"
25405 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
25406 of the conditions are not met, what happens depends on whether &%endpass%&
25407 appears among the conditions (for syntax see below). If the failing condition
25408 is before &%endpass%&, control is passed to the next ACL statement; if it is
25409 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
25410 check a RCPT command:
25411 .code
25412 accept domains = +local_domains
25413 endpass
25414 verify = recipient
25415 .endd
25416 If the recipient domain does not match the &%domains%& condition, control
25417 passes to the next statement. If it does match, the recipient is verified, and
25418 the command is accepted if verification succeeds. However, if verification
25419 fails, the ACL yields &"deny"&, because the failing condition is after
25420 &%endpass%&.
25421
25422 The &%endpass%& feature has turned out to be confusing to many people, so its
25423 use is not recommended nowadays. It is always possible to rewrite an ACL so
25424 that &%endpass%& is not needed, and it is no longer used in the default
25425 configuration.
25426
25427 .cindex "&%message%& ACL modifier" "with &%accept%&"
25428 If a &%message%& modifier appears on an &%accept%& statement, its action
25429 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
25430 (when an &%accept%& verb either accepts or passes control to the next
25431 statement), &%message%& can be used to vary the message that is sent when an
25432 SMTP command is accepted. For example, in a RCPT ACL you could have:
25433 .display
25434 &`accept  `&<&'some conditions'&>
25435 &`        message = OK, I will allow you through today`&
25436 .endd
25437 You can specify an SMTP response code, optionally followed by an &"extended
25438 response code"& at the start of the message, but the first digit must be the
25439 same as would be sent by default, which is 2 for an &%accept%& verb.
25440
25441 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
25442 an error message that is used when access is denied. This behaviour is retained
25443 for backward compatibility, but current &"best practice"& is to avoid the use
25444 of &%endpass%&.
25445
25446
25447 .next
25448 .cindex "&%defer%& ACL verb"
25449 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
25450 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
25451 &%defer%& is the same as &%deny%&, because there is no way of sending a
25452 temporary error. For a RCPT command, &%defer%& is much the same as using a
25453 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
25454 be used in any ACL, and even for a recipient it might be a simpler approach.
25455
25456
25457 .next
25458 .cindex "&%deny%& ACL verb"
25459 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
25460 the conditions are not met, control is passed to the next ACL statement. For
25461 example,
25462 .code
25463 deny dnslists = blackholes.mail-abuse.org
25464 .endd
25465 rejects commands from hosts that are on a DNS black list.
25466
25467
25468 .next
25469 .cindex "&%discard%& ACL verb"
25470 &%discard%&: This verb behaves like &%accept%&, except that it returns
25471 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
25472 that are concerned with receiving messages. When all the conditions are true,
25473 the sending entity receives a &"success"& response. However, &%discard%& causes
25474 recipients to be discarded. If it is used in an ACL for RCPT, just the one
25475 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
25476 message's recipients are discarded. Recipients that are discarded before DATA
25477 do not appear in the log line when the &%received_recipients%& log selector is set.
25478
25479 If the &%log_message%& modifier is set when &%discard%& operates,
25480 its contents are added to the line that is automatically written to the log.
25481 The &%message%& modifier operates exactly as it does for &%accept%&.
25482
25483
25484 .next
25485 .cindex "&%drop%& ACL verb"
25486 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
25487 forcibly closed after the 5&'xx'& error message has been sent. For example:
25488 .code
25489 drop   message   = I don't take more than 20 RCPTs
25490        condition = ${if > {$rcpt_count}{20}}
25491 .endd
25492 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
25493 The connection is always dropped after sending a 550 response.
25494
25495 .next
25496 .cindex "&%require%& ACL verb"
25497 &%require%&: If all the conditions are met, control is passed to the next ACL
25498 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
25499 example, when checking a RCPT command,
25500 .code
25501 require message = Sender did not verify
25502         verify  = sender
25503 .endd
25504 passes control to subsequent statements only if the message's sender can be
25505 verified. Otherwise, it rejects the command. Note the positioning of the
25506 &%message%& modifier, before the &%verify%& condition. The reason for this is
25507 discussed in section &<<SECTcondmodproc>>&.
25508
25509 .next
25510 .cindex "&%warn%& ACL verb"
25511 &%warn%&: If all the conditions are true, a line specified by the
25512 &%log_message%& modifier is written to Exim's main log. Control always passes
25513 to the next ACL statement. If any condition is false, the log line is not
25514 written. If an identical log line is requested several times in the same
25515 message, only one copy is actually written to the log. If you want to force
25516 duplicates to be written, use the &%logwrite%& modifier instead.
25517
25518 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
25519 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
25520 &%logwrite%&, and &%add_header%&) that appear before the first failing
25521 condition. There is more about adding header lines in section
25522 &<<SECTaddheadacl>>&.
25523
25524 If any condition on a &%warn%& statement cannot be completed (that is, there is
25525 some sort of defer), the log line specified by &%log_message%& is not written.
25526 This does not include the case of a forced failure from a lookup, which
25527 is considered to be a successful completion. After a defer, no further
25528 conditions or modifiers in the &%warn%& statement are processed. The incident
25529 is logged, and the ACL continues to be processed, from the next statement
25530 onwards.
25531
25532
25533 .vindex "&$acl_verify_message$&"
25534 When one of the &%warn%& conditions is an address verification that fails, the
25535 text of the verification failure message is in &$acl_verify_message$&. If you
25536 want this logged, you must set it up explicitly. For example:
25537 .code
25538 warn   !verify = sender
25539        log_message = sender verify failed: $acl_verify_message
25540 .endd
25541 .endlist
25542
25543 At the end of each ACL there is an implicit unconditional &%deny%&.
25544
25545 As you can see from the examples above, the conditions and modifiers are
25546 written one to a line, with the first one on the same line as the verb, and
25547 subsequent ones on following lines. If you have a very long condition, you can
25548 continue it onto several physical lines by the usual backslash continuation
25549 mechanism. It is conventional to align the conditions vertically.
25550
25551
25552
25553 .section "ACL variables" "SECTaclvariables"
25554 .cindex "&ACL;" "variables"
25555 There are some special variables that can be set during ACL processing. They
25556 can be used to pass information between different ACLs, different invocations
25557 of the same ACL in the same SMTP connection, and between ACLs and the routers,
25558 transports, and filters that are used to deliver a message. The names of these
25559 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
25560 an underscore, but the remainder of the name can be any sequence of
25561 alphanumeric characters and underscores that you choose. There is no limit on
25562 the number of ACL variables. The two sets act as follows:
25563 .ilist
25564 The values of those variables whose names begin with &$acl_c$& persist
25565 throughout an SMTP connection. They are never reset. Thus, a value that is set
25566 while receiving one message is still available when receiving the next message
25567 on the same SMTP connection.
25568 .next
25569 The values of those variables whose names begin with &$acl_m$& persist only
25570 while a message is being received. They are reset afterwards. They are also
25571 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
25572 .endlist
25573
25574 When a message is accepted, the current values of all the ACL variables are
25575 preserved with the message and are subsequently made available at delivery
25576 time. The ACL variables are set by a modifier called &%set%&. For example:
25577 .code
25578 accept hosts = whatever
25579        set acl_m4 = some value
25580 accept authenticated = *
25581        set acl_c_auth = yes
25582 .endd
25583 &*Note*&: A leading dollar sign is not used when naming a variable that is to
25584 be set. If you want to set a variable without taking any action, you can use a
25585 &%warn%& verb without any other modifiers or conditions.
25586
25587 .oindex &%strict_acl_vars%&
25588 What happens if a syntactically valid but undefined ACL variable is
25589 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
25590 false (the default), an empty string is substituted; if it is true, an
25591 error is generated.
25592
25593 Versions of Exim before 4.64 have a limited set of numbered variables, but
25594 their names are compatible, so there is no problem with upgrading.
25595
25596
25597 .section "Condition and modifier processing" "SECTcondmodproc"
25598 .cindex "&ACL;" "conditions; processing"
25599 .cindex "&ACL;" "modifiers; processing"
25600 An exclamation mark preceding a condition negates its result. For example:
25601 .code
25602 deny   domains = *.dom.example
25603       !verify  = recipient
25604 .endd
25605 causes the ACL to return &"deny"& if the recipient domain ends in
25606 &'dom.example'& and the recipient address cannot be verified. Sometimes
25607 negation can be used on the right-hand side of a condition. For example, these
25608 two statements are equivalent:
25609 .code
25610 deny  hosts = !192.168.3.4
25611 deny !hosts =  192.168.3.4
25612 .endd
25613 However, for many conditions (&%verify%& being a good example), only left-hand
25614 side negation of the whole condition is possible.
25615
25616 The arguments of conditions and modifiers are expanded. A forced failure
25617 of an expansion causes a condition to be ignored, that is, it behaves as if the
25618 condition is true. Consider these two statements:
25619 .code
25620 accept  senders = ${lookup{$host_name}lsearch\
25621                   {/some/file}{$value}fail}
25622 accept  senders = ${lookup{$host_name}lsearch\
25623                   {/some/file}{$value}{}}
25624 .endd
25625 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
25626 the returned list is searched, but if the lookup fails the behaviour is
25627 different in the two cases. The &%fail%& in the first statement causes the
25628 condition to be ignored, leaving no further conditions. The &%accept%& verb
25629 therefore succeeds. The second statement, however, generates an empty list when
25630 the lookup fails. No sender can match an empty list, so the condition fails,
25631 and therefore the &%accept%& also fails.
25632
25633 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
25634 specify actions that are taken as the conditions for a statement are checked;
25635 others specify text for messages that are used when access is denied or a
25636 warning is generated. The &%control%& modifier affects the way an incoming
25637 message is handled.
25638
25639 The positioning of the modifiers in an ACL statement important, because the
25640 processing of a verb ceases as soon as its outcome is known. Only those
25641 modifiers that have already been encountered will take effect. For example,
25642 consider this use of the &%message%& modifier:
25643 .code
25644 require message = Can't verify sender
25645         verify  = sender
25646         message = Can't verify recipient
25647         verify  = recipient
25648         message = This message cannot be used
25649 .endd
25650 If sender verification fails, Exim knows that the result of the statement is
25651 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
25652 so its text is used as the error message. If sender verification succeeds, but
25653 recipient verification fails, the second message is used. If recipient
25654 verification succeeds, the third message becomes &"current"&, but is never used
25655 because there are no more conditions to cause failure.
25656
25657 For the &%deny%& verb, on the other hand, it is always the last &%message%&
25658 modifier that is used, because all the conditions must be true for rejection to
25659 happen. Specifying more than one &%message%& modifier does not make sense, and
25660 the message can even be specified after all the conditions. For example:
25661 .code
25662 deny   hosts = ...
25663       !senders = *@my.domain.example
25664        message = Invalid sender from client host
25665 .endd
25666 The &"deny"& result does not happen until the end of the statement is reached,
25667 by which time Exim has set up the message.
25668
25669
25670
25671 .section "ACL modifiers" "SECTACLmodi"
25672 .cindex "&ACL;" "modifiers; list of"
25673 The ACL modifiers are as follows:
25674
25675 .vlist
25676 .vitem &*add_header*&&~=&~<&'text'&>
25677 This modifier specifies one or more header lines that are to be added to an
25678 incoming message, assuming, of course, that the message is ultimately
25679 accepted. For details, see section &<<SECTaddheadacl>>&.
25680
25681 .vitem &*continue*&&~=&~<&'text'&>
25682 .cindex "&%continue%& ACL modifier"
25683 .cindex "database" "updating in ACL"
25684 This modifier does nothing of itself, and processing of the ACL always
25685 continues with the next condition or modifier. The value of &%continue%& is in
25686 the side effects of expanding its argument. Typically this could be used to
25687 update a database. It is really just a syntactic tidiness, to avoid having to
25688 write rather ugly lines like this:
25689 .display
25690 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
25691 .endd
25692 Instead, all you need is
25693 .display
25694 &`continue = `&<&'some expansion'&>
25695 .endd
25696
25697 .vitem &*control*&&~=&~<&'text'&>
25698 .cindex "&%control%& ACL modifier"
25699 This modifier affects the subsequent processing of the SMTP connection or of an
25700 incoming message that is accepted. The effect of the first type of control
25701 lasts for the duration of the connection, whereas the effect of the second type
25702 lasts only until the current message has been received. The message-specific
25703 controls always apply to the whole message, not to individual recipients,
25704 even if the &%control%& modifier appears in a RCPT ACL.
25705
25706 As there are now quite a few controls that can be applied, they are described
25707 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
25708 in several different ways. For example:
25709
25710 . ==== As this is a nested list, any displays it contains must be indented
25711 . ==== as otherwise they are too far to the left. That comment applies only
25712 . ==== when xmlto and fop are used; formatting with sdop gets it right either
25713 . ==== way.
25714
25715 .ilist
25716 It can be at the end of an &%accept%& statement:
25717 .code
25718     accept  ...some conditions
25719             control = queue_only
25720 .endd
25721 In this case, the control is applied when this statement yields &"accept"&, in
25722 other words, when the conditions are all true.
25723
25724 .next
25725 It can be in the middle of an &%accept%& statement:
25726 .code
25727     accept  ...some conditions...
25728             control = queue_only
25729             ...some more conditions...
25730 .endd
25731 If the first set of conditions are true, the control is applied, even if the
25732 statement does not accept because one of the second set of conditions is false.
25733 In this case, some subsequent statement must yield &"accept"& for the control
25734 to be relevant.
25735
25736 .next
25737 It can be used with &%warn%& to apply the control, leaving the
25738 decision about accepting or denying to a subsequent verb. For
25739 example:
25740 .code
25741     warn    ...some conditions...
25742             control = freeze
25743     accept  ...
25744 .endd
25745 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
25746 &%logwrite%&, so it does not add anything to the message and does not write a
25747 log entry.
25748
25749 .next
25750 If you want to apply a control unconditionally, you can use it with a
25751 &%require%& verb. For example:
25752 .code
25753     require  control = no_multiline_responses
25754 .endd
25755 .endlist
25756
25757 .vitem &*delay*&&~=&~<&'time'&>
25758 .cindex "&%delay%& ACL modifier"
25759 .oindex "&%-bh%&"
25760 This modifier may appear in any ACL. It causes Exim to wait for the time
25761 interval before proceeding. However, when testing Exim using the &%-bh%&
25762 option, the delay is not actually imposed (an appropriate message is output
25763 instead). The time is given in the usual Exim notation, and the delay happens
25764 as soon as the modifier is processed. In an SMTP session, pending output is
25765 flushed before the delay is imposed.
25766
25767 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
25768 example:
25769 .code
25770 deny    ...some conditions...
25771         delay = 30s
25772 .endd
25773 The delay happens if all the conditions are true, before the statement returns
25774 &"deny"&. Compare this with:
25775 .code
25776 deny    delay = 30s
25777         ...some conditions...
25778 .endd
25779 which waits for 30s before processing the conditions. The &%delay%& modifier
25780 can also be used with &%warn%& and together with &%control%&:
25781 .code
25782 warn    ...some conditions...
25783         delay = 2m
25784         control = freeze
25785 accept  ...
25786 .endd
25787
25788 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
25789 responses to several commands are no longer buffered and sent in one packet (as
25790 they would normally be) because all output is flushed before imposing the
25791 delay. This optimization is disabled so that a number of small delays do not
25792 appear to the client as one large aggregated delay that might provoke an
25793 unwanted timeout. You can, however, disable output flushing for &%delay%& by
25794 using a &%control%& modifier to set &%no_delay_flush%&.
25795
25796
25797 .vitem &*endpass*&
25798 .cindex "&%endpass%& ACL modifier"
25799 This modifier, which has no argument, is recognized only in &%accept%& and
25800 &%discard%& statements. It marks the boundary between the conditions whose
25801 failure causes control to pass to the next statement, and the conditions whose
25802 failure causes the ACL to return &"deny"&. This concept has proved to be
25803 confusing to some people, so the use of &%endpass%& is no longer recommended as
25804 &"best practice"&. See the description of &%accept%& above for more details.
25805
25806
25807 .vitem &*log_message*&&~=&~<&'text'&>
25808 .cindex "&%log_message%& ACL modifier"
25809 This modifier sets up a message that is used as part of the log message if the
25810 ACL denies access or a &%warn%& statement's conditions are true. For example:
25811 .code
25812 require log_message = wrong cipher suite $tls_cipher
25813         encrypted   = DES-CBC3-SHA
25814 .endd
25815 &%log_message%& is also used when recipients are discarded by &%discard%&. For
25816 example:
25817 .display
25818 &`discard `&<&'some conditions'&>
25819 &`        log_message = Discarded $local_part@$domain because...`&
25820 .endd
25821 When access is denied, &%log_message%& adds to any underlying error message
25822 that may exist because of a condition failure. For example, while verifying a
25823 recipient address, a &':fail:'& redirection might have already set up a
25824 message.
25825
25826 The message may be defined before the conditions to which it applies, because
25827 the string expansion does not happen until Exim decides that access is to be
25828 denied. This means that any variables that are set by the condition are
25829 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
25830 variables are set after a DNS black list lookup succeeds. If the expansion of
25831 &%log_message%& fails, or if the result is an empty string, the modifier is
25832 ignored.
25833
25834 .vindex "&$acl_verify_message$&"
25835 If you want to use a &%warn%& statement to log the result of an address
25836 verification, you can use &$acl_verify_message$& to include the verification
25837 error message.
25838
25839 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
25840 the start of the logged message. If the same warning log message is requested
25841 more than once while receiving  a single email message, only one copy is
25842 actually logged. If you want to log multiple copies, use &%logwrite%& instead
25843 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
25844 is logged for a successful &%warn%& statement.
25845
25846 If &%log_message%& is not present and there is no underlying error message (for
25847 example, from the failure of address verification), but &%message%& is present,
25848 the &%message%& text is used for logging rejections. However, if any text for
25849 logging contains newlines, only the first line is logged. In the absence of
25850 both &%log_message%& and &%message%&, a default built-in message is used for
25851 logging rejections.
25852
25853
25854 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
25855 .cindex "&%log_reject_target%& ACL modifier"
25856 .cindex "logging in ACL" "specifying which log"
25857 This modifier makes it possible to specify which logs are used for messages
25858 about ACL rejections. Its argument is a colon-separated list of words that can
25859 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
25860 may be empty, in which case a rejection is not logged at all. For example, this
25861 ACL fragment writes no logging information when access is denied:
25862 .display
25863 &`deny `&<&'some conditions'&>
25864 &`     log_reject_target =`&
25865 .endd
25866 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
25867 permanent and temporary rejections. Its effect lasts for the rest of the
25868 current ACL.
25869
25870
25871 .vitem &*logwrite*&&~=&~<&'text'&>
25872 .cindex "&%logwrite%& ACL modifier"
25873 .cindex "logging in ACL" "immediate"
25874 This modifier writes a message to a log file as soon as it is encountered when
25875 processing an ACL. (Compare &%log_message%&, which, except in the case of
25876 &%warn%& and &%discard%&, is used only if the ACL statement denies
25877 access.) The &%logwrite%& modifier can be used to log special incidents in
25878 ACLs. For example:
25879 .display
25880 &`accept `&<&'some special conditions'&>
25881 &`       control  = freeze`&
25882 &`       logwrite = froze message because ...`&
25883 .endd
25884 By default, the message is written to the main log. However, it may begin
25885 with a colon, followed by a comma-separated list of log names, and then
25886 another colon, to specify exactly which logs are to be written. For
25887 example:
25888 .code
25889 logwrite = :main,reject: text for main and reject logs
25890 logwrite = :panic: text for panic log only
25891 .endd
25892
25893
25894 .vitem &*message*&&~=&~<&'text'&>
25895 .cindex "&%message%& ACL modifier"
25896 This modifier sets up a text string that is expanded and used as a response
25897 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
25898 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
25899 there is some complication if &%endpass%& is involved; see the description of
25900 &%accept%& for details.)
25901
25902 The expansion of the message happens at the time Exim decides that the ACL is
25903 to end, not at the time it processes &%message%&. If the expansion fails, or
25904 generates an empty string, the modifier is ignored. Here is an example where
25905 &%message%& must be specified first, because the ACL ends with a rejection if
25906 the &%hosts%& condition fails:
25907 .code
25908 require  message = Host not recognized
25909          hosts = 10.0.0.0/8
25910 .endd
25911 (Once a condition has failed, no further conditions or modifiers are
25912 processed.)
25913
25914 .cindex "SMTP" "error codes"
25915 .oindex "&%smtp_banner%&
25916 For ACLs that are triggered by SMTP commands, the message is returned as part
25917 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
25918 is meaningful only for SMTP, as no message is returned when a non-SMTP message
25919 is accepted. In the case of the connect ACL, accepting with a message modifier
25920 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
25921 accept message may not contain more than one line (otherwise it will be
25922 truncated at the first newline and a panic logged), and it cannot affect the
25923 EHLO options.
25924
25925 When SMTP is involved, the message may begin with an overriding response code,
25926 consisting of three digits optionally followed by an &"extended response code"&
25927 of the form &'n.n.n'&, each code being followed by a space. For example:
25928 .code
25929 deny  message = 599 1.2.3 Host not welcome
25930       hosts = 192.168.34.0/24
25931 .endd
25932 The first digit of the supplied response code must be the same as would be sent
25933 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
25934 access, but for the predata ACL, note that the default success code is 354, not
25935 2&'xx'&.
25936
25937 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
25938 the message modifier cannot override the 221 response code.
25939
25940 The text in a &%message%& modifier is literal; any quotes are taken as
25941 literals, but because the string is expanded, backslash escapes are processed
25942 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
25943 response.
25944
25945 .vindex "&$acl_verify_message$&"
25946 If &%message%& is used on a statement that verifies an address, the message
25947 specified overrides any message that is generated by the verification process.
25948 However, the original message is available in the variable
25949 &$acl_verify_message$&, so you can incorporate it into your message if you
25950 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
25951 routers to be passed back as part of the SMTP response, you should either not
25952 use a &%message%& modifier, or make use of &$acl_verify_message$&.
25953
25954 For compatibility with previous releases of Exim, a &%message%& modifier that
25955 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
25956 modifier, but this usage is now deprecated. However, &%message%& acts only when
25957 all the conditions are true, wherever it appears in an ACL command, whereas
25958 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
25959 &%warn%& in an ACL that is not concerned with receiving a message, it has no
25960 effect.
25961
25962
25963 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
25964 .cindex "&%set%& ACL modifier"
25965 This modifier puts a value into one of the ACL variables (see section
25966 &<<SECTaclvariables>>&).
25967 .endlist
25968
25969
25970
25971
25972
25973 .section "Use of the control modifier" "SECTcontrols"
25974 .cindex "&%control%& ACL modifier"
25975 The &%control%& modifier supports the following settings:
25976
25977 .vlist
25978 .vitem &*control&~=&~allow_auth_unadvertised*&
25979 This modifier allows a client host to use the SMTP AUTH command even when it
25980 has not been advertised in response to EHLO. Furthermore, because there are
25981 apparently some really broken clients that do this, Exim will accept AUTH after
25982 HELO (rather than EHLO) when this control is set. It should be used only if you
25983 really need it, and you should limit its use to those broken clients that do
25984 not work without it. For example:
25985 .code
25986 warn hosts   = 192.168.34.25
25987      control = allow_auth_unadvertised
25988 .endd
25989 Normally, when an Exim server receives an AUTH command, it checks the name of
25990 the authentication mechanism that is given in the command to ensure that it
25991 matches an advertised mechanism. When this control is set, the check that a
25992 mechanism has been advertised is bypassed. Any configured mechanism can be used
25993 by the client. This control is permitted only in the connection and HELO ACLs.
25994
25995
25996 .vitem &*control&~=&~caseful_local_part*& &&&
25997        &*control&~=&~caselower_local_part*&
25998 .cindex "&ACL;" "case of local part in"
25999 .cindex "case of local parts"
26000 .vindex "&$local_part$&"
26001 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
26002 (that is, during RCPT processing). By default, the contents of &$local_part$&
26003 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
26004 any uppercase letters in the original local part are restored in &$local_part$&
26005 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
26006 is encountered.
26007
26008 These controls affect only the current recipient. Moreover, they apply only to
26009 local part handling that takes place directly in the ACL (for example, as a key
26010 in lookups). If a test to verify the recipient is obeyed, the case-related
26011 handling of the local part during the verification is controlled by the router
26012 configuration (see the &%caseful_local_part%& generic router option).
26013
26014 This facility could be used, for example, to add a spam score to local parts
26015 containing upper case letters. For example, using &$acl_m4$& to accumulate the
26016 spam score:
26017 .code
26018 warn  control = caseful_local_part
26019       set acl_m4 = ${eval:\
26020                      $acl_m4 + \
26021                      ${if match{$local_part}{[A-Z]}{1}{0}}\
26022                     }
26023       control = caselower_local_part
26024 .endd
26025 Notice that we put back the lower cased version afterwards, assuming that
26026 is what is wanted for subsequent tests.
26027
26028 .new
26029 .vitem &*control&~=&~debug/*&<&'options'&>
26030 .cindex "&ACL;" "enabling debug logging"
26031 .cindex "debugging" "enabling from an ACL"
26032 This control turns on debug logging, almost as though Exim had been invoked
26033 with &`-d`&, with the output going to a new logfile, by default called
26034 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
26035 may access any variables already defined.  The logging may be adjusted with
26036 the &'opts'& option, which takes the same values as the &`-d`& command-line
26037 option.  Some examples (which depend on variables that don't exist in all
26038 contexts):
26039 .code
26040       control = debug
26041       control = debug/tag=.$sender_host_address
26042       control = debug/opts=+expand+acl
26043       control = debug/tag=.$message_exim_id/opts=+expand
26044 .endd
26045 .wen
26046
26047 .vitem &*control&~=&~enforce_sync*& &&&
26048        &*control&~=&~no_enforce_sync*&
26049 .cindex "SMTP" "synchronization checking"
26050 .cindex "synchronization checking in SMTP"
26051 These controls make it possible to be selective about when SMTP synchronization
26052 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
26053 state of the switch (it is true by default). See the description of this option
26054 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
26055
26056 The effect of these two controls lasts for the remainder of the SMTP
26057 connection. They can appear in any ACL except the one for the non-SMTP
26058 messages. The most straightforward place to put them is in the ACL defined by
26059 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
26060 before the first synchronization check. The expected use is to turn off the
26061 synchronization checks for badly-behaved hosts that you nevertheless need to
26062 work with.
26063
26064
26065 .vitem &*control&~=&~fakedefer/*&<&'message'&>
26066 .cindex "fake defer"
26067 .cindex "defer, fake"
26068 This control works in exactly the same way as &%fakereject%& (described below)
26069 except that it causes an SMTP 450 response after the message data instead of a
26070 550 response. You must take care when using &%fakedefer%& because it causes the
26071 messages to be duplicated when the sender retries. Therefore, you should not
26072 use &%fakedefer%& if the message is to be delivered normally.
26073
26074 .vitem &*control&~=&~fakereject/*&<&'message'&>
26075 .cindex "fake rejection"
26076 .cindex "rejection, fake"
26077 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
26078 words, only when an SMTP message is being received. If Exim accepts the
26079 message, instead the final 250 response, a 550 rejection message is sent.
26080 However, Exim proceeds to deliver the message as normal. The control applies
26081 only to the current message, not to any subsequent ones that may be received in
26082 the same SMTP connection.
26083
26084 The text for the 550 response is taken from the &%control%& modifier. If no
26085 message is supplied, the following is used:
26086 .code
26087 550-Your message has been rejected but is being
26088 550-kept for evaluation.
26089 550-If it was a legitimate message, it may still be
26090 550 delivered to the target recipient(s).
26091 .endd
26092 This facility should be used with extreme caution.
26093
26094 .vitem &*control&~=&~freeze*&
26095 .cindex "frozen messages" "forcing in ACL"
26096 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
26097 other words, only when a message is being received. If the message is accepted,
26098 it is placed on Exim's queue and frozen. The control applies only to the
26099 current message, not to any subsequent ones that may be received in the same
26100 SMTP connection.
26101
26102 This modifier can optionally be followed by &`/no_tell`&. If the global option
26103 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
26104 is told about the freezing), provided all the &*control=freeze*& modifiers that
26105 are obeyed for the current message have the &`/no_tell`& option.
26106
26107 .vitem &*control&~=&~no_delay_flush*&
26108 .cindex "SMTP" "output flushing, disabling for delay"
26109 Exim normally flushes SMTP output before implementing a delay in an ACL, to
26110 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
26111 use. This control, as long as it is encountered before the &%delay%& modifier,
26112 disables such output flushing.
26113
26114 .vitem &*control&~=&~no_callout_flush*&
26115 .cindex "SMTP" "output flushing, disabling for callout"
26116 Exim normally flushes SMTP output before performing a callout in an ACL, to
26117 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
26118 use. This control, as long as it is encountered before the &%verify%& condition
26119 that causes the callout, disables such output flushing.
26120
26121 .vitem &*control&~=&~no_mbox_unspool*&
26122 This control is available when Exim is compiled with the content scanning
26123 extension. Content scanning may require a copy of the current message, or parts
26124 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
26125 or spam scanner. Normally, such copies are deleted when they are no longer
26126 needed. If this control is set, the copies are not deleted. The control applies
26127 only to the current message, not to any subsequent ones that may be received in
26128 the same SMTP connection. It is provided for debugging purposes and is unlikely
26129 to be useful in production.
26130
26131 .vitem &*control&~=&~no_multiline_responses*&
26132 .cindex "multiline responses, suppressing"
26133 This control is permitted for any ACL except the one for non-SMTP messages.
26134 It seems that there are broken clients in use that cannot handle multiline
26135 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
26136
26137 If this control is set, multiline SMTP responses from ACL rejections are
26138 suppressed. One way of doing this would have been to put out these responses as
26139 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
26140 (&"use multiline responses for more"& it says &-- ha!), and some of the
26141 responses might get close to that. So this facility, which is after all only a
26142 sop to broken clients, is implemented by doing two very easy things:
26143
26144 .ilist
26145 Extra information that is normally output as part of a rejection caused by
26146 sender verification failure is omitted. Only the final line (typically &"sender
26147 verification failed"&) is sent.
26148 .next
26149 If a &%message%& modifier supplies a multiline response, only the first
26150 line is output.
26151 .endlist
26152
26153 The setting of the switch can, of course, be made conditional on the
26154 calling host. Its effect lasts until the end of the SMTP connection.
26155
26156 .vitem &*control&~=&~no_pipelining*&
26157 .cindex "PIPELINING" "suppressing advertising"
26158 This control turns off the advertising of the PIPELINING extension to SMTP in
26159 the current session. To be useful, it must be obeyed before Exim sends its
26160 response to an EHLO command. Therefore, it should normally appear in an ACL
26161 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
26162 &%pipelining_advertise_hosts%&.
26163
26164 .vitem &*control&~=&~queue_only*&
26165 .oindex "&%queue_only%&"
26166 .cindex "queueing incoming messages"
26167 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
26168 other words, only when a message is being received. If the message is accepted,
26169 it is placed on Exim's queue and left there for delivery by a subsequent queue
26170 runner. No immediate delivery process is started. In other words, it has the
26171 effect as the &%queue_only%& global option. However, the control applies only
26172 to the current message, not to any subsequent ones that may be received in the
26173 same SMTP connection.
26174
26175 .vitem &*control&~=&~submission/*&<&'options'&>
26176 .cindex "message" "submission"
26177 .cindex "submission mode"
26178 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
26179 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
26180 the current message is a submission from a local MUA. In this case, Exim
26181 operates in &"submission mode"&, and applies certain fixups to the message if
26182 necessary. For example, it adds a &'Date:'& header line if one is not present.
26183 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
26184 late (the message has already been created).
26185
26186 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
26187 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
26188 submission mode; the available options for this control are described there.
26189 The control applies only to the current message, not to any subsequent ones
26190 that may be received in the same SMTP connection.
26191
26192 .vitem &*control&~=&~suppress_local_fixups*&
26193 .cindex "submission fixups, suppressing"
26194 This control applies to locally submitted (non TCP/IP) messages, and is the
26195 complement of &`control = submission`&. It disables the fixups that are
26196 normally applied to locally-submitted messages. Specifically:
26197
26198 .ilist
26199 Any &'Sender:'& header line is left alone (in this respect, it is a
26200 dynamic version of &%local_sender_retain%&).
26201 .next
26202 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
26203 .next
26204 There is no check that &'From:'& corresponds to the actual sender.
26205 .endlist ilist
26206
26207 This control may be useful when a remotely-originated message is accepted,
26208 passed to some scanning program, and then re-submitted for delivery. It can be
26209 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
26210 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
26211 data is read.
26212
26213 &*Note:*& This control applies only to the current message, not to any others
26214 that are being submitted at the same time using &%-bs%& or &%-bS%&.
26215 .endlist vlist
26216
26217
26218 .section "Summary of message fixup control" "SECTsummesfix"
26219 All four possibilities for message fixups can be specified:
26220
26221 .ilist
26222 Locally submitted, fixups applied: the default.
26223 .next
26224 Locally submitted, no fixups applied: use
26225 &`control = suppress_local_fixups`&.
26226 .next
26227 Remotely submitted, no fixups applied: the default.
26228 .next
26229 Remotely submitted, fixups applied: use &`control = submission`&.
26230 .endlist
26231
26232
26233
26234 .section "Adding header lines in ACLs" "SECTaddheadacl"
26235 .cindex "header lines" "adding in an ACL"
26236 .cindex "header lines" "position of added lines"
26237 .cindex "&%message%& ACL modifier"
26238 The &%add_header%& modifier can be used to add one or more extra header lines
26239 to an incoming message, as in this example:
26240 .code
26241 warn dnslists = sbl.spamhaus.org : \
26242                 dialup.mail-abuse.org
26243      add_header = X-blacklisted-at: $dnslist_domain
26244 .endd
26245 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
26246 MIME, and non-SMTP ACLs (in other words, those that are concerned with
26247 receiving a message). The message must ultimately be accepted for
26248 &%add_header%& to have any significant effect. You can use &%add_header%& with
26249 any ACL verb, including &%deny%& (though this is potentially useful only in a
26250 RCPT ACL).
26251
26252 If the data for the &%add_header%& modifier contains one or more newlines that
26253 are not followed by a space or a tab, it is assumed to contain multiple header
26254 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
26255 front of any line that is not a valid header line.
26256
26257 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
26258 They are added to the message before processing the DATA and MIME ACLs.
26259 However, if an identical header line is requested more than once, only one copy
26260 is actually added to the message. Further header lines may be accumulated
26261 during the DATA and MIME ACLs, after which they are added to the message, again
26262 with duplicates suppressed. Thus, it is possible to add two identical header
26263 lines to an SMTP message, but only if one is added before DATA and one after.
26264 In the case of non-SMTP messages, new headers are accumulated during the
26265 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
26266 message is rejected after DATA or by the non-SMTP ACL, all added header lines
26267 are included in the entry that is written to the reject log.
26268
26269 .cindex "header lines" "added; visibility of"
26270 Header lines are not visible in string expansions until they are added to the
26271 message. It follows that header lines defined in the MAIL, RCPT, and predata
26272 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
26273 header lines that are added by the DATA or MIME ACLs are not visible in those
26274 ACLs. Because of this restriction, you cannot use header lines as a way of
26275 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
26276 this, you can use ACL variables, as described in section
26277 &<<SECTaclvariables>>&.
26278
26279 The &%add_header%& modifier acts immediately it is encountered during the
26280 processing of an ACL. Notice the difference between these two cases:
26281 .display
26282 &`accept add_header = ADDED: some text`&
26283 &`       `&<&'some condition'&>
26284
26285 &`accept `&<&'some condition'&>
26286 &`       add_header = ADDED: some text`&
26287 .endd
26288 In the first case, the header line is always added, whether or not the
26289 condition is true. In the second case, the header line is added only if the
26290 condition is true. Multiple occurrences of &%add_header%& may occur in the same
26291 ACL statement. All those that are encountered before a condition fails are
26292 honoured.
26293
26294 .cindex "&%warn%& ACL verb"
26295 For compatibility with previous versions of Exim, a &%message%& modifier for a
26296 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
26297 effect only if all the conditions are true, even if it appears before some of
26298 them. Furthermore, only the last occurrence of &%message%& is honoured. This
26299 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
26300 are present on a &%warn%& verb, both are processed according to their
26301 specifications.
26302
26303 By default, new header lines are added to a message at the end of the existing
26304 header lines. However, you can specify that any particular header line should
26305 be added right at the start (before all the &'Received:'& lines), immediately
26306 after the first block of &'Received:'& lines, or immediately before any line
26307 that is not a &'Received:'& or &'Resent-something:'& header.
26308
26309 This is done by specifying &":at_start:"&, &":after_received:"&, or
26310 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
26311 header line, respectively. (Header text cannot start with a colon, as there has
26312 to be a header name first.) For example:
26313 .code
26314 warn add_header = \
26315        :after_received:X-My-Header: something or other...
26316 .endd
26317 If more than one header line is supplied in a single &%add_header%& modifier,
26318 each one is treated independently and can therefore be placed differently. If
26319 you add more than one line at the start, or after the Received: block, they end
26320 up in reverse order.
26321
26322 &*Warning*&: This facility currently applies only to header lines that are
26323 added in an ACL. It does NOT work for header lines that are added in a
26324 system filter or in a router or transport.
26325
26326
26327
26328
26329 .section "ACL conditions" "SECTaclconditions"
26330 .cindex "&ACL;" "conditions; list of"
26331 Some of conditions listed in this section are available only when Exim is
26332 compiled with the content-scanning extension. They are included here briefly
26333 for completeness. More detailed descriptions can be found in the discussion on
26334 content scanning in chapter &<<CHAPexiscan>>&.
26335
26336 Not all conditions are relevant in all circumstances. For example, testing
26337 senders and recipients does not make sense in an ACL that is being run as the
26338 result of the arrival of an ETRN command, and checks on message headers can be
26339 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
26340 can use the same condition (with different parameters) more than once in the
26341 same ACL statement. This provides a way of specifying an &"and"& conjunction.
26342 The conditions are as follows:
26343
26344
26345 .vlist
26346 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
26347 .cindex "&ACL;" "nested"
26348 .cindex "&ACL;" "indirect"
26349 .cindex "&%acl%& ACL condition"
26350 The possible values of the argument are the same as for the
26351 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
26352 &"accept"& the condition is true; if it returns &"deny"& the condition is
26353 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
26354 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
26355 condition false. This means that further processing of the &%warn%& verb
26356 ceases, but processing of the ACL continues.
26357
26358 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
26359 the connection is dropped. If it returns &"discard"&, the verb must be
26360 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
26361 conditions are tested.
26362
26363 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
26364 loops. This condition allows you to use different ACLs in different
26365 circumstances. For example, different ACLs can be used to handle RCPT commands
26366 for different local users or different local domains.
26367
26368 .vitem &*authenticated&~=&~*&<&'string&~list'&>
26369 .cindex "&%authenticated%& ACL condition"
26370 .cindex "authentication" "ACL checking"
26371 .cindex "&ACL;" "testing for authentication"
26372 If the SMTP connection is not authenticated, the condition is false. Otherwise,
26373 the name of the authenticator is tested against the list. To test for
26374 authentication by any authenticator, you can set
26375 .code
26376 authenticated = *
26377 .endd
26378
26379 .vitem &*condition&~=&~*&<&'string'&>
26380 .cindex "&%condition%& ACL condition"
26381 .cindex "customizing" "ACL condition"
26382 .cindex "&ACL;" "customized test"
26383 .cindex "&ACL;" "testing, customized"
26384 This feature allows you to make up custom conditions. If the result of
26385 expanding the string is an empty string, the number zero, or one of the strings
26386 &"no"& or &"false"&, the condition is false. If the result is any non-zero
26387 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
26388 any other value, some error is assumed to have occurred, and the ACL returns
26389 &"defer"&. However, if the expansion is forced to fail, the condition is
26390 ignored. The effect is to treat it as true, whether it is positive or
26391 negative.
26392
26393 .vitem &*decode&~=&~*&<&'location'&>
26394 .cindex "&%decode%& ACL condition"
26395 This condition is available only when Exim is compiled with the
26396 content-scanning extension, and it is allowed only in the ACL defined by
26397 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
26398 If all goes well, the condition is true. It is false only if there are
26399 problems such as a syntax error or a memory shortage. For more details, see
26400 chapter &<<CHAPexiscan>>&.
26401
26402 .vitem &*demime&~=&~*&<&'extension&~list'&>
26403 .cindex "&%demime%& ACL condition"
26404 This condition is available only when Exim is compiled with the
26405 content-scanning extension. Its use is described in section
26406 &<<SECTdemimecond>>&.
26407
26408 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
26409 .cindex "&%dnslists%& ACL condition"
26410 .cindex "DNS list" "in ACL"
26411 .cindex "black list (DNS)"
26412 .cindex "&ACL;" "testing a DNS list"
26413 This condition checks for entries in DNS black lists. These are also known as
26414 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
26415 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
26416 different variants of this condition to describe briefly here. See sections
26417 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
26418
26419 .vitem &*domains&~=&~*&<&'domain&~list'&>
26420 .cindex "&%domains%& ACL condition"
26421 .cindex "domain" "ACL checking"
26422 .cindex "&ACL;" "testing a recipient domain"
26423 .vindex "&$domain_data$&"
26424 This condition is relevant only after a RCPT command. It checks that the domain
26425 of the recipient address is in the domain list. If percent-hack processing is
26426 enabled, it is done before this test is done. If the check succeeds with a
26427 lookup, the result of the lookup is placed in &$domain_data$& until the next
26428 &%domains%& test.
26429
26430 &*Note carefully*& (because many people seem to fall foul of this): you cannot
26431 use &%domains%& in a DATA ACL.
26432
26433
26434 .vitem &*encrypted&~=&~*&<&'string&~list'&>
26435 .cindex "&%encrypted%& ACL condition"
26436 .cindex "encryption" "checking in an ACL"
26437 .cindex "&ACL;" "testing for encryption"
26438 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
26439 name of the cipher suite in use is tested against the list. To test for
26440 encryption without testing for any specific cipher suite(s), set
26441 .code
26442 encrypted = *
26443 .endd
26444
26445
26446 .vitem &*hosts&~=&~*&<&'&~host&~list'&>
26447 .cindex "&%hosts%& ACL condition"
26448 .cindex "host" "ACL checking"
26449 .cindex "&ACL;" "testing the client host"
26450 This condition tests that the calling host matches the host list. If you have
26451 name lookups or wildcarded host names and IP addresses in the same host list,
26452 you should normally put the IP addresses first. For example, you could have:
26453 .code
26454 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
26455 .endd
26456 The lookup in this example uses the host name for its key. This is implied by
26457 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
26458 and it wouldn't matter which way round you had these two items.)
26459
26460 The reason for the problem with host names lies in the left-to-right way that
26461 Exim processes lists. It can test IP addresses without doing any DNS lookups,
26462 but when it reaches an item that requires a host name, it fails if it cannot
26463 find a host name to compare with the pattern. If the above list is given in the
26464 opposite order, the &%accept%& statement fails for a host whose name cannot be
26465 found, even if its IP address is 10.9.8.7.
26466
26467 If you really do want to do the name check first, and still recognize the IP
26468 address even if the name lookup fails, you can rewrite the ACL like this:
26469 .code
26470 accept hosts = dbm;/etc/friendly/hosts
26471 accept hosts = 10.9.8.7
26472 .endd
26473 The default action on failing to find the host name is to assume that the host
26474 is not in the list, so the first &%accept%& statement fails. The second
26475 statement can then check the IP address.
26476
26477 .vindex "&$host_data$&"
26478 If a &%hosts%& condition is satisfied by means of a lookup, the result
26479 of the lookup is made available in the &$host_data$& variable. This
26480 allows you, for example, to set up a statement like this:
26481 .code
26482 deny  hosts = net-lsearch;/some/file
26483 message = $host_data
26484 .endd
26485 which gives a custom error message for each denied host.
26486
26487 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
26488 .cindex "&%local_parts%& ACL condition"
26489 .cindex "local part" "ACL checking"
26490 .cindex "&ACL;" "testing a local part"
26491 .vindex "&$local_part_data$&"
26492 This condition is relevant only after a RCPT command. It checks that the local
26493 part of the recipient address is in the list. If percent-hack processing is
26494 enabled, it is done before this test. If the check succeeds with a lookup, the
26495 result of the lookup is placed in &$local_part_data$&, which remains set until
26496 the next &%local_parts%& test.
26497
26498 .vitem &*malware&~=&~*&<&'option'&>
26499 .cindex "&%malware%& ACL condition"
26500 .cindex "&ACL;" "virus scanning"
26501 .cindex "&ACL;" "scanning for viruses"
26502 This condition is available only when Exim is compiled with the
26503 content-scanning extension. It causes the incoming message to be scanned for
26504 viruses. For details, see chapter &<<CHAPexiscan>>&.
26505
26506 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
26507 .cindex "&%mime_regex%& ACL condition"
26508 .cindex "&ACL;" "testing by regex matching"
26509 This condition is available only when Exim is compiled with the
26510 content-scanning extension, and it is allowed only in the ACL defined by
26511 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
26512 with any of the regular expressions. For details, see chapter
26513 &<<CHAPexiscan>>&.
26514
26515 .vitem &*ratelimit&~=&~*&<&'parameters'&>
26516 .cindex "rate limiting"
26517 This condition can be used to limit the rate at which a user or host submits
26518 messages. Details are given in section &<<SECTratelimiting>>&.
26519
26520 .vitem &*recipients&~=&~*&<&'address&~list'&>
26521 .cindex "&%recipients%& ACL condition"
26522 .cindex "recipient" "ACL checking"
26523 .cindex "&ACL;" "testing a recipient"
26524 This condition is relevant only after a RCPT command. It checks the entire
26525 recipient address against a list of recipients.
26526
26527 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
26528 .cindex "&%regex%& ACL condition"
26529 .cindex "&ACL;" "testing by regex matching"
26530 This condition is available only when Exim is compiled with the
26531 content-scanning extension, and is available only in the DATA, MIME, and
26532 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
26533 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
26534
26535 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
26536 .cindex "&%sender_domains%& ACL condition"
26537 .cindex "sender" "ACL checking"
26538 .cindex "&ACL;" "testing a sender domain"
26539 .vindex "&$domain$&"
26540 .vindex "&$sender_address_domain$&"
26541 This condition tests the domain of the sender of the message against the given
26542 domain list. &*Note*&: The domain of the sender address is in
26543 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
26544 of this condition. This is an exception to the general rule for testing domain
26545 lists. It is done this way so that, if this condition is used in an ACL for a
26546 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
26547 influence the sender checking.
26548
26549 &*Warning*&: It is a bad idea to use this condition on its own as a control on
26550 relaying, because sender addresses are easily, and commonly, forged.
26551
26552 .vitem &*senders&~=&~*&<&'address&~list'&>
26553 .cindex "&%senders%& ACL condition"
26554 .cindex "sender" "ACL checking"
26555 .cindex "&ACL;" "testing a sender"
26556 This condition tests the sender of the message against the given list. To test
26557 for a bounce message, which has an empty sender, set
26558 .code
26559 senders = :
26560 .endd
26561 &*Warning*&: It is a bad idea to use this condition on its own as a control on
26562 relaying, because sender addresses are easily, and commonly, forged.
26563
26564 .vitem &*spam&~=&~*&<&'username'&>
26565 .cindex "&%spam%& ACL condition"
26566 .cindex "&ACL;" "scanning for spam"
26567 This condition is available only when Exim is compiled with the
26568 content-scanning extension. It causes the incoming message to be scanned by
26569 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
26570
26571 .vitem &*verify&~=&~certificate*&
26572 .cindex "&%verify%& ACL condition"
26573 .cindex "TLS" "client certificate verification"
26574 .cindex "certificate" "verification of client"
26575 .cindex "&ACL;" "certificate verification"
26576 .cindex "&ACL;" "testing a TLS certificate"
26577 This condition is true in an SMTP session if the session is encrypted, and a
26578 certificate was received from the client, and the certificate was verified. The
26579 server requests a certificate only if the client matches &%tls_verify_hosts%&
26580 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
26581
26582 .vitem &*verify&~=&~csa*&
26583 .cindex "CSA verification"
26584 This condition checks whether the sending host (the client) is authorized to
26585 send email. Details of how this works are given in section
26586 &<<SECTverifyCSA>>&.
26587
26588 .vitem &*verify&~=&~header_sender/*&<&'options'&>
26589 .cindex "&%verify%& ACL condition"
26590 .cindex "&ACL;" "verifying sender in the header"
26591 .cindex "header lines" "verifying the sender in"
26592 .cindex "sender" "verifying in header"
26593 .cindex "verifying" "sender in header"
26594 This condition is relevant only in an ACL that is run after a message has been
26595 received, that is, in an ACL specified by &%acl_smtp_data%& or
26596 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
26597 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
26598 is loosely thought of as a &"sender"& address (hence the name of the test).
26599 However, an address that appears in one of these headers need not be an address
26600 that accepts bounce messages; only sender addresses in envelopes are required
26601 to accept bounces. Therefore, if you use the callout option on this check, you
26602 might want to arrange for a non-empty address in the MAIL command.
26603
26604 Details of address verification and the options are given later, starting at
26605 section &<<SECTaddressverification>>& (callouts are described in section
26606 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
26607 condition to restrict it to bounce messages only:
26608 .code
26609 deny    senders = :
26610         message = A valid sender header is required for bounces
26611        !verify  = header_sender
26612 .endd
26613
26614 .vitem &*verify&~=&~header_syntax*&
26615 .cindex "&%verify%& ACL condition"
26616 .cindex "&ACL;" "verifying header syntax"
26617 .cindex "header lines" "verifying syntax"
26618 .cindex "verifying" "header syntax"
26619 This condition is relevant only in an ACL that is run after a message has been
26620 received, that is, in an ACL specified by &%acl_smtp_data%& or
26621 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
26622 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
26623 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
26624 permitted only in locally generated messages and from hosts that match
26625 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26626 appropriate.
26627
26628 Note that this condition is a syntax check only. However, a common spamming
26629 ploy used to be to send syntactically invalid headers such as
26630 .code
26631 To: @
26632 .endd
26633 and this condition can be used to reject such messages, though they are not as
26634 common as they used to be.
26635
26636 .vitem &*verify&~=&~helo*&
26637 .cindex "&%verify%& ACL condition"
26638 .cindex "&ACL;" "verifying HELO/EHLO"
26639 .cindex "HELO" "verifying"
26640 .cindex "EHLO" "verifying"
26641 .cindex "verifying" "EHLO"
26642 .cindex "verifying" "HELO"
26643 This condition is true if a HELO or EHLO command has been received from the
26644 client host, and its contents have been verified. If there has been no previous
26645 attempt to verify the HELO/EHLO contents, it is carried out when this
26646 condition is encountered. See the description of the &%helo_verify_hosts%& and
26647 &%helo_try_verify_hosts%& options for details of how to request verification
26648 independently of this condition.
26649
26650 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
26651 option), this condition is always true.
26652
26653
26654 .vitem &*verify&~=&~not_blind*&
26655 .cindex "verifying" "not blind"
26656 .cindex "bcc recipients, verifying none"
26657 This condition checks that there are no blind (bcc) recipients in the message.
26658 Every envelope recipient must appear either in a &'To:'& header line or in a
26659 &'Cc:'& header line for this condition to be true. Local parts are checked
26660 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
26661 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
26662 used only in a DATA or non-SMTP ACL.
26663
26664 There are, of course, many legitimate messages that make use of blind (bcc)
26665 recipients. This check should not be used on its own for blocking messages.
26666
26667
26668 .vitem &*verify&~=&~recipient/*&<&'options'&>
26669 .cindex "&%verify%& ACL condition"
26670 .cindex "&ACL;" "verifying recipient"
26671 .cindex "recipient" "verifying"
26672 .cindex "verifying" "recipient"
26673 .vindex "&$address_data$&"
26674 This condition is relevant only after a RCPT command. It verifies the current
26675 recipient. Details of address verification are given later, starting at section
26676 &<<SECTaddressverification>>&. After a recipient has been verified, the value
26677 of &$address_data$& is the last value that was set while routing the address.
26678 This applies even if the verification fails. When an address that is being
26679 verified is redirected to a single address, verification continues with the new
26680 address, and in that case, the subsequent value of &$address_data$& is the
26681 value for the child address.
26682
26683 .vitem &*verify&~=&~reverse_host_lookup*&
26684 .cindex "&%verify%& ACL condition"
26685 .cindex "&ACL;" "verifying host reverse lookup"
26686 .cindex "host" "verifying reverse lookup"
26687 This condition ensures that a verified host name has been looked up from the IP
26688 address of the client host. (This may have happened already if the host name
26689 was needed for checking a host list, or if the host matched &%host_lookup%&.)
26690 Verification ensures that the host name obtained from a reverse DNS lookup, or
26691 one of its aliases, does, when it is itself looked up in the DNS, yield the
26692 original IP address.
26693
26694 If this condition is used for a locally generated message (that is, when there
26695 is no client host involved), it always succeeds.
26696
26697 .vitem &*verify&~=&~sender/*&<&'options'&>
26698 .cindex "&%verify%& ACL condition"
26699 .cindex "&ACL;" "verifying sender"
26700 .cindex "sender" "verifying"
26701 .cindex "verifying" "sender"
26702 This condition is relevant only after a MAIL or RCPT command, or after a
26703 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
26704 the message's sender is empty (that is, this is a bounce message), the
26705 condition is true. Otherwise, the sender address is verified.
26706
26707 .vindex "&$address_data$&"
26708 .vindex "&$sender_address_data$&"
26709 If there is data in the &$address_data$& variable at the end of routing, its
26710 value is placed in &$sender_address_data$& at the end of verification. This
26711 value can be used in subsequent conditions and modifiers in the same ACL
26712 statement. It does not persist after the end of the current statement. If you
26713 want to preserve the value for longer, you can save it in an ACL variable.
26714
26715 Details of verification are given later, starting at section
26716 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
26717 to avoid doing it more than once per message.
26718
26719 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
26720 .cindex "&%verify%& ACL condition"
26721 This is a variation of the previous option, in which a modified address is
26722 verified as a sender.
26723 .endlist
26724
26725
26726
26727 .section "Using DNS lists" "SECTmorednslists"
26728 .cindex "DNS list" "in ACL"
26729 .cindex "black list (DNS)"
26730 .cindex "&ACL;" "testing a DNS list"
26731 In its simplest form, the &%dnslists%& condition tests whether the calling host
26732 is on at least one of a number of DNS lists by looking up the inverted IP
26733 address in one or more DNS domains. (Note that DNS list domains are not mail
26734 domains, so the &`+`& syntax for named lists doesn't work - it is used for
26735 special options instead.) For example, if the calling host's IP
26736 address is 192.168.62.43, and the ACL statement is
26737 .code
26738 deny dnslists = blackholes.mail-abuse.org : \
26739                 dialups.mail-abuse.org
26740 .endd
26741 the following records are looked up:
26742 .code
26743 43.62.168.192.blackholes.mail-abuse.org
26744 43.62.168.192.dialups.mail-abuse.org
26745 .endd
26746 As soon as Exim finds an existing DNS record, processing of the list stops.
26747 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
26748 to test that a host is on more than one list (an &"and"& conjunction), you can
26749 use two separate conditions:
26750 .code
26751 deny dnslists = blackholes.mail-abuse.org
26752      dnslists = dialups.mail-abuse.org
26753 .endd
26754 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
26755 behaves as if the host does not match the list item, that is, as if the DNS
26756 record does not exist. If there are further items in the DNS list, they are
26757 processed.
26758
26759 This is usually the required action when &%dnslists%& is used with &%deny%&
26760 (which is the most common usage), because it prevents a DNS failure from
26761 blocking mail. However, you can change this behaviour by putting one of the
26762 following special items in the list:
26763 .display
26764 &`+include_unknown `&   behave as if the item is on the list
26765 &`+exclude_unknown `&   behave as if the item is not on the list (default)
26766 &`+defer_unknown   `&   give a temporary error
26767 .endd
26768 .cindex "&`+include_unknown`&"
26769 .cindex "&`+exclude_unknown`&"
26770 .cindex "&`+defer_unknown`&"
26771 Each of these applies to any subsequent items on the list. For example:
26772 .code
26773 deny dnslists = +defer_unknown : foo.bar.example
26774 .endd
26775 Testing the list of domains stops as soon as a match is found. If you want to
26776 warn for one list and block for another, you can use two different statements:
26777 .code
26778 deny  dnslists = blackholes.mail-abuse.org
26779 warn  message  = X-Warn: sending host is on dialups list
26780       dnslists = dialups.mail-abuse.org
26781 .endd
26782 DNS list lookups are cached by Exim for the duration of the SMTP session,
26783 so a lookup based on the IP address is done at most once for any incoming
26784 connection. Exim does not share information between multiple incoming
26785 connections (but your local name server cache should be active).
26786
26787
26788
26789 .section "Specifying the IP address for a DNS list lookup" "SECID201"
26790 .cindex "DNS list" "keyed by explicit IP address"
26791 By default, the IP address that is used in a DNS list lookup is the IP address
26792 of the calling host. However, you can specify another IP address by listing it
26793 after the domain name, introduced by a slash. For example:
26794 .code
26795 deny dnslists = black.list.tld/192.168.1.2
26796 .endd
26797 This feature is not very helpful with explicit IP addresses; it is intended for
26798 use with IP addresses that are looked up, for example, the IP addresses of the
26799 MX hosts or nameservers of an email sender address. For an example, see section
26800 &<<SECTmulkeyfor>>& below.
26801
26802
26803
26804
26805 .section "DNS lists keyed on domain names" "SECID202"
26806 .cindex "DNS list" "keyed by domain name"
26807 There are some lists that are keyed on domain names rather than inverted IP
26808 addresses (see for example the &'domain based zones'& link at
26809 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
26810 with these lists. You can change the name that is looked up in a DNS list by
26811 listing it after the domain name, introduced by a slash. For example,
26812 .code
26813 deny  message  = Sender's domain is listed at $dnslist_domain
26814       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
26815 .endd
26816 This particular example is useful only in ACLs that are obeyed after the
26817 RCPT or DATA commands, when a sender address is available. If (for
26818 example) the message's sender is &'user@tld.example'& the name that is looked
26819 up by this example is
26820 .code
26821 tld.example.dsn.rfc-ignorant.org
26822 .endd
26823 A single &%dnslists%& condition can contain entries for both names and IP
26824 addresses. For example:
26825 .code
26826 deny dnslists = sbl.spamhaus.org : \
26827                 dsn.rfc-ignorant.org/$sender_address_domain
26828 .endd
26829 The first item checks the sending host's IP address; the second checks a domain
26830 name. The whole condition is true if either of the DNS lookups succeeds.
26831
26832
26833
26834
26835 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
26836 .cindex "DNS list" "multiple keys for"
26837 The syntax described above for looking up explicitly-defined values (either
26838 names or IP addresses) in a DNS blacklist is a simplification. After the domain
26839 name for the DNS list, what follows the slash can in fact be a list of items.
26840 As with all lists in Exim, the default separator is a colon. However, because
26841 this is a sublist within the list of DNS blacklist domains, it is necessary
26842 either to double the separators like this:
26843 .code
26844 dnslists = black.list.tld/name.1::name.2
26845 .endd
26846 or to change the separator character, like this:
26847 .code
26848 dnslists = black.list.tld/<;name.1;name.2
26849 .endd
26850 If an item in the list is an IP address, it is inverted before the DNS
26851 blacklist domain is appended. If it is not an IP address, no inversion
26852 occurs. Consider this condition:
26853 .code
26854 dnslists = black.list.tld/<;192.168.1.2;a.domain
26855 .endd
26856 The DNS lookups that occur are:
26857 .code
26858 2.1.168.192.black.list.tld
26859 a.domain.black.list.tld
26860 .endd
26861 Once a DNS record has been found (that matches a specific IP return
26862 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
26863 are done. If there is a temporary DNS error, the rest of the sublist of domains
26864 or IP addresses is tried. A temporary error for the whole dnslists item occurs
26865 only if no other DNS lookup in this sublist succeeds. In other words, a
26866 successful lookup for any of the items in the sublist overrides a temporary
26867 error for a previous item.
26868
26869 The ability to supply a list of items after the slash is in some sense just a
26870 syntactic convenience. These two examples have the same effect:
26871 .code
26872 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
26873 dnslists = black.list.tld/a.domain::b.domain
26874 .endd
26875 However, when the data for the list is obtained from a lookup, the second form
26876 is usually much more convenient. Consider this example:
26877 .code
26878 deny message  = The mail servers for the domain \
26879                 $sender_address_domain \
26880                 are listed at $dnslist_domain ($dnslist_value); \
26881                 see $dnslist_text.
26882      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
26883                                    ${lookup dnsdb {>|mxh=\
26884                                    $sender_address_domain} }} }
26885 .endd
26886 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
26887 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
26888 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
26889 of expanding the condition might be something like this:
26890 .code
26891 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
26892 .endd
26893 Thus, this example checks whether or not the IP addresses of the sender
26894 domain's mail servers are on the Spamhaus black list.
26895
26896 The key that was used for a successful DNS list lookup is put into the variable
26897 &$dnslist_matched$& (see section &<<SECID204>>&).
26898
26899
26900
26901
26902 .section "Data returned by DNS lists" "SECID203"
26903 .cindex "DNS list" "data returned from"
26904 DNS lists are constructed using address records in the DNS. The original RBL
26905 just used the address 127.0.0.1 on the right hand side of each record, but the
26906 RBL+ list and some other lists use a number of values with different meanings.
26907 The values used on the RBL+ list are:
26908 .display
26909 127.1.0.1  RBL
26910 127.1.0.2  DUL
26911 127.1.0.3  DUL and RBL
26912 127.1.0.4  RSS
26913 127.1.0.5  RSS and RBL
26914 127.1.0.6  RSS and DUL
26915 127.1.0.7  RSS and DUL and RBL
26916 .endd
26917 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
26918 different values. Some DNS lists may return more than one address record;
26919 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
26920
26921
26922 .section "Variables set from DNS lists" "SECID204"
26923 .cindex "expansion" "variables, set from DNS list"
26924 .cindex "DNS list" "variables set from"
26925 .vindex "&$dnslist_domain$&"
26926 .vindex "&$dnslist_matched$&"
26927 .vindex "&$dnslist_text$&"
26928 .vindex "&$dnslist_value$&"
26929 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
26930 the name of the overall domain that matched (for example,
26931 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
26932 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
26933 the DNS record. When the key is an IP address, it is not reversed in
26934 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
26935 cases, for example:
26936 .code
26937 deny dnslists = spamhaus.example
26938 .endd
26939 the key is also available in another variable (in this case,
26940 &$sender_host_address$&). In more complicated cases, however, this is not true.
26941 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
26942 might generate a dnslists lookup like this:
26943 .code
26944 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
26945 .endd
26946 If this condition succeeds, the value in &$dnslist_matched$& might be
26947 &`192.168.6.7`& (for example).
26948
26949 If more than one address record is returned by the DNS lookup, all the IP
26950 addresses are included in &$dnslist_value$&, separated by commas and spaces.
26951 The variable &$dnslist_text$& contains the contents of any associated TXT
26952 record. For lists such as RBL+ the TXT record for a merged entry is often not
26953 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
26954 information.
26955
26956 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
26957 &-- although these appear before the condition in the ACL, they are not
26958 expanded until after it has failed. For example:
26959 .code
26960 deny    hosts = !+local_networks
26961         message = $sender_host_address is listed \
26962                   at $dnslist_domain
26963         dnslists = rbl-plus.mail-abuse.example
26964 .endd
26965
26966
26967
26968 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
26969 .cindex "DNS list" "matching specific returned data"
26970 You can add an equals sign and an IP address after a &%dnslists%& domain name
26971 in order to restrict its action to DNS records with a matching right hand side.
26972 For example,
26973 .code
26974 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
26975 .endd
26976 rejects only those hosts that yield 127.0.0.2. Without this additional data,
26977 any address record is considered to be a match. For the moment, we assume
26978 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
26979 describes how multiple records are handled.
26980
26981 More than one IP address may be given for checking, using a comma as a
26982 separator. These are alternatives &-- if any one of them matches, the
26983 &%dnslists%& condition is true. For example:
26984 .code
26985 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
26986 .endd
26987 If you want to specify a constraining address list and also specify names or IP
26988 addresses to be looked up, the constraining address list must be specified
26989 first. For example:
26990 .code
26991 deny dnslists = dsn.rfc-ignorant.org\
26992                 =127.0.0.2/$sender_address_domain
26993 .endd
26994
26995 If the character &`&&`& is used instead of &`=`&, the comparison for each
26996 listed IP address is done by a bitwise &"and"& instead of by an equality test.
26997 In other words, the listed addresses are used as bit masks. The comparison is
26998 true if all the bits in the mask are present in the address that is being
26999 tested. For example:
27000 .code
27001 dnslists = a.b.c&0.0.0.3
27002 .endd
27003 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
27004 want to test whether one bit or another bit is present (as opposed to both
27005 being present), you must use multiple values. For example:
27006 .code
27007 dnslists = a.b.c&0.0.0.1,0.0.0.2
27008 .endd
27009 matches if the final component of the address is an odd number or two times
27010 an odd number.
27011
27012
27013
27014 .section "Negated DNS matching conditions" "SECID205"
27015 You can supply a negative list of IP addresses as part of a &%dnslists%&
27016 condition. Whereas
27017 .code
27018 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
27019 .endd
27020 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
27021 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
27022 .code
27023 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
27024 .endd
27025 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
27026 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
27027 words, the result of the test is inverted if an exclamation mark appears before
27028 the &`=`& (or the &`&&`&) sign.
27029
27030 &*Note*&: This kind of negation is not the same as negation in a domain,
27031 host, or address list (which is why the syntax is different).
27032
27033 If you are using just one list, the negation syntax does not gain you much. The
27034 previous example is precisely equivalent to
27035 .code
27036 deny  dnslists = a.b.c
27037      !dnslists = a.b.c=127.0.0.2,127.0.0.3
27038 .endd
27039 However, if you are using multiple lists, the negation syntax is clearer.
27040 Consider this example:
27041 .code
27042 deny  dnslists = sbl.spamhaus.org : \
27043                  list.dsbl.org : \
27044                  dnsbl.njabl.org!=127.0.0.3 : \
27045                  relays.ordb.org
27046 .endd
27047 Using only positive lists, this would have to be:
27048 .code
27049 deny  dnslists = sbl.spamhaus.org : \
27050                  list.dsbl.org
27051 deny  dnslists = dnsbl.njabl.org
27052      !dnslists = dnsbl.njabl.org=127.0.0.3
27053 deny  dnslists = relays.ordb.org
27054 .endd
27055 which is less clear, and harder to maintain.
27056
27057
27058
27059
27060 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
27061 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
27062 thereby providing more than one IP address. When an item in a &%dnslists%& list
27063 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
27064 the match to specific results from the DNS lookup, there are two ways in which
27065 the checking can be handled. For example, consider the condition:
27066 .code
27067 dnslists = a.b.c=127.0.0.1
27068 .endd
27069 What happens if the DNS lookup for the incoming IP address yields both
27070 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
27071 condition true because at least one given value was found, or is it false
27072 because at least one of the found values was not listed? And how does this
27073 affect negated conditions? Both possibilities are provided for with the help of
27074 additional separators &`==`& and &`=&&`&.
27075
27076 .ilist
27077 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
27078 IP addresses matches one of the listed addresses. For the example above, the
27079 condition is true because 127.0.0.1 matches.
27080 .next
27081 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
27082 looked up IP addresses matches one of the listed addresses. If the condition is
27083 changed to:
27084 .code
27085 dnslists = a.b.c==127.0.0.1
27086 .endd
27087 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27088 false because 127.0.0.2 is not listed. You would need to have:
27089 .code
27090 dnslists = a.b.c==127.0.0.1,127.0.0.2
27091 .endd
27092 for the condition to be true.
27093 .endlist
27094
27095 When &`!`& is used to negate IP address matching, it inverts the result, giving
27096 the precise opposite of the behaviour above. Thus:
27097 .ilist
27098 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
27099 addresses matches one of the listed addresses. Consider:
27100 .code
27101 dnslists = a.b.c!&0.0.0.1
27102 .endd
27103 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27104 false because 127.0.0.1 matches.
27105 .next
27106 If &`!==`& or &`!=&&`& is used, the condition is true there is at least one
27107 looked up IP address that does not match. Consider:
27108 .code
27109 dnslists = a.b.c!=&0.0.0.1
27110 .endd
27111 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27112 true, because 127.0.0.2 does not match. You would need to have:
27113 .code
27114 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
27115 .endd
27116 for the condition to be false.
27117 .endlist
27118 When the DNS lookup yields only a single IP address, there is no difference
27119 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
27120
27121
27122
27123
27124 .section "Detailed information from merged DNS lists" "SECTmordetinf"
27125 .cindex "DNS list" "information from merged"
27126 When the facility for restricting the matching IP values in a DNS list is used,
27127 the text from the TXT record that is set in &$dnslist_text$& may not reflect
27128 the true reason for rejection. This happens when lists are merged and the IP
27129 address in the A record is used to distinguish them; unfortunately there is
27130 only one TXT record. One way round this is not to use merged lists, but that
27131 can be inefficient because it requires multiple DNS lookups where one would do
27132 in the vast majority of cases when the host of interest is not on any of the
27133 lists.
27134
27135 A less inefficient way of solving this problem is available. If
27136 two domain names, comma-separated, are given, the second is used first to
27137 do an initial check, making use of any IP value restrictions that are set.
27138 If there is a match, the first domain is used, without any IP value
27139 restrictions, to get the TXT record. As a byproduct of this, there is also
27140 a check that the IP being tested is indeed on the first list. The first
27141 domain is the one that is put in &$dnslist_domain$&. For example:
27142 .code
27143 reject message  = \
27144          rejected because $sender_host_address is blacklisted \
27145          at $dnslist_domain\n$dnslist_text
27146        dnslists = \
27147          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
27148          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27149 .endd
27150 For the first blacklist item, this starts by doing a lookup in
27151 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
27152 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
27153 value, and as long as something is found, it looks for the corresponding TXT
27154 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
27155 The second blacklist item is processed similarly.
27156
27157 If you are interested in more than one merged list, the same list must be
27158 given several times, but because the results of the DNS lookups are cached,
27159 the DNS calls themselves are not repeated. For example:
27160 .code
27161 reject dnslists = \
27162          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
27163          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
27164          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
27165          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27166 .endd
27167 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
27168 values matches (or if no record is found), this is the only lookup that is
27169 done. Only if there is a match is one of the more specific lists consulted.
27170
27171
27172
27173 .section "DNS lists and IPv6" "SECTmorednslistslast"
27174 .cindex "IPv6" "DNS black lists"
27175 .cindex "DNS list" "IPv6 usage"
27176 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
27177 nibble by nibble. For example, if the calling host's IP address is
27178 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
27179 .code
27180 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
27181   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
27182 .endd
27183 (split over two lines here to fit on the page). Unfortunately, some of the DNS
27184 lists contain wildcard records, intended for IPv4, that interact badly with
27185 IPv6. For example, the DNS entry
27186 .code
27187 *.3.some.list.example.    A    127.0.0.1
27188 .endd
27189 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
27190 Unfortunately, it also matches the entire 3::/4 IPv6 network.
27191
27192 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
27193 &%condition%& condition, as in this example:
27194 .code
27195 deny   condition = ${if isip4{$sender_host_address}}
27196        dnslists  = some.list.example
27197 .endd
27198
27199 .section "Rate limiting incoming messages" "SECTratelimiting"
27200 .cindex "rate limiting" "client sending"
27201 .cindex "limiting client sending rates"
27202 .oindex "&%smtp_ratelimit_*%&"
27203 The &%ratelimit%& ACL condition can be used to measure and control the rate at
27204 which clients can send email. This is more powerful than the
27205 &%smtp_ratelimit_*%& options, because those options control the rate of
27206 commands in a single SMTP session only, whereas the &%ratelimit%& condition
27207 works across all connections (concurrent and sequential) from the same client
27208 host. The syntax of the &%ratelimit%& condition is:
27209 .display
27210 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
27211 .endd
27212 If the average client sending rate is less than &'m'& messages per time
27213 period &'p'& then the condition is false; otherwise it is true.
27214
27215 As a side-effect, the &%ratelimit%& condition sets the expansion variable
27216 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
27217 configured value of &'m'&, and &$sender_rate_period$& to the configured value
27218 of &'p'&.
27219
27220 The parameter &'p'& is the smoothing time constant, in the form of an Exim
27221 time interval, for example, &`8h`& for eight hours. A larger time constant
27222 means that it takes Exim longer to forget a client's past behaviour. The
27223 parameter &'m'& is the maximum number of messages that a client is permitted to
27224 send in each time interval. It also specifies the number of messages permitted
27225 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
27226 constant, you can allow a client to send more messages in a burst without
27227 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
27228 both small, messages must be sent at an even rate.
27229
27230 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
27231 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
27232 when deploying the &%ratelimit%& ACL condition. The script prints usage
27233 instructions when it is run with no arguments.
27234
27235 The key is used to look up the data for calculating the client's average
27236 sending rate. This data is stored in Exim's spool directory, alongside the
27237 retry and other hints databases. The default key is &$sender_host_address$&,
27238 which means Exim computes the sending rate of each client host IP address.
27239 By changing the key you can change how Exim identifies clients for the purpose
27240 of ratelimiting. For example, to limit the sending rate of each authenticated
27241 user, independent of the computer they are sending from, set the key to
27242 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
27243 example, &$authenticated_id$& is only meaningful if the client has
27244 authenticated (which you can check with the &%authenticated%& ACL condition).
27245
27246 The lookup key does not have to identify clients: If you want to limit the
27247 rate at which a recipient receives messages, you can use the key
27248 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
27249 ACL.
27250
27251 Internally, Exim appends the smoothing constant &'p'& and the options onto the
27252 lookup key because they alter the meaning of the stored data. This is not true
27253 for the limit &'m'&, so you can alter the configured maximum rate and Exim will
27254 still remember clients' past behaviour, but if you alter the other ratelimit
27255 parameters Exim forgets past behaviour.
27256
27257 Each &%ratelimit%& condition can have up to three options. One option
27258 specifies what Exim measures the rate of, and the second specifies how Exim
27259 handles excessively fast clients. The third option can be &`noupdate`&, to
27260 disable updating of the ratelimiting database (see section &<<rearatdat>>&).
27261 The options are separated by a slash, like the other parameters. They may
27262 appear in any order.
27263
27264 .section "Ratelimit options for what is being measured" "ratoptmea"
27265 The &%per_conn%& option limits the client's connection rate.
27266
27267 The &%per_mail%& option limits the client's rate of sending messages. This is
27268 the default if none of the &%per_*%& options is specified.
27269
27270 The &%per_byte%& option limits the sender's email bandwidth. Note that it is
27271 best to use this option in the DATA ACL; if it is used in an earlier ACL it
27272 relies on the SIZE parameter specified by the client in its MAIL command,
27273 which may be inaccurate or completely missing. You can follow the limit &'m'&
27274 in the configuration with K, M, or G to specify limits in kilobytes,
27275 megabytes, or gigabytes, respectively.
27276
27277 The &%per_rcpt%& option causes Exim to limit the rate at which
27278 recipients are accepted. To be effective, it would need to be used in
27279 either the &%acl_smtp_rcpt%& or the &%acl_not_smtp%& ACL. In the
27280 &%acl_smtp_rcpt%& ACL, the number of recipients is incremented by one.
27281 In the case of a locally submitted message in the &%acl_not_smtp%& ACL,
27282 the number of recipients is incremented by the &%$recipients_count%&
27283 for the entire message. Note that in either case the rate limiting
27284 engine will see a message with many recipients as a large high-speed
27285 burst.
27286
27287 The &%per_cmd%& option causes Exim to recompute the rate every time the
27288 condition is processed. This can be used to limit the SMTP command rate.
27289 This command is essentially an alias of &%per_rcpt%& to make it clear
27290 that the effect is to limit the rate at which individual commands,
27291 rather than recipients, are accepted.
27292
27293 .section "Ratelimit options for handling fast clients" "ratophanfas"
27294 If a client's average rate is greater than the maximum, the rate limiting
27295 engine can react in two possible ways, depending on the presence of the
27296 &%strict%& or &%leaky%& options. This is independent of the other
27297 counter-measures (such as rejecting the message) that may be specified by the
27298 rest of the ACL. The default mode is leaky, which avoids a sender's
27299 over-aggressive retry rate preventing it from getting any email through.
27300
27301 The &%strict%& option means that the client's recorded rate is always
27302 updated. The effect of this is that Exim measures the client's average rate
27303 of attempts to send email, which can be much higher than the maximum it is
27304 actually allowed. If the client is over the limit it may be subjected to
27305 counter-measures by the ACL until it slows down below the maximum rate. If
27306 the client stops attempting to send email for the time specified in the &'p'&
27307 parameter then its computed rate will decay exponentially to 37% of its peak
27308 value. You can work out the time (the number of smoothing periods) that a
27309 client is subjected to counter-measures after an over-limit burst with this
27310 formula:
27311 .code
27312         ln(peakrate/maxrate)
27313 .endd
27314 The &%leaky%& (default) option means that the client's recorded rate is not
27315 updated if it is above the limit. The effect of this is that Exim measures the
27316 client's average rate of successfully sent email, which cannot be greater than
27317 the maximum allowed. If the client is over the limit it may suffer some
27318 counter-measures (as specified in the ACL), but it will still be able to send
27319 email at the configured maximum rate, whatever the rate of its attempts. This
27320 is generally the better choice if you have clients that retry automatically.
27321
27322 .section "Using rate limiting" "useratlim"
27323 Exim's other ACL facilities are used to define what counter-measures are taken
27324 when the rate limit is exceeded. This might be anything from logging a warning
27325 (for example, while measuring existing sending rates in order to define
27326 policy), through time delays to slow down fast senders, up to rejecting the
27327 message. For example:
27328 .code
27329 # Log all senders' rates
27330 warn ratelimit = 0 / 1h / strict
27331      log_message = Sender rate $sender_rate / $sender_rate_period
27332
27333 # Slow down fast senders; note the need to truncate $sender_rate
27334 # at the decimal point.
27335 warn ratelimit = 100 / 1h / per_rcpt / strict
27336      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
27337                    $sender_rate_limit }s
27338
27339 # Keep authenticated users under control
27340 deny authenticated = *
27341      ratelimit = 100 / 1d / strict / $authenticated_id
27342
27343 # System-wide rate limit
27344 defer message = Sorry, too busy. Try again later.
27345      ratelimit = 10 / 1s / $primary_hostname
27346
27347 # Restrict incoming rate from each host, with a default
27348 # set using a macro and special cases looked up in a table.
27349 defer message = Sender rate exceeds $sender_rate_limit \
27350                messages per $sender_rate_period
27351      ratelimit = ${lookup {$sender_host_address} \
27352                    cdb {DB/ratelimits.cdb} \
27353                    {$value} {RATELIMIT} }
27354 .endd
27355 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
27356 especially with the &%per_rcpt%& option, you may suffer from a performance
27357 bottleneck caused by locking on the ratelimit hints database. Apart from
27358 making your ACLs less complicated, you can reduce the problem by using a
27359 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
27360 this means that Exim will lose its hints data after a reboot (including retry
27361 hints, the callout cache, and ratelimit data).
27362
27363
27364 .section "Reading ratelimit data without updating" "rearatdat"
27365 .cindex "rate limitint" "reading data without updating"
27366 If the &%noupdate%& option is present on a &%ratelimit%& ACL condition, Exim
27367 computes the rate and checks the limit as normal, but it does not update the
27368 saved data. This means that, in relevant ACLs, it is possible to lookup the
27369 existence of a specified (or auto-generated) ratelimit key without incrementing
27370 the ratelimit counter for that key. In order for this to be useful, another ACL
27371 entry must set the rate for the same key (otherwise it will always be zero).
27372 For example:
27373 .code
27374 acl_check_connect:
27375   deny ratelimit = 100 / 5m / strict / per_cmd / noupdate
27376        log_message = RATE: $sender_rate/$sender_rate_period \
27377                      (max $sender_rate_limit)
27378 .endd
27379 .display
27380 &'... some other logic and tests...'&
27381 .endd
27382 .code
27383 acl_check_mail:
27384   warn ratelimit = 100 / 5m / strict / per_cmd
27385        condition = ${if le{$sender_rate}{$sender_rate_limit}}
27386        logwrite  = RATE UPDATE: $sender_rate/$sender_rate_period \
27387                      (max $sender_rate_limit)
27388 .endd
27389 In this example, the rate is tested and used to deny access (when it is too
27390 high) in the connect ACL, but the actual computation of the remembered rate
27391 happens later, on a per-command basis, in another ACL.
27392
27393
27394
27395 .section "Address verification" "SECTaddressverification"
27396 .cindex "verifying address" "options for"
27397 .cindex "policy control" "address verification"
27398 Several of the &%verify%& conditions described in section
27399 &<<SECTaclconditions>>& cause addresses to be verified. Section
27400 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
27401 The verification conditions can be followed by options that modify the
27402 verification process. The options are separated from the keyword and from each
27403 other by slashes, and some of them contain parameters. For example:
27404 .code
27405 verify = sender/callout
27406 verify = recipient/defer_ok/callout=10s,defer_ok
27407 .endd
27408 The first stage of address verification, which always happens, is to run the
27409 address through the routers, in &"verify mode"&. Routers can detect the
27410 difference between verification and routing for delivery, and their actions can
27411 be varied by a number of generic options such as &%verify%& and &%verify_only%&
27412 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
27413 The available options are as follows:
27414
27415 .ilist
27416 If the &%callout%& option is specified, successful routing to one or more
27417 remote hosts is followed by a &"callout"& to those hosts as an additional
27418 check. Callouts and their sub-options are discussed in the next section.
27419 .next
27420 If there is a defer error while doing verification routing, the ACL
27421 normally returns &"defer"&. However, if you include &%defer_ok%& in the
27422 options, the condition is forced to be true instead. Note that this is a main
27423 verification option as well as a suboption for callouts.
27424 .next
27425 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
27426 discusses the reporting of sender address verification failures.
27427 .next
27428 The &%success_on_redirect%& option causes verification always to succeed
27429 immediately after a successful redirection. By default, if a redirection
27430 generates just one address, that address is also verified. See further
27431 discussion in section &<<SECTredirwhilveri>>&.
27432 .endlist
27433
27434 .cindex "verifying address" "differentiating failures"
27435 .vindex "&$recipient_verify_failure$&"
27436 .vindex "&$sender_verify_failure$&"
27437 .vindex "&$acl_verify_message$&"
27438 After an address verification failure, &$acl_verify_message$& contains the
27439 error message that is associated with the failure. It can be preserved by
27440 coding like this:
27441 .code
27442 warn  !verify = sender
27443        set acl_m0 = $acl_verify_message
27444 .endd
27445 If you are writing your own custom rejection message or log message when
27446 denying access, you can use this variable to include information about the
27447 verification failure.
27448
27449 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
27450 appropriate) contains one of the following words:
27451
27452 .ilist
27453 &%qualify%&: The address was unqualified (no domain), and the message
27454 was neither local nor came from an exempted host.
27455 .next
27456 &%route%&: Routing failed.
27457 .next
27458 &%mail%&: Routing succeeded, and a callout was attempted; rejection
27459 occurred at or before the MAIL command (that is, on initial
27460 connection, HELO, or MAIL).
27461 .next
27462 &%recipient%&: The RCPT command in a callout was rejected.
27463 .next
27464 &%postmaster%&: The postmaster check in a callout was rejected.
27465 .endlist
27466
27467 The main use of these variables is expected to be to distinguish between
27468 rejections of MAIL and rejections of RCPT in callouts.
27469
27470
27471
27472
27473 .section "Callout verification" "SECTcallver"
27474 .cindex "verifying address" "by callout"
27475 .cindex "callout" "verification"
27476 .cindex "SMTP" "callout verification"
27477 For non-local addresses, routing verifies the domain, but is unable to do any
27478 checking of the local part. There are situations where some means of verifying
27479 the local part is desirable. One way this can be done is to make an SMTP
27480 &'callback'& to a delivery host for the sender address or a &'callforward'& to
27481 a subsequent host for a recipient address, to see if the host accepts the
27482 address. We use the term &'callout'& to cover both cases. Note that for a
27483 sender address, the callback is not to the client host that is trying to
27484 deliver the message, but to one of the hosts that accepts incoming mail for the
27485 sender's domain.
27486
27487 Exim does not do callouts by default. If you want them to happen, you must
27488 request them by setting appropriate options on the &%verify%& condition, as
27489 described below. This facility should be used with care, because it can add a
27490 lot of resource usage to the cost of verifying an address. However, Exim does
27491 cache the results of callouts, which helps to reduce the cost. Details of
27492 caching are in section &<<SECTcallvercache>>&.
27493
27494 Recipient callouts are usually used only between hosts that are controlled by
27495 the same administration. For example, a corporate gateway host could use
27496 callouts to check for valid recipients on an internal mailserver. A successful
27497 callout does not guarantee that a real delivery to the address would succeed;
27498 on the other hand, a failing callout does guarantee that a delivery would fail.
27499
27500 If the &%callout%& option is present on a condition that verifies an address, a
27501 second stage of verification occurs if the address is successfully routed to
27502 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
27503 &(manualroute)& router, where the router specifies the hosts. However, if a
27504 router that does not set up hosts routes to an &(smtp)& transport with a
27505 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
27506 &%hosts_override%& set, its hosts are always used, whether or not the router
27507 supplies a host list.
27508
27509 The port that is used is taken from the transport, if it is specified and is a
27510 remote transport. (For routers that do verification only, no transport need be
27511 specified.) Otherwise, the default SMTP port is used. If a remote transport
27512 specifies an outgoing interface, this is used; otherwise the interface is not
27513 specified. Likewise, the text that is used for the HELO command is taken from
27514 the transport's &%helo_data%& option; if there is no transport, the value of
27515 &$smtp_active_hostname$& is used.
27516
27517 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
27518 test whether a bounce message could be delivered to the sender address. The
27519 following SMTP commands are sent:
27520 .display
27521 &`HELO `&<&'local host name'&>
27522 &`MAIL FROM:<>`&
27523 &`RCPT TO:`&<&'the address to be tested'&>
27524 &`QUIT`&
27525 .endd
27526 LHLO is used instead of HELO if the transport's &%protocol%& option is
27527 set to &"lmtp"&.
27528
27529 A recipient callout check is similar. By default, it also uses an empty address
27530 for the sender. This default is chosen because most hosts do not make use of
27531 the sender address when verifying a recipient. Using the same address means
27532 that a single cache entry can be used for each recipient. Some sites, however,
27533 do make use of the sender address when verifying. These are catered for by the
27534 &%use_sender%& and &%use_postmaster%& options, described in the next section.
27535
27536 If the response to the RCPT command is a 2&'xx'& code, the verification
27537 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
27538 Exim tries the next host, if any. If there is a problem with all the remote
27539 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
27540 &%callout%& option is given, in which case the condition is forced to succeed.
27541
27542 .cindex "SMTP" "output flushing, disabling for callout"
27543 A callout may take a little time. For this reason, Exim normally flushes SMTP
27544 output before performing a callout in an ACL, to avoid unexpected timeouts in
27545 clients when the SMTP PIPELINING extension is in use. The flushing can be
27546 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
27547
27548
27549
27550
27551 .section "Additional parameters for callouts" "CALLaddparcall"
27552 .cindex "callout" "additional parameters for"
27553 The &%callout%& option can be followed by an equals sign and a number of
27554 optional parameters, separated by commas. For example:
27555 .code
27556 verify = recipient/callout=10s,defer_ok
27557 .endd
27558 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
27559 separate verify options, is retained for backwards compatibility, but is now
27560 deprecated. The additional parameters for &%callout%& are as follows:
27561
27562
27563 .vlist
27564 .vitem <&'a&~time&~interval'&>
27565 .cindex "callout" "timeout, specifying"
27566 This specifies the timeout that applies for the callout attempt to each host.
27567 For example:
27568 .code
27569 verify = sender/callout=5s
27570 .endd
27571 The default is 30 seconds. The timeout is used for each response from the
27572 remote host. It is also used for the initial connection, unless overridden by
27573 the &%connect%& parameter.
27574
27575
27576 .vitem &*connect&~=&~*&<&'time&~interval'&>
27577 .cindex "callout" "connection timeout, specifying"
27578 This parameter makes it possible to set a different (usually smaller) timeout
27579 for making the SMTP connection. For example:
27580 .code
27581 verify = sender/callout=5s,connect=1s
27582 .endd
27583 If not specified, this timeout defaults to the general timeout value.
27584
27585 .vitem &*defer_ok*&
27586 .cindex "callout" "defer, action on"
27587 When this parameter is present, failure to contact any host, or any other kind
27588 of temporary error, is treated as success by the ACL. However, the cache is not
27589 updated in this circumstance.
27590
27591 .vitem &*fullpostmaster*&
27592 .cindex "callout" "full postmaster check"
27593 This operates like the &%postmaster%& option (see below), but if the check for
27594 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
27595 accordance with the specification in RFC 2821. The RFC states that the
27596 unqualified address &'postmaster'& should be accepted.
27597
27598
27599 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
27600 .cindex "callout" "sender when verifying header"
27601 When verifying addresses in header lines using the &%header_sender%&
27602 verification option, Exim behaves by default as if the addresses are envelope
27603 sender addresses from a message. Callout verification therefore tests to see
27604 whether a bounce message could be delivered, by using an empty address in the
27605 MAIL command. However, it is arguable that these addresses might never be used
27606 as envelope senders, and could therefore justifiably reject bounce messages
27607 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
27608 address to use in the MAIL command. For example:
27609 .code
27610 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
27611 .endd
27612 This parameter is available only for the &%header_sender%& verification option.
27613
27614
27615 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
27616 .cindex "callout" "overall timeout, specifying"
27617 This parameter sets an overall timeout for performing a callout verification.
27618 For example:
27619 .code
27620 verify = sender/callout=5s,maxwait=30s
27621 .endd
27622 This timeout defaults to four times the callout timeout for individual SMTP
27623 commands. The overall timeout applies when there is more than one host that can
27624 be tried. The timeout is checked before trying the next host. This prevents
27625 very long delays if there are a large number of hosts and all are timing out
27626 (for example, when network connections are timing out).
27627
27628
27629 .vitem &*no_cache*&
27630 .cindex "callout" "cache, suppressing"
27631 .cindex "caching callout, suppressing"
27632 When this parameter is given, the callout cache is neither read nor updated.
27633
27634 .vitem &*postmaster*&
27635 .cindex "callout" "postmaster; checking"
27636 When this parameter is set, a successful callout check is followed by a similar
27637 check for the local part &'postmaster'& at the same domain. If this address is
27638 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
27639 the postmaster check is recorded in a cache record; if it is a failure, this is
27640 used to fail subsequent callouts for the domain without a connection being
27641 made, until the cache record expires.
27642
27643 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
27644 The postmaster check uses an empty sender in the MAIL command by default.
27645 You can use this parameter to do a postmaster check using a different address.
27646 For example:
27647 .code
27648 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
27649 .endd
27650 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
27651 one overrides. The &%postmaster%& parameter is equivalent to this example:
27652 .code
27653 require  verify = sender/callout=postmaster_mailfrom=
27654 .endd
27655 &*Warning*&: The caching arrangements for postmaster checking do not take
27656 account of the sender address. It is assumed that either the empty address or
27657 a fixed non-empty address will be used. All that Exim remembers is that the
27658 postmaster check for the domain succeeded or failed.
27659
27660
27661 .vitem &*random*&
27662 .cindex "callout" "&""random""& check"
27663 When this parameter is set, before doing the normal callout check, Exim does a
27664 check for a &"random"& local part at the same domain. The local part is not
27665 really random &-- it is defined by the expansion of the option
27666 &%callout_random_local_part%&, which defaults to
27667 .code
27668 $primary_host_name-$tod_epoch-testing
27669 .endd
27670 The idea here is to try to determine whether the remote host accepts all local
27671 parts without checking. If it does, there is no point in doing callouts for
27672 specific local parts. If the &"random"& check succeeds, the result is saved in
27673 a cache record, and used to force the current and subsequent callout checks to
27674 succeed without a connection being made, until the cache record expires.
27675
27676 .vitem &*use_postmaster*&
27677 .cindex "callout" "sender for recipient check"
27678 This parameter applies to recipient callouts only. For example:
27679 .code
27680 deny  !verify = recipient/callout=use_postmaster
27681 .endd
27682 .vindex "&$qualify_domain$&"
27683 It causes a non-empty postmaster address to be used in the MAIL command when
27684 performing the callout for the recipient, and also for a &"random"& check if
27685 that is configured. The local part of the address is &`postmaster`& and the
27686 domain is the contents of &$qualify_domain$&.
27687
27688 .vitem &*use_sender*&
27689 This option applies to recipient callouts only. For example:
27690 .code
27691 require  verify = recipient/callout=use_sender
27692 .endd
27693 It causes the message's actual sender address to be used in the MAIL
27694 command when performing the callout, instead of an empty address. There is no
27695 need to use this option unless you know that the called hosts make use of the
27696 sender when checking recipients. If used indiscriminately, it reduces the
27697 usefulness of callout caching.
27698 .endlist
27699
27700 If you use any of the parameters that set a non-empty sender for the MAIL
27701 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
27702 &%use_sender%&), you should think about possible loops. Recipient checking is
27703 usually done between two hosts that are under the same management, and the host
27704 that receives the callouts is not normally configured to do callouts itself.
27705 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
27706 these circumstances.
27707
27708 However, if you use a non-empty sender address for a callout to an arbitrary
27709 host, there is the likelihood that the remote host will itself initiate a
27710 callout check back to your host. As it is checking what appears to be a message
27711 sender, it is likely to use an empty address in MAIL, thus avoiding a
27712 callout loop. However, to be on the safe side it would be best to set up your
27713 own ACLs so that they do not do sender verification checks when the recipient
27714 is the address you use for header sender or postmaster callout checking.
27715
27716 Another issue to think about when using non-empty senders for callouts is
27717 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
27718 by the sender/recipient combination; thus, for any given recipient, many more
27719 actual callouts are performed than when an empty sender or postmaster is used.
27720
27721
27722
27723
27724 .section "Callout caching" "SECTcallvercache"
27725 .cindex "hints database" "callout cache"
27726 .cindex "callout" "cache, description of"
27727 .cindex "caching" "callout"
27728 Exim caches the results of callouts in order to reduce the amount of resources
27729 used, unless you specify the &%no_cache%& parameter with the &%callout%&
27730 option. A hints database called &"callout"& is used for the cache. Two
27731 different record types are used: one records the result of a callout check for
27732 a specific address, and the other records information that applies to the
27733 entire domain (for example, that it accepts the local part &'postmaster'&).
27734
27735 When an original callout fails, a detailed SMTP error message is given about
27736 the failure. However, for subsequent failures use the cache data, this message
27737 is not available.
27738
27739 The expiry times for negative and positive address cache records are
27740 independent, and can be set by the global options &%callout_negative_expire%&
27741 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
27742
27743 If a host gives a negative response to an SMTP connection, or rejects any
27744 commands up to and including
27745 .code
27746 MAIL FROM:<>
27747 .endd
27748 (but not including the MAIL command with a non-empty address),
27749 any callout attempt is bound to fail. Exim remembers such failures in a
27750 domain cache record, which it uses to fail callouts for the domain without
27751 making new connections, until the domain record times out. There are two
27752 separate expiry times for domain cache records:
27753 &%callout_domain_negative_expire%& (default 3h) and
27754 &%callout_domain_positive_expire%& (default 7d).
27755
27756 Domain records expire when the negative expiry time is reached if callouts
27757 cannot be made for the domain, or if the postmaster check failed.
27758 Otherwise, they expire when the positive expiry time is reached. This
27759 ensures that, for example, a host that stops accepting &"random"& local parts
27760 will eventually be noticed.
27761
27762 The callout caching mechanism is based on the domain of the address that is
27763 being tested. If the domain routes to several hosts, it is assumed that their
27764 behaviour will be the same.
27765
27766
27767
27768 .section "Sender address verification reporting" "SECTsenaddver"
27769 .cindex "verifying" "suppressing error details"
27770 See section &<<SECTaddressverification>>& for a general discussion of
27771 verification. When sender verification fails in an ACL, the details of the
27772 failure are given as additional output lines before the 550 response to the
27773 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
27774 you might see:
27775 .code
27776 MAIL FROM:<xyz@abc.example>
27777 250 OK
27778 RCPT TO:<pqr@def.example>
27779 550-Verification failed for <xyz@abc.example>
27780 550-Called:   192.168.34.43
27781 550-Sent:     RCPT TO:<xyz@abc.example>
27782 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
27783 550 Sender verification failed
27784 .endd
27785 If more than one RCPT command fails in the same way, the details are given
27786 only for the first of them. However, some administrators do not want to send
27787 out this much information. You can suppress the details by adding
27788 &`/no_details`& to the ACL statement that requests sender verification. For
27789 example:
27790 .code
27791 verify = sender/no_details
27792 .endd
27793
27794 .section "Redirection while verifying" "SECTredirwhilveri"
27795 .cindex "verifying" "redirection while"
27796 .cindex "address redirection" "while verifying"
27797 A dilemma arises when a local address is redirected by aliasing or forwarding
27798 during verification: should the generated addresses themselves be verified,
27799 or should the successful expansion of the original address be enough to verify
27800 it? By default, Exim takes the following pragmatic approach:
27801
27802 .ilist
27803 When an incoming address is redirected to just one child address, verification
27804 continues with the child address, and if that fails to verify, the original
27805 verification also fails.
27806 .next
27807 When an incoming address is redirected to more than one child address,
27808 verification does not continue. A success result is returned.
27809 .endlist
27810
27811 This seems the most reasonable behaviour for the common use of aliasing as a
27812 way of redirecting different local parts to the same mailbox. It means, for
27813 example, that a pair of alias entries of the form
27814 .code
27815 A.Wol:   aw123
27816 aw123:   :fail: Gone away, no forwarding address
27817 .endd
27818 work as expected, with both local parts causing verification failure. When a
27819 redirection generates more than one address, the behaviour is more like a
27820 mailing list, where the existence of the alias itself is sufficient for
27821 verification to succeed.
27822
27823 It is possible, however, to change the default behaviour so that all successful
27824 redirections count as successful verifications, however many new addresses are
27825 generated. This is specified by the &%success_on_redirect%& verification
27826 option. For example:
27827 .code
27828 require verify = recipient/success_on_redirect/callout=10s
27829 .endd
27830 In this example, verification succeeds if a router generates a new address, and
27831 the callout does not occur, because no address was routed to a remote host.
27832
27833 When verification is being tested via the &%-bv%& option, the treatment of
27834 redirections is as just described, unless the &%-v%& or any debugging option is
27835 also specified. In that case, full verification is done for every generated
27836 address and a report is output for each of them.
27837
27838
27839
27840 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
27841 .cindex "CSA" "verifying"
27842 Client SMTP Authorization is a system that allows a site to advertise
27843 which machines are and are not permitted to send email. This is done by placing
27844 special SRV records in the DNS; these are looked up using the client's HELO
27845 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
27846 Authorization checks in Exim are performed by the ACL condition:
27847 .code
27848 verify = csa
27849 .endd
27850 This fails if the client is not authorized. If there is a DNS problem, or if no
27851 valid CSA SRV record is found, or if the client is authorized, the condition
27852 succeeds. These three cases can be distinguished using the expansion variable
27853 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
27854 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
27855 be likely to cause problems for legitimate email.
27856
27857 The error messages produced by the CSA code include slightly more
27858 detail. If &$csa_status$& is &"defer"&, this may be because of problems
27859 looking up the CSA SRV record, or problems looking up the CSA target
27860 address record. There are four reasons for &$csa_status$& being &"fail"&:
27861
27862 .ilist
27863 The client's host name is explicitly not authorized.
27864 .next
27865 The client's IP address does not match any of the CSA target IP addresses.
27866 .next
27867 The client's host name is authorized but it has no valid target IP addresses
27868 (for example, the target's addresses are IPv6 and the client is using IPv4).
27869 .next
27870 The client's host name has no CSA SRV record but a parent domain has asserted
27871 that all subdomains must be explicitly authorized.
27872 .endlist
27873
27874 The &%csa%& verification condition can take an argument which is the domain to
27875 use for the DNS query. The default is:
27876 .code
27877 verify = csa/$sender_helo_name
27878 .endd
27879 This implementation includes an extension to CSA. If the query domain
27880 is an address literal such as [192.0.2.95], or if it is a bare IP
27881 address, Exim searches for CSA SRV records in the reverse DNS as if
27882 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
27883 meaningful to say:
27884 .code
27885 verify = csa/$sender_host_address
27886 .endd
27887 In fact, this is the check that Exim performs if the client does not say HELO.
27888 This extension can be turned off by setting the main configuration option
27889 &%dns_csa_use_reverse%& to be false.
27890
27891 If a CSA SRV record is not found for the domain itself, a search
27892 is performed through its parent domains for a record which might be
27893 making assertions about subdomains. The maximum depth of this search is limited
27894 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
27895 default. Exim does not look for CSA SRV records in a top level domain, so the
27896 default settings handle HELO domains as long as seven
27897 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
27898 of legitimate HELO domains.
27899
27900 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
27901 direct SRV lookups, this is not sufficient because of the extra parent domain
27902 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
27903 addresses into lookups in the reverse DNS space. The result of a successful
27904 lookup such as:
27905 .code
27906 ${lookup dnsdb {csa=$sender_helo_name}}
27907 .endd
27908 has two space-separated fields: an authorization code and a target host name.
27909 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
27910 authorization required but absent, or &"?"& for unknown.
27911
27912
27913
27914
27915 .section "Bounce address tag validation" "SECTverifyPRVS"
27916 .cindex "BATV, verifying"
27917 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
27918 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
27919 Genuine incoming bounce messages should therefore always be addressed to
27920 recipients that have a valid tag. This scheme is a way of detecting unwanted
27921 bounce messages caused by sender address forgeries (often called &"collateral
27922 spam"&), because the recipients of such messages do not include valid tags.
27923
27924 There are two expansion items to help with the implementation of the BATV
27925 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
27926 the original envelope sender address by using a simple key to add a hash of the
27927 address and some time-based randomizing information. The &%prvs%& expansion
27928 item creates a signed address, and the &%prvscheck%& expansion item checks one.
27929 The syntax of these expansion items is described in section
27930 &<<SECTexpansionitems>>&.
27931
27932 As an example, suppose the secret per-address keys are stored in an MySQL
27933 database. A query to look up the key for an address could be defined as a macro
27934 like this:
27935 .code
27936 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
27937                 WHERE sender='${quote_mysql:$prvscheck_address}'\
27938                 }{$value}}
27939 .endd
27940 Suppose also that the senders who make use of BATV are defined by an address
27941 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
27942 use this:
27943 .code
27944 # Bounces: drop unsigned addresses for BATV senders
27945 deny message = This address does not send an unsigned reverse path
27946      senders = :
27947      recipients = +batv_senders
27948
27949 # Bounces: In case of prvs-signed address, check signature.
27950 deny message = Invalid reverse path signature.
27951      senders = :
27952      condition  = ${prvscheck {$local_part@$domain}\
27953                   {PRVSCHECK_SQL}{1}}
27954      !condition = $prvscheck_result
27955 .endd
27956 The first statement rejects recipients for bounce messages that are addressed
27957 to plain BATV sender addresses, because it is known that BATV senders do not
27958 send out messages with plain sender addresses. The second statement rejects
27959 recipients that are prvs-signed, but with invalid signatures (either because
27960 the key is wrong, or the signature has timed out).
27961
27962 A non-prvs-signed address is not rejected by the second statement, because the
27963 &%prvscheck%& expansion yields an empty string if its first argument is not a
27964 prvs-signed address, thus causing the &%condition%& condition to be false. If
27965 the first argument is a syntactically valid prvs-signed address, the yield is
27966 the third string (in this case &"1"&), whether or not the cryptographic and
27967 timeout checks succeed. The &$prvscheck_result$& variable contains the result
27968 of the checks (empty for failure, &"1"& for success).
27969
27970 There is one more issue you must consider when implementing prvs-signing:
27971 you have to ensure that the routers accept prvs-signed addresses and
27972 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
27973 router to remove the signature with a configuration along these lines:
27974 .code
27975 batv_redirect:
27976   driver = redirect
27977   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
27978 .endd
27979 This works because, if the third argument of &%prvscheck%& is empty, the result
27980 of the expansion of a prvs-signed address is the decoded value of the original
27981 address. This router should probably be the first of your routers that handles
27982 local addresses.
27983
27984 To create BATV-signed addresses in the first place, a transport of this form
27985 can be used:
27986 .code
27987 external_smtp_batv:
27988   driver = smtp
27989   return_path = ${prvs {$return_path} \
27990                        {${lookup mysql{SELECT \
27991                        secret FROM batv_prvs WHERE \
27992                        sender='${quote_mysql:$sender_address}'} \
27993                        {$value}fail}}}
27994 .endd
27995 If no key can be found for the existing return path, no signing takes place.
27996
27997
27998
27999 .section "Using an ACL to control relaying" "SECTrelaycontrol"
28000 .cindex "&ACL;" "relay control"
28001 .cindex "relaying" "control by ACL"
28002 .cindex "policy control" "relay control"
28003 An MTA is said to &'relay'& a message if it receives it from some host and
28004 delivers it directly to another host as a result of a remote address contained
28005 within it. Redirecting a local address via an alias or forward file and then
28006 passing the message on to another host is not relaying,
28007 .cindex "&""percent hack""&"
28008 but a redirection as a result of the &"percent hack"& is.
28009
28010 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
28011 A host which is acting as a gateway or an MX backup is concerned with incoming
28012 relaying from arbitrary hosts to a specific set of domains. On the other hand,
28013 a host which is acting as a smart host for a number of clients is concerned
28014 with outgoing relaying from those clients to the Internet at large. Often the
28015 same host is fulfilling both functions,
28016 . ///
28017 . as illustrated in the diagram below,
28018 . ///
28019 but in principle these two kinds of relaying are entirely independent. What is
28020 not wanted is the transmission of mail from arbitrary remote hosts through your
28021 system to arbitrary domains.
28022
28023
28024 You can implement relay control by means of suitable statements in the ACL that
28025 runs for each RCPT command. For convenience, it is often easiest to use
28026 Exim's named list facility to define the domains and hosts involved. For
28027 example, suppose you want to do the following:
28028
28029 .ilist
28030 Deliver a number of domains to mailboxes on the local host (or process them
28031 locally in some other way). Let's say these are &'my.dom1.example'& and
28032 &'my.dom2.example'&.
28033 .next
28034 Relay mail for a number of other domains for which you are the secondary MX.
28035 These might be &'friend1.example'& and &'friend2.example'&.
28036 .next
28037 Relay mail from the hosts on your local LAN, to whatever domains are involved.
28038 Suppose your LAN is 192.168.45.0/24.
28039 .endlist
28040
28041
28042 In the main part of the configuration, you put the following definitions:
28043 .code
28044 domainlist local_domains = my.dom1.example : my.dom2.example
28045 domainlist relay_domains = friend1.example : friend2.example
28046 hostlist   relay_hosts   = 192.168.45.0/24
28047 .endd
28048 Now you can use these definitions in the ACL that is run for every RCPT
28049 command:
28050 .code
28051 acl_check_rcpt:
28052   accept domains = +local_domains : +relay_domains
28053   accept hosts   = +relay_hosts
28054 .endd
28055 The first statement accepts any RCPT command that contains an address in
28056 the local or relay domains. For any other domain, control passes to the second
28057 statement, which accepts the command only if it comes from one of the relay
28058 hosts. In practice, you will probably want to make your ACL more sophisticated
28059 than this, for example, by including sender and recipient verification. The
28060 default configuration includes a more comprehensive example, which is described
28061 in chapter &<<CHAPdefconfil>>&.
28062
28063
28064
28065 .section "Checking a relay configuration" "SECTcheralcon"
28066 .cindex "relaying" "checking control of"
28067 You can check the relay characteristics of your configuration in the same way
28068 that you can test any ACL behaviour for an incoming SMTP connection, by using
28069 the &%-bh%& option to run a fake SMTP session with which you interact.
28070
28071 For specifically testing for unwanted relaying, the host
28072 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
28073 host from the host on which Exim is running, using the normal telnet port, you
28074 will see a normal telnet connection message and then quite a long delay. Be
28075 patient. The remote host is making an SMTP connection back to your host, and
28076 trying a number of common probes to test for open relay vulnerability. The
28077 results of the tests will eventually appear on your terminal.
28078 .ecindex IIDacl
28079
28080
28081
28082 . ////////////////////////////////////////////////////////////////////////////
28083 . ////////////////////////////////////////////////////////////////////////////
28084
28085 .chapter "Content scanning at ACL time" "CHAPexiscan"
28086 .scindex IIDcosca "content scanning" "at ACL time"
28087 The extension of Exim to include content scanning at ACL time, formerly known
28088 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
28089 was integrated into the main source for Exim release 4.50, and Tom continues to
28090 maintain it. Most of the wording of this chapter is taken from Tom's
28091 specification.
28092
28093 It is also possible to scan the content of messages at other times. The
28094 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
28095 scanning after all the ACLs have run. A transport filter can be used to scan
28096 messages at delivery time (see the &%transport_filter%& option, described in
28097 chapter &<<CHAPtransportgeneric>>&).
28098
28099 If you want to include the ACL-time content-scanning features when you compile
28100 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
28101 &_Local/Makefile_&. When you do that, the Exim binary is built with:
28102
28103 .ilist
28104 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
28105 for all MIME parts for SMTP and non-SMTP messages, respectively.
28106 .next
28107 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
28108 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
28109 run at the end of message reception (the &%acl_smtp_data%& ACL).
28110 .next
28111 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
28112 of messages, or parts of messages, for debugging purposes.
28113 .next
28114 Additional expansion variables that are set in the new ACL and by the new
28115 conditions.
28116 .next
28117 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
28118 .endlist
28119
28120 There is another content-scanning configuration option for &_Local/Makefile_&,
28121 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
28122 condition is compiled, in addition to all the other content-scanning features.
28123
28124 Content-scanning is continually evolving, and new features are still being
28125 added. While such features are still unstable and liable to incompatible
28126 changes, they are made available in Exim by setting options whose names begin
28127 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
28128 this manual. You can find out about them by reading the file called
28129 &_doc/experimental.txt_&.
28130
28131 All the content-scanning facilities work on a MBOX copy of the message that is
28132 temporarily created in a file called:
28133 .display
28134 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
28135 .endd
28136 The &_.eml_& extension is a friendly hint to virus scanners that they can
28137 expect an MBOX-like structure inside that file. The file is created when the
28138 first content scanning facility is called. Subsequent calls to content
28139 scanning conditions open the same file again. The directory is recursively
28140 removed when the &%acl_smtp_data%& ACL has finished running, unless
28141 .code
28142 control = no_mbox_unspool
28143 .endd
28144 has been encountered. When the MIME ACL decodes files, they are put into the
28145 same directory by default.
28146
28147
28148
28149 .section "Scanning for viruses" "SECTscanvirus"
28150 .cindex "virus scanning"
28151 .cindex "content scanning" "for viruses"
28152 .cindex "content scanning" "the &%malware%& condition"
28153 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
28154 It supports a &"generic"& interface to scanners called via the shell, and
28155 specialized interfaces for &"daemon"& type virus scanners, which are resident
28156 in memory and thus are much faster.
28157
28158 .new
28159 .oindex "&%av_scanner%&"
28160 You can set the &%av_scanner%& option in first part of the Exim configuration
28161 file to specify which scanner to use, together with any additional options that
28162 are needed. The basic syntax is as follows:
28163 .display
28164 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
28165 .endd
28166 If you do not set &%av_scanner%&, it defaults to
28167 .code
28168 av_scanner = sophie:/var/run/sophie
28169 .endd
28170 If the value of &%av_scanner%& starts with a dollar character, it is expanded
28171 before use. The following scanner types are supported in this release:
28172 .wen
28173 .vlist
28174 .vitem &%aveserver%&
28175 .cindex "virus scanners" "Kaspersky"
28176 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
28177 at &url(http://www.kaspersky.com). This scanner type takes one option,
28178 which is the path to the daemon's UNIX socket. The default is shown in this
28179 example:
28180 .code
28181 av_scanner = aveserver:/var/run/aveserver
28182 .endd
28183
28184 .new
28185 .vitem &%clamd%&
28186 .cindex "virus scanners" "clamd"
28187 This daemon-type scanner is GPL and free. You can get it at
28188 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
28189 unpack MIME containers, so it used to be recommended to unpack MIME attachments
28190 in the MIME ACL. This no longer believed to be necessary. One option is
28191 required: either the path and name of a UNIX socket file, or a hostname or IP
28192 number, and a port, separated by space, as in the second of these examples:
28193 .code
28194 av_scanner = clamd:/opt/clamd/socket
28195 av_scanner = clamd:192.0.2.3 1234
28196 av_scanner = clamd:192.0.2.3 1234:local
28197 .endd
28198 If the value of av_scanner points to a UNIX socket file or contains the local
28199 keyword, then the ClamAV interface will pass a filename containing the data
28200 to be scanned, which will should normally result in less I/O happening and be
28201 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
28202 Exim does not assume that there is a common filesystem with the remote host.
28203 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
28204 you be running a version of ClamAV prior to 0.95.
28205 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
28206 contributing the code for this scanner.
28207 .wen
28208 .vitem &%cmdline%&
28209 .cindex "virus scanners" "command line interface"
28210 This is the keyword for the generic command line scanner interface. It can be
28211 used to attach virus scanners that are invoked from the shell. This scanner
28212 type takes 3 mandatory options:
28213
28214 .olist
28215 The full path and name of the scanner binary, with all command line options,
28216 and a placeholder (&`%s`&) for the directory to scan.
28217
28218 .next
28219 A regular expression to match against the STDOUT and STDERR output of the
28220 virus scanner. If the expression matches, a virus was found. You must make
28221 absolutely sure that this expression matches on &"virus found"&. This is called
28222 the &"trigger"& expression.
28223
28224 .next
28225 Another regular expression, containing exactly one pair of parentheses, to
28226 match the name of the virus found in the scanners output. This is called the
28227 &"name"& expression.
28228 .endlist olist
28229
28230 For example, Sophos Sweep reports a virus on a line like this:
28231 .code
28232 Virus 'W32/Magistr-B' found in file ./those.bat
28233 .endd
28234 For the trigger expression, we can match the phrase &"found in file"&. For the
28235 name expression, we want to extract the W32/Magistr-B string, so we can match
28236 for the single quotes left and right of it. Altogether, this makes the
28237 configuration setting:
28238 .code
28239 av_scanner = cmdline:\
28240              /path/to/sweep -ss -all -rec -archive %s:\
28241              found in file:'(.+)'
28242 .endd
28243 .vitem &%drweb%&
28244 .cindex "virus scanners" "DrWeb"
28245 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
28246 argument, either a full path to a UNIX socket, or an IP address and port
28247 separated by white space, as in these examples:
28248 .code
28249 av_scanner = drweb:/var/run/drwebd.sock
28250 av_scanner = drweb:192.168.2.20 31337
28251 .endd
28252 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
28253 is used. Thanks to Alex Miller for contributing the code for this scanner.
28254
28255 .vitem &%fsecure%&
28256 .cindex "virus scanners" "F-Secure"
28257 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
28258 argument which is the path to a UNIX socket. For example:
28259 .code
28260 av_scanner = fsecure:/path/to/.fsav
28261 .endd
28262 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
28263 Thelmen for contributing the code for this scanner.
28264
28265 .vitem &%kavdaemon%&
28266 .cindex "virus scanners" "Kaspersky"
28267 This is the scanner daemon of Kaspersky Version 4. This version of the
28268 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
28269 scanner type takes one option, which is the path to the daemon's UNIX socket.
28270 For example:
28271 .code
28272 av_scanner = kavdaemon:/opt/AVP/AvpCtl
28273 .endd
28274 The default path is &_/var/run/AvpCtl_&.
28275
28276 .vitem &%mksd%&
28277 .cindex "virus scanners" "mksd"
28278 This is a daemon type scanner that is aimed mainly at Polish users, though some
28279 parts of documentation are now available in English. You can get it at
28280 &url(http://linux.mks.com.pl/). The only option for this scanner type is
28281 the maximum number of processes used simultaneously to scan the attachments,
28282 provided that the demime facility is employed and also provided that mksd has
28283 been run with at least the same number of child processes. For example:
28284 .code
28285 av_scanner = mksd:2
28286 .endd
28287 You can safely omit this option (the default value is 1).
28288
28289 .vitem &%sophie%&
28290 .cindex "virus scanners" "Sophos and Sophie"
28291 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
28292 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
28293 for this scanner type is the path to the UNIX socket that Sophie uses for
28294 client communication. For example:
28295 .code
28296 av_scanner = sophie:/tmp/sophie
28297 .endd
28298 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
28299 the option.
28300 .endlist
28301
28302 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
28303 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
28304 ACL.
28305
28306 The &%av_scanner%& option is expanded each time &%malware%& is called. This
28307 makes it possible to use different scanners. See further below for an example.
28308 The &%malware%& condition caches its results, so when you use it multiple times
28309 for the same message, the actual scanning process is only carried out once.
28310 However, using expandable items in &%av_scanner%& disables this caching, in
28311 which case each use of the &%malware%& condition causes a new scan of the
28312 message.
28313
28314 The &%malware%& condition takes a right-hand argument that is expanded before
28315 use. It can then be one of
28316
28317 .ilist
28318 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
28319 The condition succeeds if a virus was found, and fail otherwise. This is the
28320 recommended usage.
28321 .next
28322 &"false"& or &"0"& or an empty string, in which case no scanning is done and
28323 the condition fails immediately.
28324 .next
28325 A regular expression, in which case the message is scanned for viruses. The
28326 condition succeeds if a virus is found and its name matches the regular
28327 expression. This allows you to take special actions on certain types of virus.
28328 .endlist
28329
28330 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
28331 even if there is a problem with the virus scanner. Otherwise, such a problem
28332 causes the ACL to defer.
28333
28334 .vindex "&$malware_name$&"
28335 When a virus is found, the condition sets up an expansion variable called
28336 &$malware_name$& that contains the name of the virus. You can use it in a
28337 &%message%& modifier that specifies the error returned to the sender, and/or in
28338 logging data.
28339
28340 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
28341 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
28342 &%malware%& condition.
28343
28344 .new
28345 Beware the interaction of Exim's &%message_size_limit%& with any size limits
28346 imposed by your anti-virus scanner.
28347 .wen
28348
28349 Here is a very simple scanning example:
28350 .code
28351 deny message = This message contains malware ($malware_name)
28352      demime = *
28353      malware = *
28354 .endd
28355 The next example accepts messages when there is a problem with the scanner:
28356 .code
28357 deny message = This message contains malware ($malware_name)
28358      demime = *
28359      malware = */defer_ok
28360 .endd
28361 The next example shows how to use an ACL variable to scan with both sophie and
28362 aveserver. It assumes you have set:
28363 .code
28364 av_scanner = $acl_m0
28365 .endd
28366 in the main Exim configuration.
28367 .code
28368 deny message = This message contains malware ($malware_name)
28369      set acl_m0 = sophie
28370      malware = *
28371
28372 deny message = This message contains malware ($malware_name)
28373      set acl_m0 = aveserver
28374      malware = *
28375 .endd
28376
28377
28378 .section "Scanning with SpamAssassin" "SECTscanspamass"
28379 .cindex "content scanning" "for spam"
28380 .cindex "spam scanning"
28381 .cindex "SpamAssassin"
28382 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
28383 score and a report for the message. You can get SpamAssassin at
28384 &url(http://www.spamassassin.org), or, if you have a working Perl
28385 installation, you can use CPAN by running:
28386 .code
28387 perl -MCPAN -e 'install Mail::SpamAssassin'
28388 .endd
28389 SpamAssassin has its own set of configuration files. Please review its
28390 documentation to see how you can tweak it. The default installation should work
28391 nicely, however.
28392
28393 .oindex "&%spamd_address%&"
28394 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
28395 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
28396 port for &%spamd%&, you must set the &%spamd_address%& option in the global
28397 part of the Exim configuration as follows (example):
28398 .code
28399 spamd_address = 192.168.99.45 387
28400 .endd
28401 You do not need to set this option if you use the default. As of version 2.60,
28402 &%spamd%& also supports communication over UNIX sockets. If you want to use
28403 these, supply &%spamd_address%& with an absolute file name instead of a
28404 address/port pair:
28405 .code
28406 spamd_address = /var/run/spamd_socket
28407 .endd
28408 You can have multiple &%spamd%& servers to improve scalability. These can
28409 reside on other hardware reachable over the network. To specify multiple
28410 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
28411 option, separated with colons:
28412 .code
28413 spamd_address = 192.168.2.10 783 : \
28414                 192.168.2.11 783 : \
28415                 192.168.2.12 783
28416 .endd
28417 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
28418 fashion. When a server fails to respond to the connection attempt, all other
28419 servers are tried until one succeeds. If no server responds, the &%spam%&
28420 condition defers.
28421
28422 &*Warning*&: It is not possible to use the UNIX socket connection method with
28423 multiple &%spamd%& servers.
28424
28425 The &%spamd_address%& variable is expanded before use if it starts with
28426 a dollar sign. In this case, the expansion may return a string that is
28427 used as the list so that multiple spamd servers can be the result of an
28428 expansion.
28429
28430 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
28431 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
28432 .code
28433 deny message = This message was classified as SPAM
28434      spam = joe
28435 .endd
28436 The right-hand side of the &%spam%& condition specifies a name. This is
28437 relevant if you have set up multiple SpamAssassin profiles. If you do not want
28438 to scan using a specific profile, but rather use the SpamAssassin system-wide
28439 default profile, you can scan for an unknown name, or simply use &"nobody"&.
28440 However, you must put something on the right-hand side.
28441
28442 The name allows you to use per-domain or per-user antispam profiles in
28443 principle, but this is not straightforward in practice, because a message may
28444 have multiple recipients, not necessarily all in the same domain. Because the
28445 &%spam%& condition has to be called from a DATA ACL in order to be able to
28446 read the contents of the message, the variables &$local_part$& and &$domain$&
28447 are not set.
28448
28449 The right-hand side of the &%spam%& condition is expanded before being used, so
28450 you can put lookups or conditions there. When the right-hand side evaluates to
28451 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
28452
28453
28454 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
28455 large ones may cause significant performance degradation. As most spam messages
28456 are quite small, it is recommended that you do not scan the big ones. For
28457 example:
28458 .code
28459 deny message = This message was classified as SPAM
28460      condition = ${if < {$message_size}{10K}}
28461      spam = nobody
28462 .endd
28463
28464 The &%spam%& condition returns true if the threshold specified in the user's
28465 SpamAssassin profile has been matched or exceeded. If you want to use the
28466 &%spam%& condition for its side effects (see the variables below), you can make
28467 it always return &"true"& by appending &`:true`& to the username.
28468
28469 .new
28470 .cindex "spam scanning" "returned variables"
28471 When the &%spam%& condition is run, it sets up a number of expansion
28472 variables. These variables are saved with the received message, thus they are
28473 available for use at delivery time.
28474 .wen
28475
28476 .vlist
28477 .vitem &$spam_score$&
28478 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
28479 for inclusion in log or reject messages.
28480
28481 .new
28482 .vitem &$spam_score_int$&
28483 The spam score of the message, multiplied by ten, as an integer value. For
28484 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
28485 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
28486 The integer value is useful for numeric comparisons in conditions.
28487 .wen
28488
28489 .vitem &$spam_bar$&
28490 A string consisting of a number of &"+"& or &"-"& characters, representing the
28491 integer part of the spam score value. A spam score of 4.4 would have a
28492 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
28493 headers, since MUAs can match on such strings.
28494
28495 .vitem &$spam_report$&
28496 A multiline text table, containing the full SpamAssassin report for the
28497 message. Useful for inclusion in headers or reject messages.
28498 .endlist
28499
28500 The &%spam%& condition caches its results unless expansion in
28501 spamd_address was used. If you call it again with the same user name, it
28502 does not scan again, but rather returns the same values as before.
28503
28504 The &%spam%& condition returns DEFER if there is any error while running
28505 the message through SpamAssassin or if the expansion of spamd_address
28506 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
28507 statement block), append &`/defer_ok`& to the right-hand side of the
28508 spam condition, like this:
28509 .code
28510 deny message = This message was classified as SPAM
28511      spam    = joe/defer_ok
28512 .endd
28513 This causes messages to be accepted even if there is a problem with &%spamd%&.
28514
28515 Here is a longer, commented example of the use of the &%spam%&
28516 condition:
28517 .code
28518 # put headers in all messages (no matter if spam or not)
28519 warn  spam = nobody:true
28520       add_header = X-Spam-Score: $spam_score ($spam_bar)
28521       add_header = X-Spam-Report: $spam_report
28522
28523 # add second subject line with *SPAM* marker when message
28524 # is over threshold
28525 warn  spam = nobody
28526       add_header = Subject: *SPAM* $h_Subject:
28527
28528 # reject spam at high scores (> 12)
28529 deny  message = This message scored $spam_score spam points.
28530       spam = nobody:true
28531       condition = ${if >{$spam_score_int}{120}{1}{0}}
28532 .endd
28533
28534
28535
28536 .section "Scanning MIME parts" "SECTscanmimepart"
28537 .cindex "content scanning" "MIME parts"
28538 .cindex "MIME content scanning"
28539 .oindex "&%acl_smtp_mime%&"
28540 .oindex "&%acl_not_smtp_mime%&"
28541 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
28542 each MIME part of an SMTP message, including multipart types, in the sequence
28543 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
28544 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
28545 options may both refer to the same ACL if you want the same processing in both
28546 cases.
28547
28548 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
28549 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
28550 the case of a non-SMTP message. However, a MIME ACL is called only if the
28551 message contains a &'Content-Type:'& header line. When a call to a MIME
28552 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
28553 result code is sent to the client. In the case of an SMTP message, the
28554 &%acl_smtp_data%& ACL is not called when this happens.
28555
28556 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
28557 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
28558 condition to match against the raw MIME part. You can also use the
28559 &%mime_regex%& condition to match against the decoded MIME part (see section
28560 &<<SECTscanregex>>&).
28561
28562 At the start of a MIME ACL, a number of variables are set from the header
28563 information for the relevant MIME part. These are described below. The contents
28564 of the MIME part are not by default decoded into a disk file except for MIME
28565 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
28566 part into a disk file, you can use the &%decode%& condition. The general
28567 syntax is:
28568 .display
28569 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
28570 .endd
28571 The right hand side is expanded before use. After expansion,
28572 the value can be:
28573
28574 .olist
28575 &"0"& or &"false"&, in which case no decoding is done.
28576 .next
28577 The string &"default"&. In that case, the file is put in the temporary
28578 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
28579 a sequential file name consisting of the message id and a sequence number. The
28580 full path and name is available in &$mime_decoded_filename$& after decoding.
28581 .next
28582 A full path name starting with a slash. If the full name is an existing
28583 directory, it is used as a replacement for the default directory. The filename
28584 is then sequentially assigned. If the path does not exist, it is used as
28585 the full path and file name.
28586 .next
28587 If the string does not start with a slash, it is used as the
28588 filename, and the default path is then used.
28589 .endlist
28590 The &%decode%& condition normally succeeds. It is only false for syntax
28591 errors or unusual circumstances such as memory shortages. You can easily decode
28592 a file with its original, proposed filename using
28593 .code
28594 decode = $mime_filename
28595 .endd
28596 However, you should keep in mind that &$mime_filename$& might contain
28597 anything. If you place files outside of the default path, they are not
28598 automatically unlinked.
28599
28600 For RFC822 attachments (these are messages attached to messages, with a
28601 content-type of &"message/rfc822"&), the ACL is called again in the same manner
28602 as for the primary message, only that the &$mime_is_rfc822$& expansion
28603 variable is set (see below). Attached messages are always decoded to disk
28604 before being checked, and the files are unlinked once the check is done.
28605
28606 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
28607 used to match regular expressions against raw and decoded MIME parts,
28608 respectively. They are described in section &<<SECTscanregex>>&.
28609
28610 .cindex "MIME content scanning" "returned variables"
28611 The following list describes all expansion variables that are
28612 available in the MIME ACL:
28613
28614 .vlist
28615 .vitem &$mime_boundary$&
28616 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
28617 have a boundary string, which is stored in this variable. If the current part
28618 has no boundary parameter in the &'Content-Type:'& header, this variable
28619 contains the empty string.
28620
28621 .vitem &$mime_charset$&
28622 This variable contains the character set identifier, if one was found in the
28623 &'Content-Type:'& header. Examples for charset identifiers are:
28624 .code
28625 us-ascii
28626 gb2312 (Chinese)
28627 iso-8859-1
28628 .endd
28629 Please note that this value is not normalized, so you should do matches
28630 case-insensitively.
28631
28632 .vitem &$mime_content_description$&
28633 This variable contains the normalized content of the &'Content-Description:'&
28634 header. It can contain a human-readable description of the parts content. Some
28635 implementations repeat the filename for attachments here, but they are usually
28636 only used for display purposes.
28637
28638 .vitem &$mime_content_disposition$&
28639 This variable contains the normalized content of the &'Content-Disposition:'&
28640 header. You can expect strings like &"attachment"& or &"inline"& here.
28641
28642 .vitem &$mime_content_id$&
28643 This variable contains the normalized content of the &'Content-ID:'& header.
28644 This is a unique ID that can be used to reference a part from another part.
28645
28646 .vitem &$mime_content_size$&
28647 This variable is set only after the &%decode%& modifier (see above) has been
28648 successfully run. It contains the size of the decoded part in kilobytes. The
28649 size is always rounded up to full kilobytes, so only a completely empty part
28650 has a &$mime_content_size$& of zero.
28651
28652 .vitem &$mime_content_transfer_encoding$&
28653 This variable contains the normalized content of the
28654 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
28655 type. Typical values are &"base64"& and &"quoted-printable"&.
28656
28657 .vitem &$mime_content_type$&
28658 If the MIME part has a &'Content-Type:'& header, this variable contains its
28659 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
28660 are some examples of popular MIME types, as they may appear in this variable:
28661 .code
28662 text/plain
28663 text/html
28664 application/octet-stream
28665 image/jpeg
28666 audio/midi
28667 .endd
28668 If the MIME part has no &'Content-Type:'& header, this variable contains the
28669 empty string.
28670
28671 .vitem &$mime_decoded_filename$&
28672 This variable is set only after the &%decode%& modifier (see above) has been
28673 successfully run. It contains the full path and file name of the file
28674 containing the decoded data.
28675 .endlist
28676
28677 .cindex "RFC 2047"
28678 .vlist
28679 .vitem &$mime_filename$&
28680 This is perhaps the most important of the MIME variables. It contains a
28681 proposed filename for an attachment, if one was found in either the
28682 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
28683 RFC2047 decoded, but no additional sanity checks are done. If no filename was
28684 found, this variable contains the empty string.
28685
28686 .vitem &$mime_is_coverletter$&
28687 This variable attempts to differentiate the &"cover letter"& of an e-mail from
28688 attached data. It can be used to clamp down on flashy or unnecessarily encoded
28689 content in the cover letter, while not restricting attachments at all.
28690
28691 The variable contains 1 (true) for a MIME part believed to be part of the
28692 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
28693 follows:
28694
28695 .olist
28696 The outermost MIME part of a message is always a cover letter.
28697
28698 .next
28699 If a multipart/alternative or multipart/related MIME part is a cover letter,
28700 so are all MIME subparts within that multipart.
28701
28702 .next
28703 If any other multipart is a cover letter, the first subpart is a cover letter,
28704 and the rest are attachments.
28705
28706 .next
28707 All parts contained within an attachment multipart are attachments.
28708 .endlist olist
28709
28710 As an example, the following will ban &"HTML mail"& (including that sent with
28711 alternative plain text), while allowing HTML files to be attached. HTML
28712 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
28713 .code
28714 deny message = HTML mail is not accepted here
28715 !condition = $mime_is_rfc822
28716 condition = $mime_is_coverletter
28717 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
28718 .endd
28719 .vitem &$mime_is_multipart$&
28720 This variable has the value 1 (true) when the current part has the main type
28721 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
28722 Since multipart entities only serve as containers for other parts, you may not
28723 want to carry out specific actions on them.
28724
28725 .vitem &$mime_is_rfc822$&
28726 This variable has the value 1 (true) if the current part is not a part of the
28727 checked message itself, but part of an attached message. Attached message
28728 decoding is fully recursive.
28729
28730 .vitem &$mime_part_count$&
28731 This variable is a counter that is raised for each processed MIME part. It
28732 starts at zero for the very first part (which is usually a multipart). The
28733 counter is per-message, so it is reset when processing RFC822 attachments (see
28734 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
28735 complete, so you can use it in the DATA ACL to determine the number of MIME
28736 parts of a message. For non-MIME messages, this variable contains the value -1.
28737 .endlist
28738
28739
28740
28741 .section "Scanning with regular expressions" "SECTscanregex"
28742 .cindex "content scanning" "with regular expressions"
28743 .cindex "regular expressions" "content scanning with"
28744 You can specify your own custom regular expression matches on the full body of
28745 the message, or on individual MIME parts.
28746
28747 The &%regex%& condition takes one or more regular expressions as arguments and
28748 matches them against the full message (when called in the DATA ACL) or a raw
28749 MIME part (when called in the MIME ACL). The &%regex%& condition matches
28750 linewise, with a maximum line length of 32K characters. That means you cannot
28751 have multiline matches with the &%regex%& condition.
28752
28753 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
28754 to 32K of decoded content (the whole content at once, not linewise). If the
28755 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
28756 is decoded automatically when &%mime_regex%& is executed (using default path
28757 and filename values). If the decoded data is larger than  32K, only the first
28758 32K characters are checked.
28759
28760 The regular expressions are passed as a colon-separated list. To include a
28761 literal colon, you must double it. Since the whole right-hand side string is
28762 expanded before being used, you must also escape dollar signs and backslashes
28763 with more backslashes, or use the &`\N`& facility to disable expansion.
28764 Here is a simple example that contains two regular expressions:
28765 .code
28766 deny message = contains blacklisted regex ($regex_match_string)
28767      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
28768 .endd
28769 The conditions returns true if any one of the regular expressions matches. The
28770 &$regex_match_string$& expansion variable is then set up and contains the
28771 matching regular expression.
28772
28773 &*Warning*&: With large messages, these conditions can be fairly
28774 CPU-intensive.
28775
28776
28777
28778
28779 .section "The demime condition" "SECTdemimecond"
28780 .cindex "content scanning" "MIME checking"
28781 .cindex "MIME content scanning"
28782 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
28783 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
28784 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
28785 ACL functionality, but provides no additional facilities. Please note that this
28786 condition is deprecated and kept only for backward compatibility. You must set
28787 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
28788 use the &%demime%& condition.
28789
28790 The &%demime%& condition unpacks MIME containers in the message. It detects
28791 errors in MIME containers and can match file extensions found in the message
28792 against a list. Using this facility produces files containing the unpacked MIME
28793 parts of the message in the temporary scan directory. If you do antivirus
28794 scanning, it is recommended that you use the &%demime%& condition before the
28795 antivirus (&%malware%&) condition.
28796
28797 On the right-hand side of the &%demime%& condition you can pass a
28798 colon-separated list of file extensions that it should match against. For
28799 example:
28800 .code
28801 deny message = Found blacklisted file attachment
28802      demime  = vbs:com:bat:pif:prf:lnk
28803 .endd
28804 If one of the file extensions is found, the condition is true, otherwise it is
28805 false. If there is a temporary error while demimeing (for example, &"disk
28806 full"&), the condition defers, and the message is temporarily rejected (unless
28807 the condition is on a &%warn%& verb).
28808
28809 The right-hand side is expanded before being treated as a list, so you can have
28810 conditions and lookups there. If it expands to an empty string, &"false"&, or
28811 zero (&"0"&), no demimeing is done and the condition is false.
28812
28813 The &%demime%& condition set the following variables:
28814
28815 .vlist
28816 .vitem &$demime_errorlevel$&
28817 .vindex "&$demime_errorlevel$&"
28818 When an error is detected in a MIME container, this variable contains the
28819 severity of the error, as an integer number. The higher the value, the more
28820 severe the error (the current maximum value is 3). If this variable is unset or
28821 zero, no error occurred.
28822
28823 .vitem &$demime_reason$&
28824 .vindex "&$demime_reason$&"
28825 When &$demime_errorlevel$& is greater than zero, this variable contains a
28826 human-readable text string describing the MIME error that occurred.
28827 .endlist
28828
28829 .vlist
28830 .vitem &$found_extension$&
28831 .vindex "&$found_extension$&"
28832 When the &%demime%& condition is true, this variable contains the file
28833 extension it found.
28834 .endlist
28835
28836 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
28837 the &%demime%& condition, and are not changed on subsequent calls.
28838
28839 If you do not want to check for file extensions, but rather use the &%demime%&
28840 condition for unpacking or error checking purposes, pass &"*"& as the
28841 right-hand side value. Here is a more elaborate example of how to use this
28842 facility:
28843 .code
28844 # Reject messages with serious MIME container errors
28845 deny  message = Found MIME error ($demime_reason).
28846       demime = *
28847       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
28848
28849 # Reject known virus spreading file extensions.
28850 # Accepting these is pretty much braindead.
28851 deny  message = contains $found_extension file (blacklisted).
28852       demime  = com:vbs:bat:pif:scr
28853
28854 # Freeze .exe and .doc files. Postmaster can
28855 # examine them and eventually thaw them.
28856 deny  log_message = Another $found_extension file.
28857       demime = exe:doc
28858       control = freeze
28859 .endd
28860 .ecindex IIDcosca
28861
28862
28863
28864
28865 . ////////////////////////////////////////////////////////////////////////////
28866 . ////////////////////////////////////////////////////////////////////////////
28867
28868 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
28869          "Local scan function"
28870 .scindex IIDlosca "&[local_scan()]& function" "description of"
28871 .cindex "customizing" "input scan using C function"
28872 .cindex "policy control" "by local scan function"
28873 In these days of email worms, viruses, and ever-increasing spam, some sites
28874 want to apply a lot of checking to messages before accepting them.
28875
28876 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
28877 passing messages to external virus and spam scanning software. You can also do
28878 a certain amount in Exim itself through string expansions and the &%condition%&
28879 condition in the ACL that runs after the SMTP DATA command or the ACL for
28880 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
28881
28882 To allow for further customization to a site's own requirements, there is the
28883 possibility of linking Exim with a private message scanning function, written
28884 in C. If you want to run code that is written in something other than C, you
28885 can of course use a little C stub to call it.
28886
28887 The local scan function is run once for every incoming message, at the point
28888 when Exim is just about to accept the message.
28889 It can therefore be used to control non-SMTP messages from local processes as
28890 well as messages arriving via SMTP.
28891
28892 Exim applies a timeout to calls of the local scan function, and there is an
28893 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
28894 Zero means &"no timeout"&.
28895 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
28896 before calling the local scan function, so that the most common types of crash
28897 are caught. If the timeout is exceeded or one of those signals is caught, the
28898 incoming message is rejected with a temporary error if it is an SMTP message.
28899 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
28900 code. The incident is logged on the main and reject logs.
28901
28902
28903
28904 .section "Building Exim to use a local scan function" "SECID207"
28905 .cindex "&[local_scan()]& function" "building Exim to use"
28906 To make use of the local scan function feature, you must tell Exim where your
28907 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
28908 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
28909 directory, so you might set
28910 .code
28911 LOCAL_SCAN_SOURCE=Local/local_scan.c
28912 .endd
28913 for example. The function must be called &[local_scan()]&. It is called by
28914 Exim after it has received a message, when the success return code is about to
28915 be sent. This is after all the ACLs have been run. The return code from your
28916 function controls whether the message is actually accepted or not. There is a
28917 commented template function (that just accepts the message) in the file
28918 _src/local_scan.c_.
28919
28920 If you want to make use of Exim's run time configuration file to set options
28921 for your &[local_scan()]& function, you must also set
28922 .code
28923 LOCAL_SCAN_HAS_OPTIONS=yes
28924 .endd
28925 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
28926
28927
28928
28929
28930 .section "API for local_scan()" "SECTapiforloc"
28931 .cindex "&[local_scan()]& function" "API description"
28932 You must include this line near the start of your code:
28933 .code
28934 #include "local_scan.h"
28935 .endd
28936 This header file defines a number of variables and other values, and the
28937 prototype for the function itself. Exim is coded to use unsigned char values
28938 almost exclusively, and one of the things this header defines is a shorthand
28939 for &`unsigned char`& called &`uschar`&.
28940 It also contains the following macro definitions, to simplify casting character
28941 strings and pointers to character strings:
28942 .code
28943 #define CS   (char *)
28944 #define CCS  (const char *)
28945 #define CSS  (char **)
28946 #define US   (unsigned char *)
28947 #define CUS  (const unsigned char *)
28948 #define USS  (unsigned char **)
28949 .endd
28950 The function prototype for &[local_scan()]& is:
28951 .code
28952 extern int local_scan(int fd, uschar **return_text);
28953 .endd
28954 The arguments are as follows:
28955
28956 .ilist
28957 &%fd%& is a file descriptor for the file that contains the body of the message
28958 (the -D file). The file is open for reading and writing, but updating it is not
28959 recommended. &*Warning*&: You must &'not'& close this file descriptor.
28960
28961 The descriptor is positioned at character 19 of the file, which is the first
28962 character of the body itself, because the first 19 characters are the message
28963 id followed by &`-D`& and a newline. If you rewind the file, you should use the
28964 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
28965 case this changes in some future version.
28966 .next
28967 &%return_text%& is an address which you can use to return a pointer to a text
28968 string at the end of the function. The value it points to on entry is NULL.
28969 .endlist
28970
28971 The function must return an &%int%& value which is one of the following macros:
28972
28973 .vlist
28974 .vitem &`LOCAL_SCAN_ACCEPT`&
28975 .vindex "&$local_scan_data$&"
28976 The message is accepted. If you pass back a string of text, it is saved with
28977 the message, and made available in the variable &$local_scan_data$&. No
28978 newlines are permitted (if there are any, they are turned into spaces) and the
28979 maximum length of text is 1000 characters.
28980
28981 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
28982 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
28983 queued without immediate delivery, and is frozen.
28984
28985 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
28986 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
28987 queued without immediate delivery.
28988
28989 .vitem &`LOCAL_SCAN_REJECT`&
28990 The message is rejected; the returned text is used as an error message which is
28991 passed back to the sender and which is also logged. Newlines are permitted &--
28992 they cause a multiline response for SMTP rejections, but are converted to
28993 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
28994 used.
28995
28996 .vitem &`LOCAL_SCAN_TEMPREJECT`&
28997 The message is temporarily rejected; the returned text is used as an error
28998 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
28999 problem"& is used.
29000
29001 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
29002 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
29003 message is not written to the reject log. It has the effect of unsetting the
29004 &%rejected_header%& log selector for just this rejection. If
29005 &%rejected_header%& is already unset (see the discussion of the
29006 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
29007 same as LOCAL_SCAN_REJECT.
29008
29009 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
29010 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
29011 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
29012 .endlist
29013
29014 If the message is not being received by interactive SMTP, rejections are
29015 reported by writing to &%stderr%& or by sending an email, as configured by the
29016 &%-oe%& command line options.
29017
29018
29019
29020 .section "Configuration options for local_scan()" "SECTconoptloc"
29021 .cindex "&[local_scan()]& function" "configuration options"
29022 It is possible to have option settings in the main configuration file
29023 that set values in static variables in the &[local_scan()]& module. If you
29024 want to do this, you must have the line
29025 .code
29026 LOCAL_SCAN_HAS_OPTIONS=yes
29027 .endd
29028 in your &_Local/Makefile_& when you build Exim. (This line is in
29029 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
29030 file, you must define static variables to hold the option values, and a table
29031 to define them.
29032
29033 The table must be a vector called &%local_scan_options%&, of type
29034 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
29035 and a pointer to the variable that holds the value. The entries must appear in
29036 alphabetical order. Following &%local_scan_options%& you must also define a
29037 variable called &%local_scan_options_count%& that contains the number of
29038 entries in the table. Here is a short example, showing two kinds of option:
29039 .code
29040 static int my_integer_option = 42;
29041 static uschar *my_string_option = US"a default string";
29042
29043 optionlist local_scan_options[] = {
29044   { "my_integer", opt_int,       &my_integer_option },
29045   { "my_string",  opt_stringptr, &my_string_option }
29046 };
29047
29048 int local_scan_options_count =
29049   sizeof(local_scan_options)/sizeof(optionlist);
29050 .endd
29051 The values of the variables can now be changed from Exim's runtime
29052 configuration file by including a local scan section as in this example:
29053 .code
29054 begin local_scan
29055 my_integer = 99
29056 my_string = some string of text...
29057 .endd
29058 The available types of option data are as follows:
29059
29060 .vlist
29061 .vitem &*opt_bool*&
29062 This specifies a boolean (true/false) option. The address should point to a
29063 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
29064 that are defined as &"1"& and &"0"&, respectively. If you want to detect
29065 whether such a variable has been set at all, you can initialize it to
29066 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
29067 values.)
29068
29069 .vitem &*opt_fixed*&
29070 This specifies a fixed point number, such as is used for load averages.
29071 The address should point to a variable of type &`int`&. The value is stored
29072 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
29073
29074 .vitem &*opt_int*&
29075 This specifies an integer; the address should point to a variable of type
29076 &`int`&. The value may be specified in any of the integer formats accepted by
29077 Exim.
29078
29079 .vitem &*opt_mkint*&
29080 This is the same as &%opt_int%&, except that when such a value is output in a
29081 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
29082 printed with the suffix K or M.
29083
29084 .vitem &*opt_octint*&
29085 This also specifies an integer, but the value is always interpreted as an
29086 octal integer, whether or not it starts with the digit zero, and it is
29087 always output in octal.
29088
29089 .vitem &*opt_stringptr*&
29090 This specifies a string value; the address must be a pointer to a
29091 variable that points to a string (for example, of type &`uschar *`&).
29092
29093 .vitem &*opt_time*&
29094 This specifies a time interval value. The address must point to a variable of
29095 type &`int`&. The value that is placed there is a number of seconds.
29096 .endlist
29097
29098 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
29099 out the values of all the &[local_scan()]& options.
29100
29101
29102
29103 .section "Available Exim variables" "SECID208"
29104 .cindex "&[local_scan()]& function" "available Exim variables"
29105 The header &_local_scan.h_& gives you access to a number of C variables. These
29106 are the only ones that are guaranteed to be maintained from release to release.
29107 Note, however, that you can obtain the value of any Exim expansion variable,
29108 including &$recipients$&, by calling &'expand_string()'&. The exported
29109 C variables are as follows:
29110
29111 .vlist
29112 .vitem &*int&~body_linecount*&
29113 This variable contains the number of lines in the message's body.
29114
29115 .vitem &*int&~body_zerocount*&
29116 This variable contains the number of binary zero bytes in the message's body.
29117
29118 .vitem &*unsigned&~int&~debug_selector*&
29119 This variable is set to zero when no debugging is taking place. Otherwise, it
29120 is a bitmap of debugging selectors. Two bits are identified for use in
29121 &[local_scan()]&; they are defined as macros:
29122
29123 .ilist
29124 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
29125 testing option that is not privileged &-- any caller may set it. All the
29126 other selector bits can be set only by admin users.
29127
29128 .next
29129 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
29130 by the &`+local_scan`& debug selector. It is not included in the default set
29131 of debugging bits.
29132 .endlist ilist
29133
29134 Thus, to write to the debugging output only when &`+local_scan`& has been
29135 selected, you should use code like this:
29136 .code
29137 if ((debug_selector & D_local_scan) != 0)
29138   debug_printf("xxx", ...);
29139 .endd
29140 .vitem &*uschar&~*expand_string_message*&
29141 After a failing call to &'expand_string()'& (returned value NULL), the
29142 variable &%expand_string_message%& contains the error message, zero-terminated.
29143
29144 .vitem &*header_line&~*header_list*&
29145 A pointer to a chain of header lines. The &%header_line%& structure is
29146 discussed below.
29147
29148 .vitem &*header_line&~*header_last*&
29149 A pointer to the last of the header lines.
29150
29151 .vitem &*uschar&~*headers_charset*&
29152 The value of the &%headers_charset%& configuration option.
29153
29154 .vitem &*BOOL&~host_checking*&
29155 This variable is TRUE during a host checking session that is initiated by the
29156 &%-bh%& command line option.
29157
29158 .vitem &*uschar&~*interface_address*&
29159 The IP address of the interface that received the message, as a string. This
29160 is NULL for locally submitted messages.
29161
29162 .vitem &*int&~interface_port*&
29163 The port on which this message was received. When testing with the &%-bh%&
29164 command line option, the value of this variable is -1 unless a port has been
29165 specified via the &%-oMi%& option.
29166
29167 .vitem &*uschar&~*message_id*&
29168 This variable contains Exim's message id for the incoming message (the value of
29169 &$message_exim_id$&) as a zero-terminated string.
29170
29171 .vitem &*uschar&~*received_protocol*&
29172 The name of the protocol by which the message was received.
29173
29174 .vitem &*int&~recipients_count*&
29175 The number of accepted recipients.
29176
29177 .vitem &*recipient_item&~*recipients_list*&
29178 .cindex "recipient" "adding in local scan"
29179 .cindex "recipient" "removing in local scan"
29180 The list of accepted recipients, held in a vector of length
29181 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
29182 can add additional recipients by calling &'receive_add_recipient()'& (see
29183 below). You can delete recipients by removing them from the vector and
29184 adjusting the value in &%recipients_count%&. In particular, by setting
29185 &%recipients_count%& to zero you remove all recipients. If you then return the
29186 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
29187 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
29188 and then call &'receive_add_recipient()'& as often as needed.
29189
29190 .vitem &*uschar&~*sender_address*&
29191 The envelope sender address. For bounce messages this is the empty string.
29192
29193 .vitem &*uschar&~*sender_host_address*&
29194 The IP address of the sending host, as a string. This is NULL for
29195 locally-submitted messages.
29196
29197 .vitem &*uschar&~*sender_host_authenticated*&
29198 The name of the authentication mechanism that was used, or NULL if the message
29199 was not received over an authenticated SMTP connection.
29200
29201 .vitem &*uschar&~*sender_host_name*&
29202 The name of the sending host, if known.
29203
29204 .vitem &*int&~sender_host_port*&
29205 The port on the sending host.
29206
29207 .vitem &*BOOL&~smtp_input*&
29208 This variable is TRUE for all SMTP input, including BSMTP.
29209
29210 .vitem &*BOOL&~smtp_batched_input*&
29211 This variable is TRUE for BSMTP input.
29212
29213 .vitem &*int&~store_pool*&
29214 The contents of this variable control which pool of memory is used for new
29215 requests. See section &<<SECTmemhanloc>>& for details.
29216 .endlist
29217
29218
29219 .section "Structure of header lines" "SECID209"
29220 The &%header_line%& structure contains the members listed below.
29221 You can add additional header lines by calling the &'header_add()'& function
29222 (see below). You can cause header lines to be ignored (deleted) by setting
29223 their type to *.
29224
29225
29226 .vlist
29227 .vitem &*struct&~header_line&~*next*&
29228 A pointer to the next header line, or NULL for the last line.
29229
29230 .vitem &*int&~type*&
29231 A code identifying certain headers that Exim recognizes. The codes are printing
29232 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
29233 Notice in particular that any header line whose type is * is not transmitted
29234 with the message. This flagging is used for header lines that have been
29235 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
29236 lines.) Effectively, * means &"deleted"&.
29237
29238 .vitem &*int&~slen*&
29239 The number of characters in the header line, including the terminating and any
29240 internal newlines.
29241
29242 .vitem &*uschar&~*text*&
29243 A pointer to the text of the header. It always ends with a newline, followed by
29244 a zero byte. Internal newlines are preserved.
29245 .endlist
29246
29247
29248
29249 .section "Structure of recipient items" "SECID210"
29250 The &%recipient_item%& structure contains these members:
29251
29252 .vlist
29253 .vitem &*uschar&~*address*&
29254 This is a pointer to the recipient address as it was received.
29255
29256 .vitem &*int&~pno*&
29257 This is used in later Exim processing when top level addresses are created by
29258 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
29259 and must always contain -1 at this stage.
29260
29261 .vitem &*uschar&~*errors_to*&
29262 If this value is not NULL, bounce messages caused by failing to deliver to the
29263 recipient are sent to the address it contains. In other words, it overrides the
29264 envelope sender for this one recipient. (Compare the &%errors_to%& generic
29265 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
29266 an unqualified address, Exim qualifies it using the domain from
29267 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
29268 is NULL for all recipients.
29269 .endlist
29270
29271
29272
29273 .section "Available Exim functions" "SECID211"
29274 .cindex "&[local_scan()]& function" "available Exim functions"
29275 The header &_local_scan.h_& gives you access to a number of Exim functions.
29276 These are the only ones that are guaranteed to be maintained from release to
29277 release:
29278
29279 .vlist
29280 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
29281        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
29282
29283 This function creates a child process that runs the command specified by
29284 &%argv%&. The environment for the process is specified by &%envp%&, which can
29285 be NULL if no environment variables are to be passed. A new umask is supplied
29286 for the process in &%newumask%&.
29287
29288 Pipes to the standard input and output of the new process are set up
29289 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
29290 standard error is cloned to the standard output. If there are any file
29291 descriptors &"in the way"& in the new process, they are closed. If the final
29292 argument is TRUE, the new process is made into a process group leader.
29293
29294 The function returns the pid of the new process, or -1 if things go wrong.
29295
29296 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
29297 This function waits for a child process to terminate, or for a timeout (in
29298 seconds) to expire. A timeout value of zero means wait as long as it takes. The
29299 return value is as follows:
29300
29301 .ilist
29302 >= 0
29303
29304 The process terminated by a normal exit and the value is the process
29305 ending status.
29306
29307 .next
29308 < 0 and > &--256
29309
29310 The process was terminated by a signal and the value is the negation of the
29311 signal number.
29312
29313 .next
29314 &--256
29315
29316 The process timed out.
29317 .next
29318 &--257
29319
29320 The was some other error in wait(); &%errno%& is still set.
29321 .endlist
29322
29323 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
29324 This function provide you with a means of submitting a new message to
29325 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
29326 want, but this packages it all up for you.) The function creates a pipe,
29327 forks a subprocess that is running
29328 .code
29329 exim -t -oem -oi -f <>
29330 .endd
29331 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
29332 that is connected to the standard input. The yield of the function is the PID
29333 of the subprocess. You can then write a message to the file descriptor, with
29334 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
29335
29336 When you have finished, call &'child_close()'& to wait for the process to
29337 finish and to collect its ending status. A timeout value of zero is usually
29338 fine in this circumstance. Unless you have made a mistake with the recipient
29339 addresses, you should get a return code of zero.
29340
29341
29342 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
29343        *sender_authentication)*&
29344 This function is a more sophisticated version of &'child_open()'&. The command
29345 that it runs is:
29346 .display
29347 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
29348 .endd
29349 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
29350
29351
29352 .vitem &*void&~debug_printf(char&~*,&~...)*&
29353 This is Exim's debugging function, with arguments as for &'(printf()'&. The
29354 output is written to the standard error stream. If no debugging is selected,
29355 calls to &'debug_printf()'& have no effect. Normally, you should make calls
29356 conditional on the &`local_scan`& debug selector by coding like this:
29357 .code
29358 if ((debug_selector & D_local_scan) != 0)
29359   debug_printf("xxx", ...);
29360 .endd
29361
29362 .vitem &*uschar&~*expand_string(uschar&~*string)*&
29363 This is an interface to Exim's string expansion code. The return value is the
29364 expanded string, or NULL if there was an expansion failure.
29365 The C variable &%expand_string_message%& contains an error message after an
29366 expansion failure. If expansion does not change the string, the return value is
29367 the pointer to the input string. Otherwise, the return value points to a new
29368 block of memory that was obtained by a call to &'store_get()'&. See section
29369 &<<SECTmemhanloc>>& below for a discussion of memory handling.
29370
29371 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
29372 This function allows you to an add additional header line at the end of the
29373 existing ones. The first argument is the type, and should normally be a space
29374 character. The second argument is a format string and any number of
29375 substitution arguments as for &[sprintf()]&. You may include internal newlines
29376 if you want, and you must ensure that the string ends with a newline.
29377
29378 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
29379         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
29380 This function adds a new header line at a specified point in the header
29381 chain. The header itself is specified as for &'header_add()'&.
29382
29383 If &%name%& is NULL, the new header is added at the end of the chain if
29384 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
29385 NULL, the header lines are searched for the first non-deleted header that
29386 matches the name. If one is found, the new header is added before it if
29387 &%after%& is false. If &%after%& is true, the new header is added after the
29388 found header and any adjacent subsequent ones with the same name (even if
29389 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
29390 option controls where the header is added. If it is true, addition is at the
29391 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
29392 headers, or at the top if there are no &'Received:'& headers, you could use
29393 .code
29394 header_add_at_position(TRUE, US"Received", TRUE,
29395   ' ', "X-xxx: ...");
29396 .endd
29397 Normally, there is always at least one non-deleted &'Received:'& header, but
29398 there may not be if &%received_header_text%& expands to an empty string.
29399
29400
29401 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
29402 This function removes header lines. If &%occurrence%& is zero or negative, all
29403 occurrences of the header are removed. If occurrence is greater than zero, that
29404 particular instance of the header is removed. If no header(s) can be found that
29405 match the specification, the function does nothing.
29406
29407
29408 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
29409         int&~length,&~BOOL&~notdel)*&"
29410 This function tests whether the given header has the given name. It is not just
29411 a string comparison, because white space is permitted between the name and the
29412 colon. If the &%notdel%& argument is true, a false return is forced for all
29413 &"deleted"& headers; otherwise they are not treated specially. For example:
29414 .code
29415 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
29416 .endd
29417 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
29418 .cindex "base64 encoding" "functions for &[local_scan()]& use"
29419 This function base64-encodes a string, which is passed by address and length.
29420 The text may contain bytes of any value, including zero. The result is passed
29421 back in dynamic memory that is obtained by calling &'store_get()'&. It is
29422 zero-terminated.
29423
29424 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
29425 This function decodes a base64-encoded string. Its arguments are a
29426 zero-terminated base64-encoded string and the address of a variable that is set
29427 to point to the result, which is in dynamic memory. The length of the decoded
29428 string is the yield of the function. If the input is invalid base64 data, the
29429 yield is -1. A zero byte is added to the end of the output string to make it
29430 easy to interpret as a C string (assuming it contains no zeros of its own). The
29431 added zero byte is not included in the returned count.
29432
29433 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
29434 This function checks for a match in a domain list. Domains are always
29435 matched caselessly. The return value is one of the following:
29436 .display
29437 &`OK     `& match succeeded
29438 &`FAIL   `& match failed
29439 &`DEFER  `& match deferred
29440 .endd
29441 DEFER is usually caused by some kind of lookup defer, such as the
29442 inability to contact a database.
29443
29444 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
29445         BOOL&~caseless)*&"
29446 This function checks for a match in a local part list. The third argument
29447 controls case-sensitivity. The return values are as for
29448 &'lss_match_domain()'&.
29449
29450 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
29451         BOOL&~caseless)*&"
29452 This function checks for a match in an address list. The third argument
29453 controls the case-sensitivity of the local part match. The domain is always
29454 matched caselessly. The return values are as for &'lss_match_domain()'&.
29455
29456 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
29457         uschar&~*list)*&"
29458 This function checks for a match in a host list. The most common usage is
29459 expected to be
29460 .code
29461 lss_match_host(sender_host_name, sender_host_address, ...)
29462 .endd
29463 .vindex "&$sender_host_address$&"
29464 An empty address field matches an empty item in the host list. If the host name
29465 is NULL, the name corresponding to &$sender_host_address$& is automatically
29466 looked up if a host name is required to match an item in the list. The return
29467 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
29468 returns ERROR in the case when it had to look up a host name, but the lookup
29469 failed.
29470
29471 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
29472         *format,&~...)*&"
29473 This function writes to Exim's log files. The first argument should be zero (it
29474 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
29475 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
29476 them. It specifies to which log or logs the message is written. The remaining
29477 arguments are a format and relevant insertion arguments. The string should not
29478 contain any newlines, not even at the end.
29479
29480
29481 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
29482 This function adds an additional recipient to the message. The first argument
29483 is the recipient address. If it is unqualified (has no domain), it is qualified
29484 with the &%qualify_recipient%& domain. The second argument must always be -1.
29485
29486 This function does not allow you to specify a private &%errors_to%& address (as
29487 described with the structure of &%recipient_item%& above), because it pre-dates
29488 the addition of that field to the structure. However, it is easy to add such a
29489 value afterwards. For example:
29490 .code
29491  receive_add_recipient(US"monitor@mydom.example", -1);
29492  recipients_list[recipients_count-1].errors_to =
29493    US"postmaster@mydom.example";
29494 .endd
29495
29496 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
29497 This is a convenience function to remove a named recipient from the list of
29498 recipients. It returns true if a recipient was removed, and false if no
29499 matching recipient could be found. The argument must be a complete email
29500 address.
29501 .endlist
29502
29503
29504 .cindex "RFC 2047"
29505 .vlist
29506 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
29507   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
29508 This function decodes strings that are encoded according to RFC 2047. Typically
29509 these are the contents of header lines. First, each &"encoded word"& is decoded
29510 from the Q or B encoding into a byte-string. Then, if provided with the name of
29511 a charset encoding, and if the &[iconv()]& function is available, an attempt is
29512 made  to translate the result to the named character set. If this fails, the
29513 binary string is returned with an error message.
29514
29515 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
29516 maximum MIME word length is enforced. The third argument is the target
29517 encoding, or NULL if no translation is wanted.
29518
29519 .cindex "binary zero" "in RFC 2047 decoding"
29520 .cindex "RFC 2047" "binary zero in"
29521 If a binary zero is encountered in the decoded string, it is replaced by the
29522 contents of the &%zeroval%& argument. For use with Exim headers, the value must
29523 not be 0 because header lines are handled as zero-terminated strings.
29524
29525 The function returns the result of processing the string, zero-terminated; if
29526 &%lenptr%& is not NULL, the length of the result is set in the variable to
29527 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
29528
29529 If an error is encountered, the function returns NULL and uses the &%error%&
29530 argument to return an error message. The variable pointed to by &%error%& is
29531 set to NULL if there is no error; it may be set non-NULL even when the function
29532 returns a non-NULL value if decoding was successful, but there was a problem
29533 with translation.
29534
29535
29536 .vitem &*int&~smtp_fflush(void)*&
29537 This function is used in conjunction with &'smtp_printf()'&, as described
29538 below.
29539
29540 .vitem &*void&~smtp_printf(char&~*,&~...)*&
29541 The arguments of this function are like &[printf()]&; it writes to the SMTP
29542 output stream. You should use this function only when there is an SMTP output
29543 stream, that is, when the incoming message is being received via interactive
29544 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
29545 is FALSE. If you want to test for an incoming message from another host (as
29546 opposed to a local process that used the &%-bs%& command line option), you can
29547 test the value of &%sender_host_address%&, which is non-NULL when a remote host
29548 is involved.
29549
29550 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
29551 output function, so it can be used for all forms of SMTP connection.
29552
29553 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
29554 must start with an appropriate response code: 550 if you are going to return
29555 LOCAL_SCAN_REJECT, 451 if you are going to return
29556 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
29557 initial lines of a multi-line response, the code must be followed by a hyphen
29558 to indicate that the line is not the final response line. You must also ensure
29559 that the lines you write terminate with CRLF. For example:
29560 .code
29561 smtp_printf("550-this is some extra info\r\n");
29562 return LOCAL_SCAN_REJECT;
29563 .endd
29564 Note that you can also create multi-line responses by including newlines in
29565 the data returned via the &%return_text%& argument. The added value of using
29566 &'smtp_printf()'& is that, for instance, you could introduce delays between
29567 multiple output lines.
29568
29569 The &'smtp_printf()'& function does not return any error indication, because it
29570 does not automatically flush pending output, and therefore does not test
29571 the state of the stream. (In the main code of Exim, flushing and error
29572 detection is done when Exim is ready for the next SMTP input command.) If
29573 you want to flush the output and check for an error (for example, the
29574 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
29575 arguments. It flushes the output stream, and returns a non-zero value if there
29576 is an error.
29577
29578 .vitem &*void&~*store_get(int)*&
29579 This function accesses Exim's internal store (memory) manager. It gets a new
29580 chunk of memory whose size is given by the argument. Exim bombs out if it ever
29581 runs out of memory. See the next section for a discussion of memory handling.
29582
29583 .vitem &*void&~*store_get_perm(int)*&
29584 This function is like &'store_get()'&, but it always gets memory from the
29585 permanent pool. See the next section for a discussion of memory handling.
29586
29587 .vitem &*uschar&~*string_copy(uschar&~*string)*&
29588 See below.
29589
29590 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
29591 See below.
29592
29593 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
29594 These three functions create strings using Exim's dynamic memory facilities.
29595 The first makes a copy of an entire string. The second copies up to a maximum
29596 number of characters, indicated by the second argument. The third uses a format
29597 and insertion arguments to create a new string. In each case, the result is a
29598 pointer to a new string in the current memory pool. See the next section for
29599 more discussion.
29600 .endlist
29601
29602
29603
29604 .section "More about Exim's memory handling" "SECTmemhanloc"
29605 .cindex "&[local_scan()]& function" "memory handling"
29606 No function is provided for freeing memory, because that is never needed.
29607 The dynamic memory that Exim uses when receiving a message is automatically
29608 recycled if another message is received by the same process (this applies only
29609 to incoming SMTP connections &-- other input methods can supply only one
29610 message at a time). After receiving the last message, a reception process
29611 terminates.
29612
29613 Because it is recycled, the normal dynamic memory cannot be used for holding
29614 data that must be preserved over a number of incoming messages on the same SMTP
29615 connection. However, Exim in fact uses two pools of dynamic memory; the second
29616 one is not recycled, and can be used for this purpose.
29617
29618 If you want to allocate memory that remains available for subsequent messages
29619 in the same SMTP connection, you should set
29620 .code
29621 store_pool = POOL_PERM
29622 .endd
29623 before calling the function that does the allocation. There is no need to
29624 restore the value if you do not need to; however, if you do want to revert to
29625 the normal pool, you can either restore the previous value of &%store_pool%& or
29626 set it explicitly to POOL_MAIN.
29627
29628 The pool setting applies to all functions that get dynamic memory, including
29629 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
29630 There is also a convenience function called &'store_get_perm()'& that gets a
29631 block of memory from the permanent pool while preserving the value of
29632 &%store_pool%&.
29633 .ecindex IIDlosca
29634
29635
29636
29637
29638 . ////////////////////////////////////////////////////////////////////////////
29639 . ////////////////////////////////////////////////////////////////////////////
29640
29641 .chapter "System-wide message filtering" "CHAPsystemfilter"
29642 .scindex IIDsysfil1 "filter" "system filter"
29643 .scindex IIDsysfil2 "filtering all mail"
29644 .scindex IIDsysfil3 "system filter"
29645 The previous chapters (on ACLs and the local scan function) describe checks
29646 that can be applied to messages before they are accepted by a host. There is
29647 also a mechanism for checking messages once they have been received, but before
29648 they are delivered. This is called the &'system filter'&.
29649
29650 The system filter operates in a similar manner to users' filter files, but it
29651 is run just once per message (however many recipients the message has).
29652 It should not normally be used as a substitute for routing, because &%deliver%&
29653 commands in a system router provide new envelope recipient addresses.
29654 The system filter must be an Exim filter. It cannot be a Sieve filter.
29655
29656 The system filter is run at the start of a delivery attempt, before any routing
29657 is done. If a message fails to be completely delivered at the first attempt,
29658 the system filter is run again at the start of every retry.
29659 If you want your filter to do something only once per message, you can make use
29660 of the &%first_delivery%& condition in an &%if%& command in the filter to
29661 prevent it happening on retries.
29662
29663 .vindex "&$domain$&"
29664 .vindex "&$local_part$&"
29665 &*Warning*&: Because the system filter runs just once, variables that are
29666 specific to individual recipient addresses, such as &$local_part$& and
29667 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
29668 you want to run a centrally-specified filter for each recipient address
29669 independently, you can do so by setting up a suitable &(redirect)& router, as
29670 described in section &<<SECTperaddfil>>& below.
29671
29672
29673 .section "Specifying a system filter" "SECID212"
29674 .cindex "uid (user id)" "system filter"
29675 .cindex "gid (group id)" "system filter"
29676 The name of the file that contains the system filter must be specified by
29677 setting &%system_filter%&. If you want the filter to run under a uid and gid
29678 other than root, you must also set &%system_filter_user%& and
29679 &%system_filter_group%& as appropriate. For example:
29680 .code
29681 system_filter = /etc/mail/exim.filter
29682 system_filter_user = exim
29683 .endd
29684 If a system filter generates any deliveries directly to files or pipes (via the
29685 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
29686 specified by setting &%system_filter_file_transport%& and
29687 &%system_filter_pipe_transport%&, respectively. Similarly,
29688 &%system_filter_reply_transport%& must be set to handle any messages generated
29689 by the &%reply%& command.
29690
29691
29692 .section "Testing a system filter" "SECID213"
29693 You can run simple tests of a system filter in the same way as for a user
29694 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
29695 are permitted only in system filters are recognized.
29696
29697 If you want to test the combined effect of a system filter and a user filter,
29698 you can use both &%-bF%& and &%-bf%& on the same command line.
29699
29700
29701
29702 .section "Contents of a system filter" "SECID214"
29703 The language used to specify system filters is the same as for users' filter
29704 files. It is described in the separate end-user document &'Exim's interface to
29705 mail filtering'&. However, there are some additional features that are
29706 available only in system filters; these are described in subsequent sections.
29707 If they are encountered in a user's filter file or when testing with &%-bf%&,
29708 they cause errors.
29709
29710 .cindex "frozen messages" "manual thaw; testing in filter"
29711 There are two special conditions which, though available in users' filter
29712 files, are designed for use in system filters. The condition &%first_delivery%&
29713 is true only for the first attempt at delivering a message, and
29714 &%manually_thawed%& is true only if the message has been frozen, and
29715 subsequently thawed by an admin user. An explicit forced delivery counts as a
29716 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
29717
29718 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
29719 specify an &"unseen"& (non-significant) delivery, and that delivery does not
29720 succeed, it will not be tried again.
29721 If you want Exim to retry an unseen delivery until it succeeds, you should
29722 arrange to set it up every time the filter runs.
29723
29724 When a system filter finishes running, the values of the variables &$n0$& &--
29725 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
29726 users' filter files. Thus a system filter can, for example, set up &"scores"&
29727 to which users' filter files can refer.
29728
29729
29730
29731 .section "Additional variable for system filters" "SECID215"
29732 .vindex "&$recipients$&"
29733 The expansion variable &$recipients$&, containing a list of all the recipients
29734 of the message (separated by commas and white space), is available in system
29735 filters. It is not available in users' filters for privacy reasons.
29736
29737
29738
29739 .section "Defer, freeze, and fail commands for system filters" "SECID216"
29740 .cindex "freezing messages"
29741 .cindex "message" "freezing"
29742 .cindex "message" "forced failure"
29743 .cindex "&%fail%&" "in system filter"
29744 .cindex "&%freeze%& in system filter"
29745 .cindex "&%defer%& in system filter"
29746 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
29747 always available in system filters, but are not normally enabled in users'
29748 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
29749 for the &(redirect)& router.) These commands can optionally be followed by the
29750 word &%text%& and a string containing an error message, for example:
29751 .code
29752 fail text "this message looks like spam to me"
29753 .endd
29754 The keyword &%text%& is optional if the next character is a double quote.
29755
29756 The &%defer%& command defers delivery of the original recipients of the
29757 message. The &%fail%& command causes all the original recipients to be failed,
29758 and a bounce message to be created. The &%freeze%& command suspends all
29759 delivery attempts for the original recipients. In all cases, any new deliveries
29760 that are specified by the filter are attempted as normal after the filter has
29761 run.
29762
29763 The &%freeze%& command is ignored if the message has been manually unfrozen and
29764 not manually frozen since. This means that automatic freezing by a system
29765 filter can be used as a way of checking out suspicious messages. If a message
29766 is found to be all right, manually unfreezing it allows it to be delivered.
29767
29768 .cindex "log" "&%fail%& command log line"
29769 .cindex "&%fail%&" "log line; reducing"
29770 The text given with a fail command is used as part of the bounce message as
29771 well as being written to the log. If the message is quite long, this can fill
29772 up a lot of log space when such failures are common. To reduce the size of the
29773 log message, Exim interprets the text in a special way if it starts with the
29774 two characters &`<<`& and contains &`>>`& later. The text between these two
29775 strings is written to the log, and the rest of the text is used in the bounce
29776 message. For example:
29777 .code
29778 fail "<<filter test 1>>Your message is rejected \
29779      because it contains attachments that we are \
29780      not prepared to receive."
29781 .endd
29782
29783 .cindex "loop" "caused by &%fail%&"
29784 Take great care with the &%fail%& command when basing the decision to fail on
29785 the contents of the message, because the bounce message will of course include
29786 the contents of the original message and will therefore trigger the &%fail%&
29787 command again (causing a mail loop) unless steps are taken to prevent this.
29788 Testing the &%error_message%& condition is one way to prevent this. You could
29789 use, for example
29790 .code
29791 if $message_body contains "this is spam" and not error_message
29792 then fail text "spam is not wanted here" endif
29793 .endd
29794 though of course that might let through unwanted bounce messages. The
29795 alternative is clever checking of the body and/or headers to detect bounces
29796 generated by the filter.
29797
29798 The interpretation of a system filter file ceases after a
29799 &%defer%&,
29800 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
29801 set up earlier in the filter file are honoured, so you can use a sequence such
29802 as
29803 .code
29804 mail ...
29805 freeze
29806 .endd
29807 to send a specified message when the system filter is freezing (or deferring or
29808 failing) a message. The normal deliveries for the message do not, of course,
29809 take place.
29810
29811
29812
29813 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
29814 .cindex "header lines" "adding; in system filter"
29815 .cindex "header lines" "removing; in system filter"
29816 .cindex "filter" "header lines; adding/removing"
29817 Two filter commands that are available only in system filters are:
29818 .code
29819 headers add <string>
29820 headers remove <string>
29821 .endd
29822 The argument for the &%headers add%& is a string that is expanded and then
29823 added to the end of the message's headers. It is the responsibility of the
29824 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
29825 space is ignored, and if the string is otherwise empty, or if the expansion is
29826 forced to fail, the command has no effect.
29827
29828 You can use &"\n"& within the string, followed by white space, to specify
29829 continued header lines. More than one header may be added in one command by
29830 including &"\n"& within the string without any following white space. For
29831 example:
29832 .code
29833 headers add "X-header-1: ....\n  \
29834              continuation of X-header-1 ...\n\
29835              X-header-2: ...."
29836 .endd
29837 Note that the header line continuation white space after the first newline must
29838 be placed before the backslash that continues the input string, because white
29839 space after input continuations is ignored.
29840
29841 The argument for &%headers remove%& is a colon-separated list of header names.
29842 This command applies only to those headers that are stored with the message;
29843 those that are added at delivery time (such as &'Envelope-To:'& and
29844 &'Return-Path:'&) cannot be removed by this means. If there is more than one
29845 header with the same name, they are all removed.
29846
29847 The &%headers%& command in a system filter makes an immediate change to the set
29848 of header lines that was received with the message (with possible additions
29849 from ACL processing). Subsequent commands in the system filter operate on the
29850 modified set, which also forms the basis for subsequent message delivery.
29851 Unless further modified during routing or transporting, this set of headers is
29852 used for all recipients of the message.
29853
29854 During routing and transporting, the variables that refer to the contents of
29855 header lines refer only to those lines that are in this set. Thus, header lines
29856 that are added by a system filter are visible to users' filter files and to all
29857 routers and transports. This contrasts with the manipulation of header lines by
29858 routers and transports, which is not immediate, but which instead is saved up
29859 until the message is actually being written (see section
29860 &<<SECTheadersaddrem>>&).
29861
29862 If the message is not delivered at the first attempt, header lines that were
29863 added by the system filter are stored with the message, and so are still
29864 present at the next delivery attempt. Header lines that were removed are still
29865 present, but marked &"deleted"& so that they are not transported with the
29866 message. For this reason, it is usual to make the &%headers%& command
29867 conditional on &%first_delivery%& so that the set of header lines is not
29868 modified more than once.
29869
29870 Because header modification in a system filter acts immediately, you have to
29871 use an indirect approach if you want to modify the contents of a header line.
29872 For example:
29873 .code
29874 headers add "Old-Subject: $h_subject:"
29875 headers remove "Subject"
29876 headers add "Subject: new subject (was: $h_old-subject:)"
29877 headers remove "Old-Subject"
29878 .endd
29879
29880
29881
29882 .section "Setting an errors address in a system filter" "SECID217"
29883 .cindex "envelope sender"
29884 In a system filter, if a &%deliver%& command is followed by
29885 .code
29886 errors_to <some address>
29887 .endd
29888 in order to change the envelope sender (and hence the error reporting) for that
29889 delivery, any address may be specified. (In a user filter, only the current
29890 user's address can be set.) For example, if some mail is being monitored, you
29891 might use
29892 .code
29893 unseen deliver monitor@spying.example errors_to root@local.example
29894 .endd
29895 to take a copy which would not be sent back to the normal error reporting
29896 address if its delivery failed.
29897
29898
29899
29900 .section "Per-address filtering" "SECTperaddfil"
29901 .vindex "&$domain$&"
29902 .vindex "&$local_part$&"
29903 In contrast to the system filter, which is run just once per message for each
29904 delivery attempt, it is also possible to set up a system-wide filtering
29905 operation that runs once for each recipient address. In this case, variables
29906 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
29907 filter file could be made dependent on them. This is an example of a router
29908 which implements such a filter:
29909 .code
29910 central_filter:
29911   check_local_user
29912   driver = redirect
29913   domains = +local_domains
29914   file = /central/filters/$local_part
29915   no_verify
29916   allow_filter
29917   allow_freeze
29918 .endd
29919 The filter is run in a separate process under its own uid. Therefore, either
29920 &%check_local_user%& must be set (as above), in which case the filter is run as
29921 the local user, or the &%user%& option must be used to specify which user to
29922 use. If both are set, &%user%& overrides.
29923
29924 Care should be taken to ensure that none of the commands in the filter file
29925 specify a significant delivery if the message is to go on to be delivered to
29926 its intended recipient. The router will not then claim to have dealt with the
29927 address, so it will be passed on to subsequent routers to be delivered in the
29928 normal way.
29929 .ecindex IIDsysfil1
29930 .ecindex IIDsysfil2
29931 .ecindex IIDsysfil3
29932
29933
29934
29935
29936
29937
29938 . ////////////////////////////////////////////////////////////////////////////
29939 . ////////////////////////////////////////////////////////////////////////////
29940
29941 .chapter "Message processing" "CHAPmsgproc"
29942 .scindex IIDmesproc "message" "general processing"
29943 Exim performs various transformations on the sender and recipient addresses of
29944 all messages that it handles, and also on the messages' header lines. Some of
29945 these are optional and configurable, while others always take place. All of
29946 this processing, except rewriting as a result of routing, and the addition or
29947 removal of header lines while delivering, happens when a message is received,
29948 before it is placed on Exim's queue.
29949
29950 Some of the automatic processing takes place by default only for
29951 &"locally-originated"& messages. This adjective is used to describe messages
29952 that are not received over TCP/IP, but instead are passed to an Exim process on
29953 its standard input. This includes the interactive &"local SMTP"& case that is
29954 set up by the &%-bs%& command line option.
29955
29956 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
29957 or ::1) are not considered to be locally-originated. Exim does not treat the
29958 loopback interface specially in any way.
29959
29960 If you want the loopback interface to be treated specially, you must ensure
29961 that there are appropriate entries in your ACLs.
29962
29963
29964
29965
29966 .section "Submission mode for non-local messages" "SECTsubmodnon"
29967 .cindex "message" "submission"
29968 .cindex "submission mode"
29969 Processing that happens automatically for locally-originated messages (unless
29970 &%suppress_local_fixups%& is set) can also be requested for messages that are
29971 received over TCP/IP. The term &"submission mode"& is used to describe this
29972 state. Submission mode is set by the modifier
29973 .code
29974 control = submission
29975 .endd
29976 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
29977 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
29978 a local submission, and is normally used when the source of the message is
29979 known to be an MUA running on a client host (as opposed to an MTA). For
29980 example, to set submission mode for messages originating on the IPv4 loopback
29981 interface, you could include the following in the MAIL ACL:
29982 .code
29983 warn  hosts = 127.0.0.1
29984       control = submission
29985 .endd
29986 .cindex "&%sender_retain%& submission option"
29987 There are some options that can be used when setting submission mode. A slash
29988 is used to separate options. For example:
29989 .code
29990 control = submission/sender_retain
29991 .endd
29992 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
29993 true and &%local_from_check%& false for the current incoming message. The first
29994 of these allows an existing &'Sender:'& header in the message to remain, and
29995 the second suppresses the check to ensure that &'From:'& matches the
29996 authenticated sender. With this setting, Exim still fixes up messages by adding
29997 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
29998 attempt to check sender authenticity in header lines.
29999
30000 When &%sender_retain%& is not set, a submission mode setting may specify a
30001 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
30002 example:
30003 .code
30004 control = submission/domain=some.domain
30005 .endd
30006 The domain may be empty. How this value is used is described in sections
30007 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
30008 that allows you to specify the user's full name for inclusion in a created
30009 &'Sender:'& or &'From:'& header line. For example:
30010 .code
30011 accept authenticated = *
30012        control = submission/domain=wonderland.example/\
30013                             name=${lookup {$authenticated_id} \
30014                                    lsearch {/etc/exim/namelist}}
30015 .endd
30016 Because the name may contain any characters, including slashes, the &%name%&
30017 option must be given last. The remainder of the string is used as the name. For
30018 the example above, if &_/etc/exim/namelist_& contains:
30019 .code
30020 bigegg:  Humpty Dumpty
30021 .endd
30022 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
30023 line would be:
30024 .code
30025 Sender: Humpty Dumpty <bigegg@wonderland.example>
30026 .endd
30027 .cindex "return path" "in submission mode"
30028 By default, submission mode forces the return path to the same address as is
30029 used to create the &'Sender:'& header. However, if &%sender_retain%& is
30030 specified, the return path is also left unchanged.
30031
30032 &*Note*&: The changes caused by submission mode take effect after the predata
30033 ACL. This means that any sender checks performed before the fix-ups use the
30034 untrusted sender address specified by the user, not the trusted sender address
30035 specified by submission mode. Although this might be slightly unexpected, it
30036 does mean that you can configure ACL checks to spot that a user is trying to
30037 spoof another's address.
30038
30039 .section "Line endings" "SECTlineendings"
30040 .cindex "line endings"
30041 .cindex "carriage return"
30042 .cindex "linefeed"
30043 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
30044 linefeed) is the line ending for messages transmitted over the Internet using
30045 SMTP over TCP/IP. However, within individual operating systems, different
30046 conventions are used. For example, Unix-like systems use just LF, but others
30047 use CRLF or just CR.
30048
30049 Exim was designed for Unix-like systems, and internally, it stores messages
30050 using the system's convention of a single LF as a line terminator. When
30051 receiving a message, all line endings are translated to this standard format.
30052 Originally, it was thought that programs that passed messages directly to an
30053 MTA within an operating system would use that system's convention. Experience
30054 has shown that this is not the case; for example, there are Unix applications
30055 that use CRLF in this circumstance. For this reason, and for compatibility with
30056 other MTAs, the way Exim handles line endings for all messages is now as
30057 follows:
30058
30059 .ilist
30060 LF not preceded by CR is treated as a line ending.
30061 .next
30062 CR is treated as a line ending; if it is immediately followed by LF, the LF
30063 is ignored.
30064 .next
30065 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
30066 nor a local message in the state where a line containing only a dot is a
30067 terminator.
30068 .next
30069 If a bare CR is encountered within a header line, an extra space is added after
30070 the line terminator so as not to end the header line. The reasoning behind this
30071 is that bare CRs in header lines are most likely either to be mistakes, or
30072 people trying to play silly games.
30073 .next
30074 If the first header line received in a message ends with CRLF, a subsequent
30075 bare LF in a header line is treated in the same way as a bare CR in a header
30076 line.
30077 .endlist
30078
30079
30080
30081
30082
30083 .section "Unqualified addresses" "SECID218"
30084 .cindex "unqualified addresses"
30085 .cindex "address" "qualification"
30086 By default, Exim expects every envelope address it receives from an external
30087 host to be fully qualified. Unqualified addresses cause negative responses to
30088 SMTP commands. However, because SMTP is used as a means of transporting
30089 messages from MUAs running on personal workstations, there is sometimes a
30090 requirement to accept unqualified addresses from specific hosts or IP networks.
30091
30092 Exim has two options that separately control which hosts may send unqualified
30093 sender or recipient addresses in SMTP commands, namely
30094 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
30095 cases, if an unqualified address is accepted, it is qualified by adding the
30096 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
30097
30098 .oindex "&%qualify_domain%&"
30099 .oindex "&%qualify_recipient%&"
30100 Unqualified addresses in header lines are automatically qualified for messages
30101 that are locally originated, unless the &%-bnq%& option is given on the command
30102 line. For messages received over SMTP, unqualified addresses in header lines
30103 are qualified only if unqualified addresses are permitted in SMTP commands. In
30104 other words, such qualification is also controlled by
30105 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
30106
30107
30108
30109
30110 .section "The UUCP From line" "SECID219"
30111 .cindex "&""From""& line"
30112 .cindex "UUCP" "&""From""& line"
30113 .cindex "sender" "address"
30114 .oindex "&%uucp_from_pattern%&"
30115 .oindex "&%uucp_from_sender%&"
30116 .cindex "envelope sender"
30117 .cindex "Sendmail compatibility" "&""From""& line"
30118 Messages that have come from UUCP (and some other applications) often begin
30119 with a line containing the envelope sender and a timestamp, following the word
30120 &"From"&. Examples of two common formats are:
30121 .code
30122 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
30123 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
30124 .endd
30125 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
30126 Exim recognizes such lines at the start of messages that are submitted to it
30127 via the command line (that is, on the standard input). It does not recognize
30128 such lines in incoming SMTP messages, unless the sending host matches
30129 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
30130 and &%ignore_fromline_local%& is set. The recognition is controlled by a
30131 regular expression that is defined by the &%uucp_from_pattern%& option, whose
30132 default value matches the two common cases shown above and puts the address
30133 that follows &"From"& into &$1$&.
30134
30135 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
30136 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
30137 a trusted user, the message's sender address is constructed by expanding the
30138 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
30139 then parsed as an RFC 2822 address. If there is no domain, the local part is
30140 qualified with &%qualify_domain%& unless it is the empty string. However, if
30141 the command line &%-f%& option is used, it overrides the &"From"& line.
30142
30143 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
30144 sender address is not changed. This is also the case for incoming SMTP messages
30145 that are permitted to contain &"From"& lines.
30146
30147 Only one &"From"& line is recognized. If there is more than one, the second is
30148 treated as a data line that starts the body of the message, as it is not valid
30149 as a header line. This also happens if a &"From"& line is present in an
30150 incoming SMTP message from a source that is not permitted to send them.
30151
30152
30153
30154 .section "Resent- header lines" "SECID220"
30155 .cindex "&%Resent-%& header lines"
30156 RFC 2822 makes provision for sets of header lines starting with the string
30157 &`Resent-`& to be added to a message when it is resent by the original
30158 recipient to somebody else. These headers are &'Resent-Date:'&,
30159 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
30160 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
30161
30162 .blockquote
30163 &'Resent fields are strictly informational. They MUST NOT be used in the normal
30164 processing of replies or other such automatic actions on messages.'&
30165 .endblockquote
30166
30167 This leaves things a bit vague as far as other processing actions such as
30168 address rewriting are concerned. Exim treats &%Resent-%& header lines as
30169 follows:
30170
30171 .ilist
30172 A &'Resent-From:'& line that just contains the login id of the submitting user
30173 is automatically rewritten in the same way as &'From:'& (see below).
30174 .next
30175 If there's a rewriting rule for a particular header line, it is also applied to
30176 &%Resent-%& header lines of the same type. For example, a rule that rewrites
30177 &'From:'& also rewrites &'Resent-From:'&.
30178 .next
30179 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
30180 also removed.
30181 .next
30182 For a locally-submitted message,
30183 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
30184 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
30185 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
30186 included in log lines in this case.
30187 .next
30188 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
30189 &%Resent-%& header lines are present.
30190 .endlist
30191
30192
30193
30194
30195 .section "The Auto-Submitted: header line" "SECID221"
30196 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
30197 includes the header line:
30198 .code
30199 Auto-Submitted: auto-replied
30200 .endd
30201
30202 .section "The Bcc: header line" "SECID222"
30203 .cindex "&'Bcc:'& header line"
30204 If Exim is called with the &%-t%& option, to take recipient addresses from a
30205 message's header, it removes any &'Bcc:'& header line that may exist (after
30206 extracting its addresses). If &%-t%& is not present on the command line, any
30207 existing &'Bcc:'& is not removed.
30208
30209
30210 .section "The Date: header line" "SECID223"
30211 .cindex "&'Date:'& header line"
30212 If a locally-generated or submission-mode message has no &'Date:'& header line,
30213 Exim adds one, using the current date and time, unless the
30214 &%suppress_local_fixups%& control has been specified.
30215
30216 .section "The Delivery-date: header line" "SECID224"
30217 .cindex "&'Delivery-date:'& header line"
30218 .oindex "&%delivery_date_remove%&"
30219 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
30220 set. Exim can be configured to add them to the final delivery of messages. (See
30221 the generic &%delivery_date_add%& transport option.) They should not be present
30222 in messages in transit. If the &%delivery_date_remove%& configuration option is
30223 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
30224 messages.
30225
30226
30227 .section "The Envelope-to: header line" "SECID225"
30228 .cindex "&'Envelope-to:'& header line"
30229 .oindex "&%envelope_to_remove%&"
30230 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
30231 Exim can be configured to add them to the final delivery of messages. (See the
30232 generic &%envelope_to_add%& transport option.) They should not be present in
30233 messages in transit. If the &%envelope_to_remove%& configuration option is set
30234 (the default), Exim removes &'Envelope-to:'& header lines from incoming
30235 messages.
30236
30237
30238 .section "The From: header line" "SECTthefrohea"
30239 .cindex "&'From:'& header line"
30240 .cindex "Sendmail compatibility" "&""From""& line"
30241 .cindex "message" "submission"
30242 .cindex "submission mode"
30243 If a submission-mode message does not contain a &'From:'& header line, Exim
30244 adds one if either of the following conditions is true:
30245
30246 .ilist
30247 The envelope sender address is not empty (that is, this is not a bounce
30248 message). The added header line copies the envelope sender address.
30249 .next
30250 .vindex "&$authenticated_id$&"
30251 The SMTP session is authenticated and &$authenticated_id$& is not empty.
30252 .olist
30253 .vindex "&$qualify_domain$&"
30254 If no domain is specified by the submission control, the local part is
30255 &$authenticated_id$& and the domain is &$qualify_domain$&.
30256 .next
30257 If a non-empty domain is specified by the submission control, the local
30258 part is &$authenticated_id$&, and the domain is the specified domain.
30259 .next
30260 If an empty domain is specified by the submission control,
30261 &$authenticated_id$& is assumed to be the complete address.
30262 .endlist
30263 .endlist
30264
30265 A non-empty envelope sender takes precedence.
30266
30267 If a locally-generated incoming message does not contain a &'From:'& header
30268 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
30269 containing the sender's address. The calling user's login name and full name
30270 are used to construct the address, as described in section &<<SECTconstr>>&.
30271 They are obtained from the password data by calling &[getpwuid()]& (but see the
30272 &%unknown_login%& configuration option). The address is qualified with
30273 &%qualify_domain%&.
30274
30275 For compatibility with Sendmail, if an incoming, non-SMTP message has a
30276 &'From:'& header line containing just the unqualified login name of the calling
30277 user, this is replaced by an address containing the user's login name and full
30278 name as described in section &<<SECTconstr>>&.
30279
30280
30281 .section "The Message-ID: header line" "SECID226"
30282 .cindex "&'Message-ID:'& header line"
30283 .cindex "message" "submission"
30284 .oindex "&%message_id_header_text%&"
30285 If a locally-generated or submission-mode incoming message does not contain a
30286 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
30287 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
30288 to the message. If there are any &'Resent-:'& headers in the message, it
30289 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
30290 message id, preceded by the letter E to ensure it starts with a letter, and
30291 followed by @ and the primary host name. Additional information can be included
30292 in this header line by setting the &%message_id_header_text%& and/or
30293 &%message_id_header_domain%& options.
30294
30295
30296 .section "The Received: header line" "SECID227"
30297 .cindex "&'Received:'& header line"
30298 A &'Received:'& header line is added at the start of every message. The
30299 contents are defined by the &%received_header_text%& configuration option, and
30300 Exim automatically adds a semicolon and a timestamp to the configured string.
30301
30302 The &'Received:'& header is generated as soon as the message's header lines
30303 have been received. At this stage, the timestamp in the &'Received:'& header
30304 line is the time that the message started to be received. This is the value
30305 that is seen by the DATA ACL and by the &[local_scan()]& function.
30306
30307 Once a message is accepted, the timestamp in the &'Received:'& header line is
30308 changed to the time of acceptance, which is (apart from a small delay while the
30309 -H spool file is written) the earliest time at which delivery could start.
30310
30311
30312 .section "The References: header line" "SECID228"
30313 .cindex "&'References:'& header line"
30314 Messages created by the &(autoreply)& transport include a &'References:'&
30315 header line. This is constructed according to the rules that are described in
30316 section 3.64 of RFC 2822 (which states that replies should contain such a
30317 header line), and section 3.14 of RFC 3834 (which states that automatic
30318 responses are not different in this respect). However, because some mail
30319 processing software does not cope well with very long header lines, no more
30320 than 12 message IDs are copied from the &'References:'& header line in the
30321 incoming message. If there are more than 12, the first one and then the final
30322 11 are copied, before adding the message ID of the incoming message.
30323
30324
30325
30326 .section "The Return-path: header line" "SECID229"
30327 .cindex "&'Return-path:'& header line"
30328 .oindex "&%return_path_remove%&"
30329 &'Return-path:'& header lines are defined as something an MTA may insert when
30330 it does the final delivery of messages. (See the generic &%return_path_add%&
30331 transport option.) Therefore, they should not be present in messages in
30332 transit. If the &%return_path_remove%& configuration option is set (the
30333 default), Exim removes &'Return-path:'& header lines from incoming messages.
30334
30335
30336
30337 .section "The Sender: header line" "SECTthesenhea"
30338 .cindex "&'Sender:'& header line"
30339 .cindex "message" "submission"
30340 For a locally-originated message from an untrusted user, Exim may remove an
30341 existing &'Sender:'& header line, and it may add a new one. You can modify
30342 these actions by setting the &%local_sender_retain%& option true, the
30343 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
30344 control setting.
30345
30346 When a local message is received from an untrusted user and
30347 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
30348 control has not been set, a check is made to see if the address given in the
30349 &'From:'& header line is the correct (local) sender of the message. The address
30350 that is expected has the login name as the local part and the value of
30351 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
30352 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
30353 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
30354 line is added to the message.
30355
30356 If you set &%local_from_check%& false, this checking does not occur. However,
30357 the removal of an existing &'Sender:'& line still happens, unless you also set
30358 &%local_sender_retain%& to be true. It is not possible to set both of these
30359 options true at the same time.
30360
30361 .cindex "submission mode"
30362 By default, no processing of &'Sender:'& header lines is done for messages
30363 received over TCP/IP or for messages submitted by trusted users. However, when
30364 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
30365 not specified on the submission control, the following processing takes place:
30366
30367 .vindex "&$authenticated_id$&"
30368 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
30369 authenticated, and &$authenticated_id$& is not empty, a sender address is
30370 created as follows:
30371
30372 .ilist
30373 .vindex "&$qualify_domain$&"
30374 If no domain is specified by the submission control, the local part is
30375 &$authenticated_id$& and the domain is &$qualify_domain$&.
30376 .next
30377 If a non-empty domain is specified by the submission control, the local part
30378 is &$authenticated_id$&, and the domain is the specified domain.
30379 .next
30380 If an empty domain is specified by the submission control,
30381 &$authenticated_id$& is assumed to be the complete address.
30382 .endlist
30383
30384 This address is compared with the address in the &'From:'& header line. If they
30385 are different, a &'Sender:'& header line containing the created address is
30386 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
30387 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
30388
30389 .cindex "return path" "created from &'Sender:'&"
30390 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
30391 the message (the envelope sender address) is changed to be the same address,
30392 except in the case of submission mode when &%sender_retain%& is specified.
30393
30394
30395
30396 .section "Adding and removing header lines in routers and transports" &&&
30397          "SECTheadersaddrem"
30398 .cindex "header lines" "adding; in router or transport"
30399 .cindex "header lines" "removing; in router or transport"
30400 When a message is delivered, the addition and removal of header lines can be
30401 specified in a system filter, or on any of the routers and transports that
30402 process the message. Section &<<SECTaddremheasys>>& contains details about
30403 modifying headers in a system filter. Header lines can also be added in an ACL
30404 as a message is received (see section &<<SECTaddheadacl>>&).
30405
30406 In contrast to what happens in a system filter, header modifications that are
30407 specified on routers and transports apply only to the particular recipient
30408 addresses that are being processed by those routers and transports. These
30409 changes do not actually take place until a copy of the message is being
30410 transported. Therefore, they do not affect the basic set of header lines, and
30411 they do not affect the values of the variables that refer to header lines.
30412
30413 &*Note*&: In particular, this means that any expansions in the configuration of
30414 the transport cannot refer to the modified header lines, because such
30415 expansions all occur before the message is actually transported.
30416
30417 For both routers and transports, the result of expanding a &%headers_add%&
30418 option must be in the form of one or more RFC 2822 header lines, separated by
30419 newlines (coded as &"\n"&). For example:
30420 .code
30421 headers_add = X-added-header: added by $primary_hostname\n\
30422               X-added-second: another added header line
30423 .endd
30424 Exim does not check the syntax of these added header lines.
30425
30426 The result of expanding &%headers_remove%& must consist of a colon-separated
30427 list of header names. This is confusing, because header names themselves are
30428 often terminated by colons. In this case, the colons are the list separators,
30429 not part of the names. For example:
30430 .code
30431 headers_remove = return-receipt-to:acknowledge-to
30432 .endd
30433 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
30434 is expanded at routing time, and then associated with all addresses that are
30435 accepted by that router, and also with any new addresses that it generates. If
30436 an address passes through several routers as a result of aliasing or
30437 forwarding, the changes are cumulative.
30438
30439 .oindex "&%unseen%&"
30440 However, this does not apply to multiple routers that result from the use of
30441 the &%unseen%& option. Any header modifications that were specified by the
30442 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
30443
30444 Addresses that end up with different &%headers_add%& or &%headers_remove%&
30445 settings cannot be delivered together in a batch, so a transport is always
30446 dealing with a set of addresses that have the same header-processing
30447 requirements.
30448
30449 The transport starts by writing the original set of header lines that arrived
30450 with the message, possibly modified by the system filter. As it writes out
30451 these lines, it consults the list of header names that were attached to the
30452 recipient address(es) by &%headers_remove%& options in routers, and it also
30453 consults the transport's own &%headers_remove%& option. Header lines whose
30454 names are on either of these lists are not written out. If there are multiple
30455 instances of any listed header, they are all skipped.
30456
30457 After the remaining original header lines have been written, new header
30458 lines that were specified by routers' &%headers_add%& options are written, in
30459 the order in which they were attached to the address. These are followed by any
30460 header lines specified by the transport's &%headers_add%& option.
30461
30462 This way of handling header line modifications in routers and transports has
30463 the following consequences:
30464
30465 .ilist
30466 The original set of header lines, possibly modified by the system filter,
30467 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
30468 to it, at all times.
30469 .next
30470 Header lines that are added by a router's
30471 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
30472 expansion syntax in subsequent routers or the transport.
30473 .next
30474 Conversely, header lines that are specified for removal by &%headers_remove%&
30475 in a router remain visible to subsequent routers and the transport.
30476 .next
30477 Headers added to an address by &%headers_add%& in a router cannot be removed by
30478 a later router or by a transport.
30479 .next
30480 An added header can refer to the contents of an original header that is to be
30481 removed, even it has the same name as the added header. For example:
30482 .code
30483 headers_remove = subject
30484 headers_add = Subject: new subject (was: $h_subject:)
30485 .endd
30486 .endlist
30487
30488 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
30489 for a &(redirect)& router that has the &%one_time%& option set.
30490
30491
30492
30493
30494
30495 .section "Constructed addresses" "SECTconstr"
30496 .cindex "address" "constructed"
30497 .cindex "constructed address"
30498 When Exim constructs a sender address for a locally-generated message, it uses
30499 the form
30500 .display
30501 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
30502 .endd
30503 For example:
30504 .code
30505 Zaphod Beeblebrox <zaphod@end.univ.example>
30506 .endd
30507 The user name is obtained from the &%-F%& command line option if set, or
30508 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
30509 &"gecos"& field from the password entry. If the &"gecos"& field contains an
30510 ampersand character, this is replaced by the login name with the first letter
30511 upper cased, as is conventional in a number of operating systems. See the
30512 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
30513 The &%unknown_username%& option can be used to specify user names in cases when
30514 there is no password file entry.
30515
30516 .cindex "RFC 2047"
30517 In all cases, the user name is made to conform to RFC 2822 by quoting all or
30518 parts of it if necessary. In addition, if it contains any non-printing
30519 characters, it is encoded as described in RFC 2047, which defines a way of
30520 including non-ASCII characters in header lines. The value of the
30521 &%headers_charset%& option specifies the name of the encoding that is used (the
30522 characters are assumed to be in this encoding). The setting of
30523 &%print_topbitchars%& controls whether characters with the top bit set (that
30524 is, with codes greater than 127) count as printing characters or not.
30525
30526
30527
30528 .section "Case of local parts" "SECID230"
30529 .cindex "case of local parts"
30530 .cindex "local part" "case of"
30531 RFC 2822 states that the case of letters in the local parts of addresses cannot
30532 be assumed to be non-significant. Exim preserves the case of local parts of
30533 addresses, but by default it uses a lower-cased form when it is routing,
30534 because on most Unix systems, usernames are in lower case and case-insensitive
30535 routing is required. However, any particular router can be made to use the
30536 original case for local parts by setting the &%caseful_local_part%& generic
30537 router option.
30538
30539 .cindex "mixed-case login names"
30540 If you must have mixed-case user names on your system, the best way to proceed,
30541 assuming you want case-independent handling of incoming email, is to set up
30542 your first router to convert incoming local parts in your domains to the
30543 correct case by means of a file lookup. For example:
30544 .code
30545 correct_case:
30546   driver = redirect
30547   domains = +local_domains
30548   data = ${lookup{$local_part}cdb\
30549               {/etc/usercased.cdb}{$value}fail}\
30550               @$domain
30551 .endd
30552 For this router, the local part is forced to lower case by the default action
30553 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
30554 up a new local part in the correct case. If you then set &%caseful_local_part%&
30555 on any subsequent routers which process your domains, they will operate on
30556 local parts with the correct case in a case-sensitive manner.
30557
30558
30559
30560 .section "Dots in local parts" "SECID231"
30561 .cindex "dot" "in local part"
30562 .cindex "local part" "dots in"
30563 RFC 2822 forbids empty components in local parts. That is, an unquoted local
30564 part may not begin or end with a dot, nor have two consecutive dots in the
30565 middle. However, it seems that many MTAs do not enforce this, so Exim permits
30566 empty components for compatibility.
30567
30568
30569
30570 .section "Rewriting addresses" "SECID232"
30571 .cindex "rewriting" "addresses"
30572 Rewriting of sender and recipient addresses, and addresses in headers, can
30573 happen automatically, or as the result of configuration options, as described
30574 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
30575 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
30576
30577 Automatic rewriting includes qualification, as mentioned above. The other case
30578 in which it can happen is when an incomplete non-local domain is given. The
30579 routing process may cause this to be expanded into the full domain name. For
30580 example, a header such as
30581 .code
30582 To: hare@teaparty
30583 .endd
30584 might get rewritten as
30585 .code
30586 To: hare@teaparty.wonderland.fict.example
30587 .endd
30588 Rewriting as a result of routing is the one kind of message processing that
30589 does not happen at input time, as it cannot be done until the address has
30590 been routed.
30591
30592 Strictly, one should not do &'any'& deliveries of a message until all its
30593 addresses have been routed, in case any of the headers get changed as a
30594 result of routing. However, doing this in practice would hold up many
30595 deliveries for unreasonable amounts of time, just because one address could not
30596 immediately be routed. Exim therefore does not delay other deliveries when
30597 routing of one or more addresses is deferred.
30598 .ecindex IIDmesproc
30599
30600
30601
30602 . ////////////////////////////////////////////////////////////////////////////
30603 . ////////////////////////////////////////////////////////////////////////////
30604
30605 .chapter "SMTP processing" "CHAPSMTP"
30606 .scindex IIDsmtpproc1 "SMTP" "processing details"
30607 .scindex IIDsmtpproc2 "LMTP" "processing details"
30608 Exim supports a number of different ways of using the SMTP protocol, and its
30609 LMTP variant, which is an interactive protocol for transferring messages into a
30610 closed mail store application. This chapter contains details of how SMTP is
30611 processed. For incoming mail, the following are available:
30612
30613 .ilist
30614 SMTP over TCP/IP (Exim daemon or &'inetd'&);
30615 .next
30616 SMTP over the standard input and output (the &%-bs%& option);
30617 .next
30618 Batched SMTP on the standard input (the &%-bS%& option).
30619 .endlist
30620
30621 For mail delivery, the following are available:
30622
30623 .ilist
30624 SMTP over TCP/IP (the &(smtp)& transport);
30625 .next
30626 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
30627 &"lmtp"&);
30628 .next
30629 LMTP over a pipe to a process running in the local host (the &(lmtp)&
30630 transport);
30631 .next
30632 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
30633 the &%use_bsmtp%& option set).
30634 .endlist
30635
30636 &'Batched SMTP'& is the name for a process in which batches of messages are
30637 stored in or read from files (or pipes), in a format in which SMTP commands are
30638 used to contain the envelope information.
30639
30640
30641
30642 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
30643 .cindex "SMTP" "outgoing over TCP/IP"
30644 .cindex "outgoing SMTP over TCP/IP"
30645 .cindex "LMTP" "over TCP/IP"
30646 .cindex "outgoing LMTP over TCP/IP"
30647 .cindex "EHLO"
30648 .cindex "HELO"
30649 .cindex "SIZE option on MAIL command"
30650 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
30651 The &%protocol%& option selects which protocol is to be used, but the actual
30652 processing is the same in both cases.
30653
30654 If, in response to its EHLO command, Exim is told that the SIZE
30655 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
30656 command. The value of <&'n'&> is the message size plus the value of the
30657 &%size_addition%& option (default 1024) to allow for additions to the message
30658 such as per-transport header lines, or changes made in a
30659 .cindex "transport" "filter"
30660 .cindex "filter" "transport filter"
30661 transport filter. If &%size_addition%& is set negative, the use of SIZE is
30662 suppressed.
30663
30664 If the remote server advertises support for PIPELINING, Exim uses the
30665 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
30666 required for the transaction.
30667
30668 If the remote server advertises support for the STARTTLS command, and Exim
30669 was built to support TLS encryption, it tries to start a TLS session unless the
30670 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
30671
30672 If the remote server advertises support for the AUTH command, Exim scans
30673 the authenticators configuration for any suitable client settings, as described
30674 in chapter &<<CHAPSMTPAUTH>>&.
30675
30676 .cindex "carriage return"
30677 .cindex "linefeed"
30678 Responses from the remote host are supposed to be terminated by CR followed by
30679 LF. However, there are known to be hosts that do not send CR characters, so in
30680 order to be able to interwork with such hosts, Exim treats LF on its own as a
30681 line terminator.
30682
30683 If a message contains a number of different addresses, all those with the same
30684 characteristics (for example, the same envelope sender) that resolve to the
30685 same set of hosts, in the same order, are sent in a single SMTP transaction,
30686 even if they are for different domains, unless there are more than the setting
30687 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
30688 they are split into groups containing no more than &%max_rcpt%&s addresses
30689 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
30690 in parallel sessions. The order of hosts with identical MX values is not
30691 significant when checking whether addresses can be batched in this way.
30692
30693 When the &(smtp)& transport suffers a temporary failure that is not
30694 message-related, Exim updates its transport-specific database, which contains
30695 records indexed by host name that remember which messages are waiting for each
30696 particular host. It also updates the retry database with new retry times.
30697
30698 .cindex "hints database" "retry keys"
30699 Exim's retry hints are based on host name plus IP address, so if one address of
30700 a multi-homed host is broken, it will soon be skipped most of the time.
30701 See the next section for more detail about error handling.
30702
30703 .cindex "SMTP" "passed connection"
30704 .cindex "SMTP" "batching over TCP/IP"
30705 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
30706 looks in the hints database for the transport to see if there are any queued
30707 messages waiting for the host to which it is connected. If it finds one, it
30708 creates a new Exim process using the &%-MC%& option (which can only be used by
30709 a process running as root or the Exim user) and passes the TCP/IP socket to it
30710 so that it can deliver another message using the same socket. The new process
30711 does only those deliveries that are routed to the connected host, and may in
30712 turn pass the socket on to a third process, and so on.
30713
30714 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
30715 limit the number of messages sent down a single TCP/IP connection.
30716
30717 .cindex "asterisk" "after IP address"
30718 The second and subsequent messages delivered down an existing connection are
30719 identified in the main log by the addition of an asterisk after the closing
30720 square bracket of the IP address.
30721
30722
30723
30724
30725 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
30726 .cindex "error" "in outgoing SMTP"
30727 .cindex "SMTP" "errors in outgoing"
30728 .cindex "host" "error"
30729 Three different kinds of error are recognized for outgoing SMTP: host errors,
30730 message errors, and recipient errors.
30731
30732 .vlist
30733 .vitem "&*Host errors*&"
30734 A host error is not associated with a particular message or with a
30735 particular recipient of a message. The host errors are:
30736
30737 .ilist
30738 Connection refused or timed out,
30739 .next
30740 Any error response code on connection,
30741 .next
30742 Any error response code to EHLO or HELO,
30743 .next
30744 Loss of connection at any time, except after &"."&,
30745 .next
30746 I/O errors at any time,
30747 .next
30748 Timeouts during the session, other than in response to MAIL, RCPT or
30749 the &"."& at the end of the data.
30750 .endlist ilist
30751
30752 For a host error, a permanent error response on connection, or in response to
30753 EHLO, causes all addresses routed to the host to be failed. Any other host
30754 error causes all addresses to be deferred, and retry data to be created for the
30755 host. It is not tried again, for any message, until its retry time arrives. If
30756 the current set of addresses are not all delivered in this run (to some
30757 alternative host), the message is added to the list of those waiting for this
30758 host, so if it is still undelivered when a subsequent successful delivery is
30759 made to the host, it will be sent down the same SMTP connection.
30760
30761 .vitem "&*Message errors*&"
30762 .cindex "message" "error"
30763 A message error is associated with a particular message when sent to a
30764 particular host, but not with a particular recipient of the message. The
30765 message errors are:
30766
30767 .ilist
30768 Any error response code to MAIL, DATA, or the &"."& that terminates
30769 the data,
30770 .next
30771 Timeout after MAIL,
30772 .next
30773 Timeout or loss of connection after the &"."& that terminates the data. A
30774 timeout after the DATA command itself is treated as a host error, as is loss of
30775 connection at any other time.
30776 .endlist ilist
30777
30778 For a message error, a permanent error response (5&'xx'&) causes all addresses
30779 to be failed, and a delivery error report to be returned to the sender. A
30780 temporary error response (4&'xx'&), or one of the timeouts, causes all
30781 addresses to be deferred. Retry data is not created for the host, but instead,
30782 a retry record for the combination of host plus message id is created. The
30783 message is not added to the list of those waiting for this host. This ensures
30784 that the failing message will not be sent to this host again until the retry
30785 time arrives. However, other messages that are routed to the host are not
30786 affected, so if it is some property of the message that is causing the error,
30787 it will not stop the delivery of other mail.
30788
30789 If the remote host specified support for the SIZE parameter in its response
30790 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
30791 over-large message will cause a message error because the error arrives as a
30792 response to MAIL.
30793
30794 .vitem "&*Recipient errors*&"
30795 .cindex "recipient" "error"
30796 A recipient error is associated with a particular recipient of a message. The
30797 recipient errors are:
30798
30799 .ilist
30800 Any error response to RCPT,
30801 .next
30802 Timeout after RCPT.
30803 .endlist
30804
30805 For a recipient error, a permanent error response (5&'xx'&) causes the
30806 recipient address to be failed, and a bounce message to be returned to the
30807 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
30808 address to be deferred, and routing retry data to be created for it. This is
30809 used to delay processing of the address in subsequent queue runs, until its
30810 routing retry time arrives. This applies to all messages, but because it
30811 operates only in queue runs, one attempt will be made to deliver a new message
30812 to the failing address before the delay starts to operate. This ensures that,
30813 if the failure is really related to the message rather than the recipient
30814 (&"message too big for this recipient"& is a possible example), other messages
30815 have a chance of getting delivered. If a delivery to the address does succeed,
30816 the retry information gets cleared, so all stuck messages get tried again, and
30817 the retry clock is reset.
30818
30819 The message is not added to the list of those waiting for this host. Use of the
30820 host for other messages is unaffected, and except in the case of a timeout,
30821 other recipients are processed independently, and may be successfully delivered
30822 in the current SMTP session. After a timeout it is of course impossible to
30823 proceed with the session, so all addresses get deferred. However, those other
30824 than the one that failed do not suffer any subsequent retry delays. Therefore,
30825 if one recipient is causing trouble, the others have a chance of getting
30826 through when a subsequent delivery attempt occurs before the failing
30827 recipient's retry time.
30828 .endlist
30829
30830 In all cases, if there are other hosts (or IP addresses) available for the
30831 current set of addresses (for example, from multiple MX records), they are
30832 tried in this run for any undelivered addresses, subject of course to their
30833 own retry data. In other words, recipient error retry data does not take effect
30834 until the next delivery attempt.
30835
30836 Some hosts have been observed to give temporary error responses to every
30837 MAIL command at certain times (&"insufficient space"& has been seen). It
30838 would be nice if such circumstances could be recognized, and defer data for the
30839 host itself created, but this is not possible within the current Exim design.
30840 What actually happens is that retry data for every (host, message) combination
30841 is created.
30842
30843 The reason that timeouts after MAIL and RCPT are treated specially is that
30844 these can sometimes arise as a result of the remote host's verification
30845 procedures. Exim makes this assumption, and treats them as if a temporary error
30846 response had been received. A timeout after &"."& is treated specially because
30847 it is known that some broken implementations fail to recognize the end of the
30848 message if the last character of the last line is a binary zero. Thus, it is
30849 helpful to treat this case as a message error.
30850
30851 Timeouts at other times are treated as host errors, assuming a problem with the
30852 host, or the connection to it. If a timeout after MAIL, RCPT,
30853 or &"."& is really a connection problem, the assumption is that at the next try
30854 the timeout is likely to occur at some other point in the dialogue, causing it
30855 then to be treated as a host error.
30856
30857 There is experimental evidence that some MTAs drop the connection after the
30858 terminating &"."& if they do not like the contents of the message for some
30859 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
30860 should be given. That is why Exim treats this case as a message rather than a
30861 host error, in order not to delay other messages to the same host.
30862
30863
30864
30865
30866 .section "Incoming SMTP messages over TCP/IP" "SECID233"
30867 .cindex "SMTP" "incoming over TCP/IP"
30868 .cindex "incoming SMTP over TCP/IP"
30869 .cindex "inetd"
30870 .cindex "daemon"
30871 Incoming SMTP messages can be accepted in one of two ways: by running a
30872 listening daemon, or by using &'inetd'&. In the latter case, the entry in
30873 &_/etc/inetd.conf_& should be like this:
30874 .code
30875 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
30876 .endd
30877 Exim distinguishes between this case and the case of a locally running user
30878 agent using the &%-bs%& option by checking whether or not the standard input is
30879 a socket. When it is, either the port must be privileged (less than 1024), or
30880 the caller must be root or the Exim user. If any other user passes a socket
30881 with an unprivileged port number, Exim prints a message on the standard error
30882 stream and exits with an error code.
30883
30884 By default, Exim does not make a log entry when a remote host connects or
30885 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
30886 unexpected. It can be made to write such log entries by setting the
30887 &%smtp_connection%& log selector.
30888
30889 .cindex "carriage return"
30890 .cindex "linefeed"
30891 Commands from the remote host are supposed to be terminated by CR followed by
30892 LF. However, there are known to be hosts that do not send CR characters. In
30893 order to be able to interwork with such hosts, Exim treats LF on its own as a
30894 line terminator.
30895 Furthermore, because common code is used for receiving messages from all
30896 sources, a CR on its own is also interpreted as a line terminator. However, the
30897 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
30898
30899 .cindex "EHLO" "invalid data"
30900 .cindex "HELO" "invalid data"
30901 One area that sometimes gives rise to problems concerns the EHLO or
30902 HELO commands. Some clients send syntactically invalid versions of these
30903 commands, which Exim rejects by default. (This is nothing to do with verifying
30904 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
30905 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
30906 match the broken hosts that send invalid commands.
30907
30908 .cindex "SIZE option on MAIL command"
30909 .cindex "MAIL" "SIZE option"
30910 The amount of disk space available is checked whenever SIZE is received on
30911 a MAIL command, independently of whether &%message_size_limit%& or
30912 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
30913 false. A temporary error is given if there is not enough space. If
30914 &%check_spool_space%& is set, the check is for that amount of space plus the
30915 value given with SIZE, that is, it checks that the addition of the incoming
30916 message will not reduce the space below the threshold.
30917
30918 When a message is successfully received, Exim includes the local message id in
30919 its response to the final &"."& that terminates the data. If the remote host
30920 logs this text it can help with tracing what has happened to a message.
30921
30922 The Exim daemon can limit the number of simultaneous incoming connections it is
30923 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
30924 number of simultaneous incoming connections from a single remote host (see the
30925 &%smtp_accept_max_per_host%& option). Additional connection attempts are
30926 rejected using the SMTP temporary error code 421.
30927
30928 The Exim daemon does not rely on the SIGCHLD signal to detect when a
30929 subprocess has finished, as this can get lost at busy times. Instead, it looks
30930 for completed subprocesses every time it wakes up. Provided there are other
30931 things happening (new incoming calls, starts of queue runs), completed
30932 processes will be noticed and tidied away. On very quiet systems you may
30933 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
30934 it will be noticed when the daemon next wakes up.
30935
30936 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
30937 and can also be set up to reject SMTP calls from non-reserved hosts at times of
30938 high system load &-- for details see the &%smtp_accept_reserve%&,
30939 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
30940 applies in both the daemon and &'inetd'& cases.
30941
30942 Exim normally starts a delivery process for each message received, though this
30943 can be varied by means of the &%-odq%& command line option and the
30944 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
30945 number of simultaneously running delivery processes started in this way from
30946 SMTP input can be limited by the &%smtp_accept_queue%& and
30947 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
30948 subsequently received messages are just put on the input queue without starting
30949 a delivery process.
30950
30951 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
30952 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
30953 started up from the &'inetd'& daemon, because in that case each connection is
30954 handled by an entirely independent Exim process. Control by load average is,
30955 however, available with &'inetd'&.
30956
30957 Exim can be configured to verify addresses in incoming SMTP commands as they
30958 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
30959 to rewrite addresses at this time &-- before any syntax checking is done. See
30960 section &<<SECTrewriteS>>&.
30961
30962 Exim can also be configured to limit the rate at which a client host submits
30963 MAIL and RCPT commands in a single SMTP session. See the
30964 &%smtp_ratelimit_hosts%& option.
30965
30966
30967
30968 .section "Unrecognized SMTP commands" "SECID234"
30969 .cindex "SMTP" "unrecognized commands"
30970 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
30971 commands during a single SMTP connection, it drops the connection after sending
30972 the error response to the last command. The default value for
30973 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
30974 abuse that subvert web servers into making connections to SMTP ports; in these
30975 circumstances, a number of non-SMTP lines are sent first.
30976
30977
30978 .section "Syntax and protocol errors in SMTP commands" "SECID235"
30979 .cindex "SMTP" "syntax errors"
30980 .cindex "SMTP" "protocol errors"
30981 A syntax error is detected if an SMTP command is recognized, but there is
30982 something syntactically wrong with its data, for example, a malformed email
30983 address in a RCPT command. Protocol errors include invalid command
30984 sequencing such as RCPT before MAIL. If Exim receives more than
30985 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
30986 drops the connection after sending the error response to the last command. The
30987 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
30988 broken clients that loop sending bad commands (yes, it has been seen).
30989
30990
30991
30992 .section "Use of non-mail SMTP commands" "SECID236"
30993 .cindex "SMTP" "non-mail commands"
30994 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
30995 DATA. Exim counts such commands, and drops the connection if there are too
30996 many of them in a single SMTP session. This action catches some
30997 denial-of-service attempts and things like repeated failing AUTHs, or a mad
30998 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
30999 defines what &"too many"& means. Its default value is 10.
31000
31001 When a new message is expected, one occurrence of RSET is not counted. This
31002 allows a client to send one RSET between messages (this is not necessary,
31003 but some clients do it). Exim also allows one uncounted occurrence of HELO
31004 or EHLO, and one occurrence of STARTTLS between messages. After
31005 starting up a TLS session, another EHLO is expected, and so it too is not
31006 counted.
31007
31008 The first occurrence of AUTH in a connection, or immediately following
31009 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
31010 RCPT, DATA, and QUIT are counted.
31011
31012 You can control which hosts are subject to the limit set by
31013 &%smtp_accept_max_nonmail%& by setting
31014 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
31015 the limit apply to all hosts. This option means that you can exclude any
31016 specific badly-behaved hosts that you have to live with.
31017
31018
31019
31020
31021 .section "The VRFY and EXPN commands" "SECID237"
31022 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
31023 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
31024 appropriate) in order to decide whether the command should be accepted or not.
31025 If no ACL is defined, the command is rejected.
31026
31027 .cindex "VRFY" "processing"
31028 When VRFY is accepted, it runs exactly the same code as when Exim is
31029 called with the &%-bv%& option.
31030
31031 .cindex "EXPN" "processing"
31032 When EXPN is accepted, a single-level expansion of the address is done.
31033 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
31034 than a verification (the &%-bv%& option). If an unqualified local part is given
31035 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
31036 of VRFY and EXPN commands are logged on the main and reject logs, and
31037 VRFY verification failures are logged on the main log for consistency with
31038 RCPT failures.
31039
31040
31041
31042 .section "The ETRN command" "SECTETRN"
31043 .cindex "ETRN" "processing"
31044 RFC 1985 describes an SMTP command called ETRN that is designed to
31045 overcome the security problems of the TURN command (which has fallen into
31046 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
31047 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
31048 should be accepted or not. If no ACL is defined, the command is rejected.
31049
31050 The ETRN command is concerned with &"releasing"& messages that are awaiting
31051 delivery to certain hosts. As Exim does not organize its message queue by host,
31052 the only form of ETRN that is supported by default is the one where the
31053 text starts with the &"#"& prefix, in which case the remainder of the text is
31054 specific to the SMTP server. A valid ETRN command causes a run of Exim with
31055 the &%-R%& option to happen, with the remainder of the ETRN text as its
31056 argument. For example,
31057 .code
31058 ETRN #brigadoon
31059 .endd
31060 runs the command
31061 .code
31062 exim -R brigadoon
31063 .endd
31064 which causes a delivery attempt on all messages with undelivered addresses
31065 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
31066 default), Exim prevents the simultaneous execution of more than one queue run
31067 for the same argument string as a result of an ETRN command. This stops
31068 a misbehaving client from starting more than one queue runner at once.
31069
31070 .cindex "hints database" "ETRN serialization"
31071 Exim implements the serialization by means of a hints database in which a
31072 record is written whenever a process is started by ETRN, and deleted when
31073 the process completes. However, Exim does not keep the SMTP session waiting for
31074 the ETRN process to complete. Once ETRN is accepted, the client is sent
31075 a &"success"& return code. Obviously there is scope for hints records to get
31076 left lying around if there is a system or program crash. To guard against this,
31077 Exim ignores any records that are more than six hours old.
31078
31079 .oindex "&%smtp_etrn_command%&"
31080 For more control over what ETRN does, the &%smtp_etrn_command%& option can
31081 used. This specifies a command that is run whenever ETRN is received,
31082 whatever the form of its argument. For
31083 example:
31084 .code
31085 smtp_etrn_command = /etc/etrn_command $domain \
31086                     $sender_host_address
31087 .endd
31088 .vindex "&$domain$&"
31089 The string is split up into arguments which are independently expanded. The
31090 expansion variable &$domain$& is set to the argument of the ETRN command,
31091 and no syntax checking is done on the contents of this argument. Exim does not
31092 wait for the command to complete, so its status code is not checked. Exim runs
31093 under its own uid and gid when receiving incoming SMTP, so it is not possible
31094 for it to change them before running the command.
31095
31096
31097
31098 .section "Incoming local SMTP" "SECID238"
31099 .cindex "SMTP" "local incoming"
31100 Some user agents use SMTP to pass messages to their local MTA using the
31101 standard input and output, as opposed to passing the envelope on the command
31102 line and writing the message to the standard input. This is supported by the
31103 &%-bs%& option. This form of SMTP is handled in the same way as incoming
31104 messages over TCP/IP (including the use of ACLs), except that the envelope
31105 sender given in a MAIL command is ignored unless the caller is trusted. In
31106 an ACL you can detect this form of SMTP input by testing for an empty host
31107 identification. It is common to have this as the first line in the ACL that
31108 runs for RCPT commands:
31109 .code
31110 accept hosts = :
31111 .endd
31112 This accepts SMTP messages from local processes without doing any other tests.
31113
31114
31115
31116 .section "Outgoing batched SMTP" "SECTbatchSMTP"
31117 .cindex "SMTP" "batched outgoing"
31118 .cindex "batched SMTP output"
31119 Both the &(appendfile)& and &(pipe)& transports can be used for handling
31120 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
31121 be output in BSMTP format. No SMTP responses are possible for this form of
31122 delivery. All it is doing is using SMTP commands as a way of transmitting the
31123 envelope along with the message.
31124
31125 The message is written to the file or pipe preceded by the SMTP commands
31126 MAIL and RCPT, and followed by a line containing a single dot. Lines in
31127 the message that start with a dot have an extra dot added. The SMTP command
31128 HELO is not normally used. If it is required, the &%message_prefix%& option
31129 can be used to specify it.
31130
31131 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
31132 one recipient address at a time by default. However, you can arrange for them
31133 to handle several addresses at once by setting the &%batch_max%& option. When
31134 this is done for BSMTP, messages may contain multiple RCPT commands. See
31135 chapter &<<CHAPbatching>>& for more details.
31136
31137 .vindex "&$host$&"
31138 When one or more addresses are routed to a BSMTP transport by a router that
31139 sets up a host list, the name of the first host on the list is available to the
31140 transport in the variable &$host$&. Here is an example of such a transport and
31141 router:
31142 .code
31143 begin routers
31144 route_append:
31145   driver = manualroute
31146   transport = smtp_appendfile
31147   route_list = domain.example  batch.host.example
31148
31149 begin transports
31150 smtp_appendfile:
31151   driver = appendfile
31152   directory = /var/bsmtp/$host
31153   batch_max = 1000
31154   use_bsmtp
31155   user = exim
31156 .endd
31157 This causes messages addressed to &'domain.example'& to be written in BSMTP
31158 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
31159 message (unless there are more than 1000 recipients).
31160
31161
31162
31163 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
31164 .cindex "SMTP" "batched incoming"
31165 .cindex "batched SMTP input"
31166 The &%-bS%& command line option causes Exim to accept one or more messages by
31167 reading SMTP on the standard input, but to generate no responses. If the caller
31168 is trusted, the senders in the MAIL commands are believed; otherwise the
31169 sender is always the caller of Exim. Unqualified senders and receivers are not
31170 rejected (there seems little point) but instead just get qualified. HELO
31171 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
31172 as NOOP; QUIT quits.
31173
31174 .new
31175 Minimal policy checking is done for BSMTP input. Only the non-SMTP
31176 ACL is run in the same way as for non-SMTP local input.
31177 .wen
31178 If an error is detected while reading a message, including a missing &"."& at
31179 the end, Exim gives up immediately. It writes details of the error to the
31180 standard output in a stylized way that the calling program should be able to
31181 make some use of automatically, for example:
31182 .code
31183 554 Unexpected end of file
31184 Transaction started in line 10
31185 Error detected in line 14
31186 .endd
31187 It writes a more verbose version, for human consumption, to the standard error
31188 file, for example:
31189 .code
31190 An error was detected while processing a file of BSMTP input.
31191 The error message was:
31192
31193 501 '>' missing at end of address
31194
31195 The SMTP transaction started in line 10.
31196 The error was detected in line 12.
31197 The SMTP command at fault was:
31198
31199 rcpt to:<malformed@in.com.plete
31200
31201 1 previous message was successfully processed.
31202 The rest of the batch was abandoned.
31203 .endd
31204 The return code from Exim is zero only if there were no errors. It is 1 if some
31205 messages were accepted before an error was detected, and 2 if no messages were
31206 accepted.
31207 .ecindex IIDsmtpproc1
31208 .ecindex IIDsmtpproc2
31209
31210
31211
31212 . ////////////////////////////////////////////////////////////////////////////
31213 . ////////////////////////////////////////////////////////////////////////////
31214
31215 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
31216          "Customizing messages"
31217 When a message fails to be delivered, or remains on the queue for more than a
31218 configured amount of time, Exim sends a message to the original sender, or
31219 to an alternative configured address. The text of these messages is built into
31220 the code of Exim, but it is possible to change it, either by adding a single
31221 string, or by replacing each of the paragraphs by text supplied in a file.
31222
31223 The &'From:'& and &'To:'& header lines are automatically generated; you can
31224 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
31225 option. Exim also adds the line
31226 .code
31227 Auto-Submitted: auto-generated
31228 .endd
31229 to all warning and bounce messages,
31230
31231
31232 .section "Customizing bounce messages" "SECID239"
31233 .cindex "customizing" "bounce message"
31234 .cindex "bounce message" "customizing"
31235 If &%bounce_message_text%& is set, its contents are included in the default
31236 message immediately after &"This message was created automatically by mail
31237 delivery software."& The string is not expanded. It is not used if
31238 &%bounce_message_file%& is set.
31239
31240 When &%bounce_message_file%& is set, it must point to a template file for
31241 constructing error messages. The file consists of a series of text items,
31242 separated by lines consisting of exactly four asterisks. If the file cannot be
31243 opened, default text is used and a message is written to the main and panic
31244 logs. If any text item in the file is empty, default text is used for that
31245 item.
31246
31247 .vindex "&$bounce_recipient$&"
31248 .vindex "&$bounce_return_size_limit$&"
31249 Each item of text that is read from the file is expanded, and there are two
31250 expansion variables which can be of use here: &$bounce_recipient$& is set to
31251 the recipient of an error message while it is being created, and
31252 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
31253 option, rounded to a whole number.
31254
31255 The items must appear in the file in the following order:
31256
31257 .ilist
31258 The first item is included in the headers, and should include at least a
31259 &'Subject:'& header. Exim does not check the syntax of these headers.
31260 .next
31261 The second item forms the start of the error message. After it, Exim lists the
31262 failing addresses with their error messages.
31263 .next
31264 The third item is used to introduce any text from pipe transports that is to be
31265 returned to the sender. It is omitted if there is no such text.
31266 .next
31267 The fourth item is used to introduce the copy of the message that is returned
31268 as part of the error report.
31269 .next
31270 The fifth item is added after the fourth one if the returned message is
31271 truncated because it is bigger than &%return_size_limit%&.
31272 .next
31273 The sixth item is added after the copy of the original message.
31274 .endlist
31275
31276 The default state (&%bounce_message_file%& unset) is equivalent to the
31277 following file, in which the sixth item is empty. The &'Subject:'& and some
31278 other lines have been split in order to fit them on the page:
31279 .code
31280 Subject: Mail delivery failed
31281   ${if eq{$sender_address}{$bounce_recipient}
31282   {: returning message to sender}}
31283 ****
31284 This message was created automatically by mail delivery software.
31285
31286 A message ${if eq{$sender_address}{$bounce_recipient}
31287   {that you sent }{sent by
31288
31289 <$sender_address>
31290
31291 }}could not be delivered to all of its recipients.
31292 This is a permanent error. The following address(es) failed:
31293 ****
31294 The following text was generated during the delivery attempt(s):
31295 ****
31296 ------ This is a copy of the message, including all the headers.
31297   ------
31298 ****
31299 ------ The body of the message is $message_size characters long;
31300   only the first
31301 ------ $bounce_return_size_limit or so are included here.
31302 ****
31303 .endd
31304 .section "Customizing warning messages" "SECTcustwarn"
31305 .cindex "customizing" "warning message"
31306 .cindex "warning of delay" "customizing the message"
31307 The option &%warn_message_file%& can be pointed at a template file for use when
31308 warnings about message delays are created. In this case there are only three
31309 text sections:
31310
31311 .ilist
31312 The first item is included in the headers, and should include at least a
31313 &'Subject:'& header. Exim does not check the syntax of these headers.
31314 .next
31315 The second item forms the start of the warning message. After it, Exim lists
31316 the delayed addresses.
31317 .next
31318 The third item then ends the message.
31319 .endlist
31320
31321 The default state is equivalent to the following file, except that some lines
31322 have been split here, in order to fit them on the page:
31323 .code
31324 Subject: Warning: message $message_exim_id delayed
31325   $warn_message_delay
31326 ****
31327 This message was created automatically by mail delivery software.
31328
31329 A message ${if eq{$sender_address}{$warn_message_recipients}
31330 {that you sent }{sent by
31331
31332 <$sender_address>
31333
31334 }}has not been delivered to all of its recipients after
31335 more than $warn_message_delay on the queue on $primary_hostname.
31336
31337 The message identifier is:     $message_exim_id
31338 The subject of the message is: $h_subject
31339 The date of the message is:    $h_date
31340
31341 The following address(es) have not yet been delivered:
31342 ****
31343 No action is required on your part. Delivery attempts will
31344 continue for some time, and this warning may be repeated at
31345 intervals if the message remains undelivered. Eventually the
31346 mail delivery software will give up, and when that happens,
31347 the message will be returned to you.
31348 .endd
31349 .vindex "&$warn_message_delay$&"
31350 .vindex "&$warn_message_recipients$&"
31351 However, in the default state the subject and date lines are omitted if no
31352 appropriate headers exist. During the expansion of this file,
31353 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
31354 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
31355 of recipients for the warning message. There may be more than one if there are
31356 multiple addresses with different &%errors_to%& settings on the routers that
31357 handled them.
31358
31359
31360
31361
31362 . ////////////////////////////////////////////////////////////////////////////
31363 . ////////////////////////////////////////////////////////////////////////////
31364
31365 .chapter "Some common configuration settings" "CHAPcomconreq"
31366 This chapter discusses some configuration settings that seem to be fairly
31367 common. More examples and discussion can be found in the Exim book.
31368
31369
31370
31371 .section "Sending mail to a smart host" "SECID240"
31372 .cindex "smart host" "example router"
31373 If you want to send all mail for non-local domains to a &"smart host"&, you
31374 should replace the default &(dnslookup)& router with a router which does the
31375 routing explicitly:
31376 .code
31377 send_to_smart_host:
31378   driver = manualroute
31379   route_list = !+local_domains smart.host.name
31380   transport = remote_smtp
31381 .endd
31382 You can use the smart host's IP address instead of the name if you wish.
31383 If you are using Exim only to submit messages to a smart host, and not for
31384 receiving incoming messages, you can arrange for it to do the submission
31385 synchronously by setting the &%mua_wrapper%& option (see chapter
31386 &<<CHAPnonqueueing>>&).
31387
31388
31389
31390
31391 .section "Using Exim to handle mailing lists" "SECTmailinglists"
31392 .cindex "mailing lists"
31393 Exim can be used to run simple mailing lists, but for large and/or complicated
31394 requirements, the use of additional specialized mailing list software such as
31395 Majordomo or Mailman is recommended.
31396
31397 The &(redirect)& router can be used to handle mailing lists where each list
31398 is maintained in a separate file, which can therefore be managed by an
31399 independent manager. The &%domains%& router option can be used to run these
31400 lists in a separate domain from normal mail. For example:
31401 .code
31402 lists:
31403   driver = redirect
31404   domains = lists.example
31405   file = /usr/lists/$local_part
31406   forbid_pipe
31407   forbid_file
31408   errors_to = $local_part-request@lists.example
31409   no_more
31410 .endd
31411 This router is skipped for domains other than &'lists.example'&. For addresses
31412 in that domain, it looks for a file that matches the local part. If there is no
31413 such file, the router declines, but because &%no_more%& is set, no subsequent
31414 routers are tried, and so the whole delivery fails.
31415
31416 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
31417 expanded into a file name or a pipe delivery, which is usually inappropriate in
31418 a mailing list.
31419
31420 .oindex "&%errors_to%&"
31421 The &%errors_to%& option specifies that any delivery errors caused by addresses
31422 taken from a mailing list are to be sent to the given address rather than the
31423 original sender of the message. However, before acting on this, Exim verifies
31424 the error address, and ignores it if verification fails.
31425
31426 For example, using the configuration above, mail sent to
31427 &'dicts@lists.example'& is passed on to those addresses contained in
31428 &_/usr/lists/dicts_&, with error reports directed to
31429 &'dicts-request@lists.example'&, provided that this address can be verified.
31430 There could be a file called &_/usr/lists/dicts-request_& containing
31431 the address(es) of this particular list's manager(s), but other approaches,
31432 such as setting up an earlier router (possibly using the &%local_part_prefix%&
31433 or &%local_part_suffix%& options) to handle addresses of the form
31434 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
31435
31436
31437
31438 .section "Syntax errors in mailing lists" "SECID241"
31439 .cindex "mailing lists" "syntax errors in"
31440 If an entry in redirection data contains a syntax error, Exim normally defers
31441 delivery of the original address. That means that a syntax error in a mailing
31442 list holds up all deliveries to the list. This may not be appropriate when a
31443 list is being maintained automatically from data supplied by users, and the
31444 addresses are not rigorously checked.
31445
31446 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
31447 entries that fail to parse, noting the incident in the log. If in addition
31448 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
31449 whenever a broken address is skipped. It is usually appropriate to set
31450 &%syntax_errors_to%& to the same address as &%errors_to%&.
31451
31452
31453
31454 .section "Re-expansion of mailing lists" "SECID242"
31455 .cindex "mailing lists" "re-expansion of"
31456 Exim remembers every individual address to which a message has been delivered,
31457 in order to avoid duplication, but it normally stores only the original
31458 recipient addresses with a message. If all the deliveries to a mailing list
31459 cannot be done at the first attempt, the mailing list is re-expanded when the
31460 delivery is next tried. This means that alterations to the list are taken into
31461 account at each delivery attempt, so addresses that have been added to
31462 the list since the message arrived will therefore receive a copy of the
31463 message, even though it pre-dates their subscription.
31464
31465 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
31466 on the &(redirect)& router. If this is done, any addresses generated by the
31467 router that fail to deliver at the first attempt are added to the message as
31468 &"top level"& addresses, and the parent address that generated them is marked
31469 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
31470 subsequent delivery attempts. The disadvantage of this is that if any of the
31471 failing addresses are incorrect, correcting them in the file has no effect on
31472 pre-existing messages.
31473
31474 The original top-level address is remembered with each of the generated
31475 addresses, and is output in any log messages. However, any intermediate parent
31476 addresses are not recorded. This makes a difference to the log only if the
31477 &%all_parents%& selector is set, but for mailing lists there is normally only
31478 one level of expansion anyway.
31479
31480
31481
31482 .section "Closed mailing lists" "SECID243"
31483 .cindex "mailing lists" "closed"
31484 The examples so far have assumed open mailing lists, to which anybody may
31485 send mail. It is also possible to set up closed lists, where mail is accepted
31486 from specified senders only. This is done by making use of the generic
31487 &%senders%& option to restrict the router that handles the list.
31488
31489 The following example uses the same file as a list of recipients and as a list
31490 of permitted senders. It requires three routers:
31491 .code
31492 lists_request:
31493   driver = redirect
31494   domains = lists.example
31495   local_part_suffix = -request
31496   file = /usr/lists/$local_part$local_part_suffix
31497   no_more
31498
31499 lists_post:
31500   driver = redirect
31501   domains = lists.example
31502   senders = ${if exists {/usr/lists/$local_part}\
31503              {lsearch;/usr/lists/$local_part}{*}}
31504   file = /usr/lists/$local_part
31505   forbid_pipe
31506   forbid_file
31507   errors_to = $local_part-request@lists.example
31508   no_more
31509
31510 lists_closed:
31511   driver = redirect
31512   domains = lists.example
31513   allow_fail
31514   data = :fail: $local_part@lists.example is a closed mailing list
31515 .endd
31516 All three routers have the same &%domains%& setting, so for any other domains,
31517 they are all skipped. The first router runs only if the local part ends in
31518 &%-request%&. It handles messages to the list manager(s) by means of an open
31519 mailing list.
31520
31521 The second router runs only if the &%senders%& precondition is satisfied. It
31522 checks for the existence of a list that corresponds to the local part, and then
31523 checks that the sender is on the list by means of a linear search. It is
31524 necessary to check for the existence of the file before trying to search it,
31525 because otherwise Exim thinks there is a configuration error. If the file does
31526 not exist, the expansion of &%senders%& is *, which matches all senders. This
31527 means that the router runs, but because there is no list, declines, and
31528 &%no_more%& ensures that no further routers are run. The address fails with an
31529 &"unrouteable address"& error.
31530
31531 The third router runs only if the second router is skipped, which happens when
31532 a mailing list exists, but the sender is not on it. This router forcibly fails
31533 the address, giving a suitable error message.
31534
31535
31536
31537
31538 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
31539 .cindex "VERP"
31540 .cindex "Variable Envelope Return Paths"
31541 .cindex "envelope sender"
31542 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
31543 are a way of helping mailing list administrators discover which subscription
31544 address is the cause of a particular delivery failure. The idea is to encode
31545 the original recipient address in the outgoing envelope sender address, so that
31546 if the message is forwarded by another host and then subsequently bounces, the
31547 original recipient can be extracted from the recipient address of the bounce.
31548
31549 .oindex &%errors_to%&
31550 .oindex &%return_path%&
31551 Envelope sender addresses can be modified by Exim using two different
31552 facilities: the &%errors_to%& option on a router (as shown in previous mailing
31553 list examples), or the &%return_path%& option on a transport. The second of
31554 these is effective only if the message is successfully delivered to another
31555 host; it is not used for errors detected on the local host (see the description
31556 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
31557 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
31558 .code
31559 verp_smtp:
31560   driver = smtp
31561   max_rcpt = 1
31562   return_path = \
31563     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
31564       {$1-request+$local_part=$domain@your.dom.example}fail}
31565 .endd
31566 This has the effect of rewriting the return path (envelope sender) on outgoing
31567 SMTP messages, if the local part of the original return path ends in
31568 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
31569 local part and domain of the recipient into the return path. Suppose, for
31570 example, that a message whose return path has been set to
31571 &'somelist-request@your.dom.example'& is sent to
31572 &'subscriber@other.dom.example'&. In the transport, the return path is
31573 rewritten as
31574 .code
31575 somelist-request+subscriber=other.dom.example@your.dom.example
31576 .endd
31577 .vindex "&$local_part$&"
31578 For this to work, you must tell Exim to send multiple copies of messages that
31579 have more than one recipient, so that each copy has just one recipient. This is
31580 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
31581 might be sent to several different recipients in the same domain, in which case
31582 &$local_part$& is not available in the transport, because it is not unique.
31583
31584 Unless your host is doing nothing but mailing list deliveries, you should
31585 probably use a separate transport for the VERP deliveries, so as not to use
31586 extra resources in making one-per-recipient copies for other deliveries. This
31587 can easily be done by expanding the &%transport%& option in the router:
31588 .code
31589 dnslookup:
31590   driver = dnslookup
31591   domains = ! +local_domains
31592   transport = \
31593     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
31594       {verp_smtp}{remote_smtp}}
31595   no_more
31596 .endd
31597 If you want to change the return path using &%errors_to%& in a router instead
31598 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
31599 routers that handle mailing list addresses. This will ensure that all delivery
31600 errors, including those detected on the local host, are sent to the VERP
31601 address.
31602
31603 On a host that does no local deliveries and has no manual routing, only the
31604 &(dnslookup)& router needs to be changed. A special transport is not needed for
31605 SMTP deliveries. Every mailing list recipient has its own return path value,
31606 and so Exim must hand them to the transport one at a time. Here is an example
31607 of a &(dnslookup)& router that implements VERP:
31608 .code
31609 verp_dnslookup:
31610   driver = dnslookup
31611   domains = ! +local_domains
31612   transport = remote_smtp
31613   errors_to = \
31614     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
31615      {$1-request+$local_part=$domain@your.dom.example}fail}
31616   no_more
31617 .endd
31618 Before you start sending out messages with VERPed return paths, you must also
31619 configure Exim to accept the bounce messages that come back to those paths.
31620 Typically this is done by setting a &%local_part_suffix%& option for a
31621 router, and using this to route the messages to wherever you want to handle
31622 them.
31623
31624 The overhead incurred in using VERP depends very much on the size of the
31625 message, the number of recipient addresses that resolve to the same remote
31626 host, and the speed of the connection over which the message is being sent. If
31627 a lot of addresses resolve to the same host and the connection is slow, sending
31628 a separate copy of the message for each address may take substantially longer
31629 than sending a single copy with many recipients (for which VERP cannot be
31630 used).
31631
31632
31633
31634
31635
31636
31637 .section "Virtual domains" "SECTvirtualdomains"
31638 .cindex "virtual domains"
31639 .cindex "domain" "virtual"
31640 The phrase &'virtual domain'& is unfortunately used with two rather different
31641 meanings:
31642
31643 .ilist
31644 A domain for which there are no real mailboxes; all valid local parts are
31645 aliases for other email addresses. Common examples are organizational
31646 top-level domains and &"vanity"& domains.
31647 .next
31648 One of a number of independent domains that are all handled by the same host,
31649 with mailboxes on that host, but where the mailbox owners do not necessarily
31650 have login accounts on that host.
31651 .endlist
31652
31653 The first usage is probably more common, and does seem more &"virtual"& than
31654 the second. This kind of domain can be handled in Exim with a straightforward
31655 aliasing router. One approach is to create a separate alias file for each
31656 virtual domain. Exim can test for the existence of the alias file to determine
31657 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
31658 to a router of this form:
31659 .code
31660 virtual:
31661   driver = redirect
31662   domains = dsearch;/etc/mail/virtual
31663   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
31664   no_more
31665 .endd
31666 The &%domains%& option specifies that the router is to be skipped, unless there
31667 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
31668 domain that is being processed. When the router runs, it looks up the local
31669 part in the file to find a new address (or list of addresses). The &%no_more%&
31670 setting ensures that if the lookup fails (leading to &%data%& being an empty
31671 string), Exim gives up on the address without trying any subsequent routers.
31672
31673 This one router can handle all the virtual domains because the alias file names
31674 follow a fixed pattern. Permissions can be arranged so that appropriate people
31675 can edit the different alias files. A successful aliasing operation results in
31676 a new envelope recipient address, which is then routed from scratch.
31677
31678 The other kind of &"virtual"& domain can also be handled in a straightforward
31679 way. One approach is to create a file for each domain containing a list of
31680 valid local parts, and use it in a router like this:
31681 .code
31682 my_domains:
31683   driver = accept
31684   domains = dsearch;/etc/mail/domains
31685   local_parts = lsearch;/etc/mail/domains/$domain
31686   transport = my_mailboxes
31687 .endd
31688 The address is accepted if there is a file for the domain, and the local part
31689 can be found in the file. The &%domains%& option is used to check for the
31690 file's existence because &%domains%& is tested before the &%local_parts%&
31691 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
31692 because that option is tested after &%local_parts%&. The transport is as
31693 follows:
31694 .code
31695 my_mailboxes:
31696   driver = appendfile
31697   file = /var/mail/$domain/$local_part
31698   user = mail
31699 .endd
31700 This uses a directory of mailboxes for each domain. The &%user%& setting is
31701 required, to specify which uid is to be used for writing to the mailboxes.
31702
31703 The configuration shown here is just one example of how you might support this
31704 requirement. There are many other ways this kind of configuration can be set
31705 up, for example, by using a database instead of separate files to hold all the
31706 information about the domains.
31707
31708
31709
31710 .section "Multiple user mailboxes" "SECTmulbox"
31711 .cindex "multiple mailboxes"
31712 .cindex "mailbox" "multiple"
31713 .cindex "local part" "prefix"
31714 .cindex "local part" "suffix"
31715 Heavy email users often want to operate with multiple mailboxes, into which
31716 incoming mail is automatically sorted. A popular way of handling this is to
31717 allow users to use multiple sender addresses, so that replies can easily be
31718 identified. Users are permitted to add prefixes or suffixes to their local
31719 parts for this purpose. The wildcard facility of the generic router options
31720 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
31721 example, consider this router:
31722 .code
31723 userforward:
31724   driver = redirect
31725   check_local_user
31726   file = $home/.forward
31727   local_part_suffix = -*
31728   local_part_suffix_optional
31729   allow_filter
31730 .endd
31731 .vindex "&$local_part_suffix$&"
31732 It runs a user's &_.forward_& file for all local parts of the form
31733 &'username-*'&. Within the filter file the user can distinguish different
31734 cases by testing the variable &$local_part_suffix$&. For example:
31735 .code
31736 if $local_part_suffix contains -special then
31737 save /home/$local_part/Mail/special
31738 endif
31739 .endd
31740 If the filter file does not exist, or does not deal with such addresses, they
31741 fall through to subsequent routers, and, assuming no subsequent use of the
31742 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
31743 control over which suffixes are valid.
31744
31745 Alternatively, a suffix can be used to trigger the use of a different
31746 &_.forward_& file &-- which is the way a similar facility is implemented in
31747 another MTA:
31748 .code
31749 userforward:
31750   driver = redirect
31751   check_local_user
31752   file = $home/.forward$local_part_suffix
31753   local_part_suffix = -*
31754   local_part_suffix_optional
31755   allow_filter
31756 .endd
31757 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
31758 example, &_.forward-special_& is used. Once again, if the appropriate file
31759 does not exist, or does not deal with the address, it is passed on to
31760 subsequent routers, which could, if required, look for an unqualified
31761 &_.forward_& file to use as a default.
31762
31763
31764
31765 .section "Simplified vacation processing" "SECID244"
31766 .cindex "vacation processing"
31767 The traditional way of running the &'vacation'& program is for a user to set up
31768 a pipe command in a &_.forward_& file
31769 (see section &<<SECTspecitredli>>& for syntax details).
31770 This is prone to error by inexperienced users. There are two features of Exim
31771 that can be used to make this process simpler for users:
31772
31773 .ilist
31774 A local part prefix such as &"vacation-"& can be specified on a router which
31775 can cause the message to be delivered directly to the &'vacation'& program, or
31776 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
31777 &_.forward_& file are then much simpler. For example:
31778 .code
31779 spqr, vacation-spqr
31780 .endd
31781 .next
31782 The &%require_files%& generic router option can be used to trigger a
31783 vacation delivery by checking for the existence of a certain file in the
31784 user's home directory. The &%unseen%& generic option should also be used, to
31785 ensure that the original delivery also proceeds. In this case, all the user has
31786 to do is to create a file called, say, &_.vacation_&, containing a vacation
31787 message.
31788 .endlist
31789
31790 Another advantage of both these methods is that they both work even when the
31791 use of arbitrary pipes by users is locked out.
31792
31793
31794
31795 .section "Taking copies of mail" "SECID245"
31796 .cindex "message" "copying every"
31797 Some installations have policies that require archive copies of all messages to
31798 be made. A single copy of each message can easily be taken by an appropriate
31799 command in a system filter, which could, for example, use a different file for
31800 each day's messages.
31801
31802 There is also a shadow transport mechanism that can be used to take copies of
31803 messages that are successfully delivered by local transports, one copy per
31804 delivery. This could be used, &'inter alia'&, to implement automatic
31805 notification of delivery by sites that insist on doing such things.
31806
31807
31808
31809 .section "Intermittently connected hosts" "SECID246"
31810 .cindex "intermittently connected hosts"
31811 It has become quite common (because it is cheaper) for hosts to connect to the
31812 Internet periodically rather than remain connected all the time. The normal
31813 arrangement is that mail for such hosts accumulates on a system that is
31814 permanently connected.
31815
31816 Exim was designed for use on permanently connected hosts, and so it is not
31817 particularly well-suited to use in an intermittently connected environment.
31818 Nevertheless there are some features that can be used.
31819
31820
31821 .section "Exim on the upstream server host" "SECID247"
31822 It is tempting to arrange for incoming mail for the intermittently connected
31823 host to remain on Exim's queue until the client connects. However, this
31824 approach does not scale very well. Two different kinds of waiting message are
31825 being mixed up in the same queue &-- those that cannot be delivered because of
31826 some temporary problem, and those that are waiting for their destination host
31827 to connect. This makes it hard to manage the queue, as well as wasting
31828 resources, because each queue runner scans the entire queue.
31829
31830 A better approach is to separate off those messages that are waiting for an
31831 intermittently connected host. This can be done by delivering these messages
31832 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
31833 format, from where they are transmitted by other software when their
31834 destination connects. This makes it easy to collect all the mail for one host
31835 in a single directory, and to apply local timeout rules on a per-message basis
31836 if required.
31837
31838 On a very small scale, leaving the mail on Exim's queue can be made to work. If
31839 you are doing this, you should configure Exim with a long retry period for the
31840 intermittent host. For example:
31841 .code
31842 cheshire.wonderland.fict.example    *   F,5d,24h
31843 .endd
31844 This stops a lot of failed delivery attempts from occurring, but Exim remembers
31845 which messages it has queued up for that host. Once the intermittent host comes
31846 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
31847 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
31848 causes all the queued up messages to be delivered, often down a single SMTP
31849 connection. While the host remains connected, any new messages get delivered
31850 immediately.
31851
31852 If the connecting hosts do not have fixed IP addresses, that is, if a host is
31853 issued with a different IP address each time it connects, Exim's retry
31854 mechanisms on the holding host get confused, because the IP address is normally
31855 used as part of the key string for holding retry information. This can be
31856 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
31857 Since this has disadvantages for permanently connected hosts, it is best to
31858 arrange a separate transport for the intermittently connected ones.
31859
31860
31861
31862 .section "Exim on the intermittently connected client host" "SECID248"
31863 The value of &%smtp_accept_queue_per_connection%& should probably be
31864 increased, or even set to zero (that is, disabled) on the intermittently
31865 connected host, so that all incoming messages down a single connection get
31866 delivered immediately.
31867
31868 .cindex "SMTP" "passed connection"
31869 .cindex "SMTP" "multiple deliveries"
31870 .cindex "multiple SMTP deliveries"
31871 Mail waiting to be sent from an intermittently connected host will probably
31872 not have been routed, because without a connection DNS lookups are not
31873 possible. This means that if a normal queue run is done at connection time,
31874 each message is likely to be sent in a separate SMTP session. This can be
31875 avoided by starting the queue run with a command line option beginning with
31876 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
31877 first pass, routing is done but no deliveries take place. The second pass is a
31878 normal queue run; since all the messages have been previously routed, those
31879 destined for the same host are likely to get sent as multiple deliveries in a
31880 single SMTP connection.
31881
31882
31883
31884 . ////////////////////////////////////////////////////////////////////////////
31885 . ////////////////////////////////////////////////////////////////////////////
31886
31887 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
31888          "Exim as a non-queueing client"
31889 .cindex "client, non-queueing"
31890 .cindex "smart host" "suppressing queueing"
31891 On a personal computer, it is a common requirement for all
31892 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
31893 configured to operate that way, for all the popular operating systems.
31894 However, there are some MUAs for Unix-like systems that cannot be so
31895 configured: they submit messages using the command line interface of
31896 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
31897 messages this way.
31898
31899 If the personal computer runs continuously, there is no problem, because it can
31900 run a conventional MTA that handles delivery to the smart host, and deal with
31901 any delays via its queueing mechanism. However, if the computer does not run
31902 continuously or runs different operating systems at different times, queueing
31903 email is not desirable.
31904
31905 There is therefore a requirement for something that can provide the
31906 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
31907 any queueing or retrying facilities. Furthermore, the delivery to the smart
31908 host should be synchronous, so that if it fails, the sending MUA is immediately
31909 informed. In other words, we want something that extends an MUA that submits
31910 to a local MTA via the command line so that it behaves like one that submits
31911 to a remote smart host using TCP/SMTP.
31912
31913 There are a number of applications (for example, there is one called &'ssmtp'&)
31914 that do this job. However, people have found them to be lacking in various
31915 ways. For instance, you might want to allow aliasing and forwarding to be done
31916 before sending a message to the smart host.
31917
31918 Exim already had the necessary infrastructure for doing this job. Just a few
31919 tweaks were needed to make it behave as required, though it is somewhat of an
31920 overkill to use a fully-featured MTA for this purpose.
31921
31922 .oindex "&%mua_wrapper%&"
31923 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
31924 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
31925 assumes that it is being used to &"wrap"& a command-line MUA in the manner
31926 just described. As well as setting &%mua_wrapper%&, you also need to provide a
31927 compatible router and transport configuration. Typically there will be just one
31928 router and one transport, sending everything to a smart host.
31929
31930 When run in MUA wrapping mode, the behaviour of Exim changes in the
31931 following ways:
31932
31933 .ilist
31934 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
31935 In other words, the only way to submit messages is via the command line.
31936 .next
31937 Each message is synchronously delivered as soon as it is received (&%-odi%& is
31938 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
31939 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
31940 does not finish until the delivery attempt is complete. If the delivery is
31941 successful, a zero return code is given.
31942 .next
31943 Address redirection is permitted, but the final routing for all addresses must
31944 be to the same remote transport, and to the same list of hosts. Furthermore,
31945 the return address (envelope sender) must be the same for all recipients, as
31946 must any added or deleted header lines. In other words, it must be possible to
31947 deliver the message in a single SMTP transaction, however many recipients there
31948 are.
31949 .next
31950 If these conditions are not met, or if routing any address results in a
31951 failure or defer status, or if Exim is unable to deliver all the recipients
31952 successfully to one of the smart hosts, delivery of the entire message fails.
31953 .next
31954 Because no queueing is allowed, all failures are treated as permanent; there
31955 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
31956 smart host. Furthermore, because only a single yes/no response can be given to
31957 the caller, it is not possible to deliver to some recipients and not others. If
31958 there is an error (temporary or permanent) for any recipient, all are failed.
31959 .next
31960 If more than one smart host is listed, Exim will try another host after a
31961 connection failure or a timeout, in the normal way. However, if this kind of
31962 failure happens for all the hosts, the delivery fails.
31963 .next
31964 When delivery fails, an error message is written to the standard error stream
31965 (as well as to Exim's log), and Exim exits to the caller with a return code
31966 value 1. The message is expunged from Exim's spool files. No bounce messages
31967 are ever generated.
31968 .next
31969 No retry data is maintained, and any retry rules are ignored.
31970 .next
31971 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
31972 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
31973 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
31974 .endlist
31975
31976 The overall effect is that Exim makes a single synchronous attempt to deliver
31977 the message, failing if there is any kind of problem. Because no local
31978 deliveries are done and no daemon can be run, Exim does not need root
31979 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
31980 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
31981 the advantages and disadvantages of running without root privilege.
31982
31983
31984
31985
31986 . ////////////////////////////////////////////////////////////////////////////
31987 . ////////////////////////////////////////////////////////////////////////////
31988
31989 .chapter "Log files" "CHAPlog"
31990 .scindex IIDloggen "log" "general description"
31991 .cindex "log" "types of"
31992 Exim writes three different logs, referred to as the main log, the reject log,
31993 and the panic log:
31994
31995 .ilist
31996 .cindex "main log"
31997 The main log records the arrival of each message and each delivery in a single
31998 line in each case. The format is as compact as possible, in an attempt to keep
31999 down the size of log files. Two-character flag sequences make it easy to pick
32000 out these lines. A number of other events are recorded in the main log. Some of
32001 them are optional, in which case the &%log_selector%& option controls whether
32002 they are included or not. A Perl script called &'eximstats'&, which does simple
32003 analysis of main log files, is provided in the Exim distribution (see section
32004 &<<SECTmailstat>>&).
32005 .next
32006 .cindex "reject log"
32007 The reject log records information from messages that are rejected as a result
32008 of a configuration option (that is, for policy reasons).
32009 The first line of each rejection is a copy of the line that is also written to
32010 the main log. Then, if the message's header has been read at the time the log
32011 is written, its contents are written to this log. Only the original header
32012 lines are available; header lines added by ACLs are not logged. You can use the
32013 reject log to check that your policy controls are working correctly; on a busy
32014 host this may be easier than scanning the main log for rejection messages. You
32015 can suppress the writing of the reject log by setting &%write_rejectlog%&
32016 false.
32017 .next
32018 .cindex "panic log"
32019 .cindex "system log"
32020 When certain serious errors occur, Exim writes entries to its panic log. If the
32021 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
32022 are usually written to the main log as well, but can get lost amid the mass of
32023 other entries. The panic log should be empty under normal circumstances. It is
32024 therefore a good idea to check it (or to have a &'cron'& script check it)
32025 regularly, in order to become aware of any problems. When Exim cannot open its
32026 panic log, it tries as a last resort to write to the system log (syslog). This
32027 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
32028 message itself is written at priority LOG_CRIT.
32029 .endlist
32030
32031 Every log line starts with a timestamp, in the format shown in the following
32032 example. Note that many of the examples shown in this chapter are line-wrapped.
32033 In the log file, this would be all on one line:
32034 .code
32035 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
32036   by QUIT
32037 .endd
32038 By default, the timestamps are in the local timezone. There are two
32039 ways of changing this:
32040
32041 .ilist
32042 You can set the &%timezone%& option to a different time zone; in particular, if
32043 you set
32044 .code
32045 timezone = UTC
32046 .endd
32047 the timestamps will be in UTC (aka GMT).
32048 .next
32049 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
32050 example:
32051 .code
32052 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
32053 .endd
32054 .endlist
32055
32056 .cindex "log" "process ids in"
32057 .cindex "pid (process id)" "in log lines"
32058 Exim does not include its process id in log lines by default, but you can
32059 request that it does so by specifying the &`pid`& log selector (see section
32060 &<<SECTlogselector>>&). When this is set, the process id is output, in square
32061 brackets, immediately after the time and date.
32062
32063
32064
32065
32066 .section "Where the logs are written" "SECTwhelogwri"
32067 .cindex "log" "destination"
32068 .cindex "log" "to file"
32069 .cindex "log" "to syslog"
32070 .cindex "syslog"
32071 The logs may be written to local files, or to syslog, or both. However, it
32072 should be noted that many syslog implementations use UDP as a transport, and
32073 are therefore unreliable in the sense that messages are not guaranteed to
32074 arrive at the loghost, nor is the ordering of messages necessarily maintained.
32075 It has also been reported that on large log files (tens of megabytes) you may
32076 need to tweak syslog to prevent it syncing the file with each write &-- on
32077 Linux this has been seen to make syslog take 90% plus of CPU time.
32078
32079 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
32080 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
32081 configuration. This latter string is expanded, so it can contain, for example,
32082 references to the host name:
32083 .code
32084 log_file_path = /var/log/$primary_hostname/exim_%slog
32085 .endd
32086 It is generally advisable, however, to set the string in &_Local/Makefile_&
32087 rather than at run time, because then the setting is available right from the
32088 start of Exim's execution. Otherwise, if there's something it wants to log
32089 before it has read the configuration file (for example, an error in the
32090 configuration file) it will not use the path you want, and may not be able to
32091 log at all.
32092
32093 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
32094 list, currently limited to at most two items. This is one option where the
32095 facility for changing a list separator may not be used. The list must always be
32096 colon-separated. If an item in the list is &"syslog"& then syslog is used;
32097 otherwise the item must either be an absolute path, containing &`%s`& at the
32098 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
32099 implying the use of a default path.
32100
32101 When Exim encounters an empty item in the list, it searches the list defined by
32102 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
32103 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
32104 mean &"use the path specified at build time"&. It no such item exists, log
32105 files are written in the &_log_& subdirectory of the spool directory. This is
32106 equivalent to the setting:
32107 .code
32108 log_file_path = $spool_directory/log/%slog
32109 .endd
32110 If you do not specify anything at build time or run time, that is where the
32111 logs are written.
32112
32113 A log file path may also contain &`%D`& if datestamped log file names are in
32114 use &-- see section &<<SECTdatlogfil>>& below.
32115
32116 Here are some examples of possible settings:
32117 .display
32118 &`LOG_FILE_PATH=syslog                    `& syslog only
32119 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
32120 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
32121 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
32122 .endd
32123 If there are more than two paths in the list, the first is used and a panic
32124 error is logged.
32125
32126
32127
32128 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
32129 .cindex "log" "cycling local files"
32130 .cindex "cycling logs"
32131 .cindex "&'exicyclog'&"
32132 .cindex "log" "local files; writing to"
32133 Some operating systems provide centralized and standardized methods for cycling
32134 log files. For those that do not, a utility script called &'exicyclog'& is
32135 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
32136 main and reject logs each time it is called. The maximum number of old logs to
32137 keep can be set. It is suggested this script is run as a daily &'cron'& job.
32138
32139 An Exim delivery process opens the main log when it first needs to write to it,
32140 and it keeps the file open in case subsequent entries are required &-- for
32141 example, if a number of different deliveries are being done for the same
32142 message. However, remote SMTP deliveries can take a long time, and this means
32143 that the file may be kept open long after it is renamed if &'exicyclog'& or
32144 something similar is being used to rename log files on a regular basis. To
32145 ensure that a switch of log files is noticed as soon as possible, Exim calls
32146 &[stat()]& on the main log's name before reusing an open file, and if the file
32147 does not exist, or its inode has changed, the old file is closed and Exim
32148 tries to open the main log from scratch. Thus, an old log file may remain open
32149 for quite some time, but no Exim processes should write to it once it has been
32150 renamed.
32151
32152
32153
32154 .section "Datestamped log files" "SECTdatlogfil"
32155 .cindex "log" "datestamped files"
32156 Instead of cycling the main and reject log files by renaming them
32157 periodically, some sites like to use files whose names contain a datestamp,
32158 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_&.
32159 Exim has support for this way of working. It is enabled by setting the
32160 &%log_file_path%& option to a path that includes &`%D`& at the point where the
32161 datestamp is required. For example:
32162 .code
32163 log_file_path = /var/spool/exim/log/%slog-%D
32164 log_file_path = /var/log/exim-%s-%D.log
32165 log_file_path = /var/spool/exim/log/%D-%slog
32166 .endd
32167 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
32168 examples of names generated by the above examples:
32169 .code
32170 /var/spool/exim/log/mainlog-20021225
32171 /var/log/exim-reject-20021225.log
32172 /var/spool/exim/log/20021225-mainlog
32173 .endd
32174 When this form of log file is specified, Exim automatically switches to new
32175 files at midnight. It does not make any attempt to compress old logs; you
32176 will need to write your own script if you require this. You should not
32177 run &'exicyclog'& with this form of logging.
32178
32179 The location of the panic log is also determined by &%log_file_path%&, but it
32180 is not datestamped, because rotation of the panic log does not make sense.
32181 When generating the name of the panic log, &`%D`& is removed from the string.
32182 In addition, if it immediately follows a slash, a following non-alphanumeric
32183 character is removed; otherwise a preceding non-alphanumeric character is
32184 removed. Thus, the three examples above would give these panic log names:
32185 .code
32186 /var/spool/exim/log/paniclog
32187 /var/log/exim-panic.log
32188 /var/spool/exim/log/paniclog
32189 .endd
32190
32191
32192 .section "Logging to syslog" "SECID249"
32193 .cindex "log" "syslog; writing to"
32194 The use of syslog does not change what Exim logs or the format of its messages,
32195 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
32196 Exim's log lines are omitted when these lines are sent to syslog. Apart from
32197 that, the same strings are written to syslog as to log files. The syslog
32198 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
32199 by default, but you can change these by setting the &%syslog_facility%& and
32200 &%syslog_processname%& options, respectively. If Exim was compiled with
32201 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
32202 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
32203 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
32204 the time and host name to each line.
32205 The three log streams are mapped onto syslog priorities as follows:
32206
32207 .ilist
32208 &'mainlog'& is mapped to LOG_INFO
32209 .next
32210 &'rejectlog'& is mapped to LOG_NOTICE
32211 .next
32212 &'paniclog'& is mapped to LOG_ALERT
32213 .endlist
32214
32215 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
32216 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
32217 these are routed by syslog to the same place. You can suppress this duplication
32218 by setting &%syslog_duplication%& false.
32219
32220 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
32221 entries contain multiple lines when headers are included. To cope with both
32222 these cases, entries written to syslog are split into separate &[syslog()]&
32223 calls at each internal newline, and also after a maximum of
32224 870 data characters. (This allows for a total syslog line length of 1024, when
32225 additions such as timestamps are added.) If you are running a syslog
32226 replacement that can handle lines longer than the 1024 characters allowed by
32227 RFC 3164, you should set
32228 .code
32229 SYSLOG_LONG_LINES=yes
32230 .endd
32231 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
32232 lines, but it still splits at internal newlines in &'reject'& log entries.
32233
32234 To make it easy to re-assemble split lines later, each component of a split
32235 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
32236 where <&'n'&> is the component number and <&'m'&> is the total number of
32237 components in the entry. The / delimiter is used when the line was split
32238 because it was too long; if it was split because of an internal newline, the \
32239 delimiter is used. For example, supposing the length limit to be 50 instead of
32240 870, the following would be the result of a typical rejection message to
32241 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
32242 name, and pid as added by syslog:
32243 .code
32244 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
32245 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
32246 [3/5]  when scanning for sender: missing or malformed lo
32247 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
32248 [5/5] mple>)
32249 .endd
32250 The same error might cause the following lines to be written to &"rejectlog"&
32251 (LOG_NOTICE):
32252 .code
32253 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
32254 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
32255 [3/18] er when scanning for sender: missing or malformed
32256 [4/18]  local part in "<>" (envelope sender is <ph10@cam
32257 [5\18] .example>)
32258 [6\18] Recipients: ph10@some.domain.cam.example
32259 [7\18] P Received: from [127.0.0.1] (ident=ph10)
32260 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
32261 [9\18]        id 16RdAL-0006pc-00
32262 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
32263 [11\18] 09:43 +0100
32264 [12\18] F From: <>
32265 [13\18]   Subject: this is a test header
32266 [18\18]   X-something: this is another header
32267 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
32268 [16\18] le>
32269 [17\18] B Bcc:
32270 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
32271 .endd
32272 Log lines that are neither too long nor contain newlines are written to syslog
32273 without modification.
32274
32275 If only syslog is being used, the Exim monitor is unable to provide a log tail
32276 display, unless syslog is routing &'mainlog'& to a file on the local host and
32277 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
32278 where it is.
32279
32280
32281
32282 .section "Log line flags" "SECID250"
32283 One line is written to the main log for each message received, and for each
32284 successful, unsuccessful, and delayed delivery. These lines can readily be
32285 picked out by the distinctive two-character flags that immediately follow the
32286 timestamp. The flags are:
32287 .display
32288 &`<=`&     message arrival
32289 &`=>`&     normal message delivery
32290 &`->`&     additional address in same delivery
32291 &`*>`&     delivery suppressed by &%-N%&
32292 &`**`&     delivery failed; address bounced
32293 &`==`&     delivery deferred; temporary problem
32294 .endd
32295
32296
32297 .section "Logging message reception" "SECID251"
32298 .cindex "log" "reception line"
32299 The format of the single-line entry in the main log that is written for every
32300 message received is shown in the basic example below, which is split over
32301 several lines in order to fit it on the page:
32302 .code
32303 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
32304   H=mailer.fict.example [192.168.123.123] U=exim
32305   P=smtp S=5678 id=<incoming message id>
32306 .endd
32307 The address immediately following &"<="& is the envelope sender address. A
32308 bounce message is shown with the sender address &"<>"&, and if it is locally
32309 generated, this is followed by an item of the form
32310 .code
32311 R=<message id>
32312 .endd
32313 which is a reference to the message that caused the bounce to be sent.
32314
32315 .cindex "HELO"
32316 .cindex "EHLO"
32317 For messages from other hosts, the H and U fields identify the remote host and
32318 record the RFC 1413 identity of the user that sent the message, if one was
32319 received. The number given in square brackets is the IP address of the sending
32320 host. If there is a single, unparenthesized  host name in the H field, as
32321 above, it has been verified to correspond to the IP address (see the
32322 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
32323 by the remote host in the SMTP HELO or EHLO command, and has not been
32324 verified. If verification yields a different name to that given for HELO or
32325 EHLO, the verified name appears first, followed by the HELO or EHLO
32326 name in parentheses.
32327
32328 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
32329 without brackets, in the HELO or EHLO command, leading to entries in
32330 the log containing text like these examples:
32331 .code
32332 H=(10.21.32.43) [192.168.8.34]
32333 H=([10.21.32.43]) [192.168.8.34]
32334 .endd
32335 This can be confusing. Only the final address in square brackets can be relied
32336 on.
32337
32338 For locally generated messages (that is, messages not received over TCP/IP),
32339 the H field is omitted, and the U field contains the login name of the caller
32340 of Exim.
32341
32342 .cindex "authentication" "logging"
32343 .cindex "AUTH" "logging"
32344 For all messages, the P field specifies the protocol used to receive the
32345 message. This is the value that is stored in &$received_protocol$&. In the case
32346 of incoming SMTP messages, the value indicates whether or not any SMTP
32347 extensions (ESMTP), encryption, or authentication were used. If the SMTP
32348 session was encrypted, there is an additional X field that records the cipher
32349 suite that was used.
32350
32351 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
32352 hosts that have authenticated themselves using the SMTP AUTH command. The first
32353 value is used when the SMTP connection was encrypted (&"secure"&). In this case
32354 there is an additional item A= followed by the name of the authenticator that
32355 was used. If an authenticated identification was set up by the authenticator's
32356 &%server_set_id%& option, this is logged too, separated by a colon from the
32357 authenticator name.
32358
32359 .cindex "size" "of message"
32360 The id field records the existing message id, if present. The size of the
32361 received message is given by the S field. When the message is delivered,
32362 headers may be removed or added, so that the size of delivered copies of the
32363 message may not correspond with this value (and indeed may be different to each
32364 other).
32365
32366 The &%log_selector%& option can be used to request the logging of additional
32367 data when a message is received. See section &<<SECTlogselector>>& below.
32368
32369
32370
32371 .section "Logging deliveries" "SECID252"
32372 .cindex "log" "delivery line"
32373 The format of the single-line entry in the main log that is written for every
32374 delivery is shown in one of the examples below, for local and remote
32375 deliveries, respectively. Each example has been split into two lines in order
32376 to fit it on the page:
32377 .code
32378 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
32379   <marv@hitch.fict.example> R=localuser T=local_delivery
32380 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
32381   monk@holistic.fict.example R=dnslookup T=remote_smtp
32382   H=holistic.fict.example [192.168.234.234]
32383 .endd
32384 For ordinary local deliveries, the original address is given in angle brackets
32385 after the final delivery address, which might be a pipe or a file. If
32386 intermediate address(es) exist between the original and the final address, the
32387 last of these is given in parentheses after the final address. The R and T
32388 fields record the router and transport that were used to process the address.
32389
32390 If a shadow transport was run after a successful local delivery, the log line
32391 for the successful delivery has an item added on the end, of the form
32392 .display
32393 &`ST=<`&&'shadow transport name'&&`>`&
32394 .endd
32395 If the shadow transport did not succeed, the error message is put in
32396 parentheses afterwards.
32397
32398 .cindex "asterisk" "after IP address"
32399 When more than one address is included in a single delivery (for example, two
32400 SMTP RCPT commands in one transaction) the second and subsequent addresses are
32401 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
32402 down a single SMTP connection, an asterisk follows the IP address in the log
32403 lines for the second and subsequent messages.
32404
32405 The generation of a reply message by a filter file gets logged as a
32406 &"delivery"& to the addressee, preceded by &">"&.
32407
32408 The &%log_selector%& option can be used to request the logging of additional
32409 data when a message is delivered. See section &<<SECTlogselector>>& below.
32410
32411
32412 .section "Discarded deliveries" "SECID253"
32413 .cindex "discarded messages"
32414 .cindex "message" "discarded"
32415 .cindex "delivery" "discarded; logging"
32416 When a message is discarded as a result of the command &"seen finish"& being
32417 obeyed in a filter file which generates no deliveries, a log entry of the form
32418 .code
32419 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
32420   <low.club@bridge.example> R=userforward
32421 .endd
32422 is written, to record why no deliveries are logged. When a message is discarded
32423 because it is aliased to &":blackhole:"& the log line is like this:
32424 .code
32425 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
32426   <hole@nowhere.example> R=blackhole_router
32427 .endd
32428
32429
32430 .section "Deferred deliveries" "SECID254"
32431 When a delivery is deferred, a line of the following form is logged:
32432 .code
32433 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
32434   R=dnslookup T=smtp defer (146): Connection refused
32435 .endd
32436 In the case of remote deliveries, the error is the one that was given for the
32437 last IP address that was tried. Details of individual SMTP failures are also
32438 written to the log, so the above line would be preceded by something like
32439 .code
32440 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
32441   mail1.endrest.example [192.168.239.239]: Connection refused
32442 .endd
32443 When a deferred address is skipped because its retry time has not been reached,
32444 a message is written to the log, but this can be suppressed by setting an
32445 appropriate value in &%log_selector%&.
32446
32447
32448
32449 .section "Delivery failures" "SECID255"
32450 .cindex "delivery" "failure; logging"
32451 If a delivery fails because an address cannot be routed, a line of the
32452 following form is logged:
32453 .code
32454 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
32455   <jim@trek99.example>: unknown mail domain
32456 .endd
32457 If a delivery fails at transport time, the router and transport are shown, and
32458 the response from the remote host is included, as in this example:
32459 .code
32460 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
32461   R=dnslookup T=remote_smtp: SMTP error from remote mailer
32462   after pipelined RCPT TO:<ace400@pb.example>: host
32463   pbmail3.py.example [192.168.63.111]: 553 5.3.0
32464   <ace400@pb.example>...Addressee unknown
32465 .endd
32466 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
32467 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
32468 disabling PIPELINING. The log lines for all forms of delivery failure are
32469 flagged with &`**`&.
32470
32471
32472
32473 .section "Fake deliveries" "SECID256"
32474 .cindex "delivery" "fake; logging"
32475 If a delivery does not actually take place because the &%-N%& option has been
32476 used to suppress it, a normal delivery line is written to the log, except that
32477 &"=>"& is replaced by &"*>"&.
32478
32479
32480
32481 .section "Completion" "SECID257"
32482 A line of the form
32483 .code
32484 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
32485 .endd
32486 is written to the main log when a message is about to be removed from the spool
32487 at the end of its processing.
32488
32489
32490
32491
32492 .section "Summary of Fields in Log Lines" "SECID258"
32493 .cindex "log" "summary of fields"
32494 A summary of the field identifiers that are used in log lines is shown in
32495 the following table:
32496 .display
32497 &`A   `&        authenticator name (and optional id)
32498 &`C   `&        SMTP confirmation on delivery
32499 &`    `&        command list for &"no mail in SMTP session"&
32500 &`CV  `&        certificate verification status
32501 &`D   `&        duration of &"no mail in SMTP session"&
32502 &`DN  `&        distinguished name from peer certificate
32503 &`DT  `&        on &`=>`& lines: time taken for a delivery
32504 &`F   `&        sender address (on delivery lines)
32505 &`H   `&        host name and IP address
32506 &`I   `&        local interface used
32507 &`id  `&        message id for incoming message
32508 &`P   `&        on &`<=`& lines: protocol used
32509 &`    `&        on &`=>`& and &`**`& lines: return path
32510 &`QT  `&        on &`=>`& lines: time spent on queue so far
32511 &`    `&        on &"Completed"& lines: time spent on queue
32512 &`R   `&        on &`<=`& lines: reference for local bounce
32513 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
32514 &`S   `&        size of message
32515 &`ST  `&        shadow transport name
32516 &`T   `&        on &`<=`& lines: message subject (topic)
32517 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
32518 &`U   `&        local user or RFC 1413 identity
32519 &`X   `&        TLS cipher suite
32520 .endd
32521
32522
32523 .section "Other log entries" "SECID259"
32524 Various other types of log entry are written from time to time. Most should be
32525 self-explanatory. Among the more common are:
32526
32527 .ilist
32528 .cindex "retry" "time not reached"
32529 &'retry time not reached'&&~&~An address previously suffered a temporary error
32530 during routing or local delivery, and the time to retry has not yet arrived.
32531 This message is not written to an individual message log file unless it happens
32532 during the first delivery attempt.
32533 .next
32534 &'retry time not reached for any host'&&~&~An address previously suffered
32535 temporary errors during remote delivery, and the retry time has not yet arrived
32536 for any of the hosts to which it is routed.
32537 .next
32538 .cindex "spool directory" "file locked"
32539 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
32540 some other Exim process is already working on the message. This can be quite
32541 common if queue running processes are started at frequent intervals. The
32542 &'exiwhat'& utility script can be used to find out what Exim processes are
32543 doing.
32544 .next
32545 .cindex "error" "ignored"
32546 &'error ignored'&&~&~There are several circumstances that give rise to this
32547 message:
32548 .olist
32549 Exim failed to deliver a bounce message whose age was greater than
32550 &%ignore_bounce_errors_after%&. The bounce was discarded.
32551 .next
32552 A filter file set up a delivery using the &"noerror"& option, and the delivery
32553 failed. The delivery was discarded.
32554 .next
32555 A delivery set up by a router configured with
32556 . ==== As this is a nested list, any displays it contains must be indented
32557 . ==== as otherwise they are too far to the left.
32558 .code
32559     errors_to = <>
32560 .endd
32561 failed. The delivery was discarded.
32562 .endlist olist
32563 .endlist ilist
32564
32565
32566
32567
32568
32569 .section "Reducing or increasing what is logged" "SECTlogselector"
32570 .cindex "log" "selectors"
32571 By setting the &%log_selector%& global option, you can disable some of Exim's
32572 default logging, or you can request additional logging. The value of
32573 &%log_selector%& is made up of names preceded by plus or minus characters. For
32574 example:
32575 .code
32576 log_selector = +arguments -retry_defer
32577 .endd
32578 The list of optional log items is in the following table, with the default
32579 selection marked by asterisks:
32580 .display
32581 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
32582 &` address_rewrite            `&  address rewriting
32583 &` all_parents                `&  all parents in => lines
32584 &` arguments                  `&  command line arguments
32585 &`*connection_reject          `&  connection rejections
32586 &`*delay_delivery             `&  immediate delivery delayed
32587 &` deliver_time               `&  time taken to perform delivery
32588 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
32589 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
32590 &`*etrn                       `&  ETRN commands
32591 &`*host_lookup_failed         `&  as it says
32592 &` ident_timeout              `&  timeout for ident connection
32593 &` incoming_interface         `&  incoming interface on <= lines
32594 &` incoming_port              `&  incoming port on <= lines
32595 &`*lost_incoming_connection   `&  as it says (includes timeouts)
32596 &` outgoing_port              `&  add remote port to => lines
32597 &`*queue_run                  `&  start and end queue runs
32598 &` queue_time                 `&  time on queue for one recipient
32599 &` queue_time_overall         `&  time on queue for whole message
32600 &` pid                        `&  Exim process id
32601 &` received_recipients        `&  recipients on <= lines
32602 &` received_sender            `&  sender on <= lines
32603 &`*rejected_header            `&  header contents on reject log
32604 &`*retry_defer                `&  &"retry time not reached"&
32605 &` return_path_on_delivery    `&  put return path on => and ** lines
32606 &` sender_on_delivery         `&  add sender to => lines
32607 &`*sender_verify_fail         `&  sender verification failures
32608 &`*size_reject                `&  rejection because too big
32609 &`*skip_delivery              `&  delivery skipped in a queue run
32610 &` smtp_confirmation          `&  SMTP confirmation on => lines
32611 &` smtp_connection            `&  SMTP connections
32612 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
32613 &` smtp_no_mail               `&  session with no MAIL commands
32614 &` smtp_protocol_error        `&  SMTP protocol errors
32615 &` smtp_syntax_error          `&  SMTP syntax errors
32616 &` subject                    `&  contents of &'Subject:'& on <= lines
32617 &` tls_certificate_verified   `&  certificate verification status
32618 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
32619 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
32620 &` unknown_in_list            `&  DNS lookup failed in list match
32621
32622 &` all                        `&  all of the above
32623 .endd
32624 More details on each of these items follows:
32625
32626 .ilist
32627 .cindex "&%warn%& ACL verb" "log when skipping"
32628 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
32629 its conditions cannot be evaluated, a log line to this effect is written if
32630 this log selector is set.
32631 .next
32632 .cindex "log" "rewriting"
32633 .cindex "rewriting" "logging"
32634 &%address_rewrite%&: This applies both to global rewrites and per-transport
32635 rewrites, but not to rewrites in filters run as an unprivileged user (because
32636 such users cannot access the log).
32637 .next
32638 .cindex "log" "full parentage"
32639 &%all_parents%&: Normally only the original and final addresses are logged on
32640 delivery lines; with this selector, intermediate parents are given in
32641 parentheses between them.
32642 .next
32643 .cindex "log" "Exim arguments"
32644 .cindex "Exim arguments, logging"
32645 &%arguments%&: This causes Exim to write the arguments with which it was called
32646 to the main log, preceded by the current working directory. This is a debugging
32647 feature, added to make it easier to find out how certain MUAs call
32648 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
32649 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
32650 that are empty or that contain white space are quoted. Non-printing characters
32651 are shown as escape sequences. This facility cannot log unrecognized arguments,
32652 because the arguments are checked before the configuration file is read. The
32653 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
32654 between the caller and Exim.
32655 .next
32656 .cindex "log" "connection rejections"
32657 &%connection_reject%&: A log entry is written whenever an incoming SMTP
32658 connection is rejected, for whatever reason.
32659 .next
32660 .cindex "log" "delayed delivery"
32661 .cindex "delayed delivery, logging"
32662 &%delay_delivery%&: A log entry is written whenever a delivery process is not
32663 started for an incoming message because the load is too high or too many
32664 messages were received on one connection. Logging does not occur if no delivery
32665 process is started because &%queue_only%& is set or &%-odq%& was used.
32666 .next
32667 .cindex "log" "delivery duration"
32668 &%deliver_time%&: For each delivery, the amount of real time it has taken to
32669 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
32670 .next
32671 .cindex "log" "message size on delivery"
32672 .cindex "size" "of message"
32673 &%delivery_size%&: For each delivery, the size of message delivered is added to
32674 the &"=>"& line, tagged with S=.
32675 .next
32676 .cindex "log" "dnslist defer"
32677 .cindex "DNS list" "logging defer"
32678 .cindex "black list (DNS)"
32679 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
32680 DNS black list suffers a temporary error.
32681 .next
32682 .cindex "log" "ETRN commands"
32683 .cindex "ETRN" "logging"
32684 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
32685 is run to determine whether or not it is actually accepted. An invalid ETRN
32686 command, or one received within a message transaction is not logged by this
32687 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
32688 .next
32689 .cindex "log" "host lookup failure"
32690 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
32691 any addresses, or when a lookup of an IP address fails to find a host name, a
32692 log line is written. This logging does not apply to direct DNS lookups when
32693 routing email addresses, but it does apply to &"byname"& lookups.
32694 .next
32695 .cindex "log" "ident timeout"
32696 .cindex "RFC 1413" "logging timeout"
32697 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
32698 client's ident port times out.
32699 .next
32700 .cindex "log" "incoming interface"
32701 .cindex "interface" "logging"
32702 &%incoming_interface%&: The interface on which a message was received is added
32703 to the &"<="& line as an IP address in square brackets, tagged by I= and
32704 followed by a colon and the port number. The local interface and port are also
32705 added to other SMTP log lines, for example &"SMTP connection from"&, and to
32706 rejection lines.
32707 .next
32708 .cindex "log" "incoming remote port"
32709 .cindex "port" "logging remote"
32710 .cindex "TCP/IP" "logging incoming remote port"
32711 .vindex "&$sender_fullhost$&"
32712 .vindex "&$sender_rcvhost$&"
32713 &%incoming_port%&: The remote port number from which a message was received is
32714 added to log entries and &'Received:'& header lines, following the IP address
32715 in square brackets, and separated from it by a colon. This is implemented by
32716 changing the value that is put in the &$sender_fullhost$& and
32717 &$sender_rcvhost$& variables. Recording the remote port number has become more
32718 important with the widening use of NAT (see RFC 2505).
32719 .next
32720 .cindex "log" "dropped connection"
32721 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
32722 connection is unexpectedly dropped.
32723 .next
32724 .cindex "log" "outgoing remote port"
32725 .cindex "port" "logging outgoint remote"
32726 .cindex "TCP/IP" "logging ougtoing remote port"
32727 &%outgoing_port%&: The remote port number is added to delivery log lines (those
32728 containing => tags) following the IP address. This option is not included in
32729 the default setting, because for most ordinary configurations, the remote port
32730 number is always 25 (the SMTP port).
32731 .next
32732 .cindex "log" "process ids in"
32733 .cindex "pid (process id)" "in log lines"
32734 &%pid%&: The current process id is added to every log line, in square brackets,
32735 immediately after the time and date.
32736 .next
32737 .cindex "log" "queue run"
32738 .cindex "queue runner" "logging"
32739 &%queue_run%&: The start and end of every queue run are logged.
32740 .next
32741 .cindex "log" "queue time"
32742 &%queue_time%&: The amount of time the message has been in the queue on the
32743 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
32744 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
32745 includes reception time as well as the delivery time for the current address.
32746 This means that it may be longer than the difference between the arrival and
32747 delivery log line times, because the arrival log line is not written until the
32748 message has been successfully received.
32749 .next
32750 &%queue_time_overall%&: The amount of time the message has been in the queue on
32751 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
32752 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
32753 message, so it includes reception time as well as the total delivery time.
32754 .next
32755 .cindex "log" "recipients"
32756 &%received_recipients%&: The recipients of a message are listed in the main log
32757 as soon as the message is received. The list appears at the end of the log line
32758 that is written when a message is received, preceded by the word &"for"&. The
32759 addresses are listed after they have been qualified, but before any rewriting
32760 has taken place.
32761 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
32762 in the list.
32763 .next
32764 .cindex "log" "sender reception"
32765 &%received_sender%&: The unrewritten original sender of a message is added to
32766 the end of the log line that records the message's arrival, after the word
32767 &"from"& (before the recipients if &%received_recipients%& is also set).
32768 .next
32769 .cindex "log" "header lines for rejection"
32770 &%rejected_header%&: If a message's header has been received at the time a
32771 rejection is written to the reject log, the complete header is added to the
32772 log. Header logging can be turned off individually for messages that are
32773 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
32774 .next
32775 .cindex "log" "retry defer"
32776 &%retry_defer%&: A log line is written if a delivery is deferred because a
32777 retry time has not yet been reached. However, this &"retry time not reached"&
32778 message is always omitted from individual message logs after the first delivery
32779 attempt.
32780 .next
32781 .cindex "log" "return path"
32782 &%return_path_on_delivery%&: The return path that is being transmitted with
32783 the message is included in delivery and bounce lines, using the tag P=.
32784 This is omitted if no delivery actually happens, for example, if routing fails,
32785 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
32786 .next
32787 .cindex "log" "sender on delivery"
32788 &%sender_on_delivery%&: The message's sender address is added to every delivery
32789 and bounce line, tagged by F= (for &"from"&).
32790 This is the original sender that was received with the message; it is not
32791 necessarily the same as the outgoing return path.
32792 .next
32793 .cindex "log" "sender verify failure"
32794 &%sender_verify_fail%&: If this selector is unset, the separate log line that
32795 gives details of a sender verification failure is not written. Log lines for
32796 the rejection of SMTP commands contain just &"sender verify failed"&, so some
32797 detail is lost.
32798 .next
32799 .cindex "log" "size rejection"
32800 &%size_reject%&: A log line is written whenever a message is rejected because
32801 it is too big.
32802 .next
32803 .cindex "log" "frozen messages; skipped"
32804 .cindex "frozen messages" "logging skipping"
32805 &%skip_delivery%&: A log line is written whenever a message is skipped during a
32806 queue run because it is frozen or because another process is already delivering
32807 it.
32808 .cindex "&""spool file is locked""&"
32809 The message that is written is &"spool file is locked"&.
32810 .next
32811 .cindex "log" "smtp confirmation"
32812 .cindex "SMTP" "logging confirmation"
32813 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
32814 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
32815 A number of MTAs (including Exim) return an identifying string in this
32816 response.
32817 .next
32818 .cindex "log" "SMTP connections"
32819 .cindex "SMTP" "logging connections"
32820 &%smtp_connection%&: A log line is written whenever an SMTP connection is
32821 established or closed, unless the connection is from a host that matches
32822 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
32823 only when the closure is unexpected.) This applies to connections from local
32824 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
32825 dropped in the middle of a message, a log line is always written, whether or
32826 not this selector is set, but otherwise nothing is written at the start and end
32827 of connections unless this selector is enabled.
32828
32829 For TCP/IP connections to an Exim daemon, the current number of connections is
32830 included in the log message for each new connection, but note that the count is
32831 reset if the daemon is restarted.
32832 Also, because connections are closed (and the closure is logged) in
32833 subprocesses, the count may not include connections that have been closed but
32834 whose termination the daemon has not yet noticed. Thus, while it is possible to
32835 match up the opening and closing of connections in the log, the value of the
32836 logged counts may not be entirely accurate.
32837 .next
32838 .cindex "log" "SMTP transaction; incomplete"
32839 .cindex "SMTP" "logging incomplete transactions"
32840 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
32841 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
32842 and the message sender plus any accepted recipients are included in the log
32843 line. This can provide evidence of dictionary attacks.
32844 .next
32845 .cindex "log" "non-MAIL SMTP sessions"
32846 .cindex "MAIL" "logging session without"
32847 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
32848 connection terminates without having issued a MAIL command. This includes both
32849 the case when the connection is dropped, and the case when QUIT is used. It
32850 does not include cases where the connection is rejected right at the start (by
32851 an ACL, or because there are too many connections, or whatever). These cases
32852 already have their own log lines.
32853
32854 The log line that is written contains the identity of the client in the usual
32855 way, followed by D= and a time, which records the duration of the connection.
32856 If the connection was authenticated, this fact is logged exactly as it is for
32857 an incoming message, with an A= item. If the connection was encrypted, CV=,
32858 DN=, and X= items may appear as they do for an incoming message, controlled by
32859 the same logging options.
32860
32861 Finally, if any SMTP commands were issued during the connection, a C= item
32862 is added to the line, listing the commands that were used. For example,
32863 .code
32864 C=EHLO,QUIT
32865 .endd
32866 shows that the client issued QUIT straight after EHLO. If there were fewer
32867 than 20 commands, they are all listed. If there were more than 20 commands,
32868 the last 20 are listed, preceded by &"..."&. However, with the default
32869 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
32870 have been aborted before 20 non-mail commands are processed.
32871 .next
32872 .cindex "log" "SMTP protocol error"
32873 .cindex "SMTP" "logging protocol error"
32874 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
32875 encountered. Exim does not have perfect detection of all protocol errors
32876 because of transmission delays and the use of pipelining. If PIPELINING has
32877 been advertised to a client, an Exim server assumes that the client will use
32878 it, and therefore it does not count &"expected"& errors (for example, RCPT
32879 received after rejecting MAIL) as protocol errors.
32880 .next
32881 .cindex "SMTP" "logging syntax errors"
32882 .cindex "SMTP" "syntax errors; logging"
32883 .cindex "SMTP" "unknown command; logging"
32884 .cindex "log" "unknown SMTP command"
32885 .cindex "log" "SMTP syntax error"
32886 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
32887 encountered. An unrecognized command is treated as a syntax error. For an
32888 external connection, the host identity is given; for an internal connection
32889 using &%-bs%& the sender identification (normally the calling user) is given.
32890 .next
32891 .cindex "log" "subject"
32892 .cindex "subject, logging"
32893 &%subject%&: The subject of the message is added to the arrival log line,
32894 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
32895 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
32896 specifies whether characters with values greater than 127 should be logged
32897 unchanged, or whether they should be rendered as escape sequences.
32898 .next
32899 .cindex "log" "certificate verification"
32900 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
32901 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
32902 verified, and &`CV=no`& if not.
32903 .next
32904 .cindex "log" "TLS cipher"
32905 .cindex "TLS" "logging cipher"
32906 &%tls_cipher%&: When a message is sent or received over an encrypted
32907 connection, the cipher suite used is added to the log line, preceded by X=.
32908 .next
32909 .cindex "log" "TLS peer DN"
32910 .cindex "TLS" "logging peer DN"
32911 &%tls_peerdn%&: When a message is sent or received over an encrypted
32912 connection, and a certificate is supplied by the remote host, the peer DN is
32913 added to the log line, preceded by DN=.
32914 .next
32915 .cindex "log" "DNS failure in list"
32916 &%unknown_in_list%&: This setting causes a log entry to be written when the
32917 result of a list match is failure because a DNS lookup failed.
32918 .endlist
32919
32920
32921 .section "Message log" "SECID260"
32922 .cindex "message" "log file for"
32923 .cindex "log" "message log; description of"
32924 .cindex "&_msglog_& directory"
32925 .oindex "&%preserve_message_logs%&"
32926 In addition to the general log files, Exim writes a log file for each message
32927 that it handles. The names of these per-message logs are the message ids, and
32928 they are kept in the &_msglog_& sub-directory of the spool directory. Each
32929 message log contains copies of the log lines that apply to the message. This
32930 makes it easier to inspect the status of an individual message without having
32931 to search the main log. A message log is deleted when processing of the message
32932 is complete, unless &%preserve_message_logs%& is set, but this should be used
32933 only with great care because they can fill up your disk very quickly.
32934
32935 On a heavily loaded system, it may be desirable to disable the use of
32936 per-message logs, in order to reduce disk I/O. This can be done by setting the
32937 &%message_logs%& option false.
32938 .ecindex IIDloggen
32939
32940
32941
32942
32943 . ////////////////////////////////////////////////////////////////////////////
32944 . ////////////////////////////////////////////////////////////////////////////
32945
32946 .chapter "Exim utilities" "CHAPutils"
32947 .scindex IIDutils "utilities"
32948 A number of utility scripts and programs are supplied with Exim and are
32949 described in this chapter. There is also the Exim Monitor, which is covered in
32950 the next chapter. The utilities described here are:
32951
32952 .itable none 0 0 3  7* left  15* left  40* left
32953 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
32954   "list what Exim processes are doing"
32955 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
32956 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
32957 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
32958 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
32959                                                 various criteria"
32960 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
32961 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
32962   "extract statistics from the log"
32963 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
32964   "check address acceptance from given IP"
32965 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
32966 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
32967 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
32968 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
32969 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
32970 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
32971 .endtable
32972
32973 Another utility that might be of use to sites with many MTAs is Tom Kistner's
32974 &'exilog'&. It provides log visualizations across multiple Exim servers. See
32975 &url(http://duncanthrax.net/exilog/) for details.
32976
32977
32978
32979
32980 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
32981 .cindex "&'exiwhat'&"
32982 .cindex "process, querying"
32983 .cindex "SIGUSR1"
32984 On operating systems that can restart a system call after receiving a signal
32985 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
32986 a line describing what it is doing to the file &_exim-process.info_& in the
32987 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
32988 processes it can find, having first emptied the file. It then waits for one
32989 second to allow the Exim processes to react before displaying the results. In
32990 order to run &'exiwhat'& successfully you have to have sufficient privilege to
32991 send the signal to the Exim processes, so it is normally run as root.
32992
32993 &*Warning*&: This is not an efficient process. It is intended for occasional
32994 use by system administrators. It is not sensible, for example, to set up a
32995 script that sends SIGUSR1 signals to Exim processes at short intervals.
32996
32997
32998 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
32999 varies in different operating systems. Not only are different options used,
33000 but the format of the output is different. For this reason, there are some
33001 system configuration options that configure exactly how &'exiwhat'& works. If
33002 it doesn't seem to be working for you, check the following compile-time
33003 options:
33004 .display
33005 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
33006 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
33007 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
33008 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
33009 .endd
33010 An example of typical output from &'exiwhat'& is
33011 .code
33012 164 daemon: -q1h, listening on port 25
33013 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
33014 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
33015   [10.19.42.42] (editor@ref.example)
33016 10592 handling incoming call from [192.168.243.242]
33017 10628 accepting a local non-SMTP message
33018 .endd
33019 The first number in the output line is the process number. The third line has
33020 been split here, in order to fit it on the page.
33021
33022
33023
33024 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
33025 .cindex "&'exiqgrep'&"
33026 .cindex "queue" "grepping"
33027 This utility is a Perl script contributed by Matt Hubbard. It runs
33028 .code
33029 exim -bpu
33030 .endd
33031 to obtain a queue listing with undelivered recipients only, and then greps the
33032 output to select messages that match given criteria. The following selection
33033 options are available:
33034
33035 .vlist
33036 .vitem &*-f*&&~<&'regex'&>
33037 Match the sender address. The field that is tested is enclosed in angle
33038 brackets, so you can test for bounce messages with
33039 .code
33040 exiqgrep -f '^<>$'
33041 .endd
33042 .vitem &*-r*&&~<&'regex'&>
33043 Match a recipient address. The field that is tested is not enclosed in angle
33044 brackets.
33045
33046 .vitem &*-s*&&~<&'regex'&>
33047 Match against the size field.
33048
33049 .vitem &*-y*&&~<&'seconds'&>
33050 Match messages that are younger than the given time.
33051
33052 .vitem &*-o*&&~<&'seconds'&>
33053 Match messages that are older than the given time.
33054
33055 .vitem &*-z*&
33056 Match only frozen messages.
33057
33058 .vitem &*-x*&
33059 Match only non-frozen messages.
33060 .endlist
33061
33062 The following options control the format of the output:
33063
33064 .vlist
33065 .vitem &*-c*&
33066 Display only the count of matching messages.
33067
33068 .vitem &*-l*&
33069 Long format &-- display the full message information as output by Exim. This is
33070 the default.
33071
33072 .vitem &*-i*&
33073 Display message ids only.
33074
33075 .vitem &*-b*&
33076 Brief format &-- one line per message.
33077
33078 .vitem &*-R*&
33079 Display messages in reverse order.
33080 .endlist
33081
33082 There is one more option, &%-h%&, which outputs a list of options.
33083
33084
33085
33086 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
33087 .cindex "&'exiqsumm'&"
33088 .cindex "queue" "summary"
33089 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
33090 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
33091 running a command such as
33092 .code
33093 exim -bp | exiqsumm
33094 .endd
33095 The output consists of one line for each domain that has messages waiting for
33096 it, as in the following example:
33097 .code
33098 3   2322   74m   66m  msn.com.example
33099 .endd
33100 Each line lists the number of pending deliveries for a domain, their total
33101 volume, and the length of time that the oldest and the newest messages have
33102 been waiting. Note that the number of pending deliveries is greater than the
33103 number of messages when messages have more than one recipient.
33104
33105 A summary line is output at the end. By default the output is sorted on the
33106 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
33107 the output to be sorted by oldest message and by count of messages,
33108 respectively. There are also three options that split the messages for each
33109 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
33110 separates frozen messages, and &%-s%& separates messages according to their
33111 sender.
33112
33113 The output of &'exim -bp'& contains the original addresses in the message, so
33114 this also applies to the output from &'exiqsumm'&. No domains from addresses
33115 generated by aliasing or forwarding are included (unless the &%one_time%&
33116 option of the &(redirect)& router has been used to convert them into &"top
33117 level"& addresses).
33118
33119
33120
33121
33122 .section "Extracting specific information from the log (exigrep)" &&&
33123          "SECTextspeinf"
33124 .cindex "&'exigrep'&"
33125 .cindex "log" "extracts; grepping for"
33126 The &'exigrep'& utility is a Perl script that searches one or more main log
33127 files for entries that match a given pattern. When it finds a match, it
33128 extracts all the log entries for the relevant message, not just those that
33129 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
33130 given message, or all mail for a given user, or for a given host, for example.
33131 The input files can be in Exim log format or syslog format.
33132 If a matching log line is not associated with a specific message, it is
33133 included in &'exigrep'&'s output without any additional lines. The usage is:
33134 .display
33135 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
33136 .endd
33137 If no log file names are given on the command line, the standard input is read.
33138
33139 The &%-t%& argument specifies a number of seconds. It adds an additional
33140 condition for message selection. Messages that are complete are shown only if
33141 they spent more than <&'n'&> seconds on the queue.
33142
33143 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
33144 makes it case-sensitive. This may give a performance improvement when searching
33145 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
33146 option; with &%-I%& they do not. In both cases it is possible to change the
33147 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
33148
33149 The &%-l%& option means &"literal"&, that is, treat all characters in the
33150 pattern as standing for themselves. Otherwise the pattern must be a Perl
33151 regular expression.
33152
33153 The &%-v%& option inverts the matching condition. That is, a line is selected
33154 if it does &'not'& match the pattern.
33155
33156 If the location of a &'zcat'& command is known from the definition of
33157 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
33158 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
33159
33160
33161 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
33162 .cindex "&'exipick'&"
33163 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
33164 lists messages from the queue according to a variety of criteria. For details
33165 of &'exipick'&'s facilities, visit the web page at
33166 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
33167 the &%--help%& option.
33168
33169
33170 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
33171 .cindex "log" "cycling local files"
33172 .cindex "cycling logs"
33173 .cindex "&'exicyclog'&"
33174 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
33175 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
33176 you are using log files with datestamps in their names (see section
33177 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
33178 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
33179 There are two command line options for &'exicyclog'&:
33180 .ilist
33181 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
33182 default that is set when Exim is built. The default default is 10.
33183 .next
33184 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
33185 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
33186 overriding the script's default, which is to find the setting from Exim's
33187 configuration.
33188 .endlist
33189
33190 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
33191 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
33192 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
33193 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
33194 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
33195 logs are handled similarly.
33196
33197 If the limit is greater than 99, the script uses 3-digit numbers such as
33198 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
33199 to one that is greater, or &'vice versa'&, you will have to fix the names of
33200 any existing log files.
33201
33202 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
33203 the end are deleted. All files with numbers greater than 01 are compressed,
33204 using a compression command which is configured by the COMPRESS_COMMAND
33205 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
33206 root &%crontab%& entry of the form
33207 .code
33208 1 0 * * * su exim -c /usr/exim/bin/exicyclog
33209 .endd
33210 assuming you have used the name &"exim"& for the Exim user. You can run
33211 &'exicyclog'& as root if you wish, but there is no need.
33212
33213
33214
33215 .section "Mail statistics (eximstats)" "SECTmailstat"
33216 .cindex "statistics"
33217 .cindex "&'eximstats'&"
33218 A Perl script called &'eximstats'& is provided for extracting statistical
33219 information from log files. The output is either plain text, or HTML.
33220 Exim log files are also supported by the &'Lire'& system produced by the
33221 LogReport Foundation &url(http://www.logreport.org).
33222
33223 The &'eximstats'& script has been hacked about quite a bit over time. The
33224 latest version is the result of some extensive revision by Steve Campbell. A
33225 lot of information is given by default, but there are options for suppressing
33226 various parts of it. Following any options, the arguments to the script are a
33227 list of files, which should be main log files. For example:
33228 .code
33229 eximstats -nr /var/spool/exim/log/mainlog.01
33230 .endd
33231 By default, &'eximstats'& extracts information about the number and volume of
33232 messages received from or delivered to various hosts. The information is sorted
33233 both by message count and by volume, and the top fifty hosts in each category
33234 are listed on the standard output. Similar information, based on email
33235 addresses or domains instead of hosts can be requested by means of various
33236 options. For messages delivered and received locally, similar statistics are
33237 also produced per user.
33238
33239 The output also includes total counts and statistics about delivery errors, and
33240 histograms showing the number of messages received and deliveries made in each
33241 hour of the day. A delivery with more than one address in its envelope (for
33242 example, an SMTP transaction with more than one RCPT command) is counted
33243 as a single delivery by &'eximstats'&.
33244
33245 Though normally more deliveries than receipts are reported (as messages may
33246 have multiple recipients), it is possible for &'eximstats'& to report more
33247 messages received than delivered, even though the queue is empty at the start
33248 and end of the period in question. If an incoming message contains no valid
33249 recipients, no deliveries are recorded for it. A bounce message is handled as
33250 an entirely separate message.
33251
33252 &'eximstats'& always outputs a grand total summary giving the volume and number
33253 of messages received and deliveries made, and the number of hosts involved in
33254 each case. It also outputs the number of messages that were delayed (that is,
33255 not completely delivered at the first attempt), and the number that had at
33256 least one address that failed.
33257
33258 The remainder of the output is in sections that can be independently disabled
33259 or modified by various options. It consists of a summary of deliveries by
33260 transport, histograms of messages received and delivered per time interval
33261 (default per hour), information about the time messages spent on the queue,
33262 a list of relayed messages, lists of the top fifty sending hosts, local
33263 senders, destination hosts, and destination local users by count and by volume,
33264 and a list of delivery errors that occurred.
33265
33266 The relay information lists messages that were actually relayed, that is, they
33267 came from a remote host and were directly delivered to some other remote host,
33268 without being processed (for example, for aliasing or forwarding) locally.
33269
33270 There are quite a few options for &'eximstats'& to control exactly what it
33271 outputs. These are documented in the Perl script itself, and can be extracted
33272 by running the command &(perldoc)& on the script. For example:
33273 .code
33274 perldoc /usr/exim/bin/eximstats
33275 .endd
33276
33277 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
33278 .cindex "&'exim_checkaccess'&"
33279 .cindex "policy control" "checking access"
33280 .cindex "checking access"
33281 The &%-bh%& command line argument allows you to run a fake SMTP session with
33282 debugging output, in order to check what Exim is doing when it is applying
33283 policy controls to incoming SMTP mail. However, not everybody is sufficiently
33284 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
33285 sometimes you just want to answer the question &"Does this address have
33286 access?"& without bothering with any further details.
33287
33288 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
33289 two arguments, an IP address and an email address:
33290 .code
33291 exim_checkaccess 10.9.8.7 A.User@a.domain.example
33292 .endd
33293 The utility runs a call to Exim with the &%-bh%& option, to test whether the
33294 given email address would be accepted in a RCPT command in a TCP/IP
33295 connection from the host with the given IP address. The output of the utility
33296 is either the word &"accepted"&, or the SMTP error response, for example:
33297 .code
33298 Rejected:
33299 550 Relay not permitted
33300 .endd
33301 When running this test, the utility uses &`<>`& as the envelope sender address
33302 for the MAIL command, but you can change this by providing additional
33303 options. These are passed directly to the Exim command. For example, to specify
33304 that the test is to be run with the sender address &'himself@there.example'&
33305 you can use:
33306 .code
33307 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
33308                  -f himself@there.example
33309 .endd
33310 Note that these additional Exim command line items must be given after the two
33311 mandatory arguments.
33312
33313 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
33314 while running its checks. You can run checks that include callouts by using
33315 &%-bhc%&, but this is not yet available in a &"packaged"& form.
33316
33317
33318
33319 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
33320 .cindex "DBM" "building dbm files"
33321 .cindex "building DBM files"
33322 .cindex "&'exim_dbmbuild'&"
33323 .cindex "lower casing"
33324 .cindex "binary zero" "in lookup key"
33325 The &'exim_dbmbuild'& program reads an input file containing keys and data in
33326 the format used by the &(lsearch)& lookup (see section
33327 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
33328 names as keys and the remainder of the information as data. The lower-casing
33329 can be prevented by calling the program with the &%-nolc%& option.
33330
33331 A terminating zero is included as part of the key string. This is expected by
33332 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
33333 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
33334 strings or the data strings. The &(dbmnz)& lookup type can be used with such
33335 files.
33336
33337 The program requires two arguments: the name of the input file (which can be a
33338 single hyphen to indicate the standard input), and the name of the output file.
33339 It creates the output under a temporary name, and then renames it if all went
33340 well.
33341
33342 .cindex "USE_DB"
33343 If the native DB interface is in use (USE_DB is set in a compile-time
33344 configuration file &-- this is common in free versions of Unix) the two file
33345 names must be different, because in this mode the Berkeley DB functions create
33346 a single output file using exactly the name given. For example,
33347 .code
33348 exim_dbmbuild /etc/aliases /etc/aliases.db
33349 .endd
33350 reads the system alias file and creates a DBM version of it in
33351 &_/etc/aliases.db_&.
33352
33353 In systems that use the &'ndbm'& routines (mostly proprietary versions of
33354 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
33355 environment, the suffixes are added to the second argument of
33356 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
33357 when the Berkeley functions are used in compatibility mode (though this is not
33358 recommended), because in that case it adds a &_.db_& suffix to the file name.
33359
33360 If a duplicate key is encountered, the program outputs a warning, and when it
33361 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
33362 option is used. By default, only the first of a set of duplicates is used &--
33363 this makes it compatible with &(lsearch)& lookups. There is an option
33364 &%-lastdup%& which causes it to use the data for the last duplicate instead.
33365 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
33366 &%stderr%&. For other errors, where it doesn't actually make a new file, the
33367 return code is 2.
33368
33369
33370
33371
33372 .section "Finding individual retry times (exinext)" "SECTfinindret"
33373 .cindex "retry" "times"
33374 .cindex "&'exinext'&"
33375 A utility called &'exinext'& (mostly a Perl script) provides the ability to
33376 fish specific information out of the retry database. Given a mail domain (or a
33377 complete address), it looks up the hosts for that domain, and outputs any retry
33378 information for the hosts or for the domain. At present, the retry information
33379 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
33380 output. For example:
33381 .code
33382 $ exinext piglet@milne.fict.example
33383 kanga.milne.example:192.168.8.1 error 146: Connection refused
33384   first failed: 21-Feb-1996 14:57:34
33385   last tried:   21-Feb-1996 14:57:34
33386   next try at:  21-Feb-1996 15:02:34
33387 roo.milne.example:192.168.8.3 error 146: Connection refused
33388   first failed: 20-Jan-1996 13:12:08
33389   last tried:   21-Feb-1996 11:42:03
33390   next try at:  21-Feb-1996 19:42:03
33391   past final cutoff time
33392 .endd
33393 You can also give &'exinext'& a local part, without a domain, and it
33394 will give any retry information for that local part in your default domain.
33395 A message id can be used to obtain retry information pertaining to a specific
33396 message. This exists only when an attempt to deliver a message to a remote host
33397 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
33398 &'exinext'& is not particularly efficient, but then it is not expected to be
33399 run very often.
33400
33401 The &'exinext'& utility calls Exim to find out information such as the location
33402 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
33403 passed on to the &'exim'& commands. The first specifies an alternate Exim
33404 configuration file, and the second sets macros for use within the configuration
33405 file. These features are mainly to help in testing, but might also be useful in
33406 environments where more than one configuration file is in use.
33407
33408
33409
33410 .section "Hints database maintenance" "SECThindatmai"
33411 .cindex "hints database" "maintenance"
33412 .cindex "maintaining Exim's hints database"
33413 Three utility programs are provided for maintaining the DBM files that Exim
33414 uses to contain its delivery hint information. Each program requires two
33415 arguments. The first specifies the name of Exim's spool directory, and the
33416 second is the name of the database it is to operate on. These are as follows:
33417
33418 .ilist
33419 &'retry'&: the database of retry information
33420 .next
33421 &'wait-'&<&'transport name'&>: databases of information about messages waiting
33422 for remote hosts
33423 .next
33424 &'callout'&: the callout cache
33425 .next
33426 &'ratelimit'&: the data for implementing the ratelimit ACL condition
33427 .next
33428 &'misc'&: other hints data
33429 .endlist
33430
33431 The &'misc'& database is used for
33432
33433 .ilist
33434 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
33435 .next
33436 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
33437 &(smtp)& transport)
33438 .endlist
33439
33440
33441
33442 .section "exim_dumpdb" "SECID261"
33443 .cindex "&'exim_dumpdb'&"
33444 The entire contents of a database are written to the standard output by the
33445 &'exim_dumpdb'& program, which has no options or arguments other than the
33446 spool and database names. For example, to dump the retry database:
33447 .code
33448 exim_dumpdb /var/spool/exim retry
33449 .endd
33450 Two lines of output are produced for each entry:
33451 .code
33452 T:mail.ref.example:192.168.242.242 146 77 Connection refused
33453 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
33454 .endd
33455 The first item on the first line is the key of the record. It starts with one
33456 of the letters R, or T, depending on whether it refers to a routing or
33457 transport retry. For a local delivery, the next part is the local address; for
33458 a remote delivery it is the name of the remote host, followed by its failing IP
33459 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
33460 transport). If the remote port is not the standard one (port 25), it is added
33461 to the IP address. Then there follows an error code, an additional error code,
33462 and a textual description of the error.
33463
33464 The three times on the second line are the time of first failure, the time of
33465 the last delivery attempt, and the computed time for the next attempt. The line
33466 ends with an asterisk if the cutoff time for the last retry rule has been
33467 exceeded.
33468
33469 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
33470 consists of a host name followed by a list of ids for messages that are or were
33471 waiting to be delivered to that host. If there are a very large number for any
33472 one host, continuation records, with a sequence number added to the host name,
33473 may be seen. The data in these records is often out of date, because a message
33474 may be routed to several alternative hosts, and Exim makes no effort to keep
33475 cross-references.
33476
33477
33478
33479 .section "exim_tidydb" "SECID262"
33480 .cindex "&'exim_tidydb'&"
33481 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
33482 database. If run with no options, it removes all records that are more than 30
33483 days old. The age is calculated from the date and time that the record was last
33484 updated. Note that, in the case of the retry database, it is &'not'& the time
33485 since the first delivery failure. Information about a host that has been down
33486 for more than 30 days will remain in the database, provided that the record is
33487 updated sufficiently often.
33488
33489 The cutoff date can be altered by means of the &%-t%& option, which must be
33490 followed by a time. For example, to remove all records older than a week from
33491 the retry database:
33492 .code
33493 exim_tidydb -t 7d /var/spool/exim retry
33494 .endd
33495 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
33496 message ids. In the former these appear as data in records keyed by host &--
33497 they were messages that were waiting for that host &-- and in the latter they
33498 are the keys for retry information for messages that have suffered certain
33499 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
33500 message ids in database records are those of messages that are still on the
33501 queue. Message ids for messages that no longer exist are removed from
33502 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
33503 For the &'retry'& database, records whose keys are non-existent message ids are
33504 removed. The &'exim_tidydb'& utility outputs comments on the standard output
33505 whenever it removes information from the database.
33506
33507 Certain records are automatically removed by Exim when they are no longer
33508 needed, but others are not. For example, if all the MX hosts for a domain are
33509 down, a retry record is created for each one. If the primary MX host comes back
33510 first, its record is removed when Exim successfully delivers to it, but the
33511 records for the others remain because Exim has not tried to use those hosts.
33512
33513 It is important, therefore, to run &'exim_tidydb'& periodically on all the
33514 hints databases. You should do this at a quiet time of day, because it requires
33515 a database to be locked (and therefore inaccessible to Exim) while it does its
33516 work. Removing records from a DBM file does not normally make the file smaller,
33517 but all the common DBM libraries are able to re-use the space that is released.
33518 After an initial phase of increasing in size, the databases normally reach a
33519 point at which they no longer get any bigger, as long as they are regularly
33520 tidied.
33521
33522 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
33523 databases is likely to keep on increasing.
33524
33525
33526
33527
33528 .section "exim_fixdb" "SECID263"
33529 .cindex "&'exim_fixdb'&"
33530 The &'exim_fixdb'& program is a utility for interactively modifying databases.
33531 Its main use is for testing Exim, but it might also be occasionally useful for
33532 getting round problems in a live system. It has no options, and its interface
33533 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
33534 key of a database record can then be entered, and the data for that record is
33535 displayed.
33536
33537 If &"d"& is typed at the next prompt, the entire record is deleted. For all
33538 except the &'retry'& database, that is the only operation that can be carried
33539 out. For the &'retry'& database, each field is output preceded by a number, and
33540 data for individual fields can be changed by typing the field number followed
33541 by new data, for example:
33542 .code
33543 > 4 951102:1000
33544 .endd
33545 resets the time of the next delivery attempt. Time values are given as a
33546 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
33547 used as optional separators.
33548
33549
33550
33551
33552 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
33553 .cindex "mailbox" "maintenance"
33554 .cindex "&'exim_lock'&"
33555 .cindex "locking mailboxes"
33556 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
33557 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
33558 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
33559 a user agent while investigating a problem. The utility requires the name of
33560 the file as its first argument. If the locking is successful, the second
33561 argument is run as a command (using C's &[system()]& function); if there is no
33562 second argument, the value of the SHELL environment variable is used; if this
33563 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
33564 is unlocked and the utility ends. The following options are available:
33565
33566 .vlist
33567 .vitem &%-fcntl%&
33568 Use &[fcntl()]& locking on the open mailbox.
33569
33570 .vitem &%-flock%&
33571 Use &[flock()]& locking on the open mailbox, provided the operating system
33572 supports it.
33573
33574 .vitem &%-interval%&
33575 This must be followed by a number, which is a number of seconds; it sets the
33576 interval to sleep between retries (default 3).
33577
33578 .vitem &%-lockfile%&
33579 Create a lock file before opening the mailbox.
33580
33581 .vitem &%-mbx%&
33582 Lock the mailbox using MBX rules.
33583
33584 .vitem &%-q%&
33585 Suppress verification output.
33586
33587 .vitem &%-retries%&
33588 This must be followed by a number; it sets the number of times to try to get
33589 the lock (default 10).
33590
33591 .vitem &%-restore_time%&
33592 This option causes &%exim_lock%& to restore the modified and read times to the
33593 locked file before exiting. This allows you to access a locked mailbox (for
33594 example, to take a backup copy) without disturbing the times that the user
33595 subsequently sees.
33596
33597 .vitem &%-timeout%&
33598 This must be followed by a number, which is a number of seconds; it sets a
33599 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
33600 default), a non-blocking call is used.
33601
33602 .vitem &%-v%&
33603 Generate verbose output.
33604 .endlist
33605
33606 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
33607 default is to create a lock file and also to use &[fcntl()]& locking on the
33608 mailbox, which is the same as Exim's default. The use of &%-flock%& or
33609 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
33610 requires that the directory containing the file be writeable. Locking by lock
33611 file does not last for ever; Exim assumes that a lock file is expired if it is
33612 more than 30 minutes old.
33613
33614 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
33615 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
33616 to be taken out on the open mailbox, and an exclusive lock on the file
33617 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
33618 number of the mailbox file. When the locking is released, if an exclusive lock
33619 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
33620
33621 The default output contains verification of the locking that takes place. The
33622 &%-v%& option causes some additional information to be given. The &%-q%& option
33623 suppresses all output except error messages.
33624
33625 A command such as
33626 .code
33627 exim_lock /var/spool/mail/spqr
33628 .endd
33629 runs an interactive shell while the file is locked, whereas
33630 .display
33631 &`exim_lock -q /var/spool/mail/spqr <<End`&
33632 <&'some commands'&>
33633 &`End`&
33634 .endd
33635 runs a specific non-interactive sequence of commands while the file is locked,
33636 suppressing all verification output. A single command can be run by a command
33637 such as
33638 .code
33639 exim_lock -q /var/spool/mail/spqr \
33640   "cp /var/spool/mail/spqr /some/where"
33641 .endd
33642 Note that if a command is supplied, it must be entirely contained within the
33643 second argument &-- hence the quotes.
33644 .ecindex IIDutils
33645
33646
33647 . ////////////////////////////////////////////////////////////////////////////
33648 . ////////////////////////////////////////////////////////////////////////////
33649
33650 .chapter "The Exim monitor" "CHAPeximon"
33651 .scindex IIDeximon "Exim monitor" "description"
33652 .cindex "X-windows"
33653 .cindex "&'eximon'&"
33654 .cindex "Local/eximon.conf"
33655 .cindex "&_exim_monitor/EDITME_&"
33656 The Exim monitor is an application which displays in an X window information
33657 about the state of Exim's queue and what Exim is doing. An admin user can
33658 perform certain operations on messages from this GUI interface; however all
33659 such facilities are also available from the command line, and indeed, the
33660 monitor itself makes use of the command line to perform any actions requested.
33661
33662
33663
33664 .section "Running the monitor" "SECID264"
33665 The monitor is started by running the script called &'eximon'&. This is a shell
33666 script that sets up a number of environment variables, and then runs the
33667 binary called &_eximon.bin_&. The default appearance of the monitor window can
33668 be changed by editing the &_Local/eximon.conf_& file created by editing
33669 &_exim_monitor/EDITME_&. Comments in that file describe what the various
33670 parameters are for.
33671
33672 The parameters that get built into the &'eximon'& script can be overridden for
33673 a particular invocation by setting up environment variables of the same names,
33674 preceded by &`EXIMON_`&. For example, a shell command such as
33675 .code
33676 EXIMON_LOG_DEPTH=400 eximon
33677 .endd
33678 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
33679 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
33680 overrides the Exim log file configuration. This makes it possible to have
33681 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
33682 syslog messages are routed to a file on the local host.
33683
33684 X resources can be used to change the appearance of the window in the normal
33685 way. For example, a resource setting of the form
33686 .code
33687 Eximon*background: gray94
33688 .endd
33689 changes the colour of the background to light grey rather than white. The
33690 stripcharts are drawn with both the data lines and the reference lines in
33691 black. This means that the reference lines are not visible when on top of the
33692 data. However, their colour can be changed by setting a resource called
33693 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
33694 For example, if your X server is running Unix, you could set up lighter
33695 reference lines in the stripcharts by obeying
33696 .code
33697 xrdb -merge <<End
33698 Eximon*highlight: gray
33699 End
33700 .endd
33701 .cindex "admin user"
33702 In order to see the contents of messages on the queue, and to operate on them,
33703 &'eximon'& must either be run as root or by an admin user.
33704
33705 The monitor's window is divided into three parts. The first contains one or
33706 more stripcharts and two action buttons, the second contains a &"tail"& of the
33707 main log file, and the third is a display of the queue of messages awaiting
33708 delivery, with two more action buttons. The following sections describe these
33709 different parts of the display.
33710
33711
33712
33713
33714 .section "The stripcharts" "SECID265"
33715 .cindex "stripchart"
33716 The first stripchart is always a count of messages on the queue. Its name can
33717 be configured by setting QUEUE_STRIPCHART_NAME in the
33718 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
33719 configuration script by regular expression matches on log file entries, making
33720 it possible to display, for example, counts of messages delivered to certain
33721 hosts or using certain transports. The supplied defaults display counts of
33722 received and delivered messages, and of local and SMTP deliveries. The default
33723 period between stripchart updates is one minute; this can be adjusted by a
33724 parameter in the &_Local/eximon.conf_& file.
33725
33726 The stripchart displays rescale themselves automatically as the value they are
33727 displaying changes. There are always 10 horizontal lines in each chart; the
33728 title string indicates the value of each division when it is greater than one.
33729 For example, &"x2"& means that each division represents a value of 2.
33730
33731 It is also possible to have a stripchart which shows the percentage fullness of
33732 a particular disk partition, which is useful when local deliveries are confined
33733 to a single partition.
33734
33735 .cindex "&%statvfs%& function"
33736 This relies on the availability of the &[statvfs()]& function or equivalent in
33737 the operating system. Most, but not all versions of Unix that support Exim have
33738 this. For this particular stripchart, the top of the chart always represents
33739 100%, and the scale is given as &"x10%"&. This chart is configured by setting
33740 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
33741 &_Local/eximon.conf_& file.
33742
33743
33744
33745
33746 .section "Main action buttons" "SECID266"
33747 .cindex "size" "of monitor window"
33748 .cindex "Exim monitor" "window size"
33749 .cindex "window size"
33750 Below the stripcharts there is an action button for quitting the monitor. Next
33751 to this is another button marked &"Size"&. They are placed here so that
33752 shrinking the window to its default minimum size leaves just the queue count
33753 stripchart and these two buttons visible. Pressing the &"Size"& button causes
33754 the window to expand to its maximum size, unless it is already at the maximum,
33755 in which case it is reduced to its minimum.
33756
33757 When expanding to the maximum, if the window cannot be fully seen where it
33758 currently is, it is moved back to where it was the last time it was at full
33759 size. When it is expanding from its minimum size, the old position is
33760 remembered, and next time it is reduced to the minimum it is moved back there.
33761
33762 The idea is that you can keep a reduced window just showing one or two
33763 stripcharts at a convenient place on your screen, easily expand it to show
33764 the full window when required, and just as easily put it back to what it was.
33765 The idea is copied from what the &'twm'& window manager does for its
33766 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
33767 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
33768
33769 Normally, the monitor starts up with the window at its full size, but it can be
33770 built so that it starts up with the window at its smallest size, by setting
33771 START_SMALL=yes in &_Local/eximon.conf_&.
33772
33773
33774
33775 .section "The log display" "SECID267"
33776 .cindex "log" "tail of; in monitor"
33777 The second section of the window is an area in which a display of the tail of
33778 the main log is maintained.
33779 To save space on the screen, the timestamp on each log line is shortened by
33780 removing the date and, if &%log_timezone%& is set, the timezone.
33781 The log tail is not available when the only destination for logging data is
33782 syslog, unless the syslog lines are routed to a local file whose name is passed
33783 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
33784
33785 The log sub-window has a scroll bar at its lefthand side which can be used to
33786 move back to look at earlier text, and the up and down arrow keys also have a
33787 scrolling effect. The amount of log that is kept depends on the setting of
33788 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
33789 to use. When this is full, the earlier 50% of data is discarded &-- this is
33790 much more efficient than throwing it away line by line. The sub-window also has
33791 a horizontal scroll bar for accessing the ends of long log lines. This is the
33792 only means of horizontal scrolling; the right and left arrow keys are not
33793 available. Text can be cut from this part of the window using the mouse in the
33794 normal way. The size of this subwindow is controlled by parameters in the
33795 configuration file &_Local/eximon.conf_&.
33796
33797 Searches of the text in the log window can be carried out by means of the ^R
33798 and ^S keystrokes, which default to a reverse and a forward search,
33799 respectively. The search covers only the text that is displayed in the window.
33800 It cannot go further back up the log.
33801
33802 The point from which the search starts is indicated by a caret marker. This is
33803 normally at the end of the text in the window, but can be positioned explicitly
33804 by pointing and clicking with the left mouse button, and is moved automatically
33805 by a successful search. If new text arrives in the window when it is scrolled
33806 back, the caret remains where it is, but if the window is not scrolled back,
33807 the caret is moved to the end of the new text.
33808
33809 Pressing ^R or ^S pops up a window into which the search text can be typed.
33810 There are buttons for selecting forward or reverse searching, for carrying out
33811 the search, and for cancelling. If the &"Search"& button is pressed, the search
33812 happens and the window remains so that further searches can be done. If the
33813 &"Return"& key is pressed, a single search is done and the window is closed. If
33814 ^C is typed the search is cancelled.
33815
33816 The searching facility is implemented using the facilities of the Athena text
33817 widget. By default this pops up a window containing both &"search"& and
33818 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
33819 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
33820 However, the linkers in BSDI and HP-UX seem unable to handle an externally
33821 provided version of &%TextPop%& when the remaining parts of the text widget
33822 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
33823 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
33824 on these systems, at the expense of having unwanted items in the search popup
33825 window.
33826
33827
33828
33829 .section "The queue display" "SECID268"
33830 .cindex "queue" "display in monitor"
33831 The bottom section of the monitor window contains a list of all messages that
33832 are on the queue, which includes those currently being received or delivered,
33833 as well as those awaiting delivery. The size of this subwindow is controlled by
33834 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
33835 at which it is updated is controlled by another parameter in the same file &--
33836 the default is 5 minutes, since queue scans can be quite expensive. However,
33837 there is an &"Update"& action button just above the display which can be used
33838 to force an update of the queue display at any time.
33839
33840 When a host is down for some time, a lot of pending mail can build up for it,
33841 and this can make it hard to deal with other messages on the queue. To help
33842 with this situation there is a button next to &"Update"& called &"Hide"&. If
33843 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
33844 type anything in here and press &"Return"&, the text is added to a chain of
33845 such texts, and if every undelivered address in a message matches at least one
33846 of the texts, the message is not displayed.
33847
33848 If there is an address that does not match any of the texts, all the addresses
33849 are displayed as normal. The matching happens on the ends of addresses so, for
33850 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
33851 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
33852 has been set up, a button called &"Unhide"& is displayed. If pressed, it
33853 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
33854 a hide request is automatically cancelled after one hour.
33855
33856 While the dialogue box is displayed, you can't press any buttons or do anything
33857 else to the monitor window. For this reason, if you want to cut text from the
33858 queue display to use in the dialogue box, you have to do the cutting before
33859 pressing the &"Hide"& button.
33860
33861 The queue display contains, for each unhidden queued message, the length of
33862 time it has been on the queue, the size of the message, the message id, the
33863 message sender, and the first undelivered recipient, all on one line. If it is
33864 a bounce message, the sender is shown as &"<>"&. If there is more than one
33865 recipient to which the message has not yet been delivered, subsequent ones are
33866 listed on additional lines, up to a maximum configured number, following which
33867 an ellipsis is displayed. Recipients that have already received the message are
33868 not shown.
33869
33870 .cindex "frozen messages" "display"
33871 If a message is frozen, an asterisk is displayed at the left-hand side.
33872
33873 The queue display has a vertical scroll bar, and can also be scrolled by means
33874 of the arrow keys. Text can be cut from it using the mouse in the normal way.
33875 The text searching facilities, as described above for the log window, are also
33876 available, but the caret is always moved to the end of the text when the queue
33877 display is updated.
33878
33879
33880
33881 .section "The queue menu" "SECID269"
33882 .cindex "queue" "menu in monitor"
33883 If the &%shift%& key is held down and the left button is clicked when the mouse
33884 pointer is over the text for any message, an action menu pops up, and the first
33885 line of the queue display for the message is highlighted. This does not affect
33886 any selected text.
33887
33888 If you want to use some other event for popping up the menu, you can set the
33889 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
33890 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
33891 value set in this parameter is a standard X event description. For example, to
33892 run eximon using &%ctrl%& rather than &%shift%& you could use
33893 .code
33894 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
33895 .endd
33896 The title of the menu is the message id, and it contains entries which act as
33897 follows:
33898
33899 .ilist
33900 &'message log'&: The contents of the message log for the message are displayed
33901 in a new text window.
33902 .next
33903 &'headers'&: Information from the spool file that contains the envelope
33904 information and headers is displayed in a new text window. See chapter
33905 &<<CHAPspool>>& for a description of the format of spool files.
33906 .next
33907 &'body'&: The contents of the spool file containing the body of the message are
33908 displayed in a new text window. There is a default limit of 20,000 bytes to the
33909 amount of data displayed. This can be changed by setting the BODY_MAX
33910 option at compile time, or the EXIMON_BODY_MAX option at run time.
33911 .next
33912 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
33913 delivery of the message. This causes an automatic thaw if the message is
33914 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
33915 a new text window. The delivery is run in a separate process, to avoid holding
33916 up the monitor while the delivery proceeds.
33917 .next
33918 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
33919 that the message be frozen.
33920 .next
33921 .cindex "thawing messages"
33922 .cindex "unfreezing messages"
33923 .cindex "frozen messages" "thawing"
33924 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
33925 that the message be thawed.
33926 .next
33927 .cindex "delivery" "forcing failure"
33928 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
33929 that Exim gives up trying to deliver the message. A bounce message is generated
33930 for any remaining undelivered addresses.
33931 .next
33932 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
33933 that the message be deleted from the system without generating a bounce
33934 message.
33935 .next
33936 &'add recipient'&: A dialog box is displayed into which a recipient address can
33937 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
33938 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
33939 Otherwise it must be entered as a fully qualified address. Pressing RETURN
33940 causes a call to Exim to be made using the &%-Mar%& option to request that an
33941 additional recipient be added to the message, unless the entry box is empty, in
33942 which case no action is taken.
33943 .next
33944 &'mark delivered'&: A dialog box is displayed into which a recipient address
33945 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
33946 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
33947 Otherwise it must be entered as a fully qualified address. Pressing RETURN
33948 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
33949 recipient address as already delivered, unless the entry box is empty, in which
33950 case no action is taken.
33951 .next
33952 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
33953 mark all recipient addresses as already delivered.
33954 .next
33955 &'edit sender'&: A dialog box is displayed initialized with the current
33956 sender's address. Pressing RETURN causes a call to Exim to be made using the
33957 &%-Mes%& option to replace the sender address, unless the entry box is empty,
33958 in which case no action is taken. If you want to set an empty sender (as in
33959 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
33960 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
33961 the address is qualified with that domain.
33962 .endlist
33963
33964 When a delivery is forced, a window showing the &%-v%& output is displayed. In
33965 other cases when a call to Exim is made, if there is any output from Exim (in
33966 particular, if the command fails) a window containing the command and the
33967 output is displayed. Otherwise, the results of the action are normally apparent
33968 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
33969 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
33970 if no output is generated.
33971
33972 The queue display is automatically updated for actions such as freezing and
33973 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
33974 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
33975 force an update of the display after one of these actions.
33976
33977 In any text window that is displayed as result of a menu action, the normal
33978 cut-and-paste facility is available, and searching can be carried out using ^R
33979 and ^S, as described above for the log tail window.
33980 .ecindex IIDeximon
33981
33982
33983
33984
33985
33986 . ////////////////////////////////////////////////////////////////////////////
33987 . ////////////////////////////////////////////////////////////////////////////
33988
33989 .chapter "Security considerations" "CHAPsecurity"
33990 .scindex IIDsecurcon "security" "discussion of"
33991 This chapter discusses a number of issues concerned with security, some of
33992 which are also covered in other parts of this manual.
33993
33994 For reasons that this author does not understand, some people have promoted
33995 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
33996 existence of this chapter in the documentation. However, the intent of the
33997 chapter is simply to describe the way Exim works in relation to certain
33998 security concerns, not to make any specific claims about the effectiveness of
33999 its security as compared with other MTAs.
34000
34001 What follows is a description of the way Exim is supposed to be. Best efforts
34002 have been made to try to ensure that the code agrees with the theory, but an
34003 absence of bugs can never be guaranteed. Any that are reported will get fixed
34004 as soon as possible.
34005
34006
34007 .section "Building a more &""hardened""& Exim" "SECID286"
34008 .cindex "security" "build-time features"
34009 There are a number of build-time options that can be set in &_Local/Makefile_&
34010 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
34011 Exim administrator who does not have the root password, or by someone who has
34012 penetrated the Exim (but not the root) account. These options are as follows:
34013
34014 .ilist
34015 ALT_CONFIG_PREFIX can be set to a string that is required to match the
34016 start of any file names used with the &%-C%& option. When it is set, these file
34017 names are also not allowed to contain the sequence &"/../"&. (However, if the
34018 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
34019 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
34020 default setting for &%ALT_CONFIG_PREFIX%&.
34021
34022 .new
34023 If the permitted configuration files are confined to a directory to
34024 which only root has access, this guards against someone who has broken
34025 into the Exim account from running a privileged Exim with an arbitrary
34026 configuration file, and using it to break into other accounts.
34027 .next
34028
34029 If a non-trusted configuration file (i.e. not the default configuration file
34030 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
34031 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
34032 the next item), then root privilege is retained only if the caller of Exim is
34033 root. This locks out the possibility of testing a configuration using &%-C%&
34034 right through message reception and delivery, even if the caller is root. The
34035 reception works, but by that time, Exim is running as the Exim user, so when
34036 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
34037 privilege to be lost. However, root can test reception and delivery using two
34038 separate commands.
34039
34040 .next
34041 The WHITELIST_D_MACROS build option declares some macros to be safe to override
34042 with &%-D%& if the real uid is one of root, the Exim run-time user or the
34043 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
34044 requiring the run-time value supplied to &%-D%& to match a regex that errs on
34045 the restrictive side.  Requiring build-time selection of safe macros is onerous
34046 but this option is intended solely as a transition mechanism to permit
34047 previously-working configurations to continue to work after release 4.73.
34048 .next
34049 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
34050 is disabled.
34051 .next
34052 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
34053 never to be used for any deliveries. This is like the &%never_users%& runtime
34054 option, but it cannot be overridden; the runtime option adds additional users
34055 to the list. The default setting is &"root"&; this prevents a non-root user who
34056 is permitted to modify the runtime file from using Exim as a way to get root.
34057 .endlist
34058 .wen
34059
34060
34061
34062 .section "Root privilege" "SECID270"
34063 .cindex "setuid"
34064 .cindex "root privilege"
34065 The Exim binary is normally setuid to root, which means that it gains root
34066 privilege (runs as root) when it starts execution. In some special cases (for
34067 example, when the daemon is not in use and there are no local deliveries), it
34068 may be possible to run Exim setuid to some user other than root. This is
34069 discussed in the next section. However, in most installations, root privilege
34070 is required for two things:
34071
34072 .ilist
34073 To set up a socket connected to the standard SMTP port (25) when initialising
34074 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
34075 not required.
34076 .next
34077 To be able to change uid and gid in order to read users' &_.forward_& files and
34078 perform local deliveries as the receiving user or as specified in the
34079 configuration.
34080 .endlist
34081
34082 It is not necessary to be root to do any of the other things Exim does, such as
34083 receiving messages and delivering them externally over SMTP, and it is
34084 obviously more secure if Exim does not run as root except when necessary.
34085 For this reason, a user and group for Exim to use must be defined in
34086 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
34087 group"&. Their values can be changed by the run time configuration, though this
34088 is not recommended. Often a user called &'exim'& is used, but some sites use
34089 &'mail'& or another user name altogether.
34090
34091 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
34092 abdication; the process cannot regain root afterwards. Prior to release 4.00,
34093 &[seteuid()]& was used in some circumstances, but this is no longer the case.
34094
34095 After a new Exim process has interpreted its command line options, it changes
34096 uid and gid in the following cases:
34097
34098 .new
34099 .ilist
34100 .oindex "&%-C%&"
34101 .oindex "&%-D%&"
34102 If the &%-C%& option is used to specify an alternate configuration file, or if
34103 the &%-D%& option is used to define macro values for the configuration, and the
34104 calling process is not running as root, the uid and gid are changed to those of
34105 the calling process.
34106 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
34107 option may not be used at all.
34108 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
34109 can be supplied if the calling process is running as root, the Exim run-time
34110 user or CONFIGURE_OWNER, if defined.
34111 .next
34112 .oindex "&%-be%&"
34113 .oindex "&%-bf%&"
34114 .oindex "&%-bF%&"
34115 If the expansion test option (&%-be%&) or one of the filter testing options
34116 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
34117 calling process.
34118 .next
34119 If the process is not a daemon process or a queue runner process or a delivery
34120 process or a process for testing address routing (started with &%-bt%&), the
34121 uid and gid are changed to the Exim user and group. This means that Exim always
34122 runs under its own uid and gid when receiving messages. This also applies when
34123 testing address verification
34124 .oindex "&%-bv%&"
34125 .oindex "&%-bh%&"
34126 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
34127 option).
34128 .next
34129 For a daemon, queue runner, delivery, or address testing process, the uid
34130 remains as root at this stage, but the gid is changed to the Exim group.
34131 .endlist
34132 .wen
34133 The processes that initially retain root privilege behave as follows:
34134
34135 .ilist
34136 A daemon process changes the gid to the Exim group and the uid to the Exim
34137 user after setting up one or more listening sockets. The &[initgroups()]&
34138 function is called, so that if the Exim user is in any additional groups, they
34139 will be used during message reception.
34140 .next
34141 A queue runner process retains root privilege throughout its execution. Its
34142 job is to fork a controlled sequence of delivery processes.
34143 .next
34144 A delivery process retains root privilege throughout most of its execution,
34145 but any actual deliveries (that is, the transports themselves) are run in
34146 subprocesses which always change to a non-root uid and gid. For local
34147 deliveries this is typically the uid and gid of the owner of the mailbox; for
34148 remote deliveries, the Exim uid and gid are used. Once all the delivery
34149 subprocesses have been run, a delivery process changes to the Exim uid and gid
34150 while doing post-delivery tidying up such as updating the retry database and
34151 generating bounce and warning messages.
34152
34153 While the recipient addresses in a message are being routed, the delivery
34154 process runs as root. However, if a user's filter file has to be processed,
34155 this is done in a subprocess that runs under the individual user's uid and
34156 gid. A system filter is run as root unless &%system_filter_user%& is set.
34157 .next
34158 A process that is testing addresses (the &%-bt%& option) runs as root so that
34159 the routing is done in the same environment as a message delivery.
34160 .endlist
34161
34162
34163
34164
34165 .section "Running Exim without privilege" "SECTrunexiwitpri"
34166 .cindex "privilege, running without"
34167 .cindex "unprivileged running"
34168 .cindex "root privilege" "running without"
34169 Some installations like to run Exim in an unprivileged state for more of its
34170 operation, for added security. Support for this mode of operation is provided
34171 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
34172 gid are changed to the Exim user and group at the start of a delivery process
34173 (and also queue runner and address testing processes). This means that address
34174 routing is no longer run as root, and the deliveries themselves cannot change
34175 to any other uid.
34176
34177 .cindex SIGHUP
34178 .cindex "daemon" "restarting"
34179 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
34180 that the daemon can still be started in the usual way, and it can respond
34181 correctly to SIGHUP because the re-invocation regains root privilege.
34182
34183 An alternative approach is to make Exim setuid to the Exim user and also setgid
34184 to the Exim group. If you do this, the daemon must be started from a root
34185 process. (Calling Exim from a root process makes it behave in the way it does
34186 when it is setuid root.) However, the daemon cannot restart itself after a
34187 SIGHUP signal because it cannot regain privilege.
34188
34189 It is still useful to set &%deliver_drop_privilege%& in this case, because it
34190 stops Exim from trying to re-invoke itself to do a delivery after a message has
34191 been received. Such a re-invocation is a waste of resources because it has no
34192 effect.
34193
34194 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
34195 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
34196 to the Exim user seems a clean approach, but there is one complication:
34197
34198 In this style of operation, Exim is running with the real uid and gid set to
34199 those of the calling process, and the effective uid/gid set to Exim's values.
34200 Ideally, any association with the calling process' uid/gid should be dropped,
34201 that is, the real uid/gid should be reset to the effective values so as to
34202 discard any privileges that the caller may have. While some operating systems
34203 have a function that permits this action for a non-root effective uid, quite a
34204 number of them do not. Because of this lack of standardization, Exim does not
34205 address this problem at this time.
34206
34207 For this reason, the recommended approach for &"mostly unprivileged"& running
34208 is to keep the Exim binary setuid to root, and to set
34209 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
34210 be used in the most straightforward way.
34211
34212 If you configure Exim not to run delivery processes as root, there are a
34213 number of restrictions on what you can do:
34214
34215 .ilist
34216 You can deliver only as the Exim user/group. You should  explicitly use the
34217 &%user%& and &%group%& options to override routers or local transports that
34218 normally deliver as the recipient. This makes sure that configurations that
34219 work in this mode function the same way in normal mode. Any implicit or
34220 explicit specification of another user causes an error.
34221 .next
34222 Use of &_.forward_& files is severely restricted, such that it is usually
34223 not worthwhile to include them in the configuration.
34224 .next
34225 Users who wish to use &_.forward_& would have to make their home directory and
34226 the file itself accessible to the Exim user. Pipe and append-to-file entries,
34227 and their equivalents in Exim filters, cannot be used. While they could be
34228 enabled in the Exim user's name, that would be insecure and not very useful.
34229 .next
34230 Unless the local user mailboxes are all owned by the Exim user (possible in
34231 some POP3 or IMAP-only environments):
34232
34233 .olist
34234 They must be owned by the Exim group and be writeable by that group. This
34235 implies you must set &%mode%& in the appendfile configuration, as well as the
34236 mode of the mailbox files themselves.
34237 .next
34238 You must set &%no_check_owner%&, since most or all of the files will not be
34239 owned by the Exim user.
34240 .next
34241 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
34242 on a newly created mailbox when unprivileged. This also implies that new
34243 mailboxes need to be created manually.
34244 .endlist olist
34245 .endlist ilist
34246
34247
34248 These restrictions severely restrict what can be done in local deliveries.
34249 However, there are no restrictions on remote deliveries. If you are running a
34250 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
34251 gives more security at essentially no cost.
34252
34253 If you are using the &%mua_wrapper%& facility (see chapter
34254 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
34255
34256
34257
34258
34259 .section "Delivering to local files" "SECID271"
34260 Full details of the checks applied by &(appendfile)& before it writes to a file
34261 are given in chapter &<<CHAPappendfile>>&.
34262
34263
34264
34265 .section "IPv4 source routing" "SECID272"
34266 .cindex "source routing" "in IP packets"
34267 .cindex "IP source routing"
34268 Many operating systems suppress IP source-routed packets in the kernel, but
34269 some cannot be made to do this, so Exim does its own check. It logs incoming
34270 IPv4 source-routed TCP calls, and then drops them. Things are all different in
34271 IPv6. No special checking is currently done.
34272
34273
34274
34275 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
34276 Support for these SMTP commands is disabled by default. If required, they can
34277 be enabled by defining suitable ACLs.
34278
34279
34280
34281
34282 .section "Privileged users" "SECID274"
34283 .cindex "trusted users"
34284 .cindex "admin user"
34285 .cindex "privileged user"
34286 .cindex "user" "trusted"
34287 .cindex "user" "admin"
34288 Exim recognizes two sets of users with special privileges. Trusted users are
34289 able to submit new messages to Exim locally, but supply their own sender
34290 addresses and information about a sending host. For other users submitting
34291 local messages, Exim sets up the sender address from the uid, and doesn't
34292 permit a remote host to be specified.
34293
34294 .oindex "&%-f%&"
34295 However, an untrusted user is permitted to use the &%-f%& command line option
34296 in the special form &%-f <>%& to indicate that a delivery failure for the
34297 message should not cause an error report. This affects the message's envelope,
34298 but it does not affect the &'Sender:'& header. Untrusted users may also be
34299 permitted to use specific forms of address with the &%-f%& option by setting
34300 the &%untrusted_set_sender%& option.
34301
34302 Trusted users are used to run processes that receive mail messages from some
34303 other mail domain and pass them on to Exim for delivery either locally, or over
34304 the Internet. Exim trusts a caller that is running as root, as the Exim user,
34305 as any user listed in the &%trusted_users%& configuration option, or under any
34306 group listed in the &%trusted_groups%& option.
34307
34308 Admin users are permitted to do things to the messages on Exim's queue. They
34309 can freeze or thaw messages, cause them to be returned to their senders, remove
34310 them entirely, or modify them in various ways. In addition, admin users can run
34311 the Exim monitor and see all the information it is capable of providing, which
34312 includes the contents of files on the spool.
34313
34314 .oindex "&%-M%&"
34315 .oindex "&%-q%&"
34316 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
34317 delivery of messages on its queue is restricted to admin users. This
34318 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
34319 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
34320 queue is also restricted to admin users. This restriction can be relaxed by
34321 setting &%no_queue_list_requires_admin%&.
34322
34323 Exim recognizes an admin user if the calling process is running as root or as
34324 the Exim user or if any of the groups associated with the calling process is
34325 the Exim group. It is not necessary actually to be running under the Exim
34326 group. However, if admin users who are not root or the Exim user are to access
34327 the contents of files on the spool via the Exim monitor (which runs
34328 unprivileged), Exim must be built to allow group read access to its spool
34329 files.
34330
34331
34332
34333 .section "Spool files" "SECID275"
34334 .cindex "spool directory" "files"
34335 Exim's spool directory and everything it contains is owned by the Exim user and
34336 set to the Exim group. The mode for spool files is defined in the
34337 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
34338 any user who is a member of the Exim group can access these files.
34339
34340
34341
34342 .section "Use of argv[0]" "SECID276"
34343 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
34344 of specific strings, Exim assumes certain options. For example, calling Exim
34345 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
34346 to calling it with the option &%-bS%&. There are no security implications in
34347 this.
34348
34349
34350
34351 .section "Use of %f formatting" "SECID277"
34352 The only use made of &"%f"& by Exim is in formatting load average values. These
34353 are actually stored in integer variables as 1000 times the load average.
34354 Consequently, their range is limited and so therefore is the length of the
34355 converted output.
34356
34357
34358
34359 .section "Embedded Exim path" "SECID278"
34360 Exim uses its own path name, which is embedded in the code, only when it needs
34361 to re-exec in order to regain root privilege. Therefore, it is not root when it
34362 does so. If some bug allowed the path to get overwritten, it would lead to an
34363 arbitrary program's being run as exim, not as root.
34364
34365
34366
34367 .new
34368 .section "Dynamic module directory" "SECTdynmoddir"
34369 Any dynamically loadable modules must be installed into the directory
34370 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
34371 loading it.
34372 .wen
34373
34374
34375 .section "Use of sprintf()" "SECID279"
34376 .cindex "&[sprintf()]&"
34377 A large number of occurrences of &"sprintf"& in the code are actually calls to
34378 &'string_sprintf()'&, a function that returns the result in malloc'd store.
34379 The intermediate formatting is done into a large fixed buffer by a function
34380 that runs through the format string itself, and checks the length of each
34381 conversion before performing it, thus preventing buffer overruns.
34382
34383 The remaining uses of &[sprintf()]& happen in controlled circumstances where
34384 the output buffer is known to be sufficiently long to contain the converted
34385 string.
34386
34387
34388
34389 .section "Use of debug_printf() and log_write()" "SECID280"
34390 Arbitrary strings are passed to both these functions, but they do their
34391 formatting by calling the function &'string_vformat()'&, which runs through
34392 the format string itself, and checks the length of each conversion.
34393
34394
34395
34396 .section "Use of strcat() and strcpy()" "SECID281"
34397 These are used only in cases where the output buffer is known to be large
34398 enough to hold the result.
34399 .ecindex IIDsecurcon
34400
34401
34402
34403
34404 . ////////////////////////////////////////////////////////////////////////////
34405 . ////////////////////////////////////////////////////////////////////////////
34406
34407 .chapter "Format of spool files" "CHAPspool"
34408 .scindex IIDforspo1 "format" "spool files"
34409 .scindex IIDforspo2 "spool directory" "format of files"
34410 .scindex IIDforspo3 "spool files" "format of"
34411 .cindex "spool files" "editing"
34412 A message on Exim's queue consists of two files, whose names are the message id
34413 followed by -D and -H, respectively. The data portion of the message is kept in
34414 the -D file on its own. The message's envelope, status, and headers are all
34415 kept in the -H file, whose format is described in this chapter. Each of these
34416 two files contains the final component of its own name as its first line. This
34417 is insurance against disk crashes where the directory is lost but the files
34418 themselves are recoverable.
34419
34420 Some people are tempted into editing -D files in order to modify messages. You
34421 need to be extremely careful if you do this; it is not recommended and you are
34422 on your own if you do it. Here are some of the pitfalls:
34423
34424 .ilist
34425 You must ensure that Exim does not try to deliver the message while you are
34426 fiddling with it. The safest way is to take out a write lock on the -D file,
34427 which is what Exim itself does, using &[fcntl()]&. If you update the file in
34428 place, the lock will be retained. If you write a new file and rename it, the
34429 lock will be lost at the instant of rename.
34430 .next
34431 .vindex "&$body_linecount$&"
34432 If you change the number of lines in the file, the value of
34433 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
34434 present, this value is not used by Exim, but there is no guarantee that this
34435 will always be the case.
34436 .next
34437 If the message is in MIME format, you must take care not to break it.
34438 .next
34439 If the message is cryptographically signed, any change will invalidate the
34440 signature.
34441 .endlist
34442 All in all, modifying -D files is fraught with danger.
34443
34444 Files whose names end with -J may also be seen in the &_input_& directory (or
34445 its subdirectories when &%split_spool_directory%& is set). These are journal
34446 files, used to record addresses to which the message has been delivered during
34447 the course of a delivery attempt. If there are still undelivered recipients at
34448 the end, the -H file is updated, and the -J file is deleted. If, however, there
34449 is some kind of crash (for example, a power outage) before this happens, the -J
34450 file remains in existence. When Exim next processes the message, it notices the
34451 -J file and uses it to update the -H file before starting the next delivery
34452 attempt.
34453
34454 .section "Format of the -H file" "SECID282"
34455 .cindex "uid (user id)" "in spool file"
34456 .cindex "gid (group id)" "in spool file"
34457 The second line of the -H file contains the login name for the uid of the
34458 process that called Exim to read the message, followed by the numerical uid and
34459 gid. For a locally generated message, this is normally the user who sent the
34460 message. For a message received over TCP/IP via the daemon, it is
34461 normally the Exim user.
34462
34463 The third line of the file contains the address of the message's sender as
34464 transmitted in the envelope, contained in angle brackets. The sender address is
34465 empty for bounce messages. For incoming SMTP mail, the sender address is given
34466 in the MAIL command. For locally generated mail, the sender address is
34467 created by Exim from the login name of the current user and the configured
34468 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
34469 leading &"From&~"& line if the caller is trusted, or if the supplied address is
34470 &"<>"& or an address that matches &%untrusted_set_senders%&.
34471
34472 The fourth line contains two numbers. The first is the time that the message
34473 was received, in the conventional Unix form &-- the number of seconds since the
34474 start of the epoch. The second number is a count of the number of messages
34475 warning of delayed delivery that have been sent to the sender.
34476
34477 There follow a number of lines starting with a hyphen. These can appear in any
34478 order, and are omitted when not relevant:
34479
34480 .vlist
34481 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
34482 This item is obsolete, and is not generated from Exim release 4.61 onwards;
34483 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
34484 recognized, to provide backward compatibility. In the old format, a line of
34485 this form is present for every ACL variable that is not empty. The number
34486 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
34487 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
34488 the data string for the variable. The string itself starts at the beginning of
34489 the next line, and is followed by a newline character. It may contain internal
34490 newlines.
34491
34492 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
34493 A line of this form is present for every ACL connection variable that is
34494 defined. Note that there is a space between &%-aclc%& and the rest of the name.
34495 The length is the length of the data string for the variable. The string itself
34496 starts at the beginning of the next line, and is followed by a newline
34497 character. It may contain internal newlines.
34498
34499 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
34500 A line of this form is present for every ACL message variable that is defined.
34501 Note that there is a space between &%-aclm%& and the rest of the name. The
34502 length is the length of the data string for the variable. The string itself
34503 starts at the beginning of the next line, and is followed by a newline
34504 character. It may contain internal newlines.
34505
34506 .vitem "&%-active_hostname%&&~<&'hostname'&>"
34507 This is present if, when the message was received over SMTP, the value of
34508 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
34509
34510 .vitem &%-allow_unqualified_recipient%&
34511 This is present if unqualified recipient addresses are permitted in header
34512 lines (to stop such addresses from being qualified if rewriting occurs at
34513 transport time). Local messages that were input using &%-bnq%& and remote
34514 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
34515
34516 .vitem &%-allow_unqualified_sender%&
34517 This is present if unqualified sender addresses are permitted in header lines
34518 (to stop such addresses from being qualified if rewriting occurs at transport
34519 time). Local messages that were input using &%-bnq%& and remote messages from
34520 hosts that match &%sender_unqualified_hosts%& set this flag.
34521
34522 .vitem "&%-auth_id%&&~<&'text'&>"
34523 The id information for a message received on an authenticated SMTP connection
34524 &-- the value of the &$authenticated_id$& variable.
34525
34526 .vitem "&%-auth_sender%&&~<&'address'&>"
34527 The address of an authenticated sender &-- the value of the
34528 &$authenticated_sender$& variable.
34529
34530 .vitem "&%-body_linecount%&&~<&'number'&>"
34531 This records the number of lines in the body of the message, and is always
34532 present.
34533
34534 .vitem "&%-body_zerocount%&&~<&'number'&>"
34535 This records the number of binary zero bytes in the body of the message, and is
34536 present if the number is greater than zero.
34537
34538 .vitem &%-deliver_firsttime%&
34539 This is written when a new message is first added to the spool. When the spool
34540 file is updated after a deferral, it is omitted.
34541
34542 .vitem "&%-frozen%&&~<&'time'&>"
34543 .cindex "frozen messages" "spool data"
34544 The message is frozen, and the freezing happened at <&'time'&>.
34545
34546 .vitem "&%-helo_name%&&~<&'text'&>"
34547 This records the host name as specified by a remote host in a HELO or EHLO
34548 command.
34549
34550 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
34551 This records the IP address of the host from which the message was received and
34552 the remote port number that was used. It is omitted for locally generated
34553 messages.
34554
34555 .vitem "&%-host_auth%&&~<&'text'&>"
34556 If the message was received on an authenticated SMTP connection, this records
34557 the name of the authenticator &-- the value of the
34558 &$sender_host_authenticated$& variable.
34559
34560 .vitem &%-host_lookup_failed%&
34561 This is present if an attempt to look up the sending host's name from its IP
34562 address failed. It corresponds to the &$host_lookup_failed$& variable.
34563
34564 .vitem "&%-host_name%&&~<&'text'&>"
34565 .cindex "reverse DNS lookup"
34566 .cindex "DNS" "reverse lookup"
34567 This records the name of the remote host from which the message was received,
34568 if the host name was looked up from the IP address when the message was being
34569 received. It is not present if no reverse lookup was done.
34570
34571 .vitem "&%-ident%&&~<&'text'&>"
34572 For locally submitted messages, this records the login of the originating user,
34573 unless it was a trusted user and the &%-oMt%& option was used to specify an
34574 ident value. For messages received over TCP/IP, this records the ident string
34575 supplied by the remote host, if any.
34576
34577 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
34578 This records the IP address of the local interface and the port number through
34579 which a message was received from a remote host. It is omitted for locally
34580 generated messages.
34581
34582 .vitem &%-local%&
34583 The message is from a local sender.
34584
34585 .vitem &%-localerror%&
34586 The message is a locally-generated bounce message.
34587
34588 .vitem "&%-local_scan%&&~<&'string'&>"
34589 This records the data string that was returned by the &[local_scan()]& function
34590 when the message was received &-- the value of the &$local_scan_data$&
34591 variable. It is omitted if no data was returned.
34592
34593 .vitem &%-manual_thaw%&
34594 The message was frozen but has been thawed manually, that is, by an explicit
34595 Exim command rather than via the auto-thaw process.
34596
34597 .vitem &%-N%&
34598 A testing delivery process was started using the &%-N%& option to suppress any
34599 actual deliveries, but delivery was deferred. At any further delivery attempts,
34600 &%-N%& is assumed.
34601
34602 .vitem &%-received_protocol%&
34603 This records the value of the &$received_protocol$& variable, which contains
34604 the name of the protocol by which the message was received.
34605
34606 .vitem &%-sender_set_untrusted%&
34607 The envelope sender of this message was set by an untrusted local caller (used
34608 to ensure that the caller is displayed in queue listings).
34609
34610 .vitem "&%-spam_score_int%&&~<&'number'&>"
34611 If a message was scanned by SpamAssassin, this is present. It records the value
34612 of &$spam_score_int$&.
34613
34614 .vitem &%-tls_certificate_verified%&
34615 A TLS certificate was received from the client that sent this message, and the
34616 certificate was verified by the server.
34617
34618 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
34619 When the message was received over an encrypted connection, this records the
34620 name of the cipher suite that was used.
34621
34622 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
34623 When the message was received over an encrypted connection, and a certificate
34624 was received from the client, this records the Distinguished Name from that
34625 certificate.
34626 .endlist
34627
34628 Following the options there is a list of those addresses to which the message
34629 is not to be delivered. This set of addresses is initialized from the command
34630 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
34631 is set; otherwise it starts out empty. Whenever a successful delivery is made,
34632 the address is added to this set. The addresses are kept internally as a
34633 balanced binary tree, and it is a representation of that tree which is written
34634 to the spool file. If an address is expanded via an alias or forward file, the
34635 original address is added to the tree when deliveries to all its child
34636 addresses are complete.
34637
34638 If the tree is empty, there is a single line in the spool file containing just
34639 the text &"XX"&. Otherwise, each line consists of two letters, which are either
34640 Y or N, followed by an address. The address is the value for the node of the
34641 tree, and the letters indicate whether the node has a left branch and/or a
34642 right branch attached to it, respectively. If branches exist, they immediately
34643 follow. Here is an example of a three-node tree:
34644 .code
34645 YY darcy@austen.fict.example
34646 NN alice@wonderland.fict.example
34647 NN editor@thesaurus.ref.example
34648 .endd
34649 After the non-recipients tree, there is a list of the message's recipients.
34650 This is a simple list, preceded by a count. It includes all the original
34651 recipients of the message, including those to whom the message has already been
34652 delivered. In the simplest case, the list contains one address per line. For
34653 example:
34654 .code
34655 4
34656 editor@thesaurus.ref.example
34657 darcy@austen.fict.example
34658 rdo@foundation
34659 alice@wonderland.fict.example
34660 .endd
34661 However, when a child address has been added to the top-level addresses as a
34662 result of the use of the &%one_time%& option on a &(redirect)& router, each
34663 line is of the following form:
34664 .display
34665 <&'top-level address'&> <&'errors_to address'&> &&&
34666   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
34667 .endd
34668 The 01 flag bit indicates the presence of the three other fields that follow
34669 the top-level address. Other bits may be used in future to support additional
34670 fields. The <&'parent number'&> is the offset in the recipients list of the
34671 original parent of the &"one time"& address. The first two fields are the
34672 envelope sender that is associated with this address and its length. If the
34673 length is zero, there is no special envelope sender (there are then two space
34674 characters in the line). A non-empty field can arise from a &(redirect)& router
34675 that has an &%errors_to%& setting.
34676
34677
34678 A blank line separates the envelope and status information from the headers
34679 which follow. A header may occupy several lines of the file, and to save effort
34680 when reading it in, each header is preceded by a number and an identifying
34681 character. The number is the number of characters in the header, including any
34682 embedded newlines and the terminating newline. The character is one of the
34683 following:
34684
34685 .table2 50pt
34686 .row <&'blank'&>         "header in which Exim has no special interest"
34687 .row &`B`&               "&'Bcc:'& header"
34688 .row &`C`&               "&'Cc:'& header"
34689 .row &`F`&               "&'From:'& header"
34690 .row &`I`&               "&'Message-id:'& header"
34691 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
34692 .row &`R`&               "&'Reply-To:'& header"
34693 .row &`S`&               "&'Sender:'& header"
34694 .row &`T`&               "&'To:'& header"
34695 .row &`*`&               "replaced or deleted header"
34696 .endtable
34697
34698 Deleted or replaced (rewritten) headers remain in the spool file for debugging
34699 purposes. They are not transmitted when the message is delivered. Here is a
34700 typical set of headers:
34701 .code
34702 111P Received: by hobbit.fict.example with local (Exim 4.00)
34703 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
34704 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
34705 038* X-rewrote-sender: bb@hobbit.fict.example
34706 042* From: Bilbo Baggins <bb@hobbit.fict.example>
34707 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
34708 099* To: alice@wonderland.fict.example, rdo@foundation,
34709 darcy@austen.fict.example, editor@thesaurus.ref.example
34710 104T To: alice@wonderland.fict.example, rdo@foundation.example,
34711 darcy@austen.fict.example, editor@thesaurus.ref.example
34712 038  Date: Fri, 11 May 2001 10:28:59 +0100
34713 .endd
34714 The asterisked headers indicate that the envelope sender, &'From:'& header, and
34715 &'To:'& header have been rewritten, the last one because routing expanded the
34716 unqualified domain &'foundation'&.
34717 .ecindex IIDforspo1
34718 .ecindex IIDforspo2
34719 .ecindex IIDforspo3
34720
34721 . ////////////////////////////////////////////////////////////////////////////
34722 . ////////////////////////////////////////////////////////////////////////////
34723
34724 .chapter "Support for DKIM (DomainKeys Identified Mail) - RFC4871" "CHID12" &&&
34725          "DKIM Support"
34726 .cindex "DKIM"
34727
34728 Since version 4.70, DKIM support is compiled into Exim by default. It can be
34729 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
34730
34731 .new
34732 Exim's DKIM implementation allows to
34733 .olist
34734 Sign outgoing messages: This function is implemented in the SMTP transport.
34735 It can co-exist with all other Exim features, including transport filters.
34736 .next
34737 Verify signatures in incoming messages: This is implemented by an additional
34738 ACL (acl_smtp_dkim), which can be called several times per message, with
34739 different signature contexts.
34740 .endlist
34741 .wen
34742 In typical Exim style, the verification implementation does not include any
34743 default "policy". Instead it enables you to build your own policy using
34744 Exim's standard controls.
34745
34746 Please note that verification of DKIM signatures in incoming mail is turned
34747 on by default for logging purposes. For each signature in incoming email,
34748 exim will log a line displaying the most important signature details, and the
34749 signature status. Here is an example:
34750 .code
34751 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]
34752 .endd
34753 You might want to turn off DKIM verification processing entirely for internal
34754 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
34755 control modifier. This should typically be done in the RCPT ACL, at points
34756 where you accept mail from relay sources (internal hosts or authenticated
34757 senders).
34758
34759
34760 .section "Signing outgoing messages" "SECID513"
34761 .cindex "DKIM" "signing"
34762
34763 Signing is implemented by setting private options on the SMTP transport.
34764 These options take (expandable) strings as arguments.
34765
34766 .new
34767 .option dkim_domain smtp string&!! unset
34768 MANDATORY:
34769 The domain you want to sign with. The result of this expanded
34770 option is put into the &%$dkim_domain%& expansion variable.
34771
34772 .option dkim_selector smtp string&!! unset
34773 MANDATORY:
34774 This sets the key selector string. You can use the &%$dkim_domain%& expansion
34775 variable to look up a matching selector. The result is put in the expansion
34776 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
34777 option along with &%$dkim_domain%&.
34778
34779 .option dkim_private_key smtp string&!! unset
34780 MANDATORY:
34781 This sets the private key to use. You can use the &%$dkim_domain%& and
34782 &%$dkim_selector%& expansion variables to determine the private key to use.
34783 The result can either
34784 .ilist
34785 be a valid RSA private key in ASCII armor, including line breaks.
34786 .next
34787 start with a slash, in which case it is treated as a file that contains
34788 the private key.
34789 .next
34790 be "0", "false" or the empty string, in which case the message will not
34791 be signed. This case will not result in an error, even if &%dkim_strict%&
34792 is set.
34793 .endlist
34794
34795 .option dkim_canon smtp string&!! unset
34796 OPTIONAL:
34797 This option sets the canonicalization method used when signing a message.
34798 The DKIM RFC currently supports two methods: "simple" and "relaxed".
34799 The option defaults to "relaxed" when unset. Note: the current implementation
34800 only supports using the same canonicalization method for both headers and body.
34801
34802 .option dkim_strict smtp string&!! unset
34803 OPTIONAL:
34804 This  option  defines  how  Exim  behaves  when  signing a message that
34805 should be signed fails for some reason.  When the expansion evaluates to
34806 either "1" or "true", Exim will defer. Otherwise Exim will send the message
34807 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
34808 variables here.
34809
34810 .option dkim_sign_headers smtp string&!! unset
34811 OPTIONAL:
34812 When set, this option must expand to (or be specified as) a colon-separated
34813 list of header names. Headers with these names will be included in the message
34814 signature. When unspecified, the header names recommended in RFC4871 will be
34815 used.
34816 .wen
34817
34818 .section "Verifying DKIM signatures in incoming mail" "SECID514"
34819 .cindex "DKIM" "verification"
34820
34821 Verification of DKIM signatures in incoming email is implemented via the
34822 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
34823 syntactically(!) correct signature in the incoming message.
34824
34825 To evaluate the signature in the ACL a large number of expansion variables
34826 containing the signature status and its details are set up during the
34827 runtime of the ACL.
34828
34829 Calling the ACL only for existing signatures is not sufficient to build
34830 more advanced policies. For that reason, the global option
34831 &%dkim_verify_signers%&, and a global expansion variable
34832 &%$dkim_signers%& exist.
34833
34834 .new
34835 The global option &%dkim_verify_signers%& can be set to a colon-separated
34836 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
34837 called. It is expanded when the message has been received. At this point,
34838 the expansion variable &%$dkim_signers%& already contains a colon-separated
34839 list of signer domains and identities for the message. When
34840 &%dkim_verify_signers%& is not specified in the main configuration,
34841 it defaults as:
34842 .code
34843 dkim_verify_signers = $dkim_signers
34844 .endd
34845 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
34846 DKIM signature in the message. Current DKIM verifiers may want to explicitly
34847 call the ACL for known domains or identities. This would be achieved as follows:
34848 .code
34849 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
34850 .endd
34851 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
34852 and "ebay.com", plus all domains and identities that have signatures in the message.
34853 You can also be more creative in constructing your policy. For example:
34854 .code
34855 dkim_verify_signers = $sender_address_domain:$dkim_signers
34856 .endd
34857 .wen
34858 If a domain or identity is listed several times in the (expanded) value of
34859 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
34860
34861
34862 Inside the &%acl_smtp_dkim%&, the following expansion variables are
34863 available (from most to least important):
34864
34865 .new
34866 .vlist
34867 .vitem &%$dkim_cur_signer%&
34868 The signer that is being evaluated in this ACL run. This can be a domain or
34869 an identity. This is one of the list items from the expanded main option
34870 &%dkim_verify_signers%& (see above).
34871 .vitem &%$dkim_verify_status%&
34872 A string describing the general status of the signature. One of
34873 .ilist
34874 &%none%&: There is no signature in the message for the current domain or
34875 identity (as reflected by &%$dkim_cur_signer%&).
34876 .next
34877 &%invalid%&: The signature could not be verified due to a processing error.
34878 More detail is available in &%$dkim_verify_reason%&.
34879 .next
34880 &%fail%&: Verification of the signature failed.  More detail is
34881 available in &%$dkim_verify_reason%&.
34882 .next
34883 &%pass%&: The signature passed verification. It is valid.
34884 .endlist
34885 .vitem &%$dkim_verify_reason%&
34886 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
34887 "fail" or "invalid". One of
34888 .ilist
34889 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
34890 key for the domain could not be retrieved. This may be a temporary problem.
34891 .next
34892 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
34893 record for the domain is syntactically invalid.
34894 .next
34895 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
34896 body hash does not match the one specified in the signature header. This
34897 means that the message body was modified in transit.
34898 .next
34899 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
34900 could not be verified. This may mean that headers were modified,
34901 re-written or otherwise changed in a way which is incompatible with
34902 DKIM verification. It may of course also mean that the signature is forged.
34903 .endlist
34904 .vitem &%$dkim_domain%&
34905 The signing domain. IMPORTANT: This variable is only populated if there is
34906 an actual signature in the message for the current domain or identity (as
34907 reflected by &%$dkim_cur_signer%&).
34908 .vitem &%$dkim_identity%&
34909 The signing identity, if present. IMPORTANT: This variable is only populated
34910 if there is an actual signature in the message for the current domain or
34911 identity (as reflected by &%$dkim_cur_signer%&).
34912 .vitem &%$dkim_selector%&
34913 The key record selector string.
34914 .vitem &%$dkim_algo%&
34915 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
34916 .vitem &%$dkim_canon_body%&
34917 The body canonicalization method. One of 'relaxed' or 'simple'.
34918 .vitem &%dkim_canon_headers%&
34919 The header canonicalization method. One of 'relaxed' or 'simple'.
34920 .vitem &%$dkim_copiedheaders%&
34921 A transcript of headers and their values which are included in the signature
34922 (copied from the 'z=' tag of the signature).
34923 .vitem &%$dkim_bodylength%&
34924 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
34925 limit was set by the signer, "9999999999999" is returned. This makes sure
34926 that this variable always expands to an integer value.
34927 .vitem &%$dkim_created%&
34928 UNIX timestamp reflecting the date and time when the signature was created.
34929 When this was not specified by the signer, "0" is returned.
34930 .vitem &%$dkim_expires%&
34931 UNIX timestamp reflecting the date and time when the signer wants the
34932 signature to be treated as "expired". When this was not specified by the
34933 signer, "9999999999999" is returned. This makes it possible to do useful
34934 integer size comparisons against this value.
34935 .vitem &%$dkim_headernames%&
34936 A colon-separated list of names of headers included in the signature.
34937 .vitem &%$dkim_key_testing%&
34938 "1" if the key record has the "testing" flag set, "0" if not.
34939 .vitem &%$dkim_key_nosubdomaining%&
34940 "1" if the key record forbids subdomaining, "0" otherwise.
34941 .vitem &%$dkim_key_srvtype%&
34942 Service type (tag s=) from the key record. Defaults to "*" if not specified
34943 in the key record.
34944 .vitem &%$dkim_key_granularity%&
34945 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
34946 in the key record.
34947 .vitem &%$dkim_key_notes%&
34948 Notes from the key record (tag n=).
34949 .endlist
34950 .wen
34951 In addition, two ACL conditions are provided:
34952
34953 .new
34954 .vlist
34955 .vitem &%dkim_signers%&
34956 ACL condition that checks a colon-separated list of domains or identities
34957 for a match against the domain or identity that the ACL is currently verifying
34958 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
34959 verb to a group of domains or identities. For example:
34960 .wen
34961 .code
34962 # Warn when message apparently from GMail has no signature at all
34963 warn log_message = GMail sender without DKIM signature
34964      sender_domains = gmail.com
34965      dkim_signers = gmail.com
34966      dkim_status = none
34967 .endd
34968
34969 .vitem &%dkim_status%&
34970 ACL condition that checks a colon-separated list of possible DKIM verification
34971 results agains the actual result of verification. This is typically used
34972 to restrict an ACL verb to a list of verification outcomes, like:
34973
34974 .code
34975 deny message = Message from Paypal with invalid or missing signature
34976      sender_domains = paypal.com:paypal.de
34977      dkim_signers = paypal.com:paypal.de
34978      dkim_status = none:invalid:fail
34979 .endd
34980
34981 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
34982 see the documentation of the &%$dkim_verify_status%& expansion variable above
34983 for more information of what they mean.
34984 .endlist
34985
34986 . ////////////////////////////////////////////////////////////////////////////
34987 . ////////////////////////////////////////////////////////////////////////////
34988
34989 .chapter "Adding new drivers or lookup types" "CHID13" &&&
34990          "Adding drivers or lookups"
34991 .cindex "adding drivers"
34992 .cindex "new drivers, adding"
34993 .cindex "drivers" "adding new"
34994 The following actions have to be taken in order to add a new router, transport,
34995 authenticator, or lookup type to Exim:
34996
34997 .olist
34998 Choose a name for the driver or lookup type that does not conflict with any
34999 existing name; I will use &"newdriver"& in what follows.
35000 .next
35001 Add to &_src/EDITME_& the line:
35002 .display
35003 <&'type'&>&`_NEWDRIVER=yes`&
35004 .endd
35005 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
35006 code is not to be included in the binary by default, comment this line out. You
35007 should also add any relevant comments about the driver or lookup type.
35008 .next
35009 Add to &_src/config.h.defaults_& the line:
35010 .code
35011 #define <type>_NEWDRIVER
35012 .endd
35013 .next
35014 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
35015 and create a table entry as is done for all the other drivers and lookup types.
35016 .next
35017 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
35018 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
35019 driver or lookup type and add it to the definition of OBJ.
35020 .next
35021 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
35022 &_src_&.
35023 .next
35024 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
35025 as for other drivers and lookups.
35026 .endlist
35027
35028 Then all you need to do is write the code! A good way to start is to make a
35029 proforma by copying an existing module of the same type, globally changing all
35030 occurrences of the name, and cutting out most of the code. Note that any
35031 options you create must be listed in alphabetical order, because the tables are
35032 searched using a binary chop procedure.
35033
35034 There is a &_README_& file in each of the sub-directories of &_src_& describing
35035 the interface that is expected.
35036
35037
35038
35039
35040 . ////////////////////////////////////////////////////////////////////////////
35041 . ////////////////////////////////////////////////////////////////////////////
35042
35043 . /////////////////////////////////////////////////////////////////////////////
35044 . These lines are processing instructions for the Simple DocBook Processor that
35045 . Philip Hazel has developed as a less cumbersome way of making PostScript and
35046 . PDFs than using xmlto and fop. They will be ignored by all other XML
35047 . processors.
35048 . /////////////////////////////////////////////////////////////////////////////
35049
35050 .literal xml
35051 <?sdop
35052   format="newpage"
35053   foot_right_recto="&chaptertitle;"
35054   foot_right_verso="&chaptertitle;"
35055 ?>
35056 .literal off
35057
35058 .makeindex "Options index"   "option"
35059 .makeindex "Variables index" "variable"
35060 .makeindex "Concept index"   "concept"
35061
35062
35063 . /////////////////////////////////////////////////////////////////////////////
35064 . /////////////////////////////////////////////////////////////////////////////