Exim 4.75.
[users/jgh/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.75"
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.75</revnumber>
180   <date>21 Feb 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.
11141
11142 .new
11143 As with the special case of &$message_size$&, during the expansion of the
11144 appendfile transport's maildir_tag option in maildir format, the value of
11145 &$message_linecount$& is the precise size of the number of newlines in the
11146 file that has been written (minus one for the blank line between the
11147 header and the body).
11148 .wen
11149
11150 Here is an example of the use of this variable in a DATA ACL:
11151 .code
11152 deny message   = Too many lines in message header
11153      condition = \
11154       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11155 .endd
11156 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11157 message has not yet been received.
11158
11159 .vitem &$message_size$&
11160 .cindex "size" "of message"
11161 .cindex "message" "size"
11162 .vindex "&$message_size$&"
11163 When a message is being processed, this variable contains its size in bytes. In
11164 most cases, the size includes those headers that were received with the
11165 message, but not those (such as &'Envelope-to:'&) that are added to individual
11166 deliveries as they are written. However, there is one special case: during the
11167 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11168 doing a delivery in maildir format, the value of &$message_size$& is the
11169 precise size of the file that has been written. See also
11170 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11171
11172 .cindex "RCPT" "value of &$message_size$&"
11173 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11174 contains the size supplied on the MAIL command, or -1 if no size was given. The
11175 value may not, of course, be truthful.
11176
11177 .vitem &$mime_$&&'xxx'&
11178 A number of variables whose names start with &$mime$& are
11179 available when Exim is compiled with the content-scanning extension. For
11180 details, see section &<<SECTscanmimepart>>&.
11181
11182 .vitem "&$n0$& &-- &$n9$&"
11183 These variables are counters that can be incremented by means
11184 of the &%add%& command in filter files.
11185
11186 .vitem &$original_domain$&
11187 .vindex "&$domain$&"
11188 .vindex "&$original_domain$&"
11189 When a top-level address is being processed for delivery, this contains the
11190 same value as &$domain$&. However, if a &"child"& address (for example,
11191 generated by an alias, forward, or filter file) is being processed, this
11192 variable contains the domain of the original address (lower cased). This
11193 differs from &$parent_domain$& only when there is more than one level of
11194 aliasing or forwarding. When more than one address is being delivered in a
11195 single transport run, &$original_domain$& is not set.
11196
11197 If a new address is created by means of a &%deliver%& command in a system
11198 filter, it is set up with an artificial &"parent"& address. This has the local
11199 part &'system-filter'& and the default qualify domain.
11200
11201 .vitem &$original_local_part$&
11202 .vindex "&$local_part$&"
11203 .vindex "&$original_local_part$&"
11204 When a top-level address is being processed for delivery, this contains the
11205 same value as &$local_part$&, unless a prefix or suffix was removed from the
11206 local part, because &$original_local_part$& always contains the full local
11207 part. When a &"child"& address (for example, generated by an alias, forward, or
11208 filter file) is being processed, this variable contains the full local part of
11209 the original address.
11210
11211 If the router that did the redirection processed the local part
11212 case-insensitively, the value in &$original_local_part$& is in lower case.
11213 This variable differs from &$parent_local_part$& only when there is more than
11214 one level of aliasing or forwarding. When more than one address is being
11215 delivered in a single transport run, &$original_local_part$& is not set.
11216
11217 If a new address is created by means of a &%deliver%& command in a system
11218 filter, it is set up with an artificial &"parent"& address. This has the local
11219 part &'system-filter'& and the default qualify domain.
11220
11221 .vitem &$originator_gid$&
11222 .cindex "gid (group id)" "of originating user"
11223 .cindex "sender" "gid"
11224 .vindex "&$caller_gid$&"
11225 .vindex "&$originator_gid$&"
11226 This variable contains the value of &$caller_gid$& that was set when the
11227 message was received. For messages received via the command line, this is the
11228 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11229 normally the gid of the Exim user.
11230
11231 .vitem &$originator_uid$&
11232 .cindex "uid (user id)" "of originating user"
11233 .cindex "sender" "uid"
11234 .vindex "&$caller_uid$&"
11235 .vindex "&$originaltor_uid$&"
11236 The value of &$caller_uid$& that was set when the message was received. For
11237 messages received via the command line, this is the uid of the sending user.
11238 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11239 user.
11240
11241 .vitem &$parent_domain$&
11242 .vindex "&$parent_domain$&"
11243 This variable is similar to &$original_domain$& (see
11244 above), except that it refers to the immediately preceding parent address.
11245
11246 .vitem &$parent_local_part$&
11247 .vindex "&$parent_local_part$&"
11248 This variable is similar to &$original_local_part$&
11249 (see above), except that it refers to the immediately preceding parent address.
11250
11251 .vitem &$pid$&
11252 .cindex "pid (process id)" "of current process"
11253 .vindex "&$pid$&"
11254 This variable contains the current process id.
11255
11256 .vitem &$pipe_addresses$&
11257 .cindex "filter" "transport filter"
11258 .cindex "transport" "filter"
11259 .vindex "&$pipe_addresses$&"
11260 This is not an expansion variable, but is mentioned here because the string
11261 &`$pipe_addresses`& is handled specially in the command specification for the
11262 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11263 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11264 It cannot be used in general expansion strings, and provokes an &"unknown
11265 variable"& error if encountered.
11266
11267 .vitem &$primary_hostname$&
11268 .vindex "&$primary_hostname$&"
11269 This variable contains the value set by &%primary_hostname%& in the
11270 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11271 a single-component name, Exim calls &[gethostbyname()]& (or
11272 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11273 qualified host name. See also &$smtp_active_hostname$&.
11274
11275
11276 .vitem &$prvscheck_address$&
11277 This variable is used in conjunction with the &%prvscheck%& expansion item,
11278 which is described in sections &<<SECTexpansionitems>>& and
11279 &<<SECTverifyPRVS>>&.
11280
11281 .vitem &$prvscheck_keynum$&
11282 This variable is used in conjunction with the &%prvscheck%& expansion item,
11283 which is described in sections &<<SECTexpansionitems>>& and
11284 &<<SECTverifyPRVS>>&.
11285
11286 .vitem &$prvscheck_result$&
11287 This variable is used in conjunction with the &%prvscheck%& expansion item,
11288 which is described in sections &<<SECTexpansionitems>>& and
11289 &<<SECTverifyPRVS>>&.
11290
11291 .vitem &$qualify_domain$&
11292 .vindex "&$qualify_domain$&"
11293 The value set for the &%qualify_domain%& option in the configuration file.
11294
11295 .vitem &$qualify_recipient$&
11296 .vindex "&$qualify_recipient$&"
11297 The value set for the &%qualify_recipient%& option in the configuration file,
11298 or if not set, the value of &$qualify_domain$&.
11299
11300 .vitem &$rcpt_count$&
11301 .vindex "&$rcpt_count$&"
11302 When a message is being received by SMTP, this variable contains the number of
11303 RCPT commands received for the current message. If this variable is used in a
11304 RCPT ACL, its value includes the current command.
11305
11306 .vitem &$rcpt_defer_count$&
11307 .vindex "&$rcpt_defer_count$&"
11308 .cindex "4&'xx'& responses" "count of"
11309 When a message is being received by SMTP, this variable contains the number of
11310 RCPT commands in the current message that have previously been rejected with a
11311 temporary (4&'xx'&) response.
11312
11313 .vitem &$rcpt_fail_count$&
11314 .vindex "&$rcpt_fail_count$&"
11315 When a message is being received by SMTP, this variable contains the number of
11316 RCPT commands in the current message that have previously been rejected with a
11317 permanent (5&'xx'&) response.
11318
11319 .vitem &$received_count$&
11320 .vindex "&$received_count$&"
11321 This variable contains the number of &'Received:'& header lines in the message,
11322 including the one added by Exim (so its value is always greater than zero). It
11323 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11324 delivering.
11325
11326 .vitem &$received_for$&
11327 .vindex "&$received_for$&"
11328 If there is only a single recipient address in an incoming message, this
11329 variable contains that address when the &'Received:'& header line is being
11330 built. The value is copied after recipient rewriting has happened, but before
11331 the &[local_scan()]& function is run.
11332
11333 .vitem &$received_ip_address$&
11334 .vindex "&$received_ip_address$&"
11335 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11336 variable is set to the address of the local IP interface, and &$received_port$&
11337 is set to the local port number. (The remote IP address and port are in
11338 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11339 the port value is -1 unless it has been set using the &%-oMi%& command line
11340 option.
11341
11342 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11343 could be used, for example, to make the file name for a TLS certificate depend
11344 on which interface and/or port is being used for the incoming connection. The
11345 values of &$received_ip_address$& and &$received_port$& are saved with any
11346 messages that are received, thus making these variables available at delivery
11347 time.
11348
11349 &*Note:*& There are no equivalent variables for outgoing connections, because
11350 the values are unknown (unless they are explicitly set by options of the
11351 &(smtp)& transport).
11352
11353 .vitem &$received_port$&
11354 .vindex "&$received_port$&"
11355 See &$received_ip_address$&.
11356
11357 .vitem &$received_protocol$&
11358 .vindex "&$received_protocol$&"
11359 When a message is being processed, this variable contains the name of the
11360 protocol by which it was received. Most of the names used by Exim are defined
11361 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11362 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11363 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11364 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11365 connection and the client was successfully authenticated.
11366
11367 Exim uses the protocol name &"smtps"& for the case when encryption is
11368 automatically set up on connection without the use of STARTTLS (see
11369 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11370 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11371 where the client initially uses EHLO, sets up an encrypted connection using
11372 STARTTLS, and then uses HELO afterwards.
11373
11374 The &%-oMr%& option provides a way of specifying a custom protocol name for
11375 messages that are injected locally by trusted callers. This is commonly used to
11376 identify messages that are being re-injected after some kind of scanning.
11377
11378 .vitem &$received_time$&
11379 .vindex "&$received_time$&"
11380 This variable contains the date and time when the current message was received,
11381 as a number of seconds since the start of the Unix epoch.
11382
11383 .vitem &$recipient_data$&
11384 .vindex "&$recipient_data$&"
11385 This variable is set after an indexing lookup success in an ACL &%recipients%&
11386 condition. It contains the data from the lookup, and the value remains set
11387 until the next &%recipients%& test. Thus, you can do things like this:
11388 .display
11389 &`require recipients  = cdb*@;/some/file`&
11390 &`deny    `&&'some further test involving'& &`$recipient_data`&
11391 .endd
11392 &*Warning*&: This variable is set only when a lookup is used as an indexing
11393 method in the address list, using the semicolon syntax as in the example above.
11394 The variable is not set for a lookup that is used as part of the string
11395 expansion that all such lists undergo before being interpreted.
11396
11397 .vitem &$recipient_verify_failure$&
11398 .vindex "&$recipient_verify_failure$&"
11399 In an ACL, when a recipient verification fails, this variable contains
11400 information about the failure. It is set to one of the following words:
11401
11402 .ilist
11403 &"qualify"&: The address was unqualified (no domain), and the message
11404 was neither local nor came from an exempted host.
11405
11406 .next
11407 &"route"&: Routing failed.
11408
11409 .next
11410 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11411 or before the MAIL command (that is, on initial connection, HELO, or
11412 MAIL).
11413
11414 .next
11415 &"recipient"&: The RCPT command in a callout was rejected.
11416 .next
11417
11418 &"postmaster"&: The postmaster check in a callout was rejected.
11419 .endlist
11420
11421 The main use of this variable is expected to be to distinguish between
11422 rejections of MAIL and rejections of RCPT.
11423
11424 .vitem &$recipients$&
11425 .vindex "&$recipients$&"
11426 This variable contains a list of envelope recipients for a message. A comma and
11427 a space separate the addresses in the replacement text. However, the variable
11428 is not generally available, to prevent exposure of Bcc recipients in
11429 unprivileged users' filter files. You can use &$recipients$& only in these
11430 cases:
11431
11432 .olist
11433 In a system filter file.
11434 .next
11435 In the ACLs associated with the DATA command and with non-SMTP messages, that
11436 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11437 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11438 &%acl_not_smtp_mime%&.
11439 .next
11440 From within a &[local_scan()]& function.
11441 .endlist
11442
11443
11444 .vitem &$recipients_count$&
11445 .vindex "&$recipients_count$&"
11446 When a message is being processed, this variable contains the number of
11447 envelope recipients that came with the message. Duplicates are not excluded
11448 from the count. While a message is being received over SMTP, the number
11449 increases for each accepted recipient. It can be referenced in an ACL.
11450
11451
11452 .vitem &$regex_match_string$&
11453 .vindex "&$regex_match_string$&"
11454 This variable is set to contain the matching regular expression after a
11455 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11456
11457
11458 .vitem &$reply_address$&
11459 .vindex "&$reply_address$&"
11460 When a message is being processed, this variable contains the contents of the
11461 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11462 contents of the &'From:'& header line. Apart from the removal of leading
11463 white space, the value is not processed in any way. In particular, no RFC 2047
11464 decoding or character code translation takes place.
11465
11466 .vitem &$return_path$&
11467 .vindex "&$return_path$&"
11468 When a message is being delivered, this variable contains the return path &--
11469 the sender field that will be sent as part of the envelope. It is not enclosed
11470 in <> characters. At the start of routing an address, &$return_path$& has the
11471 same value as &$sender_address$&, but if, for example, an incoming message to a
11472 mailing list has been expanded by a router which specifies a different address
11473 for bounce messages, &$return_path$& subsequently contains the new bounce
11474 address, whereas &$sender_address$& always contains the original sender address
11475 that was received with the message. In other words, &$sender_address$& contains
11476 the incoming envelope sender, and &$return_path$& contains the outgoing
11477 envelope sender.
11478
11479 .vitem &$return_size_limit$&
11480 .vindex "&$return_size_limit$&"
11481 This is an obsolete name for &$bounce_return_size_limit$&.
11482
11483 .vitem &$runrc$&
11484 .cindex "return code" "from &%run%& expansion"
11485 .vindex "&$runrc$&"
11486 This variable contains the return code from a command that is run by the
11487 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11488 assume the order in which option values are expanded, except for those
11489 preconditions whose order of testing is documented. Therefore, you cannot
11490 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11491 another.
11492
11493 .vitem &$self_hostname$&
11494 .oindex "&%self%&" "value of host name"
11495 .vindex "&$self_hostname$&"
11496 When an address is routed to a supposedly remote host that turns out to be the
11497 local host, what happens is controlled by the &%self%& generic router option.
11498 One of its values causes the address to be passed to another router. When this
11499 happens, &$self_hostname$& is set to the name of the local host that the
11500 original router encountered. In other circumstances its contents are null.
11501
11502 .vitem &$sender_address$&
11503 .vindex "&$sender_address$&"
11504 When a message is being processed, this variable contains the sender's address
11505 that was received in the message's envelope. The case of letters in the address
11506 is retained, in both the local part and the domain. For bounce messages, the
11507 value of this variable is the empty string. See also &$return_path$&.
11508
11509 .vitem &$sender_address_data$&
11510 .vindex "&$address_data$&"
11511 .vindex "&$sender_address_data$&"
11512 If &$address_data$& is set when the routers are called from an ACL to verify a
11513 sender address, the final value is preserved in &$sender_address_data$&, to
11514 distinguish it from data from a recipient address. The value does not persist
11515 after the end of the current ACL statement. If you want to preserve it for
11516 longer, you can save it in an ACL variable.
11517
11518 .vitem &$sender_address_domain$&
11519 .vindex "&$sender_address_domain$&"
11520 The domain portion of &$sender_address$&.
11521
11522 .vitem &$sender_address_local_part$&
11523 .vindex "&$sender_address_local_part$&"
11524 The local part portion of &$sender_address$&.
11525
11526 .vitem &$sender_data$&
11527 .vindex "&$sender_data$&"
11528 This variable is set after a lookup success in an ACL &%senders%& condition or
11529 in a router &%senders%& option. It contains the data from the lookup, and the
11530 value remains set until the next &%senders%& test. Thus, you can do things like
11531 this:
11532 .display
11533 &`require senders      = cdb*@;/some/file`&
11534 &`deny    `&&'some further test involving'& &`$sender_data`&
11535 .endd
11536 &*Warning*&: This variable is set only when a lookup is used as an indexing
11537 method in the address list, using the semicolon syntax as in the example above.
11538 The variable is not set for a lookup that is used as part of the string
11539 expansion that all such lists undergo before being interpreted.
11540
11541 .vitem &$sender_fullhost$&
11542 .vindex "&$sender_fullhost$&"
11543 When a message is received from a remote host, this variable contains the host
11544 name and IP address in a single string. It ends with the IP address in square
11545 brackets, followed by a colon and a port number if the logging of ports is
11546 enabled. The format of the rest of the string depends on whether the host
11547 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11548 looking up its IP address. (Looking up the IP address can be forced by the
11549 &%host_lookup%& option, independent of verification.) A plain host name at the
11550 start of the string is a verified host name; if this is not present,
11551 verification either failed or was not requested. A host name in parentheses is
11552 the argument of a HELO or EHLO command. This is omitted if it is identical to
11553 the verified host name or to the host's IP address in square brackets.
11554
11555 .vitem &$sender_helo_name$&
11556 .vindex "&$sender_helo_name$&"
11557 When a message is received from a remote host that has issued a HELO or EHLO
11558 command, the argument of that command is placed in this variable. It is also
11559 set if HELO or EHLO is used when a message is received using SMTP locally via
11560 the &%-bs%& or &%-bS%& options.
11561
11562 .vitem &$sender_host_address$&
11563 .vindex "&$sender_host_address$&"
11564 When a message is received from a remote host, this variable contains that
11565 host's IP address. For locally submitted messages, it is empty.
11566
11567 .vitem &$sender_host_authenticated$&
11568 .vindex "&$sender_host_authenticated$&"
11569 This variable contains the name (not the public name) of the authenticator
11570 driver that successfully authenticated the client from which the message was
11571 received. It is empty if there was no successful authentication. See also
11572 &$authenticated_id$&.
11573
11574 .vitem &$sender_host_name$&
11575 .vindex "&$sender_host_name$&"
11576 When a message is received from a remote host, this variable contains the
11577 host's name as obtained by looking up its IP address. For messages received by
11578 other means, this variable is empty.
11579
11580 .vindex "&$host_lookup_failed$&"
11581 If the host name has not previously been looked up, a reference to
11582 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11583 A looked up name is accepted only if it leads back to the original IP address
11584 via a forward lookup. If either the reverse or the forward lookup fails to find
11585 any data, or if the forward lookup does not yield the original IP address,
11586 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11587
11588 .vindex "&$host_lookup_deferred$&"
11589 However, if either of the lookups cannot be completed (for example, there is a
11590 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11591 &$host_lookup_failed$& remains set to &"0"&.
11592
11593 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
11594 host name again if there is a subsequent reference to &$sender_host_name$&
11595 in the same Exim process, but it does try again if &$host_lookup_deferred$&
11596 is set to &"1"&.
11597
11598 Exim does not automatically look up every calling host's name. If you want
11599 maximum efficiency, you should arrange your configuration so that it avoids
11600 these lookups altogether. The lookup happens only if one or more of the
11601 following are true:
11602
11603 .ilist
11604 A string containing &$sender_host_name$& is expanded.
11605 .next
11606 The calling host matches the list in &%host_lookup%&. In the default
11607 configuration, this option is set to *, so it must be changed if lookups are
11608 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
11609 .next
11610 Exim needs the host name in order to test an item in a host list. The items
11611 that require this are described in sections &<<SECThoslispatnam>>& and
11612 &<<SECThoslispatnamsk>>&.
11613 .next
11614 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
11615 In this case, the host name is required to compare with the name quoted in any
11616 EHLO or HELO commands that the client issues.
11617 .next
11618 The remote host issues a EHLO or HELO command that quotes one of the
11619 domains in &%helo_lookup_domains%&. The default value of this option is
11620 . ==== As this is a nested list, any displays it contains must be indented
11621 . ==== as otherwise they are too far to the left.
11622 .code
11623   helo_lookup_domains = @ : @[]
11624 .endd
11625 which causes a lookup if a remote host (incorrectly) gives the server's name or
11626 IP address in an EHLO or HELO command.
11627 .endlist
11628
11629
11630 .vitem &$sender_host_port$&
11631 .vindex "&$sender_host_port$&"
11632 When a message is received from a remote host, this variable contains the port
11633 number that was used on the remote host.
11634
11635 .vitem &$sender_ident$&
11636 .vindex "&$sender_ident$&"
11637 When a message is received from a remote host, this variable contains the
11638 identification received in response to an RFC 1413 request. When a message has
11639 been received locally, this variable contains the login name of the user that
11640 called Exim.
11641
11642 .vitem &$sender_rate_$&&'xxx'&
11643 A number of variables whose names begin &$sender_rate_$& are set as part of the
11644 &%ratelimit%& ACL condition. Details are given in section
11645 &<<SECTratelimiting>>&.
11646
11647 .vitem &$sender_rcvhost$&
11648 .cindex "DNS" "reverse lookup"
11649 .cindex "reverse DNS lookup"
11650 .vindex "&$sender_rcvhost$&"
11651 This is provided specifically for use in &'Received:'& headers. It starts with
11652 either the verified host name (as obtained from a reverse DNS lookup) or, if
11653 there is no verified host name, the IP address in square brackets. After that
11654 there may be text in parentheses. When the first item is a verified host name,
11655 the first thing in the parentheses is the IP address in square brackets,
11656 followed by a colon and a port number if port logging is enabled. When the
11657 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
11658 the parentheses.
11659
11660 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
11661 was used and its argument was not identical to the real host name or IP
11662 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
11663 all three items are present in the parentheses, a newline and tab are inserted
11664 into the string, to improve the formatting of the &'Received:'& header.
11665
11666 .vitem &$sender_verify_failure$&
11667 .vindex "&$sender_verify_failure$&"
11668 In an ACL, when a sender verification fails, this variable contains information
11669 about the failure. The details are the same as for
11670 &$recipient_verify_failure$&.
11671
11672 .vitem &$sending_ip_address$&
11673 .vindex "&$sending_ip_address$&"
11674 This variable is set whenever an outgoing SMTP connection to another host has
11675 been set up. It contains the IP address of the local interface that is being
11676 used. This is useful if a host that has more than one IP address wants to take
11677 on different personalities depending on which one is being used. For incoming
11678 connections, see &$received_ip_address$&.
11679
11680 .vitem &$sending_port$&
11681 .vindex "&$sending_port$&"
11682 This variable is set whenever an outgoing SMTP connection to another host has
11683 been set up. It contains the local port that is being used. For incoming
11684 connections, see &$received_port$&.
11685
11686 .vitem &$smtp_active_hostname$&
11687 .vindex "&$smtp_active_hostname$&"
11688 During an incoming SMTP session, this variable contains the value of the active
11689 host name, as specified by the &%smtp_active_hostname%& option. The value of
11690 &$smtp_active_hostname$& is saved with any message that is received, so its
11691 value can be consulted during routing and delivery.
11692
11693 .vitem &$smtp_command$&
11694 .vindex "&$smtp_command$&"
11695 During the processing of an incoming SMTP command, this variable contains the
11696 entire command. This makes it possible to distinguish between HELO and EHLO in
11697 the HELO ACL, and also to distinguish between commands such as these:
11698 .code
11699 MAIL FROM:<>
11700 MAIL FROM: <>
11701 .endd
11702 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
11703 command, the address in &$smtp_command$& is the original address before any
11704 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
11705 the address after SMTP-time rewriting.
11706
11707 .vitem &$smtp_command_argument$&
11708 .cindex "SMTP" "command, argument for"
11709 .vindex "&$smtp_command_argument$&"
11710 While an ACL is running to check an SMTP command, this variable contains the
11711 argument, that is, the text that follows the command name, with leading white
11712 space removed. Following the introduction of &$smtp_command$&, this variable is
11713 somewhat redundant, but is retained for backwards compatibility.
11714
11715 .vitem &$smtp_count_at_connection_start$&
11716 .vindex "&$smtp_count_at_connection_start$&"
11717 This variable is set greater than zero only in processes spawned by the Exim
11718 daemon for handling incoming SMTP connections. The name is deliberately long,
11719 in order to emphasize what the contents are. When the daemon accepts a new
11720 connection, it increments this variable. A copy of the variable is passed to
11721 the child process that handles the connection, but its value is fixed, and
11722 never changes. It is only an approximation of how many incoming connections
11723 there actually are, because many other connections may come and go while a
11724 single connection is being processed. When a child process terminates, the
11725 daemon decrements its copy of the variable.
11726
11727 .vitem "&$sn0$& &-- &$sn9$&"
11728 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
11729 that were current at the end of the system filter file. This allows a system
11730 filter file to set values that can be tested in users' filter files. For
11731 example, a system filter could set a value indicating how likely it is that a
11732 message is junk mail.
11733
11734 .vitem &$spam_$&&'xxx'&
11735 A number of variables whose names start with &$spam$& are available when Exim
11736 is compiled with the content-scanning extension. For details, see section
11737 &<<SECTscanspamass>>&.
11738
11739
11740 .vitem &$spool_directory$&
11741 .vindex "&$spool_directory$&"
11742 The name of Exim's spool directory.
11743
11744 .vitem &$spool_inodes$&
11745 .vindex "&$spool_inodes$&"
11746 The number of free inodes in the disk partition where Exim's spool files are
11747 being written. The value is recalculated whenever the variable is referenced.
11748 If the relevant file system does not have the concept of inodes, the value of
11749 is -1. See also the &%check_spool_inodes%& option.
11750
11751 .vitem &$spool_space$&
11752 .vindex "&$spool_space$&"
11753 The amount of free space (as a number of kilobytes) in the disk partition where
11754 Exim's spool files are being written. The value is recalculated whenever the
11755 variable is referenced. If the operating system does not have the ability to
11756 find the amount of free space (only true for experimental systems), the space
11757 value is -1. For example, to check in an ACL that there is at least 50
11758 megabytes free on the spool, you could write:
11759 .code
11760 condition = ${if > {$spool_space}{50000}}
11761 .endd
11762 See also the &%check_spool_space%& option.
11763
11764
11765 .vitem &$thisaddress$&
11766 .vindex "&$thisaddress$&"
11767 This variable is set only during the processing of the &%foranyaddress%&
11768 command in a filter file. Its use is explained in the description of that
11769 command, which can be found in the separate document entitled &'Exim's
11770 interfaces to mail filtering'&.
11771
11772 .vitem &$tls_certificate_verified$&
11773 .vindex "&$tls_certificate_verified$&"
11774 This variable is set to &"1"& if a TLS certificate was verified when the
11775 message was received, and &"0"& otherwise.
11776
11777 .vitem &$tls_cipher$&
11778 .vindex "&$tls_cipher$&"
11779 When a message is received from a remote host over an encrypted SMTP
11780 connection, this variable is set to the cipher suite that was negotiated, for
11781 example DES-CBC3-SHA. In other circumstances, in particular, for message
11782 received over unencrypted connections, the variable is empty. Testing
11783 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
11784 non-encrypted connections during ACL processing.
11785
11786 The &$tls_cipher$& variable retains its value during message delivery, except
11787 when an outward SMTP delivery takes place via the &(smtp)& transport. In this
11788 case, &$tls_cipher$& is cleared before any outgoing SMTP connection is made,
11789 and then set to the outgoing cipher suite if one is negotiated. See chapter
11790 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
11791 details of the &(smtp)& transport.
11792
11793 .vitem &$tls_peerdn$&
11794 .vindex "&$tls_peerdn$&"
11795 When a message is received from a remote host over an encrypted SMTP
11796 connection, and Exim is configured to request a certificate from the client,
11797 the value of the Distinguished Name of the certificate is made available in the
11798 &$tls_peerdn$& during subsequent processing. Like &$tls_cipher$&, the
11799 value is retained during message delivery, except during outbound SMTP
11800 deliveries.
11801
11802 .vitem &$tod_bsdinbox$&
11803 .vindex "&$tod_bsdinbox$&"
11804 The time of day and the date, in the format required for BSD-style mailbox
11805 files, for example: Thu Oct 17 17:14:09 1995.
11806
11807 .vitem &$tod_epoch$&
11808 .vindex "&$tod_epoch$&"
11809 The time and date as a number of seconds since the start of the Unix epoch.
11810
11811 .vitem &$tod_full$&
11812 .vindex "&$tod_full$&"
11813 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
11814 +0100. The timezone is always given as a numerical offset from UTC, with
11815 positive values used for timezones that are ahead (east) of UTC, and negative
11816 values for those that are behind (west).
11817
11818 .vitem &$tod_log$&
11819 .vindex "&$tod_log$&"
11820 The time and date in the format used for writing Exim's log files, for example:
11821 1995-10-12 15:32:29, but without a timezone.
11822
11823 .vitem &$tod_logfile$&
11824 .vindex "&$tod_logfile$&"
11825 This variable contains the date in the format yyyymmdd. This is the format that
11826 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
11827 flag.
11828
11829 .vitem &$tod_zone$&
11830 .vindex "&$tod_zone$&"
11831 This variable contains the numerical value of the local timezone, for example:
11832 -0500.
11833
11834 .vitem &$tod_zulu$&
11835 .vindex "&$tod_zulu$&"
11836 This variable contains the UTC date and time in &"Zulu"& format, as specified
11837 by ISO 8601, for example: 20030221154023Z.
11838
11839 .vitem &$value$&
11840 .vindex "&$value$&"
11841 This variable contains the result of an expansion lookup, extraction operation,
11842 or external command, as described above. It is also used during a
11843 &*reduce*& expansion.
11844
11845 .vitem &$version_number$&
11846 .vindex "&$version_number$&"
11847 The version number of Exim.
11848
11849 .vitem &$warn_message_delay$&
11850 .vindex "&$warn_message_delay$&"
11851 This variable is set only during the creation of a message warning about a
11852 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11853
11854 .vitem &$warn_message_recipients$&
11855 .vindex "&$warn_message_recipients$&"
11856 This variable is set only during the creation of a message warning about a
11857 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11858 .endlist
11859 .ecindex IIDstrexp
11860
11861
11862
11863 . ////////////////////////////////////////////////////////////////////////////
11864 . ////////////////////////////////////////////////////////////////////////////
11865
11866 .chapter "Embedded Perl" "CHAPperl"
11867 .scindex IIDperl "Perl" "calling from Exim"
11868 Exim can be built to include an embedded Perl interpreter. When this is done,
11869 Perl subroutines can be called as part of the string expansion process. To make
11870 use of the Perl support, you need version 5.004 or later of Perl installed on
11871 your system. To include the embedded interpreter in the Exim binary, include
11872 the line
11873 .code
11874 EXIM_PERL = perl.o
11875 .endd
11876 in your &_Local/Makefile_& and then build Exim in the normal way.
11877
11878
11879 .section "Setting up so Perl can be used" "SECID85"
11880 .oindex "&%perl_startup%&"
11881 Access to Perl subroutines is via a global configuration option called
11882 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
11883 no &%perl_startup%& option in the Exim configuration file then no Perl
11884 interpreter is started and there is almost no overhead for Exim (since none of
11885 the Perl library will be paged in unless used). If there is a &%perl_startup%&
11886 option then the associated value is taken to be Perl code which is executed in
11887 a newly created Perl interpreter.
11888
11889 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
11890 need backslashes before any characters to escape special meanings. The option
11891 should usually be something like
11892 .code
11893 perl_startup = do '/etc/exim.pl'
11894 .endd
11895 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
11896 use from Exim. Exim can be configured either to start up a Perl interpreter as
11897 soon as it is entered, or to wait until the first time it is needed. Starting
11898 the interpreter at the beginning ensures that it is done while Exim still has
11899 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
11900 fact used in a particular run. Also, note that this does not mean that Exim is
11901 necessarily running as root when Perl is called at a later time. By default,
11902 the interpreter is started only when it is needed, but this can be changed in
11903 two ways:
11904
11905 .ilist
11906 .oindex "&%perl_at_start%&"
11907 Setting &%perl_at_start%& (a boolean option) in the configuration requests
11908 a startup when Exim is entered.
11909 .next
11910 The command line option &%-ps%& also requests a startup when Exim is entered,
11911 overriding the setting of &%perl_at_start%&.
11912 .endlist
11913
11914 There is also a command line option &%-pd%& (for delay) which suppresses the
11915 initial startup, even if &%perl_at_start%& is set.
11916
11917
11918 .section "Calling Perl subroutines" "SECID86"
11919 When the configuration file includes a &%perl_startup%& option you can make use
11920 of the string expansion item to call the Perl subroutines that are defined
11921 by the &%perl_startup%& code. The operator is used in any of the following
11922 forms:
11923 .code
11924 ${perl{foo}}
11925 ${perl{foo}{argument}}
11926 ${perl{foo}{argument1}{argument2} ... }
11927 .endd
11928 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
11929 arguments may be passed. Passing more than this results in an expansion failure
11930 with an error message of the form
11931 .code
11932 Too many arguments passed to Perl subroutine "foo" (max is 8)
11933 .endd
11934 The return value of the Perl subroutine is evaluated in a scalar context before
11935 it is passed back to Exim to be inserted into the expanded string. If the
11936 return value is &'undef'&, the expansion is forced to fail in the same way as
11937 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
11938 by obeying Perl's &%die%& function, the expansion fails with the error message
11939 that was passed to &%die%&.
11940
11941
11942 .section "Calling Exim functions from Perl" "SECID87"
11943 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
11944 is available to call back into Exim's string expansion function. For example,
11945 the Perl code
11946 .code
11947 my $lp = Exim::expand_string('$local_part');
11948 .endd
11949 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
11950 Note those are single quotes and not double quotes to protect against
11951 &$local_part$& being interpolated as a Perl variable.
11952
11953 If the string expansion is forced to fail by a &"fail"& item, the result of
11954 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
11955 expansion string, the Perl call from the original expansion string fails with
11956 an appropriate error message, in the same way as if &%die%& were used.
11957
11958 .cindex "debugging" "from embedded Perl"
11959 .cindex "log" "writing from embedded Perl"
11960 Two other Exim functions are available for use from within Perl code.
11961 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
11962 debugging is enabled. If you want a newline at the end, you must supply it.
11963 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
11964 timestamp. In this case, you should not supply a terminating newline.
11965
11966
11967 .section "Use of standard output and error by Perl" "SECID88"
11968 .cindex "Perl" "standard output and error"
11969 You should not write to the standard error or output streams from within your
11970 Perl code, as it is not defined how these are set up. In versions of Exim
11971 before 4.50, it is possible for the standard output or error to refer to the
11972 SMTP connection during message reception via the daemon. Writing to this stream
11973 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
11974 error streams are connected to &_/dev/null_& in the daemon. The chaos is
11975 avoided, but the output is lost.
11976
11977 .cindex "Perl" "use of &%warn%&"
11978 The Perl &%warn%& statement writes to the standard error stream by default.
11979 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
11980 you have no control. When Exim starts up the Perl interpreter, it arranges for
11981 output from the &%warn%& statement to be written to the Exim main log. You can
11982 change this by including appropriate Perl magic somewhere in your Perl code.
11983 For example, to discard &%warn%& output completely, you need this:
11984 .code
11985 $SIG{__WARN__} = sub { };
11986 .endd
11987 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
11988 example, the code for the subroutine is empty, so it does nothing, but you can
11989 include any Perl code that you like. The text of the &%warn%& message is passed
11990 as the first subroutine argument.
11991 .ecindex IIDperl
11992
11993
11994 . ////////////////////////////////////////////////////////////////////////////
11995 . ////////////////////////////////////////////////////////////////////////////
11996
11997 .chapter "Starting the daemon and the use of network interfaces" &&&
11998          "CHAPinterfaces" &&&
11999          "Starting the daemon"
12000 .cindex "daemon" "starting"
12001 .cindex "interface" "listening"
12002 .cindex "network interface"
12003 .cindex "interface" "network"
12004 .cindex "IP address" "for listening"
12005 .cindex "daemon" "listening IP addresses"
12006 .cindex "TCP/IP" "setting listening interfaces"
12007 .cindex "TCP/IP" "setting listening ports"
12008 A host that is connected to a TCP/IP network may have one or more physical
12009 hardware network interfaces. Each of these interfaces may be configured as one
12010 or more &"logical"& interfaces, which are the entities that a program actually
12011 works with. Each of these logical interfaces is associated with an IP address.
12012 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12013 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12014 knowledge about the host's interfaces for use in three different circumstances:
12015
12016 .olist
12017 When a listening daemon is started, Exim needs to know which interfaces
12018 and ports to listen on.
12019 .next
12020 When Exim is routing an address, it needs to know which IP addresses
12021 are associated with local interfaces. This is required for the correct
12022 processing of MX lists by removing the local host and others with the
12023 same or higher priority values. Also, Exim needs to detect cases
12024 when an address is routed to an IP address that in fact belongs to the
12025 local host. Unless the &%self%& router option or the &%allow_localhost%&
12026 option of the smtp transport is set (as appropriate), this is treated
12027 as an error situation.
12028 .next
12029 When Exim connects to a remote host, it may need to know which interface to use
12030 for the outgoing connection.
12031 .endlist
12032
12033
12034 Exim's default behaviour is likely to be appropriate in the vast majority
12035 of cases. If your host has only one interface, and you want all its IP
12036 addresses to be treated in the same way, and you are using only the
12037 standard SMTP port, you should not need to take any special action. The
12038 rest of this chapter does not apply to you.
12039
12040 In a more complicated situation you may want to listen only on certain
12041 interfaces, or on different ports, and for this reason there are a number of
12042 options that can be used to influence Exim's behaviour. The rest of this
12043 chapter describes how they operate.
12044
12045 When a message is received over TCP/IP, the interface and port that were
12046 actually used are set in &$received_ip_address$& and &$received_port$&.
12047
12048
12049
12050 .section "Starting a listening daemon" "SECID89"
12051 When a listening daemon is started (by means of the &%-bd%& command line
12052 option), the interfaces and ports on which it listens are controlled by the
12053 following options:
12054
12055 .ilist
12056 &%daemon_smtp_ports%& contains a list of default ports. (For backward
12057 compatibility, this option can also be specified in the singular.)
12058 .next
12059 &%local_interfaces%& contains list of interface IP addresses on which to
12060 listen. Each item may optionally also specify a port.
12061 .endlist
12062
12063 The default list separator in both cases is a colon, but this can be changed as
12064 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12065 it is usually best to change the separator to avoid having to double all the
12066 colons. For example:
12067 .code
12068 local_interfaces = <; 127.0.0.1 ; \
12069                       192.168.23.65 ; \
12070                       ::1 ; \
12071                       3ffe:ffff:836f::fe86:a061
12072 .endd
12073 There are two different formats for specifying a port along with an IP address
12074 in &%local_interfaces%&:
12075
12076 .olist
12077 The port is added onto the address with a dot separator. For example, to listen
12078 on port 1234 on two different IP addresses:
12079 .code
12080 local_interfaces = <; 192.168.23.65.1234 ; \
12081                       3ffe:ffff:836f::fe86:a061.1234
12082 .endd
12083 .next
12084 The IP address is enclosed in square brackets, and the port is added
12085 with a colon separator, for example:
12086 .code
12087 local_interfaces = <; [192.168.23.65]:1234 ; \
12088                       [3ffe:ffff:836f::fe86:a061]:1234
12089 .endd
12090 .endlist
12091
12092 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12093 default setting contains just one port:
12094 .code
12095 daemon_smtp_ports = smtp
12096 .endd
12097 If more than one port is listed, each interface that does not have its own port
12098 specified listens on all of them. Ports that are listed in
12099 &%daemon_smtp_ports%& can be identified either by name (defined in
12100 &_/etc/services_&) or by number. However, when ports are given with individual
12101 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12102
12103
12104
12105 .section "Special IP listening addresses" "SECID90"
12106 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12107 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12108 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12109 instead of setting up separate listening sockets for each interface. The
12110 default value of &%local_interfaces%& is
12111 .code
12112 local_interfaces = 0.0.0.0
12113 .endd
12114 when Exim is built without IPv6 support; otherwise it is:
12115 .code
12116 local_interfaces = <; ::0 ; 0.0.0.0
12117 .endd
12118 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12119
12120
12121
12122 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12123 The &%-oX%& command line option can be used to override the values of
12124 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12125 instance. Another way of doing this would be to use macros and the &%-D%&
12126 option. However, &%-oX%& can be used by any admin user, whereas modification of
12127 the runtime configuration by &%-D%& is allowed only when the caller is root or
12128 exim.
12129
12130 The value of &%-oX%& is a list of items. The default colon separator can be
12131 changed in the usual way if required. If there are any items that do not
12132 contain dots or colons (that is, are not IP addresses), the value of
12133 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12134 items that do contain dots or colons, the value of &%local_interfaces%& is
12135 replaced by those items. Thus, for example,
12136 .code
12137 -oX 1225
12138 .endd
12139 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12140 whereas
12141 .code
12142 -oX 192.168.34.5.1125
12143 .endd
12144 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12145 (However, since &%local_interfaces%& now contains no items without ports, the
12146 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12147
12148
12149
12150 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12151 .cindex "ssmtp protocol"
12152 .cindex "smtps protocol"
12153 .cindex "SMTP" "ssmtp protocol"
12154 .cindex "SMTP" "smtps protocol"
12155 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12156 before the STARTTLS command was standardized for SMTP. Some legacy clients
12157 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12158 list of port numbers, connections to those ports must use SSMTP. The most
12159 common use of this option is expected to be
12160 .code
12161 tls_on_connect_ports = 465
12162 .endd
12163 because 465 is the usual port number used by the legacy clients. There is also
12164 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12165 this way when a daemon is started.
12166
12167 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12168 daemon to listen on those ports. You must still specify them in
12169 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12170 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12171 connections via the daemon.)
12172
12173
12174
12175
12176 .section "IPv6 address scopes" "SECID92"
12177 .cindex "IPv6" "address scopes"
12178 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12179 can, in principle, have the same link-local IPv6 address on different
12180 interfaces. Thus, additional information is needed, over and above the IP
12181 address, to distinguish individual interfaces. A convention of using a
12182 percent sign followed by something (often the interface name) has been
12183 adopted in some cases, leading to addresses like this:
12184 .code
12185 fe80::202:b3ff:fe03:45c1%eth0
12186 .endd
12187 To accommodate this usage, a percent sign followed by an arbitrary string is
12188 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12189 to convert a textual IPv6 address for actual use. This function recognizes the
12190 percent convention in operating systems that support it, and it processes the
12191 address appropriately. Unfortunately, some older libraries have problems with
12192 &[getaddrinfo()]&. If
12193 .code
12194 IPV6_USE_INET_PTON=yes
12195 .endd
12196 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12197 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12198 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12199 function.) Of course, this means that the additional functionality of
12200 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12201
12202 .section "Disabling IPv6" "SECID93"
12203 .cindex "IPv6" "disabling"
12204 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12205 run on a host whose kernel does not support IPv6. The binary will fall back to
12206 using IPv4, but it may waste resources looking up AAAA records, and trying to
12207 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12208 .oindex "&%disable_ipv6%&"
12209 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12210 activities take place. AAAA records are never looked up, and any IPv6 addresses
12211 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12212 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12213 to handle IPv6 literal addresses.
12214
12215 On the other hand, when IPv6 is in use, there may be times when you want to
12216 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12217 option to globally suppress the lookup of AAAA records for specified domains,
12218 and you can use the &%ignore_target_hosts%& generic router option to ignore
12219 IPv6 addresses in an individual router.
12220
12221
12222
12223 .section "Examples of starting a listening daemon" "SECID94"
12224 The default case in an IPv6 environment is
12225 .code
12226 daemon_smtp_ports = smtp
12227 local_interfaces = <; ::0 ; 0.0.0.0
12228 .endd
12229 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12230 Either one or two sockets may be used, depending on the characteristics of
12231 the TCP/IP stack. (This is complicated and messy; for more information,
12232 read the comments in the &_daemon.c_& source file.)
12233
12234 To specify listening on ports 25 and 26 on all interfaces:
12235 .code
12236 daemon_smtp_ports = 25 : 26
12237 .endd
12238 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12239 .code
12240 local_interfaces = <; ::0.25     ; ::0.26 \
12241                       0.0.0.0.25 ; 0.0.0.0.26
12242 .endd
12243 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12244 IPv4 loopback address only:
12245 .code
12246 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12247 .endd
12248 To specify listening on the default port on specific interfaces only:
12249 .code
12250 local_interfaces = 192.168.34.67 : 192.168.34.67
12251 .endd
12252 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12253
12254
12255
12256 .section "Recognizing the local host" "SECTreclocipadd"
12257 The &%local_interfaces%& option is also used when Exim needs to determine
12258 whether or not an IP address refers to the local host. That is, the IP
12259 addresses of all the interfaces on which a daemon is listening are always
12260 treated as local.
12261
12262 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12263 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12264 available interfaces from the operating system, and extracts the relevant
12265 (that is, IPv4 or IPv6) addresses to use for checking.
12266
12267 Some systems set up large numbers of virtual interfaces in order to provide
12268 many virtual web servers. In this situation, you may want to listen for
12269 email on only a few of the available interfaces, but nevertheless treat all
12270 interfaces as local when routing. You can do this by setting
12271 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12272 &"all"& wildcard values. These addresses are recognized as local, but are not
12273 used for listening. Consider this example:
12274 .code
12275 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12276                       192.168.53.235 ; \
12277                       3ffe:2101:12:1:a00:20ff:fe86:a061
12278
12279 extra_local_interfaces = <; ::0 ; 0.0.0.0
12280 .endd
12281 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12282 address, but all available interface addresses are treated as local when
12283 Exim is routing.
12284
12285 In some environments the local host name may be in an MX list, but with an IP
12286 address that is not assigned to any local interface. In other cases it may be
12287 desirable to treat other host names as if they referred to the local host. Both
12288 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12289 This contains host names rather than IP addresses. When a host is referenced
12290 during routing, either via an MX record or directly, it is treated as the local
12291 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12292 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12293
12294
12295
12296 .section "Delivering to a remote host" "SECID95"
12297 Delivery to a remote host is handled by the smtp transport. By default, it
12298 allows the system's TCP/IP functions to choose which interface to use (if
12299 there is more than one) when connecting to a remote host. However, the
12300 &%interface%& option can be set to specify which interface is used. See the
12301 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12302 details.
12303
12304
12305
12306
12307 . ////////////////////////////////////////////////////////////////////////////
12308 . ////////////////////////////////////////////////////////////////////////////
12309
12310 .chapter "Main configuration" "CHAPmainconfig"
12311 .scindex IIDconfima "configuration file" "main section"
12312 .scindex IIDmaiconf "main configuration"
12313 The first part of the run time configuration file contains three types of item:
12314
12315 .ilist
12316 Macro definitions: These lines start with an upper case letter. See section
12317 &<<SECTmacrodefs>>& for details of macro processing.
12318 .next
12319 Named list definitions: These lines start with one of the words &"domainlist"&,
12320 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12321 section &<<SECTnamedlists>>&.
12322 .next
12323 Main configuration settings: Each setting occupies one line of the file
12324 (with possible continuations). If any setting is preceded by the word
12325 &"hide"&, the &%-bP%& command line option displays its value to admin users
12326 only. See section &<<SECTcos>>& for a description of the syntax of these option
12327 settings.
12328 .endlist
12329
12330 This chapter specifies all the main configuration options, along with their
12331 types and default values. For ease of finding a particular option, they appear
12332 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12333 are now so many options, they are first listed briefly in functional groups, as
12334 an aid to finding the name of the option you are looking for. Some options are
12335 listed in more than one group.
12336
12337 .section "Miscellaneous" "SECID96"
12338 .table2
12339 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12340 .row &%disable_ipv6%&                "do no IPv6 processing"
12341 .row &%keep_malformed%&              "for broken files &-- should not happen"
12342 .row &%localhost_number%&            "for unique message ids in clusters"
12343 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12344 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12345 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12346 .row &%print_topbitchars%&           "top-bit characters are printing"
12347 .row &%timezone%&                    "force time zone"
12348 .endtable
12349
12350
12351 .section "Exim parameters" "SECID97"
12352 .table2
12353 .row &%exim_group%&                  "override compiled-in value"
12354 .row &%exim_path%&                   "override compiled-in value"
12355 .row &%exim_user%&                   "override compiled-in value"
12356 .row &%primary_hostname%&            "default from &[uname()]&"
12357 .row &%split_spool_directory%&       "use multiple directories"
12358 .row &%spool_directory%&             "override compiled-in value"
12359 .endtable
12360
12361
12362
12363 .section "Privilege controls" "SECID98"
12364 .table2
12365 .row &%admin_groups%&                "groups that are Exim admin users"
12366 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12367 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12368 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12369 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12370 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12371 .row &%never_users%&                 "do not run deliveries as these"
12372 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12373 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12374 .row &%trusted_groups%&              "groups that are trusted"
12375 .row &%trusted_users%&               "users that are trusted"
12376 .endtable
12377
12378
12379
12380 .section "Logging" "SECID99"
12381 .table2
12382 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12383 .row &%log_file_path%&               "override compiled-in value"
12384 .row &%log_selector%&                "set/unset optional logging"
12385 .row &%log_timezone%&                "add timezone to log lines"
12386 .row &%message_logs%&                "create per-message logs"
12387 .row &%preserve_message_logs%&       "after message completion"
12388 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12389 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12390 .row &%syslog_facility%&             "set syslog &""facility""& field"
12391 .row &%syslog_processname%&          "set syslog &""ident""& field"
12392 .row &%syslog_timestamp%&            "timestamp syslog lines"
12393 .row &%write_rejectlog%&             "control use of message log"
12394 .endtable
12395
12396
12397
12398 .section "Frozen messages" "SECID100"
12399 .table2
12400 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12401 .row &%freeze_tell%&                 "send message when freezing"
12402 .row &%move_frozen_messages%&        "to another directory"
12403 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12404 .endtable
12405
12406
12407
12408 .section "Data lookups" "SECID101"
12409 .table2
12410 .row &%ibase_servers%&               "InterBase servers"
12411 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
12412 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
12413 .row &%ldap_cert_file%&              "client cert file for LDAP"
12414 .row &%ldap_cert_key%&               "client key file for LDAP"
12415 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
12416 .row &%ldap_default_servers%&        "used if no server in query"
12417 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
12418 .row &%ldap_start_tls%&              "require TLS within LDAP"
12419 .row &%ldap_version%&                "set protocol version"
12420 .row &%lookup_open_max%&             "lookup files held open"
12421 .row &%mysql_servers%&               "default MySQL servers"
12422 .row &%oracle_servers%&              "Oracle servers"
12423 .row &%pgsql_servers%&               "default PostgreSQL servers"
12424 .row &%sqlite_lock_timeout%&         "as it says"
12425 .endtable
12426
12427
12428
12429 .section "Message ids" "SECID102"
12430 .table2
12431 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12432 .row &%message_id_header_text%&      "ditto"
12433 .endtable
12434
12435
12436
12437 .section "Embedded Perl Startup" "SECID103"
12438 .table2
12439 .row &%perl_at_start%&               "always start the interpreter"
12440 .row &%perl_startup%&                "code to obey when starting Perl"
12441 .endtable
12442
12443
12444
12445 .section "Daemon" "SECID104"
12446 .table2
12447 .row &%daemon_smtp_ports%&           "default ports"
12448 .row &%daemon_startup_retries%&      "number of times to retry"
12449 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12450 .row &%extra_local_interfaces%&      "not necessarily listened on"
12451 .row &%local_interfaces%&            "on which to listen, with optional ports"
12452 .row &%pid_file_path%&               "override compiled-in value"
12453 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12454 .endtable
12455
12456
12457
12458 .section "Resource control" "SECID105"
12459 .table2
12460 .row &%check_log_inodes%&            "before accepting a message"
12461 .row &%check_log_space%&             "before accepting a message"
12462 .row &%check_spool_inodes%&          "before accepting a message"
12463 .row &%check_spool_space%&           "before accepting a message"
12464 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12465 .row &%queue_only_load%&             "queue incoming if load high"
12466 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12467 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12468 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12469 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12470 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12471 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12472 .row &%smtp_accept_max_per_connection%& "messages per connection"
12473 .row &%smtp_accept_max_per_host%&    "connections from one host"
12474 .row &%smtp_accept_queue%&           "queue mail if more connections"
12475 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12476                                            connection"
12477 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12478 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12479 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12480 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12481 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12482 .endtable
12483
12484
12485
12486 .section "Policy controls" "SECID106"
12487 .table2
12488 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12489 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12490 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12491 .row &%acl_smtp_auth%&               "ACL for AUTH"
12492 .row &%acl_smtp_connect%&            "ACL for connection"
12493 .row &%acl_smtp_data%&               "ACL for DATA"
12494 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12495 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12496 .row &%acl_smtp_expn%&               "ACL for EXPN"
12497 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12498 .row &%acl_smtp_mail%&               "ACL for MAIL"
12499 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12500 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12501 .row &%acl_smtp_predata%&            "ACL for start of data"
12502 .row &%acl_smtp_quit%&               "ACL for QUIT"
12503 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12504 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
12505 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
12506 .row &%av_scanner%&                  "specify virus scanner"
12507 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12508                                       words""&"
12509 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
12510 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
12511 .row &%header_maxsize%&              "total size of message header"
12512 .row &%header_line_maxsize%&         "individual header line limit"
12513 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
12514 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
12515 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
12516 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
12517 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
12518 .row &%host_lookup%&                 "host name looked up for these hosts"
12519 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12520 .row &%host_reject_connection%&      "reject connection from these hosts"
12521 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
12522 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
12523 .row &%message_size_limit%&          "for all messages"
12524 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12525 .row &%spamd_address%&               "set interface to SpamAssassin"
12526 .row &%strict_acl_vars%&             "object to unset ACL variables"
12527 .endtable
12528
12529
12530
12531 .section "Callout cache" "SECID107"
12532 .table2
12533 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
12534                                          item"
12535 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
12536                                          item"
12537 .row &%callout_negative_expire%&     "timeout for negative address cache item"
12538 .row &%callout_positive_expire%&     "timeout for positive address cache item"
12539 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
12540 .endtable
12541
12542
12543
12544 .section "TLS" "SECID108"
12545 .table2
12546 .row &%gnutls_require_kx%&           "control GnuTLS key exchanges"
12547 .row &%gnutls_require_mac%&          "control GnuTLS MAC algorithms"
12548 .row &%gnutls_require_protocols%&    "control GnuTLS protocols"
12549 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
12550 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
12551 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12552 .row &%tls_certificate%&             "location of server certificate"
12553 .row &%tls_crl%&                     "certificate revocation list"
12554 .row &%tls_dhparam%&                 "DH parameters for server"
12555 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
12556 .row &%tls_privatekey%&              "location of server private key"
12557 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
12558 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
12559 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
12560 .row &%tls_verify_certificates%&     "expected client certificates"
12561 .row &%tls_verify_hosts%&            "insist on client certificate verify"
12562 .endtable
12563
12564
12565
12566 .section "Local user handling" "SECID109"
12567 .table2
12568 .row &%finduser_retries%&            "useful in NIS environments"
12569 .row &%gecos_name%&                  "used when creating &'Sender:'&"
12570 .row &%gecos_pattern%&               "ditto"
12571 .row &%max_username_length%&         "for systems that truncate"
12572 .row &%unknown_login%&               "used when no login name found"
12573 .row &%unknown_username%&            "ditto"
12574 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
12575 .row &%uucp_from_sender%&            "ditto"
12576 .endtable
12577
12578
12579
12580 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
12581 .table2
12582 .row &%header_maxsize%&              "total size of message header"
12583 .row &%header_line_maxsize%&         "individual header line limit"
12584 .row &%message_size_limit%&          "applies to all messages"
12585 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12586 .row &%received_header_text%&        "expanded to make &'Received:'&"
12587 .row &%received_headers_max%&        "for mail loop detection"
12588 .row &%recipients_max%&              "limit per message"
12589 .row &%recipients_max_reject%&       "permanently reject excess recipients"
12590 .endtable
12591
12592
12593
12594
12595 .section "Non-SMTP incoming messages" "SECID111"
12596 .table2
12597 .row &%receive_timeout%&             "for non-SMTP messages"
12598 .endtable
12599
12600
12601
12602
12603
12604 .section "Incoming SMTP messages" "SECID112"
12605 See also the &'Policy controls'& section above.
12606
12607 .table2
12608 .row &%host_lookup%&                 "host name looked up for these hosts"
12609 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12610 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
12611 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
12612 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
12613 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
12614 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
12615 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12616 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12617 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12618 .row &%smtp_accept_max_per_connection%& "messages per connection"
12619 .row &%smtp_accept_max_per_host%&    "connections from one host"
12620 .row &%smtp_accept_queue%&           "queue mail if more connections"
12621 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12622                                            connection"
12623 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12624 .row &%smtp_active_hostname%&        "host name to use in messages"
12625 .row &%smtp_banner%&                 "text for welcome banner"
12626 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12627 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12628 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
12629 .row &%smtp_etrn_command%&           "what to run for ETRN"
12630 .row &%smtp_etrn_serialize%&         "only one at once"
12631 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
12632 .row &%smtp_max_unknown_commands%&   "before dropping connection"
12633 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
12634 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
12635 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
12636 .row &%smtp_receive_timeout%&        "per command or data line"
12637 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12638 .row &%smtp_return_error_details%&   "give detail on rejections"
12639 .endtable
12640
12641
12642
12643 .section "SMTP extensions" "SECID113"
12644 .table2
12645 .row &%accept_8bitmime%&             "advertise 8BITMIME"
12646 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
12647 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
12648 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
12649 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
12650 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12651 .endtable
12652
12653
12654
12655 .section "Processing messages" "SECID114"
12656 .table2
12657 .row &%allow_domain_literals%&       "recognize domain literal syntax"
12658 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
12659 .row &%allow_utf8_domains%&          "in addresses"
12660 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12661                                       words""&"
12662 .row &%delivery_date_remove%&        "from incoming messages"
12663 .row &%envelope_to_remove%&          "from incoming messages"
12664 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
12665 .row &%headers_charset%&             "default for translations"
12666 .row &%qualify_domain%&              "default for senders"
12667 .row &%qualify_recipient%&           "default for recipients"
12668 .row &%return_path_remove%&          "from incoming messages"
12669 .row &%strip_excess_angle_brackets%& "in addresses"
12670 .row &%strip_trailing_dot%&          "at end of addresses"
12671 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
12672 .endtable
12673
12674
12675
12676 .section "System filter" "SECID115"
12677 .table2
12678 .row &%system_filter%&               "locate system filter"
12679 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
12680                                             directory"
12681 .row &%system_filter_file_transport%& "transport for delivery to a file"
12682 .row &%system_filter_group%&         "group for filter running"
12683 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
12684 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
12685 .row &%system_filter_user%&          "user for filter running"
12686 .endtable
12687
12688
12689
12690 .section "Routing and delivery" "SECID116"
12691 .table2
12692 .row &%disable_ipv6%&                "do no IPv6 processing"
12693 .row &%dns_again_means_nonexist%&    "for broken domains"
12694 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
12695 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
12696 .row &%dns_retrans%&                 "parameter for resolver"
12697 .row &%dns_retry%&                   "parameter for resolver"
12698 .row &%hold_domains%&                "hold delivery for these domains"
12699 .row &%local_interfaces%&            "for routing checks"
12700 .row &%queue_domains%&               "no immediate delivery for these"
12701 .row &%queue_only%&                  "no immediate delivery at all"
12702 .row &%queue_only_file%&             "no immediate delivery if file exists"
12703 .row &%queue_only_load%&             "no immediate delivery if load is high"
12704 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12705 .row &%queue_only_override%&         "allow command line to override"
12706 .row &%queue_run_in_order%&          "order of arrival"
12707 .row &%queue_run_max%&               "of simultaneous queue runners"
12708 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
12709 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12710 .row &%remote_sort_domains%&         "order of remote deliveries"
12711 .row &%retry_data_expire%&           "timeout for retry data"
12712 .row &%retry_interval_max%&          "safety net for retry rules"
12713 .endtable
12714
12715
12716
12717 .section "Bounce and warning messages" "SECID117"
12718 .table2
12719 .row &%bounce_message_file%&         "content of bounce"
12720 .row &%bounce_message_text%&         "content of bounce"
12721 .row &%bounce_return_body%&          "include body if returning message"
12722 .row &%bounce_return_message%&       "include original message in bounce"
12723 .row &%bounce_return_size_limit%&    "limit on returned message"
12724 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
12725 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
12726 .row &%errors_copy%&                 "copy bounce messages"
12727 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
12728 .row &%delay_warning%&               "time schedule"
12729 .row &%delay_warning_condition%&     "condition for warning messages"
12730 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
12731 .row &%smtp_return_error_details%&   "give detail on rejections"
12732 .row &%warn_message_file%&           "content of warning message"
12733 .endtable
12734
12735
12736
12737 .section "Alphabetical list of main options" "SECTalomo"
12738 Those options that undergo string expansion before use are marked with
12739 &dagger;.
12740
12741 .option accept_8bitmime main boolean false
12742 .cindex "8BITMIME"
12743 .cindex "8-bit characters"
12744 This option causes Exim to send 8BITMIME in its response to an SMTP
12745 EHLO command, and to accept the BODY= parameter on MAIL commands.
12746 However, though Exim is 8-bit clean, it is not a protocol converter, and it
12747 takes no steps to do anything special with messages received by this route.
12748 Consequently, this option is turned off by default.
12749
12750 .option acl_not_smtp main string&!! unset
12751 .cindex "&ACL;" "for non-SMTP messages"
12752 .cindex "non-SMTP messages" "ACLs for"
12753 This option defines the ACL that is run when a non-SMTP message has been
12754 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
12755 further details.
12756
12757 .option acl_not_smtp_mime main string&!! unset
12758 This option defines the ACL that is run for individual MIME parts of non-SMTP
12759 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
12760 SMTP messages.
12761
12762 .option acl_not_smtp_start main string&!! unset
12763 .cindex "&ACL;" "at start of non-SMTP message"
12764 .cindex "non-SMTP messages" "ACLs for"
12765 This option defines the ACL that is run before Exim starts reading a
12766 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
12767
12768 .option acl_smtp_auth main string&!! unset
12769 .cindex "&ACL;" "setting up for SMTP commands"
12770 .cindex "AUTH" "ACL for"
12771 This option defines the ACL that is run when an SMTP AUTH command is
12772 received. See chapter &<<CHAPACL>>& for further details.
12773
12774 .option acl_smtp_connect main string&!! unset
12775 .cindex "&ACL;" "on SMTP connection"
12776 This option defines the ACL that is run when an SMTP connection is received.
12777 See chapter &<<CHAPACL>>& for further details.
12778
12779 .option acl_smtp_data main string&!! unset
12780 .cindex "DATA" "ACL for"
12781 This option defines the ACL that is run after an SMTP DATA command has been
12782 processed and the message itself has been received, but before the final
12783 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
12784
12785 .option acl_smtp_etrn main string&!! unset
12786 .cindex "ETRN" "ACL for"
12787 This option defines the ACL that is run when an SMTP ETRN command is
12788 received. See chapter &<<CHAPACL>>& for further details.
12789
12790 .option acl_smtp_expn main string&!! unset
12791 .cindex "EXPN" "ACL for"
12792 This option defines the ACL that is run when an SMTP EXPN command is
12793 received. See chapter &<<CHAPACL>>& for further details.
12794
12795 .option acl_smtp_helo main string&!! unset
12796 .cindex "EHLO" "ACL for"
12797 .cindex "HELO" "ACL for"
12798 This option defines the ACL that is run when an SMTP EHLO or HELO
12799 command is received. See chapter &<<CHAPACL>>& for further details.
12800
12801
12802 .option acl_smtp_mail main string&!! unset
12803 .cindex "MAIL" "ACL for"
12804 This option defines the ACL that is run when an SMTP MAIL command is
12805 received. See chapter &<<CHAPACL>>& for further details.
12806
12807 .option acl_smtp_mailauth main string&!! unset
12808 .cindex "AUTH" "on MAIL command"
12809 This option defines the ACL that is run when there is an AUTH parameter on
12810 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
12811 &<<CHAPSMTPAUTH>>& for details of authentication.
12812
12813 .option acl_smtp_mime main string&!! unset
12814 .cindex "MIME content scanning" "ACL for"
12815 This option is available when Exim is built with the content-scanning
12816 extension. It defines the ACL that is run for each MIME part in a message. See
12817 section &<<SECTscanmimepart>>& for details.
12818
12819 .option acl_smtp_predata main string&!! unset
12820 This option defines the ACL that is run when an SMTP DATA command is
12821 received, before the message itself is received. See chapter &<<CHAPACL>>& for
12822 further details.
12823
12824 .option acl_smtp_quit main string&!! unset
12825 .cindex "QUIT, ACL for"
12826 This option defines the ACL that is run when an SMTP QUIT command is
12827 received. See chapter &<<CHAPACL>>& for further details.
12828
12829 .option acl_smtp_rcpt main string&!! unset
12830 .cindex "RCPT" "ACL for"
12831 This option defines the ACL that is run when an SMTP RCPT command is
12832 received. See chapter &<<CHAPACL>>& for further details.
12833
12834 .option acl_smtp_starttls main string&!! unset
12835 .cindex "STARTTLS, ACL for"
12836 This option defines the ACL that is run when an SMTP STARTTLS command is
12837 received. See chapter &<<CHAPACL>>& for further details.
12838
12839 .option acl_smtp_vrfy main string&!! unset
12840 .cindex "VRFY" "ACL for"
12841 This option defines the ACL that is run when an SMTP VRFY command is
12842 received. See chapter &<<CHAPACL>>& for further details.
12843
12844 .option admin_groups main "string list&!!" unset
12845 .cindex "admin user"
12846 This option is expanded just once, at the start of Exim's processing. If the
12847 current group or any of the supplementary groups of an Exim caller is in this
12848 colon-separated list, the caller has admin privileges. If all your system
12849 programmers are in a specific group, for example, you can give them all Exim
12850 admin privileges by putting that group in &%admin_groups%&. However, this does
12851 not permit them to read Exim's spool files (whose group owner is the Exim gid).
12852 To permit this, you have to add individuals to the Exim group.
12853
12854 .option allow_domain_literals main boolean false
12855 .cindex "domain literal"
12856 If this option is set, the RFC 2822 domain literal format is permitted in
12857 email addresses. The option is not set by default, because the domain literal
12858 format is not normally required these days, and few people know about it. It
12859 has, however, been exploited by mail abusers.
12860
12861 Unfortunately, it seems that some DNS black list maintainers are using this
12862 format to report black listing to postmasters. If you want to accept messages
12863 addressed to your hosts by IP address, you need to set
12864 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
12865 domains (defined in the named domain list &%local_domains%& in the default
12866 configuration). This &"magic string"& matches the domain literal form of all
12867 the local host's IP addresses.
12868
12869
12870 .option allow_mx_to_ip main boolean false
12871 .cindex "MX record" "pointing to IP address"
12872 It appears that more and more DNS zone administrators are breaking the rules
12873 and putting domain names that look like IP addresses on the right hand side of
12874 MX records. Exim follows the rules and rejects this, giving an error message
12875 that explains the mis-configuration. However, some other MTAs support this
12876 practice, so to avoid &"Why can't Exim do this?"& complaints,
12877 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
12878 recommended, except when you have no other choice.
12879
12880 .option allow_utf8_domains main boolean false
12881 .cindex "domain" "UTF-8 characters in"
12882 .cindex "UTF-8" "in domain name"
12883 Lots of discussion is going on about internationalized domain names. One
12884 camp is strongly in favour of just using UTF-8 characters, and it seems
12885 that at least two other MTAs permit this. This option allows Exim users to
12886 experiment if they wish.
12887
12888 If it is set true, Exim's domain parsing function allows valid
12889 UTF-8 multicharacters to appear in domain name components, in addition to
12890 letters, digits, and hyphens. However, just setting this option is not
12891 enough; if you want to look up these domain names in the DNS, you must also
12892 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
12893 suitable setting is:
12894 .code
12895 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
12896   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
12897 .endd
12898 Alternatively, you can just disable this feature by setting
12899 .code
12900 dns_check_names_pattern =
12901 .endd
12902 That is, set the option to an empty string so that no check is done.
12903
12904
12905 .option auth_advertise_hosts main "host list&!!" *
12906 .cindex "authentication" "advertising"
12907 .cindex "AUTH" "advertising"
12908 If any server authentication mechanisms are configured, Exim advertises them in
12909 response to an EHLO command only if the calling host matches this list.
12910 Otherwise, Exim does not advertise AUTH.
12911 Exim does not accept AUTH commands from clients to which it has not
12912 advertised the availability of AUTH. The advertising of individual
12913 authentication mechanisms can be controlled by the use of the
12914 &%server_advertise_condition%& generic authenticator option on the individual
12915 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
12916
12917 Certain mail clients (for example, Netscape) require the user to provide a name
12918 and password for authentication if AUTH is advertised, even though it may
12919 not be needed (the host may accept messages from hosts on its local LAN without
12920 authentication, for example). The &%auth_advertise_hosts%& option can be used
12921 to make these clients more friendly by excluding them from the set of hosts to
12922 which Exim advertises AUTH.
12923
12924 .cindex "AUTH" "advertising when encrypted"
12925 If you want to advertise the availability of AUTH only when the connection
12926 is encrypted using TLS, you can make use of the fact that the value of this
12927 option is expanded, with a setting like this:
12928 .code
12929 auth_advertise_hosts = ${if eq{$tls_cipher}{}{}{*}}
12930 .endd
12931 .vindex "&$tls_cipher$&"
12932 If &$tls_cipher$& is empty, the session is not encrypted, and the result of
12933 the expansion is empty, thus matching no hosts. Otherwise, the result of the
12934 expansion is *, which matches all hosts.
12935
12936
12937 .option auto_thaw main time 0s
12938 .cindex "thawing messages"
12939 .cindex "unfreezing messages"
12940 If this option is set to a time greater than zero, a queue runner will try a
12941 new delivery attempt on any frozen message, other than a bounce message, if
12942 this much time has passed since it was frozen. This may result in the message
12943 being re-frozen if nothing has changed since the last attempt. It is a way of
12944 saying &"keep on trying, even though there are big problems"&.
12945
12946 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
12947 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
12948 thought to be very useful any more, and its use should probably be avoided.
12949
12950 .new
12951 .option av_scanner main string "see below"
12952 This option is available if Exim is built with the content-scanning extension.
12953 It specifies which anti-virus scanner to use. The default value is:
12954 .code
12955 sophie:/var/run/sophie
12956 .endd
12957 If the value of &%av_scanner%& starts with a dollar character, it is expanded
12958 before use. See section &<<SECTscanvirus>>& for further details.
12959 .wen
12960
12961
12962 .option bi_command main string unset
12963 .oindex "&%-bi%&"
12964 This option supplies the name of a command that is run when Exim is called with
12965 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
12966 just the command name, it is not a complete command line. If an argument is
12967 required, it must come from the &%-oA%& command line option.
12968
12969
12970 .option bounce_message_file main string unset
12971 .cindex "bounce message" "customizing"
12972 .cindex "customizing" "bounce message"
12973 This option defines a template file containing paragraphs of text to be used
12974 for constructing bounce messages.  Details of the file's contents are given in
12975 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
12976
12977
12978 .option bounce_message_text main string unset
12979 When this option is set, its contents are included in the default bounce
12980 message immediately after &"This message was created automatically by mail
12981 delivery software."& It is not used if &%bounce_message_file%& is set.
12982
12983 .option bounce_return_body main boolean true
12984 .cindex "bounce message" "including body"
12985 This option controls whether the body of an incoming message is included in a
12986 bounce message when &%bounce_return_message%& is true. The default setting
12987 causes the entire message, both header and body, to be returned (subject to the
12988 value of &%bounce_return_size_limit%&). If this option is false, only the
12989 message header is included. In the case of a non-SMTP message containing an
12990 error that is detected during reception, only those header lines preceding the
12991 point at which the error was detected are returned.
12992 .cindex "bounce message" "including original"
12993
12994 .option bounce_return_message main boolean true
12995 If this option is set false, none of the original message is included in
12996 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
12997 &%bounce_return_body%&.
12998
12999
13000 .option bounce_return_size_limit main integer 100K
13001 .cindex "size" "of bounce, limit"
13002 .cindex "bounce message" "size limit"
13003 .cindex "limit" "bounce message size"
13004 This option sets a limit in bytes on the size of messages that are returned to
13005 senders as part of bounce messages when &%bounce_return_message%& is true. The
13006 limit should be less than the value of the global &%message_size_limit%& and of
13007 any &%message_size_limit%& settings on transports, to allow for the bounce text
13008 that Exim generates. If this option is set to zero there is no limit.
13009
13010 When the body of any message that is to be included in a bounce message is
13011 greater than the limit, it is truncated, and a comment pointing this out is
13012 added at the top. The actual cutoff may be greater than the value given, owing
13013 to the use of buffering for transferring the message in chunks (typically 8K in
13014 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13015 messages.
13016
13017 .option bounce_sender_authentication main string unset
13018 .cindex "bounce message" "sender authentication"
13019 .cindex "authentication" "bounce message"
13020 .cindex "AUTH" "on bounce message"
13021 This option provides an authenticated sender address that is sent with any
13022 bounce messages generated by Exim that are sent over an authenticated SMTP
13023 connection. A typical setting might be:
13024 .code
13025 bounce_sender_authentication = mailer-daemon@my.domain.example
13026 .endd
13027 which would cause bounce messages to be sent using the SMTP command:
13028 .code
13029 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13030 .endd
13031 The value of &%bounce_sender_authentication%& must always be a complete email
13032 address.
13033
13034 .option callout_domain_negative_expire main time 3h
13035 .cindex "caching" "callout timeouts"
13036 .cindex "callout" "caching timeouts"
13037 This option specifies the expiry time for negative callout cache data for a
13038 domain. See section &<<SECTcallver>>& for details of callout verification, and
13039 section &<<SECTcallvercache>>& for details of the caching.
13040
13041
13042 .option callout_domain_positive_expire main time 7d
13043 This option specifies the expiry time for positive callout cache data for a
13044 domain. See section &<<SECTcallver>>& for details of callout verification, and
13045 section &<<SECTcallvercache>>& for details of the caching.
13046
13047
13048 .option callout_negative_expire main time 2h
13049 This option specifies the expiry time for negative callout cache data for an
13050 address. See section &<<SECTcallver>>& for details of callout verification, and
13051 section &<<SECTcallvercache>>& for details of the caching.
13052
13053
13054 .option callout_positive_expire main time 24h
13055 This option specifies the expiry time for positive callout cache data for an
13056 address. See section &<<SECTcallver>>& for details of callout verification, and
13057 section &<<SECTcallvercache>>& for details of the caching.
13058
13059
13060 .option callout_random_local_part main string&!! "see below"
13061 This option defines the &"random"& local part that can be used as part of
13062 callout verification. The default value is
13063 .code
13064 $primary_host_name-$tod_epoch-testing
13065 .endd
13066 See section &<<CALLaddparcall>>& for details of how this value is used.
13067
13068
13069 .option check_log_inodes main integer 0
13070 See &%check_spool_space%& below.
13071
13072
13073 .option check_log_space main integer 0
13074 See &%check_spool_space%& below.
13075
13076 .oindex "&%check_rfc2047_length%&"
13077 .cindex "RFC 2047" "disabling length check"
13078 .option check_rfc2047_length main boolean true
13079 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13080 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13081 word; strings to be encoded that exceed this length are supposed to use
13082 multiple encoded words. By default, Exim does not recognize encoded words that
13083 exceed the maximum length. However, it seems that some software, in violation
13084 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13085 set false, Exim recognizes encoded words of any length.
13086
13087
13088 .option check_spool_inodes main integer 0
13089 See &%check_spool_space%& below.
13090
13091
13092 .option check_spool_space main integer 0
13093 .cindex "checking disk space"
13094 .cindex "disk space, checking"
13095 .cindex "spool directory" "checking space"
13096 The four &%check_...%& options allow for checking of disk resources before a
13097 message is accepted.
13098
13099 .vindex "&$log_inodes$&"
13100 .vindex "&$log_space$&"
13101 .vindex "&$spool_inodes$&"
13102 .vindex "&$spool_space$&"
13103 When any of these options are set, they apply to all incoming messages. If you
13104 want to apply different checks to different kinds of message, you can do so by
13105 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13106 &$spool_space$& in an ACL with appropriate additional conditions.
13107
13108
13109 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13110 either value is greater than zero, for example:
13111 .code
13112 check_spool_space = 10M
13113 check_spool_inodes = 100
13114 .endd
13115 The spool partition is the one that contains the directory defined by
13116 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13117 transit.
13118
13119 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13120 files are written if either is greater than zero. These should be set only if
13121 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13122
13123 If there is less space or fewer inodes than requested, Exim refuses to accept
13124 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13125 error response to the MAIL command. If ESMTP is in use and there was a
13126 SIZE parameter on the MAIL command, its value is added to the
13127 &%check_spool_space%& value, and the check is performed even if
13128 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13129
13130 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13131 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13132
13133 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13134 failure a message is written to stderr and Exim exits with a non-zero code, as
13135 it obviously cannot send an error message of any kind.
13136
13137 .option daemon_smtp_ports main string &`smtp`&
13138 .cindex "port" "for daemon"
13139 .cindex "TCP/IP" "setting listening ports"
13140 This option specifies one or more default SMTP ports on which the Exim daemon
13141 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13142 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13143
13144 .option daemon_startup_retries main integer 9
13145 .cindex "daemon startup, retrying"
13146 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13147 the daemon at startup when it cannot immediately bind a listening socket
13148 (typically because the socket is already in use): &%daemon_startup_retries%&
13149 defines the number of retries after the first failure, and
13150 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13151
13152 .option daemon_startup_sleep main time 30s
13153 See &%daemon_startup_retries%&.
13154
13155 .option delay_warning main "time list" 24h
13156 .cindex "warning of delay"
13157 .cindex "delay warning, specifying"
13158 When a message is delayed, Exim sends a warning message to the sender at
13159 intervals specified by this option. The data is a colon-separated list of times
13160 after which to send warning messages. If the value of the option is an empty
13161 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13162 message has been on the queue for longer than the last time, the last interval
13163 between the times is used to compute subsequent warning times. For example,
13164 with
13165 .code
13166 delay_warning = 4h:8h:24h
13167 .endd
13168 the first message is sent after 4 hours, the second after 8 hours, and
13169 the third one after 24 hours. After that, messages are sent every 16 hours,
13170 because that is the interval between the last two times on the list. If you set
13171 just one time, it specifies the repeat interval. For example, with:
13172 .code
13173 delay_warning = 6h
13174 .endd
13175 messages are repeated every six hours. To stop warnings after a given time, set
13176 a very large time at the end of the list. For example:
13177 .code
13178 delay_warning = 2h:12h:99d
13179 .endd
13180
13181 .option delay_warning_condition main string&!! "see below"
13182 .vindex "&$domain$&"
13183 The string is expanded at the time a warning message might be sent. If all the
13184 deferred addresses have the same domain, it is set in &$domain$& during the
13185 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13186 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13187 &"false"& (the comparison being done caselessly) then the warning message is
13188 not sent. The default is:
13189 .code
13190 delay_warning_condition = ${if or {\
13191   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13192   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13193   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13194   } {no}{yes}}
13195 .endd
13196 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13197 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13198 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13199 &"auto-replied"& in an &'Auto-Submitted:'& header.
13200
13201 .option deliver_drop_privilege main boolean false
13202 .cindex "unprivileged delivery"
13203 .cindex "delivery" "unprivileged"
13204 If this option is set true, Exim drops its root privilege at the start of a
13205 delivery process, and runs as the Exim user throughout. This severely restricts
13206 the kinds of local delivery that are possible, but is viable in certain types
13207 of configuration. There is a discussion about the use of root privilege in
13208 chapter &<<CHAPsecurity>>&.
13209
13210 .option deliver_queue_load_max main fixed-point unset
13211 .cindex "load average"
13212 .cindex "queue runner" "abandoning"
13213 When this option is set, a queue run is abandoned if the system load average
13214 becomes greater than the value of the option. The option has no effect on
13215 ancient operating systems on which Exim cannot determine the load average.
13216 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13217
13218
13219 .option delivery_date_remove main boolean true
13220 .cindex "&'Delivery-date:'& header line"
13221 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13222 message when it is delivered, in exactly the same way as &'Return-path:'& is
13223 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13224 should not be present in incoming messages, and this option causes them to be
13225 removed at the time the message is received, to avoid any problems that might
13226 occur when a delivered message is subsequently sent on to some other recipient.
13227
13228 .option disable_fsync main boolean false
13229 .cindex "&[fsync()]&, disabling"
13230 This option is available only if Exim was built with the compile-time option
13231 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13232 a runtime configuration generates an &"unknown option"& error. You should not
13233 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13234 really, really, really understand what you are doing. &'No pre-compiled
13235 distributions of Exim should ever make this option available.'&
13236
13237 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13238 updated files' data to be written to disc before continuing. Unexpected events
13239 such as crashes and power outages may cause data to be lost or scrambled.
13240 Here be Dragons. &*Beware.*&
13241
13242
13243 .option disable_ipv6 main boolean false
13244 .cindex "IPv6" "disabling"
13245 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13246 activities take place. AAAA records are never looked up, and any IPv6 addresses
13247 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13248 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13249 to handle IPv6 literal addresses.
13250
13251
13252 .option dns_again_means_nonexist main "domain list&!!" unset
13253 .cindex "DNS" "&""try again""& response; overriding"
13254 DNS lookups give a &"try again"& response for the DNS errors
13255 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13256 keep trying to deliver a message, or to give repeated temporary errors to
13257 incoming mail. Sometimes the effect is caused by a badly set up name server and
13258 may persist for a long time. If a domain which exhibits this problem matches
13259 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13260 This option should be used with care. You can make it apply to reverse lookups
13261 by a setting such as this:
13262 .code
13263 dns_again_means_nonexist = *.in-addr.arpa
13264 .endd
13265 This option applies to all DNS lookups that Exim does. It also applies when the
13266 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13267 since these are most likely to be caused by DNS lookup problems. The
13268 &(dnslookup)& router has some options of its own for controlling what happens
13269 when lookups for MX or SRV records give temporary errors. These more specific
13270 options are applied after this global option.
13271
13272 .option dns_check_names_pattern main string "see below"
13273 .cindex "DNS" "pre-check of name syntax"
13274 When this option is set to a non-empty string, it causes Exim to check domain
13275 names for characters that are not allowed in host names before handing them to
13276 the DNS resolver, because some resolvers give temporary errors for names that
13277 contain unusual characters. If a domain name contains any unwanted characters,
13278 a &"not found"& result is forced, and the resolver is not called. The check is
13279 done by matching the domain name against a regular expression, which is the
13280 value of this option. The default pattern is
13281 .code
13282 dns_check_names_pattern = \
13283   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13284 .endd
13285 which permits only letters, digits, slashes, and hyphens in components, but
13286 they must start and end with a letter or digit. Slashes are not, in fact,
13287 permitted in host names, but they are found in certain NS records (which can be
13288 accessed in Exim by using a &%dnsdb%& lookup). If you set
13289 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13290 empty string.
13291
13292 .option dns_csa_search_limit main integer 5
13293 This option controls the depth of parental searching for CSA SRV records in the
13294 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13295
13296 .option dns_csa_use_reverse main boolean true
13297 This option controls whether or not an IP address, given as a CSA domain, is
13298 reversed and looked up in the reverse DNS, as described in more detail in
13299 section &<<SECTverifyCSA>>&.
13300
13301 .option dns_ipv4_lookup main "domain list&!!" unset
13302 .cindex "IPv6" "DNS lookup for AAAA records"
13303 .cindex "DNS" "IPv6 lookup for AAAA records"
13304 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13305 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13306 (A records) when trying to find IP addresses for hosts, unless the host's
13307 domain matches this list.
13308
13309 This is a fudge to help with name servers that give big delays or otherwise do
13310 not work for the AAAA record type. In due course, when the world's name
13311 servers have all been upgraded, there should be no need for this option.
13312
13313
13314 .option dns_retrans main time 0s
13315 .cindex "DNS" "resolver options"
13316 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13317 retransmission and retry parameters for DNS lookups. Values of zero (the
13318 defaults) leave the system default settings unchanged. The first value is the
13319 time between retries, and the second is the number of retries. It isn't
13320 totally clear exactly how these settings affect the total time a DNS lookup may
13321 take. I haven't found any documentation about timeouts on DNS lookups; these
13322 parameter values are available in the external resolver interface structure,
13323 but nowhere does it seem to describe how they are used or what you might want
13324 to set in them.
13325
13326
13327 .option dns_retry main integer 0
13328 See &%dns_retrans%& above.
13329
13330
13331 .option drop_cr main boolean false
13332 This is an obsolete option that is now a no-op. It used to affect the way Exim
13333 handled CR and LF characters in incoming messages. What happens now is
13334 described in section &<<SECTlineendings>>&.
13335
13336 .option dsn_from main "string&!!" "see below"
13337 .cindex "&'From:'& header line" "in bounces"
13338 .cindex "bounce messages" "&'From:'& line, specifying"
13339 This option can be used to vary the contents of &'From:'& header lines in
13340 bounces and other automatically generated messages (&"Delivery Status
13341 Notifications"& &-- hence the name of the option). The default setting is:
13342 .code
13343 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13344 .endd
13345 The value is expanded every time it is needed. If the expansion fails, a
13346 panic is logged, and the default value is used.
13347
13348 .option envelope_to_remove main boolean true
13349 .cindex "&'Envelope-to:'& header line"
13350 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13351 message when it is delivered, in exactly the same way as &'Return-path:'& is
13352 handled. &'Envelope-to:'& records the original recipient address from the
13353 messages's envelope that caused the delivery to happen. Such headers should not
13354 be present in incoming messages, and this option causes them to be removed at
13355 the time the message is received, to avoid any problems that might occur when a
13356 delivered message is subsequently sent on to some other recipient.
13357
13358
13359 .option errors_copy main "string list&!!" unset
13360 .cindex "bounce message" "copy to other address"
13361 .cindex "copy of bounce message"
13362 Setting this option causes Exim to send bcc copies of bounce messages that it
13363 generates to other addresses. &*Note*&: This does not apply to bounce messages
13364 coming from elsewhere. The value of the option is a colon-separated list of
13365 items. Each item consists of a pattern, terminated by white space, followed by
13366 a comma-separated list of email addresses. If a pattern contains spaces, it
13367 must be enclosed in double quotes.
13368
13369 Each pattern is processed in the same way as a single item in an address list
13370 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13371 the bounce message, the message is copied to the addresses on the list. The
13372 items are scanned in order, and once a matching one is found, no further items
13373 are examined. For example:
13374 .code
13375 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13376               rqps@mydomain   hostmaster@mydomain.example,\
13377                               postmaster@mydomain.example
13378 .endd
13379 .vindex "&$domain$&"
13380 .vindex "&$local_part$&"
13381 The address list is expanded before use. The expansion variables &$local_part$&
13382 and &$domain$& are set from the original recipient of the error message, and if
13383 there was any wildcard matching in the pattern, the expansion
13384 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13385 variables &$0$&, &$1$&, etc. are set in the normal way.
13386
13387
13388 .option errors_reply_to main string unset
13389 .cindex "bounce message" "&'Reply-to:'& in"
13390 By default, Exim's bounce and delivery warning messages contain the header line
13391 .display
13392 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13393 .endd
13394 .oindex &%quota_warn_message%&
13395 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13396 A warning message that is generated by the &%quota_warn_message%& option in an
13397 &(appendfile)& transport may contain its own &'From:'& header line that
13398 overrides the default.
13399
13400 Experience shows that people reply to bounce messages. If the
13401 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13402 and warning messages. For example:
13403 .code
13404 errors_reply_to = postmaster@my.domain.example
13405 .endd
13406 The value of the option is not expanded. It must specify a valid RFC 2822
13407 address. However, if a warning message that is generated by the
13408 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13409 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13410 not used.
13411
13412
13413 .option exim_group main string "compile-time configured"
13414 .cindex "gid (group id)" "Exim's own"
13415 .cindex "Exim group"
13416 This option changes the gid under which Exim runs when it gives up root
13417 privilege. The default value is compiled into the binary. The value of this
13418 option is used only when &%exim_user%& is also set. Unless it consists entirely
13419 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13420 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13421 security issues.
13422
13423
13424 .option exim_path main string "see below"
13425 .cindex "Exim binary, path name"
13426 This option specifies the path name of the Exim binary, which is used when Exim
13427 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13428 the directory configured at compile time by the BIN_DIRECTORY setting. It
13429 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13430 other place.
13431 &*Warning*&: Do not use a macro to define the value of this option, because
13432 you will break those Exim utilities that scan the configuration file to find
13433 where the binary is. (They then use the &%-bP%& option to extract option
13434 settings such as the value of &%spool_directory%&.)
13435
13436
13437 .option exim_user main string "compile-time configured"
13438 .cindex "uid (user id)" "Exim's own"
13439 .cindex "Exim user"
13440 This option changes the uid under which Exim runs when it gives up root
13441 privilege. The default value is compiled into the binary. Ownership of the run
13442 time configuration file and the use of the &%-C%& and &%-D%& command line
13443 options is checked against the values in the binary, not what is set here.
13444
13445 Unless it consists entirely of digits, the string is looked up using
13446 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13447 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13448 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13449
13450
13451 .option extra_local_interfaces main "string list" unset
13452 This option defines network interfaces that are to be considered local when
13453 routing, but which are not used for listening by the daemon. See section
13454 &<<SECTreclocipadd>>& for details.
13455
13456
13457 . Allow this long option name to split; give it unsplit as a fifth argument
13458 . for the automatic .oindex that is generated by .option.
13459
13460 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13461          extract_addresses_remove_arguments
13462 .oindex "&%-t%&"
13463 .cindex "command line" "addresses with &%-t%&"
13464 .cindex "Sendmail compatibility" "&%-t%& option"
13465 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13466 are present on the command line when the &%-t%& option is used to build an
13467 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13468 line addresses are removed from the recipients list. This is also how Smail
13469 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13470 command line addresses are added to those obtained from the header lines. When
13471 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13472 argument headers. If it is set false, Exim adds rather than removes argument
13473 addresses.
13474
13475
13476 .option finduser_retries main integer 0
13477 .cindex "NIS, retrying user lookups"
13478 On systems running NIS or other schemes in which user and group information is
13479 distributed from a remote system, there can be times when &[getpwnam()]& and
13480 related functions fail, even when given valid data, because things time out.
13481 Unfortunately these failures cannot be distinguished from genuine &"not found"&
13482 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
13483 many extra times to find a user or a group, waiting for one second between
13484 retries.
13485
13486 .cindex "&_/etc/passwd_&" "multiple reading of"
13487 You should not set this option greater than zero if your user information is in
13488 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
13489 search the file multiple times for non-existent users, and also cause delay.
13490
13491
13492
13493 .option freeze_tell main "string list, comma separated" unset
13494 .cindex "freezing messages" "sending a message when freezing"
13495 On encountering certain errors, or when configured to do so in a system filter,
13496 ACL, or special router, Exim freezes a message. This means that no further
13497 delivery attempts take place until an administrator thaws the message, or the
13498 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
13499 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
13500 warning message whenever it freezes something, unless the message it is
13501 freezing is a locally-generated bounce message. (Without this exception there
13502 is the possibility of looping.) The warning message is sent to the addresses
13503 supplied as the comma-separated value of this option. If several of the
13504 message's addresses cause freezing, only a single message is sent. If the
13505 freezing was automatic, the reason(s) for freezing can be found in the message
13506 log. If you configure freezing in a filter or ACL, you must arrange for any
13507 logging that you require.
13508
13509
13510 .option gecos_name main string&!! unset
13511 .cindex "HP-UX"
13512 .cindex "&""gecos""& field, parsing"
13513 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
13514 password file to hold other information in addition to users' real names. Exim
13515 looks up this field for use when it is creating &'Sender:'& or &'From:'&
13516 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
13517 of the field are used unchanged, except that, if an ampersand is encountered,
13518 it is replaced by the user's login name with the first character forced to
13519 upper case, since this is a convention that is observed on many systems.
13520
13521 When these options are set, &%gecos_pattern%& is treated as a regular
13522 expression that is to be applied to the field (again with && replaced by the
13523 login name), and if it matches, &%gecos_name%& is expanded and used as the
13524 user's name.
13525
13526 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
13527 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
13528 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
13529 name terminates at the first comma, the following can be used:
13530 .code
13531 gecos_pattern = ([^,]*)
13532 gecos_name = $1
13533 .endd
13534
13535 .option gecos_pattern main string unset
13536 See &%gecos_name%& above.
13537
13538
13539 .option gnutls_require_kx main string unset
13540 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
13541 server. For details, see section &<<SECTreqciphgnu>>&.
13542
13543 .option gnutls_require_mac main string unset
13544 This option controls the MAC algorithms when GnuTLS is used in an Exim
13545 server. For details, see section &<<SECTreqciphgnu>>&.
13546
13547 .option gnutls_require_protocols main string unset
13548 This option controls the protocols when GnuTLS is used in an Exim
13549 server. For details, see section &<<SECTreqciphgnu>>&.
13550
13551 .option gnutls_compat_mode main boolean unset
13552 This option controls whether GnuTLS is used in compatibility mode in an Exim
13553 server. This reduces security slightly, but improves interworking with older
13554 implementations of TLS.
13555
13556 .option headers_charset main string "see below"
13557 This option sets a default character set for translating from encoded MIME
13558 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
13559 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
13560 ultimate default is ISO-8859-1. For more details see the description of header
13561 insertions in section &<<SECTexpansionitems>>&.
13562
13563
13564
13565 .option header_maxsize main integer "see below"
13566 .cindex "header section" "maximum size of"
13567 .cindex "limit" "size of message header section"
13568 This option controls the overall maximum size of a message's header
13569 section. The default is the value of HEADER_MAXSIZE in
13570 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
13571 sections are rejected.
13572
13573
13574 .option header_line_maxsize main integer 0
13575 .cindex "header lines" "maximum size of"
13576 .cindex "limit" "size of one header line"
13577 This option limits the length of any individual header line in a message, after
13578 all the continuations have been joined together. Messages with individual
13579 header lines that are longer than the limit are rejected. The default value of
13580 zero means &"no limit"&.
13581
13582
13583
13584
13585 .option helo_accept_junk_hosts main "host list&!!" unset
13586 .cindex "HELO" "accepting junk data"
13587 .cindex "EHLO" "accepting junk data"
13588 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
13589 mail, and gives an error response for invalid data. Unfortunately, there are
13590 some SMTP clients that send syntactic junk. They can be accommodated by setting
13591 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
13592 if you want to do semantic checking.
13593 See also &%helo_allow_chars%& for a way of extending the permitted character
13594 set.
13595
13596
13597 .option helo_allow_chars main string unset
13598 .cindex "HELO" "underscores in"
13599 .cindex "EHLO" "underscores in"
13600 .cindex "underscore in EHLO/HELO"
13601 This option can be set to a string of rogue characters that are permitted in
13602 all EHLO and HELO names in addition to the standard letters, digits,
13603 hyphens, and dots. If you really must allow underscores, you can set
13604 .code
13605 helo_allow_chars = _
13606 .endd
13607 Note that the value is one string, not a list.
13608
13609
13610 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
13611 .cindex "HELO" "forcing reverse lookup"
13612 .cindex "EHLO" "forcing reverse lookup"
13613 If the domain given by a client in a HELO or EHLO command matches this
13614 list, a reverse lookup is done in order to establish the host's true name. The
13615 default forces a lookup if the client host gives the server's name or any of
13616 its IP addresses (in brackets), something that broken clients have been seen to
13617 do.
13618
13619
13620 .option helo_try_verify_hosts main "host list&!!" unset
13621 .cindex "HELO verifying" "optional"
13622 .cindex "EHLO" "verifying, optional"
13623 By default, Exim just checks the syntax of HELO and EHLO commands (see
13624 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
13625 to do more extensive checking of the data supplied by these commands. The ACL
13626 condition &`verify = helo`& is provided to make this possible.
13627 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
13628 to force the check to occur. From release 4.53 onwards, this is no longer
13629 necessary. If the check has not been done before &`verify = helo`& is
13630 encountered, it is done at that time. Consequently, this option is obsolete.
13631 Its specification is retained here for backwards compatibility.
13632
13633 When an EHLO or HELO command is received, if the calling host matches
13634 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
13635 EHLO command either:
13636
13637 .ilist
13638 is an IP literal matching the calling address of the host, or
13639 .next
13640 .cindex "DNS" "reverse lookup"
13641 .cindex "reverse DNS lookup"
13642 matches the host name that Exim obtains by doing a reverse lookup of the
13643 calling host address, or
13644 .next
13645 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
13646 available) yields the calling host address.
13647 .endlist
13648
13649 However, the EHLO or HELO command is not rejected if any of the checks
13650 fail. Processing continues, but the result of the check is remembered, and can
13651 be detected later in an ACL by the &`verify = helo`& condition.
13652
13653 .option helo_verify_hosts main "host list&!!" unset
13654 .cindex "HELO verifying" "mandatory"
13655 .cindex "EHLO" "verifying, mandatory"
13656 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
13657 backwards compatibility. For hosts that match this option, Exim checks the host
13658 name given in the HELO or EHLO in the same way as for
13659 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
13660 rejected with a 550 error, and entries are written to the main and reject logs.
13661 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
13662 error.
13663
13664 .option hold_domains main "domain list&!!" unset
13665 .cindex "domain" "delaying delivery"
13666 .cindex "delivery" "delaying certain domains"
13667 This option allows mail for particular domains to be held on the queue
13668 manually. The option is overridden if a message delivery is forced with the
13669 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
13670 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
13671 item in &%hold_domains%&, no routing or delivery for that address is done, and
13672 it is deferred every time the message is looked at.
13673
13674 This option is intended as a temporary operational measure for delaying the
13675 delivery of mail while some problem is being sorted out, or some new
13676 configuration tested. If you just want to delay the processing of some
13677 domains until a queue run occurs, you should use &%queue_domains%& or
13678 &%queue_smtp_domains%&, not &%hold_domains%&.
13679
13680 A setting of &%hold_domains%& does not override Exim's code for removing
13681 messages from the queue if they have been there longer than the longest retry
13682 time in any retry rule. If you want to hold messages for longer than the normal
13683 retry times, insert a dummy retry rule with a long retry time.
13684
13685
13686 .option host_lookup main "host list&!!" unset
13687 .cindex "host name" "lookup, forcing"
13688 Exim does not look up the name of a calling host from its IP address unless it
13689 is required to compare against some host list, or the host matches
13690 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
13691 option (which normally contains IP addresses rather than host names). The
13692 default configuration file contains
13693 .code
13694 host_lookup = *
13695 .endd
13696 which causes a lookup to happen for all hosts. If the expense of these lookups
13697 is felt to be too great, the setting can be changed or removed.
13698
13699 After a successful reverse lookup, Exim does a forward lookup on the name it
13700 has obtained, to verify that it yields the IP address that it started with. If
13701 this check fails, Exim behaves as if the name lookup failed.
13702
13703 .vindex "&$host_lookup_failed$&"
13704 .vindex "&$sender_host_name$&"
13705 After any kind of failure, the host name (in &$sender_host_name$&) remains
13706 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
13707 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
13708 &`verify = reverse_host_lookup`& in ACLs.
13709
13710
13711 .option host_lookup_order main "string list" &`bydns:byaddr`&
13712 This option specifies the order of different lookup methods when Exim is trying
13713 to find a host name from an IP address. The default is to do a DNS lookup
13714 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
13715 if that fails. You can change the order of these lookups, or omit one entirely,
13716 if you want.
13717
13718 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
13719 multiple PTR records in the DNS and the IP address is not listed in
13720 &_/etc/hosts_&. Different operating systems give different results in this
13721 case. That is why the default tries a DNS lookup first.
13722
13723
13724
13725 .option host_reject_connection main "host list&!!" unset
13726 .cindex "host" "rejecting connections from"
13727 If this option is set, incoming SMTP calls from the hosts listed are rejected
13728 as soon as the connection is made.
13729 This option is obsolete, and retained only for backward compatibility, because
13730 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
13731 connections immediately.
13732
13733 The ability to give an immediate rejection (either by this option or using an
13734 ACL) is provided for use in unusual cases. Many hosts will just try again,
13735 sometimes without much delay. Normally, it is better to use an ACL to reject
13736 incoming messages at a later stage, such as after RCPT commands. See
13737 chapter &<<CHAPACL>>&.
13738
13739
13740 .option hosts_connection_nolog main "host list&!!" unset
13741 .cindex "host" "not logging connections from"
13742 This option defines a list of hosts for which connection logging does not
13743 happen, even though the &%smtp_connection%& log selector is set. For example,
13744 you might want not to log SMTP connections from local processes, or from
13745 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
13746 the daemon; you should therefore strive to restrict its value to a short inline
13747 list of IP addresses and networks. To disable logging SMTP connections from
13748 local processes, you must create a host list with an empty item. For example:
13749 .code
13750 hosts_connection_nolog = :
13751 .endd
13752 If the &%smtp_connection%& log selector is not set, this option has no effect.
13753
13754
13755
13756 .option hosts_treat_as_local main "domain list&!!" unset
13757 .cindex "local host" "domains treated as"
13758 .cindex "host" "treated as local"
13759 If this option is set, any host names that match the domain list are treated as
13760 if they were the local host when Exim is scanning host lists obtained from MX
13761 records
13762 or other sources. Note that the value of this option is a domain list, not a
13763 host list, because it is always used to check host names, not IP addresses.
13764
13765 This option also applies when Exim is matching the special items
13766 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
13767 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
13768 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
13769 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
13770 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
13771 interfaces and recognizing the local host.
13772
13773
13774 .option ibase_servers main "string list" unset
13775 .cindex "InterBase" "server list"
13776 This option provides a list of InterBase servers and associated connection data,
13777 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
13778 The option is available only if Exim has been built with InterBase support.
13779
13780
13781
13782 .option ignore_bounce_errors_after main time 10w
13783 .cindex "bounce message" "discarding"
13784 .cindex "discarding bounce message"
13785 This option affects the processing of bounce messages that cannot be delivered,
13786 that is, those that suffer a permanent delivery failure. (Bounce messages that
13787 suffer temporary delivery failures are of course retried in the usual way.)
13788
13789 After a permanent delivery failure, bounce messages are frozen,
13790 because there is no sender to whom they can be returned. When a frozen bounce
13791 message has been on the queue for more than the given time, it is unfrozen at
13792 the next queue run, and a further delivery is attempted. If delivery fails
13793 again, the bounce message is discarded. This makes it possible to keep failed
13794 bounce messages around for a shorter time than the normal maximum retry time
13795 for frozen messages. For example,
13796 .code
13797 ignore_bounce_errors_after = 12h
13798 .endd
13799 retries failed bounce message deliveries after 12 hours, discarding any further
13800 failures. If the value of this option is set to a zero time period, bounce
13801 failures are discarded immediately. Setting a very long time (as in the default
13802 value) has the effect of disabling this option. For ways of automatically
13803 dealing with other kinds of frozen message, see &%auto_thaw%& and
13804 &%timeout_frozen_after%&.
13805
13806
13807 .option ignore_fromline_hosts main "host list&!!" unset
13808 .cindex "&""From""& line"
13809 .cindex "UUCP" "&""From""& line"
13810 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
13811 the headers of a message. By default this is treated as the start of the
13812 message's body, which means that any following headers are not recognized as
13813 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
13814 match those hosts that insist on sending it. If the sender is actually a local
13815 process rather than a remote host, and is using &%-bs%& to inject the messages,
13816 &%ignore_fromline_local%& must be set to achieve this effect.
13817
13818
13819 .option ignore_fromline_local main boolean false
13820 See &%ignore_fromline_hosts%& above.
13821
13822
13823 .option keep_malformed main time 4d
13824 This option specifies the length of time to keep messages whose spool files
13825 have been corrupted in some way. This should, of course, never happen. At the
13826 next attempt to deliver such a message, it gets removed. The incident is
13827 logged.
13828
13829
13830 .new
13831 .option ldap_ca_cert_dir main string unset
13832 .cindex "LDAP", "TLS CA certificate directory"
13833 This option indicates which directory contains CA certificates for verifying
13834 a TLS certificate presented by an LDAP server.
13835 While Exim does not provide a default value, your SSL library may.
13836 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
13837 and constrained to be a directory.
13838 .wen
13839
13840
13841 .new
13842 .option ldap_ca_cert_file main string unset
13843 .cindex "LDAP", "TLS CA certificate file"
13844 This option indicates which file contains CA certificates for verifying
13845 a TLS certificate presented by an LDAP server.
13846 While Exim does not provide a default value, your SSL library may.
13847 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
13848 and constrained to be a file.
13849 .wen
13850
13851
13852 .new
13853 .option ldap_cert_file main string unset
13854 .cindex "LDAP" "TLS client certificate file"
13855 This option indicates which file contains an TLS client certificate which
13856 Exim should present to the LDAP server during TLS negotiation.
13857 Should be used together with &%ldap_cert_key%&.
13858 .wen
13859
13860
13861 .new
13862 .option ldap_cert_key main string unset
13863 .cindex "LDAP" "TLS client key file"
13864 This option indicates which file contains the secret/private key to use
13865 to prove identity to the LDAP server during TLS negotiation.
13866 Should be used together with &%ldap_cert_file%&, which contains the
13867 identity to be proven.
13868 .wen
13869
13870
13871 .new
13872 .option ldap_cipher_suite main string unset
13873 .cindex "LDAP" "TLS cipher suite"
13874 This controls the TLS cipher-suite negotiation during TLS negotiation with
13875 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
13876 cipher-suite options with OpenSSL (as used by LDAP client libraries).
13877 .wen
13878
13879
13880 .option ldap_default_servers main "string list" unset
13881 .cindex "LDAP" "default servers"
13882 This option provides a list of LDAP servers which are tried in turn when an
13883 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
13884 details of LDAP queries. This option is available only when Exim has been built
13885 with LDAP support.
13886
13887
13888 .new
13889 .option ldap_require_cert main string unset.
13890 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
13891 This should be one of the values "hard", "demand", "allow", "try" or "never".
13892 A value other than one of these is interpreted as "never".
13893 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
13894 Although Exim does not set a default, the LDAP library probably defaults
13895 to hard/demand.
13896 .wen
13897
13898
13899 .new
13900 .option ldap_start_tls main boolean false
13901 .cindex "LDAP" "whether or not to negotiate TLS"
13902 If set, Exim will attempt to negotiate TLS with the LDAP server when
13903 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
13904 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
13905 of SSL-on-connect.
13906 In the event of failure to negotiate TLS, the action taken is controlled
13907 by &%ldap_require_cert%&.
13908 .wen
13909
13910
13911 .option ldap_version main integer unset
13912 .cindex "LDAP" "protocol version, forcing"
13913 This option can be used to force Exim to set a specific protocol version for
13914 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
13915 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
13916 the LDAP headers; otherwise it is 2. This option is available only when Exim
13917 has been built with LDAP support.
13918
13919
13920
13921 .option local_from_check main boolean true
13922 .cindex "&'Sender:'& header line" "disabling addition of"
13923 .cindex "&'From:'& header line" "disabling checking of"
13924 When a message is submitted locally (that is, not over a TCP/IP connection) by
13925 an untrusted user, Exim removes any existing &'Sender:'& header line, and
13926 checks that the &'From:'& header line matches the login of the calling user and
13927 the domain specified by &%qualify_domain%&.
13928
13929 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
13930 locally submitted message is automatically qualified by Exim, unless the
13931 &%-bnq%& command line option is used.
13932
13933 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
13934 on the local part. If the &'From:'& header line does not match, Exim adds a
13935 &'Sender:'& header with an address constructed from the calling user's login
13936 and the default qualify domain.
13937
13938 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
13939 and no &'Sender:'& header is ever added. If, in addition, you want to retain
13940 &'Sender:'& header lines supplied by untrusted users, you must also set
13941 &%local_sender_retain%& to be true.
13942
13943 .cindex "envelope sender"
13944 These options affect only the header lines in the message. The envelope sender
13945 is still forced to be the login id at the qualify domain unless
13946 &%untrusted_set_sender%& permits the user to supply an envelope sender.
13947
13948 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
13949 request similar header line checking. See section &<<SECTthesenhea>>&, which
13950 has more details about &'Sender:'& processing.
13951
13952
13953
13954
13955 .option local_from_prefix main string unset
13956 When Exim checks the &'From:'& header line of locally submitted messages for
13957 matching the login id (see &%local_from_check%& above), it can be configured to
13958 ignore certain prefixes and suffixes in the local part of the address. This is
13959 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
13960 appropriate lists, in the same form as the &%local_part_prefix%& and
13961 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
13962 example, if
13963 .code
13964 local_from_prefix = *-
13965 .endd
13966 is set, a &'From:'& line containing
13967 .code
13968 From: anything-user@your.domain.example
13969 .endd
13970 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
13971 matches the actual sender address that is constructed from the login name and
13972 qualify domain.
13973
13974
13975 .option local_from_suffix main string unset
13976 See &%local_from_prefix%& above.
13977
13978
13979 .option local_interfaces main "string list" "see below"
13980 This option controls which network interfaces are used by the daemon for
13981 listening; they are also used to identify the local host when routing. Chapter
13982 &<<CHAPinterfaces>>& contains a full description of this option and the related
13983 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
13984 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
13985 &%local_interfaces%& is
13986 .code
13987 local_interfaces = 0.0.0.0
13988 .endd
13989 when Exim is built without IPv6 support; otherwise it is
13990 .code
13991 local_interfaces = <; ::0 ; 0.0.0.0
13992 .endd
13993
13994 .option local_scan_timeout main time 5m
13995 .cindex "timeout" "for &[local_scan()]& function"
13996 .cindex "&[local_scan()]& function" "timeout"
13997 This timeout applies to the &[local_scan()]& function (see chapter
13998 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
13999 the incoming message is rejected with a temporary error if it is an SMTP
14000 message. For a non-SMTP message, the message is dropped and Exim ends with a
14001 non-zero code. The incident is logged on the main and reject logs.
14002
14003
14004
14005 .option local_sender_retain main boolean false
14006 .cindex "&'Sender:'& header line" "retaining from local submission"
14007 When a message is submitted locally (that is, not over a TCP/IP connection) by
14008 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14009 do not want this to happen, you must set &%local_sender_retain%&, and you must
14010 also set &%local_from_check%& to be false (Exim will complain if you do not).
14011 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14012 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14013
14014
14015
14016
14017 .option localhost_number main string&!! unset
14018 .cindex "host" "locally unique number for"
14019 .cindex "message ids" "with multiple hosts"
14020 .vindex "&$localhost_number$&"
14021 Exim's message ids are normally unique only within the local host. If
14022 uniqueness among a set of hosts is required, each host must set a different
14023 value for the &%localhost_number%& option. The string is expanded immediately
14024 after reading the configuration file (so that a number can be computed from the
14025 host name, for example) and the result of the expansion must be a number in the
14026 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14027 systems). This is available in subsequent string expansions via the variable
14028 &$localhost_number$&. When &%localhost_number is set%&, the final two
14029 characters of the message id, instead of just being a fractional part of the
14030 time, are computed from the time and the local host number as described in
14031 section &<<SECTmessiden>>&.
14032
14033
14034
14035 .option log_file_path main "string list&!!" "set at compile time"
14036 .cindex "log" "file path for"
14037 This option sets the path which is used to determine the names of Exim's log
14038 files, or indicates that logging is to be to syslog, or both. It is expanded
14039 when Exim is entered, so it can, for example, contain a reference to the host
14040 name. If no specific path is set for the log files at compile or run time, they
14041 are written in a sub-directory called &_log_& in Exim's spool directory.
14042 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14043 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14044 used. If this string is fixed at your installation (contains no expansion
14045 variables) it is recommended that you do not set this option in the
14046 configuration file, but instead supply the path using LOG_FILE_PATH in
14047 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14048 early on &-- in particular, failure to read the configuration file.
14049
14050
14051 .option log_selector main string unset
14052 .cindex "log" "selectors"
14053 This option can be used to reduce or increase the number of things that Exim
14054 writes to its log files. Its argument is made up of names preceded by plus or
14055 minus characters. For example:
14056 .code
14057 log_selector = +arguments -retry_defer
14058 .endd
14059 A list of possible names and what they control is given in the chapter on
14060 logging, in section &<<SECTlogselector>>&.
14061
14062
14063 .option log_timezone main boolean false
14064 .cindex "log" "timezone for entries"
14065 .vindex "&$tod_log$&"
14066 .vindex "&$tod_zone$&"
14067 By default, the timestamps on log lines are in local time without the
14068 timezone. This means that if your timezone changes twice a year, the timestamps
14069 in log lines are ambiguous for an hour when the clocks go back. One way of
14070 avoiding this problem is to set the timezone to UTC. An alternative is to set
14071 &%log_timezone%& true. This turns on the addition of the timezone offset to
14072 timestamps in log lines. Turning on this option can add quite a lot to the size
14073 of log files because each line is extended by 6 characters. Note that the
14074 &$tod_log$& variable contains the log timestamp without the zone, but there is
14075 another variable called &$tod_zone$& that contains just the timezone offset.
14076
14077
14078 .option lookup_open_max main integer 25
14079 .cindex "too many open files"
14080 .cindex "open files, too many"
14081 .cindex "file" "too many open"
14082 .cindex "lookup" "maximum open files"
14083 .cindex "limit" "open files for lookups"
14084 This option limits the number of simultaneously open files for single-key
14085 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14086 Exim normally keeps these files open during routing, because often the same
14087 file is required several times. If the limit is reached, Exim closes the least
14088 recently used file. Note that if you are using the &'ndbm'& library, it
14089 actually opens two files for each logical DBM database, though it still counts
14090 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14091 open files"& errors with NDBM, you need to reduce the value of
14092 &%lookup_open_max%&.
14093
14094
14095 .option max_username_length main integer 0
14096 .cindex "length of login name"
14097 .cindex "user name" "maximum length"
14098 .cindex "limit" "user name length"
14099 Some operating systems are broken in that they truncate long arguments to
14100 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14101 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14102 an argument that is longer behaves as if &[getpwnam()]& failed.
14103
14104
14105 .option message_body_newlines main bool false
14106 .cindex "message body" "newlines in variables"
14107 .cindex "newline" "in message body variables"
14108 .vindex "&$message_body$&"
14109 .vindex "&$message_body_end$&"
14110 By default, newlines in the message body are replaced by spaces when setting
14111 the &$message_body$& and &$message_body_end$& expansion variables. If this
14112 option is set true, this no longer happens.
14113
14114
14115 .option message_body_visible main integer 500
14116 .cindex "body of message" "visible size"
14117 .cindex "message body" "visible size"
14118 .vindex "&$message_body$&"
14119 .vindex "&$message_body_end$&"
14120 This option specifies how much of a message's body is to be included in the
14121 &$message_body$& and &$message_body_end$& expansion variables.
14122
14123
14124 .option message_id_header_domain main string&!! unset
14125 .cindex "&'Message-ID:'& header line"
14126 If this option is set, the string is expanded and used as the right hand side
14127 (domain) of the &'Message-ID:'& header that Exim creates if a
14128 locally-originated incoming message does not have one. &"Locally-originated"&
14129 means &"not received over TCP/IP."&
14130 Otherwise, the primary host name is used.
14131 Only letters, digits, dot and hyphen are accepted; any other characters are
14132 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14133 empty string, the option is ignored.
14134
14135
14136 .option message_id_header_text main string&!! unset
14137 If this variable is set, the string is expanded and used to augment the text of
14138 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14139 message does not have one. The text of this header is required by RFC 2822 to
14140 take the form of an address. By default, Exim uses its internal message id as
14141 the local part, and the primary host name as the domain. If this option is set,
14142 it is expanded, and provided the expansion is not forced to fail, and does not
14143 yield an empty string, the result is inserted into the header immediately
14144 before the @, separated from the internal message id by a dot. Any characters
14145 that are illegal in an address are automatically converted into hyphens. This
14146 means that variables such as &$tod_log$& can be used, because the spaces and
14147 colons will become hyphens.
14148
14149
14150 .option message_logs main boolean true
14151 .cindex "message logs" "disabling"
14152 .cindex "log" "message log; disabling"
14153 If this option is turned off, per-message log files are not created in the
14154 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14155 Exim, by reducing the number of files involved in handling a message from a
14156 minimum of four (header spool file, body spool file, delivery journal, and
14157 per-message log) to three. The other major I/O activity is Exim's main log,
14158 which is not affected by this option.
14159
14160
14161 .option message_size_limit main string&!! 50M
14162 .cindex "message" "size limit"
14163 .cindex "limit" "message size"
14164 .cindex "size" "of message, limit"
14165 This option limits the maximum size of message that Exim will process. The
14166 value is expanded for each incoming connection so, for example, it can be made
14167 to depend on the IP address of the remote host for messages arriving via
14168 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14169 optionally followed by K or M.
14170
14171 &*Note*&: This limit cannot be made to depend on a message's sender or any
14172 other properties of an individual message, because it has to be advertised in
14173 the server's response to EHLO. String expansion failure causes a temporary
14174 error. A value of zero means no limit, but its use is not recommended. See also
14175 &%bounce_return_size_limit%&.
14176
14177 Incoming SMTP messages are failed with a 552 error if the limit is
14178 exceeded; locally-generated messages either get a stderr message or a delivery
14179 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14180 an oversized message is logged in both the main and the reject logs. See also
14181 the generic transport option &%message_size_limit%&, which limits the size of
14182 message that an individual transport can process.
14183
14184 .new
14185 If you use a virus-scanner and set this option to to a value larger than the
14186 maximum size that your virus-scanner is configured to support, you may get
14187 failures triggered by large mails.  The right size to configure for the
14188 virus-scanner depends upon what data is passed and the options in use but it's
14189 probably safest to just set it to a little larger than this value.  Eg, with a
14190 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14191 some problems may result.
14192 .wen
14193
14194
14195 .option move_frozen_messages main boolean false
14196 .cindex "frozen messages" "moving"
14197 This option, which is available only if Exim has been built with the setting
14198 .code
14199 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14200 .endd
14201 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14202 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14203 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14204 standard utilities for handling such moved messages, and they do not show up in
14205 lists generated by &%-bp%& or by the Exim monitor.
14206
14207
14208 .option mua_wrapper main boolean false
14209 Setting this option true causes Exim to run in a very restrictive mode in which
14210 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14211 contains a full description of this facility.
14212
14213
14214
14215 .option mysql_servers main "string list" unset
14216 .cindex "MySQL" "server list"
14217 This option provides a list of MySQL servers and associated connection data, to
14218 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14219 option is available only if Exim has been built with MySQL support.
14220
14221
14222 .option never_users main "string list&!!" unset
14223 This option is expanded just once, at the start of Exim's processing. Local
14224 message deliveries are normally run in processes that are setuid to the
14225 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14226 It is usually desirable to prevent any deliveries from running as root, as a
14227 safety precaution.
14228
14229 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14230 list of users that must not be used for local deliveries. This list is fixed in
14231 the binary and cannot be overridden by the configuration file. By default, it
14232 contains just the single user name &"root"&. The &%never_users%& runtime option
14233 can be used to add more users to the fixed list.
14234
14235 If a message is to be delivered as one of the users on the fixed list or the
14236 &%never_users%& list, an error occurs, and delivery is deferred. A common
14237 example is
14238 .code
14239 never_users = root:daemon:bin
14240 .endd
14241 Including root is redundant if it is also on the fixed list, but it does no
14242 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14243 transport driver.
14244
14245
14246 .new
14247 .option openssl_options main "string list" +dont_insert_empty_fragments
14248 .cindex "OpenSSL "compatibility options"
14249 This option allows an administrator to adjust the SSL options applied
14250 by OpenSSL to connections.  It is given as a space-separated list of items,
14251 each one to be +added or -subtracted from the current value.  The default
14252 value is one option which happens to have been set historically.  You can
14253 remove all options with:
14254 .code
14255 openssl_options = -all
14256 .endd
14257 This option is only available if Exim is built against OpenSSL.  The values
14258 available for this option vary according to the age of your OpenSSL install.
14259 The &"all"& value controls a subset of flags which are available, typically
14260 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14261 list the values known on your system and Exim should support all the
14262 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14263 names lose the leading &"SSL_OP_"& and are lower-cased.
14264
14265 Note that adjusting the options can have severe impact upon the security of
14266 SSL as used by Exim.  It is possible to disable safety checks and shoot
14267 yourself in the foot in various unpleasant ways.  This option should not be
14268 adjusted lightly.  An unrecognised item will be detected at by invoking Exim
14269 with the &%-bV%& flag.
14270
14271 An example:
14272 .code
14273 openssl_options = -all +microsoft_big_sslv3_buffer
14274 .endd
14275 .wen
14276
14277
14278 .option oracle_servers main "string list" unset
14279 .cindex "Oracle" "server list"
14280 This option provides a list of Oracle servers and associated connection data,
14281 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14282 The option is available only if Exim has been built with Oracle support.
14283
14284
14285 .option percent_hack_domains main "domain list&!!" unset
14286 .cindex "&""percent hack""&"
14287 .cindex "source routing" "in email address"
14288 .cindex "address" "source-routed"
14289 The &"percent hack"& is the convention whereby a local part containing a
14290 percent sign is re-interpreted as a new email address, with the percent
14291 replaced by @. This is sometimes called &"source routing"&, though that term is
14292 also applied to RFC 2822 addresses that begin with an @ character. If this
14293 option is set, Exim implements the percent facility for those domains listed,
14294 but no others. This happens before an incoming SMTP address is tested against
14295 an ACL.
14296
14297 &*Warning*&: The &"percent hack"& has often been abused by people who are
14298 trying to get round relaying restrictions. For this reason, it is best avoided
14299 if at all possible. Unfortunately, a number of less security-conscious MTAs
14300 implement it unconditionally. If you are running Exim on a gateway host, and
14301 routing mail through to internal MTAs without processing the local parts, it is
14302 a good idea to reject recipient addresses with percent characters in their
14303 local parts. Exim's default configuration does this.
14304
14305
14306 .option perl_at_start main boolean false
14307 This option is available only when Exim is built with an embedded Perl
14308 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14309
14310
14311 .option perl_startup main string unset
14312 This option is available only when Exim is built with an embedded Perl
14313 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14314
14315
14316 .option pgsql_servers main "string list" unset
14317 .cindex "PostgreSQL lookup type" "server list"
14318 This option provides a list of PostgreSQL servers and associated connection
14319 data, to be used in conjunction with &(pgsql)& lookups (see section
14320 &<<SECID72>>&). The option is available only if Exim has been built with
14321 PostgreSQL support.
14322
14323
14324 .option pid_file_path main string&!! "set at compile time"
14325 .cindex "daemon" "pid file path"
14326 .cindex "pid file, path for"
14327 This option sets the name of the file to which the Exim daemon writes its
14328 process id. The string is expanded, so it can contain, for example, references
14329 to the host name:
14330 .code
14331 pid_file_path = /var/log/$primary_hostname/exim.pid
14332 .endd
14333 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14334 spool directory.
14335 The value set by the option can be overridden by the &%-oP%& command line
14336 option. A pid file is not written if a &"non-standard"& daemon is run by means
14337 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14338
14339
14340 .option pipelining_advertise_hosts main "host list&!!" *
14341 .cindex "PIPELINING" "suppressing advertising"
14342 This option can be used to suppress the advertisement of the SMTP
14343 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14344 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14345 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14346 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14347 that clients will use it; &"out of order"& commands that are &"expected"& do
14348 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14349
14350
14351 .option preserve_message_logs main boolean false
14352 .cindex "message logs" "preserving"
14353 If this option is set, message log files are not deleted when messages are
14354 completed. Instead, they are moved to a sub-directory of the spool directory
14355 called &_msglog.OLD_&, where they remain available for statistical or debugging
14356 purposes. This is a dangerous option to set on systems with any appreciable
14357 volume of mail. Use with care!
14358
14359
14360 .option primary_hostname main string "see below"
14361 .cindex "name" "of local host"
14362 .cindex "host" "name of local"
14363 .cindex "local host" "name of"
14364 .vindex "&$primary_hostname$&"
14365 This specifies the name of the current host. It is used in the default EHLO or
14366 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14367 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14368 The value is also used by default in some SMTP response messages from an Exim
14369 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14370
14371 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14372 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14373 contains only one component, Exim passes it to &[gethostbyname()]& (or
14374 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14375 version. The variable &$primary_hostname$& contains the host name, whether set
14376 explicitly by this option, or defaulted.
14377
14378
14379 .option print_topbitchars main boolean false
14380 .cindex "printing characters"
14381 .cindex "8-bit characters"
14382 By default, Exim considers only those characters whose codes lie in the range
14383 32&--126 to be printing characters. In a number of circumstances (for example,
14384 when writing log entries) non-printing characters are converted into escape
14385 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14386 is set, code values of 128 and above are also considered to be printing
14387 characters.
14388
14389 This option also affects the header syntax checks performed by the
14390 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14391 the user's full name when constructing From: and Sender: addresses (as
14392 described in section &<<SECTconstr>>&). Setting this option can cause
14393 Exim to generate eight bit message headers that do not conform to the
14394 standards.
14395
14396
14397 .option process_log_path main string unset
14398 .cindex "process log path"
14399 .cindex "log" "process log"
14400 .cindex "&'exiwhat'&"
14401 This option sets the name of the file to which an Exim process writes its
14402 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14403 utility script. If this option is unset, the file called &_exim-process.info_&
14404 in Exim's spool directory is used. The ability to specify the name explicitly
14405 can be useful in environments where two different Exims are running, using
14406 different spool directories.
14407
14408
14409 .option prod_requires_admin main boolean true
14410 .oindex "&%-M%&"
14411 .oindex "&%-R%&"
14412 .oindex "&%-q%&"
14413 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14414 admin user unless &%prod_requires_admin%& is set false. See also
14415 &%queue_list_requires_admin%&.
14416
14417
14418 .option qualify_domain main string "see below"
14419 .cindex "domain" "for qualifying addresses"
14420 .cindex "address" "qualification"
14421 This option specifies the domain name that is added to any envelope sender
14422 addresses that do not have a domain qualification. It also applies to
14423 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
14424 are accepted by default only for locally-generated messages. Qualification is
14425 also applied to addresses in header lines such as &'From:'& and &'To:'& for
14426 locally-generated messages, unless the &%-bnq%& command line option is used.
14427
14428 Messages from external sources must always contain fully qualified addresses,
14429 unless the sending host matches &%sender_unqualified_hosts%& or
14430 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
14431 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
14432 necessary. Internally, Exim always works with fully qualified envelope
14433 addresses. If &%qualify_domain%& is not set, it defaults to the
14434 &%primary_hostname%& value.
14435
14436
14437 .option qualify_recipient main string "see below"
14438 This option allows you to specify a different domain for qualifying recipient
14439 addresses to the one that is used for senders. See &%qualify_domain%& above.
14440
14441
14442
14443 .option queue_domains main "domain list&!!" unset
14444 .cindex "domain" "specifying non-immediate delivery"
14445 .cindex "queueing incoming messages"
14446 .cindex "message" "queueing certain domains"
14447 This option lists domains for which immediate delivery is not required.
14448 A delivery process is started whenever a message is received, but only those
14449 domains that do not match are processed. All other deliveries wait until the
14450 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
14451
14452
14453 .option queue_list_requires_admin main boolean true
14454 .oindex "&%-bp%&"
14455 The &%-bp%& command-line option, which lists the messages that are on the
14456 queue, requires the caller to be an admin user unless
14457 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
14458
14459
14460 .option queue_only main boolean false
14461 .cindex "queueing incoming messages"
14462 .cindex "message" "queueing unconditionally"
14463 If &%queue_only%& is set, a delivery process is not automatically started
14464 whenever a message is received. Instead, the message waits on the queue for the
14465 next queue run. Even if &%queue_only%& is false, incoming messages may not get
14466 delivered immediately when certain conditions (such as heavy load) occur.
14467
14468 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
14469 and &%-odi%& command line options override &%queue_only%& unless
14470 &%queue_only_override%& is set false. See also &%queue_only_file%&,
14471 &%queue_only_load%&, and &%smtp_accept_queue%&.
14472
14473
14474 .option queue_only_file main string unset
14475 .cindex "queueing incoming messages"
14476 .cindex "message" "queueing by file existence"
14477 This option can be set to a colon-separated list of absolute path names, each
14478 one optionally preceded by &"smtp"&. When Exim is receiving a message,
14479 it tests for the existence of each listed path using a call to &[stat()]&. For
14480 each path that exists, the corresponding queueing option is set.
14481 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
14482 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
14483 .code
14484 queue_only_file = smtp/some/file
14485 .endd
14486 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
14487 &_/some/file_& exists.
14488
14489
14490 .option queue_only_load main fixed-point unset
14491 .cindex "load average"
14492 .cindex "queueing incoming messages"
14493 .cindex "message" "queueing by load"
14494 If the system load average is higher than this value, incoming messages from
14495 all sources are queued, and no automatic deliveries are started. If this
14496 happens during local or remote SMTP input, all subsequent messages received on
14497 the same SMTP connection are queued by default, whatever happens to the load in
14498 the meantime, but this can be changed by setting &%queue_only_load_latch%&
14499 false.
14500
14501 Deliveries will subsequently be performed by queue runner processes. This
14502 option has no effect on ancient operating systems on which Exim cannot
14503 determine the load average. See also &%deliver_queue_load_max%& and
14504 &%smtp_load_reserve%&.
14505
14506
14507 .option queue_only_load_latch main boolean true
14508 .cindex "load average" "re-evaluating per message"
14509 When this option is true (the default), once one message has been queued
14510 because the load average is higher than the value set by &%queue_only_load%&,
14511 all subsequent messages received on the same SMTP connection are also queued.
14512 This is a deliberate choice; even though the load average may fall below the
14513 threshold, it doesn't seem right to deliver later messages on the same
14514 connection when not delivering earlier ones. However, there are special
14515 circumstances such as very long-lived connections from scanning appliances
14516 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
14517 should be set false. This causes the value of the load average to be
14518 re-evaluated for each message.
14519
14520
14521 .option queue_only_override main boolean true
14522 .cindex "queueing incoming messages"
14523 When this option is true, the &%-od%&&'x'& command line options override the
14524 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
14525 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
14526 to override; they are accepted, but ignored.
14527
14528
14529 .option queue_run_in_order main boolean false
14530 .cindex "queue runner" "processing messages in order"
14531 If this option is set, queue runs happen in order of message arrival instead of
14532 in an arbitrary order. For this to happen, a complete list of the entire queue
14533 must be set up before the deliveries start. When the queue is all held in a
14534 single directory (the default), a single list is created for both the ordered
14535 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
14536 single list is not created when &%queue_run_in_order%& is false. In this case,
14537 the sub-directories are processed one at a time (in a random order), and this
14538 avoids setting up one huge list for the whole queue. Thus, setting
14539 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
14540 when the queue is large, because of the extra work in setting up the single,
14541 large list. In most situations, &%queue_run_in_order%& should not be set.
14542
14543
14544
14545 .option queue_run_max main integer 5
14546 .cindex "queue runner" "maximum number of"
14547 This controls the maximum number of queue runner processes that an Exim daemon
14548 can run simultaneously. This does not mean that it starts them all at once,
14549 but rather that if the maximum number are still running when the time comes to
14550 start another one, it refrains from starting another one. This can happen with
14551 very large queues and/or very sluggish deliveries. This option does not,
14552 however, interlock with other processes, so additional queue runners can be
14553 started by other means, or by killing and restarting the daemon.
14554
14555 Setting this option to zero does not suppress queue runs; rather, it disables
14556 the limit, allowing any number of simultaneous queue runner processes to be
14557 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
14558 the daemon's command line.
14559
14560 .option queue_smtp_domains main "domain list&!!" unset
14561 .cindex "queueing incoming messages"
14562 .cindex "message" "queueing remote deliveries"
14563 When this option is set, a delivery process is started whenever a message is
14564 received, routing is performed, and local deliveries take place.
14565 However, if any SMTP deliveries are required for domains that match
14566 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
14567 message waits on the queue for the next queue run. Since routing of the message
14568 has taken place, Exim knows to which remote hosts it must be delivered, and so
14569 when the queue run happens, multiple messages for the same host are delivered
14570 over a single SMTP connection. The &%-odqs%& command line option causes all
14571 SMTP deliveries to be queued in this way, and is equivalent to setting
14572 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
14573 &%queue_domains%&.
14574
14575
14576 .option receive_timeout main time 0s
14577 .cindex "timeout" "for non-SMTP input"
14578 This option sets the timeout for accepting a non-SMTP message, that is, the
14579 maximum time that Exim waits when reading a message on the standard input. If
14580 the value is zero, it will wait for ever. This setting is overridden by the
14581 &%-or%& command line option. The timeout for incoming SMTP messages is
14582 controlled by &%smtp_receive_timeout%&.
14583
14584 .option received_header_text main string&!! "see below"
14585 .cindex "customizing" "&'Received:'& header"
14586 .cindex "&'Received:'& header line" "customizing"
14587 This string defines the contents of the &'Received:'& message header that is
14588 added to each message, except for the timestamp, which is automatically added
14589 on at the end (preceded by a semicolon). The string is expanded each time it is
14590 used. If the expansion yields an empty string, no &'Received:'& header line is
14591 added to the message. Otherwise, the string should start with the text
14592 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
14593 header lines. The default setting is:
14594
14595 .code
14596 received_header_text = Received: \
14597   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
14598   {${if def:sender_ident \
14599   {from ${quote_local_part:$sender_ident} }}\
14600   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
14601   by $primary_hostname \
14602   ${if def:received_protocol {with $received_protocol}} \
14603   ${if def:tls_cipher {($tls_cipher)\n\t}}\
14604   (Exim $version_number)\n\t\
14605   ${if def:sender_address \
14606   {(envelope-from <$sender_address>)\n\t}}\
14607   id $message_exim_id\
14608   ${if def:received_for {\n\tfor $received_for}}
14609 .endd
14610
14611 The reference to the TLS cipher is omitted when Exim is built without TLS
14612 support. The use of conditional expansions ensures that this works for both
14613 locally generated messages and messages received from remote hosts, giving
14614 header lines such as the following:
14615 .code
14616 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
14617 by marley.carol.example with esmtp (Exim 4.00)
14618 (envelope-from <bob@carol.example>)
14619 id 16IOWa-00019l-00
14620 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
14621 Received: by scrooge.carol.example with local (Exim 4.00)
14622 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
14623 .endd
14624 Until the body of the message has been received, the timestamp is the time when
14625 the message started to be received. Once the body has arrived, and all policy
14626 checks have taken place, the timestamp is updated to the time at which the
14627 message was accepted.
14628
14629
14630 .option received_headers_max main integer 30
14631 .cindex "loop" "prevention"
14632 .cindex "mail loop prevention"
14633 .cindex "&'Received:'& header line" "counting"
14634 When a message is to be delivered, the number of &'Received:'& headers is
14635 counted, and if it is greater than this parameter, a mail loop is assumed to
14636 have occurred, the delivery is abandoned, and an error message is generated.
14637 This applies to both local and remote deliveries.
14638
14639
14640 .option recipient_unqualified_hosts main "host list&!!" unset
14641 .cindex "unqualified addresses"
14642 .cindex "host" "unqualified addresses from"
14643 This option lists those hosts from which Exim is prepared to accept unqualified
14644 recipient addresses in message envelopes. The addresses are made fully
14645 qualified by the addition of the &%qualify_recipient%& value. This option also
14646 affects message header lines. Exim does not reject unqualified recipient
14647 addresses in headers, but it qualifies them only if the message came from a
14648 host that matches &%recipient_unqualified_hosts%&,
14649 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
14650 option was not set.
14651
14652
14653 .option recipients_max main integer 0
14654 .cindex "limit" "number of recipients"
14655 .cindex "recipient" "maximum number"
14656 If this option is set greater than zero, it specifies the maximum number of
14657 original recipients for any message. Additional recipients that are generated
14658 by aliasing or forwarding do not count. SMTP messages get a 452 response for
14659 all recipients over the limit; earlier recipients are delivered as normal.
14660 Non-SMTP messages with too many recipients are failed, and no deliveries are
14661 done.
14662
14663 .cindex "RCPT" "maximum number of incoming"
14664 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
14665 RCPT commands in a single message.
14666
14667
14668 .option recipients_max_reject main boolean false
14669 If this option is set true, Exim rejects SMTP messages containing too many
14670 recipients by giving 552 errors to the surplus RCPT commands, and a 554
14671 error to the eventual DATA command. Otherwise (the default) it gives a 452
14672 error to the surplus RCPT commands and accepts the message on behalf of the
14673 initial set of recipients. The remote server should then re-send the message
14674 for the remaining recipients at a later time.
14675
14676
14677 .option remote_max_parallel main integer 2
14678 .cindex "delivery" "parallelism for remote"
14679 This option controls parallel delivery of one message to a number of remote
14680 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
14681 does all the remote deliveries for a message one by one. Otherwise, if a single
14682 message has to be delivered to more than one remote host, or if several copies
14683 have to be sent to the same remote host, up to &%remote_max_parallel%&
14684 deliveries are done simultaneously. If more than &%remote_max_parallel%&
14685 deliveries are required, the maximum number of processes are started, and as
14686 each one finishes, another is begun. The order of starting processes is the
14687 same as if sequential delivery were being done, and can be controlled by the
14688 &%remote_sort_domains%& option. If parallel delivery takes place while running
14689 with debugging turned on, the debugging output from each delivery process is
14690 tagged with its process id.
14691
14692 This option controls only the maximum number of parallel deliveries for one
14693 message in one Exim delivery process. Because Exim has no central queue
14694 manager, there is no way of controlling the total number of simultaneous
14695 deliveries if the configuration allows a delivery attempt as soon as a message
14696 is received.
14697
14698 .cindex "number of deliveries"
14699 .cindex "delivery" "maximum number of"
14700 If you want to control the total number of deliveries on the system, you
14701 need to set the &%queue_only%& option. This ensures that all incoming messages
14702 are added to the queue without starting a delivery process. Then set up an Exim
14703 daemon to start queue runner processes at appropriate intervals (probably
14704 fairly often, for example, every minute), and limit the total number of queue
14705 runners by setting the &%queue_run_max%& parameter. Because each queue runner
14706 delivers only one message at a time, the maximum number of deliveries that can
14707 then take place at once is &%queue_run_max%& multiplied by
14708 &%remote_max_parallel%&.
14709
14710 If it is purely remote deliveries you want to control, use
14711 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
14712 doing the SMTP routing before queueing, so that several messages for the same
14713 host will eventually get delivered down the same connection.
14714
14715
14716 .option remote_sort_domains main "domain list&!!" unset
14717 .cindex "sorting remote deliveries"
14718 .cindex "delivery" "sorting remote"
14719 When there are a number of remote deliveries for a message, they are sorted by
14720 domain into the order given by this list. For example,
14721 .code
14722 remote_sort_domains = *.cam.ac.uk:*.uk
14723 .endd
14724 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
14725 then to those in the &%uk%& domain, then to any others.
14726
14727
14728 .option retry_data_expire main time 7d
14729 .cindex "hints database" "data expiry"
14730 This option sets a &"use before"& time on retry information in Exim's hints
14731 database. Any older retry data is ignored. This means that, for example, once a
14732 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
14733 past failures.
14734
14735
14736 .option retry_interval_max main time 24h
14737 .cindex "retry" "limit on interval"
14738 .cindex "limit" "on retry interval"
14739 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
14740 intervals between delivery attempts for messages that cannot be delivered
14741 straight away. This option sets an overall limit to the length of time between
14742 retries. It cannot be set greater than 24 hours; any attempt to do so forces
14743 the default value.
14744
14745
14746 .option return_path_remove main boolean true
14747 .cindex "&'Return-path:'& header line" "removing"
14748 RFC 2821, section 4.4, states that an SMTP server must insert a
14749 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
14750 The &'Return-path:'& header preserves the sender address as received in the
14751 MAIL command. This description implies that this header should not be present
14752 in an incoming message. If &%return_path_remove%& is true, any existing
14753 &'Return-path:'& headers are removed from messages at the time they are
14754 received. Exim's transports have options for adding &'Return-path:'& headers at
14755 the time of delivery. They are normally used only for final local deliveries.
14756
14757
14758 .option return_size_limit main integer 100K
14759 This option is an obsolete synonym for &%bounce_return_size_limit%&.
14760
14761
14762 .option rfc1413_hosts main "host list&!!" *
14763 .cindex "RFC 1413"
14764 .cindex "host" "for RFC 1413 calls"
14765 RFC 1413 identification calls are made to any client host which matches an item
14766 in the list.
14767
14768 .option rfc1413_query_timeout main time 5s
14769 .cindex "RFC 1413" "query timeout"
14770 .cindex "timeout" "for RFC 1413 call"
14771 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
14772 no RFC 1413 calls are ever made.
14773
14774
14775 .option sender_unqualified_hosts main "host list&!!" unset
14776 .cindex "unqualified addresses"
14777 .cindex "host" "unqualified addresses from"
14778 This option lists those hosts from which Exim is prepared to accept unqualified
14779 sender addresses. The addresses are made fully qualified by the addition of
14780 &%qualify_domain%&. This option also affects message header lines. Exim does
14781 not reject unqualified addresses in headers that contain sender addresses, but
14782 it qualifies them only if the message came from a host that matches
14783 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
14784 using TCP/IP), and the &%-bnq%& option was not set.
14785
14786
14787 .option smtp_accept_keepalive main boolean true
14788 .cindex "keepalive" "on incoming connection"
14789 This option controls the setting of the SO_KEEPALIVE option on incoming
14790 TCP/IP socket connections. When set, it causes the kernel to probe idle
14791 connections periodically, by sending packets with &"old"& sequence numbers. The
14792 other end of the connection should send an acknowledgment if the connection is
14793 still okay or a reset if the connection has been aborted. The reason for doing
14794 this is that it has the beneficial effect of freeing up certain types of
14795 connection that can get stuck when the remote host is disconnected without
14796 tidying up the TCP/IP call properly. The keepalive mechanism takes several
14797 hours to detect unreachable hosts.
14798
14799
14800
14801 .option smtp_accept_max main integer 20
14802 .cindex "limit" "incoming SMTP connections"
14803 .cindex "SMTP" "incoming connection count"
14804 .cindex "inetd"
14805 This option specifies the maximum number of simultaneous incoming SMTP calls
14806 that Exim will accept. It applies only to the listening daemon; there is no
14807 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
14808 value is set to zero, no limit is applied. However, it is required to be
14809 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
14810 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
14811
14812 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
14813 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
14814 that limit has not been reached for the client host, &%smtp_accept_reserve%&
14815 and &%smtp_load_reserve%& are then checked before accepting the connection.
14816
14817
14818 .option smtp_accept_max_nonmail main integer 10
14819 .cindex "limit" "non-mail SMTP commands"
14820 .cindex "SMTP" "limiting non-mail commands"
14821 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
14822 the connection if there are too many. This option defines &"too many"&. The
14823 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
14824 client looping sending EHLO, for example. The check is applied only if the
14825 client host matches &%smtp_accept_max_nonmail_hosts%&.
14826
14827 When a new message is expected, one occurrence of RSET is not counted. This
14828 allows a client to send one RSET between messages (this is not necessary,
14829 but some clients do it). Exim also allows one uncounted occurrence of HELO
14830 or EHLO, and one occurrence of STARTTLS between messages. After
14831 starting up a TLS session, another EHLO is expected, and so it too is not
14832 counted. The first occurrence of AUTH in a connection, or immediately
14833 following STARTTLS is not counted. Otherwise, all commands other than
14834 MAIL, RCPT, DATA, and QUIT are counted.
14835
14836
14837 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
14838 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
14839 check by setting this option. The default value makes it apply to all hosts. By
14840 changing the value, you can exclude any badly-behaved hosts that you have to
14841 live with.
14842
14843
14844 . Allow this long option name to split; give it unsplit as a fifth argument
14845 . for the automatic .oindex that is generated by .option.
14846
14847 .option "smtp_accept_max_per_ &~&~connection" main integer 1000 &&&
14848          smtp_accept_max_per_connection
14849 .cindex "SMTP" "limiting incoming message count"
14850 .cindex "limit" "messages per SMTP connection"
14851 The value of this option limits the number of MAIL commands that Exim is
14852 prepared to accept over a single SMTP connection, whether or not each command
14853 results in the transfer of a message. After the limit is reached, a 421
14854 response is given to subsequent MAIL commands. This limit is a safety
14855 precaution against a client that goes mad (incidents of this type have been
14856 seen).
14857
14858
14859 .option smtp_accept_max_per_host main string&!! unset
14860 .cindex "limit" "SMTP connections from one host"
14861 .cindex "host" "limiting SMTP connections from"
14862 This option restricts the number of simultaneous IP connections from a single
14863 host (strictly, from a single IP address) to the Exim daemon. The option is
14864 expanded, to enable different limits to be applied to different hosts by
14865 reference to &$sender_host_address$&. Once the limit is reached, additional
14866 connection attempts from the same host are rejected with error code 421. This
14867 is entirely independent of &%smtp_accept_reserve%&. The option's default value
14868 of zero imposes no limit. If this option is set greater than zero, it is
14869 required that &%smtp_accept_max%& be non-zero.
14870
14871 &*Warning*&: When setting this option you should not use any expansion
14872 constructions that take an appreciable amount of time. The expansion and test
14873 happen in the main daemon loop, in order to reject additional connections
14874 without forking additional processes (otherwise a denial-of-service attack
14875 could cause a vast number or processes to be created). While the daemon is
14876 doing this processing, it cannot accept any other incoming connections.
14877
14878
14879
14880 .option smtp_accept_queue main integer 0
14881 .cindex "SMTP" "incoming connection count"
14882 .cindex "queueing incoming messages"
14883 .cindex "message" "queueing by SMTP connection count"
14884 If the number of simultaneous incoming SMTP connections being handled via the
14885 listening daemon exceeds this value, messages received by SMTP are just placed
14886 on the queue; no delivery processes are started automatically. The count is
14887 fixed at the start of an SMTP connection. It cannot be updated in the
14888 subprocess that receives messages, and so the queueing or not queueing applies
14889 to all messages received in the same connection.
14890
14891 A value of zero implies no limit, and clearly any non-zero value is useful only
14892 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
14893 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
14894 various &%-od%&&'x'& command line options.
14895
14896
14897 . Allow this long option name to split; give it unsplit as a fifth argument
14898 . for the automatic .oindex that is generated by .option.
14899
14900 .option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&&
14901          smtp_accept_queue_per_connection
14902 .cindex "queueing incoming messages"
14903 .cindex "message" "queueing by message count"
14904 This option limits the number of delivery processes that Exim starts
14905 automatically when receiving messages via SMTP, whether via the daemon or by
14906 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
14907 and the number of messages received in a single SMTP session exceeds this
14908 number, subsequent messages are placed on the queue, but no delivery processes
14909 are started. This helps to limit the number of Exim processes when a server
14910 restarts after downtime and there is a lot of mail waiting for it on other
14911 systems. On large systems, the default should probably be increased, and on
14912 dial-in client systems it should probably be set to zero (that is, disabled).
14913
14914
14915 .option smtp_accept_reserve main integer 0
14916 .cindex "SMTP" "incoming call count"
14917 .cindex "host" "reserved"
14918 When &%smtp_accept_max%& is set greater than zero, this option specifies a
14919 number of SMTP connections that are reserved for connections from the hosts
14920 that are specified in &%smtp_reserve_hosts%&. The value set in
14921 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
14922 restricted to this number of connections; the option specifies a minimum number
14923 of connection slots for them, not a maximum. It is a guarantee that this group
14924 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
14925 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
14926 individual host.
14927
14928 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
14929 set to 5, once there are 45 active connections (from any hosts), new
14930 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
14931 provided the other criteria for acceptance are met.
14932
14933
14934 .option smtp_active_hostname main string&!! unset
14935 .cindex "host" "name in SMTP responses"
14936 .cindex "SMTP" "host name in responses"
14937 .vindex "&$primary_hostname$&"
14938 This option is provided for multi-homed servers that want to masquerade as
14939 several different hosts. At the start of an incoming SMTP connection, its value
14940 is expanded and used instead of the value of &$primary_hostname$& in SMTP
14941 responses. For example, it is used as domain name in the response to an
14942 incoming HELO or EHLO command.
14943
14944 .vindex "&$smtp_active_hostname$&"
14945 The active hostname is placed in the &$smtp_active_hostname$& variable, which
14946 is saved with any messages that are received. It is therefore available for use
14947 in routers and transports when the message is later delivered.
14948
14949 If this option is unset, or if its expansion is forced to fail, or if the
14950 expansion results in an empty string, the value of &$primary_hostname$& is
14951 used. Other expansion failures cause a message to be written to the main and
14952 panic logs, and the SMTP command receives a temporary error. Typically, the
14953 value of &%smtp_active_hostname%& depends on the incoming interface address.
14954 For example:
14955 .code
14956 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
14957   {cox.mydomain}{box.mydomain}}
14958 .endd
14959
14960 Although &$smtp_active_hostname$& is primarily concerned with incoming
14961 messages, it is also used as the default for HELO commands in callout
14962 verification if there is no remote transport from which to obtain a
14963 &%helo_data%& value.
14964
14965 .option smtp_banner main string&!! "see below"
14966 .cindex "SMTP" "welcome banner"
14967 .cindex "banner for SMTP"
14968 .cindex "welcome banner for SMTP"
14969 .cindex "customizing" "SMTP banner"
14970 This string, which is expanded every time it is used, is output as the initial
14971 positive response to an SMTP connection. The default setting is:
14972 .code
14973 smtp_banner = $smtp_active_hostname ESMTP Exim \
14974   $version_number $tod_full
14975 .endd
14976 Failure to expand the string causes a panic error. If you want to create a
14977 multiline response to the initial SMTP connection, use &"\n"& in the string at
14978 appropriate points, but not at the end. Note that the 220 code is not included
14979 in this string. Exim adds it automatically (several times in the case of a
14980 multiline response).
14981
14982
14983 .option smtp_check_spool_space main boolean true
14984 .cindex "checking disk space"
14985 .cindex "disk space, checking"
14986 .cindex "spool directory" "checking space"
14987 When this option is set, if an incoming SMTP session encounters the SIZE
14988 option on a MAIL command, it checks that there is enough space in the
14989 spool directory's partition to accept a message of that size, while still
14990 leaving free the amount specified by &%check_spool_space%& (even if that value
14991 is zero). If there isn't enough space, a temporary error code is returned.
14992
14993
14994 .option smtp_connect_backlog main integer 20
14995 .cindex "connection backlog"
14996 .cindex "SMTP" "connection backlog"
14997 .cindex "backlog of connections"
14998 This option specifies a maximum number of waiting SMTP connections. Exim passes
14999 this value to the TCP/IP system when it sets up its listener. Once this number
15000 of connections are waiting for the daemon's attention, subsequent connection
15001 attempts are refused at the TCP/IP level. At least, that is what the manuals
15002 say; in some circumstances such connection attempts have been observed to time
15003 out instead. For large systems it is probably a good idea to increase the
15004 value (to 50, say). It also gives some protection against denial-of-service
15005 attacks by SYN flooding.
15006
15007
15008 .option smtp_enforce_sync main boolean true
15009 .cindex "SMTP" "synchronization checking"
15010 .cindex "synchronization checking in SMTP"
15011 The SMTP protocol specification requires the client to wait for a response from
15012 the server at certain points in the dialogue. Without PIPELINING these
15013 synchronization points are after every command; with PIPELINING they are
15014 fewer, but they still exist.
15015
15016 Some spamming sites send out a complete set of SMTP commands without waiting
15017 for any response. Exim protects against this by rejecting a message if the
15018 client has sent further input when it should not have. The error response &"554
15019 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15020 for this error cannot be perfect because of transmission delays (unexpected
15021 input may be on its way but not yet received when Exim checks). However, it
15022 does detect many instances.
15023
15024 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15025 If you want to disable the check selectively (for example, only for certain
15026 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15027 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15028
15029
15030
15031 .option smtp_etrn_command main string&!! unset
15032 .cindex "ETRN" "command to be run"
15033 .vindex "&$domain$&"
15034 If this option is set, the given command is run whenever an SMTP ETRN
15035 command is received from a host that is permitted to issue such commands (see
15036 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15037 are independently expanded. The expansion variable &$domain$& is set to the
15038 argument of the ETRN command, and no syntax checking is done on it. For
15039 example:
15040 .code
15041 smtp_etrn_command = /etc/etrn_command $domain \
15042                     $sender_host_address
15043 .endd
15044 A new process is created to run the command, but Exim does not wait for it to
15045 complete. Consequently, its status cannot be checked. If the command cannot be
15046 run, a line is written to the panic log, but the ETRN caller still receives
15047 a 250 success response. Exim is normally running under its own uid when
15048 receiving SMTP, so it is not possible for it to change the uid before running
15049 the command.
15050
15051
15052 .option smtp_etrn_serialize main boolean true
15053 .cindex "ETRN" "serializing"
15054 When this option is set, it prevents the simultaneous execution of more than
15055 one identical command as a result of ETRN in an SMTP connection. See
15056 section &<<SECTETRN>>& for details.
15057
15058
15059 .option smtp_load_reserve main fixed-point unset
15060 .cindex "load average"
15061 If the system load average ever gets higher than this, incoming SMTP calls are
15062 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15063 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15064 the load is over the limit. The option has no effect on ancient operating
15065 systems on which Exim cannot determine the load average. See also
15066 &%deliver_queue_load_max%& and &%queue_only_load%&.
15067
15068
15069
15070 .option smtp_max_synprot_errors main integer 3
15071 .cindex "SMTP" "limiting syntax and protocol errors"
15072 .cindex "limit" "SMTP syntax and protocol errors"
15073 Exim rejects SMTP commands that contain syntax or protocol errors. In
15074 particular, a syntactically invalid email address, as in this command:
15075 .code
15076 RCPT TO:<abc xyz@a.b.c>
15077 .endd
15078 causes immediate rejection of the command, before any other tests are done.
15079 (The ACL cannot be run if there is no valid address to set up for it.) An
15080 example of a protocol error is receiving RCPT before MAIL. If there are
15081 too many syntax or protocol errors in one SMTP session, the connection is
15082 dropped. The limit is set by this option.
15083
15084 .cindex "PIPELINING" "expected errors"
15085 When the PIPELINING extension to SMTP is in use, some protocol errors are
15086 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15087 Exim assumes that PIPELINING will be used if it advertises it (see
15088 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15089 not count towards the limit.
15090
15091
15092
15093 .option smtp_max_unknown_commands main integer 3
15094 .cindex "SMTP" "limiting unknown commands"
15095 .cindex "limit" "unknown SMTP commands"
15096 If there are too many unrecognized commands in an incoming SMTP session, an
15097 Exim server drops the connection. This is a defence against some kinds of abuse
15098 that subvert web
15099 clients
15100 into making connections to SMTP ports; in these circumstances, a number of
15101 non-SMTP command lines are sent first.
15102
15103
15104
15105 .option smtp_ratelimit_hosts main "host list&!!" unset
15106 .cindex "SMTP" "rate limiting"
15107 .cindex "limit" "rate of message arrival"
15108 .cindex "RCPT" "rate limiting"
15109 Some sites find it helpful to be able to limit the rate at which certain hosts
15110 can send them messages, and the rate at which an individual message can specify
15111 recipients.
15112
15113 Exim has two rate-limiting facilities. This section describes the older
15114 facility, which can limit rates within a single connection. The newer
15115 &%ratelimit%& ACL condition can limit rates across all connections. See section
15116 &<<SECTratelimiting>>& for details of the newer facility.
15117
15118 When a host matches &%smtp_ratelimit_hosts%&, the values of
15119 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15120 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15121 respectively. Each option, if set, must contain a set of four comma-separated
15122 values:
15123
15124 .ilist
15125 A threshold, before which there is no rate limiting.
15126 .next
15127 An initial time delay. Unlike other times in Exim, numbers with decimal
15128 fractional parts are allowed here.
15129 .next
15130 A factor by which to increase the delay each time.
15131 .next
15132 A maximum value for the delay. This should normally be less than 5 minutes,
15133 because after that time, the client is liable to timeout the SMTP command.
15134 .endlist
15135
15136 For example, these settings have been used successfully at the site which
15137 first suggested this feature, for controlling mail from their customers:
15138 .code
15139 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15140 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15141 .endd
15142 The first setting specifies delays that are applied to MAIL commands after
15143 two have been received over a single connection. The initial delay is 0.5
15144 seconds, increasing by a factor of 1.05 each time. The second setting applies
15145 delays to RCPT commands when more than four occur in a single message.
15146
15147
15148 .option smtp_ratelimit_mail main string unset
15149 See &%smtp_ratelimit_hosts%& above.
15150
15151
15152 .option smtp_ratelimit_rcpt main string unset
15153 See &%smtp_ratelimit_hosts%& above.
15154
15155
15156 .option smtp_receive_timeout main time 5m
15157 .cindex "timeout" "for SMTP input"
15158 .cindex "SMTP" "input timeout"
15159 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15160 input, including batch SMTP. If a line of input (either an SMTP command or a
15161 data line) is not received within this time, the SMTP connection is dropped and
15162 the message is abandoned.
15163 A line is written to the log containing one of the following messages:
15164 .code
15165 SMTP command timeout on connection from...
15166 SMTP data timeout on connection from...
15167 .endd
15168 The former means that Exim was expecting to read an SMTP command; the latter
15169 means that it was in the DATA phase, reading the contents of a message.
15170
15171
15172 .oindex "&%-os%&"
15173 The value set by this option can be overridden by the
15174 &%-os%& command-line option. A setting of zero time disables the timeout, but
15175 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15176 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15177 timeout is controlled by &%receive_timeout%& and &%-or%&.
15178
15179
15180 .option smtp_reserve_hosts main "host list&!!" unset
15181 This option defines hosts for which SMTP connections are reserved; see
15182 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15183
15184
15185 .option smtp_return_error_details main boolean false
15186 .cindex "SMTP" "details policy failures"
15187 .cindex "policy control" "rejection, returning details"
15188 In the default state, Exim uses bland messages such as
15189 &"Administrative prohibition"& when it rejects SMTP commands for policy
15190 reasons. Many sysadmins like this because it gives away little information
15191 to spammers. However, some other sysadmins who are applying strict checking
15192 policies want to give out much fuller information about failures. Setting
15193 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15194 example, instead of &"Administrative prohibition"&, it might give:
15195 .code
15196 550-Rejected after DATA: '>' missing at end of address:
15197 550 failing address in "From" header is: <user@dom.ain
15198 .endd
15199
15200 .option spamd_address main string "see below"
15201 This option is available when Exim is compiled with the content-scanning
15202 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15203 The default value is
15204 .code
15205 127.0.0.1 783
15206 .endd
15207 See section &<<SECTscanspamass>>& for more details.
15208
15209
15210
15211 .option split_spool_directory main boolean false
15212 .cindex "multiple spool directories"
15213 .cindex "spool directory" "split"
15214 .cindex "directories, multiple"
15215 If this option is set, it causes Exim to split its input directory into 62
15216 subdirectories, each with a single alphanumeric character as its name. The
15217 sixth character of the message id is used to allocate messages to
15218 subdirectories; this is the least significant base-62 digit of the time of
15219 arrival of the message.
15220
15221 Splitting up the spool in this way may provide better performance on systems
15222 where there are long mail queues, by reducing the number of files in any one
15223 directory. The msglog directory is also split up in a similar way to the input
15224 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15225 are still placed in the single directory &_msglog.OLD_&.
15226
15227 It is not necessary to take any special action for existing messages when
15228 changing &%split_spool_directory%&. Exim notices messages that are in the
15229 &"wrong"& place, and continues to process them. If the option is turned off
15230 after a period of being on, the subdirectories will eventually empty and be
15231 automatically deleted.
15232
15233 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15234 changes. Instead of creating a list of all messages in the queue, and then
15235 trying to deliver each one in turn, it constructs a list of those in one
15236 sub-directory and tries to deliver them, before moving on to the next
15237 sub-directory. The sub-directories are processed in a random order. This
15238 spreads out the scanning of the input directories, and uses less memory. It is
15239 particularly beneficial when there are lots of messages on the queue. However,
15240 if &%queue_run_in_order%& is set, none of this new processing happens. The
15241 entire queue has to be scanned and sorted before any deliveries can start.
15242
15243
15244 .option spool_directory main string&!! "set at compile time"
15245 .cindex "spool directory" "path to"
15246 This defines the directory in which Exim keeps its spool, that is, the messages
15247 it is waiting to deliver. The default value is taken from the compile-time
15248 configuration setting, if there is one. If not, this option must be set. The
15249 string is expanded, so it can contain, for example, a reference to
15250 &$primary_hostname$&.
15251
15252 If the spool directory name is fixed on your installation, it is recommended
15253 that you set it at build time rather than from this option, particularly if the
15254 log files are being written to the spool directory (see &%log_file_path%&).
15255 Otherwise log files cannot be used for errors that are detected early on, such
15256 as failures in the configuration file.
15257
15258 By using this option to override the compiled-in path, it is possible to run
15259 tests of Exim without using the standard spool.
15260
15261 .option sqlite_lock_timeout main time 5s
15262 .cindex "sqlite lookup type" "lock timeout"
15263 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15264 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15265
15266 .option strict_acl_vars main boolean false
15267 .cindex "&ACL;" "variables, handling unset"
15268 This option controls what happens if a syntactically valid but undefined ACL
15269 variable is referenced. If it is false (the default), an empty string
15270 is substituted; if it is true, an error is generated. See section
15271 &<<SECTaclvariables>>& for details of ACL variables.
15272
15273 .option strip_excess_angle_brackets main boolean false
15274 .cindex "angle brackets, excess"
15275 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15276 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15277 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15278 passed on to another MTA, the excess angle brackets are not passed on. If this
15279 option is not set, multiple pairs of angle brackets cause a syntax error.
15280
15281
15282 .option strip_trailing_dot main boolean false
15283 .cindex "trailing dot on domain"
15284 .cindex "dot" "trailing on domain"
15285 If this option is set, a trailing dot at the end of a domain in an address is
15286 ignored. If this is in the envelope and the message is passed on to another
15287 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15288 domain causes a syntax error.
15289 However, addresses in header lines are checked only when an ACL requests header
15290 syntax checking.
15291
15292
15293 .option syslog_duplication main boolean true
15294 .cindex "syslog" "duplicate log lines; suppressing"
15295 When Exim is logging to syslog, it writes the log lines for its three
15296 separate logs at different syslog priorities so that they can in principle
15297 be separated on the logging hosts. Some installations do not require this
15298 separation, and in those cases, the duplication of certain log lines is a
15299 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15300 particular log line is written to syslog. For lines that normally go to
15301 both the main log and the reject log, the reject log version (possibly
15302 containing message header lines) is written, at LOG_NOTICE priority.
15303 Lines that normally go to both the main and the panic log are written at
15304 the LOG_ALERT priority.
15305
15306
15307 .option syslog_facility main string unset
15308 .cindex "syslog" "facility; setting"
15309 This option sets the syslog &"facility"& name, used when Exim is logging to
15310 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15311 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15312 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15313 details of Exim's logging.
15314
15315
15316
15317 .option syslog_processname main string &`exim`&
15318 .cindex "syslog" "process name; setting"
15319 This option sets the syslog &"ident"& name, used when Exim is logging to
15320 syslog. The value must be no longer than 32 characters. See chapter
15321 &<<CHAPlog>>& for details of Exim's logging.
15322
15323
15324
15325 .option syslog_timestamp main boolean true
15326 .cindex "syslog" "timestamps"
15327 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15328 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15329 details of Exim's logging.
15330
15331
15332 .option system_filter main string&!! unset
15333 .cindex "filter" "system filter"
15334 .cindex "system filter" "specifying"
15335 .cindex "Sieve filter" "not available for system filter"
15336 This option specifies an Exim filter file that is applied to all messages at
15337 the start of each delivery attempt, before any routing is done. System filters
15338 must be Exim filters; they cannot be Sieve filters. If the system filter
15339 generates any deliveries to files or pipes, or any new mail messages, the
15340 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15341 which transports are to be used. Details of this facility are given in chapter
15342 &<<CHAPsystemfilter>>&.
15343
15344
15345 .option system_filter_directory_transport main string&!! unset
15346 .vindex "&$address_file$&"
15347 This sets the name of the transport driver that is to be used when the
15348 &%save%& command in a system message filter specifies a path ending in &"/"&,
15349 implying delivery of each message into a separate file in some directory.
15350 During the delivery, the variable &$address_file$& contains the path name.
15351
15352
15353 .option system_filter_file_transport main string&!! unset
15354 .cindex "file" "transport for system filter"
15355 This sets the name of the transport driver that is to be used when the &%save%&
15356 command in a system message filter specifies a path not ending in &"/"&. During
15357 the delivery, the variable &$address_file$& contains the path name.
15358
15359 .option system_filter_group main string unset
15360 .cindex "gid (group id)" "system filter"
15361 This option is used only when &%system_filter_user%& is also set. It sets the
15362 gid under which the system filter is run, overriding any gid that is associated
15363 with the user. The value may be numerical or symbolic.
15364
15365 .option system_filter_pipe_transport main string&!! unset
15366 .cindex "&(pipe)& transport" "for system filter"
15367 .vindex "&$address_pipe$&"
15368 This specifies the transport driver that is to be used when a &%pipe%& command
15369 is used in a system filter. During the delivery, the variable &$address_pipe$&
15370 contains the pipe command.
15371
15372
15373 .option system_filter_reply_transport main string&!! unset
15374 .cindex "&(autoreply)& transport" "for system filter"
15375 This specifies the transport driver that is to be used when a &%mail%& command
15376 is used in a system filter.
15377
15378 .new
15379 .option system_filter_user main string unset
15380 .cindex "uid (user id)" "system filter"
15381 If this option is set to root, the system filter is run in the main Exim
15382 delivery process, as root.  Otherwise, the system filter runs in a separate
15383 process, as the given user, defaulting to the Exim run-time user.
15384 Unless the string consists entirely of digits, it
15385 is looked up in the password data. Failure to find the named user causes a
15386 configuration error. The gid is either taken from the password data, or
15387 specified by &%system_filter_group%&. When the uid is specified numerically,
15388 &%system_filter_group%& is required to be set.
15389
15390 If the system filter generates any pipe, file, or reply deliveries, the uid
15391 under which the filter is run is used when transporting them, unless a
15392 transport option overrides.
15393 .wen
15394
15395
15396 .option tcp_nodelay main boolean true
15397 .cindex "daemon" "TCP_NODELAY on sockets"
15398 .cindex "Nagle algorithm"
15399 .cindex "TCP_NODELAY on listening sockets"
15400 If this option is set false, it stops the Exim daemon setting the
15401 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15402 turns off the &"Nagle algorithm"&, which is a way of improving network
15403 performance in interactive (character-by-character) situations. Turning it off
15404 should improve Exim's performance a bit, so that is what happens by default.
15405 However, it appears that some broken clients cannot cope, and time out. Hence
15406 this option. It affects only those sockets that are set up for listening by the
15407 daemon. Sockets created by the smtp transport for delivering mail always set
15408 TCP_NODELAY.
15409
15410
15411 .option timeout_frozen_after main time 0s
15412 .cindex "frozen messages" "timing out"
15413 .cindex "timeout" "frozen messages"
15414 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15415 message of any kind that has been on the queue for longer than the given time
15416 is automatically cancelled at the next queue run. If the frozen message is a
15417 bounce message, it is just discarded; otherwise, a bounce is sent to the
15418 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
15419 If you want to timeout frozen bounce messages earlier than other kinds of
15420 frozen message, see &%ignore_bounce_errors_after%&.
15421
15422 &*Note:*& the default value of zero means no timeouts; with this setting,
15423 frozen messages remain on the queue forever (except for any frozen bounce
15424 messages that are released by &%ignore_bounce_errors_after%&).
15425
15426
15427 .option timezone main string unset
15428 .cindex "timezone, setting"
15429 The value of &%timezone%& is used to set the environment variable TZ while
15430 running Exim (if it is different on entry). This ensures that all timestamps
15431 created by Exim are in the required timezone. If you want all your timestamps
15432 to be in UTC (aka GMT) you should set
15433 .code
15434 timezone = UTC
15435 .endd
15436 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
15437 or, if that is not set, from the value of the TZ environment variable when Exim
15438 is built. If &%timezone%& is set to the empty string, either at build or run
15439 time, any existing TZ variable is removed from the environment when Exim
15440 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
15441 unfortunately not all, operating systems.
15442
15443
15444 .option tls_advertise_hosts main "host list&!!" unset
15445 .cindex "TLS" "advertising"
15446 .cindex "encryption" "on SMTP connection"
15447 .cindex "SMTP" "encrypted connection"
15448 When Exim is built with support for TLS encrypted connections, the availability
15449 of the STARTTLS command to set up an encrypted session is advertised in
15450 response to EHLO only to those client hosts that match this option. See
15451 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
15452
15453
15454 .option tls_certificate main string&!! unset
15455 .cindex "TLS" "server certificate; location of"
15456 .cindex "certificate" "server, location of"
15457 The value of this option is expanded, and must then be the absolute path to a
15458 file which contains the server's certificates. The server's private key is also
15459 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
15460 &<<CHAPTLS>>& for further details.
15461
15462 &*Note*&: The certificates defined by this option are used only when Exim is
15463 receiving incoming messages as a server. If you want to supply certificates for
15464 use when sending messages as a client, you must set the &%tls_certificate%&
15465 option in the relevant &(smtp)& transport.
15466
15467
15468 .option tls_crl main string&!! unset
15469 .cindex "TLS" "server certificate revocation list"
15470 .cindex "certificate" "revocation list for server"
15471 This option specifies a certificate revocation list. The expanded value must
15472 be the name of a file that contains a CRL in PEM format.
15473
15474
15475 .option tls_dhparam main string&!! unset
15476 .cindex "TLS" "D-H parameters for server"
15477 The value of this option is expanded, and must then be the absolute path to
15478 a file which contains the server's DH parameter values.
15479 This is used only for OpenSSL. When Exim is linked with GnuTLS, this option is
15480 ignored. See section &<<SECTopenvsgnu>>& for further details.
15481
15482
15483 .option tls_on_connect_ports main "string list" unset
15484 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
15485 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
15486 set up without waiting for the client to issue a STARTTLS command. For
15487 further details, see section &<<SECTsupobssmt>>&.
15488
15489
15490
15491 .option tls_privatekey main string&!! unset
15492 .cindex "TLS" "server private key; location of"
15493 The value of this option is expanded, and must then be the absolute path to a
15494 file which contains the server's private key. If this option is unset, or if
15495 the expansion is forced to fail, or the result is an empty string, the private
15496 key is assumed to be in the same file as the server's certificates. See chapter
15497 &<<CHAPTLS>>& for further details.
15498
15499
15500 .option tls_remember_esmtp main boolean false
15501 .cindex "TLS" "esmtp state; remembering"
15502 .cindex "TLS" "broken clients"
15503 If this option is set true, Exim violates the RFCs by remembering that it is in
15504 &"esmtp"& state after successfully negotiating a TLS session. This provides
15505 support for broken clients that fail to send a new EHLO after starting a
15506 TLS session.
15507
15508
15509 .option tls_require_ciphers main string&!! unset
15510 .cindex "TLS" "requiring specific ciphers"
15511 .cindex "cipher" "requiring specific"
15512 This option controls which ciphers can be used for incoming TLS connections.
15513 The &(smtp)& transport has an option of the same name for controlling outgoing
15514 connections. This option is expanded for each connection, so can be varied for
15515 different clients if required. The value of this option must be a list of
15516 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
15517 in somewhat different ways. If GnuTLS is being used, the client controls the
15518 preference order of the available ciphers. Details are given in sections
15519 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
15520
15521
15522 .option tls_try_verify_hosts main "host list&!!" unset
15523 .cindex "TLS" "client certificate verification"
15524 .cindex "certificate" "verification of client"
15525 See &%tls_verify_hosts%& below.
15526
15527
15528 .option tls_verify_certificates main string&!! unset
15529 .cindex "TLS" "client certificate verification"
15530 .cindex "certificate" "verification of client"
15531 The value of this option is expanded, and must then be the absolute path to
15532 a file containing permitted certificates for clients that
15533 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
15534 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
15535 directory containing certificate files. This does not work with GnuTLS; the
15536 option must be set to the name of a single file if you are using GnuTLS.
15537
15538 .new
15539 These certificates should be for the certificate authorities trusted, rather
15540 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
15541 the value is a file then the certificates are sent by Exim as a server to
15542 connecting clients, defining the list of accepted certificate authorities.
15543 Thus the values defined should be considered public data.  To avoid this,
15544 use OpenSSL with a directory.
15545 .wen
15546
15547 .option tls_verify_hosts main "host list&!!" unset
15548 .cindex "TLS" "client certificate verification"
15549 .cindex "certificate" "verification of client"
15550 This option, along with &%tls_try_verify_hosts%&, controls the checking of
15551 certificates from clients. The expected certificates are defined by
15552 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
15553 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
15554 &%tls_verify_certificates%& is not set.
15555
15556 Any client that matches &%tls_verify_hosts%& is constrained by
15557 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
15558 present one of the listed certificates. If it does not, the connection is
15559 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
15560 the host to use TLS. It can still send SMTP commands through unencrypted
15561 connections. Forcing a client to use TLS has to be done separately using an
15562 ACL to reject inappropriate commands when the connection is not encrypted.
15563
15564 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
15565 matches this option (but not &%tls_verify_hosts%&), Exim requests a
15566 certificate and checks it against &%tls_verify_certificates%&, but does not
15567 abort the connection if there is no certificate or if it does not match. This
15568 state can be detected in an ACL, which makes it possible to implement policies
15569 such as &"accept for relay only if a verified certificate has been received,
15570 but accept for local delivery if encrypted, even without a verified
15571 certificate"&.
15572
15573 Client hosts that match neither of these lists are not asked to present
15574 certificates.
15575
15576
15577 .option trusted_groups main "string list&!!" unset
15578 .cindex "trusted groups"
15579 .cindex "groups" "trusted"
15580 This option is expanded just once, at the start of Exim's processing. If this
15581 option is set, any process that is running in one of the listed groups, or
15582 which has one of them as a supplementary group, is trusted. The groups can be
15583 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
15584 details of what trusted callers are permitted to do. If neither
15585 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
15586 are trusted.
15587
15588 .option trusted_users main "string list&!!" unset
15589 .cindex "trusted users"
15590 .cindex "user" "trusted"
15591 This option is expanded just once, at the start of Exim's processing. If this
15592 option is set, any process that is running as one of the listed users is
15593 trusted. The users can be specified numerically or by name. See section
15594 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
15595 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
15596 Exim user are trusted.
15597
15598 .option unknown_login main string&!! unset
15599 .cindex "uid (user id)" "unknown caller"
15600 .vindex "&$caller_uid$&"
15601 This is a specialized feature for use in unusual configurations. By default, if
15602 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
15603 gives up. The &%unknown_login%& option can be used to set a login name to be
15604 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
15605 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
15606 is used for the user's real name (gecos field), unless this has been set by the
15607 &%-F%& option.
15608
15609 .option unknown_username main string unset
15610 See &%unknown_login%&.
15611
15612 .option untrusted_set_sender main "address list&!!" unset
15613 .cindex "trusted users"
15614 .cindex "sender" "setting by untrusted user"
15615 .cindex "untrusted user setting sender"
15616 .cindex "user" "untrusted setting sender"
15617 .cindex "envelope sender"
15618 When an untrusted user submits a message to Exim using the standard input, Exim
15619 normally creates an envelope sender address from the user's login and the
15620 default qualification domain. Data from the &%-f%& option (for setting envelope
15621 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
15622 is used) is ignored.
15623
15624 However, untrusted users are permitted to set an empty envelope sender address,
15625 to declare that a message should never generate any bounces. For example:
15626 .code
15627 exim -f '<>' user@domain.example
15628 .endd
15629 .vindex "&$sender_ident$&"
15630 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
15631 other envelope sender addresses in a controlled way. When it is set, untrusted
15632 users are allowed to set envelope sender addresses that match any of the
15633 patterns in the list. Like all address lists, the string is expanded. The
15634 identity of the user is in &$sender_ident$&, so you can, for example, restrict
15635 users to setting senders that start with their login ids
15636 followed by a hyphen
15637 by a setting like this:
15638 .code
15639 untrusted_set_sender = ^$sender_ident-
15640 .endd
15641 If you want to allow untrusted users to set envelope sender addresses without
15642 restriction, you can use
15643 .code
15644 untrusted_set_sender = *
15645 .endd
15646 The &%untrusted_set_sender%& option applies to all forms of local input, but
15647 only to the setting of the envelope sender. It does not permit untrusted users
15648 to use the other options which trusted user can use to override message
15649 parameters. Furthermore, it does not stop Exim from removing an existing
15650 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
15651 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
15652 overriding these actions. The handling of the &'Sender:'& header is also
15653 described in section &<<SECTthesenhea>>&.
15654
15655 The log line for a message's arrival shows the envelope sender following
15656 &"<="&. For local messages, the user's login always follows, after &"U="&. In
15657 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
15658 envelope sender address, the user's login is shown in parentheses after the
15659 sender address.
15660
15661
15662 .option uucp_from_pattern main string "see below"
15663 .cindex "&""From""& line"
15664 .cindex "UUCP" "&""From""& line"
15665 Some applications that pass messages to an MTA via a command line interface use
15666 an initial line starting with &"From&~"& to pass the envelope sender. In
15667 particular, this is used by UUCP software. Exim recognizes such a line by means
15668 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
15669 matches, the sender address is constructed by expanding the contents of
15670 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
15671 default pattern recognizes lines in the following two forms:
15672 .code
15673 From ph10 Fri Jan  5 12:35 GMT 1996
15674 From ph10 Fri, 7 Jan 97 14:00:00 GMT
15675 .endd
15676 The pattern can be seen by running
15677 .code
15678 exim -bP uucp_from_pattern
15679 .endd
15680 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
15681 year in the second case. The first word after &"From&~"& is matched in the
15682 regular expression by a parenthesized subpattern. The default value for
15683 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
15684 (&"ph10"& in the example above) as the message's sender. See also
15685 &%ignore_fromline_hosts%&.
15686
15687
15688 .option uucp_from_sender main string&!! &`$1`&
15689 See &%uucp_from_pattern%& above.
15690
15691
15692 .option warn_message_file main string unset
15693 .cindex "warning of delay" "customizing the message"
15694 .cindex "customizing" "warning message"
15695 This option defines a template file containing paragraphs of text to be used
15696 for constructing the warning message which is sent by Exim when a message has
15697 been on the queue for a specified amount of time, as specified by
15698 &%delay_warning%&. Details of the file's contents are given in chapter
15699 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
15700
15701
15702 .option write_rejectlog main boolean true
15703 .cindex "reject log" "disabling"
15704 If this option is set false, Exim no longer writes anything to the reject log.
15705 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
15706 .ecindex IIDconfima
15707 .ecindex IIDmaiconf
15708
15709
15710
15711
15712 . ////////////////////////////////////////////////////////////////////////////
15713 . ////////////////////////////////////////////////////////////////////////////
15714
15715 .chapter "Generic options for routers" "CHAProutergeneric"
15716 .scindex IIDgenoprou1 "options" "generic; for routers"
15717 .scindex IIDgenoprou2 "generic options" "router"
15718 This chapter describes the generic options that apply to all routers.
15719 Those that are preconditions are marked with &Dagger; in the &"use"& field.
15720
15721 For a general description of how a router operates, see sections
15722 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
15723 which the preconditions are tested. The order of expansion of the options that
15724 provide data for a transport is: &%errors_to%&, &%headers_add%&,
15725 &%headers_remove%&, &%transport%&.
15726
15727
15728
15729 .option address_data routers string&!! unset
15730 .cindex "router" "data attached to address"
15731 The string is expanded just before the router is run, that is, after all the
15732 precondition tests have succeeded. If the expansion is forced to fail, the
15733 router declines, the value of &%address_data%& remains unchanged, and the
15734 &%more%& option controls what happens next. Other expansion failures cause
15735 delivery of the address to be deferred.
15736
15737 .vindex "&$address_data$&"
15738 When the expansion succeeds, the value is retained with the address, and can be
15739 accessed using the variable &$address_data$& in the current router, subsequent
15740 routers, and the eventual transport.
15741
15742 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
15743 that runs a user's filter file, the contents of &$address_data$& are accessible
15744 in the filter. This is not normally a problem, because such data is usually
15745 either not confidential or it &"belongs"& to the current user, but if you do
15746 put confidential data into &$address_data$& you need to remember this point.
15747
15748 Even if the router declines or passes, the value of &$address_data$& remains
15749 with the address, though it can be changed by another &%address_data%& setting
15750 on a subsequent router. If a router generates child addresses, the value of
15751 &$address_data$& propagates to them. This also applies to the special kind of
15752 &"child"& that is generated by a router with the &%unseen%& option.
15753
15754 The idea of &%address_data%& is that you can use it to look up a lot of data
15755 for the address once, and then pick out parts of the data later. For example,
15756 you could use a single LDAP lookup to return a string of the form
15757 .code
15758 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
15759 .endd
15760 In the transport you could pick out the mailbox by a setting such as
15761 .code
15762 file = ${extract{mailbox}{$address_data}}
15763 .endd
15764 This makes the configuration file less messy, and also reduces the number of
15765 lookups (though Exim does cache lookups).
15766
15767 .vindex "&$sender_address_data$&"
15768 .vindex "&$address_data$&"
15769 The &%address_data%& facility is also useful as a means of passing information
15770 from one router to another, and from a router to a transport. In addition, if
15771 &$address_data$& is set by a router when verifying a recipient address from an
15772 ACL, it remains available for use in the rest of the ACL statement. After
15773 verifying a sender, the value is transferred to &$sender_address_data$&.
15774
15775
15776
15777 .option address_test routers&!? boolean true
15778 .oindex "&%-bt%&"
15779 .cindex "router" "skipping when address testing"
15780 If this option is set false, the router is skipped when routing is being tested
15781 by means of the &%-bt%& command line option. This can be a convenience when
15782 your first router sends messages to an external scanner, because it saves you
15783 having to set the &"already scanned"& indicator when testing real address
15784 routing.
15785
15786
15787
15788 .option cannot_route_message routers string&!! unset
15789 .cindex "router" "customizing &""cannot route""& message"
15790 .cindex "customizing" "&""cannot route""& message"
15791 This option specifies a text message that is used when an address cannot be
15792 routed because Exim has run out of routers. The default message is
15793 &"Unrouteable address"&. This option is useful only on routers that have
15794 &%more%& set false, or on the very last router in a configuration, because the
15795 value that is used is taken from the last router that is considered. This
15796 includes a router that is skipped because its preconditions are not met, as
15797 well as a router that declines. For example, using the default configuration,
15798 you could put:
15799 .code
15800 cannot_route_message = Remote domain not found in DNS
15801 .endd
15802 on the first router, which is a &(dnslookup)& router with &%more%& set false,
15803 and
15804 .code
15805 cannot_route_message = Unknown local user
15806 .endd
15807 on the final router that checks for local users. If string expansion fails for
15808 this option, the default message is used. Unless the expansion failure was
15809 explicitly forced, a message about the failure is written to the main and panic
15810 logs, in addition to the normal message about the routing failure.
15811
15812
15813 .option caseful_local_part routers boolean false
15814 .cindex "case of local parts"
15815 .cindex "router" "case of local parts"
15816 By default, routers handle the local parts of addresses in a case-insensitive
15817 manner, though the actual case is preserved for transmission with the message.
15818 If you want the case of letters to be significant in a router, you must set
15819 this option true. For individual router options that contain address or local
15820 part lists (for example, &%local_parts%&), case-sensitive matching can be
15821 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
15822 more details.
15823
15824 .vindex "&$local_part$&"
15825 .vindex "&$original_local_part$&"
15826 .vindex "&$parent_local_part$&"
15827 The value of the &$local_part$& variable is forced to lower case while a
15828 router is running unless &%caseful_local_part%& is set. When a router assigns
15829 an address to a transport, the value of &$local_part$& when the transport runs
15830 is the same as it was in the router. Similarly, when a router generates child
15831 addresses by aliasing or forwarding, the values of &$original_local_part$&
15832 and &$parent_local_part$& are those that were used by the redirecting router.
15833
15834 This option applies to the processing of an address by a router. When a
15835 recipient address is being processed in an ACL, there is a separate &%control%&
15836 modifier that can be used to specify case-sensitive processing within the ACL
15837 (see section &<<SECTcontrols>>&).
15838
15839
15840
15841 .option check_local_user routers&!? boolean false
15842 .cindex "local user, checking in router"
15843 .cindex "router" "checking for local user"
15844 .cindex "&_/etc/passwd_&"
15845 .vindex "&$home$&"
15846 When this option is true, Exim checks that the local part of the recipient
15847 address (with affixes removed if relevant) is the name of an account on the
15848 local system. The check is done by calling the &[getpwnam()]& function rather
15849 than trying to read &_/etc/passwd_& directly. This means that other methods of
15850 holding password data (such as NIS) are supported. If the local part is a local
15851 user, &$home$& is set from the password data, and can be tested in other
15852 preconditions that are evaluated after this one (the order of evaluation is
15853 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
15854 overridden by &%router_home_directory%&. If the local part is not a local user,
15855 the router is skipped.
15856
15857 If you want to check that the local part is either the name of a local user
15858 or matches something else, you cannot combine &%check_local_user%& with a
15859 setting of &%local_parts%&, because that specifies the logical &'and'& of the
15860 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
15861 setting to achieve this. For example:
15862 .code
15863 local_parts = passwd;$local_part : lsearch;/etc/other/users
15864 .endd
15865 Note, however, that the side effects of &%check_local_user%& (such as setting
15866 up a home directory) do not occur when a &(passwd)& lookup is used in a
15867 &%local_parts%& (or any other) precondition.
15868
15869
15870
15871 .option condition routers&!? string&!! unset
15872 .cindex "router" "customized precondition"
15873 This option specifies a general precondition test that has to succeed for the
15874 router to be called. The &%condition%& option is the last precondition to be
15875 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
15876 result is a forced failure, or an empty string, or one of the strings &"0"& or
15877 &"no"& or &"false"& (checked without regard to the case of the letters), the
15878 router is skipped, and the address is offered to the next one.
15879
15880 If the result is any other value, the router is run (as this is the last
15881 precondition to be evaluated, all the other preconditions must be true).
15882
15883 .new
15884 This option is unique in that multiple &%condition%& options may be present.
15885 All &%condition%& options must succeed.
15886 .wen
15887
15888 .new
15889 The &%condition%& option provides a means of applying custom conditions to the
15890 running of routers. Note that in the case of a simple conditional expansion,
15891 the default expansion values are exactly what is wanted. For example:
15892 .code
15893 condition = ${if >{$message_age}{600}}
15894 .endd
15895 Because of the default behaviour of the string expansion, this is equivalent to
15896 .code
15897 condition = ${if >{$message_age}{600}{true}{}}
15898 .endd
15899
15900 A multiple condition example, which succeeds:
15901 .code
15902 condition = ${if >{$message_age}{600}}
15903 condition = ${if !eq{${lc:$local_part}}{postmaster}}
15904 condition = foobar
15905 .endd
15906
15907 If the expansion fails (other than forced failure) delivery is deferred. Some
15908 of the other precondition options are common special cases that could in fact
15909 be specified using &%condition%&.
15910 .wen
15911
15912
15913 .option debug_print routers string&!! unset
15914 .cindex "testing" "variables in drivers"
15915 If this option is set and debugging is enabled (see the &%-d%& command line
15916 option), the string is expanded and included in the debugging output.
15917 If expansion of the string fails, the error message is written to the debugging
15918 output, and Exim carries on processing.
15919 This option is provided to help with checking out the values of variables and
15920 so on when debugging router configurations. For example, if a &%condition%&
15921 option appears not to be working, &%debug_print%& can be used to output the
15922 variables it references. The output happens after checks for &%domains%&,
15923 &%local_parts%&, and &%check_local_user%& but before any other preconditions
15924 are tested. A newline is added to the text if it does not end with one.
15925
15926
15927
15928 .option disable_logging routers boolean false
15929 If this option is set true, nothing is logged for any routing errors
15930 or for any deliveries caused by this router. You should not set this option
15931 unless you really, really know what you are doing. See also the generic
15932 transport option of the same name.
15933
15934
15935 .option domains routers&!? "domain list&!!" unset
15936 .cindex "router" "restricting to specific domains"
15937 .vindex "&$domain_data$&"
15938 If this option is set, the router is skipped unless the current domain matches
15939 the list. If the match is achieved by means of a file lookup, the data that the
15940 lookup returned for the domain is placed in &$domain_data$& for use in string
15941 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
15942 a list of the order in which preconditions are evaluated.
15943
15944
15945
15946 .option driver routers string unset
15947 This option must always be set. It specifies which of the available routers is
15948 to be used.
15949
15950
15951
15952 .option errors_to routers string&!! unset
15953 .cindex "envelope sender"
15954 .cindex "router" "changing address for errors"
15955 If a router successfully handles an address, it may assign the address to a
15956 transport for delivery or it may generate child addresses. In both cases, if
15957 there is a delivery problem during later processing, the resulting bounce
15958 message is sent to the address that results from expanding this string,
15959 provided that the address verifies successfully. The &%errors_to%& option is
15960 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
15961
15962 The &%errors_to%& setting associated with an address can be overridden if it
15963 subsequently passes through other routers that have their own &%errors_to%&
15964 settings, or if the message is delivered by a transport with a &%return_path%&
15965 setting.
15966
15967 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
15968 the expansion fails to verify, the errors address associated with the incoming
15969 address is used. At top level, this is the envelope sender. A non-forced
15970 expansion failure causes delivery to be deferred.
15971
15972 If an address for which &%errors_to%& has been set ends up being delivered over
15973 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
15974 any bounces that are generated by other MTAs on the delivery route are also
15975 sent there. You can set &%errors_to%& to the empty string by either of these
15976 settings:
15977 .code
15978 errors_to =
15979 errors_to = ""
15980 .endd
15981 An expansion item that yields an empty string has the same effect. If you do
15982 this, a locally detected delivery error for addresses processed by this router
15983 no longer gives rise to a bounce message; the error is discarded. If the
15984 address is delivered to a remote host, the return path is set to &`<>`&, unless
15985 overridden by the &%return_path%& option on the transport.
15986
15987 .vindex "&$address_data$&"
15988 If for some reason you want to discard local errors, but use a non-empty
15989 MAIL command for remote delivery, you can preserve the original return
15990 path in &$address_data$& in the router, and reinstate it in the transport by
15991 setting &%return_path%&.
15992
15993 The most common use of &%errors_to%& is to direct mailing list bounces to the
15994 manager of the list, as described in section &<<SECTmailinglists>>&, or to
15995 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
15996
15997
15998
15999 .option expn routers&!? boolean true
16000 .cindex "address" "testing"
16001 .cindex "testing" "addresses"
16002 .cindex "EXPN" "router skipping"
16003 .cindex "router" "skipping for EXPN"
16004 If this option is turned off, the router is skipped when testing an address
16005 as a result of processing an SMTP EXPN command. You might, for example,
16006 want to turn it off on a router for users' &_.forward_& files, while leaving it
16007 on for the system alias file.
16008 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16009 are evaluated.
16010
16011 The use of the SMTP EXPN command is controlled by an ACL (see chapter
16012 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
16013 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
16014
16015
16016
16017 .option fail_verify routers boolean false
16018 .cindex "router" "forcing verification failure"
16019 Setting this option has the effect of setting both &%fail_verify_sender%& and
16020 &%fail_verify_recipient%& to the same value.
16021
16022
16023
16024 .option fail_verify_recipient routers boolean false
16025 If this option is true and an address is accepted by this router when
16026 verifying a recipient, verification fails.
16027
16028
16029
16030 .option fail_verify_sender routers boolean false
16031 If this option is true and an address is accepted by this router when
16032 verifying a sender, verification fails.
16033
16034
16035
16036 .option fallback_hosts routers "string list" unset
16037 .cindex "router" "fallback hosts"
16038 .cindex "fallback" "hosts specified on router"
16039 String expansion is not applied to this option. The argument must be a
16040 colon-separated list of host names or IP addresses. The list separator can be
16041 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
16042 each name or address. In fact, the format of each item is exactly the same as
16043 defined for the list of hosts in a &(manualroute)& router (see section
16044 &<<SECTformatonehostitem>>&).
16045
16046 If a router queues an address for a remote transport, this host list is
16047 associated with the address, and used instead of the transport's fallback host
16048 list. If &%hosts_randomize%& is set on the transport, the order of the list is
16049 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
16050 transport for further details.
16051
16052
16053 .option group routers string&!! "see below"
16054 .cindex "gid (group id)" "local delivery"
16055 .cindex "local transports" "uid and gid"
16056 .cindex "transport" "local"
16057 .cindex "router" "setting group"
16058 When a router queues an address for a transport, and the transport does not
16059 specify a group, the group given here is used when running the delivery
16060 process.
16061 The group may be specified numerically or by name. If expansion fails, the
16062 error is logged and delivery is deferred.
16063 The default is unset, unless &%check_local_user%& is set, when the default
16064 is taken from the password information. See also &%initgroups%& and &%user%&
16065 and the discussion in chapter &<<CHAPenvironment>>&.
16066
16067
16068
16069 .option headers_add routers string&!! unset
16070 .cindex "header lines" "adding"
16071 .cindex "router" "adding header lines"
16072 This option specifies a string of text that is expanded at routing time, and
16073 associated with any addresses that are accepted by the router. However, this
16074 option has no effect when an address is just being verified. The way in which
16075 the text is used to add header lines at transport time is described in section
16076 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
16077 message is in the process of being transported. This means that references to
16078 header lines in string expansions in the transport's configuration do not
16079 &"see"& the added header lines.
16080
16081 The &%headers_add%& option is expanded after &%errors_to%&, but before
16082 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
16083 the expansion is forced to fail, the option has no effect. Other expansion
16084 failures are treated as configuration errors.
16085
16086 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
16087 router that has the &%one_time%& option set.
16088
16089 .cindex "duplicate addresses"
16090 .oindex "&%unseen%&"
16091 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16092 additions are deleted when the address is passed on to subsequent routers.
16093 For a &%redirect%& router, if a generated address is the same as the incoming
16094 address, this can lead to duplicate addresses with different header
16095 modifications. Exim does not do duplicate deliveries (except, in certain
16096 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
16097 which of the duplicates is discarded, so this ambiguous situation should be
16098 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
16099
16100
16101
16102 .option headers_remove routers string&!! unset
16103 .cindex "header lines" "removing"
16104 .cindex "router" "removing header lines"
16105 This option specifies a string of text that is expanded at routing time, and
16106 associated with any addresses that are accepted by the router. However, this
16107 option has no effect when an address is just being verified. The way in which
16108 the text is used to remove header lines at transport time is described in
16109 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
16110 the message is in the process of being transported. This means that references
16111 to header lines in string expansions in the transport's configuration still
16112 &"see"& the original header lines.
16113
16114 The &%headers_remove%& option is expanded after &%errors_to%& and
16115 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
16116 the option has no effect. Other expansion failures are treated as configuration
16117 errors.
16118
16119 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
16120 router that has the &%one_time%& option set.
16121
16122 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16123 removal requests are deleted when the address is passed on to subsequent
16124 routers, and this can lead to problems with duplicates -- see the similar
16125 warning for &%headers_add%& above.
16126
16127
16128 .option ignore_target_hosts routers "host list&!!" unset
16129 .cindex "IP address" "discarding"
16130 .cindex "router" "discarding IP addresses"
16131 Although this option is a host list, it should normally contain IP address
16132 entries rather than names. If any host that is looked up by the router has an
16133 IP address that matches an item in this list, Exim behaves as if that IP
16134 address did not exist. This option allows you to cope with rogue DNS entries
16135 like
16136 .code
16137 remote.domain.example.  A  127.0.0.1
16138 .endd
16139 by setting
16140 .code
16141 ignore_target_hosts = 127.0.0.1
16142 .endd
16143 on the relevant router. If all the hosts found by a &(dnslookup)& router are
16144 discarded in this way, the router declines. In a conventional configuration, an
16145 attempt to mail to such a domain would normally provoke the &"unrouteable
16146 domain"& error, and an attempt to verify an address in the domain would fail.
16147 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
16148 router declines if presented with one of the listed addresses.
16149
16150 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
16151 means of the first or the second of the following settings, respectively:
16152 .code
16153 ignore_target_hosts = 0.0.0.0/0
16154 ignore_target_hosts = <; 0::0/0
16155 .endd
16156 The pattern in the first line matches all IPv4 addresses, whereas the pattern
16157 in the second line matches all IPv6 addresses.
16158
16159 This option may also be useful for ignoring link-local and site-local IPv6
16160 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
16161 is expanded before use as a list, it is possible to make it dependent on the
16162 domain that is being routed.
16163
16164 .vindex "&$host_address$&"
16165 During its expansion, &$host_address$& is set to the IP address that is being
16166 checked.
16167
16168 .option initgroups routers boolean false
16169 .cindex "additional groups"
16170 .cindex "groups" "additional"
16171 .cindex "local transports" "uid and gid"
16172 .cindex "transport" "local"
16173 If the router queues an address for a transport, and this option is true, and
16174 the uid supplied by the router is not overridden by the transport, the
16175 &[initgroups()]& function is called when running the transport to ensure that
16176 any additional groups associated with the uid are set up. See also &%group%&
16177 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16178
16179
16180
16181 .option local_part_prefix routers&!? "string list" unset
16182 .cindex "router" "prefix for local part"
16183 .cindex "prefix" "for local part, used in router"
16184 If this option is set, the router is skipped unless the local part starts with
16185 one of the given strings, or &%local_part_prefix_optional%& is true. See
16186 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16187 evaluated.
16188
16189 The list is scanned from left to right, and the first prefix that matches is
16190 used. A limited form of wildcard is available; if the prefix begins with an
16191 asterisk, it matches the longest possible sequence of arbitrary characters at
16192 the start of the local part. An asterisk should therefore always be followed by
16193 some character that does not occur in normal local parts.
16194 .cindex "multiple mailboxes"
16195 .cindex "mailbox" "multiple"
16196 Wildcarding can be used to set up multiple user mailboxes, as described in
16197 section &<<SECTmulbox>>&.
16198
16199 .vindex "&$local_part$&"
16200 .vindex "&$local_part_prefix$&"
16201 During the testing of the &%local_parts%& option, and while the router is
16202 running, the prefix is removed from the local part, and is available in the
16203 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16204 the router accepts the address, this remains true during subsequent delivery by
16205 a transport. In particular, the local part that is transmitted in the RCPT
16206 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16207 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16208 the relevant transport.
16209
16210 When an address is being verified, &%local_part_prefix%& affects only the
16211 behaviour of the router. If the callout feature of verification is in use, this
16212 means that the full address, including the prefix, will be used during the
16213 callout.
16214
16215 The prefix facility is commonly used to handle local parts of the form
16216 &%owner-something%&. Another common use is to support local parts of the form
16217 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16218 to tell a user their forwarding is broken &-- by placing a router like this one
16219 immediately before the router that handles &_.forward_& files:
16220 .code
16221 real_localuser:
16222   driver = accept
16223   local_part_prefix = real-
16224   check_local_user
16225   transport = local_delivery
16226 .endd
16227 For security, it would probably be a good idea to restrict the use of this
16228 router to locally-generated messages, using a condition such as this:
16229 .code
16230   condition = ${if match {$sender_host_address}\
16231                          {\N^(|127\.0\.0\.1)$\N}}
16232 .endd
16233
16234 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16235 both conditions must be met if not optional. Care must be taken if wildcards
16236 are used in both a prefix and a suffix on the same router. Different
16237 separator characters must be used to avoid ambiguity.
16238
16239
16240 .option local_part_prefix_optional routers boolean false
16241 See &%local_part_prefix%& above.
16242
16243
16244
16245 .option local_part_suffix routers&!? "string list" unset
16246 .cindex "router" "suffix for local part"
16247 .cindex "suffix for local part" "used in router"
16248 This option operates in the same way as &%local_part_prefix%&, except that the
16249 local part must end (rather than start) with the given string, the
16250 &%local_part_suffix_optional%& option determines whether the suffix is
16251 mandatory, and the wildcard * character, if present, must be the last
16252 character of the suffix. This option facility is commonly used to handle local
16253 parts of the form &%something-request%& and multiple user mailboxes of the form
16254 &%username-foo%&.
16255
16256
16257 .option local_part_suffix_optional routers boolean false
16258 See &%local_part_suffix%& above.
16259
16260
16261
16262 .option local_parts routers&!? "local part list&!!" unset
16263 .cindex "router" "restricting to specific local parts"
16264 .cindex "local part" "checking in router"
16265 The router is run only if the local part of the address matches the list.
16266 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16267 are evaluated, and
16268 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16269 string is expanded, it is possible to make it depend on the domain, for
16270 example:
16271 .code
16272 local_parts = dbm;/usr/local/specials/$domain
16273 .endd
16274 .vindex "&$local_part_data$&"
16275 If the match is achieved by a lookup, the data that the lookup returned
16276 for the local part is placed in the variable &$local_part_data$& for use in
16277 expansions of the router's private options. You might use this option, for
16278 example, if you have a large number of local virtual domains, and you want to
16279 send all postmaster mail to the same place without having to set up an alias in
16280 each virtual domain:
16281 .code
16282 postmaster:
16283   driver = redirect
16284   local_parts = postmaster
16285   data = postmaster@real.domain.example
16286 .endd
16287
16288
16289 .option log_as_local routers boolean "see below"
16290 .cindex "log" "delivery line"
16291 .cindex "delivery" "log line format"
16292 Exim has two logging styles for delivery, the idea being to make local
16293 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16294 recipient address is given just as the local part, without a domain. The use of
16295 this style is controlled by this option. It defaults to true for the &(accept)&
16296 router, and false for all the others. This option applies only when a
16297 router assigns an address to a transport. It has no effect on routers that
16298 redirect addresses.
16299
16300
16301
16302 .option more routers boolean&!! true
16303 The result of string expansion for this option must be a valid boolean value,
16304 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16305 result causes an error, and delivery is deferred. If the expansion is forced to
16306 fail, the default value for the option (true) is used. Other failures cause
16307 delivery to be deferred.
16308
16309 If this option is set false, and the router declines to handle the address, no
16310 further routers are tried, routing fails, and the address is bounced.
16311 .oindex "&%self%&"
16312 However, if the router explicitly passes an address to the following router by
16313 means of the setting
16314 .code
16315 self = pass
16316 .endd
16317 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16318 does not affect the behaviour if one of the precondition tests fails. In that
16319 case, the address is always passed to the next router.
16320
16321 Note that &%address_data%& is not considered to be a precondition. If its
16322 expansion is forced to fail, the router declines, and the value of &%more%&
16323 controls what happens next.
16324
16325
16326 .option pass_on_timeout routers boolean false
16327 .cindex "timeout" "of router"
16328 .cindex "router" "timeout"
16329 If a router times out during a host lookup, it normally causes deferral of the
16330 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16331 router, overriding &%no_more%&. This may be helpful for systems that are
16332 intermittently connected to the Internet, or those that want to pass to a smart
16333 host any messages that cannot immediately be delivered.
16334
16335 There are occasional other temporary errors that can occur while doing DNS
16336 lookups. They are treated in the same way as a timeout, and this option
16337 applies to all of them.
16338
16339
16340
16341 .option pass_router routers string unset
16342 .cindex "router" "go to after &""pass""&"
16343 Routers that recognize the generic &%self%& option (&(dnslookup)&,
16344 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
16345 routing to continue, and overriding a false setting of &%more%&. When one of
16346 these routers returns &"pass"&, the address is normally handed on to the next
16347 router in sequence. This can be changed by setting &%pass_router%& to the name
16348 of another router. However (unlike &%redirect_router%&) the named router must
16349 be below the current router, to avoid loops. Note that this option applies only
16350 to the special case of &"pass"&. It does not apply when a router returns
16351 &"decline"& because it cannot handle an address.
16352
16353
16354
16355 .option redirect_router routers string unset
16356 .cindex "router" "start at after redirection"
16357 Sometimes an administrator knows that it is pointless to reprocess addresses
16358 generated from alias or forward files with the same router again. For
16359 example, if an alias file translates real names into login ids there is no
16360 point searching the alias file a second time, especially if it is a large file.
16361
16362 The &%redirect_router%& option can be set to the name of any router instance.
16363 It causes the routing of any generated addresses to start at the named router
16364 instead of at the first router. This option has no effect if the router in
16365 which it is set does not generate new addresses.
16366
16367
16368
16369 .option require_files routers&!? "string list&!!" unset
16370 .cindex "file" "requiring for router"
16371 .cindex "router" "requiring file existence"
16372 This option provides a general mechanism for predicating the running of a
16373 router on the existence or non-existence of certain files or directories.
16374 Before running a router, as one of its precondition tests, Exim works its way
16375 through the &%require_files%& list, expanding each item separately.
16376
16377 Because the list is split before expansion, any colons in expansion items must
16378 be doubled, or the facility for using a different list separator must be used.
16379 If any expansion is forced to fail, the item is ignored. Other expansion
16380 failures cause routing of the address to be deferred.
16381
16382 If any expanded string is empty, it is ignored. Otherwise, except as described
16383 below, each string must be a fully qualified file path, optionally preceded by
16384 &"!"&. The paths are passed to the &[stat()]& function to test for the
16385 existence of the files or directories. The router is skipped if any paths not
16386 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
16387
16388 .cindex "NFS"
16389 If &[stat()]& cannot determine whether a file exists or not, delivery of
16390 the message is deferred. This can happen when NFS-mounted filesystems are
16391 unavailable.
16392
16393 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
16394 options, so you cannot use it to check for the existence of a file in which to
16395 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
16396 full list of the order in which preconditions are evaluated.) However, as
16397 these options are all expanded, you can use the &%exists%& expansion condition
16398 to make such tests. The &%require_files%& option is intended for checking files
16399 that the router may be going to use internally, or which are needed by a
16400 transport (for example &_.procmailrc_&).
16401
16402 During delivery, the &[stat()]& function is run as root, but there is a
16403 facility for some checking of the accessibility of a file by another user.
16404 This is not a proper permissions check, but just a &"rough"& check that
16405 operates as follows:
16406
16407 If an item in a &%require_files%& list does not contain any forward slash
16408 characters, it is taken to be the user (and optional group, separated by a
16409 comma) to be checked for subsequent files in the list. If no group is specified
16410 but the user is specified symbolically, the gid associated with the uid is
16411 used. For example:
16412 .code
16413 require_files = mail:/some/file
16414 require_files = $local_part:$home/.procmailrc
16415 .endd
16416 If a user or group name in a &%require_files%& list does not exist, the
16417 &%require_files%& condition fails.
16418
16419 Exim performs the check by scanning along the components of the file path, and
16420 checking the access for the given uid and gid. It checks for &"x"& access on
16421 directories, and &"r"& access on the final file. Note that this means that file
16422 access control lists, if the operating system has them, are ignored.
16423
16424 &*Warning 1*&: When the router is being run to verify addresses for an
16425 incoming SMTP message, Exim is not running as root, but under its own uid. This
16426 may affect the result of a &%require_files%& check. In particular, &[stat()]&
16427 may yield the error EACCES (&"Permission denied"&). This means that the Exim
16428 user is not permitted to read one of the directories on the file's path.
16429
16430 &*Warning 2*&: Even when Exim is running as root while delivering a message,
16431 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
16432 without root access. In this case, if a check for access by a particular user
16433 is requested, Exim creates a subprocess that runs as that user, and tries the
16434 check again in that process.
16435
16436 The default action for handling an unresolved EACCES is to consider it to
16437 be caused by a configuration error, and routing is deferred because the
16438 existence or non-existence of the file cannot be determined. However, in some
16439 circumstances it may be desirable to treat this condition as if the file did
16440 not exist. If the file name (or the exclamation mark that precedes the file
16441 name for non-existence) is preceded by a plus sign, the EACCES error is treated
16442 as if the file did not exist. For example:
16443 .code
16444 require_files = +/some/file
16445 .endd
16446 If the router is not an essential part of verification (for example, it
16447 handles users' &_.forward_& files), another solution is to set the &%verify%&
16448 option false so that the router is skipped when verifying.
16449
16450
16451
16452 .option retry_use_local_part routers boolean "see below"
16453 .cindex "hints database" "retry keys"
16454 .cindex "local part" "in retry keys"
16455 When a delivery suffers a temporary routing failure, a retry record is created
16456 in Exim's hints database. For addresses whose routing depends only on the
16457 domain, the key for the retry record should not involve the local part, but for
16458 other addresses, both the domain and the local part should be included.
16459 Usually, remote routing is of the former kind, and local routing is of the
16460 latter kind.
16461
16462 This option controls whether the local part is used to form the key for retry
16463 hints for addresses that suffer temporary errors while being handled by this
16464 router. The default value is true for any router that has &%check_local_user%&
16465 set, and false otherwise. Note that this option does not apply to hints keys
16466 for transport delays; they are controlled by a generic transport option of the
16467 same name.
16468
16469 The setting of &%retry_use_local_part%& applies only to the router on which it
16470 appears. If the router generates child addresses, they are routed
16471 independently; this setting does not become attached to them.
16472
16473
16474
16475 .option router_home_directory routers string&!! unset
16476 .cindex "router" "home directory for"
16477 .cindex "home directory" "for router"
16478 .vindex "&$home$&"
16479 This option sets a home directory for use while the router is running. (Compare
16480 &%transport_home_directory%&, which sets a home directory for later
16481 transporting.) In particular, if used on a &(redirect)& router, this option
16482 sets a value for &$home$& while a filter is running. The value is expanded;
16483 forced expansion failure causes the option to be ignored &-- other failures
16484 cause the router to defer.
16485
16486 Expansion of &%router_home_directory%& happens immediately after the
16487 &%check_local_user%& test (if configured), before any further expansions take
16488 place.
16489 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16490 are evaluated.)
16491 While the router is running, &%router_home_directory%& overrides the value of
16492 &$home$& that came from &%check_local_user%&.
16493
16494 When a router accepts an address and assigns it to a local transport (including
16495 the cases when a &(redirect)& router generates a pipe, file, or autoreply
16496 delivery), the home directory setting for the transport is taken from the first
16497 of these values that is set:
16498
16499 .ilist
16500 The &%home_directory%& option on the transport;
16501 .next
16502 The &%transport_home_directory%& option on the router;
16503 .next
16504 The password data if &%check_local_user%& is set on the router;
16505 .next
16506 The &%router_home_directory%& option on the router.
16507 .endlist
16508
16509 In other words, &%router_home_directory%& overrides the password data for the
16510 router, but not for the transport.
16511
16512
16513
16514 .option self routers string freeze
16515 .cindex "MX record" "pointing to local host"
16516 .cindex "local host" "MX pointing to"
16517 This option applies to those routers that use a recipient address to find a
16518 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
16519 and &(manualroute)& routers.
16520 Certain configurations of the &(queryprogram)& router can also specify a list
16521 of remote hosts.
16522 Usually such routers are configured to send the message to a remote host via an
16523 &(smtp)& transport. The &%self%& option specifies what happens when the first
16524 host on the list turns out to be the local host.
16525 The way in which Exim checks for the local host is described in section
16526 &<<SECTreclocipadd>>&.
16527
16528 Normally this situation indicates either an error in Exim's configuration (for
16529 example, the router should be configured not to process this domain), or an
16530 error in the DNS (for example, the MX should not point to this host). For this
16531 reason, the default action is to log the incident, defer the address, and
16532 freeze the message. The following alternatives are provided for use in special
16533 cases:
16534
16535 .vlist
16536 .vitem &%defer%&
16537 Delivery of the message is tried again later, but the message is not frozen.
16538
16539 .vitem "&%reroute%&: <&'domain'&>"
16540 The domain is changed to the given domain, and the address is passed back to
16541 be reprocessed by the routers. No rewriting of headers takes place. This
16542 behaviour is essentially a redirection.
16543
16544 .vitem "&%reroute: rewrite:%& <&'domain'&>"
16545 The domain is changed to the given domain, and the address is passed back to be
16546 reprocessed by the routers. Any headers that contain the original domain are
16547 rewritten.
16548
16549 .vitem &%pass%&
16550 .oindex "&%more%&"
16551 .vindex "&$self_hostname$&"
16552 The router passes the address to the next router, or to the router named in the
16553 &%pass_router%& option if it is set. This overrides &%no_more%&. During
16554 subsequent routing and delivery, the variable &$self_hostname$& contains the
16555 name of the local host that the router encountered. This can be used to
16556 distinguish between different cases for hosts with multiple names. The
16557 combination
16558 .code
16559 self = pass
16560 no_more
16561 .endd
16562 ensures that only those addresses that routed to the local host are passed on.
16563 Without &%no_more%&, addresses that were declined for other reasons would also
16564 be passed to the next router.
16565
16566 .vitem &%fail%&
16567 Delivery fails and an error report is generated.
16568
16569 .vitem &%send%&
16570 .cindex "local host" "sending to"
16571 The anomaly is ignored and the address is queued for the transport. This
16572 setting should be used with extreme caution. For an &(smtp)& transport, it
16573 makes sense only in cases where the program that is listening on the SMTP port
16574 is not this version of Exim. That is, it must be some other MTA, or Exim with a
16575 different configuration file that handles the domain in another way.
16576 .endlist
16577
16578
16579
16580 .option senders routers&!? "address list&!!" unset
16581 .cindex "router" "checking senders"
16582 If this option is set, the router is skipped unless the message's sender
16583 address matches something on the list.
16584 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16585 are evaluated.
16586
16587 There are issues concerning verification when the running of routers is
16588 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
16589 setting, it sets the sender to the null string. When using the &%-bt%& option
16590 to check a configuration file, it is necessary also to use the &%-f%& option to
16591 set an appropriate sender. For incoming mail, the sender is unset when
16592 verifying the sender, but is available when verifying any recipients. If the
16593 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
16594 matters.
16595
16596
16597 .option translate_ip_address routers string&!! unset
16598 .cindex "IP address" "translating"
16599 .cindex "packet radio"
16600 .cindex "router" "IP address translation"
16601 There exist some rare networking situations (for example, packet radio) where
16602 it is helpful to be able to translate IP addresses generated by normal routing
16603 mechanisms into other IP addresses, thus performing a kind of manual IP
16604 routing. This should be done only if the normal IP routing of the TCP/IP stack
16605 is inadequate or broken. Because this is an extremely uncommon requirement, the
16606 code to support this option is not included in the Exim binary unless
16607 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
16608
16609 .vindex "&$host_address$&"
16610 The &%translate_ip_address%& string is expanded for every IP address generated
16611 by the router, with the generated address set in &$host_address$&. If the
16612 expansion is forced to fail, no action is taken.
16613 For any other expansion error, delivery of the message is deferred.
16614 If the result of the expansion is an IP address, that replaces the original
16615 address; otherwise the result is assumed to be a host name &-- this is looked
16616 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
16617 produce one or more replacement IP addresses. For example, to subvert all IP
16618 addresses in some specific networks, this could be added to a router:
16619 .code
16620 translate_ip_address = \
16621   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
16622     {$value}fail}}
16623 .endd
16624 The file would contain lines like
16625 .code
16626 10.2.3.128/26    some.host
16627 10.8.4.34/26     10.44.8.15
16628 .endd
16629 You should not make use of this facility unless you really understand what you
16630 are doing.
16631
16632
16633
16634 .option transport routers string&!! unset
16635 This option specifies the transport to be used when a router accepts an address
16636 and sets it up for delivery. A transport is never needed if a router is used
16637 only for verification. The value of the option is expanded at routing time,
16638 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
16639 and result must be the name of one of the configured transports. If it is not,
16640 delivery is deferred.
16641
16642 The &%transport%& option is not used by the &(redirect)& router, but it does
16643 have some private options that set up transports for pipe and file deliveries
16644 (see chapter &<<CHAPredirect>>&).
16645
16646
16647
16648 .option transport_current_directory routers string&!! unset
16649 .cindex "current directory for local transport"
16650 This option associates a current directory with any address that is routed
16651 to a local transport. This can happen either because a transport is
16652 explicitly configured for the router, or because it generates a delivery to a
16653 file or a pipe. During the delivery process (that is, at transport time), this
16654 option string is expanded and is set as the current directory, unless
16655 overridden by a setting on the transport.
16656 If the expansion fails for any reason, including forced failure, an error is
16657 logged, and delivery is deferred.
16658 See chapter &<<CHAPenvironment>>& for details of the local delivery
16659 environment.
16660
16661
16662
16663
16664 .option transport_home_directory routers string&!! "see below"
16665 .cindex "home directory" "for local transport"
16666 This option associates a home directory with any address that is routed to a
16667 local transport. This can happen either because a transport is explicitly
16668 configured for the router, or because it generates a delivery to a file or a
16669 pipe. During the delivery process (that is, at transport time), the option
16670 string is expanded and is set as the home directory, unless overridden by a
16671 setting of &%home_directory%& on the transport.
16672 If the expansion fails for any reason, including forced failure, an error is
16673 logged, and delivery is deferred.
16674
16675 If the transport does not specify a home directory, and
16676 &%transport_home_directory%& is not set for the router, the home directory for
16677 the transport is taken from the password data if &%check_local_user%& is set for
16678 the router. Otherwise it is taken from &%router_home_directory%& if that option
16679 is set; if not, no home directory is set for the transport.
16680
16681 See chapter &<<CHAPenvironment>>& for further details of the local delivery
16682 environment.
16683
16684
16685
16686
16687 .option unseen routers boolean&!! false
16688 .cindex "router" "carrying on after success"
16689 The result of string expansion for this option must be a valid boolean value,
16690 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16691 result causes an error, and delivery is deferred. If the expansion is forced to
16692 fail, the default value for the option (false) is used. Other failures cause
16693 delivery to be deferred.
16694
16695 When this option is set true, routing does not cease if the router accepts the
16696 address. Instead, a copy of the incoming address is passed to the next router,
16697 overriding a false setting of &%more%&. There is little point in setting
16698 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
16699 the value of &%unseen%& contains expansion items (and therefore, presumably, is
16700 sometimes true and sometimes false).
16701
16702 .cindex "copy of message (&%unseen%& option)"
16703 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
16704 qualifier in filter files. It can be used to cause copies of messages to be
16705 delivered to some other destination, while also carrying out a normal delivery.
16706 In effect, the current address is made into a &"parent"& that has two children
16707 &-- one that is delivered as specified by this router, and a clone that goes on
16708 to be routed further. For this reason, &%unseen%& may not be combined with the
16709 &%one_time%& option in a &(redirect)& router.
16710
16711 &*Warning*&: Header lines added to the address (or specified for removal) by
16712 this router or by previous routers affect the &"unseen"& copy of the message
16713 only. The clone that continues to be processed by further routers starts with
16714 no added headers and none specified for removal. For a &%redirect%& router, if
16715 a generated address is the same as the incoming address, this can lead to
16716 duplicate addresses with different header modifications. Exim does not do
16717 duplicate deliveries (except, in certain circumstances, to pipes -- see section
16718 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
16719 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
16720 &%redirect%& router may be of help.
16721
16722 Unlike the handling of header modifications, any data that was set by the
16723 &%address_data%& option in the current or previous routers &'is'& passed on to
16724 subsequent routers.
16725
16726
16727 .option user routers string&!! "see below"
16728 .cindex "uid (user id)" "local delivery"
16729 .cindex "local transports" "uid and gid"
16730 .cindex "transport" "local"
16731 .cindex "router" "user for filter processing"
16732 .cindex "filter" "user for processing"
16733 When a router queues an address for a transport, and the transport does not
16734 specify a user, the user given here is used when running the delivery process.
16735 The user may be specified numerically or by name. If expansion fails, the
16736 error is logged and delivery is deferred.
16737 This user is also used by the &(redirect)& router when running a filter file.
16738 The default is unset, except when &%check_local_user%& is set. In this case,
16739 the default is taken from the password information. If the user is specified as
16740 a name, and &%group%& is not set, the group associated with the user is used.
16741 See also &%initgroups%& and &%group%& and the discussion in chapter
16742 &<<CHAPenvironment>>&.
16743
16744
16745
16746 .option verify routers&!? boolean true
16747 Setting this option has the effect of setting &%verify_sender%& and
16748 &%verify_recipient%& to the same value.
16749
16750
16751 .option verify_only routers&!? boolean false
16752 .cindex "EXPN" "with &%verify_only%&"
16753 .oindex "&%-bv%&"
16754 .cindex "router" "used only when verifying"
16755 If this option is set, the router is used only when verifying an address or
16756 testing with the &%-bv%& option, not when actually doing a delivery, testing
16757 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
16758 restricted to verifying only senders or recipients by means of
16759 &%verify_sender%& and &%verify_recipient%&.
16760
16761 &*Warning*&: When the router is being run to verify addresses for an incoming
16762 SMTP message, Exim is not running as root, but under its own uid. If the router
16763 accesses any files, you need to make sure that they are accessible to the Exim
16764 user or group.
16765
16766
16767 .option verify_recipient routers&!? boolean true
16768 If this option is false, the router is skipped when verifying recipient
16769 addresses
16770 or testing recipient verification using &%-bv%&.
16771 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16772 are evaluated.
16773
16774
16775 .option verify_sender routers&!? boolean true
16776 If this option is false, the router is skipped when verifying sender addresses
16777 or testing sender verification using &%-bvs%&.
16778 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16779 are evaluated.
16780 .ecindex IIDgenoprou1
16781 .ecindex IIDgenoprou2
16782
16783
16784
16785
16786
16787
16788 . ////////////////////////////////////////////////////////////////////////////
16789 . ////////////////////////////////////////////////////////////////////////////
16790
16791 .chapter "The accept router" "CHID4"
16792 .cindex "&(accept)& router"
16793 .cindex "routers" "&(accept)&"
16794 The &(accept)& router has no private options of its own. Unless it is being
16795 used purely for verification (see &%verify_only%&) a transport is required to
16796 be defined by the generic &%transport%& option. If the preconditions that are
16797 specified by generic options are met, the router accepts the address and queues
16798 it for the given transport. The most common use of this router is for setting
16799 up deliveries to local mailboxes. For example:
16800 .code
16801 localusers:
16802   driver = accept
16803   domains = mydomain.example
16804   check_local_user
16805   transport = local_delivery
16806 .endd
16807 The &%domains%& condition in this example checks the domain of the address, and
16808 &%check_local_user%& checks that the local part is the login of a local user.
16809 When both preconditions are met, the &(accept)& router runs, and queues the
16810 address for the &(local_delivery)& transport.
16811
16812
16813
16814
16815
16816
16817 . ////////////////////////////////////////////////////////////////////////////
16818 . ////////////////////////////////////////////////////////////////////////////
16819
16820 .chapter "The dnslookup router" "CHAPdnslookup"
16821 .scindex IIDdnsrou1 "&(dnslookup)& router"
16822 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
16823 The &(dnslookup)& router looks up the hosts that handle mail for the
16824 recipient's domain in the DNS. A transport must always be set for this router,
16825 unless &%verify_only%& is set.
16826
16827 If SRV support is configured (see &%check_srv%& below), Exim first searches for
16828 SRV records. If none are found, or if SRV support is not configured,
16829 MX records are looked up. If no MX records exist, address records are sought.
16830 However, &%mx_domains%& can be set to disable the direct use of address
16831 records.
16832
16833 MX records of equal priority are sorted by Exim into a random order. Exim then
16834 looks for address records for the host names obtained from MX or SRV records.
16835 When a host has more than one IP address, they are sorted into a random order,
16836 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
16837 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
16838 generic option, the router declines.
16839
16840 Unless they have the highest priority (lowest MX value), MX records that point
16841 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
16842 are discarded, together with any other MX records of equal or lower priority.
16843
16844 .cindex "MX record" "pointing to local host"
16845 .cindex "local host" "MX pointing to"
16846 .oindex "&%self%&" "in &(dnslookup)& router"
16847 If the host pointed to by the highest priority MX record, or looked up as an
16848 address record, is the local host, or matches &%hosts_treat_as_local%&, what
16849 happens is controlled by the generic &%self%& option.
16850
16851
16852 .section "Problems with DNS lookups" "SECTprowitdnsloo"
16853 There have been problems with DNS servers when SRV records are looked up.
16854 Some mis-behaving servers return a DNS error or timeout when a non-existent
16855 SRV record is sought. Similar problems have in the past been reported for
16856 MX records. The global &%dns_again_means_nonexist%& option can help with this
16857 problem, but it is heavy-handed because it is a global option.
16858
16859 For this reason, there are two options, &%srv_fail_domains%& and
16860 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
16861 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
16862 an attempt to look up an SRV or MX record causes one of these results, and the
16863 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
16864 such record"&. In the case of an SRV lookup, this means that the router
16865 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
16866 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
16867 case routing fails.
16868
16869
16870
16871
16872 .section "Private options for dnslookup" "SECID118"
16873 .cindex "options" "&(dnslookup)& router"
16874 The private options for the &(dnslookup)& router are as follows:
16875
16876 .option check_secondary_mx dnslookup boolean false
16877 .cindex "MX record" "checking for secondary"
16878 If this option is set, the router declines unless the local host is found in
16879 (and removed from) the list of hosts obtained by MX lookup. This can be used to
16880 process domains for which the local host is a secondary mail exchanger
16881 differently to other domains. The way in which Exim decides whether a host is
16882 the local host is described in section &<<SECTreclocipadd>>&.
16883
16884
16885 .option check_srv dnslookup string&!! unset
16886 .cindex "SRV record" "enabling use of"
16887 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
16888 addition to MX and address records. The support is disabled by default. To
16889 enable SRV support, set the &%check_srv%& option to the name of the service
16890 required. For example,
16891 .code
16892 check_srv = smtp
16893 .endd
16894 looks for SRV records that refer to the normal smtp service. The option is
16895 expanded, so the service name can vary from message to message or address
16896 to address. This might be helpful if SRV records are being used for a
16897 submission service. If the expansion is forced to fail, the &%check_srv%&
16898 option is ignored, and the router proceeds to look for MX records in the
16899 normal way.
16900
16901 When the expansion succeeds, the router searches first for SRV records for
16902 the given service (it assumes TCP protocol). A single SRV record with a
16903 host name that consists of just a single dot indicates &"no such service for
16904 this domain"&; if this is encountered, the router declines. If other kinds of
16905 SRV record are found, they are used to construct a host list for delivery
16906 according to the rules of RFC 2782. MX records are not sought in this case.
16907
16908 When no SRV records are found, MX records (and address records) are sought in
16909 the traditional way. In other words, SRV records take precedence over MX
16910 records, just as MX records take precedence over address records. Note that
16911 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
16912 defined it. It is apparently believed that MX records are sufficient for email
16913 and that SRV records should not be used for this purpose. However, SRV records
16914 have an additional &"weight"& feature which some people might find useful when
16915 trying to split an SMTP load between hosts of different power.
16916
16917 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
16918 when there is a DNS lookup error.
16919
16920
16921
16922 .option mx_domains dnslookup "domain list&!!" unset
16923 .cindex "MX record" "required to exist"
16924 .cindex "SRV record" "required to exist"
16925 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
16926 record in order to be recognized. (The name of this option could be improved.)
16927 For example, if all the mail hosts in &'fict.example'& are known to have MX
16928 records, except for those in &'discworld.fict.example'&, you could use this
16929 setting:
16930 .code
16931 mx_domains = ! *.discworld.fict.example : *.fict.example
16932 .endd
16933 This specifies that messages addressed to a domain that matches the list but
16934 has no MX record should be bounced immediately instead of being routed using
16935 the address record.
16936
16937
16938 .option mx_fail_domains dnslookup "domain list&!!" unset
16939 If the DNS lookup for MX records for one of the domains in this list causes a
16940 DNS lookup error, Exim behaves as if no MX records were found. See section
16941 &<<SECTprowitdnsloo>>& for more discussion.
16942
16943
16944
16945
16946 .option qualify_single dnslookup boolean true
16947 .cindex "DNS" "resolver options"
16948 .cindex "DNS" "qualifying single-component names"
16949 When this option is true, the resolver option RES_DEFNAMES is set for DNS
16950 lookups. Typically, but not standardly, this causes the resolver to qualify
16951 single-component names with the default domain. For example, on a machine
16952 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
16953 &'thesaurus.ref.example'& inside the resolver. For details of what your
16954 resolver actually does, consult your man pages for &'resolver'& and
16955 &'resolv.conf'&.
16956
16957
16958
16959 .option rewrite_headers dnslookup boolean true
16960 .cindex "rewriting" "header lines"
16961 .cindex "header lines" "rewriting"
16962 If the domain name in the address that is being processed is not fully
16963 qualified, it may be expanded to its full form by a DNS lookup. For example, if
16964 an address is specified as &'dormouse@teaparty'&, the domain might be
16965 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
16966 occur as a result of setting the &%widen_domains%& option. If
16967 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
16968 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
16969 header lines of the message are rewritten with the full domain name.
16970
16971 This option should be turned off only when it is known that no message is
16972 ever going to be sent outside an environment where the abbreviation makes
16973 sense.
16974
16975 When an MX record is looked up in the DNS and matches a wildcard record, name
16976 servers normally return a record containing the name that has been looked up,
16977 making it impossible to detect whether a wildcard was present or not. However,
16978 some name servers have recently been seen to return the wildcard entry. If the
16979 name returned by a DNS lookup begins with an asterisk, it is not used for
16980 header rewriting.
16981
16982
16983 .option same_domain_copy_routing dnslookup boolean false
16984 .cindex "address" "copying routing"
16985 Addresses with the same domain are normally routed by the &(dnslookup)& router
16986 to the same list of hosts. However, this cannot be presumed, because the router
16987 options and preconditions may refer to the local part of the address. By
16988 default, therefore, Exim routes each address in a message independently. DNS
16989 servers run caches, so repeated DNS lookups are not normally expensive, and in
16990 any case, personal messages rarely have more than a few recipients.
16991
16992 If you are running mailing lists with large numbers of subscribers at the same
16993 domain, and you are using a &(dnslookup)& router which is independent of the
16994 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
16995 lookups for identical domains in one message. In this case, when &(dnslookup)&
16996 routes an address to a remote transport, any other unrouted addresses in the
16997 message that have the same domain are automatically given the same routing
16998 without processing them independently,
16999 provided the following conditions are met:
17000
17001 .ilist
17002 No router that processed the address specified &%headers_add%& or
17003 &%headers_remove%&.
17004 .next
17005 The router did not change the address in any way, for example, by &"widening"&
17006 the domain.
17007 .endlist
17008
17009
17010
17011
17012 .option search_parents dnslookup boolean false
17013 .cindex "DNS" "resolver options"
17014 When this option is true, the resolver option RES_DNSRCH is set for DNS
17015 lookups. This is different from the &%qualify_single%& option in that it
17016 applies to domains containing dots. Typically, but not standardly, it causes
17017 the resolver to search for the name in the current domain and in parent
17018 domains. For example, on a machine in the &'fict.example'& domain, if looking
17019 up &'teaparty.wonderland'& failed, the resolver would try
17020 &'teaparty.wonderland.fict.example'&. For details of what your resolver
17021 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
17022
17023 Setting this option true can cause problems in domains that have a wildcard MX
17024 record, because any domain that does not have its own MX record matches the
17025 local wildcard.
17026
17027
17028
17029 .option srv_fail_domains dnslookup "domain list&!!" unset
17030 If the DNS lookup for SRV records for one of the domains in this list causes a
17031 DNS lookup error, Exim behaves as if no SRV records were found. See section
17032 &<<SECTprowitdnsloo>>& for more discussion.
17033
17034
17035
17036
17037 .option widen_domains dnslookup "string list" unset
17038 .cindex "domain" "partial; widening"
17039 If a DNS lookup fails and this option is set, each of its strings in turn is
17040 added onto the end of the domain, and the lookup is tried again. For example,
17041 if
17042 .code
17043 widen_domains = fict.example:ref.example
17044 .endd
17045 is set and a lookup of &'klingon.dictionary'& fails,
17046 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
17047 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
17048 and &%search_parents%& options can cause some widening to be undertaken inside
17049 the DNS resolver. &%widen_domains%& is not applied to sender addresses
17050 when verifying, unless &%rewrite_headers%& is false (not the default).
17051
17052
17053 .section "Effect of qualify_single and search_parents" "SECID119"
17054 When a domain from an envelope recipient is changed by the resolver as a result
17055 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
17056 corresponding address in the message's header lines unless &%rewrite_headers%&
17057 is set false. Exim then re-routes the address, using the full domain.
17058
17059 These two options affect only the DNS lookup that takes place inside the router
17060 for the domain of the address that is being routed. They do not affect lookups
17061 such as that implied by
17062 .code
17063 domains = @mx_any
17064 .endd
17065 that may happen while processing a router precondition before the router is
17066 entered. No widening ever takes place for these lookups.
17067 .ecindex IIDdnsrou1
17068 .ecindex IIDdnsrou2
17069
17070
17071
17072
17073
17074
17075
17076
17077
17078 . ////////////////////////////////////////////////////////////////////////////
17079 . ////////////////////////////////////////////////////////////////////////////
17080
17081 .chapter "The ipliteral router" "CHID5"
17082 .cindex "&(ipliteral)& router"
17083 .cindex "domain literal" "routing"
17084 .cindex "routers" "&(ipliteral)&"
17085 This router has no private options. Unless it is being used purely for
17086 verification (see &%verify_only%&) a transport is required to be defined by the
17087 generic &%transport%& option. The router accepts the address if its domain part
17088 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
17089 router handles the address
17090 .code
17091 root@[192.168.1.1]
17092 .endd
17093 by setting up delivery to the host with that IP address. IPv4 domain literals
17094 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
17095 are similar, but the address is preceded by &`ipv6:`&. For example:
17096 .code
17097 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
17098 .endd
17099 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
17100 grounds that sooner or later somebody will try it.
17101
17102 .oindex "&%self%&" "in &(ipliteral)& router"
17103 If the IP address matches something in &%ignore_target_hosts%&, the router
17104 declines. If an IP literal turns out to refer to the local host, the generic
17105 &%self%& option determines what happens.
17106
17107 The RFCs require support for domain literals; however, their use is
17108 controversial in today's Internet. If you want to use this router, you must
17109 also set the main configuration option &%allow_domain_literals%&. Otherwise,
17110 Exim will not recognize the domain literal syntax in addresses.
17111
17112
17113
17114 . ////////////////////////////////////////////////////////////////////////////
17115 . ////////////////////////////////////////////////////////////////////////////
17116
17117 .chapter "The iplookup router" "CHID6"
17118 .cindex "&(iplookup)& router"
17119 .cindex "routers" "&(iplookup)&"
17120 The &(iplookup)& router was written to fulfil a specific requirement in
17121 Cambridge University (which in fact no longer exists). For this reason, it is
17122 not included in the binary of Exim by default. If you want to include it, you
17123 must set
17124 .code
17125 ROUTER_IPLOOKUP=yes
17126 .endd
17127 in your &_Local/Makefile_& configuration file.
17128
17129 The &(iplookup)& router routes an address by sending it over a TCP or UDP
17130 connection to one or more specific hosts. The host can then return the same or
17131 a different address &-- in effect rewriting the recipient address in the
17132 message's envelope. The new address is then passed on to subsequent routers. If
17133 this process fails, the address can be passed on to other routers, or delivery
17134 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
17135 must not be specified for it.
17136
17137 .cindex "options" "&(iplookup)& router"
17138 .option hosts iplookup string unset
17139 This option must be supplied. Its value is a colon-separated list of host
17140 names. The hosts are looked up using &[gethostbyname()]&
17141 (or &[getipnodebyname()]& when available)
17142 and are tried in order until one responds to the query. If none respond, what
17143 happens is controlled by &%optional%&.
17144
17145
17146 .option optional iplookup boolean false
17147 If &%optional%& is true, if no response is obtained from any host, the address
17148 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
17149 delivery to the address is deferred.
17150
17151
17152 .option port iplookup integer 0
17153 .cindex "port" "&(iplookup)& router"
17154 This option must be supplied. It specifies the port number for the TCP or UDP
17155 call.
17156
17157
17158 .option protocol iplookup string udp
17159 This option can be set to &"udp"& or &"tcp"& to specify which of the two
17160 protocols is to be used.
17161
17162
17163 .option query iplookup string&!! "see below"
17164 This defines the content of the query that is sent to the remote hosts. The
17165 default value is:
17166 .code
17167 $local_part@$domain $local_part@$domain
17168 .endd
17169 The repetition serves as a way of checking that a response is to the correct
17170 query in the default case (see &%response_pattern%& below).
17171
17172
17173 .option reroute iplookup string&!! unset
17174 If this option is not set, the rerouted address is precisely the byte string
17175 returned by the remote host, up to the first white space, if any. If set, the
17176 string is expanded to form the rerouted address. It can include parts matched
17177 in the response by &%response_pattern%& by means of numeric variables such as
17178 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17179 whether or not a pattern is in use. In all cases, the rerouted address must end
17180 up in the form &'local_part@domain'&.
17181
17182
17183 .option response_pattern iplookup string unset
17184 This option can be set to a regular expression that is applied to the string
17185 returned from the remote host. If the pattern does not match the response, the
17186 router declines. If &%response_pattern%& is not set, no checking of the
17187 response is done, unless the query was defaulted, in which case there is a
17188 check that the text returned after the first white space is the original
17189 address. This checks that the answer that has been received is in response to
17190 the correct question. For example, if the response is just a new domain, the
17191 following could be used:
17192 .code
17193 response_pattern = ^([^@]+)$
17194 reroute = $local_part@$1
17195 .endd
17196
17197 .option timeout iplookup time 5s
17198 This specifies the amount of time to wait for a response from the remote
17199 machine. The same timeout is used for the &[connect()]& function for a TCP
17200 call. It does not apply to UDP.
17201
17202
17203
17204
17205 . ////////////////////////////////////////////////////////////////////////////
17206 . ////////////////////////////////////////////////////////////////////////////
17207
17208 .chapter "The manualroute router" "CHID7"
17209 .scindex IIDmanrou1 "&(manualroute)& router"
17210 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17211 .cindex "domain" "manually routing"
17212 The &(manualroute)& router is so-called because it provides a way of manually
17213 routing an address according to its domain. It is mainly used when you want to
17214 route addresses to remote hosts according to your own rules, bypassing the
17215 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17216 route to local transports, a facility that may be useful if you want to save
17217 messages for dial-in hosts in local files.
17218
17219 The &(manualroute)& router compares a list of domain patterns with the domain
17220 it is trying to route. If there is no match, the router declines. Each pattern
17221 has associated with it a list of hosts and some other optional data, which may
17222 include a transport. The combination of a pattern and its data is called a
17223 &"routing rule"&. For patterns that do not have an associated transport, the
17224 generic &%transport%& option must specify a transport, unless the router is
17225 being used purely for verification (see &%verify_only%&).
17226
17227 .vindex "&$host$&"
17228 In the case of verification, matching the domain pattern is sufficient for the
17229 router to accept the address. When actually routing an address for delivery,
17230 an address that matches a domain pattern is queued for the associated
17231 transport. If the transport is not a local one, a host list must be associated
17232 with the pattern; IP addresses are looked up for the hosts, and these are
17233 passed to the transport along with the mail address. For local transports, a
17234 host list is optional. If it is present, it is passed in &$host$& as a single
17235 text string.
17236
17237 The list of routing rules can be provided as an inline string in
17238 &%route_list%&, or the data can be obtained by looking up the domain in a file
17239 or database by setting &%route_data%&. Only one of these settings may appear in
17240 any one instance of &(manualroute)&. The format of routing rules is described
17241 below, following the list of private options.
17242
17243
17244 .section "Private options for manualroute" "SECTprioptman"
17245
17246 .cindex "options" "&(manualroute)& router"
17247 The private options for the &(manualroute)& router are as follows:
17248
17249 .option host_all_ignored manualroute string defer
17250 See &%host_find_failed%&.
17251
17252 .option host_find_failed manualroute string freeze
17253 This option controls what happens when &(manualroute)& tries to find an IP
17254 address for a host, and the host does not exist. The option can be set to one
17255 of the following values:
17256 .code
17257 decline
17258 defer
17259 fail
17260 freeze
17261 ignore
17262 pass
17263 .endd
17264 The default (&"freeze"&) assumes that this state is a serious configuration
17265 error. The difference between &"pass"& and &"decline"& is that the former
17266 forces the address to be passed to the next router (or the router defined by
17267 &%pass_router%&),
17268 .oindex "&%more%&"
17269 overriding &%no_more%&, whereas the latter passes the address to the next
17270 router only if &%more%& is true.
17271
17272 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17273 cannot be found. If all the hosts in the list are ignored, the behaviour is
17274 controlled by the &%host_all_ignored%& option. This takes the same values
17275 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17276
17277 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17278 state; if a host lookup gets a temporary error, delivery is deferred unless the
17279 generic &%pass_on_timeout%& option is set.
17280
17281
17282 .option hosts_randomize manualroute boolean false
17283 .cindex "randomized host list"
17284 .cindex "host" "list of; randomized"
17285 If this option is set, the order of the items in a host list in a routing rule
17286 is randomized each time the list is used, unless an option in the routing rule
17287 overrides (see below). Randomizing the order of a host list can be used to do
17288 crude load sharing. However, if more than one mail address is routed by the
17289 same router to the same host list, the host lists are considered to be the same
17290 (even though they may be randomized into different orders) for the purpose of
17291 deciding whether to batch the deliveries into a single SMTP transaction.
17292
17293 When &%hosts_randomize%& is true, a host list may be split
17294 into groups whose order is separately randomized. This makes it possible to
17295 set up MX-like behaviour. The boundaries between groups are indicated by an
17296 item that is just &`+`& in the host list. For example:
17297 .code
17298 route_list = * host1:host2:host3:+:host4:host5
17299 .endd
17300 The order of the first three hosts and the order of the last two hosts is
17301 randomized for each use, but the first three always end up before the last two.
17302 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
17303 randomized host list is passed to an &(smtp)& transport that also has
17304 &%hosts_randomize set%&, the list is not re-randomized.
17305
17306
17307 .option route_data manualroute string&!! unset
17308 If this option is set, it must expand to yield the data part of a routing rule.
17309 Typically, the expansion string includes a lookup based on the domain. For
17310 example:
17311 .code
17312 route_data = ${lookup{$domain}dbm{/etc/routes}}
17313 .endd
17314 If the expansion is forced to fail, or the result is an empty string, the
17315 router declines. Other kinds of expansion failure cause delivery to be
17316 deferred.
17317
17318
17319 .option route_list manualroute "string list" unset
17320 This string is a list of routing rules, in the form defined below. Note that,
17321 unlike most string lists, the items are separated by semicolons. This is so
17322 that they may contain colon-separated host lists.
17323
17324
17325 .option same_domain_copy_routing manualroute boolean false
17326 .cindex "address" "copying routing"
17327 Addresses with the same domain are normally routed by the &(manualroute)&
17328 router to the same list of hosts. However, this cannot be presumed, because the
17329 router options and preconditions may refer to the local part of the address. By
17330 default, therefore, Exim routes each address in a message independently. DNS
17331 servers run caches, so repeated DNS lookups are not normally expensive, and in
17332 any case, personal messages rarely have more than a few recipients.
17333
17334 If you are running mailing lists with large numbers of subscribers at the same
17335 domain, and you are using a &(manualroute)& router which is independent of the
17336 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17337 lookups for identical domains in one message. In this case, when
17338 &(manualroute)& routes an address to a remote transport, any other unrouted
17339 addresses in the message that have the same domain are automatically given the
17340 same routing without processing them independently. However, this is only done
17341 if &%headers_add%& and &%headers_remove%& are unset.
17342
17343
17344
17345
17346 .section "Routing rules in route_list" "SECID120"
17347 The value of &%route_list%& is a string consisting of a sequence of routing
17348 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
17349 entered as two semicolons. Alternatively, the list separator can be changed as
17350 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
17351 Empty rules are ignored. The format of each rule is
17352 .display
17353 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
17354 .endd
17355 The following example contains two rules, each with a simple domain pattern and
17356 no options:
17357 .code
17358 route_list = \
17359   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
17360   thes.ref.example  mail-3.ref.example:mail-4.ref.example
17361 .endd
17362 The three parts of a rule are separated by white space. The pattern and the
17363 list of hosts can be enclosed in quotes if necessary, and if they are, the
17364 usual quoting rules apply. Each rule in a &%route_list%& must start with a
17365 single domain pattern, which is the only mandatory item in the rule. The
17366 pattern is in the same format as one item in a domain list (see section
17367 &<<SECTdomainlist>>&),
17368 except that it may not be the name of an interpolated file.
17369 That is, it may be wildcarded, or a regular expression, or a file or database
17370 lookup (with semicolons doubled, because of the use of semicolon as a separator
17371 in a &%route_list%&).
17372
17373 The rules in &%route_list%& are searched in order until one of the patterns
17374 matches the domain that is being routed. The list of hosts and then options are
17375 then used as described below. If there is no match, the router declines. When
17376 &%route_list%& is set, &%route_data%& must not be set.
17377
17378
17379
17380 .section "Routing rules in route_data" "SECID121"
17381 The use of &%route_list%& is convenient when there are only a small number of
17382 routing rules. For larger numbers, it is easier to use a file or database to
17383 hold the routing information, and use the &%route_data%& option instead.
17384 The value of &%route_data%& is a list of hosts, followed by (optional) options.
17385 Most commonly, &%route_data%& is set as a string that contains an
17386 expansion lookup. For example, suppose we place two routing rules in a file
17387 like this:
17388 .code
17389 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
17390 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
17391 .endd
17392 This data can be accessed by setting
17393 .code
17394 route_data = ${lookup{$domain}lsearch{/the/file/name}}
17395 .endd
17396 Failure of the lookup results in an empty string, causing the router to
17397 decline. However, you do not have to use a lookup in &%route_data%&. The only
17398 requirement is that the result of expanding the string is a list of hosts,
17399 possibly followed by options, separated by white space. The list of hosts must
17400 be enclosed in quotes if it contains white space.
17401
17402
17403
17404
17405 .section "Format of the list of hosts" "SECID122"
17406 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
17407 always separately expanded before use. If the expansion fails, the router
17408 declines. The result of the expansion must be a colon-separated list of names
17409 and/or IP addresses, optionally also including ports. The format of each item
17410 in the list is described in the next section. The list separator can be changed
17411 as described in section &<<SECTlistconstruct>>&.
17412
17413 If the list of hosts was obtained from a &%route_list%& item, the following
17414 variables are set during its expansion:
17415
17416 .ilist
17417 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
17418 If the domain was matched against a regular expression, the numeric variables
17419 &$1$&, &$2$&, etc. may be set. For example:
17420 .code
17421 route_list = ^domain(\d+)   host-$1.text.example
17422 .endd
17423 .next
17424 &$0$& is always set to the entire domain.
17425 .next
17426 &$1$& is also set when partial matching is done in a file lookup.
17427
17428 .next
17429 .vindex "&$value$&"
17430 If the pattern that matched the domain was a lookup item, the data that was
17431 looked up is available in the expansion variable &$value$&. For example:
17432 .code
17433 route_list = lsearch;;/some/file.routes  $value
17434 .endd
17435 .endlist
17436
17437 Note the doubling of the semicolon in the pattern that is necessary because
17438 semicolon is the default route list separator.
17439
17440
17441
17442 .section "Format of one host item" "SECTformatonehostitem"
17443 Each item in the list of hosts is either a host name or an IP address,
17444 optionally with an attached port number. When no port is given, an IP address
17445 is not enclosed in brackets. When a port is specified, it overrides the port
17446 specification on the transport. The port is separated from the name or address
17447 by a colon. This leads to some complications:
17448
17449 .ilist
17450 Because colon is the default separator for the list of hosts, either
17451 the colon that specifies a port must be doubled, or the list separator must
17452 be changed. The following two examples have the same effect:
17453 .code
17454 route_list = * "host1.tld::1225 : host2.tld::1226"
17455 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
17456 .endd
17457 .next
17458 When IPv6 addresses are involved, it gets worse, because they contain
17459 colons of their own. To make this case easier, it is permitted to
17460 enclose an IP address (either v4 or v6) in square brackets if a port
17461 number follows. For example:
17462 .code
17463 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
17464 .endd
17465 .endlist
17466
17467 .section "How the list of hosts is used" "SECThostshowused"
17468 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
17469 the hosts is tried, in the order specified, when carrying out the SMTP
17470 delivery. However, the order can be changed by setting the &%hosts_randomize%&
17471 option, either on the router (see section &<<SECTprioptman>>& above), or on the
17472 transport.
17473
17474 Hosts may be listed by name or by IP address. An unadorned name in the list of
17475 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
17476 interpreted as an indirection to a sublist of hosts obtained by looking up MX
17477 records in the DNS. For example:
17478 .code
17479 route_list = *  x.y.z:p.q.r/MX:e.f.g
17480 .endd
17481 If this feature is used with a port specifier, the port must come last. For
17482 example:
17483 .code
17484 route_list = *  dom1.tld/mx::1225
17485 .endd
17486 If the &%hosts_randomize%& option is set, the order of the items in the list is
17487 randomized before any lookups are done. Exim then scans the list; for any name
17488 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
17489 be an interface on the local host and the item is not the first in the list,
17490 Exim discards it and any subsequent items. If it is the first item, what
17491 happens is controlled by the
17492 .oindex "&%self%&" "in &(manualroute)& router"
17493 &%self%& option of the router.
17494
17495 A name on the list that is followed by &`/MX`& is replaced with the list of
17496 hosts obtained by looking up MX records for the name. This is always a DNS
17497 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
17498 below) are not relevant here. The order of these hosts is determined by the
17499 preference values in the MX records, according to the usual rules. Because
17500 randomizing happens before the MX lookup, it does not affect the order that is
17501 defined by MX preferences.
17502
17503 If the local host is present in the sublist obtained from MX records, but is
17504 not the most preferred host in that list, it and any equally or less
17505 preferred hosts are removed before the sublist is inserted into the main list.
17506
17507 If the local host is the most preferred host in the MX list, what happens
17508 depends on where in the original list of hosts the &`/MX`& item appears. If it
17509 is not the first item (that is, there are previous hosts in the main list),
17510 Exim discards this name and any subsequent items in the main list.
17511
17512 If the MX item is first in the list of hosts, and the local host is the
17513 most preferred host, what happens is controlled by the &%self%& option of the
17514 router.
17515
17516 DNS failures when lookup up the MX records are treated in the same way as DNS
17517 failures when looking up IP addresses: &%pass_on_timeout%& and
17518 &%host_find_failed%& are used when relevant.
17519
17520 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
17521 whether obtained from an MX lookup or not.
17522
17523
17524
17525 .section "How the options are used" "SECThowoptused"
17526 The options are a sequence of words; in practice no more than three are ever
17527 present. One of the words can be the name of a transport; this overrides the
17528 &%transport%& option on the router for this particular routing rule only. The
17529 other words (if present) control randomization of the list of hosts on a
17530 per-rule basis, and how the IP addresses of the hosts are to be found when
17531 routing to a remote transport. These options are as follows:
17532
17533 .ilist
17534 &%randomize%&: randomize the order of the hosts in this list, overriding the
17535 setting of &%hosts_randomize%& for this routing rule only.
17536 .next
17537 &%no_randomize%&: do not randomize the order of the hosts in this list,
17538 overriding the setting of &%hosts_randomize%& for this routing rule only.
17539 .next
17540 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
17541 find IP addresses. This function may ultimately cause a DNS lookup, but it may
17542 also look in &_/etc/hosts_& or other sources of information.
17543 .next
17544 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
17545 no address records are found. If there is a temporary DNS error (such as a
17546 timeout), delivery is deferred.
17547 .endlist
17548
17549 For example:
17550 .code
17551 route_list = domain1  host1:host2:host3  randomize bydns;\
17552              domain2  host4:host5
17553 .endd
17554 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
17555 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
17556 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
17557 or &[gethostbyname()]&, and the result of the lookup is the result of that
17558 call.
17559
17560 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
17561 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
17562 instead of TRY_AGAIN. That is why the default action is to try a DNS
17563 lookup first. Only if that gives a definite &"no such host"& is the local
17564 function called.
17565
17566
17567
17568 If no IP address for a host can be found, what happens is controlled by the
17569 &%host_find_failed%& option.
17570
17571 .vindex "&$host$&"
17572 When an address is routed to a local transport, IP addresses are not looked up.
17573 The host list is passed to the transport in the &$host$& variable.
17574
17575
17576
17577 .section "Manualroute examples" "SECID123"
17578 In some of the examples that follow, the presence of the &%remote_smtp%&
17579 transport, as defined in the default configuration file, is assumed:
17580
17581 .ilist
17582 .cindex "smart host" "example router"
17583 The &(manualroute)& router can be used to forward all external mail to a
17584 &'smart host'&. If you have set up, in the main part of the configuration, a
17585 named domain list that contains your local domains, for example:
17586 .code
17587 domainlist local_domains = my.domain.example
17588 .endd
17589 You can arrange for all other domains to be routed to a smart host by making
17590 your first router something like this:
17591 .code
17592 smart_route:
17593   driver = manualroute
17594   domains = !+local_domains
17595   transport = remote_smtp
17596   route_list = * smarthost.ref.example
17597 .endd
17598 This causes all non-local addresses to be sent to the single host
17599 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
17600 they are tried in order
17601 (but you can use &%hosts_randomize%& to vary the order each time).
17602 Another way of configuring the same thing is this:
17603 .code
17604 smart_route:
17605   driver = manualroute
17606   transport = remote_smtp
17607   route_list = !+local_domains  smarthost.ref.example
17608 .endd
17609 There is no difference in behaviour between these two routers as they stand.
17610 However, they behave differently if &%no_more%& is added to them. In the first
17611 example, the router is skipped if the domain does not match the &%domains%&
17612 precondition; the following router is always tried. If the router runs, it
17613 always matches the domain and so can never decline. Therefore, &%no_more%&
17614 would have no effect. In the second case, the router is never skipped; it
17615 always runs. However, if it doesn't match the domain, it declines. In this case
17616 &%no_more%& would prevent subsequent routers from running.
17617
17618 .next
17619 .cindex "mail hub example"
17620 A &'mail hub'& is a host which receives mail for a number of domains via MX
17621 records in the DNS and delivers it via its own private routing mechanism. Often
17622 the final destinations are behind a firewall, with the mail hub being the one
17623 machine that can connect to machines both inside and outside the firewall. The
17624 &(manualroute)& router is usually used on a mail hub to route incoming messages
17625 to the correct hosts. For a small number of domains, the routing can be inline,
17626 using the &%route_list%& option, but for a larger number a file or database
17627 lookup is easier to manage.
17628
17629 If the domain names are in fact the names of the machines to which the mail is
17630 to be sent by the mail hub, the configuration can be quite simple. For
17631 example:
17632 .code
17633 hub_route:
17634   driver = manualroute
17635   transport = remote_smtp
17636   route_list = *.rhodes.tvs.example  $domain
17637 .endd
17638 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
17639 whose names are the same as the mail domains. A similar approach can be taken
17640 if the host name can be obtained from the domain name by a string manipulation
17641 that the expansion facilities can handle. Otherwise, a lookup based on the
17642 domain can be used to find the host:
17643 .code
17644 through_firewall:
17645   driver = manualroute
17646   transport = remote_smtp
17647   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
17648 .endd
17649 The result of the lookup must be the name or IP address of the host (or
17650 hosts) to which the address is to be routed. If the lookup fails, the route
17651 data is empty, causing the router to decline. The address then passes to the
17652 next router.
17653
17654 .next
17655 .cindex "batched SMTP output example"
17656 .cindex "SMTP" "batched outgoing; example"
17657 You can use &(manualroute)& to deliver messages to pipes or files in batched
17658 SMTP format for onward transportation by some other means. This is one way of
17659 storing mail for a dial-up host when it is not connected. The route list entry
17660 can be as simple as a single domain name in a configuration like this:
17661 .code
17662 save_in_file:
17663   driver = manualroute
17664   transport = batchsmtp_appendfile
17665   route_list = saved.domain.example
17666 .endd
17667 though often a pattern is used to pick up more than one domain. If there are
17668 several domains or groups of domains with different transport requirements,
17669 different transports can be listed in the routing information:
17670 .code
17671 save_in_file:
17672   driver = manualroute
17673   route_list = \
17674     *.saved.domain1.example  $domain  batch_appendfile; \
17675     *.saved.domain2.example  \
17676       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
17677       batch_pipe
17678 .endd
17679 .vindex "&$domain$&"
17680 .vindex "&$host$&"
17681 The first of these just passes the domain in the &$host$& variable, which
17682 doesn't achieve much (since it is also in &$domain$&), but the second does a
17683 file lookup to find a value to pass, causing the router to decline to handle
17684 the address if the lookup fails.
17685
17686 .next
17687 .cindex "UUCP" "example of router for"
17688 Routing mail directly to UUCP software is a specific case of the use of
17689 &(manualroute)& in a gateway to another mail environment. This is an example of
17690 one way it can be done:
17691 .code
17692 # Transport
17693 uucp:
17694   driver = pipe
17695   user = nobody
17696   command = /usr/local/bin/uux -r - \
17697     ${substr_-5:$host}!rmail ${local_part}
17698   return_fail_output = true
17699
17700 # Router
17701 uucphost:
17702   transport = uucp
17703   driver = manualroute
17704   route_data = \
17705     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
17706 .endd
17707 The file &_/usr/local/exim/uucphosts_& contains entries like
17708 .code
17709 darksite.ethereal.example:           darksite.UUCP
17710 .endd
17711 It can be set up more simply without adding and removing &".UUCP"& but this way
17712 makes clear the distinction between the domain name
17713 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
17714 .endlist
17715 .ecindex IIDmanrou1
17716 .ecindex IIDmanrou2
17717
17718
17719
17720
17721
17722
17723
17724
17725 . ////////////////////////////////////////////////////////////////////////////
17726 . ////////////////////////////////////////////////////////////////////////////
17727
17728 .chapter "The queryprogram router" "CHAPdriverlast"
17729 .scindex IIDquerou1 "&(queryprogram)& router"
17730 .scindex IIDquerou2 "routers" "&(queryprogram)&"
17731 .cindex "routing" "by external program"
17732 The &(queryprogram)& router routes an address by running an external command
17733 and acting on its output. This is an expensive way to route, and is intended
17734 mainly for use in lightly-loaded systems, or for performing experiments.
17735 However, if it is possible to use the precondition options (&%domains%&,
17736 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
17737 be used in special cases, even on a busy host. There are the following private
17738 options:
17739 .cindex "options" "&(queryprogram)& router"
17740
17741 .option command queryprogram string&!! unset
17742 This option must be set. It specifies the command that is to be run. The
17743 command is split up into a command name and arguments, and then each is
17744 expanded separately (exactly as for a &(pipe)& transport, described in chapter
17745 &<<CHAPpipetransport>>&).
17746
17747
17748 .option command_group queryprogram string unset
17749 .cindex "gid (group id)" "in &(queryprogram)& router"
17750 This option specifies a gid to be set when running the command while routing an
17751 address for deliver. It must be set if &%command_user%& specifies a numerical
17752 uid. If it begins with a digit, it is interpreted as the numerical value of the
17753 gid. Otherwise it is looked up using &[getgrnam()]&.
17754
17755
17756 .option command_user queryprogram string unset
17757 .cindex "uid (user id)" "for &(queryprogram)&"
17758 This option must be set. It specifies the uid which is set when running the
17759 command while routing an address for delivery. If the value begins with a digit,
17760 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
17761 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
17762 not set, a value for the gid also.
17763
17764 &*Warning:*& Changing uid and gid is possible only when Exim is running as
17765 root, which it does during a normal delivery in a conventional configuration.
17766 However, when an address is being verified during message reception, Exim is
17767 usually running as the Exim user, not as root. If the &(queryprogram)& router
17768 is called from a non-root process, Exim cannot change uid or gid before running
17769 the command. In this circumstance the command runs under the current uid and
17770 gid.
17771
17772
17773 .option current_directory queryprogram string /
17774 This option specifies an absolute path which is made the current directory
17775 before running the command.
17776
17777
17778 .option timeout queryprogram time 1h
17779 If the command does not complete within the timeout period, its process group
17780 is killed and the message is frozen. A value of zero time specifies no
17781 timeout.
17782
17783
17784 The standard output of the command is connected to a pipe, which is read when
17785 the command terminates. It should consist of a single line of output,
17786 containing up to five fields, separated by white space. The maximum length of
17787 the line is 1023 characters. Longer lines are silently truncated. The first
17788 field is one of the following words (case-insensitive):
17789
17790 .ilist
17791 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
17792 below).
17793 .next
17794 &'Decline'&: the router declines; pass the address to the next router, unless
17795 &%no_more%& is set.
17796 .next
17797 &'Fail'&: routing failed; do not pass the address to any more routers. Any
17798 subsequent text on the line is an error message. If the router is run as part
17799 of address verification during an incoming SMTP message, the message is
17800 included in the SMTP response.
17801 .next
17802 &'Defer'&: routing could not be completed at this time; try again later. Any
17803 subsequent text on the line is an error message which is logged. It is not
17804 included in any SMTP response.
17805 .next
17806 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
17807 .next
17808 &'Pass'&: pass the address to the next router (or the router specified by
17809 &%pass_router%&), overriding &%no_more%&.
17810 .next
17811 &'Redirect'&: the message is redirected. The remainder of the line is a list of
17812 new addresses, which are routed independently, starting with the first router,
17813 or the router specified by &%redirect_router%&, if set.
17814 .endlist
17815
17816 When the first word is &'accept'&, the remainder of the line consists of a
17817 number of keyed data values, as follows (split into two lines here, to fit on
17818 the page):
17819 .code
17820 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
17821 LOOKUP=byname|bydns DATA=<text>
17822 .endd
17823 The data items can be given in any order, and all are optional. If no transport
17824 is included, the transport specified by the generic &%transport%& option is
17825 used. The list of hosts and the lookup type are needed only if the transport is
17826 an &(smtp)& transport that does not itself supply a list of hosts.
17827
17828 The format of the list of hosts is the same as for the &(manualroute)& router.
17829 As well as host names and IP addresses with optional port numbers, as described
17830 in section &<<SECTformatonehostitem>>&, it may contain names followed by
17831 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
17832 (see section &<<SECThostshowused>>&).
17833
17834 If the lookup type is not specified, Exim behaves as follows when trying to
17835 find an IP address for each host: First, a DNS lookup is done. If this yields
17836 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
17837 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
17838 result of the lookup is the result of that call.
17839
17840 .vindex "&$address_data$&"
17841 If the DATA field is set, its value is placed in the &$address_data$&
17842 variable. For example, this return line
17843 .code
17844 accept hosts=x1.y.example:x2.y.example data="rule1"
17845 .endd
17846 routes the address to the default transport, passing a list of two hosts. When
17847 the transport runs, the string &"rule1"& is in &$address_data$&.
17848 .ecindex IIDquerou1
17849 .ecindex IIDquerou2
17850
17851
17852
17853
17854 . ////////////////////////////////////////////////////////////////////////////
17855 . ////////////////////////////////////////////////////////////////////////////
17856
17857 .chapter "The redirect router" "CHAPredirect"
17858 .scindex IIDredrou1 "&(redirect)& router"
17859 .scindex IIDredrou2 "routers" "&(redirect)&"
17860 .cindex "alias file" "in a &(redirect)& router"
17861 .cindex "address redirection" "&(redirect)& router"
17862 The &(redirect)& router handles several kinds of address redirection. Its most
17863 common uses are for resolving local part aliases from a central alias file
17864 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
17865 files, but it has many other potential uses. The incoming address can be
17866 redirected in several different ways:
17867
17868 .ilist
17869 It can be replaced by one or more new addresses which are themselves routed
17870 independently.
17871 .next
17872 It can be routed to be delivered to a given file or directory.
17873 .next
17874 It can be routed to be delivered to a specified pipe command.
17875 .next
17876 It can cause an automatic reply to be generated.
17877 .next
17878 It can be forced to fail, optionally with a custom error message.
17879 .next
17880 It can be temporarily deferred, optionally with a custom message.
17881 .next
17882 It can be discarded.
17883 .endlist
17884
17885 The generic &%transport%& option must not be set for &(redirect)& routers.
17886 However, there are some private options which define transports for delivery to
17887 files and pipes, and for generating autoreplies. See the &%file_transport%&,
17888 &%pipe_transport%& and &%reply_transport%& descriptions below.
17889
17890
17891
17892 .section "Redirection data" "SECID124"
17893 The router operates by interpreting a text string which it obtains either by
17894 expanding the contents of the &%data%& option, or by reading the entire
17895 contents of a file whose name is given in the &%file%& option. These two
17896 options are mutually exclusive. The first is commonly used for handling system
17897 aliases, in a configuration like this:
17898 .code
17899 system_aliases:
17900   driver = redirect
17901   data = ${lookup{$local_part}lsearch{/etc/aliases}}
17902 .endd
17903 If the lookup fails, the expanded string in this example is empty. When the
17904 expansion of &%data%& results in an empty string, the router declines. A forced
17905 expansion failure also causes the router to decline; other expansion failures
17906 cause delivery to be deferred.
17907
17908 A configuration using &%file%& is commonly used for handling users'
17909 &_.forward_& files, like this:
17910 .code
17911 userforward:
17912   driver = redirect
17913   check_local_user
17914   file = $home/.forward
17915   no_verify
17916 .endd
17917 If the file does not exist, or causes no action to be taken (for example, it is
17918 empty or consists only of comments), the router declines. &*Warning*&: This
17919 is not the case when the file contains syntactically valid items that happen to
17920 yield empty addresses, for example, items containing only RFC 2822 address
17921 comments.
17922
17923
17924
17925 .section "Forward files and address verification" "SECID125"
17926 .cindex "address redirection" "while verifying"
17927 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
17928 &_.forward_& files, as in the example above. There are two reasons for this:
17929
17930 .ilist
17931 When Exim is receiving an incoming SMTP message from a remote host, it is
17932 running under the Exim uid, not as root. Exim is unable to change uid to read
17933 the file as the user, and it may not be able to read it as the Exim user. So in
17934 practice the router may not be able to operate.
17935 .next
17936 However, even when the router can operate, the existence of a &_.forward_& file
17937 is unimportant when verifying an address. What should be checked is whether the
17938 local part is a valid user name or not. Cutting out the redirection processing
17939 saves some resources.
17940 .endlist
17941
17942
17943
17944
17945
17946
17947 .section "Interpreting redirection data" "SECID126"
17948 .cindex "Sieve filter" "specifying in redirection data"
17949 .cindex "filter" "specifying in redirection data"
17950 The contents of the data string, whether obtained from &%data%& or &%file%&,
17951 can be interpreted in two different ways:
17952
17953 .ilist
17954 If the &%allow_filter%& option is set true, and the data begins with the text
17955 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
17956 &'filtering'& instructions in the form of an Exim or Sieve filter file,
17957 respectively. Details of the syntax and semantics of filter files are described
17958 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
17959 document is intended for use by end users.
17960 .next
17961 Otherwise, the data must be a comma-separated list of redirection items, as
17962 described in the next section.
17963 .endlist
17964
17965 When a message is redirected to a file (a &"mail folder"&), the file name given
17966 in a non-filter redirection list must always be an absolute path. A filter may
17967 generate a relative path &-- how this is handled depends on the transport's
17968 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
17969 for the &(appendfile)& transport.
17970
17971
17972
17973 .section "Items in a non-filter redirection list" "SECTitenonfilred"
17974 .cindex "address redirection" "non-filter list items"
17975 When the redirection data is not an Exim or Sieve filter, for example, if it
17976 comes from a conventional alias or forward file, it consists of a list of
17977 addresses, file names, pipe commands, or certain special items (see section
17978 &<<SECTspecitredli>>& below). The special items can be individually enabled or
17979 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
17980 depending on their default values. The items in the list are separated by
17981 commas or newlines.
17982 If a comma is required in an item, the entire item must be enclosed in double
17983 quotes.
17984
17985 Lines starting with a # character are comments, and are ignored, and # may
17986 also appear following a comma, in which case everything between the # and the
17987 next newline character is ignored.
17988
17989 If an item is entirely enclosed in double quotes, these are removed. Otherwise
17990 double quotes are retained because some forms of mail address require their use
17991 (but never to enclose the entire address). In the following description,
17992 &"item"& refers to what remains after any surrounding double quotes have been
17993 removed.
17994
17995 .vindex "&$local_part$&"
17996 &*Warning*&: If you use an Exim expansion to construct a redirection address,
17997 and the expansion contains a reference to &$local_part$&, you should make use
17998 of the &%quote_local_part%& expansion operator, in case the local part contains
17999 special characters. For example, to redirect all mail for the domain
18000 &'obsolete.example'&, retaining the existing local part, you could use this
18001 setting:
18002 .code
18003 data = ${quote_local_part:$local_part}@newdomain.example
18004 .endd
18005
18006
18007 .section "Redirecting to a local mailbox" "SECTredlocmai"
18008 .cindex "routing" "loops in"
18009 .cindex "loop" "while routing, avoidance of"
18010 .cindex "address redirection" "to local mailbox"
18011 A redirection item may safely be the same as the address currently under
18012 consideration. This does not cause a routing loop, because a router is
18013 automatically skipped if any ancestor of the address that is being processed
18014 is the same as the current address and was processed by the current router.
18015 Such an address is therefore passed to the following routers, so it is handled
18016 as if there were no redirection. When making this loop-avoidance test, the
18017 complete local part, including any prefix or suffix, is used.
18018
18019 .cindex "address redirection" "local part without domain"
18020 Specifying the same local part without a domain is a common usage in personal
18021 filter files when the user wants to have messages delivered to the local
18022 mailbox and also forwarded elsewhere. For example, the user whose login is
18023 &'cleo'& might have a &_.forward_& file containing this:
18024 .code
18025 cleo, cleopatra@egypt.example
18026 .endd
18027 .cindex "backslash in alias file"
18028 .cindex "alias file" "backslash in"
18029 For compatibility with other MTAs, such unqualified local parts may be
18030 preceded by &"\"&, but this is not a requirement for loop prevention. However,
18031 it does make a difference if more than one domain is being handled
18032 synonymously.
18033
18034 If an item begins with &"\"& and the rest of the item parses as a valid RFC
18035 2822 address that does not include a domain, the item is qualified using the
18036 domain of the incoming address. In the absence of a leading &"\"&, unqualified
18037 addresses are qualified using the value in &%qualify_recipient%&, but you can
18038 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
18039
18040 Care must be taken if there are alias names for local users.
18041 Consider an MTA handling a single local domain where the system alias file
18042 contains:
18043 .code
18044 Sam.Reman: spqr
18045 .endd
18046 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
18047 messages in the local mailbox, and also forward copies elsewhere. He creates
18048 this forward file:
18049 .code
18050 Sam.Reman, spqr@reme.elsewhere.example
18051 .endd
18052 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
18053 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
18054 second time round, because it has previously routed it,
18055 and the following routers presumably cannot handle the alias. The forward file
18056 should really contain
18057 .code
18058 spqr, spqr@reme.elsewhere.example
18059 .endd
18060 but because this is such a common error, the &%check_ancestor%& option (see
18061 below) exists to provide a way to get round it. This is normally set on a
18062 &(redirect)& router that is handling users' &_.forward_& files.
18063
18064
18065
18066 .section "Special items in redirection lists" "SECTspecitredli"
18067 In addition to addresses, the following types of item may appear in redirection
18068 lists (that is, in non-filter redirection data):
18069
18070 .ilist
18071 .cindex "pipe" "in redirection list"
18072 .cindex "address redirection" "to pipe"
18073 An item is treated as a pipe command if it begins with &"|"& and does not parse
18074 as a valid RFC 2822 address that includes a domain. A transport for running the
18075 command must be specified by the &%pipe_transport%& option.
18076 Normally, either the router or the transport specifies a user and a group under
18077 which to run the delivery. The default is to use the Exim user and group.
18078
18079 Single or double quotes can be used for enclosing the individual arguments of
18080 the pipe command; no interpretation of escapes is done for single quotes. If
18081 the command contains a comma character, it is necessary to put the whole item
18082 in double quotes, for example:
18083 .code
18084 "|/some/command ready,steady,go"
18085 .endd
18086 since items in redirection lists are terminated by commas. Do not, however,
18087 quote just the command. An item such as
18088 .code
18089 |"/some/command ready,steady,go"
18090 .endd
18091 is interpreted as a pipe with a rather strange command name, and no arguments.
18092
18093 .next
18094 .cindex "file" "in redirection list"
18095 .cindex "address redirection" "to file"
18096 An item is interpreted as a path name if it begins with &"/"& and does not
18097 parse as a valid RFC 2822 address that includes a domain. For example,
18098 .code
18099 /home/world/minbari
18100 .endd
18101 is treated as a file name, but
18102 .code
18103 /s=molari/o=babylon/@x400gate.way
18104 .endd
18105 is treated as an address. For a file name, a transport must be specified using
18106 the &%file_transport%& option. However, if the generated path name ends with a
18107 forward slash character, it is interpreted as a directory name rather than a
18108 file name, and &%directory_transport%& is used instead.
18109
18110 Normally, either the router or the transport specifies a user and a group under
18111 which to run the delivery. The default is to use the Exim user and group.
18112
18113 .cindex "&_/dev/null_&"
18114 However, if a redirection item is the path &_/dev/null_&, delivery to it is
18115 bypassed at a high level, and the log entry shows &"**bypassed**"&
18116 instead of a transport name. In this case the user and group are not used.
18117
18118 .next
18119 .cindex "included address list"
18120 .cindex "address redirection" "included external list"
18121 If an item is of the form
18122 .code
18123 :include:<path name>
18124 .endd
18125 a list of further items is taken from the given file and included at that
18126 point. &*Note*&: Such a file can not be a filter file; it is just an
18127 out-of-line addition to the list. The items in the included list are separated
18128 by commas or newlines and are not subject to expansion. If this is the first
18129 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
18130 the alias name. This example is incorrect:
18131 .code
18132 list1    :include:/opt/lists/list1
18133 .endd
18134 It must be given as
18135 .code
18136 list1:   :include:/opt/lists/list1
18137 .endd
18138 .next
18139 .cindex "address redirection" "to black hole"
18140 Sometimes you want to throw away mail to a particular local part. Making the
18141 &%data%& option expand to an empty string does not work, because that causes
18142 the router to decline. Instead, the alias item
18143 .cindex "black hole"
18144 .cindex "abandoning mail"
18145 &':blackhole:'& can be used. It does what its name implies. No delivery is
18146 done, and no error message is generated. This has the same effect as specifing
18147 &_/dev/null_& as a destination, but it can be independently disabled.
18148
18149 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
18150 delivery is done for the original local part, even if other redirection items
18151 are present. If you are generating a multi-item list (for example, by reading a
18152 database) and need the ability to provide a no-op item, you must use
18153 &_/dev/null_&.
18154
18155 .next
18156 .cindex "delivery" "forcing failure"
18157 .cindex "delivery" "forcing deferral"
18158 .cindex "failing delivery" "forcing"
18159 .cindex "deferred delivery, forcing"
18160 .cindex "customizing" "failure message"
18161 An attempt to deliver a particular address can be deferred or forced to fail by
18162 redirection items of the form
18163 .code
18164 :defer:
18165 :fail:
18166 .endd
18167 respectively. When a redirection list contains such an item, it applies
18168 to the entire redirection; any other items in the list are ignored. Any
18169 text following &':fail:'& or &':defer:'& is placed in the error text
18170 associated with the failure. For example, an alias file might contain:
18171 .code
18172 X.Employee:  :fail: Gone away, no forwarding address
18173 .endd
18174 In the case of an address that is being verified from an ACL or as the subject
18175 of a
18176 .cindex "VRFY" "error text, display of"
18177 VRFY command, the text is included in the SMTP error response by
18178 default.
18179 .cindex "EXPN" "error text, display of"
18180 The text is not included in the response to an EXPN command. In non-SMTP cases
18181 the text is included in the error message that Exim generates.
18182
18183 .cindex "SMTP" "error codes"
18184 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18185 &':fail:'&. However, if the message starts with three digits followed by a
18186 space, optionally followed by an extended code of the form &'n.n.n'&, also
18187 followed by a space, and the very first digit is the same as the default error
18188 code, the code from the message is used instead. If the very first digit is
18189 incorrect, a panic error is logged, and the default code is used. You can
18190 suppress the use of the supplied code in a redirect router by setting the
18191 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18192 ignored.
18193
18194 .vindex "&$acl_verify_message$&"
18195 In an ACL, an explicitly provided message overrides the default, but the
18196 default message is available in the variable &$acl_verify_message$& and can
18197 therefore be included in a custom message if this is desired.
18198
18199 Normally the error text is the rest of the redirection list &-- a comma does
18200 not terminate it &-- but a newline does act as a terminator. Newlines are not
18201 normally present in alias expansions. In &(lsearch)& lookups they are removed
18202 as part of the continuation process, but they may exist in other kinds of
18203 lookup and in &':include:'& files.
18204
18205 During routing for message delivery (as opposed to verification), a redirection
18206 containing &':fail:'& causes an immediate failure of the incoming address,
18207 whereas &':defer:'& causes the message to remain on the queue so that a
18208 subsequent delivery attempt can happen at a later time. If an address is
18209 deferred for too long, it will ultimately fail, because the normal retry
18210 rules still apply.
18211
18212 .next
18213 .cindex "alias file" "exception to default"
18214 Sometimes it is useful to use a single-key search type with a default (see
18215 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18216 for exceptions to the default. These can be handled by aliasing them to
18217 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18218 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18219 results in an empty redirection list has the same effect.
18220 .endlist
18221
18222
18223 .section "Duplicate addresses" "SECTdupaddr"
18224 .cindex "duplicate addresses"
18225 .cindex "address duplicate, discarding"
18226 .cindex "pipe" "duplicated"
18227 Exim removes duplicate addresses from the list to which it is delivering, so as
18228 to deliver just one copy to each address. This does not apply to deliveries
18229 routed to pipes by different immediate parent addresses, but an indirect
18230 aliasing scheme of the type
18231 .code
18232 pipe:       |/some/command $local_part
18233 localpart1: pipe
18234 localpart2: pipe
18235 .endd
18236 does not work with a message that is addressed to both local parts, because
18237 when the second is aliased to the intermediate local part &"pipe"& it gets
18238 discarded as being the same as a previously handled address. However, a scheme
18239 such as
18240 .code
18241 localpart1: |/some/command $local_part
18242 localpart2: |/some/command $local_part
18243 .endd
18244 does result in two different pipe deliveries, because the immediate parents of
18245 the pipes are distinct.
18246
18247
18248
18249 .section "Repeated redirection expansion" "SECID128"
18250 .cindex "repeated redirection expansion"
18251 .cindex "address redirection" "repeated for each delivery attempt"
18252 When a message cannot be delivered to all of its recipients immediately,
18253 leading to two or more delivery attempts, redirection expansion is carried out
18254 afresh each time for those addresses whose children were not all previously
18255 delivered. If redirection is being used as a mailing list, this can lead to new
18256 members of the list receiving copies of old messages. The &%one_time%& option
18257 can be used to avoid this.
18258
18259
18260 .section "Errors in redirection lists" "SECID129"
18261 .cindex "address redirection" "errors"
18262 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18263 error is skipped, and an entry is written to the main log. This may be useful
18264 for mailing lists that are automatically managed. Otherwise, if an error is
18265 detected while generating the list of new addresses, the original address is
18266 deferred. See also &%syntax_errors_to%&.
18267
18268
18269
18270 .section "Private options for the redirect router" "SECID130"
18271
18272 .cindex "options" "&(redirect)& router"
18273 The private options for the &(redirect)& router are as follows:
18274
18275
18276 .option allow_defer redirect boolean false
18277 Setting this option allows the use of &':defer:'& in non-filter redirection
18278 data, or the &%defer%& command in an Exim filter file.
18279
18280
18281 .option allow_fail redirect boolean false
18282 .cindex "failing delivery" "from filter"
18283 If this option is true, the &':fail:'& item can be used in a redirection list,
18284 and the &%fail%& command may be used in an Exim filter file.
18285
18286
18287 .option allow_filter redirect boolean false
18288 .cindex "filter" "enabling use of"
18289 .cindex "Sieve filter" "enabling use of"
18290 Setting this option allows Exim to interpret redirection data that starts with
18291 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
18292 are some features of Exim filter files that some administrators may wish to
18293 lock out; see the &%forbid_filter_%&&'xxx'& options below.
18294
18295 It is also possible to lock out Exim filters or Sieve filters while allowing
18296 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
18297
18298
18299 The filter is run using the uid and gid set by the generic &%user%& and
18300 &%group%& options. These take their defaults from the password data if
18301 &%check_local_user%& is set, so in the normal case of users' personal filter
18302 files, the filter is run as the relevant user. When &%allow_filter%& is set
18303 true, Exim insists that either &%check_local_user%& or &%user%& is set.
18304
18305
18306
18307 .option allow_freeze redirect boolean false
18308 .cindex "freezing messages" "allowing in filter"
18309 Setting this option allows the use of the &%freeze%& command in an Exim filter.
18310 This command is more normally encountered in system filters, and is disabled by
18311 default for redirection filters because it isn't something you usually want to
18312 let ordinary users do.
18313
18314
18315
18316 .option check_ancestor redirect boolean false
18317 This option is concerned with handling generated addresses that are the same
18318 as some address in the list of redirection ancestors of the current address.
18319 Although it is turned off by default in the code, it is set in the default
18320 configuration file for handling users' &_.forward_& files. It is recommended
18321 for this use of the &(redirect)& router.
18322
18323 When &%check_ancestor%& is set, if a generated address (including the domain)
18324 is the same as any ancestor of the current address, it is replaced by a copy of
18325 the current address. This helps in the case where local part A is aliased to B,
18326 and B has a &_.forward_& file pointing back to A. For example, within a single
18327 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
18328 &_&~jb/.forward_& contains:
18329 .code
18330 \Joe.Bloggs, <other item(s)>
18331 .endd
18332 Without the &%check_ancestor%& setting, either local part (&"jb"& or
18333 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
18334 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
18335 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
18336 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
18337 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
18338 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
18339 original address. See also the &%repeat_use%& option below.
18340
18341
18342 .option check_group redirect boolean "see below"
18343 When the &%file%& option is used, the group owner of the file is checked only
18344 when this option is set. The permitted groups are those listed in the
18345 &%owngroups%& option, together with the user's default group if
18346 &%check_local_user%& is set. If the file has the wrong group, routing is
18347 deferred. The default setting for this option is true if &%check_local_user%&
18348 is set and the &%modemask%& option permits the group write bit, or if the
18349 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
18350
18351
18352
18353 .option check_owner redirect boolean "see below"
18354 When the &%file%& option is used, the owner of the file is checked only when
18355 this option is set. If &%check_local_user%& is set, the local user is
18356 permitted; otherwise the owner must be one of those listed in the &%owners%&
18357 option. The default value for this option is true if &%check_local_user%& or
18358 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
18359
18360
18361 .option data redirect string&!! unset
18362 This option is mutually exclusive with &%file%&. One or other of them must be
18363 set, but not both. The contents of &%data%& are expanded, and then used as the
18364 list of forwarding items, or as a set of filtering instructions. If the
18365 expansion is forced to fail, or the result is an empty string or a string that
18366 has no effect (consists entirely of comments), the router declines.
18367
18368 When filtering instructions are used, the string must begin with &"#Exim
18369 filter"&, and all comments in the string, including this initial one, must be
18370 terminated with newline characters. For example:
18371 .code
18372 data = #Exim filter\n\
18373        if $h_to: contains Exim then save $home/mail/exim endif
18374 .endd
18375 If you are reading the data from a database where newlines cannot be included,
18376 you can use the &${sg}$& expansion item to turn the escape string of your
18377 choice into a newline.
18378
18379
18380 .option directory_transport redirect string&!! unset
18381 A &(redirect)& router sets up a direct delivery to a directory when a path name
18382 ending with a slash is specified as a new &"address"&. The transport used is
18383 specified by this option, which, after expansion, must be the name of a
18384 configured transport. This should normally be an &(appendfile)& transport.
18385
18386
18387 .option file redirect string&!! unset
18388 This option specifies the name of a file that contains the redirection data. It
18389 is mutually exclusive with the &%data%& option. The string is expanded before
18390 use; if the expansion is forced to fail, the router declines. Other expansion
18391 failures cause delivery to be deferred. The result of a successful expansion
18392 must be an absolute path. The entire file is read and used as the redirection
18393 data. If the data is an empty string or a string that has no effect (consists
18394 entirely of comments), the router declines.
18395
18396 .cindex "NFS" "checking for file existence"
18397 If the attempt to open the file fails with a &"does not exist"& error, Exim
18398 runs a check on the containing directory,
18399 unless &%ignore_enotdir%& is true (see below).
18400 If the directory does not appear to exist, delivery is deferred. This can
18401 happen when users' &_.forward_& files are in NFS-mounted directories, and there
18402 is a mount problem. If the containing directory does exist, but the file does
18403 not, the router declines.
18404
18405
18406 .option file_transport redirect string&!! unset
18407 .vindex "&$address_file$&"
18408 A &(redirect)& router sets up a direct delivery to a file when a path name not
18409 ending in a slash is specified as a new &"address"&. The transport used is
18410 specified by this option, which, after expansion, must be the name of a
18411 configured transport. This should normally be an &(appendfile)& transport. When
18412 it is running, the file name is in &$address_file$&.
18413
18414
18415 .option filter_prepend_home redirect boolean true
18416 When this option is true, if a &(save)& command in an Exim filter specifies a
18417 relative path, and &$home$& is defined, it is automatically prepended to the
18418 relative path. If this option is set false, this action does not happen. The
18419 relative path is then passed to the transport unmodified.
18420
18421
18422 .option forbid_blackhole redirect boolean false
18423 If this option is true, the &':blackhole:'& item may not appear in a
18424 redirection list.
18425
18426
18427 .option forbid_exim_filter redirect boolean false
18428 If this option is set true, only Sieve filters are permitted when
18429 &%allow_filter%& is true.
18430
18431
18432
18433
18434 .option forbid_file redirect boolean false
18435 .cindex "delivery" "to file; forbidding"
18436 .cindex "Sieve filter" "forbidding delivery to a file"
18437 .cindex "Sieve filter" "&""keep""& facility; disabling"
18438 If this option is true, this router may not generate a new address that
18439 specifies delivery to a local file or directory, either from a filter or from a
18440 conventional forward file. This option is forced to be true if &%one_time%& is
18441 set. It applies to Sieve filters as well as to Exim filters, but if true, it
18442 locks out the Sieve's &"keep"& facility.
18443
18444
18445 .option forbid_filter_dlfunc redirect boolean false
18446 .cindex "filter" "locking out certain features"
18447 If this option is true, string expansions in Exim filters are not allowed to
18448 make use of the &%dlfunc%& expansion facility to run dynamically loaded
18449 functions.
18450
18451 .option forbid_filter_existstest redirect boolean false
18452 .cindex "expansion" "statting a file"
18453 If this option is true, string expansions in Exim filters are not allowed to
18454 make use of the &%exists%& condition or the &%stat%& expansion item.
18455
18456 .option forbid_filter_logwrite redirect boolean false
18457 If this option is true, use of the logging facility in Exim filters is not
18458 permitted. Logging is in any case available only if the filter is being run
18459 under some unprivileged uid (which is normally the case for ordinary users'
18460 &_.forward_& files).
18461
18462
18463 .option forbid_filter_lookup redirect boolean false
18464 If this option is true, string expansions in Exim filter files are not allowed
18465 to make use of &%lookup%& items.
18466
18467
18468 .option forbid_filter_perl redirect boolean false
18469 This option has an effect only if Exim is built with embedded Perl support. If
18470 it is true, string expansions in Exim filter files are not allowed to make use
18471 of the embedded Perl support.
18472
18473
18474 .option forbid_filter_readfile redirect boolean false
18475 If this option is true, string expansions in Exim filter files are not allowed
18476 to make use of &%readfile%& items.
18477
18478
18479 .option forbid_filter_readsocket redirect boolean false
18480 If this option is true, string expansions in Exim filter files are not allowed
18481 to make use of &%readsocket%& items.
18482
18483
18484 .option forbid_filter_reply redirect boolean false
18485 If this option is true, this router may not generate an automatic reply
18486 message. Automatic replies can be generated only from Exim or Sieve filter
18487 files, not from traditional forward files. This option is forced to be true if
18488 &%one_time%& is set.
18489
18490
18491 .option forbid_filter_run redirect boolean false
18492 If this option is true, string expansions in Exim filter files are not allowed
18493 to make use of &%run%& items.
18494
18495
18496 .option forbid_include redirect boolean false
18497 If this option is true, items of the form
18498 .code
18499 :include:<path name>
18500 .endd
18501 are not permitted in non-filter redirection lists.
18502
18503
18504 .option forbid_pipe redirect boolean false
18505 .cindex "delivery" "to pipe; forbidding"
18506 If this option is true, this router may not generate a new address which
18507 specifies delivery to a pipe, either from an Exim filter or from a conventional
18508 forward file. This option is forced to be true if &%one_time%& is set.
18509
18510
18511 .option forbid_sieve_filter redirect boolean false
18512 If this option is set true, only Exim filters are permitted when
18513 &%allow_filter%& is true.
18514
18515
18516 .cindex "SMTP" "error codes"
18517 .option forbid_smtp_code redirect boolean false
18518 If this option is set true, any SMTP error codes that are present at the start
18519 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
18520 the default codes (451 and 550, respectively) are always used.
18521
18522
18523
18524
18525 .option hide_child_in_errmsg redirect boolean false
18526 .cindex "bounce message" "redirection details; suppressing"
18527 If this option is true, it prevents Exim from quoting a child address if it
18528 generates a bounce or delay message for it. Instead it says &"an address
18529 generated from <&'the top level address'&>"&. Of course, this applies only to
18530 bounces generated locally. If a message is forwarded to another host, &'its'&
18531 bounce may well quote the generated address.
18532
18533
18534 .option ignore_eacces redirect boolean false
18535 .cindex "EACCES"
18536 If this option is set and an attempt to open a redirection file yields the
18537 EACCES error (permission denied), the &(redirect)& router behaves as if the
18538 file did not exist.
18539
18540
18541 .option ignore_enotdir redirect boolean false
18542 .cindex "ENOTDIR"
18543 If this option is set and an attempt to open a redirection file yields the
18544 ENOTDIR error (something on the path is not a directory), the &(redirect)&
18545 router behaves as if the file did not exist.
18546
18547 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
18548 router that has the &%file%& option set discovers that the file does not exist
18549 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
18550 against unmounted NFS directories. If the parent can not be statted, delivery
18551 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
18552 is set, because that option tells Exim to ignore &"something on the path is not
18553 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
18554 that some operating systems give ENOENT where others give ENOTDIR.
18555
18556
18557
18558 .option include_directory redirect string unset
18559 If this option is set, the path names of any &':include:'& items in a
18560 redirection list must start with this directory.
18561
18562
18563 .option modemask redirect "octal integer" 022
18564 This specifies mode bits which must not be set for a file specified by the
18565 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
18566
18567
18568 .option one_time redirect boolean false
18569 .cindex "one-time aliasing/forwarding expansion"
18570 .cindex "alias file" "one-time expansion"
18571 .cindex "forward file" "one-time expansion"
18572 .cindex "mailing lists" "one-time expansion"
18573 .cindex "address redirection" "one-time expansion"
18574 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
18575 files each time it tries to deliver a message causes a problem when one or more
18576 of the generated addresses fails be delivered at the first attempt. The problem
18577 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
18578 but of what happens when the redirection list changes during the time that the
18579 message is on Exim's queue. This is particularly true in the case of mailing
18580 lists, where new subscribers might receive copies of messages that were posted
18581 before they subscribed.
18582
18583 If &%one_time%& is set and any addresses generated by the router fail to
18584 deliver at the first attempt, the failing addresses are added to the message as
18585 &"top level"& addresses, and the parent address that generated them is marked
18586 &"delivered"&. Thus, redirection does not happen again at the next delivery
18587 attempt.
18588
18589 &*Warning 1*&: Any header line addition or removal that is specified by this
18590 router would be lost if delivery did not succeed at the first attempt. For this
18591 reason, the &%headers_add%& and &%headers_remove%& generic options are not
18592 permitted when &%one_time%& is set.
18593
18594 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
18595 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
18596 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
18597
18598 &*Warning 3*&: The &%unseen%& generic router option may not be set with
18599 &%one_time%&.
18600
18601 The original top-level address is remembered with each of the generated
18602 addresses, and is output in any log messages. However, any intermediate parent
18603 addresses are not recorded. This makes a difference to the log only if
18604 &%all_parents%& log selector is set. It is expected that &%one_time%& will
18605 typically be used for mailing lists, where there is normally just one level of
18606 expansion.
18607
18608
18609 .option owners redirect "string list" unset
18610 .cindex "ownership" "alias file"
18611 .cindex "ownership" "forward file"
18612 .cindex "alias file" "ownership"
18613 .cindex "forward file" "ownership"
18614 This specifies a list of permitted owners for the file specified by &%file%&.
18615 This list is in addition to the local user when &%check_local_user%& is set.
18616 See &%check_owner%& above.
18617
18618
18619 .option owngroups redirect "string list" unset
18620 This specifies a list of permitted groups for the file specified by &%file%&.
18621 The list is in addition to the local user's primary group when
18622 &%check_local_user%& is set. See &%check_group%& above.
18623
18624
18625 .option pipe_transport redirect string&!! unset
18626 .vindex "&$address_pipe$&"
18627 A &(redirect)& router sets up a direct delivery to a pipe when a string
18628 starting with a vertical bar character is specified as a new &"address"&. The
18629 transport used is specified by this option, which, after expansion, must be the
18630 name of a configured transport. This should normally be a &(pipe)& transport.
18631 When the transport is run, the pipe command is in &$address_pipe$&.
18632
18633
18634 .option qualify_domain redirect string&!! unset
18635 .vindex "&$qualify_recipient$&"
18636 If this option is set, and an unqualified address (one without a domain) is
18637 generated, and that address would normally be qualified by the global setting
18638 in &%qualify_recipient%&, it is instead qualified with the domain specified by
18639 expanding this string. If the expansion fails, the router declines. If you want
18640 to revert to the default, you can have the expansion generate
18641 &$qualify_recipient$&.
18642
18643 This option applies to all unqualified addresses generated by Exim filters,
18644 but for traditional &_.forward_& files, it applies only to addresses that are
18645 not preceded by a backslash. Sieve filters cannot generate unqualified
18646 addresses.
18647
18648 .option qualify_preserve_domain redirect boolean false
18649 .cindex "domain" "in redirection; preserving"
18650 .cindex "preserving domain in redirection"
18651 .cindex "address redirection" "domain; preserving"
18652 If this option is set, the router's local &%qualify_domain%& option must not be
18653 set (a configuration error occurs if it is). If an unqualified address (one
18654 without a domain) is generated, it is qualified with the domain of the parent
18655 address (the immediately preceding ancestor) instead of the global
18656 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
18657 this applies whether or not the address is preceded by a backslash.
18658
18659
18660 .option repeat_use redirect boolean true
18661 If this option is set false, the router is skipped for a child address that has
18662 any ancestor that was routed by this router. This test happens before any of
18663 the other preconditions are tested. Exim's default anti-looping rules skip
18664 only when the ancestor is the same as the current address. See also
18665 &%check_ancestor%& above and the generic &%redirect_router%& option.
18666
18667
18668 .option reply_transport redirect string&!! unset
18669 A &(redirect)& router sets up an automatic reply when a &%mail%& or
18670 &%vacation%& command is used in a filter file. The transport used is specified
18671 by this option, which, after expansion, must be the name of a configured
18672 transport. This should normally be an &(autoreply)& transport. Other transports
18673 are unlikely to do anything sensible or useful.
18674
18675
18676 .option rewrite redirect boolean true
18677 .cindex "address redirection" "disabling rewriting"
18678 If this option is set false, addresses generated by the router are not
18679 subject to address rewriting. Otherwise, they are treated like new addresses
18680 and are rewritten according to the global rewriting rules.
18681
18682
18683 .option sieve_subaddress redirect string&!! unset
18684 The value of this option is passed to a Sieve filter to specify the
18685 :subaddress part of an address.
18686
18687 .option sieve_useraddress redirect string&!! unset
18688 The value of this option is passed to a Sieve filter to specify the :user part
18689 of an address. However, if it is unset, the entire original local part
18690 (including any prefix or suffix) is used for :user.
18691
18692
18693 .option sieve_vacation_directory redirect string&!! unset
18694 .cindex "Sieve filter" "vacation directory"
18695 To enable the &"vacation"& extension for Sieve filters, you must set
18696 &%sieve_vacation_directory%& to the directory where vacation databases are held
18697 (do not put anything else in that directory), and ensure that the
18698 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
18699 needs their own directory; Exim will create it if necessary.
18700
18701
18702
18703 .option skip_syntax_errors redirect boolean false
18704 .cindex "forward file" "broken"
18705 .cindex "address redirection" "broken files"
18706 .cindex "alias file" "broken"
18707 .cindex "broken alias or forward files"
18708 .cindex "ignoring faulty addresses"
18709 .cindex "skipping faulty addresses"
18710 .cindex "error" "skipping bad syntax"
18711 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
18712 non-filter redirection data are skipped, and each failing address is logged. If
18713 &%syntax_errors_to%& is set, a message is sent to the address it defines,
18714 giving details of the failures. If &%syntax_errors_text%& is set, its contents
18715 are expanded and placed at the head of the error message generated by
18716 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
18717 be the same address as the generic &%errors_to%& option. The
18718 &%skip_syntax_errors%& option is often used when handling mailing lists.
18719
18720 If all the addresses in a redirection list are skipped because of syntax
18721 errors, the router declines to handle the original address, and it is passed to
18722 the following routers.
18723
18724 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
18725 error in the filter causes filtering to be abandoned without any action being
18726 taken. The incident is logged, and the router declines to handle the address,
18727 so it is passed to the following routers.
18728
18729 .cindex "Sieve filter" "syntax errors in"
18730 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
18731 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
18732 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
18733
18734 &%skip_syntax_errors%& can be used to specify that errors in users' forward
18735 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
18736 option, used with an address that does not get redirected, can be used to
18737 notify users of these errors, by means of a router like this:
18738 .code
18739 userforward:
18740   driver = redirect
18741   allow_filter
18742   check_local_user
18743   file = $home/.forward
18744   file_transport = address_file
18745   pipe_transport = address_pipe
18746   reply_transport = address_reply
18747   no_verify
18748   skip_syntax_errors
18749   syntax_errors_to = real-$local_part@$domain
18750   syntax_errors_text = \
18751    This is an automatically generated message. An error has\n\
18752    been found in your .forward file. Details of the error are\n\
18753    reported below. While this error persists, you will receive\n\
18754    a copy of this message for every message that is addressed\n\
18755    to you. If your .forward file is a filter file, or if it is\n\
18756    a non-filter file containing no valid forwarding addresses,\n\
18757    a copy of each incoming message will be put in your normal\n\
18758    mailbox. If a non-filter file contains at least one valid\n\
18759    forwarding address, forwarding to the valid addresses will\n\
18760    happen, and those will be the only deliveries that occur.
18761 .endd
18762 You also need a router to ensure that local addresses that are prefixed by
18763 &`real-`& are recognized, but not forwarded or filtered. For example, you could
18764 put this immediately before the &(userforward)& router:
18765 .code
18766 real_localuser:
18767   driver = accept
18768   check_local_user
18769   local_part_prefix = real-
18770   transport = local_delivery
18771 .endd
18772 For security, it would probably be a good idea to restrict the use of this
18773 router to locally-generated messages, using a condition such as this:
18774 .code
18775   condition = ${if match {$sender_host_address}\
18776                          {\N^(|127\.0\.0\.1)$\N}}
18777 .endd
18778
18779
18780 .option syntax_errors_text redirect string&!! unset
18781 See &%skip_syntax_errors%& above.
18782
18783
18784 .option syntax_errors_to redirect string unset
18785 See &%skip_syntax_errors%& above.
18786 .ecindex IIDredrou1
18787 .ecindex IIDredrou2
18788
18789
18790
18791
18792
18793
18794 . ////////////////////////////////////////////////////////////////////////////
18795 . ////////////////////////////////////////////////////////////////////////////
18796
18797 .chapter "Environment for running local transports" "CHAPenvironment" &&&
18798          "Environment for local transports"
18799 .scindex IIDenvlotra1 "local transports" "environment for"
18800 .scindex IIDenvlotra2 "environment for local transports"
18801 .scindex IIDenvlotra3 "transport" "local; environment for"
18802 Local transports handle deliveries to files and pipes. (The &(autoreply)&
18803 transport can be thought of as similar to a pipe.) Exim always runs transports
18804 in subprocesses, under specified uids and gids. Typical deliveries to local
18805 mailboxes run under the uid and gid of the local user.
18806
18807 Exim also sets a specific current directory while running the transport; for
18808 some transports a home directory setting is also relevant. The &(pipe)&
18809 transport is the only one that sets up environment variables; see section
18810 &<<SECTpipeenv>>& for details.
18811
18812 The values used for the uid, gid, and the directories may come from several
18813 different places. In many cases, the router that handles the address associates
18814 settings with that address as a result of its &%check_local_user%&, &%group%&,
18815 or &%user%& options. However, values may also be given in the transport's own
18816 configuration, and these override anything that comes from the router.
18817
18818
18819
18820 .section "Concurrent deliveries" "SECID131"
18821 .cindex "concurrent deliveries"
18822 .cindex "simultaneous deliveries"
18823 If two different messages for the same local recipient arrive more or less
18824 simultaneously, the two delivery processes are likely to run concurrently. When
18825 the &(appendfile)& transport is used to write to a file, Exim applies locking
18826 rules to stop concurrent processes from writing to the same file at the same
18827 time.
18828
18829 However, when you use a &(pipe)& transport, it is up to you to arrange any
18830 locking that is needed. Here is a silly example:
18831 .code
18832 my_transport:
18833   driver = pipe
18834   command = /bin/sh -c 'cat >>/some/file'
18835 .endd
18836 This is supposed to write the message at the end of the file. However, if two
18837 messages arrive at the same time, the file will be scrambled. You can use the
18838 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
18839 file using the same algorithm that Exim itself uses.
18840
18841
18842
18843
18844 .section "Uids and gids" "SECTenvuidgid"
18845 .cindex "local transports" "uid and gid"
18846 .cindex "transport" "local; uid and gid"
18847 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
18848 overrides any group that the router set in the address, even if &%user%& is not
18849 set for the transport. This makes it possible, for example, to run local mail
18850 delivery under the uid of the recipient (set by the router), but in a special
18851 group (set by the transport). For example:
18852 .code
18853 # Routers ...
18854 # User/group are set by check_local_user in this router
18855 local_users:
18856   driver = accept
18857   check_local_user
18858   transport = group_delivery
18859
18860 # Transports ...
18861 # This transport overrides the group
18862 group_delivery:
18863   driver = appendfile
18864   file = /var/spool/mail/$local_part
18865   group = mail
18866 .endd
18867 If &%user%& is set for a transport, its value overrides what is set in the
18868 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
18869 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
18870 set.
18871
18872 .oindex "&%initgroups%&"
18873 When the uid is taken from the transport's configuration, the &[initgroups()]&
18874 function is called for the groups associated with that uid if the
18875 &%initgroups%& option is set for the transport. When the uid is not specified
18876 by the transport, but is associated with the address by a router, the option
18877 for calling &[initgroups()]& is taken from the router configuration.
18878
18879 .cindex "&(pipe)& transport" "uid for"
18880 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
18881 is set and &%user%& is not set, the uid of the process that called Exim to
18882 receive the message is used, and if &%group%& is not set, the corresponding
18883 original gid is also used.
18884
18885 This is the detailed preference order for obtaining a gid; the first of the
18886 following that is set is used:
18887
18888 .ilist
18889 A &%group%& setting of the transport;
18890 .next
18891 A &%group%& setting of the router;
18892 .next
18893 A gid associated with a user setting of the router, either as a result of
18894 &%check_local_user%& or an explicit non-numeric &%user%& setting;
18895 .next
18896 The group associated with a non-numeric &%user%& setting of the transport;
18897 .next
18898 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
18899 the uid is the creator's uid;
18900 .next
18901 The Exim gid if the Exim uid is being used as a default.
18902 .endlist
18903
18904 If, for example, the user is specified numerically on the router and there are
18905 no group settings, no gid is available. In this situation, an error occurs.
18906 This is different for the uid, for which there always is an ultimate default.
18907 The first of the following that is set is used:
18908
18909 .ilist
18910 A &%user%& setting of the transport;
18911 .next
18912 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
18913 .next
18914 A &%user%& setting of the router;
18915 .next
18916 A &%check_local_user%& setting of the router;
18917 .next
18918 The Exim uid.
18919 .endlist
18920
18921 Of course, an error will still occur if the uid that is chosen is on the
18922 &%never_users%& list.
18923
18924
18925
18926
18927
18928 .section "Current and home directories" "SECID132"
18929 .cindex "current directory for local transport"
18930 .cindex "home directory" "for local transport"
18931 .cindex "transport" "local; home directory for"
18932 .cindex "transport" "local; current directory for"
18933 Routers may set current and home directories for local transports by means of
18934 the &%transport_current_directory%& and &%transport_home_directory%& options.
18935 However, if the transport's &%current_directory%& or &%home_directory%& options
18936 are set, they override the router's values. In detail, the home directory
18937 for a local transport is taken from the first of these values that is set:
18938
18939 .ilist
18940 The &%home_directory%& option on the transport;
18941 .next
18942 The &%transport_home_directory%& option on the router;
18943 .next
18944 The password data if &%check_local_user%& is set on the router;
18945 .next
18946 The &%router_home_directory%& option on the router.
18947 .endlist
18948
18949 The current directory is taken from the first of these values that is set:
18950
18951 .ilist
18952 The &%current_directory%& option on the transport;
18953 .next
18954 The &%transport_current_directory%& option on the router.
18955 .endlist
18956
18957
18958 If neither the router nor the transport sets a current directory, Exim uses the
18959 value of the home directory, if it is set. Otherwise it sets the current
18960 directory to &_/_& before running a local transport.
18961
18962
18963
18964 .section "Expansion variables derived from the address" "SECID133"
18965 .vindex "&$domain$&"
18966 .vindex "&$local_part$&"
18967 .vindex "&$original_domain$&"
18968 Normally a local delivery is handling a single address, and in that case the
18969 variables such as &$domain$& and &$local_part$& are set during local
18970 deliveries. However, in some circumstances more than one address may be handled
18971 at once (for example, while writing batch SMTP for onward transmission by some
18972 other means). In this case, the variables associated with the local part are
18973 never set, &$domain$& is set only if all the addresses have the same domain,
18974 and &$original_domain$& is never set.
18975 .ecindex IIDenvlotra1
18976 .ecindex IIDenvlotra2
18977 .ecindex IIDenvlotra3
18978
18979
18980
18981
18982
18983
18984
18985 . ////////////////////////////////////////////////////////////////////////////
18986 . ////////////////////////////////////////////////////////////////////////////
18987
18988 .chapter "Generic options for transports" "CHAPtransportgeneric"
18989 .scindex IIDgenoptra1 "generic options" "transport"
18990 .scindex IIDgenoptra2 "options" "generic; for transports"
18991 .scindex IIDgenoptra3 "transport" "generic options for"
18992 The following generic options apply to all transports:
18993
18994
18995 .option body_only transports boolean false
18996 .cindex "transport" "body only"
18997 .cindex "message" "transporting body only"
18998 .cindex "body of message" "transporting"
18999 If this option is set, the message's headers are not transported. It is
19000 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
19001 or &(pipe)& transports, the settings of &%message_prefix%& and
19002 &%message_suffix%& should be checked, because this option does not
19003 automatically suppress them.
19004
19005
19006 .option current_directory transports string&!! unset
19007 .cindex "transport" "current directory for"
19008 This specifies the current directory that is to be set while running the
19009 transport, overriding any value that may have been set by the router.
19010 If the expansion fails for any reason, including forced failure, an error is
19011 logged, and delivery is deferred.
19012
19013
19014 .option disable_logging transports boolean false
19015 If this option is set true, nothing is logged for any
19016 deliveries by the transport or for any
19017 transport errors. You should not set this option unless you really, really know
19018 what you are doing.
19019
19020
19021 .option debug_print transports string&!! unset
19022 .cindex "testing" "variables in drivers"
19023 If this option is set and debugging is enabled (see the &%-d%& command line
19024 option), the string is expanded and included in the debugging output when the
19025 transport is run.
19026 If expansion of the string fails, the error message is written to the debugging
19027 output, and Exim carries on processing.
19028 This facility is provided to help with checking out the values of variables and
19029 so on when debugging driver configurations. For example, if a &%headers_add%&
19030 option is not working properly, &%debug_print%& could be used to output the
19031 variables it references. A newline is added to the text if it does not end with
19032 one.
19033
19034
19035 .option delivery_date_add transports boolean false
19036 .cindex "&'Delivery-date:'& header line"
19037 If this option is true, a &'Delivery-date:'& header is added to the message.
19038 This gives the actual time the delivery was made. As this is not a standard
19039 header, Exim has a configuration option (&%delivery_date_remove%&) which
19040 requests its removal from incoming messages, so that delivered messages can
19041 safely be resent to other recipients.
19042
19043
19044 .option driver transports string unset
19045 This specifies which of the available transport drivers is to be used.
19046 There is no default, and this option must be set for every transport.
19047
19048
19049 .option envelope_to_add transports boolean false
19050 .cindex "&'Envelope-to:'& header line"
19051 If this option is true, an &'Envelope-to:'& header is added to the message.
19052 This gives the original address(es) in the incoming envelope that caused this
19053 delivery to happen. More than one address may be present if the transport is
19054 configured to handle several addresses at once, or if more than one original
19055 address was redirected to the same final address. As this is not a standard
19056 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
19057 its removal from incoming messages, so that delivered messages can safely be
19058 resent to other recipients.
19059
19060
19061 .option group transports string&!! "Exim group"
19062 .cindex "transport" "group; specifying"
19063 This option specifies a gid for running the transport process, overriding any
19064 value that the router supplies, and also overriding any value associated with
19065 &%user%& (see below).
19066
19067
19068 .option headers_add transports string&!! unset
19069 .cindex "header lines" "adding in transport"
19070 .cindex "transport" "header lines; adding"
19071 This option specifies a string of text that is expanded and added to the header
19072 portion of a message as it is transported, as described in section
19073 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
19074 routers. If the result of the expansion is an empty string, or if the expansion
19075 is forced to fail, no action is taken. Other expansion failures are treated as
19076 errors and cause the delivery to be deferred.
19077
19078
19079
19080 .option headers_only transports boolean false
19081 .cindex "transport" "header lines only"
19082 .cindex "message" "transporting headers only"
19083 .cindex "header lines" "transporting"
19084 If this option is set, the message's body is not transported. It is mutually
19085 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
19086 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
19087 checked, since this option does not automatically suppress them.
19088
19089
19090 .option headers_remove transports string&!! unset
19091 .cindex "header lines" "removing"
19092 .cindex "transport" "header lines; removing"
19093 This option specifies a string that is expanded into a list of header names;
19094 these headers are omitted from the message as it is transported, as described
19095 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
19096 routers. If the result of the expansion is an empty string, or if the expansion
19097 is forced to fail, no action is taken. Other expansion failures are treated as
19098 errors and cause the delivery to be deferred.
19099
19100
19101
19102 .option headers_rewrite transports string unset
19103 .cindex "transport" "header lines; rewriting"
19104 .cindex "rewriting" "at transport time"
19105 This option allows addresses in header lines to be rewritten at transport time,
19106 that is, as the message is being copied to its destination. The contents of the
19107 option are a colon-separated list of rewriting rules. Each rule is in exactly
19108 the same form as one of the general rewriting rules that are applied when a
19109 message is received. These are described in chapter &<<CHAPrewrite>>&. For
19110 example,
19111 .code
19112 headers_rewrite = a@b c@d f : \
19113                   x@y w@z
19114 .endd
19115 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
19116 &'w@z'& in all address-bearing header lines. The rules are applied to the
19117 header lines just before they are written out at transport time, so they affect
19118 only those copies of the message that pass through the transport. However, only
19119 the message's original header lines, and any that were added by a system
19120 filter, are rewritten. If a router or transport adds header lines, they are not
19121 affected by this option. These rewriting rules are &'not'& applied to the
19122 envelope. You can change the return path using &%return_path%&, but you cannot
19123 change envelope recipients at this time.
19124
19125
19126 .option home_directory transports string&!! unset
19127 .cindex "transport" "home directory for"
19128 .vindex "&$home$&"
19129 This option specifies a home directory setting for a local transport,
19130 overriding any value that may be set by the router. The home directory is
19131 placed in &$home$& while expanding the transport's private options. It is also
19132 used as the current directory if no current directory is set by the
19133 &%current_directory%& option on the transport or the
19134 &%transport_current_directory%& option on the router. If the expansion fails
19135 for any reason, including forced failure, an error is logged, and delivery is
19136 deferred.
19137
19138
19139 .option initgroups transports boolean false
19140 .cindex "additional groups"
19141 .cindex "groups" "additional"
19142 .cindex "transport" "group; additional"
19143 If this option is true and the uid for the delivery process is provided by the
19144 transport, the &[initgroups()]& function is called when running the transport
19145 to ensure that any additional groups associated with the uid are set up.
19146
19147
19148 .option message_size_limit transports string&!! 0
19149 .cindex "limit" "message size per transport"
19150 .cindex "size" "of message, limit"
19151 .cindex "transport" "message size; limiting"
19152 This option controls the size of messages passed through the transport. It is
19153 expanded before use; the result of the expansion must be a sequence of decimal
19154 digits, optionally followed by K or M. If the expansion fails for any reason,
19155 including forced failure, or if the result is not of the required form,
19156 delivery is deferred. If the value is greater than zero and the size of a
19157 message exceeds this limit, the address is failed. If there is any chance that
19158 the resulting bounce message could be routed to the same transport, you should
19159 ensure that &%return_size_limit%& is less than the transport's
19160 &%message_size_limit%&, as otherwise the bounce message will fail to get
19161 delivered.
19162
19163
19164
19165 .option rcpt_include_affixes transports boolean false
19166 .cindex "prefix" "for local part, including in envelope"
19167 .cindex "suffix for local part" "including in envelope"
19168 .cindex "local part" "prefix"
19169 .cindex "local part" "suffix"
19170 When this option is false (the default), and an address that has had any
19171 affixes (prefixes or suffixes) removed from the local part is delivered by any
19172 form of SMTP or LMTP, the affixes are not included. For example, if a router
19173 that contains
19174 .code
19175 local_part_prefix = *-
19176 .endd
19177 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19178 is delivered with
19179 .code
19180 RCPT TO:<xyz@some.domain>
19181 .endd
19182 This is also the case when an ACL-time callout is being used to verify a
19183 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19184 whole local part is included in the RCPT command. This option applies to BSMTP
19185 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19186 &(lmtp)& and &(smtp)& transports.
19187
19188
19189 .option retry_use_local_part transports boolean "see below"
19190 .cindex "hints database" "retry keys"
19191 When a delivery suffers a temporary failure, a retry record is created
19192 in Exim's hints database. For remote deliveries, the key for the retry record
19193 is based on the name and/or IP address of the failing remote host. For local
19194 deliveries, the key is normally the entire address, including both the local
19195 part and the domain. This is suitable for most common cases of local delivery
19196 temporary failure &-- for example, exceeding a mailbox quota should delay only
19197 deliveries to that mailbox, not to the whole domain.
19198
19199 However, in some special cases you may want to treat a temporary local delivery
19200 as a failure associated with the domain, and not with a particular local part.
19201 (For example, if you are storing all mail for some domain in files.) You can do
19202 this by setting &%retry_use_local_part%& false.
19203
19204 For all the local transports, its default value is true. For remote transports,
19205 the default value is false for tidiness, but changing the value has no effect
19206 on a remote transport in the current implementation.
19207
19208
19209 .option return_path transports string&!! unset
19210 .cindex "envelope sender"
19211 .cindex "transport" "return path; changing"
19212 .cindex "return path" "changing in transport"
19213 If this option is set, the string is expanded at transport time and replaces
19214 the existing return path (envelope sender) value in the copy of the message
19215 that is being delivered. An empty return path is permitted. This feature is
19216 designed for remote deliveries, where the value of this option is used in the
19217 SMTP MAIL command. If you set &%return_path%& for a local transport, the
19218 only effect is to change the address that is placed in the &'Return-path:'&
19219 header line, if one is added to the message (see the next option).
19220
19221 &*Note:*& A changed return path is not logged unless you add
19222 &%return_path_on_delivery%& to the log selector.
19223
19224 .vindex "&$return_path$&"
19225 The expansion can refer to the existing value via &$return_path$&. This is
19226 either the message's envelope sender, or an address set by the
19227 &%errors_to%& option on a router. If the expansion is forced to fail, no
19228 replacement occurs; if it fails for another reason, delivery is deferred. This
19229 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19230 section &<<SECTverp>>&.
19231
19232 &*Note*&: If a delivery error is detected locally, including the case when a
19233 remote server rejects a message at SMTP time, the bounce message is not sent to
19234 the value of this option. It is sent to the previously set errors address.
19235 This defaults to the incoming sender address, but can be changed by setting
19236 &%errors_to%& in a router.
19237
19238
19239
19240 .option return_path_add transports boolean false
19241 .cindex "&'Return-path:'& header line"
19242 If this option is true, a &'Return-path:'& header is added to the message.
19243 Although the return path is normally available in the prefix line of BSD
19244 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19245 have easy access to it.
19246
19247 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19248 the delivery SMTP server makes the final delivery"&. This implies that this
19249 header should not be present in incoming messages. Exim has a configuration
19250 option, &%return_path_remove%&, which requests removal of this header from
19251 incoming messages, so that delivered messages can safely be resent to other
19252 recipients.
19253
19254
19255 .option shadow_condition transports string&!! unset
19256 See &%shadow_transport%& below.
19257
19258
19259 .option shadow_transport transports string unset
19260 .cindex "shadow transport"
19261 .cindex "transport" "shadow"
19262 A local transport may set the &%shadow_transport%& option to the name of
19263 another local transport. Shadow remote transports are not supported.
19264
19265 Whenever a delivery to the main transport succeeds, and either
19266 &%shadow_condition%& is unset, or its expansion does not result in the empty
19267 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
19268 passed to the shadow transport, with the same delivery address or addresses. If
19269 expansion fails, no action is taken except that non-forced expansion failures
19270 cause a log line to be written.
19271
19272 The result of the shadow transport is discarded and does not affect the
19273 subsequent processing of the message. Only a single level of shadowing is
19274 provided; the &%shadow_transport%& option is ignored on any transport when it
19275 is running as a shadow. Options concerned with output from pipes are also
19276 ignored. The log line for the successful delivery has an item added on the end,
19277 of the form
19278 .code
19279 ST=<shadow transport name>
19280 .endd
19281 If the shadow transport did not succeed, the error message is put in
19282 parentheses afterwards. Shadow transports can be used for a number of different
19283 purposes, including keeping more detailed log information than Exim normally
19284 provides, and implementing automatic acknowledgment policies based on message
19285 headers that some sites insist on.
19286
19287
19288 .option transport_filter transports string&!! unset
19289 .cindex "transport" "filter"
19290 .cindex "filter" "transport filter"
19291 This option sets up a filtering (in the Unix shell sense) process for messages
19292 at transport time. It should not be confused with mail filtering as set up by
19293 individual users or via a system filter.
19294
19295 When the message is about to be written out, the command specified by
19296 &%transport_filter%& is started up in a separate, parallel process, and
19297 the entire message, including the header lines, is passed to it on its standard
19298 input (this in fact is done from a third process, to avoid deadlock). The
19299 command must be specified as an absolute path.
19300
19301 The lines of the message that are written to the transport filter are
19302 terminated by newline (&"\n"&). The message is passed to the filter before any
19303 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
19304 lines beginning with a dot, and also before any processing implied by the
19305 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
19306 &(pipe)& transports.
19307
19308 The standard error for the filter process is set to the same destination as its
19309 standard output; this is read and written to the message's ultimate
19310 destination. The process that writes the message to the filter, the
19311 filter itself, and the original process that reads the result and delivers it
19312 are all run in parallel, like a shell pipeline.
19313
19314 The filter can perform any transformations it likes, but of course should take
19315 care not to break RFC 2822 syntax. Exim does not check the result, except to
19316 test for a final newline when SMTP is in use. All messages transmitted over
19317 SMTP must end with a newline, so Exim supplies one if it is missing.
19318
19319 .cindex "content scanning" "per user"
19320 A transport filter can be used to provide content-scanning on a per-user basis
19321 at delivery time if the only required effect of the scan is to modify the
19322 message. For example, a content scan could insert a new header line containing
19323 a spam score. This could be interpreted by a filter in the user's MUA. It is
19324 not possible to discard a message at this stage.
19325
19326 .cindex "SMTP" "SIZE"
19327 A problem might arise if the filter increases the size of a message that is
19328 being sent down an SMTP connection. If the receiving SMTP server has indicated
19329 support for the SIZE parameter, Exim will have sent the size of the message
19330 at the start of the SMTP session. If what is actually sent is substantially
19331 more, the server might reject the message. This can be worked round by setting
19332 the &%size_addition%& option on the &(smtp)& transport, either to allow for
19333 additions to the message, or to disable the use of SIZE altogether.
19334
19335 .vindex "&$pipe_addresses$&"
19336 The value of the &%transport_filter%& option is the command string for starting
19337 the filter, which is run directly from Exim, not under a shell. The string is
19338 parsed by Exim in the same way as a command string for the &(pipe)& transport:
19339 Exim breaks it up into arguments and then expands each argument separately (see
19340 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
19341 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
19342 of arguments, one for each address that applies to this delivery. (This isn't
19343 an ideal name for this feature here, but as it was already implemented for the
19344 &(pipe)& transport, it seemed sensible not to change it.)
19345
19346 .vindex "&$host$&"
19347 .vindex "&$host_address$&"
19348 The expansion variables &$host$& and &$host_address$& are available when the
19349 transport is a remote one. They contain the name and IP address of the host to
19350 which the message is being sent. For example:
19351 .code
19352 transport_filter = /some/directory/transport-filter.pl \
19353   $host $host_address $sender_address $pipe_addresses
19354 .endd
19355
19356 Two problems arise if you want to use more complicated expansion items to
19357 generate transport filter commands, both of which due to the fact that the
19358 command is split up &'before'& expansion.
19359 .ilist
19360 If an expansion item contains white space, you must quote it, so that it is all
19361 part of the same command item. If the entire option setting is one such
19362 expansion item, you have to take care what kind of quoting you use. For
19363 example:
19364 .code
19365 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
19366 .endd
19367 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
19368 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
19369 stripped by Exim when it read the option's value. When the value is used, if
19370 the single quotes were missing, the line would be split into two items,
19371 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
19372 Exim tried to expand the first one.
19373 .next
19374 Except for the special case of &$pipe_addresses$& that is mentioned above, an
19375 expansion cannot generate multiple arguments, or a command name followed by
19376 arguments. Consider this example:
19377 .code
19378 transport_filter = ${lookup{$host}lsearch{/a/file}\
19379                     {$value}{/bin/cat}}
19380 .endd
19381 The result of the lookup is interpreted as the name of the command, even
19382 if it contains white space. The simplest way round this is to use a shell:
19383 .code
19384 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
19385                                {$value}{/bin/cat}}
19386 .endd
19387 .endlist
19388
19389 The filter process is run under the same uid and gid as the normal delivery.
19390 For remote deliveries this is the Exim uid/gid by default. The command should
19391 normally yield a zero return code. Transport filters are not supposed to fail.
19392 A non-zero code is taken to mean that the transport filter encountered some
19393 serious problem. Delivery of the message is deferred; the message remains on
19394 the queue and is tried again later. It is not possible to cause a message to be
19395 bounced from a transport filter.
19396
19397 If a transport filter is set on an autoreply transport, the original message is
19398 passed through the filter as it is being copied into the newly generated
19399 message, which happens if the &%return_message%& option is set.
19400
19401
19402 .option transport_filter_timeout transports time 5m
19403 .cindex "transport" "filter, timeout"
19404 When Exim is reading the output of a transport filter, it a applies a timeout
19405 that can be set by this option. Exceeding the timeout is normally treated as a
19406 temporary delivery failure. However, if a transport filter is used with a
19407 &(pipe)& transport, a timeout in the transport filter is treated in the same
19408 way as a timeout in the pipe command itself. By default, a timeout is a hard
19409 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
19410 becomes a temporary error.
19411
19412
19413 .option user transports string&!! "Exim user"
19414 .cindex "uid (user id)" "local delivery"
19415 .cindex "transport" "user, specifying"
19416 This option specifies the user under whose uid the delivery process is to be
19417 run, overriding any uid that may have been set by the router. If the user is
19418 given as a name, the uid is looked up from the password data, and the
19419 associated group is taken as the value of the gid to be used if the &%group%&
19420 option is not set.
19421
19422 For deliveries that use local transports, a user and group are normally
19423 specified explicitly or implicitly (for example, as a result of
19424 &%check_local_user%&) by the router or transport.
19425
19426 .cindex "hints database" "access by remote transport"
19427 For remote transports, you should leave this option unset unless you really are
19428 sure you know what you are doing. When a remote transport is running, it needs
19429 to be able to access Exim's hints databases, because each host may have its own
19430 retry data.
19431 .ecindex IIDgenoptra1
19432 .ecindex IIDgenoptra2
19433 .ecindex IIDgenoptra3
19434
19435
19436
19437
19438
19439
19440 . ////////////////////////////////////////////////////////////////////////////
19441 . ////////////////////////////////////////////////////////////////////////////
19442
19443 .chapter "Address batching in local transports" "CHAPbatching" &&&
19444          "Address batching"
19445 .cindex "transport" "local; address batching in"
19446 The only remote transport (&(smtp)&) is normally configured to handle more than
19447 one address at a time, so that when several addresses are routed to the same
19448 remote host, just one copy of the message is sent. Local transports, however,
19449 normally handle one address at a time. That is, a separate instance of the
19450 transport is run for each address that is routed to the transport. A separate
19451 copy of the message is delivered each time.
19452
19453 .cindex "batched local delivery"
19454 .oindex "&%batch_max%&"
19455 .oindex "&%batch_id%&"
19456 In special cases, it may be desirable to handle several addresses at once in a
19457 local transport, for example:
19458
19459 .ilist
19460 In an &(appendfile)& transport, when storing messages in files for later
19461 delivery by some other means, a single copy of the message with multiple
19462 recipients saves space.
19463 .next
19464 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
19465 a single copy saves time, and is the normal way LMTP is expected to work.
19466 .next
19467 In a &(pipe)& transport, when passing the message
19468 to a scanner program or
19469 to some other delivery mechanism such as UUCP, multiple recipients may be
19470 acceptable.
19471 .endlist
19472
19473 These three local transports all have the same options for controlling multiple
19474 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
19475 repeating the information for each transport, these options are described here.
19476
19477 The &%batch_max%& option specifies the maximum number of addresses that can be
19478 delivered together in a single run of the transport. Its default value is one
19479 (no batching). When more than one address is routed to a transport that has a
19480 &%batch_max%& value greater than one, the addresses are delivered in a batch
19481 (that is, in a single run of the transport with multiple recipients), subject
19482 to certain conditions:
19483
19484 .ilist
19485 .vindex "&$local_part$&"
19486 If any of the transport's options contain a reference to &$local_part$&, no
19487 batching is possible.
19488 .next
19489 .vindex "&$domain$&"
19490 If any of the transport's options contain a reference to &$domain$&, only
19491 addresses with the same domain are batched.
19492 .next
19493 .cindex "customizing" "batching condition"
19494 If &%batch_id%& is set, it is expanded for each address, and only those
19495 addresses with the same expanded value are batched. This allows you to specify
19496 customized batching conditions. Failure of the expansion for any reason,
19497 including forced failure, disables batching, but it does not stop the delivery
19498 from taking place.
19499 .next
19500 Batched addresses must also have the same errors address (where to send
19501 delivery errors), the same header additions and removals, the same user and
19502 group for the transport, and if a host list is present, the first host must
19503 be the same.
19504 .endlist
19505
19506 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
19507 both when the file or pipe command is specified in the transport, and when it
19508 is specified by a &(redirect)& router, but all the batched addresses must of
19509 course be routed to the same file or pipe command. These two transports have an
19510 option called &%use_bsmtp%&, which causes them to deliver the message in
19511 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
19512 &%check_string%& and &%escape_string%& options are forced to the values
19513 .code
19514 check_string = "."
19515 escape_string = ".."
19516 .endd
19517 when batched SMTP is in use. A full description of the batch SMTP mechanism is
19518 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
19519 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
19520
19521 .cindex "&'Envelope-to:'& header line"
19522 If the generic &%envelope_to_add%& option is set for a batching transport, the
19523 &'Envelope-to:'& header that is added to the message contains all the addresses
19524 that are being processed together. If you are using a batching &(appendfile)&
19525 transport without &%use_bsmtp%&, the only way to preserve the recipient
19526 addresses is to set the &%envelope_to_add%& option.
19527
19528 .cindex "&(pipe)& transport" "with multiple addresses"
19529 .vindex "&$pipe_addresses$&"
19530 If you are using a &(pipe)& transport without BSMTP, and setting the
19531 transport's &%command%& option, you can include &$pipe_addresses$& as part of
19532 the command. This is not a true variable; it is a bit of magic that causes each
19533 of the recipient addresses to be inserted into the command as a separate
19534 argument. This provides a way of accessing all the addresses that are being
19535 delivered in the batch. &*Note:*& This is not possible for pipe commands that
19536 are specified by a &(redirect)& router.
19537
19538
19539
19540
19541 . ////////////////////////////////////////////////////////////////////////////
19542 . ////////////////////////////////////////////////////////////////////////////
19543
19544 .chapter "The appendfile transport" "CHAPappendfile"
19545 .scindex IIDapptra1 "&(appendfile)& transport"
19546 .scindex IIDapptra2 "transports" "&(appendfile)&"
19547 .cindex "directory creation"
19548 .cindex "creating directories"
19549 The &(appendfile)& transport delivers a message by appending it to an existing
19550 file, or by creating an entirely new file in a specified directory. Single
19551 files to which messages are appended can be in the traditional Unix mailbox
19552 format, or optionally in the MBX format supported by the Pine MUA and
19553 University of Washington IMAP daemon, &'inter alia'&. When each message is
19554 being delivered as a separate file, &"maildir"& format can optionally be used
19555 to give added protection against failures that happen part-way through the
19556 delivery. A third form of separate-file delivery known as &"mailstore"& is also
19557 supported. For all file formats, Exim attempts to create as many levels of
19558 directory as necessary, provided that &%create_directory%& is set.
19559
19560 The code for the optional formats is not included in the Exim binary by
19561 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
19562 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
19563 included.
19564
19565 .cindex "quota" "system"
19566 Exim recognizes system quota errors, and generates an appropriate message. Exim
19567 also supports its own quota control within the transport, for use when the
19568 system facility is unavailable or cannot be used for some reason.
19569
19570 If there is an error while appending to a file (for example, quota exceeded or
19571 partition filled), Exim attempts to reset the file's length and last
19572 modification time back to what they were before. If there is an error while
19573 creating an entirely new file, the new file is removed.
19574
19575 Before appending to a file, a number of security checks are made, and the
19576 file is locked. A detailed description is given below, after the list of
19577 private options.
19578
19579 The &(appendfile)& transport is most commonly used for local deliveries to
19580 users' mailboxes. However, it can also be used as a pseudo-remote transport for
19581 putting messages into files for remote delivery by some means other than Exim.
19582 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
19583 option).
19584
19585
19586
19587 .section "The file and directory options" "SECTfildiropt"
19588 The &%file%& option specifies a single file, to which the message is appended;
19589 the &%directory%& option specifies a directory, in which a new file containing
19590 the message is created. Only one of these two options can be set, and for
19591 normal deliveries to mailboxes, one of them &'must'& be set.
19592
19593 .vindex "&$address_file$&"
19594 .vindex "&$local_part$&"
19595 However, &(appendfile)& is also used for delivering messages to files or
19596 directories whose names (or parts of names) are obtained from alias,
19597 forwarding, or filtering operations (for example, a &%save%& command in a
19598 user's Exim filter). When such a transport is running, &$local_part$& contains
19599 the local part that was aliased or forwarded, and &$address_file$& contains the
19600 name (or partial name) of the file or directory generated by the redirection
19601 operation. There are two cases:
19602
19603 .ilist
19604 If neither &%file%& nor &%directory%& is set, the redirection operation
19605 must specify an absolute path (one that begins with &`/`&). This is the most
19606 common case when users with local accounts use filtering to sort mail into
19607 different folders. See for example, the &(address_file)& transport in the
19608 default configuration. If the path ends with a slash, it is assumed to be the
19609 name of a directory. A delivery to a directory can also be forced by setting
19610 &%maildir_format%& or &%mailstore_format%&.
19611 .next
19612 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
19613 used to determine the file or directory name for the delivery. Normally, the
19614 contents of &$address_file$& are used in some way in the string expansion.
19615 .endlist
19616
19617
19618 .cindex "Sieve filter" "configuring &(appendfile)&"
19619 .cindex "Sieve filter" "relative mailbox path handling"
19620 As an example of the second case, consider an environment where users do not
19621 have home directories. They may be permitted to use Exim filter commands of the
19622 form:
19623 .code
19624 save folder23
19625 .endd
19626 or Sieve filter commands of the form:
19627 .code
19628 require "fileinto";
19629 fileinto "folder23";
19630 .endd
19631 In this situation, the expansion of &%file%& or &%directory%& in the transport
19632 must transform the relative path into an appropriate absolute file name. In the
19633 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
19634 is used as a result of a &"keep"& action in the filter. This example shows one
19635 way of handling this requirement:
19636 .code
19637 file = ${if eq{$address_file}{inbox} \
19638             {/var/mail/$local_part} \
19639             {${if eq{${substr_0_1:$address_file}}{/} \
19640                   {$address_file} \
19641                   {$home/mail/$address_file} \
19642             }} \
19643        }
19644 .endd
19645 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
19646 location, absolute paths are used without change, and other folders are in the
19647 &_mail_& directory within the home directory.
19648
19649 &*Note 1*&: While processing an Exim filter, a relative path such as
19650 &_folder23_& is turned into an absolute path if a home directory is known to
19651 the router. In particular, this is the case if &%check_local_user%& is set. If
19652 you want to prevent this happening at routing time, you can set
19653 &%router_home_directory%& empty. This forces the router to pass the relative
19654 path to the transport.
19655
19656 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
19657 the &%file%& or &%directory%& option is still used if it is set.
19658
19659
19660
19661
19662 .section "Private options for appendfile" "SECID134"
19663 .cindex "options" "&(appendfile)& transport"
19664
19665
19666
19667 .option allow_fifo appendfile boolean false
19668 .cindex "fifo (named pipe)"
19669 .cindex "named pipe (fifo)"
19670 .cindex "pipe" "named (fifo)"
19671 Setting this option permits delivery to named pipes (FIFOs) as well as to
19672 regular files. If no process is reading the named pipe at delivery time, the
19673 delivery is deferred.
19674
19675
19676 .option allow_symlink appendfile boolean false
19677 .cindex "symbolic link" "to mailbox"
19678 .cindex "mailbox" "symbolic link"
19679 By default, &(appendfile)& will not deliver if the path name for the file is
19680 that of a symbolic link. Setting this option relaxes that constraint, but there
19681 are security issues involved in the use of symbolic links. Be sure you know
19682 what you are doing if you set this. Details of exactly what this option affects
19683 are included in the discussion which follows this list of options.
19684
19685
19686 .option batch_id appendfile string&!! unset
19687 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19688 However, batching is automatically disabled for &(appendfile)& deliveries that
19689 happen as a result of forwarding or aliasing or other redirection directly to a
19690 file.
19691
19692
19693 .option batch_max appendfile integer 1
19694 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19695
19696
19697 .option check_group appendfile boolean false
19698 When this option is set, the group owner of the file defined by the &%file%&
19699 option is checked to see that it is the same as the group under which the
19700 delivery process is running. The default setting is false because the default
19701 file mode is 0600, which means that the group is irrelevant.
19702
19703
19704 .option check_owner appendfile boolean true
19705 When this option is set, the owner of the file defined by the &%file%& option
19706 is checked to ensure that it is the same as the user under which the delivery
19707 process is running.
19708
19709
19710 .option check_string appendfile string "see below"
19711 .cindex "&""From""& line"
19712 As &(appendfile)& writes the message, the start of each line is tested for
19713 matching &%check_string%&, and if it does, the initial matching characters are
19714 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
19715 a literal string, not a regular expression, and the case of any letters it
19716 contains is significant.
19717
19718 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
19719 are forced to &"."& and &".."& respectively, and any settings in the
19720 configuration are ignored. Otherwise, they default to &"From&~"& and
19721 &">From&~"& when the &%file%& option is set, and unset when any of the
19722 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
19723
19724 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
19725 suitable for traditional &"BSD"& mailboxes, where a line beginning with
19726 &"From&~"& indicates the start of a new message. All four options need changing
19727 if another format is used. For example, to deliver to mailboxes in MMDF format:
19728 .cindex "MMDF format mailbox"
19729 .cindex "mailbox" "MMDF format"
19730 .code
19731 check_string = "\1\1\1\1\n"
19732 escape_string = "\1\1\1\1 \n"
19733 message_prefix = "\1\1\1\1\n"
19734 message_suffix = "\1\1\1\1\n"
19735 .endd
19736 .option create_directory appendfile boolean true
19737 .cindex "directory creation"
19738 When this option is true, Exim attempts to create any missing superior
19739 directories for the file that it is about to write. A created directory's mode
19740 is given by the &%directory_mode%& option.
19741
19742 The group ownership of a newly created directory is highly dependent on the
19743 operating system (and possibly the file system) that is being used. For
19744 example, in Solaris, if the parent directory has the setgid bit set, its group
19745 is propagated to the child; if not, the currently set group is used. However,
19746 in FreeBSD, the parent's group is always used.
19747
19748
19749
19750 .option create_file appendfile string anywhere
19751 This option constrains the location of files and directories that are created
19752 by this transport. It applies to files defined by the &%file%& option and
19753 directories defined by the &%directory%& option. In the case of maildir
19754 delivery, it applies to the top level directory, not the maildir directories
19755 beneath.
19756
19757 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
19758 &"belowhome"&. In the second and third cases, a home directory must have been
19759 set for the transport. This option is not useful when an explicit file name is
19760 given for normal mailbox deliveries. It is intended for the case when file
19761 names are generated from users' &_.forward_& files. These are usually handled
19762 by an &(appendfile)& transport called &%address_file%&. See also
19763 &%file_must_exist%&.
19764
19765
19766 .option directory appendfile string&!! unset
19767 This option is mutually exclusive with the &%file%& option, but one of &%file%&
19768 or &%directory%& must be set, unless the delivery is the direct result of a
19769 redirection (see section &<<SECTfildiropt>>&).
19770
19771 When &%directory%& is set, the string is expanded, and the message is delivered
19772 into a new file or files in or below the given directory, instead of being
19773 appended to a single mailbox file. A number of different formats are provided
19774 (see &%maildir_format%& and &%mailstore_format%&), and see section
19775 &<<SECTopdir>>& for further details of this form of delivery.
19776
19777
19778 .option directory_file appendfile string&!! "see below"
19779 .cindex "base62"
19780 .vindex "&$inode$&"
19781 When &%directory%& is set, but neither &%maildir_format%& nor
19782 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
19783 whose name is obtained by expanding this string. The default value is:
19784 .code
19785 q${base62:$tod_epoch}-$inode
19786 .endd
19787 This generates a unique name from the current time, in base 62 form, and the
19788 inode of the file. The variable &$inode$& is available only when expanding this
19789 option.
19790
19791
19792 .option directory_mode appendfile "octal integer" 0700
19793 If &(appendfile)& creates any directories as a result of the
19794 &%create_directory%& option, their mode is specified by this option.
19795
19796
19797 .option escape_string appendfile string "see description"
19798 See &%check_string%& above.
19799
19800
19801 .option file appendfile string&!! unset
19802 This option is mutually exclusive with the &%directory%& option, but one of
19803 &%file%& or &%directory%& must be set, unless the delivery is the direct result
19804 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
19805 specifies a single file, to which the message is appended. One or more of
19806 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
19807 &%file%&.
19808
19809 .cindex "NFS" "lock file"
19810 .cindex "locking files"
19811 .cindex "lock files"
19812 If you are using more than one host to deliver over NFS into the same
19813 mailboxes, you should always use lock files.
19814
19815 The string value is expanded for each delivery, and must yield an absolute
19816 path. The most common settings of this option are variations on one of these
19817 examples:
19818 .code
19819 file = /var/spool/mail/$local_part
19820 file = /home/$local_part/inbox
19821 file = $home/inbox
19822 .endd
19823 .cindex "&""sticky""& bit"
19824 In the first example, all deliveries are done into the same directory. If Exim
19825 is configured to use lock files (see &%use_lockfile%& below) it must be able to
19826 create a file in the directory, so the &"sticky"& bit must be turned on for
19827 deliveries to be possible, or alternatively the &%group%& option can be used to
19828 run the delivery under a group id which has write access to the directory.
19829
19830
19831
19832 .option file_format appendfile string unset
19833 .cindex "file" "mailbox; checking existing format"
19834 This option requests the transport to check the format of an existing file
19835 before adding to it. The check consists of matching a specific string at the
19836 start of the file. The value of the option consists of an even number of
19837 colon-separated strings. The first of each pair is the test string, and the
19838 second is the name of a transport. If the transport associated with a matched
19839 string is not the current transport, control is passed over to the other
19840 transport. For example, suppose the standard &(local_delivery)& transport has
19841 this added to it:
19842 .code
19843 file_format = "From       : local_delivery :\
19844                \1\1\1\1\n : local_mmdf_delivery"
19845 .endd
19846 Mailboxes that begin with &"From"& are still handled by this transport, but if
19847 a mailbox begins with four binary ones followed by a newline, control is passed
19848 to a transport called &%local_mmdf_delivery%&, which presumably is configured
19849 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
19850 is assumed to match the current transport. If the start of a mailbox doesn't
19851 match any string, or if the transport named for a given string is not defined,
19852 delivery is deferred.
19853
19854
19855 .option file_must_exist appendfile boolean false
19856 If this option is true, the file specified by the &%file%& option must exist.
19857 A temporary error occurs if it does not, causing delivery to be deferred.
19858 If this option is false, the file is created if it does not exist.
19859
19860
19861 .option lock_fcntl_timeout appendfile time 0s
19862 .cindex "timeout" "mailbox locking"
19863 .cindex "mailbox" "locking, blocking and non-blocking"
19864 .cindex "locking files"
19865 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
19866 when locking an open mailbox file. If the call fails, the delivery process
19867 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
19868 Non-blocking calls are used so that the file is not kept open during the wait
19869 for the lock; the reason for this is to make it as safe as possible for
19870 deliveries over NFS in the case when processes might be accessing an NFS
19871 mailbox without using a lock file. This should not be done, but
19872 misunderstandings and hence misconfigurations are not unknown.
19873
19874 On a busy system, however, the performance of a non-blocking lock approach is
19875 not as good as using a blocking lock with a timeout. In this case, the waiting
19876 is done inside the system call, and Exim's delivery process acquires the lock
19877 and can proceed as soon as the previous lock holder releases it.
19878
19879 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
19880 timeout, are used. There may still be some retrying: the maximum number of
19881 retries is
19882 .code
19883 (lock_retries * lock_interval) / lock_fcntl_timeout
19884 .endd
19885 rounded up to the next whole number. In other words, the total time during
19886 which &(appendfile)& is trying to get a lock is roughly the same, unless
19887 &%lock_fcntl_timeout%& is set very large.
19888
19889 You should consider setting this option if you are getting a lot of delayed
19890 local deliveries because of errors of the form
19891 .code
19892 failed to lock mailbox /some/file (fcntl)
19893 .endd
19894
19895 .option lock_flock_timeout appendfile time 0s
19896 This timeout applies to file locking when using &[flock()]& (see
19897 &%use_flock%&); the timeout operates in a similar manner to
19898 &%lock_fcntl_timeout%&.
19899
19900
19901 .option lock_interval appendfile time 3s
19902 This specifies the time to wait between attempts to lock the file. See below
19903 for details of locking.
19904
19905
19906 .option lock_retries appendfile integer 10
19907 This specifies the maximum number of attempts to lock the file. A value of zero
19908 is treated as 1. See below for details of locking.
19909
19910
19911 .option lockfile_mode appendfile "octal integer" 0600
19912 This specifies the mode of the created lock file, when a lock file is being
19913 used (see &%use_lockfile%& and &%use_mbx_lock%&).
19914
19915
19916 .option lockfile_timeout appendfile time 30m
19917 .cindex "timeout" "mailbox locking"
19918 When a lock file is being used (see &%use_lockfile%&), if a lock file already
19919 exists and is older than this value, it is assumed to have been left behind by
19920 accident, and Exim attempts to remove it.
19921
19922
19923 .option mailbox_filecount 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 number of files in the mailbox. It must be a decimal number, optionally
19928 followed by K or M. This provides a way of obtaining this information from an
19929 external source that maintains the data.
19930
19931
19932 .option mailbox_size appendfile string&!! unset
19933 .cindex "mailbox" "specifying size of"
19934 .cindex "size" "of mailbox"
19935 If this option is set, it is expanded, and the result is taken as the current
19936 size the mailbox. It must be a decimal number, optionally followed by K or M.
19937 This provides a way of obtaining this information from an external source that
19938 maintains the data. This is likely to be helpful for maildir deliveries where
19939 it is computationally expensive to compute the size of a mailbox.
19940
19941
19942
19943 .option maildir_format appendfile boolean false
19944 .cindex "maildir format" "specifying"
19945 If this option is set with the &%directory%& option, the delivery is into a new
19946 file, in the &"maildir"& format that is used by other mail software. When the
19947 transport is activated directly from a &(redirect)& router (for example, the
19948 &(address_file)& transport in the default configuration), setting
19949 &%maildir_format%& causes the path received from the router to be treated as a
19950 directory, whether or not it ends with &`/`&. This option is available only if
19951 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
19952 &<<SECTmaildirdelivery>>& below for further details.
19953
19954
19955 .option maildir_quota_directory_regex appendfile string "See below"
19956 .cindex "maildir format" "quota; directories included in"
19957 .cindex "quota" "maildir; directories included in"
19958 This option is relevant only when &%maildir_use_size_file%& is set. It defines
19959 a regular expression for specifying directories, relative to the quota
19960 directory (see &%quota_directory%&), that should be included in the quota
19961 calculation. The default value is:
19962 .code
19963 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
19964 .endd
19965 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
19966 (directories whose names begin with a dot). If you want to exclude the
19967 &_Trash_&
19968 folder from the count (as some sites do), you need to change this setting to
19969 .code
19970 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
19971 .endd
19972 This uses a negative lookahead in the regular expression to exclude the
19973 directory whose name is &_.Trash_&. When a directory is excluded from quota
19974 calculations, quota processing is bypassed for any messages that are delivered
19975 directly into that directory.
19976
19977
19978 .option maildir_retries appendfile integer 10
19979 This option specifies the number of times to retry when writing a file in
19980 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
19981
19982
19983 .option maildir_tag appendfile string&!! unset
19984 This option applies only to deliveries in maildir format, and is described in
19985 section &<<SECTmaildirdelivery>>& below.
19986
19987
19988 .option maildir_use_size_file appendfile boolean false
19989 .cindex "maildir format" "&_maildirsize_& file"
19990 Setting this option true enables support for &_maildirsize_& files. Exim
19991 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
19992 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
19993 value is zero. See &%maildir_quota_directory_regex%& above and section
19994 &<<SECTmaildirdelivery>>& below for further details.
19995
19996 .option maildirfolder_create_regex appendfile string unset
19997 .cindex "maildir format" "&_maildirfolder_& file"
19998 .cindex "&_maildirfolder_&, creating"
19999 The value of this option is a regular expression. If it is unset, it has no
20000 effect. Otherwise, before a maildir delivery takes place, the pattern is
20001 matched against the name of the maildir directory, that is, the directory
20002 containing the &_new_& and &_tmp_& subdirectories that will be used for the
20003 delivery. If there is a match, Exim checks for the existence of a file called
20004 &_maildirfolder_& in the directory, and creates it if it does not exist.
20005 See section &<<SECTmaildirdelivery>>& for more details.
20006
20007
20008 .option mailstore_format appendfile boolean false
20009 .cindex "mailstore format" "specifying"
20010 If this option is set with the &%directory%& option, the delivery is into two
20011 new files in  &"mailstore"& format. The option is available only if
20012 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
20013 below for further details.
20014
20015
20016 .option mailstore_prefix appendfile string&!! unset
20017 This option applies only to deliveries in mailstore format, and is described in
20018 section &<<SECTopdir>>& below.
20019
20020
20021 .option mailstore_suffix appendfile string&!! unset
20022 This option applies only to deliveries in mailstore format, and is described in
20023 section &<<SECTopdir>>& below.
20024
20025
20026 .option mbx_format appendfile boolean false
20027 .cindex "locking files"
20028 .cindex "file" "locking"
20029 .cindex "file" "MBX format"
20030 .cindex "MBX format, specifying"
20031 This option is available only if Exim has been compiled with SUPPORT_MBX
20032 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
20033 the message is appended to the mailbox file in MBX format instead of
20034 traditional Unix format. This format is supported by Pine4 and its associated
20035 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
20036
20037 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
20038 automatically changed by the use of &%mbx_format%&. They should normally be set
20039 empty when using MBX format, so this option almost always appears in this
20040 combination:
20041 .code
20042 mbx_format = true
20043 message_prefix =
20044 message_suffix =
20045 .endd
20046 If none of the locking options are mentioned in the configuration,
20047 &%use_mbx_lock%& is assumed and the other locking options default to false. It
20048 is possible to specify the other kinds of locking with &%mbx_format%&, but
20049 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
20050 interworks with &'c-client'&, providing for shared access to the mailbox. It
20051 should not be used if any program that does not use this form of locking is
20052 going to access the mailbox, nor should it be used if the mailbox file is NFS
20053 mounted, because it works only when the mailbox is accessed from a single host.
20054
20055 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
20056 the standard version of &'c-client'&, because as long as it has a mailbox open
20057 (this means for the whole of a Pine or IMAP session), Exim will not be able to
20058 append messages to it.
20059
20060
20061 .option message_prefix appendfile string&!! "see below"
20062 .cindex "&""From""& line"
20063 The string specified here is expanded and output at the start of every message.
20064 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20065 in which case it is:
20066 .code
20067 message_prefix = "From ${if def:return_path{$return_path}\
20068   {MAILER-DAEMON}} $tod_bsdinbox\n"
20069 .endd
20070 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20071 &`\n`& to &`\r\n`& in &%message_prefix%&.
20072
20073 .option message_suffix appendfile string&!! "see below"
20074 The string specified here is expanded and output at the end of every message.
20075 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20076 in which case it is a single newline character. The suffix can be suppressed by
20077 setting
20078 .code
20079 message_suffix =
20080 .endd
20081 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20082 &`\n`& to &`\r\n`& in &%message_suffix%&.
20083
20084 .option mode appendfile "octal integer" 0600
20085 If the output file is created, it is given this mode. If it already exists and
20086 has wider permissions, they are reduced to this mode. If it has narrower
20087 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
20088 if the delivery is the result of a &%save%& command in a filter file specifying
20089 a particular mode, the mode of the output file is always forced to take that
20090 value, and this option is ignored.
20091
20092
20093 .option mode_fail_narrower appendfile boolean true
20094 This option applies in the case when an existing mailbox file has a narrower
20095 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
20096 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
20097 continues with the delivery attempt, using the existing mode of the file.
20098
20099
20100 .option notify_comsat appendfile boolean false
20101 If this option is true, the &'comsat'& daemon is notified after every
20102 successful delivery to a user mailbox. This is the daemon that notifies logged
20103 on users about incoming mail.
20104
20105
20106 .option quota appendfile string&!! unset
20107 .cindex "quota" "imposed by Exim"
20108 This option imposes a limit on the size of the file to which Exim is appending,
20109 or to the total space used in the directory tree when the &%directory%& option
20110 is set. In the latter case, computation of the space used is expensive, because
20111 all the files in the directory (and any sub-directories) have to be
20112 individually inspected and their sizes summed. (See &%quota_size_regex%& and
20113 &%maildir_use_size_file%& for ways to avoid this in environments where users
20114 have no shell access to their mailboxes).
20115
20116 As there is no interlock against two simultaneous deliveries into a
20117 multi-file mailbox, it is possible for the quota to be overrun in this case.
20118 For single-file mailboxes, of course, an interlock is a necessity.
20119
20120 A file's size is taken as its &'used'& value. Because of blocking effects, this
20121 may be a lot less than the actual amount of disk space allocated to the file.
20122 If the sizes of a number of files are being added up, the rounding effect can
20123 become quite noticeable, especially on systems that have large block sizes.
20124 Nevertheless, it seems best to stick to the &'used'& figure, because this is
20125 the obvious value which users understand most easily.
20126
20127 The value of the option is expanded, and must then be a numerical value
20128 (decimal point allowed), optionally followed by one of the letters K, M, or G,
20129 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
20130 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
20131 be handled.
20132
20133 &*Note*&: A value of zero is interpreted as &"no quota"&.
20134
20135 The expansion happens while Exim is running as root, before it changes uid for
20136 the delivery. This means that files that are inaccessible to the end user can
20137 be used to hold quota values that are looked up in the expansion. When delivery
20138 fails because this quota is exceeded, the handling of the error is as for
20139 system quota failures.
20140
20141 By default, Exim's quota checking mimics system quotas, and restricts the
20142 mailbox to the specified maximum size, though the value is not accurate to the
20143 last byte, owing to separator lines and additional headers that may get added
20144 during message delivery. When a mailbox is nearly full, large messages may get
20145 refused even though small ones are accepted, because the size of the current
20146 message is added to the quota when the check is made. This behaviour can be
20147 changed by setting &%quota_is_inclusive%& false. When this is done, the check
20148 for exceeding the quota does not include the current message. Thus, deliveries
20149 continue until the quota has been exceeded; thereafter, no further messages are
20150 delivered. See also &%quota_warn_threshold%&.
20151
20152
20153 .option quota_directory appendfile string&!! unset
20154 This option defines the directory to check for quota purposes when delivering
20155 into individual files. The default is the delivery directory, or, if a file
20156 called &_maildirfolder_& exists in a maildir directory, the parent of the
20157 delivery directory.
20158
20159
20160 .option quota_filecount appendfile string&!! 0
20161 This option applies when the &%directory%& option is set. It limits the total
20162 number of files in the directory (compare the inode limit in system quotas). It
20163 can only be used if &%quota%& is also set. The value is expanded; an expansion
20164 failure causes delivery to be deferred. A value of zero is interpreted as
20165 &"no quota"&.
20166
20167
20168 .option quota_is_inclusive appendfile boolean true
20169 See &%quota%& above.
20170
20171
20172 .option quota_size_regex appendfile string unset
20173 This option applies when one of the delivery modes that writes a separate file
20174 for each message is being used. When Exim wants to find the size of one of
20175 these files in order to test the quota, it first checks &%quota_size_regex%&.
20176 If this is set to a regular expression that matches the file name, and it
20177 captures one string, that string is interpreted as a representation of the
20178 file's size. The value of &%quota_size_regex%& is not expanded.
20179
20180 This feature is useful only when users have no shell access to their mailboxes
20181 &-- otherwise they could defeat the quota simply by renaming the files. This
20182 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20183 the file length to the file name. For example:
20184 .code
20185 maildir_tag = ,S=$message_size
20186 quota_size_regex = ,S=(\d+)
20187 .endd
20188 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20189 number of lines in the message.
20190
20191 The regular expression should not assume that the length is at the end of the
20192 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20193 sometimes add other information onto the ends of message file names.
20194
20195 Section &<<SECID136>>& contains further information.
20196
20197
20198 .option quota_warn_message appendfile string&!! "see below"
20199 See below for the use of this option. If it is not set when
20200 &%quota_warn_threshold%& is set, it defaults to
20201 .code
20202 quota_warn_message = "\
20203   To: $local_part@$domain\n\
20204   Subject: Your mailbox\n\n\
20205   This message is automatically created \
20206   by mail delivery software.\n\n\
20207   The size of your mailbox has exceeded \
20208   a warning threshold that is\n\
20209   set by the system administrator.\n"
20210 .endd
20211
20212
20213 .option quota_warn_threshold appendfile string&!! 0
20214 .cindex "quota" "warning threshold"
20215 .cindex "mailbox" "size warning"
20216 .cindex "size" "of mailbox"
20217 This option is expanded in the same way as &%quota%& (see above). If the
20218 resulting value is greater than zero, and delivery of the message causes the
20219 size of the file or total space in the directory tree to cross the given
20220 threshold, a warning message is sent. If &%quota%& is also set, the threshold
20221 may be specified as a percentage of it by following the value with a percent
20222 sign. For example:
20223 .code
20224 quota = 10M
20225 quota_warn_threshold = 75%
20226 .endd
20227 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20228 percent sign is ignored.
20229
20230 The warning message itself is specified by the &%quota_warn_message%& option,
20231 and it must start with a &'To:'& header line containing the recipient(s) of the
20232 warning message. These do not necessarily have to include the recipient(s) of
20233 the original message. A &'Subject:'& line should also normally be supplied. You
20234 can include any other header lines that you want. If you do not include a
20235 &'From:'& line, the default is:
20236 .code
20237 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20238 .endd
20239 .oindex &%errors_reply_to%&
20240 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20241 option.
20242
20243 The &%quota%& option does not have to be set in order to use this option; they
20244 are independent of one another except when the threshold is specified as a
20245 percentage.
20246
20247
20248 .option use_bsmtp appendfile boolean false
20249 .cindex "envelope sender"
20250 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20251 format, with the envelope sender and recipient(s) included as SMTP commands. If
20252 you want to include a leading HELO command with such messages, you can do
20253 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20254 for details of batch SMTP.
20255
20256
20257 .option use_crlf appendfile boolean false
20258 .cindex "carriage return"
20259 .cindex "linefeed"
20260 This option causes lines to be terminated with the two-character CRLF sequence
20261 (carriage return, linefeed) instead of just a linefeed character. In the case
20262 of batched SMTP, the byte sequence written to the file is then an exact image
20263 of what would be sent down a real SMTP connection.
20264
20265 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
20266 (which are used to supply the traditional &"From&~"& and blank line separators
20267 in Berkeley-style mailboxes) are written verbatim, so must contain their own
20268 carriage return characters if these are needed. In cases where these options
20269 have non-empty defaults, the values end with a single linefeed, so they must be
20270 changed to end with &`\r\n`& if &%use_crlf%& is set.
20271
20272
20273 .option use_fcntl_lock appendfile boolean "see below"
20274 This option controls the use of the &[fcntl()]& function to lock a file for
20275 exclusive use when a message is being appended. It is set by default unless
20276 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
20277 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
20278 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
20279
20280
20281 .option use_flock_lock appendfile boolean false
20282 This option is provided to support the use of &[flock()]& for file locking, for
20283 the few situations where it is needed. Most modern operating systems support
20284 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
20285 each other. Exim uses &[fcntl()]& locking by default.
20286
20287 This option is required only if you are using an operating system where
20288 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
20289 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
20290 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
20291
20292 .cindex "Solaris" "&[flock()]& support"
20293 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
20294 have it (and some, I think, provide a not quite right version built on top of
20295 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
20296 the ability to use it, and any attempt to do so will cause a configuration
20297 error.
20298
20299 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
20300 is just being mapped onto &[fcntl()]& by the OS).
20301
20302
20303 .option use_lockfile appendfile boolean "see below"
20304 If this option is turned off, Exim does not attempt to create a lock file when
20305 appending to a mailbox file. In this situation, the only locking is by
20306 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
20307 sure that every MUA that is ever going to look at your users' mailboxes uses
20308 &[fcntl()]& rather than a lock file, and even then only when you are not
20309 delivering over NFS from more than one host.
20310
20311 .cindex "NFS" "lock file"
20312 In order to append to an NFS file safely from more than one host, it is
20313 necessary to take out a lock &'before'& opening the file, and the lock file
20314 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
20315 file corruption.
20316
20317 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
20318 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
20319 except when &%mbx_format%& is set.
20320
20321
20322 .option use_mbx_lock appendfile boolean "see below"
20323 This option is available only if Exim has been compiled with SUPPORT_MBX
20324 set in &_Local/Makefile_&. Setting the option specifies that special MBX
20325 locking rules be used. It is set by default if &%mbx_format%& is set and none
20326 of the locking options are mentioned in the configuration. The locking rules
20327 are the same as are used by the &'c-client'& library that underlies Pine and
20328 the IMAP4 and POP daemons that come with it (see the discussion below). The
20329 rules allow for shared access to the mailbox. However, this kind of locking
20330 does not work when the mailbox is NFS mounted.
20331
20332 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
20333 &%use_flock_lock%& to control what kind of locking is used in implementing the
20334 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
20335 without &%use_fcntl_lock%& or &%use_flock_lock%&.
20336
20337
20338
20339
20340 .section "Operational details for appending" "SECTopappend"
20341 .cindex "appending to a file"
20342 .cindex "file" "appending"
20343 Before appending to a file, the following preparations are made:
20344
20345 .ilist
20346 If the name of the file is &_/dev/null_&, no action is taken, and a success
20347 return is given.
20348
20349 .next
20350 .cindex "directory creation"
20351 If any directories on the file's path are missing, Exim creates them if the
20352 &%create_directory%& option is set. A created directory's mode is given by the
20353 &%directory_mode%& option.
20354
20355 .next
20356 If &%file_format%& is set, the format of an existing file is checked. If this
20357 indicates that a different transport should be used, control is passed to that
20358 transport.
20359
20360 .next
20361 .cindex "file" "locking"
20362 .cindex "locking files"
20363 .cindex "NFS" "lock file"
20364 If &%use_lockfile%& is set, a lock file is built in a way that will work
20365 reliably over NFS, as follows:
20366
20367 .olist
20368 Create a &"hitching post"& file whose name is that of the lock file with the
20369 current time, primary host name, and process id added, by opening for writing
20370 as a new file. If this fails with an access error, delivery is deferred.
20371 .next
20372 Close the hitching post file, and hard link it to the lock file name.
20373 .next
20374 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
20375 Unlink the hitching post name.
20376 .next
20377 Otherwise, use &[stat()]& to get information about the hitching post file, and
20378 then unlink hitching post name. If the number of links is exactly two, creation
20379 of the lock file succeeded but something (for example, an NFS server crash and
20380 restart) caused this fact not to be communicated to the &[link()]& call.
20381 .next
20382 If creation of the lock file failed, wait for &%lock_interval%& and try again,
20383 up to &%lock_retries%& times. However, since any program that writes to a
20384 mailbox should complete its task very quickly, it is reasonable to time out old
20385 lock files that are normally the result of user agent and system crashes. If an
20386 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
20387 it before trying again.
20388 .endlist olist
20389
20390 .next
20391 A call is made to &[lstat()]& to discover whether the main file exists, and if
20392 so, what its characteristics are. If &[lstat()]& fails for any reason other
20393 than non-existence, delivery is deferred.
20394
20395 .next
20396 .cindex "symbolic link" "to mailbox"
20397 .cindex "mailbox" "symbolic link"
20398 If the file does exist and is a symbolic link, delivery is deferred, unless the
20399 &%allow_symlink%& option is set, in which case the ownership of the link is
20400 checked, and then &[stat()]& is called to find out about the real file, which
20401 is then subjected to the checks below. The check on the top-level link
20402 ownership prevents one user creating a link for another's mailbox in a sticky
20403 directory, though allowing symbolic links in this case is definitely not a good
20404 idea. If there is a chain of symbolic links, the intermediate ones are not
20405 checked.
20406
20407 .next
20408 If the file already exists but is not a regular file, or if the file's owner
20409 and group (if the group is being checked &-- see &%check_group%& above) are
20410 different from the user and group under which the delivery is running,
20411 delivery is deferred.
20412
20413 .next
20414 If the file's permissions are more generous than specified, they are reduced.
20415 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
20416 is set false, in which case the delivery is tried using the existing
20417 permissions.
20418
20419 .next
20420 The file's inode number is saved, and the file is then opened for appending.
20421 If this fails because the file has vanished, &(appendfile)& behaves as if it
20422 hadn't existed (see below). For any other failures, delivery is deferred.
20423
20424 .next
20425 If the file is opened successfully, check that the inode number hasn't
20426 changed, that it is still a regular file, and that the owner and permissions
20427 have not changed. If anything is wrong, defer delivery and freeze the message.
20428
20429 .next
20430 If the file did not exist originally, defer delivery if the &%file_must_exist%&
20431 option is set. Otherwise, check that the file is being created in a permitted
20432 directory if the &%create_file%& option is set (deferring on failure), and then
20433 open for writing as a new file, with the O_EXCL and O_CREAT options,
20434 except when dealing with a symbolic link (the &%allow_symlink%& option must be
20435 set). In this case, which can happen if the link points to a non-existent file,
20436 the file is opened for writing using O_CREAT but not O_EXCL, because
20437 that prevents link following.
20438
20439 .next
20440 .cindex "loop" "while file testing"
20441 If opening fails because the file exists, obey the tests given above for
20442 existing files. However, to avoid looping in a situation where the file is
20443 being continuously created and destroyed, the exists/not-exists loop is broken
20444 after 10 repetitions, and the message is then frozen.
20445
20446 .next
20447 If opening fails with any other error, defer delivery.
20448
20449 .next
20450 .cindex "file" "locking"
20451 .cindex "locking files"
20452 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
20453 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
20454 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
20455 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
20456 file, and an exclusive lock on the file whose name is
20457 .code
20458 /tmp/.<device-number>.<inode-number>
20459 .endd
20460 using the device and inode numbers of the open mailbox file, in accordance with
20461 the MBX locking rules. This file is created with a mode that is specified by
20462 the &%lockfile_mode%& option.
20463
20464 If Exim fails to lock the file, there are two possible courses of action,
20465 depending on the value of the locking timeout. This is obtained from
20466 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
20467
20468 If the timeout value is zero, the file is closed, Exim waits for
20469 &%lock_interval%&, and then goes back and re-opens the file as above and tries
20470 to lock it again. This happens up to &%lock_retries%& times, after which the
20471 delivery is deferred.
20472
20473 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
20474 &[flock()]& are used (with the given timeout), so there has already been some
20475 waiting involved by the time locking fails. Nevertheless, Exim does not give up
20476 immediately. It retries up to
20477 .code
20478 (lock_retries * lock_interval) / <timeout>
20479 .endd
20480 times (rounded up).
20481 .endlist
20482
20483 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
20484 and/or &[flock()]& locks) and then deletes the lock file if one was created.
20485
20486
20487 .section "Operational details for delivery to a new file" "SECTopdir"
20488 .cindex "delivery" "to single file"
20489 .cindex "&""From""& line"
20490 When the &%directory%& option is set instead of &%file%&, each message is
20491 delivered into a newly-created file or set of files. When &(appendfile)& is
20492 activated directly from a &(redirect)& router, neither &%file%& nor
20493 &%directory%& is normally set, because the path for delivery is supplied by the
20494 router. (See for example, the &(address_file)& transport in the default
20495 configuration.) In this case, delivery is to a new file if either the path name
20496 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
20497
20498 No locking is required while writing the message to a new file, so the various
20499 locking options of the transport are ignored. The &"From"& line that by default
20500 separates messages in a single file is not normally needed, nor is the escaping
20501 of message lines that start with &"From"&, and there is no need to ensure a
20502 newline at the end of each message. Consequently, the default values for
20503 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
20504 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
20505
20506 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
20507 the files in the delivery directory by default. However, you can specify a
20508 different directory by setting &%quota_directory%&. Also, for maildir
20509 deliveries (see below) the &_maildirfolder_& convention is honoured.
20510
20511
20512 .cindex "maildir format"
20513 .cindex "mailstore format"
20514 There are three different ways in which delivery to individual files can be
20515 done, controlled by the settings of the &%maildir_format%& and
20516 &%mailstore_format%& options. Note that code to support maildir or mailstore
20517 formats is not included in the binary unless SUPPORT_MAILDIR or
20518 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
20519
20520 .cindex "directory creation"
20521 In all three cases an attempt is made to create the directory and any necessary
20522 sub-directories if they do not exist, provided that the &%create_directory%&
20523 option is set (the default). The location of a created directory can be
20524 constrained by setting &%create_file%&. A created directory's mode is given by
20525 the &%directory_mode%& option. If creation fails, or if the
20526 &%create_directory%& option is not set when creation is required, delivery is
20527 deferred.
20528
20529
20530
20531 .section "Maildir delivery" "SECTmaildirdelivery"
20532 .cindex "maildir format" "description of"
20533 If the &%maildir_format%& option is true, Exim delivers each message by writing
20534 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
20535 directory that is defined by the &%directory%& option (the &"delivery
20536 directory"&). If the delivery is successful, the file is renamed into the
20537 &_new_& subdirectory.
20538
20539 In the file name, <&'stime'&> is the current time of day in seconds, and
20540 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
20541 Exim checks that the time-of-day clock has moved on by at least one microsecond
20542 before terminating the delivery process. This guarantees uniqueness for the
20543 file name. However, as a precaution, Exim calls &[stat()]& for the file before
20544 opening it. If any response other than ENOENT (does not exist) is given,
20545 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
20546
20547 Before Exim carries out a maildir delivery, it ensures that subdirectories
20548 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
20549 do not exist, Exim tries to create them and any superior directories in their
20550 path, subject to the &%create_directory%& and &%create_file%& options. If the
20551 &%maildirfolder_create_regex%& option is set, and the regular expression it
20552 contains matches the delivery directory, Exim also ensures that a file called
20553 &_maildirfolder_& exists in the delivery directory. If a missing directory or
20554 &_maildirfolder_& file cannot be created, delivery is deferred.
20555
20556 These features make it possible to use Exim to create all the necessary files
20557 and directories in a maildir mailbox, including subdirectories for maildir++
20558 folders. Consider this example:
20559 .code
20560 maildir_format = true
20561 directory = /var/mail/$local_part\
20562            ${if eq{$local_part_suffix}{}{}\
20563            {/.${substr_1:$local_part_suffix}}}
20564 maildirfolder_create_regex = /\.[^/]+$
20565 .endd
20566 If &$local_part_suffix$& is empty (there was no suffix for the local part),
20567 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
20568 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
20569 not match this name, so Exim will not look for or create the file
20570 &_/var/mail/pimbo/maildirfolder_&, though it will create
20571 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
20572
20573 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
20574 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
20575 does match &%maildirfolder_create_regex%&. In this case, Exim will create
20576 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
20577 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
20578
20579 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
20580 not inadvertently match the toplevel maildir directory, because a
20581 &_maildirfolder_& file at top level would completely break quota calculations.
20582
20583 .cindex "quota" "in maildir delivery"
20584 .cindex "maildir++"
20585 If Exim is required to check a &%quota%& setting before a maildir delivery, and
20586 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
20587 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
20588 Exim assumes the directory is a maildir++ folder directory, which is one level
20589 down from the user's top level mailbox directory. This causes it to start at
20590 the parent directory instead of the current directory when calculating the
20591 amount of space used.
20592
20593 One problem with delivering into a multi-file mailbox is that it is
20594 computationally expensive to compute the size of the mailbox for quota
20595 checking. Various approaches have been taken to reduce the amount of work
20596 needed. The next two sections describe two of them. A third alternative is to
20597 use some external process for maintaining the size data, and use the expansion
20598 of the &%mailbox_size%& option as a way of importing it into Exim.
20599
20600
20601
20602
20603 .section "Using tags to record message sizes" "SECID135"
20604 If &%maildir_tag%& is set, the string is expanded for each delivery.
20605 When the maildir file is renamed into the &_new_& sub-directory, the
20606 tag is added to its name. However, if adding the tag takes the length of the
20607 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
20608 the tag is dropped and the maildir file is created with no tag.
20609
20610 .new
20611 .vindex "&$message_size$&"
20612 Tags can be used to encode the size of files in their names; see
20613 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
20614 happens after the message has been written. The value of the &$message_size$&
20615 variable is set to the number of bytes actually written. If the expansion is
20616 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
20617 be deferred. The expanded tag may contain any printing characters except &"/"&.
20618 Non-printing characters in the string are ignored; if the resulting string is
20619 empty, it is ignored. If it starts with an alphanumeric character, a leading
20620 colon is inserted; this default has not proven to be the path that popular
20621 maildir implementations have chosen (but changing it in Exim would break
20622 backwards compatibility).
20623
20624 For one common implementation, you might set:
20625 .code
20626 maildir_tag = ,S=${message_size}
20627 .endd
20628 but you should check the documentation of the other software to be sure.
20629
20630 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
20631 as this allows Exim to extract the size from your tag, instead of having to
20632 &[stat()]& each message file.
20633 .wen
20634
20635
20636 .section "Using a maildirsize file" "SECID136"
20637 .cindex "quota" "in maildir delivery"
20638 .cindex "maildir format" "&_maildirsize_& file"
20639 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
20640 storing quota and message size information in a file called &_maildirsize_&
20641 within the toplevel maildir directory. If this file does not exist, Exim
20642 creates it, setting the quota from the &%quota%& option of the transport. If
20643 the maildir directory itself does not exist, it is created before any attempt
20644 to write a &_maildirsize_& file.
20645
20646 The &_maildirsize_& file is used to hold information about the sizes of
20647 messages in the maildir, thus speeding up quota calculations. The quota value
20648 in the file is just a cache; if the quota is changed in the transport, the new
20649 value overrides the cached value when the next message is delivered. The cache
20650 is maintained for the benefit of other programs that access the maildir and
20651 need to know the quota.
20652
20653 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
20654 file is maintained (with a zero quota setting), but no quota is imposed.
20655
20656 A regular expression is available for controlling which directories in the
20657 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
20658 See the description of the &%maildir_quota_directory_regex%& option above for
20659 details.
20660
20661
20662 .section "Mailstore delivery" "SECID137"
20663 .cindex "mailstore format" "description of"
20664 If the &%mailstore_format%& option is true, each message is written as two
20665 files in the given directory. A unique base name is constructed from the
20666 message id and the current delivery process, and the files that are written use
20667 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
20668 contains the message's envelope, and the &_.msg_& file contains the message
20669 itself. The base name is placed in the variable &$mailstore_basename$&.
20670
20671 During delivery, the envelope is first written to a file with the suffix
20672 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
20673 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
20674 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
20675 file before accessing either of them. An alternative approach is to wait for
20676 the absence of a &_.tmp_& file.
20677
20678 The envelope file starts with any text defined by the &%mailstore_prefix%&
20679 option, expanded and terminated by a newline if there isn't one. Then follows
20680 the sender address on one line, then all the recipient addresses, one per line.
20681 There can be more than one recipient only if the &%batch_max%& option is set
20682 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
20683 appended to the file, followed by a newline if it does not end with one.
20684
20685 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
20686 failure, it is ignored. Other expansion errors are treated as serious
20687 configuration errors, and delivery is deferred. The variable
20688 &$mailstore_basename$& is available for use during these expansions.
20689
20690
20691 .section "Non-special new file delivery" "SECID138"
20692 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
20693 file is created directly in the named directory. For example, when delivering
20694 messages into files in batched SMTP format for later delivery to some host (see
20695 section &<<SECTbatchSMTP>>&), a setting such as
20696 .code
20697 directory = /var/bsmtp/$host
20698 .endd
20699 might be used. A message is written to a file with a temporary name, which is
20700 then renamed when the delivery is complete. The final name is obtained by
20701 expanding the contents of the &%directory_file%& option.
20702 .ecindex IIDapptra1
20703 .ecindex IIDapptra2
20704
20705
20706
20707
20708
20709
20710 . ////////////////////////////////////////////////////////////////////////////
20711 . ////////////////////////////////////////////////////////////////////////////
20712
20713 .chapter "The autoreply transport" "CHID8"
20714 .scindex IIDauttra1 "transports" "&(autoreply)&"
20715 .scindex IIDauttra2 "&(autoreply)& transport"
20716 The &(autoreply)& transport is not a true transport in that it does not cause
20717 the message to be transmitted. Instead, it generates a new mail message as an
20718 automatic reply to the incoming message. &'References:'& and
20719 &'Auto-Submitted:'& header lines are included. These are constructed according
20720 to the rules in RFCs 2822 and 3834, respectively.
20721
20722 If the router that passes the message to this transport does not have the
20723 &%unseen%& option set, the original message (for the current recipient) is not
20724 delivered anywhere. However, when the &%unseen%& option is set on the router
20725 that passes the message to this transport, routing of the address continues, so
20726 another router can set up a normal message delivery.
20727
20728
20729 The &(autoreply)& transport is usually run as the result of mail filtering, a
20730 &"vacation"& message being the standard example. However, it can also be run
20731 directly from a router like any other transport. To reduce the possibility of
20732 message cascades, messages created by the &(autoreply)& transport always have
20733 empty envelope sender addresses, like bounce messages.
20734
20735 The parameters of the message to be sent can be specified in the configuration
20736 by options described below. However, these are used only when the address
20737 passed to the transport does not contain its own reply information. When the
20738 transport is run as a consequence of a
20739 &%mail%&
20740 or &%vacation%& command in a filter file, the parameters of the message are
20741 supplied by the filter, and passed with the address. The transport's options
20742 that define the message are then ignored (so they are not usually set in this
20743 case). The message is specified entirely by the filter or by the transport; it
20744 is never built from a mixture of options. However, the &%file_optional%&,
20745 &%mode%&, and &%return_message%& options apply in all cases.
20746
20747 &(Autoreply)& is implemented as a local transport. When used as a result of a
20748 command in a user's filter file, &(autoreply)& normally runs under the uid and
20749 gid of the user, and with appropriate current and home directories (see chapter
20750 &<<CHAPenvironment>>&).
20751
20752 There is a subtle difference between routing a message to a &(pipe)& transport
20753 that generates some text to be returned to the sender, and routing it to an
20754 &(autoreply)& transport. This difference is noticeable only if more than one
20755 address from the same message is so handled. In the case of a pipe, the
20756 separate outputs from the different addresses are gathered up and returned to
20757 the sender in a single message, whereas if &(autoreply)& is used, a separate
20758 message is generated for each address that is passed to it.
20759
20760 Non-printing characters are not permitted in the header lines generated for the
20761 message that &(autoreply)& creates, with the exception of newlines that are
20762 immediately followed by white space. If any non-printing characters are found,
20763 the transport defers.
20764 Whether characters with the top bit set count as printing characters or not is
20765 controlled by the &%print_topbitchars%& global option.
20766
20767 If any of the generic options for manipulating headers (for example,
20768 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
20769 of the original message that is included in the generated message when
20770 &%return_message%& is set. They do not apply to the generated message itself.
20771
20772 .vindex "&$sender_address$&"
20773 If the &(autoreply)& transport receives return code 2 from Exim when it submits
20774 the message, indicating that there were no recipients, it does not treat this
20775 as an error. This means that autoreplies sent to &$sender_address$& when this
20776 is empty (because the incoming message is a bounce message) do not cause
20777 problems. They are just discarded.
20778
20779
20780
20781 .section "Private options for autoreply" "SECID139"
20782 .cindex "options" "&(autoreply)& transport"
20783
20784 .option bcc autoreply string&!! unset
20785 This specifies the addresses that are to receive &"blind carbon copies"& of the
20786 message when the message is specified by the transport.
20787
20788
20789 .option cc autoreply string&!! unset
20790 This specifies recipients of the message and the contents of the &'Cc:'& header
20791 when the message is specified by the transport.
20792
20793
20794 .option file autoreply string&!! unset
20795 The contents of the file are sent as the body of the message when the message
20796 is specified by the transport. If both &%file%& and &%text%& are set, the text
20797 string comes first.
20798
20799
20800 .option file_expand autoreply boolean false
20801 If this is set, the contents of the file named by the &%file%& option are
20802 subjected to string expansion as they are added to the message.
20803
20804
20805 .option file_optional autoreply boolean false
20806 If this option is true, no error is generated if the file named by the &%file%&
20807 option or passed with the address does not exist or cannot be read.
20808
20809
20810 .option from autoreply string&!! unset
20811 This specifies the contents of the &'From:'& header when the message is
20812 specified by the transport.
20813
20814
20815 .option headers autoreply string&!! unset
20816 This specifies additional RFC 2822 headers that are to be added to the message
20817 when the message is specified by the transport. Several can be given by using
20818 &"\n"& to separate them. There is no check on the format.
20819
20820
20821 .option log autoreply string&!! unset
20822 This option names a file in which a record of every message sent is logged when
20823 the message is specified by the transport.
20824
20825
20826 .option mode autoreply "octal integer" 0600
20827 If either the log file or the &"once"& file has to be created, this mode is
20828 used.
20829
20830
20831 .option never_mail autoreply "address list&!!" unset
20832 If any run of the transport creates a message with a recipient that matches any
20833 item in the list, that recipient is quietly discarded. If all recipients are
20834 discarded, no message is created. This applies both when the recipients are
20835 generated by a filter and when they are specified in the transport.
20836
20837
20838
20839 .option once autoreply string&!! unset
20840 This option names a file or DBM database in which a record of each &'To:'&
20841 recipient is kept when the message is specified by the transport. &*Note*&:
20842 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
20843
20844 If &%once%& is unset, or is set to an empty string, the message is always sent.
20845 By default, if &%once%& is set to a non-empty file name, the message
20846 is not sent if a potential recipient is already listed in the database.
20847 However, if the &%once_repeat%& option specifies a time greater than zero, the
20848 message is sent if that much time has elapsed since a message was last sent to
20849 this recipient. A setting of zero time for &%once_repeat%& (the default)
20850 prevents a message from being sent a second time &-- in this case, zero means
20851 infinity.
20852
20853 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
20854 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
20855 greater than zero, it changes the way Exim implements the &%once%& option.
20856 Instead of using a DBM file to record every recipient it sends to, it uses a
20857 regular file, whose size will never get larger than the given value.
20858
20859 In the file, Exim keeps a linear list of recipient addresses and the times at
20860 which they were sent messages. If the file is full when a new address needs to
20861 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
20862 means that a given recipient may receive multiple messages, but at
20863 unpredictable intervals that depend on the rate of turnover of addresses in the
20864 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
20865
20866
20867 .option once_file_size autoreply integer 0
20868 See &%once%& above.
20869
20870
20871 .option once_repeat autoreply time&!! 0s
20872 See &%once%& above.
20873 After expansion, the value of this option must be a valid time value.
20874
20875
20876 .option reply_to autoreply string&!! unset
20877 This specifies the contents of the &'Reply-To:'& header when the message is
20878 specified by the transport.
20879
20880
20881 .option return_message autoreply boolean false
20882 If this is set, a copy of the original message is returned with the new
20883 message, subject to the maximum size set in the &%return_size_limit%& global
20884 configuration option.
20885
20886
20887 .option subject autoreply string&!! unset
20888 This specifies the contents of the &'Subject:'& header when the message is
20889 specified by the transport. It is tempting to quote the original subject in
20890 automatic responses. For example:
20891 .code
20892 subject = Re: $h_subject:
20893 .endd
20894 There is a danger in doing this, however. It may allow a third party to
20895 subscribe your users to an opt-in mailing list, provided that the list accepts
20896 bounce messages as subscription confirmations. Well-managed lists require a
20897 non-bounce message to confirm a subscription, so the danger is relatively
20898 small.
20899
20900
20901
20902 .option text autoreply string&!! unset
20903 This specifies a single string to be used as the body of the message when the
20904 message is specified by the transport. If both &%text%& and &%file%& are set,
20905 the text comes first.
20906
20907
20908 .option to autoreply string&!! unset
20909 This specifies recipients of the message and the contents of the &'To:'& header
20910 when the message is specified by the transport.
20911 .ecindex IIDauttra1
20912 .ecindex IIDauttra2
20913
20914
20915
20916
20917 . ////////////////////////////////////////////////////////////////////////////
20918 . ////////////////////////////////////////////////////////////////////////////
20919
20920 .chapter "The lmtp transport" "CHAPLMTP"
20921 .cindex "transports" "&(lmtp)&"
20922 .cindex "&(lmtp)& transport"
20923 .cindex "LMTP" "over a pipe"
20924 .cindex "LMTP" "over a socket"
20925 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
20926 specified command
20927 or by interacting with a Unix domain socket.
20928 This transport is something of a cross between the &(pipe)& and &(smtp)&
20929 transports. Exim also has support for using LMTP over TCP/IP; this is
20930 implemented as an option for the &(smtp)& transport. Because LMTP is expected
20931 to be of minority interest, the default build-time configure in &_src/EDITME_&
20932 has it commented out. You need to ensure that
20933 .code
20934 TRANSPORT_LMTP=yes
20935 .endd
20936 .cindex "options" "&(lmtp)& transport"
20937 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
20938 included in the Exim binary. The private options of the &(lmtp)& transport are
20939 as follows:
20940
20941 .option batch_id lmtp string&!! unset
20942 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20943
20944
20945 .option batch_max lmtp integer 1
20946 This limits the number of addresses that can be handled in a single delivery.
20947 Most LMTP servers can handle several addresses at once, so it is normally a
20948 good idea to increase this value. See the description of local delivery
20949 batching in chapter &<<CHAPbatching>>&.
20950
20951
20952 .option command lmtp string&!! unset
20953 This option must be set if &%socket%& is not set. The string is a command which
20954 is run in a separate process. It is split up into a command name and list of
20955 arguments, each of which is separately expanded (so expansion cannot change the
20956 number of arguments). The command is run directly, not via a shell. The message
20957 is passed to the new process using the standard input and output to operate the
20958 LMTP protocol.
20959
20960 .option ignore_quota lmtp boolean false
20961 .cindex "LMTP" "ignoring quota errors"
20962 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
20963 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
20964 in its response to the LHLO command.
20965
20966 .option socket lmtp string&!! unset
20967 This option must be set if &%command%& is not set. The result of expansion must
20968 be the name of a Unix domain socket. The transport connects to the socket and
20969 delivers the message to it using the LMTP protocol.
20970
20971
20972 .option timeout lmtp time 5m
20973 The transport is aborted if the created process or Unix domain socket does not
20974 respond to LMTP commands or message input within this timeout. Delivery
20975 is deferred, and will be tried again later. Here is an example of a typical
20976 LMTP transport:
20977 .code
20978 lmtp:
20979   driver = lmtp
20980   command = /some/local/lmtp/delivery/program
20981   batch_max = 20
20982   user = exim
20983 .endd
20984 This delivers up to 20 addresses at a time, in a mixture of domains if
20985 necessary, running as the user &'exim'&.
20986
20987
20988
20989 . ////////////////////////////////////////////////////////////////////////////
20990 . ////////////////////////////////////////////////////////////////////////////
20991
20992 .chapter "The pipe transport" "CHAPpipetransport"
20993 .scindex IIDpiptra1 "transports" "&(pipe)&"
20994 .scindex IIDpiptra2 "&(pipe)& transport"
20995 The &(pipe)& transport is used to deliver messages via a pipe to a command
20996 running in another process. One example is the use of &(pipe)& as a
20997 pseudo-remote transport for passing messages to some other delivery mechanism
20998 (such as UUCP). Another is the use by individual users to automatically process
20999 their incoming messages. The &(pipe)& transport can be used in one of the
21000 following ways:
21001
21002 .ilist
21003 .vindex "&$local_part$&"
21004 A router routes one address to a transport in the normal way, and the
21005 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
21006 contains the local part of the address (as usual), and the command that is run
21007 is specified by the &%command%& option on the transport.
21008 .next
21009 .vindex "&$pipe_addresses$&"
21010 If the &%batch_max%& option is set greater than 1 (the default is 1), the
21011 transport can handle more than one address in a single run. In this case, when
21012 more than one address is routed to the transport, &$local_part$& is not set
21013 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
21014 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
21015 that are routed to the transport.
21016 .next
21017 .vindex "&$address_pipe$&"
21018 A router redirects an address directly to a pipe command (for example, from an
21019 alias or forward file). In this case, &$address_pipe$& contains the text of the
21020 pipe command, and the &%command%& option on the transport is ignored. If only
21021 one address is being transported (&%batch_max%& is not greater than one, or
21022 only one address was redirected to this pipe command), &$local_part$& contains
21023 the local part that was redirected.
21024 .endlist
21025
21026
21027 The &(pipe)& transport is a non-interactive delivery method. Exim can also
21028 deliver messages over pipes using the LMTP interactive protocol. This is
21029 implemented by the &(lmtp)& transport.
21030
21031 In the case when &(pipe)& is run as a consequence of an entry in a local user's
21032 &_.forward_& file, the command runs under the uid and gid of that user. In
21033 other cases, the uid and gid have to be specified explicitly, either on the
21034 transport or on the router that handles the address. Current and &"home"&
21035 directories are also controllable. See chapter &<<CHAPenvironment>>& for
21036 details of the local delivery environment and chapter &<<CHAPbatching>>&
21037 for a discussion of local delivery batching.
21038
21039
21040 .section "Concurrent delivery" "SECID140"
21041 If two messages arrive at almost the same time, and both are routed to a pipe
21042 delivery, the two pipe transports may be run concurrently. You must ensure that
21043 any pipe commands you set up are robust against this happening. If the commands
21044 write to a file, the &%exim_lock%& utility might be of use.
21045
21046
21047
21048
21049 .section "Returned status and data" "SECID141"
21050 .cindex "&(pipe)& transport" "returned data"
21051 If the command exits with a non-zero return code, the delivery is deemed to
21052 have failed, unless either the &%ignore_status%& option is set (in which case
21053 the return code is treated as zero), or the return code is one of those listed
21054 in the &%temp_errors%& option, which are interpreted as meaning &"try again
21055 later"&. In this case, delivery is deferred. Details of a permanent failure are
21056 logged, but are not included in the bounce message, which merely contains
21057 &"local delivery failed"&.
21058
21059 If the command exits on a signal and the &%freeze_signal%& option is set then
21060 the message will be frozen in the queue. If that option is not set, a bounce
21061 will be sent as normal.
21062
21063 If the return code is greater than 128 and the command being run is a shell
21064 script, it normally means that the script was terminated by a signal whose
21065 value is the return code minus 128. The &%freeze_signal%& option does not
21066 apply in this case.
21067
21068 If Exim is unable to run the command (that is, if &[execve()]& fails), the
21069 return code is set to 127. This is the value that a shell returns if it is
21070 asked to run a non-existent command. The wording for the log line suggests that
21071 a non-existent command may be the problem.
21072
21073 The &%return_output%& option can affect the result of a pipe delivery. If it is
21074 set and the command produces any output on its standard output or standard
21075 error streams, the command is considered to have failed, even if it gave a zero
21076 return code or if &%ignore_status%& is set. The output from the command is
21077 included as part of the bounce message. The &%return_fail_output%& option is
21078 similar, except that output is returned only when the command exits with a
21079 failure return code, that is, a value other than zero or a code that matches
21080 &%temp_errors%&.
21081
21082
21083
21084 .section "How the command is run" "SECThowcommandrun"
21085 .cindex "&(pipe)& transport" "path for command"
21086 The command line is (by default) broken down into a command name and arguments
21087 by the &(pipe)& transport itself. The &%allow_commands%& and
21088 &%restrict_to_path%& options can be used to restrict the commands that may be
21089 run.
21090
21091 .cindex "quoting" "in pipe command"
21092 Unquoted arguments are delimited by white space. If an argument appears in
21093 double quotes, backslash is interpreted as an escape character in the usual
21094 way. If an argument appears in single quotes, no escaping is done.
21095
21096 String expansion is applied to the command line except when it comes from a
21097 traditional &_.forward_& file (commands from a filter file are expanded). The
21098 expansion is applied to each argument in turn rather than to the whole line.
21099 For this reason, any string expansion item that contains white space must be
21100 quoted so as to be contained within a single argument. A setting such as
21101 .code
21102 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
21103 .endd
21104 will not work, because the expansion item gets split between several
21105 arguments. You have to write
21106 .code
21107 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
21108 .endd
21109 to ensure that it is all in one argument. The expansion is done in this way,
21110 argument by argument, so that the number of arguments cannot be changed as a
21111 result of expansion, and quotes or backslashes in inserted variables do not
21112 interact with external quoting. However, this leads to problems if you want to
21113 generate multiple arguments (or the command name plus arguments) from a single
21114 expansion. In this situation, the simplest solution is to use a shell. For
21115 example:
21116 .code
21117 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
21118 .endd
21119
21120 .cindex "transport" "filter"
21121 .cindex "filter" "transport filter"
21122 .vindex "&$pipe_addresses$&"
21123 Special handling takes place when an argument consists of precisely the text
21124 &`$pipe_addresses`&. This is not a general expansion variable; the only
21125 place this string is recognized is when it appears as an argument for a pipe or
21126 transport filter command. It causes each address that is being handled to be
21127 inserted in the argument list at that point &'as a separate argument'&. This
21128 avoids any problems with spaces or shell metacharacters, and is of use when a
21129 &(pipe)& transport is handling groups of addresses in a batch.
21130
21131 After splitting up into arguments and expansion, the resulting command is run
21132 in a subprocess directly from the transport, &'not'& under a shell. The
21133 message that is being delivered is supplied on the standard input, and the
21134 standard output and standard error are both connected to a single pipe that is
21135 read by Exim. The &%max_output%& option controls how much output the command
21136 may produce, and the &%return_output%& and &%return_fail_output%& options
21137 control what is done with it.
21138
21139 Not running the command under a shell (by default) lessens the security risks
21140 in cases when a command from a user's filter file is built out of data that was
21141 taken from an incoming message. If a shell is required, it can of course be
21142 explicitly specified as the command to be run. However, there are circumstances
21143 where existing commands (for example, in &_.forward_& files) expect to be run
21144 under a shell and cannot easily be modified. To allow for these cases, there is
21145 an option called &%use_shell%&, which changes the way the &(pipe)& transport
21146 works. Instead of breaking up the command line as just described, it expands it
21147 as a single string and passes the result to &_/bin/sh_&. The
21148 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
21149 with &%use_shell%&, and the whole mechanism is inherently less secure.
21150
21151
21152
21153 .section "Environment variables" "SECTpipeenv"
21154 .cindex "&(pipe)& transport" "environment for command"
21155 .cindex "environment for pipe transport"
21156 The environment variables listed below are set up when the command is invoked.
21157 This list is a compromise for maximum compatibility with other MTAs. Note that
21158 the &%environment%& option can be used to add additional variables to this
21159 environment.
21160 .display
21161 &`DOMAIN            `&   the domain of the address
21162 &`HOME              `&   the home directory, if set
21163 &`HOST              `&   the host name when called from a router (see below)
21164 &`LOCAL_PART        `&   see below
21165 &`LOCAL_PART_PREFIX `&   see below
21166 &`LOCAL_PART_SUFFIX `&   see below
21167 &`LOGNAME           `&   see below
21168 &`MESSAGE_ID        `&   Exim's local ID for the message
21169 &`PATH              `&   as specified by the &%path%& option below
21170 &`QUALIFY_DOMAIN    `&   the sender qualification domain
21171 &`RECIPIENT         `&   the complete recipient address
21172 &`SENDER            `&   the sender of the message (empty if a bounce)
21173 &`SHELL             `&   &`/bin/sh`&
21174 &`TZ                `&   the value of the &%timezone%& option, if set
21175 &`USER              `&   see below
21176 .endd
21177 When a &(pipe)& transport is called directly from (for example) an &(accept)&
21178 router, LOCAL_PART is set to the local part of the address. When it is
21179 called as a result of a forward or alias expansion, LOCAL_PART is set to
21180 the local part of the address that was expanded. In both cases, any affixes are
21181 removed from the local part, and made available in LOCAL_PART_PREFIX and
21182 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
21183 same value as LOCAL_PART for compatibility with other MTAs.
21184
21185 .cindex "HOST"
21186 HOST is set only when a &(pipe)& transport is called from a router that
21187 associates hosts with an address, typically when using &(pipe)& as a
21188 pseudo-remote transport. HOST is set to the first host name specified by
21189 the router.
21190
21191 .cindex "HOME"
21192 If the transport's generic &%home_directory%& option is set, its value is used
21193 for the HOME environment variable. Otherwise, a home directory may be set
21194 by the router's &%transport_home_directory%& option, which defaults to the
21195 user's home directory if &%check_local_user%& is set.
21196
21197
21198 .section "Private options for pipe" "SECID142"
21199 .cindex "options" "&(pipe)& transport"
21200
21201
21202
21203 .option allow_commands pipe "string list&!!" unset
21204 .cindex "&(pipe)& transport" "permitted commands"
21205 The string is expanded, and is then interpreted as a colon-separated list of
21206 permitted commands. If &%restrict_to_path%& is not set, the only commands
21207 permitted are those in the &%allow_commands%& list. They need not be absolute
21208 paths; the &%path%& option is still used for relative paths. If
21209 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
21210 in the &%allow_commands%& list, or a name without any slashes that is found on
21211 the path. In other words, if neither &%allow_commands%& nor
21212 &%restrict_to_path%& is set, there is no restriction on the command, but
21213 otherwise only commands that are permitted by one or the other are allowed. For
21214 example, if
21215 .code
21216 allow_commands = /usr/bin/vacation
21217 .endd
21218 and &%restrict_to_path%& is not set, the only permitted command is
21219 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
21220 &%use_shell%& is set.
21221
21222
21223 .option batch_id pipe string&!! unset
21224 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21225
21226
21227 .option batch_max pipe integer 1
21228 This limits the number of addresses that can be handled in a single delivery.
21229 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21230
21231
21232 .option check_string pipe string unset
21233 As &(pipe)& writes the message, the start of each line is tested for matching
21234 &%check_string%&, and if it does, the initial matching characters are replaced
21235 by the contents of &%escape_string%&, provided both are set. The value of
21236 &%check_string%& is a literal string, not a regular expression, and the case of
21237 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
21238 of &%check_string%& and &%escape_string%& are forced to values that implement
21239 the SMTP escaping protocol. Any settings made in the configuration file are
21240 ignored.
21241
21242
21243 .option command pipe string&!! unset
21244 This option need not be set when &(pipe)& is being used to deliver to pipes
21245 obtained directly from address redirections. In other cases, the option must be
21246 set, to provide a command to be run. It need not yield an absolute path (see
21247 the &%path%& option below). The command is split up into separate arguments by
21248 Exim, and each argument is separately expanded, as described in section
21249 &<<SECThowcommandrun>>& above.
21250
21251
21252 .option environment pipe string&!! unset
21253 .cindex "&(pipe)& transport" "environment for command"
21254 .cindex "environment for &(pipe)& transport"
21255 This option is used to add additional variables to the environment in which the
21256 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
21257 a string which is expanded, and then interpreted as a colon-separated list of
21258 environment settings of the form <&'name'&>=<&'value'&>.
21259
21260
21261 .option escape_string pipe string unset
21262 See &%check_string%& above.
21263
21264
21265 .option freeze_exec_fail pipe boolean false
21266 .cindex "exec failure"
21267 .cindex "failure of exec"
21268 .cindex "&(pipe)& transport" "failure of exec"
21269 Failure to exec the command in a pipe transport is by default treated like
21270 any other failure while running the command. However, if &%freeze_exec_fail%&
21271 is set, failure to exec is treated specially, and causes the message to be
21272 frozen, whatever the setting of &%ignore_status%&.
21273
21274
21275 .new
21276 .otion freeze_signal pipe boolean false
21277 .cindex "signal exit"
21278 .cidenx "&(pipe)& transport", "signal exit"
21279 Normally if the process run by a command in a pipe transport exits on a signal,
21280 a bounce message is sent. If &%freeze_signal%& is set, the message will be
21281 frozen in Exim's queue instead.
21282 .wen
21283
21284
21285 .option ignore_status pipe boolean false
21286 If this option is true, the status returned by the subprocess that is set up to
21287 run the command is ignored, and Exim behaves as if zero had been returned.
21288 Otherwise, a non-zero status or termination by signal causes an error return
21289 from the transport unless the status value is one of those listed in
21290 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
21291
21292 &*Note*&: This option does not apply to timeouts, which do not return a status.
21293 See the &%timeout_defer%& option for how timeouts are handled.
21294
21295 .option log_defer_output pipe boolean false
21296 .cindex "&(pipe)& transport" "logging output"
21297 If this option is set, and the status returned by the command is
21298 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
21299 and any output was produced, the first line of it is written to the main log.
21300
21301
21302 .option log_fail_output pipe boolean false
21303 If this option is set, and the command returns any output, and also ends with a
21304 return code that is neither zero nor one of the return codes listed in
21305 &%temp_errors%& (that is, the delivery failed), the first line of output is
21306 written to the main log. This option and &%log_output%& are mutually exclusive.
21307 Only one of them may be set.
21308
21309
21310
21311 .option log_output pipe boolean false
21312 If this option is set and the command returns any output, the first line of
21313 output is written to the main log, whatever the return code. This option and
21314 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
21315
21316
21317
21318 .option max_output pipe integer 20K
21319 This specifies the maximum amount of output that the command may produce on its
21320 standard output and standard error file combined. If the limit is exceeded, the
21321 process running the command is killed. This is intended as a safety measure to
21322 catch runaway processes. The limit is applied independently of the settings of
21323 the options that control what is done with such output (for example,
21324 &%return_output%&). Because of buffering effects, the amount of output may
21325 exceed the limit by a small amount before Exim notices.
21326
21327
21328 .option message_prefix pipe string&!! "see below"
21329 The string specified here is expanded and output at the start of every message.
21330 The default is unset if &%use_bsmtp%& is set. Otherwise it is
21331 .code
21332 message_prefix = \
21333   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
21334   ${tod_bsdinbox}\n
21335 .endd
21336 .cindex "Cyrus"
21337 .cindex "&%tmail%&"
21338 .cindex "&""From""& line"
21339 This is required by the commonly used &_/usr/bin/vacation_& program.
21340 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
21341 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
21342 setting
21343 .code
21344 message_prefix =
21345 .endd
21346 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21347 &`\n`& to &`\r\n`& in &%message_prefix%&.
21348
21349
21350 .option message_suffix pipe string&!! "see below"
21351 The string specified here is expanded and output at the end of every message.
21352 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
21353 The suffix can be suppressed by setting
21354 .code
21355 message_suffix =
21356 .endd
21357 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21358 &`\n`& to &`\r\n`& in &%message_suffix%&.
21359
21360
21361 .option path pipe string "see below"
21362 This option specifies the string that is set up in the PATH environment
21363 variable of the subprocess. The default is:
21364 .code
21365 /bin:/usr/bin
21366 .endd
21367 If the &%command%& option does not yield an absolute path name, the command is
21368 sought in the PATH directories, in the usual way. &*Warning*&: This does not
21369 apply to a command specified as a transport filter.
21370
21371
21372 .new
21373 .option permit_coredump pipe boolean false
21374 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
21375 a core-dump of a pipe command, enable this command.  This enables core-dumps
21376 during delivery and affects both the Exim binary and the pipe command run.
21377 It is recommended that this option remain off unless and until you have a need
21378 for it and that this only be enabled when needed, as the risk of excessive
21379 resource consumption can be quite high.  Note also that Exim is typically
21380 installed as a setuid binary and most operating systems will inhibit coredumps
21381 of these by default, so further OS-specific action may be required.
21382 .wen
21383
21384
21385 .option pipe_as_creator pipe boolean false
21386 .cindex "uid (user id)" "local delivery"
21387 If the generic &%user%& option is not set and this option is true, the delivery
21388 process is run under the uid that was in force when Exim was originally called
21389 to accept the message. If the group id is not otherwise set (via the generic
21390 &%group%& option), the gid that was in force when Exim was originally called to
21391 accept the message is used.
21392
21393
21394 .option restrict_to_path pipe boolean false
21395 When this option is set, any command name not listed in &%allow_commands%& must
21396 contain no slashes. The command is searched for only in the directories listed
21397 in the &%path%& option. This option is intended for use in the case when a pipe
21398 command has been generated from a user's &_.forward_& file. This is usually
21399 handled by a &(pipe)& transport called &%address_pipe%&.
21400
21401
21402 .option return_fail_output pipe boolean false
21403 If this option is true, and the command produced any output and ended with a
21404 return code other than zero or one of the codes listed in &%temp_errors%& (that
21405 is, the delivery failed), the output is returned in the bounce message.
21406 However, if the message has a null sender (that is, it is itself a bounce
21407 message), output from the command is discarded. This option and
21408 &%return_output%& are mutually exclusive. Only one of them may be set.
21409
21410
21411
21412 .option return_output pipe boolean false
21413 If this option is true, and the command produced any output, the delivery is
21414 deemed to have failed whatever the return code from the command, and the output
21415 is returned in the bounce message. Otherwise, the output is just discarded.
21416 However, if the message has a null sender (that is, it is a bounce message),
21417 output from the command is always discarded, whatever the setting of this
21418 option. This option and &%return_fail_output%& are mutually exclusive. Only one
21419 of them may be set.
21420
21421
21422
21423 .option temp_errors pipe "string list" "see below"
21424 .cindex "&(pipe)& transport" "temporary failure"
21425 This option contains either a colon-separated list of numbers, or a single
21426 asterisk. If &%ignore_status%& is false
21427 and &%return_output%& is not set,
21428 and the command exits with a non-zero return code, the failure is treated as
21429 temporary and the delivery is deferred if the return code matches one of the
21430 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
21431 codes are treated as permanent errors. The default setting contains the codes
21432 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
21433 compiled on a system that does not define these macros, it assumes values of 75
21434 and 73, respectively.
21435
21436
21437 .option timeout pipe time 1h
21438 If the command fails to complete within this time, it is killed. This normally
21439 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
21440 specifies no timeout. In order to ensure that any subprocesses created by the
21441 command are also killed, Exim makes the initial process a process group leader,
21442 and kills the whole process group on a timeout. However, this can be defeated
21443 if one of the processes starts a new process group.
21444
21445 .option timeout_defer pipe boolean false
21446 A timeout in a &(pipe)& transport, either in the command that the transport
21447 runs, or in a transport filter that is associated with it, is by default
21448 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
21449 is set true, both kinds of timeout become temporary errors, causing the
21450 delivery to be deferred.
21451
21452 .option umask pipe "octal integer" 022
21453 This specifies the umask setting for the subprocess that runs the command.
21454
21455
21456 .option use_bsmtp pipe boolean false
21457 .cindex "envelope sender"
21458 If this option is set true, the &(pipe)& transport writes messages in &"batch
21459 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
21460 commands. If you want to include a leading HELO command with such messages,
21461 you can do so by setting the &%message_prefix%& option. See section
21462 &<<SECTbatchSMTP>>& for details of batch SMTP.
21463
21464 .option use_classresources pipe boolean false
21465 .cindex "class resources (BSD)"
21466 This option is available only when Exim is running on FreeBSD, NetBSD, or
21467 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
21468 resource limits when a &(pipe)& transport is run to perform a delivery. The
21469 limits for the uid under which the pipe is to run are obtained from the login
21470 class database.
21471
21472
21473 .option use_crlf pipe boolean false
21474 .cindex "carriage return"
21475 .cindex "linefeed"
21476 This option causes lines to be terminated with the two-character CRLF sequence
21477 (carriage return, linefeed) instead of just a linefeed character. In the case
21478 of batched SMTP, the byte sequence written to the pipe is then an exact image
21479 of what would be sent down a real SMTP connection.
21480
21481 The contents of the &%message_prefix%& and &%message_suffix%& options are
21482 written verbatim, so must contain their own carriage return characters if these
21483 are needed. When &%use_bsmtp%& is not set, the default values for both
21484 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
21485 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
21486
21487
21488 .option use_shell pipe boolean false
21489 .vindex "&$pipe_addresses$&"
21490 If this option is set, it causes the command to be passed to &_/bin/sh_&
21491 instead of being run directly from the transport, as described in section
21492 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
21493 where the command is expected to be run under a shell and cannot easily be
21494 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
21495 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
21496 command is expanded as a single string, and handed to &_/bin/sh_& as data for
21497 its &%-c%& option.
21498
21499
21500
21501 .section "Using an external local delivery agent" "SECID143"
21502 .cindex "local delivery" "using an external agent"
21503 .cindex "&'procmail'&"
21504 .cindex "external local delivery"
21505 .cindex "delivery" "&'procmail'&"
21506 .cindex "delivery" "by external agent"
21507 The &(pipe)& transport can be used to pass all messages that require local
21508 delivery to a separate local delivery agent such as &%procmail%&. When doing
21509 this, care must be taken to ensure that the pipe is run under an appropriate
21510 uid and gid. In some configurations one wants this to be a uid that is trusted
21511 by the delivery agent to supply the correct sender of the message. It may be
21512 necessary to recompile or reconfigure the delivery agent so that it trusts an
21513 appropriate user. The following is an example transport and router
21514 configuration for &%procmail%&:
21515 .code
21516 # transport
21517 procmail_pipe:
21518   driver = pipe
21519   command = /usr/local/bin/procmail -d $local_part
21520   return_path_add
21521   delivery_date_add
21522   envelope_to_add
21523   check_string = "From "
21524   escape_string = ">From "
21525   umask = 077
21526   user = $local_part
21527   group = mail
21528
21529 # router
21530 procmail:
21531   driver = accept
21532   check_local_user
21533   transport = procmail_pipe
21534 .endd
21535 In this example, the pipe is run as the local user, but with the group set to
21536 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
21537 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
21538 user to supply a correct sender address. If you do not specify either a
21539 &%group%& or a &%user%& option, the pipe command is run as the local user. The
21540 home directory is the user's home directory by default.
21541
21542 &*Note*&: The command that the pipe transport runs does &'not'& begin with
21543 .code
21544 IFS=" "
21545 .endd
21546 as shown in some &%procmail%& documentation, because Exim does not by default
21547 use a shell to run pipe commands.
21548
21549 .cindex "Cyrus"
21550 The next example shows a transport and a router for a system where local
21551 deliveries are handled by the Cyrus IMAP server.
21552 .code
21553 # transport
21554 local_delivery_cyrus:
21555   driver = pipe
21556   command = /usr/cyrus/bin/deliver \
21557             -m ${substr_1:$local_part_suffix} -- $local_part
21558   user = cyrus
21559   group = mail
21560   return_output
21561   log_output
21562   message_prefix =
21563   message_suffix =
21564
21565 # router
21566 local_user_cyrus:
21567   driver = accept
21568   check_local_user
21569   local_part_suffix = .*
21570   transport = local_delivery_cyrus
21571 .endd
21572 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
21573 &%return_output%& to cause any text written by Cyrus to be returned to the
21574 sender.
21575 .ecindex IIDpiptra1
21576 .ecindex IIDpiptra2
21577
21578
21579 . ////////////////////////////////////////////////////////////////////////////
21580 . ////////////////////////////////////////////////////////////////////////////
21581
21582 .chapter "The smtp transport" "CHAPsmtptrans"
21583 .scindex IIDsmttra1 "transports" "&(smtp)&"
21584 .scindex IIDsmttra2 "&(smtp)& transport"
21585 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
21586 or LMTP protocol. The list of hosts to try can either be taken from the address
21587 that is being processed (having been set up by the router), or specified
21588 explicitly for the transport. Timeout and retry processing (see chapter
21589 &<<CHAPretry>>&) is applied to each IP address independently.
21590
21591
21592 .section "Multiple messages on a single connection" "SECID144"
21593 The sending of multiple messages over a single TCP/IP connection can arise in
21594 two ways:
21595
21596 .ilist
21597 If a message contains more than &%max_rcpt%& (see below) addresses that are
21598 routed to the same host, more than one copy of the message has to be sent to
21599 that host. In this situation, multiple copies may be sent in a single run of
21600 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
21601 does when it has too many addresses to send in one message also depends on the
21602 value of the global &%remote_max_parallel%& option. Details are given in
21603 section &<<SECToutSMTPTCP>>&.)
21604 .next
21605 .cindex "hints database" "remembering routing"
21606 When a message has been successfully delivered over a TCP/IP connection, Exim
21607 looks in its hints database to see if there are any other messages awaiting a
21608 connection to the same host. If there are, a new delivery process is started
21609 for one of them, and the current TCP/IP connection is passed on to it. The new
21610 process may in turn send multiple copies and possibly create yet another
21611 process.
21612 .endlist
21613
21614
21615 For each copy sent over the same TCP/IP connection, a sequence counter is
21616 incremented, and if it ever gets to the value of &%connection_max_messages%&,
21617 no further messages are sent over that connection.
21618
21619
21620
21621 .section "Use of the $host and $host_address variables" "SECID145"
21622 .vindex "&$host$&"
21623 .vindex "&$host_address$&"
21624 At the start of a run of the &(smtp)& transport, the values of &$host$& and
21625 &$host_address$& are the name and IP address of the first host on the host list
21626 passed by the router. However, when the transport is about to connect to a
21627 specific host, and while it is connected to that host, &$host$& and
21628 &$host_address$& are set to the values for that host. These are the values
21629 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
21630 &%serialize_hosts%&, and the various TLS options are expanded.
21631
21632
21633 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
21634 .vindex &$tls_cipher$&
21635 .vindex &$tls_peerdn$&
21636 At the start of a run of the &(smtp)& transport, the values of &$tls_cipher$&
21637 and &$tls_peerdn$& are the values that were set when the message was received.
21638 These are the values that are used for options that are expanded before any
21639 SMTP connections are made. Just before each connection is made, these two
21640 variables are emptied. If TLS is subsequently started, they are set to the
21641 appropriate values for the outgoing connection, and these are the values that
21642 are in force when any authenticators are run and when the
21643 &%authenticated_sender%& option is expanded.
21644
21645
21646 .section "Private options for smtp" "SECID146"
21647 .cindex "options" "&(smtp)& transport"
21648 The private options of the &(smtp)& transport are as follows:
21649
21650
21651 .option address_retry_include_sender smtp boolean true
21652 .cindex "4&'xx'& responses" "retrying after"
21653 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
21654 is the combination of sender and recipient that is delayed in subsequent queue
21655 runs until the retry time is reached. You can delay the recipient without
21656 reference to the sender (which is what earlier versions of Exim did), by
21657 setting &%address_retry_include_sender%& false. However, this can lead to
21658 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
21659
21660 .option allow_localhost smtp boolean false
21661 .cindex "local host" "sending to"
21662 .cindex "fallback" "hosts specified on transport"
21663 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
21664 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
21665 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
21666 the delivery anyway. This should be used only in special cases when the
21667 configuration ensures that no looping will result (for example, a differently
21668 configured Exim is listening on the port to which the message is sent).
21669
21670
21671 .option authenticated_sender smtp string&!! unset
21672 .cindex "Cyrus"
21673 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
21674 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
21675 overriding any existing authenticated sender value. If the string expansion is
21676 forced to fail, the option is ignored. Other expansion failures cause delivery
21677 to be deferred. If the result of expansion is an empty string, that is also
21678 ignored.
21679
21680 The expansion happens after the outgoing connection has been made and TLS
21681 started, if required. This means that the &$host$&, &$host_address$&,
21682 &$tls_cipher$&, and &$tls_peerdn$& variables are set according to the
21683 particular connection.
21684
21685 If the SMTP session is not authenticated, the expansion of
21686 &%authenticated_sender%& still happens (and can cause the delivery to be
21687 deferred if it fails), but no AUTH= item is added to MAIL commands
21688 unless &%authenticated_sender_force%& is true.
21689
21690 This option allows you to use the &(smtp)& transport in LMTP mode to
21691 deliver mail to Cyrus IMAP and provide the proper local part as the
21692 &"authenticated sender"&, via a setting such as:
21693 .code
21694 authenticated_sender = $local_part
21695 .endd
21696 This removes the need for IMAP subfolders to be assigned special ACLs to
21697 allow direct delivery to those subfolders.
21698
21699 Because of expected uses such as that just described for Cyrus (when no
21700 domain is involved), there is no checking on the syntax of the provided
21701 value.
21702
21703
21704 .option authenticated_sender_force smtp boolean false
21705 If this option is set true, the &%authenticated_sender%& option's value
21706 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
21707 authenticated as a client.
21708
21709
21710 .option command_timeout smtp time 5m
21711 This sets a timeout for receiving a response to an SMTP command that has been
21712 sent out. It is also used when waiting for the initial banner line from the
21713 remote host. Its value must not be zero.
21714
21715
21716 .option connect_timeout smtp time 5m
21717 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
21718 to a remote host. A setting of zero allows the system timeout (typically
21719 several minutes) to act. To have any effect, the value of this option must be
21720 less than the system timeout. However, it has been observed that on some
21721 systems there is no system timeout, which is why the default value for this
21722 option is 5 minutes, a value recommended by RFC 1123.
21723
21724
21725 .option connection_max_messages smtp integer 500
21726 .cindex "SMTP" "passed connection"
21727 .cindex "SMTP" "multiple deliveries"
21728 .cindex "multiple SMTP deliveries"
21729 This controls the maximum number of separate message deliveries that are sent
21730 over a single TCP/IP connection. If the value is zero, there is no limit.
21731 For testing purposes, this value can be overridden by the &%-oB%& command line
21732 option.
21733
21734
21735 .option data_timeout smtp time 5m
21736 This sets a timeout for the transmission of each block in the data portion of
21737 the message. As a result, the overall timeout for a message depends on the size
21738 of the message. Its value must not be zero. See also &%final_timeout%&.
21739
21740
21741 .option delay_after_cutoff smtp boolean true
21742 This option controls what happens when all remote IP addresses for a given
21743 domain have been inaccessible for so long that they have passed their retry
21744 cutoff times.
21745
21746 In the default state, if the next retry time has not been reached for any of
21747 them, the address is bounced without trying any deliveries. In other words,
21748 Exim delays retrying an IP address after the final cutoff time until a new
21749 retry time is reached, and can therefore bounce an address without ever trying
21750 a delivery, when machines have been down for a long time. Some people are
21751 unhappy at this prospect, so...
21752
21753 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
21754 addresses are past their final cutoff time, Exim tries to deliver to those
21755 IP addresses that have not been tried since the message arrived. If there are
21756 none, of if they all fail, the address is bounced. In other words, it does not
21757 delay when a new message arrives, but immediately tries those expired IP
21758 addresses that haven't been tried since the message arrived. If there is a
21759 continuous stream of messages for the dead hosts, unsetting
21760 &%delay_after_cutoff%& means that there will be many more attempts to deliver
21761 to them.
21762
21763
21764 .option dns_qualify_single smtp boolean true
21765 If the &%hosts%& or &%fallback_hosts%& option is being used,
21766 and the &%gethostbyname%& option is false,
21767 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
21768 in chapter &<<CHAPdnslookup>>& for more details.
21769
21770
21771 .option dns_search_parents smtp boolean false
21772 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
21773 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
21774 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
21775 details.
21776
21777
21778
21779 .option fallback_hosts smtp "string list" unset
21780 .cindex "fallback" "hosts specified on transport"
21781 String expansion is not applied to this option. The argument must be a
21782 colon-separated list of host names or IP addresses, optionally also including
21783 port numbers, though the separator can be changed, as described in section
21784 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
21785 item in a &%route_list%& setting for the &(manualroute)& router, as described
21786 in section &<<SECTformatonehostitem>>&.
21787
21788 Fallback hosts can also be specified on routers, which associate them with the
21789 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
21790 &%fallback_hosts%& specified on the transport is used only if the address does
21791 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
21792 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
21793 However, &%hosts_randomize%& does apply to fallback host lists.
21794
21795 If Exim is unable to deliver to any of the hosts for a particular address, and
21796 the errors are not permanent rejections, the address is put on a separate
21797 transport queue with its host list replaced by the fallback hosts, unless the
21798 address was routed via MX records and the current host was in the original MX
21799 list. In that situation, the fallback host list is not used.
21800
21801 Once normal deliveries are complete, the fallback queue is delivered by
21802 re-running the same transports with the new host lists. If several failing
21803 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
21804 copy of the message is sent.
21805
21806 The resolution of the host names on the fallback list is controlled by the
21807 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
21808 both to cases when the host list comes with the address and when it is taken
21809 from &%hosts%&. This option provides a &"use a smart host only if delivery
21810 fails"& facility.
21811
21812
21813 .option final_timeout smtp time 10m
21814 This is the timeout that applies while waiting for the response to the final
21815 line containing just &"."& that terminates a message. Its value must not be
21816 zero.
21817
21818 .option gethostbyname smtp boolean false
21819 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
21820 being used, names are looked up using &[gethostbyname()]&
21821 (or &[getipnodebyname()]& when available)
21822 instead of using the DNS. Of course, that function may in fact use the DNS, but
21823 it may also consult other sources of information such as &_/etc/hosts_&.
21824
21825 .option gnutls_require_kx smtp string unset
21826 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
21827 client. For details, see section &<<SECTreqciphgnu>>&.
21828
21829 .option gnutls_require_mac smtp string unset
21830 This option controls the MAC algorithms when GnuTLS is used in an Exim
21831 client. For details, see section &<<SECTreqciphgnu>>&.
21832
21833 .option gnutls_require_protocols smtp string unset
21834 This option controls the protocols when GnuTLS is used in an Exim
21835 client. For details, see section &<<SECTreqciphgnu>>&.
21836
21837 .option gnutls_compat_mode smtp boolean unset
21838 This option controls whether GnuTLS is used in compatibility mode in an Exim
21839 server. This reduces security slightly, but improves interworking with older
21840 implementations of TLS.
21841
21842 .option helo_data smtp string&!! "see below"
21843 .cindex "HELO" "argument, setting"
21844 .cindex "EHLO" "argument, setting"
21845 .cindex "LHLO argument setting"
21846 The value of this option is expanded after a connection to a another host has
21847 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
21848 command that starts the outgoing SMTP or LMTP session. The default value of the
21849 option is:
21850 .code
21851 $primary_hostname
21852 .endd
21853 During the expansion, the variables &$host$& and &$host_address$& are set to
21854 the identity of the remote host, and the variables &$sending_ip_address$& and
21855 &$sending_port$& are set to the local IP address and port number that are being
21856 used. These variables can be used to generate different values for different
21857 servers or different local IP addresses. For example, if you want the string
21858 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
21859 interface address, you could use this:
21860 .code
21861 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
21862   {$primary_hostname}}
21863 .endd
21864 The use of &%helo_data%& applies both to sending messages and when doing
21865 callouts.
21866
21867 .option hosts smtp "string list&!!" unset
21868 Hosts are associated with an address by a router such as &(dnslookup)&, which
21869 finds the hosts by looking up the address domain in the DNS, or by
21870 &(manualroute)&, which has lists of hosts in its configuration. However,
21871 email addresses can be passed to the &(smtp)& transport by any router, and not
21872 all of them can provide an associated list of hosts.
21873
21874 The &%hosts%& option specifies a list of hosts to be used if the address being
21875 processed does not have any hosts associated with it. The hosts specified by
21876 &%hosts%& are also used, whether or not the address has its own hosts, if
21877 &%hosts_override%& is set.
21878
21879 The string is first expanded, before being interpreted as a colon-separated
21880 list of host names or IP addresses, possibly including port numbers. The
21881 separator may be changed to something other than colon, as described in section
21882 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
21883 item in a &%route_list%& setting for the &(manualroute)& router, as described
21884 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
21885 of the &(manualroute)& router is not available here.
21886
21887 If the expansion fails, delivery is deferred. Unless the failure was caused by
21888 the inability to complete a lookup, the error is logged to the panic log as
21889 well as the main log. Host names are looked up either by searching directly for
21890 address records in the DNS or by calling &[gethostbyname()]& (or
21891 &[getipnodebyname()]& when available), depending on the setting of the
21892 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
21893 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
21894 address are used.
21895
21896 During delivery, the hosts are tried in order, subject to their retry status,
21897 unless &%hosts_randomize%& is set.
21898
21899
21900 .option hosts_avoid_esmtp smtp "host list&!!" unset
21901 .cindex "ESMTP, avoiding use of"
21902 .cindex "HELO" "forcing use of"
21903 .cindex "EHLO" "avoiding use of"
21904 .cindex "PIPELINING" "avoiding the use of"
21905 This option is for use with broken hosts that announce ESMTP facilities (for
21906 example, PIPELINING) and then fail to implement them properly. When a host
21907 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
21908 start of the SMTP session. This means that it cannot use any of the ESMTP
21909 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
21910
21911
21912 .option hosts_avoid_pipelining smtp "host list&!!" unset
21913 .cindex "PIPELINING" "avoiding the use of"
21914 Exim will not use the SMTP PIPELINING extension when delivering to any host
21915 that matches this list, even if the server host advertises PIPELINING support.
21916
21917
21918 .option hosts_avoid_tls smtp "host list&!!" unset
21919 .cindex "TLS" "avoiding for certain hosts"
21920 Exim will not try to start a TLS session when delivering to any host that
21921 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
21922
21923
21924 .option hosts_max_try smtp integer 5
21925 .cindex "host" "maximum number to try"
21926 .cindex "limit" "number of hosts tried"
21927 .cindex "limit" "number of MX tried"
21928 .cindex "MX record" "maximum tried"
21929 This option limits the number of IP addresses that are tried for any one
21930 delivery in cases where there are temporary delivery errors. Section
21931 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
21932
21933
21934 .option hosts_max_try_hardlimit smtp integer 50
21935 This is an additional check on the maximum number of IP addresses that Exim
21936 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
21937 why it exists.
21938
21939
21940
21941 .option hosts_nopass_tls smtp "host list&!!" unset
21942 .cindex "TLS" "passing connection"
21943 .cindex "multiple SMTP deliveries"
21944 .cindex "TLS" "multiple message deliveries"
21945 For any host that matches this list, a connection on which a TLS session has
21946 been started will not be passed to a new delivery process for sending another
21947 message on the same connection. See section &<<SECTmulmessam>>& for an
21948 explanation of when this might be needed.
21949
21950
21951 .option hosts_override smtp boolean false
21952 If this option is set and the &%hosts%& option is also set, any hosts that are
21953 attached to the address are ignored, and instead the hosts specified by the
21954 &%hosts%& option are always used. This option does not apply to
21955 &%fallback_hosts%&.
21956
21957
21958 .option hosts_randomize smtp boolean false
21959 .cindex "randomized host list"
21960 .cindex "host" "list of; randomized"
21961 .cindex "fallback" "randomized hosts"
21962 If this option is set, and either the list of hosts is taken from the
21963 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
21964 were not obtained from MX records (this includes fallback hosts from the
21965 router), and were not randomized by the router, the order of trying the hosts
21966 is randomized each time the transport runs. Randomizing the order of a host
21967 list can be used to do crude load sharing.
21968
21969 When &%hosts_randomize%& is true, a host list may be split into groups whose
21970 order is separately randomized. This makes it possible to set up MX-like
21971 behaviour. The boundaries between groups are indicated by an item that is just
21972 &`+`& in the host list. For example:
21973 .code
21974 hosts = host1:host2:host3:+:host4:host5
21975 .endd
21976 The order of the first three hosts and the order of the last two hosts is
21977 randomized for each use, but the first three always end up before the last two.
21978 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
21979
21980 .option hosts_require_auth smtp "host list&!!" unset
21981 .cindex "authentication" "required by client"
21982 This option provides a list of servers for which authentication must succeed
21983 before Exim will try to transfer a message. If authentication fails for
21984 servers which are not in this list, Exim tries to send unauthenticated. If
21985 authentication fails for one of these servers, delivery is deferred. This
21986 temporary error is detectable in the retry rules, so it can be turned into a
21987 hard failure if required. See also &%hosts_try_auth%&, and chapter
21988 &<<CHAPSMTPAUTH>>& for details of authentication.
21989
21990
21991 .option hosts_require_tls smtp "host list&!!" unset
21992 .cindex "TLS" "requiring for certain servers"
21993 Exim will insist on using a TLS session when delivering to any host that
21994 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
21995 &*Note*&: This option affects outgoing mail only. To insist on TLS for
21996 incoming messages, use an appropriate ACL.
21997
21998 .option hosts_try_auth smtp "host list&!!" unset
21999 .cindex "authentication" "optional in client"
22000 This option provides a list of servers to which, provided they announce
22001 authentication support, Exim will attempt to authenticate as a client when it
22002 connects. If authentication fails, Exim will try to transfer the message
22003 unauthenticated. See also &%hosts_require_auth%&, and chapter
22004 &<<CHAPSMTPAUTH>>& for details of authentication.
22005
22006 .option interface smtp "string list&!!" unset
22007 .cindex "bind IP address"
22008 .cindex "IP address" "binding"
22009 .vindex "&$host$&"
22010 .vindex "&$host_address$&"
22011 This option specifies which interface to bind to when making an outgoing SMTP
22012 call. The value is an IP address, not an interface name such as
22013 &`eth0`&. Do not confuse this with the interface address that was used when a
22014 message was received, which is in &$received_ip_address$&, formerly known as
22015 &$interface_address$&. The name was changed to minimize confusion with the
22016 outgoing interface address. There is no variable that contains an outgoing
22017 interface address because, unless it is set by this option, its value is
22018 unknown.
22019
22020 During the expansion of the &%interface%& option the variables &$host$& and
22021 &$host_address$& refer to the host to which a connection is about to be made
22022 during the expansion of the string. Forced expansion failure, or an empty
22023 string result causes the option to be ignored. Otherwise, after expansion, the
22024 string must be a list of IP addresses, colon-separated by default, but the
22025 separator can be changed in the usual way. For example:
22026 .code
22027 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
22028 .endd
22029 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
22030 connection. If none of them are the correct type, the option is ignored. If
22031 &%interface%& is not set, or is ignored, the system's IP functions choose which
22032 interface to use if the host has more than one.
22033
22034
22035 .option keepalive smtp boolean true
22036 .cindex "keepalive" "on outgoing connection"
22037 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
22038 connections. When set, it causes the kernel to probe idle connections
22039 periodically, by sending packets with &"old"& sequence numbers. The other end
22040 of the connection should send a acknowledgment if the connection is still okay
22041 or a reset if the connection has been aborted. The reason for doing this is
22042 that it has the beneficial effect of freeing up certain types of connection
22043 that can get stuck when the remote host is disconnected without tidying up the
22044 TCP/IP call properly. The keepalive mechanism takes several hours to detect
22045 unreachable hosts.
22046
22047
22048 .option lmtp_ignore_quota smtp boolean false
22049 .cindex "LMTP" "ignoring quota errors"
22050 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
22051 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
22052 has advertised support for IGNOREQUOTA in its response to the LHLO command.
22053
22054 .option max_rcpt smtp integer 100
22055 .cindex "RCPT" "maximum number of outgoing"
22056 This option limits the number of RCPT commands that are sent in a single
22057 SMTP message transaction. Each set of addresses is treated independently, and
22058 so can cause parallel connections to the same host if &%remote_max_parallel%&
22059 permits this.
22060
22061
22062 .option multi_domain smtp boolean true
22063 .vindex "&$domain$&"
22064 When this option is set, the &(smtp)& transport can handle a number of
22065 addresses containing a mixture of different domains provided they all resolve
22066 to the same list of hosts. Turning the option off restricts the transport to
22067 handling only one domain at a time. This is useful if you want to use
22068 &$domain$& in an expansion for the transport, because it is set only when there
22069 is a single domain involved in a remote delivery.
22070
22071
22072 .option port smtp string&!! "see below"
22073 .cindex "port" "sending TCP/IP"
22074 .cindex "TCP/IP" "setting outgoing port"
22075 This option specifies the TCP/IP port on the server to which Exim connects.
22076 &*Note:*& Do not confuse this with the port that was used when a message was
22077 received, which is in &$received_port$&, formerly known as &$interface_port$&.
22078 The name was changed to minimize confusion with the outgoing port. There is no
22079 variable that contains an outgoing port.
22080
22081 If the value of this option begins with a digit it is taken as a port number;
22082 otherwise it is looked up using &[getservbyname()]&. The default value is
22083 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
22084 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
22085 is deferred.
22086
22087
22088
22089 .option protocol smtp string smtp
22090 .cindex "LMTP" "over TCP/IP"
22091 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
22092 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
22093 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
22094 deliveries into closed message stores. Exim also has support for running LMTP
22095 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
22096
22097
22098 .option retry_include_ip_address smtp boolean true
22099 Exim normally includes both the host name and the IP address in the key it
22100 constructs for indexing retry data after a temporary delivery failure. This
22101 means that when one of several IP addresses for a host is failing, it gets
22102 tried periodically (controlled by the retry rules), but use of the other IP
22103 addresses is not affected.
22104
22105 However, in some dialup environments hosts are assigned a different IP address
22106 each time they connect. In this situation the use of the IP address as part of
22107 the retry key leads to undesirable behaviour. Setting this option false causes
22108 Exim to use only the host name. This should normally be done on a separate
22109 instance of the &(smtp)& transport, set up specially to handle the dialup
22110 hosts.
22111
22112
22113 .option serialize_hosts smtp "host list&!!" unset
22114 .cindex "serializing connections"
22115 .cindex "host" "serializing connections"
22116 Because Exim operates in a distributed manner, if several messages for the same
22117 host arrive at around the same time, more than one simultaneous connection to
22118 the remote host can occur. This is not usually a problem except when there is a
22119 slow link between the hosts. In that situation it may be helpful to restrict
22120 Exim to one connection at a time. This can be done by setting
22121 &%serialize_hosts%& to match the relevant hosts.
22122
22123 .cindex "hints database" "serializing deliveries to a host"
22124 Exim implements serialization by means of a hints database in which a record is
22125 written whenever a process connects to one of the restricted hosts. The record
22126 is deleted when the connection is completed. Obviously there is scope for
22127 records to get left lying around if there is a system or program crash. To
22128 guard against this, Exim ignores any records that are more than six hours old.
22129
22130 If you set up this kind of serialization, you should also arrange to delete the
22131 relevant hints database whenever your system reboots. The names of the files
22132 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22133 may be one or two files, depending on the type of DBM in use. The same files
22134 are used for ETRN serialization.
22135
22136
22137 .option size_addition smtp integer 1024
22138 .cindex "SMTP" "SIZE"
22139 .cindex "message" "size issue for transport filter"
22140 .cindex "size" "of message"
22141 .cindex "transport" "filter"
22142 .cindex "filter" "transport filter"
22143 If a remote SMTP server indicates that it supports the SIZE option of the
22144 MAIL command, Exim uses this to pass over the message size at the start of
22145 an SMTP transaction. It adds the value of &%size_addition%& to the value it
22146 sends, to allow for headers and other text that may be added during delivery by
22147 configuration options or in a transport filter. It may be necessary to increase
22148 this if a lot of text is added to messages.
22149
22150 Alternatively, if the value of &%size_addition%& is set negative, it disables
22151 the use of the SIZE option altogether.
22152
22153
22154 .option tls_certificate smtp string&!! unset
22155 .cindex "TLS" "client certificate, location of"
22156 .cindex "certificate" "client, location of"
22157 .vindex "&$host$&"
22158 .vindex "&$host_address$&"
22159 The value of this option must be the absolute path to a file which contains the
22160 client's certificate, for possible use when sending a message over an encrypted
22161 connection. The values of &$host$& and &$host_address$& are set to the name and
22162 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
22163 details of TLS.
22164
22165 &*Note*&: This option must be set if you want Exim to be able to use a TLS
22166 certificate when sending messages as a client. The global option of the same
22167 name specifies the certificate for Exim as a server; it is not automatically
22168 assumed that the same certificate should be used when Exim is operating as a
22169 client.
22170
22171
22172 .option tls_crl smtp string&!! unset
22173 .cindex "TLS" "client certificate revocation list"
22174 .cindex "certificate" "revocation list for client"
22175 This option specifies a certificate revocation list. The expanded value must
22176 be the name of a file that contains a CRL in PEM format.
22177
22178
22179 .option tls_privatekey smtp string&!! unset
22180 .cindex "TLS" "client private key, location of"
22181 .vindex "&$host$&"
22182 .vindex "&$host_address$&"
22183 The value of this option must be the absolute path to a file which contains the
22184 client's private key. This is used when sending a message over an encrypted
22185 connection using a client certificate. The values of &$host$& and
22186 &$host_address$& are set to the name and address of the server during the
22187 expansion. If this option is unset, or the expansion is forced to fail, or the
22188 result is an empty string, the private key is assumed to be in the same file as
22189 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
22190
22191
22192 .option tls_require_ciphers smtp string&!! unset
22193 .cindex "TLS" "requiring specific ciphers"
22194 .cindex "cipher" "requiring specific"
22195 .vindex "&$host$&"
22196 .vindex "&$host_address$&"
22197 The value of this option must be a list of permitted cipher suites, for use
22198 when setting up an outgoing encrypted connection. (There is a global option of
22199 the same name for controlling incoming connections.) The values of &$host$& and
22200 &$host_address$& are set to the name and address of the server during the
22201 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
22202 is used in different ways by OpenSSL and GnuTLS (see sections
22203 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
22204 ciphers is a preference order.
22205
22206
22207
22208 .option tls_tempfail_tryclear smtp boolean true
22209 .cindex "4&'xx'& responses" "to STARTTLS"
22210 When the server host is not in &%hosts_require_tls%&, and there is a problem in
22211 setting up a TLS session, this option determines whether or not Exim should try
22212 to deliver the message unencrypted. If it is set false, delivery to the
22213 current host is deferred; if there are other hosts, they are tried. If this
22214 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
22215 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
22216 TLS negotiation fails, Exim closes the current connection (because it is in an
22217 unknown state), opens a new one to the same host, and then tries the delivery
22218 in clear.
22219
22220
22221 .option tls_verify_certificates smtp string&!! unset
22222 .cindex "TLS" "server certificate verification"
22223 .cindex "certificate" "verification of server"
22224 .vindex "&$host$&"
22225 .vindex "&$host_address$&"
22226 The value of this option must be the absolute path to a file containing
22227 permitted server certificates, for use when setting up an encrypted connection.
22228 Alternatively, if you are using OpenSSL, you can set
22229 &%tls_verify_certificates%& to the name of a directory containing certificate
22230 files. This does not work with GnuTLS; the option must be set to the name of a
22231 single file if you are using GnuTLS. The values of &$host$& and
22232 &$host_address$& are set to the name and address of the server during the
22233 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
22234
22235
22236
22237
22238 .section "How the limits for the number of hosts to try are used" &&&
22239          "SECTvalhosmax"
22240 .cindex "host" "maximum number to try"
22241 .cindex "limit" "hosts; maximum number tried"
22242 There are two options that are concerned with the number of hosts that are
22243 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
22244 &%hosts_max_try_hardlimit%&.
22245
22246
22247 The &%hosts_max_try%& option limits the number of hosts that are tried
22248 for a single delivery. However, despite the term &"host"& in its name, the
22249 option actually applies to each IP address independently. In other words, a
22250 multihomed host is treated as several independent hosts, just as it is for
22251 retrying.
22252
22253 Many of the larger ISPs have multiple MX records which often point to
22254 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
22255 created as a result of routing one of these domains.
22256
22257 Trying every single IP address on such a long list does not seem sensible; if
22258 several at the top of the list fail, it is reasonable to assume there is some
22259 problem that is likely to affect all of them. Roughly speaking, the value of
22260 &%hosts_max_try%& is the maximum number that are tried before deferring the
22261 delivery. However, the logic cannot be quite that simple.
22262
22263 Firstly, IP addresses that are skipped because their retry times have not
22264 arrived do not count, and in addition, addresses that are past their retry
22265 limits are also not counted, even when they are tried. This means that when
22266 some IP addresses are past their retry limits, more than the value of
22267 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
22268 that all IP addresses are considered before timing out an email address (but
22269 see below for an exception).
22270
22271 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
22272 list to see if there is a subsequent host with a different (higher valued) MX.
22273 If there is, that host is considered next, and the current IP address is used
22274 but not counted. This behaviour helps in the case of a domain with a retry rule
22275 that hardly ever delays any hosts, as is now explained:
22276
22277 Consider the case of a long list of hosts with one MX value, and a few with a
22278 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
22279 hosts at the top of the list are tried at first. With the default retry rule,
22280 which specifies increasing retry times, the higher MX hosts are eventually
22281 tried when those at the top of the list are skipped because they have not
22282 reached their retry times.
22283
22284 However, it is common practice to put a fixed short retry time on domains for
22285 large ISPs, on the grounds that their servers are rarely down for very long.
22286 Unfortunately, these are exactly the domains that tend to resolve to long lists
22287 of hosts. The short retry time means that the lowest MX hosts are tried every
22288 time. The attempts may be in a different order because of random sorting, but
22289 without the special MX check, the higher MX hosts would never be tried until
22290 all the lower MX hosts had timed out (which might be several days), because
22291 there are always some lower MX hosts that have reached their retry times. With
22292 the special check, Exim considers at least one IP address from each MX value at
22293 every delivery attempt, even if the &%hosts_max_try%& limit has already been
22294 reached.
22295
22296 The above logic means that &%hosts_max_try%& is not a hard limit, and in
22297 particular, Exim normally eventually tries all the IP addresses before timing
22298 out an email address. When &%hosts_max_try%& was implemented, this seemed a
22299 reasonable thing to do. Recently, however, some lunatic DNS configurations have
22300 been set up with hundreds of IP addresses for some domains. It can
22301 take a very long time indeed for an address to time out in these cases.
22302
22303 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
22304 Exim never tries more than this number of IP addresses; if it hits this limit
22305 and they are all timed out, the email address is bounced, even though not all
22306 possible IP addresses have been tried.
22307 .ecindex IIDsmttra1
22308 .ecindex IIDsmttra2
22309
22310
22311
22312
22313
22314 . ////////////////////////////////////////////////////////////////////////////
22315 . ////////////////////////////////////////////////////////////////////////////
22316
22317 .chapter "Address rewriting" "CHAPrewrite"
22318 .scindex IIDaddrew "rewriting" "addresses"
22319 There are some circumstances in which Exim automatically rewrites domains in
22320 addresses. The two most common are when an address is given without a domain
22321 (referred to as an &"unqualified address"&) or when an address contains an
22322 abbreviated domain that is expanded by DNS lookup.
22323
22324 Unqualified envelope addresses are accepted only for locally submitted
22325 messages, or for messages that are received from hosts matching
22326 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
22327 appropriate. Unqualified addresses in header lines are qualified if they are in
22328 locally submitted messages, or messages from hosts that are permitted to send
22329 unqualified envelope addresses. Otherwise, unqualified addresses in header
22330 lines are neither qualified nor rewritten.
22331
22332 One situation in which Exim does &'not'& automatically rewrite a domain is
22333 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
22334 such a domain should be rewritten using the &"canonical"& name, and some MTAs
22335 do this. The new RFCs do not contain this suggestion.
22336
22337
22338 .section "Explicitly configured address rewriting" "SECID147"
22339 This chapter describes the rewriting rules that can be used in the
22340 main rewrite section of the configuration file, and also in the generic
22341 &%headers_rewrite%& option that can be set on any transport.
22342
22343 Some people believe that configured address rewriting is a Mortal Sin.
22344 Others believe that life is not possible without it. Exim provides the
22345 facility; you do not have to use it.
22346
22347 The main rewriting rules that appear in the &"rewrite"& section of the
22348 configuration file are applied to addresses in incoming messages, both envelope
22349 addresses and addresses in header lines. Each rule specifies the types of
22350 address to which it applies.
22351
22352 Whether or not addresses in header lines are rewritten depends on the origin of
22353 the headers and the type of rewriting. Global rewriting, that is, rewriting
22354 rules from the rewrite section of the configuration file, is applied only to
22355 those headers that were received with the message. Header lines that are added
22356 by ACLs or by a system filter or by individual routers or transports (which
22357 are specific to individual recipient addresses) are not rewritten by the global
22358 rules.
22359
22360 Rewriting at transport time, by means of the &%headers_rewrite%& option,
22361 applies all headers except those added by routers and transports. That is, as
22362 well as the headers that were received with the message, it also applies to
22363 headers that were added by an ACL or a system filter.
22364
22365
22366 In general, rewriting addresses from your own system or domain has some
22367 legitimacy. Rewriting other addresses should be done only with great care and
22368 in special circumstances. The author of Exim believes that rewriting should be
22369 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
22370 Although it can sometimes be used as a routing tool, this is very strongly
22371 discouraged.
22372
22373 There are two commonly encountered circumstances where rewriting is used, as
22374 illustrated by these examples:
22375
22376 .ilist
22377 The company whose domain is &'hitch.fict.example'& has a number of hosts that
22378 exchange mail with each other behind a firewall, but there is only a single
22379 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
22380 &'hitch.fict.example'& when sending mail off-site.
22381 .next
22382 A host rewrites the local parts of its own users so that, for example,
22383 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
22384 .endlist
22385
22386
22387
22388 .section "When does rewriting happen?" "SECID148"
22389 .cindex "rewriting" "timing of"
22390 .cindex "&ACL;" "rewriting addresses in"
22391 Configured address rewriting can take place at several different stages of a
22392 message's processing.
22393
22394 .vindex "&$sender_address$&"
22395 At the start of an ACL for MAIL, the sender address may have been rewritten
22396 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
22397 ordinary rewrite rules have yet been applied. If, however, the sender address
22398 is verified in the ACL, it is rewritten before verification, and remains
22399 rewritten thereafter. The subsequent value of &$sender_address$& is the
22400 rewritten address. This also applies if sender verification happens in a
22401 RCPT ACL. Otherwise, when the sender address is not verified, it is
22402 rewritten as soon as a message's header lines have been received.
22403
22404 .vindex "&$domain$&"
22405 .vindex "&$local_part$&"
22406 Similarly, at the start of an ACL for RCPT, the current recipient's address
22407 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
22408 rewrite rules have yet been applied to it. However, the behaviour is different
22409 from the sender address when a recipient is verified. The address is rewritten
22410 for the verification, but the rewriting is not remembered at this stage. The
22411 value of &$local_part$& and &$domain$& after verification are always the same
22412 as they were before (that is, they contain the unrewritten &-- except for
22413 SMTP-time rewriting &-- address).
22414
22415 As soon as a message's header lines have been received, all the envelope
22416 recipient addresses are permanently rewritten, and rewriting is also applied to
22417 the addresses in the header lines (if configured). This happens before adding
22418 any header lines that were specified in MAIL or RCPT ACLs, and
22419 .cindex "&[local_scan()]& function" "address rewriting; timing of"
22420 before the DATA ACL and &[local_scan()]& functions are run.
22421
22422 When an address is being routed, either for delivery or for verification,
22423 rewriting is applied immediately to child addresses that are generated by
22424 redirection, unless &%no_rewrite%& is set on the router.
22425
22426 .cindex "envelope sender" "rewriting at transport time"
22427 .cindex "rewriting" "at transport time"
22428 .cindex "header lines" "rewriting at transport time"
22429 At transport time, additional rewriting of addresses in header lines can be
22430 specified by setting the generic &%headers_rewrite%& option on a transport.
22431 This option contains rules that are identical in form to those in the rewrite
22432 section of the configuration file. They are applied to the original message
22433 header lines and any that were added by ACLs or a system filter. They are not
22434 applied to header lines that are added by routers or the transport.
22435
22436 The outgoing envelope sender can be rewritten by means of the &%return_path%&
22437 transport option. However, it is not possible to rewrite envelope recipients at
22438 transport time.
22439
22440
22441
22442
22443 .section "Testing the rewriting rules that apply on input" "SECID149"
22444 .cindex "rewriting" "testing"
22445 .cindex "testing" "rewriting"
22446 Exim's input rewriting configuration appears in a part of the run time
22447 configuration file headed by &"begin rewrite"&. It can be tested by the
22448 &%-brw%& command line option. This takes an address (which can be a full RFC
22449 2822 address) as its argument. The output is a list of how the address would be
22450 transformed by the rewriting rules for each of the different places it might
22451 appear in an incoming message, that is, for each different header and for the
22452 envelope sender and recipient fields. For example,
22453 .code
22454 exim -brw ph10@exim.workshop.example
22455 .endd
22456 might produce the output
22457 .code
22458 sender: Philip.Hazel@exim.workshop.example
22459 from: Philip.Hazel@exim.workshop.example
22460 to: ph10@exim.workshop.example
22461 cc: ph10@exim.workshop.example
22462 bcc: ph10@exim.workshop.example
22463 reply-to: Philip.Hazel@exim.workshop.example
22464 env-from: Philip.Hazel@exim.workshop.example
22465 env-to: ph10@exim.workshop.example
22466 .endd
22467 which shows that rewriting has been set up for that address when used in any of
22468 the source fields, but not when it appears as a recipient address. At the
22469 present time, there is no equivalent way of testing rewriting rules that are
22470 set for a particular transport.
22471
22472
22473 .section "Rewriting rules" "SECID150"
22474 .cindex "rewriting" "rules"
22475 The rewrite section of the configuration file consists of lines of rewriting
22476 rules in the form
22477 .display
22478 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
22479 .endd
22480 Rewriting rules that are specified for the &%headers_rewrite%& generic
22481 transport option are given as a colon-separated list. Each item in the list
22482 takes the same form as a line in the main rewriting configuration (except that
22483 any colons must be doubled, of course).
22484
22485 The formats of source patterns and replacement strings are described below.
22486 Each is terminated by white space, unless enclosed in double quotes, in which
22487 case normal quoting conventions apply inside the quotes. The flags are single
22488 characters which may appear in any order. Spaces and tabs between them are
22489 ignored.
22490
22491 For each address that could potentially be rewritten, the rules are scanned in
22492 order, and replacements for the address from earlier rules can themselves be
22493 replaced by later rules (but see the &"q"& and &"R"& flags).
22494
22495 The order in which addresses are rewritten is undefined, may change between
22496 releases, and must not be relied on, with one exception: when a message is
22497 received, the envelope sender is always rewritten first, before any header
22498 lines are rewritten. For example, the replacement string for a rewrite of an
22499 address in &'To:'& must not assume that the message's address in &'From:'& has
22500 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
22501 that the envelope sender has already been rewritten.
22502
22503 .vindex "&$domain$&"
22504 .vindex "&$local_part$&"
22505 The variables &$local_part$& and &$domain$& can be used in the replacement
22506 string to refer to the address that is being rewritten. Note that lookup-driven
22507 rewriting can be done by a rule of the form
22508 .code
22509 *@*   ${lookup ...
22510 .endd
22511 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
22512 refer to the address that is being rewritten.
22513
22514
22515 .section "Rewriting patterns" "SECID151"
22516 .cindex "rewriting" "patterns"
22517 .cindex "address list" "in a rewriting pattern"
22518 The source pattern in a rewriting rule is any item which may appear in an
22519 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
22520 single-item address list, which means that it is expanded before being tested
22521 against the address. As always, if you use a regular expression as a pattern,
22522 you must take care to escape dollar and backslash characters, or use the &`\N`&
22523 facility to suppress string expansion within the regular expression.
22524
22525 Domains in patterns should be given in lower case. Local parts in patterns are
22526 case-sensitive. If you want to do case-insensitive matching of local parts, you
22527 can use a regular expression that starts with &`^(?i)`&.
22528
22529 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
22530 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
22531 depending on the type of match which occurred. These can be used in the
22532 replacement string to insert portions of the incoming address. &$0$& always
22533 refers to the complete incoming address. When a regular expression is used, the
22534 numerical variables are set from its capturing subexpressions. For other types
22535 of pattern they are set as follows:
22536
22537 .ilist
22538 If a local part or domain starts with an asterisk, the numerical variables
22539 refer to the character strings matched by asterisks, with &$1$& associated with
22540 the first asterisk, and &$2$& with the second, if present. For example, if the
22541 pattern
22542 .code
22543 *queen@*.fict.example
22544 .endd
22545 is matched against the address &'hearts-queen@wonderland.fict.example'& then
22546 .code
22547 $0 = hearts-queen@wonderland.fict.example
22548 $1 = hearts-
22549 $2 = wonderland
22550 .endd
22551 Note that if the local part does not start with an asterisk, but the domain
22552 does, it is &$1$& that contains the wild part of the domain.
22553
22554 .next
22555 If the domain part of the pattern is a partial lookup, the wild and fixed parts
22556 of the domain are placed in the next available numerical variables. Suppose,
22557 for example, that the address &'foo@bar.baz.example'& is processed by a
22558 rewriting rule of the form
22559 .display
22560 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
22561 .endd
22562 and the key in the file that matches the domain is &`*.baz.example`&. Then
22563 .code
22564 $1 = foo
22565 $2 = bar
22566 $3 = baz.example
22567 .endd
22568 If the address &'foo@baz.example'& is looked up, this matches the same
22569 wildcard file entry, and in this case &$2$& is set to the empty string, but
22570 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
22571 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
22572 whole domain. For non-partial domain lookups, no numerical variables are set.
22573 .endlist
22574
22575
22576 .section "Rewriting replacements" "SECID152"
22577 .cindex "rewriting" "replacements"
22578 If the replacement string for a rule is a single asterisk, addresses that
22579 match the pattern and the flags are &'not'& rewritten, and no subsequent
22580 rewriting rules are scanned. For example,
22581 .code
22582 hatta@lookingglass.fict.example  *  f
22583 .endd
22584 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
22585 &'From:'& headers.
22586
22587 .vindex "&$domain$&"
22588 .vindex "&$local_part$&"
22589 If the replacement string is not a single asterisk, it is expanded, and must
22590 yield a fully qualified address. Within the expansion, the variables
22591 &$local_part$& and &$domain$& refer to the address that is being rewritten.
22592 Any letters they contain retain their original case &-- they are not lower
22593 cased. The numerical variables are set up according to the type of pattern that
22594 matched the address, as described above. If the expansion is forced to fail by
22595 the presence of &"fail"& in a conditional or lookup item, rewriting by the
22596 current rule is abandoned, but subsequent rules may take effect. Any other
22597 expansion failure causes the entire rewriting operation to be abandoned, and an
22598 entry written to the panic log.
22599
22600
22601
22602 .section "Rewriting flags" "SECID153"
22603 There are three different kinds of flag that may appear on rewriting rules:
22604
22605 .ilist
22606 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
22607 c, f, h, r, s, t.
22608 .next
22609 A flag that specifies rewriting at SMTP time: S.
22610 .next
22611 Flags that control the rewriting process: Q, q, R, w.
22612 .endlist
22613
22614 For rules that are part of the &%headers_rewrite%& generic transport option,
22615 E, F, T, and S are not permitted.
22616
22617
22618
22619 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
22620          "SECID154"
22621 .cindex "rewriting" "flags"
22622 If none of the following flag letters, nor the &"S"& flag (see section
22623 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
22624 and to both the sender and recipient fields of the envelope, whereas a
22625 transport-time rewriting rule just applies to all headers. Otherwise, the
22626 rewriting rule is skipped unless the relevant addresses are being processed.
22627 .display
22628 &`E`&       rewrite all envelope fields
22629 &`F`&       rewrite the envelope From field
22630 &`T`&       rewrite the envelope To field
22631 &`b`&       rewrite the &'Bcc:'& header
22632 &`c`&       rewrite the &'Cc:'& header
22633 &`f`&       rewrite the &'From:'& header
22634 &`h`&       rewrite all headers
22635 &`r`&       rewrite the &'Reply-To:'& header
22636 &`s`&       rewrite the &'Sender:'& header
22637 &`t`&       rewrite the &'To:'& header
22638 .endd
22639 "All headers" means all of the headers listed above that can be selected
22640 individually, plus their &'Resent-'& versions. It does not include
22641 other headers such as &'Subject:'& etc.
22642
22643 You should be particularly careful about rewriting &'Sender:'& headers, and
22644 restrict this to special known cases in your own domains.
22645
22646
22647 .section "The SMTP-time rewriting flag" "SECTrewriteS"
22648 .cindex "SMTP" "rewriting malformed addresses"
22649 .cindex "RCPT" "rewriting argument of"
22650 .cindex "MAIL" "rewriting argument of"
22651 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
22652 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
22653 before any other processing; even before syntax checking. The pattern is
22654 required to be a regular expression, and it is matched against the whole of the
22655 data for the command, including any surrounding angle brackets.
22656
22657 .vindex "&$domain$&"
22658 .vindex "&$local_part$&"
22659 This form of rewrite rule allows for the handling of addresses that are not
22660 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
22661 input). Because the input is not required to be a syntactically valid address,
22662 the variables &$local_part$& and &$domain$& are not available during the
22663 expansion of the replacement string. The result of rewriting replaces the
22664 original address in the MAIL or RCPT command.
22665
22666
22667 .section "Flags controlling the rewriting process" "SECID155"
22668 There are four flags which control the way the rewriting process works. These
22669 take effect only when a rule is invoked, that is, when the address is of the
22670 correct type (matches the flags) and matches the pattern:
22671
22672 .ilist
22673 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
22674 unqualified local part. It is qualified with &%qualify_recipient%&. In the
22675 absence of &"Q"& the rewritten address must always include a domain.
22676 .next
22677 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
22678 even if no rewriting actually takes place because of a &"fail"& in the
22679 expansion. The &"q"& flag is not effective if the address is of the wrong type
22680 (does not match the flags) or does not match the pattern.
22681 .next
22682 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
22683 address, up to ten times. It can be combined with the &"q"& flag, to stop
22684 rewriting once it fails to match (after at least one successful rewrite).
22685 .next
22686 .cindex "rewriting" "whole addresses"
22687 When an address in a header is rewritten, the rewriting normally applies only
22688 to the working part of the address, with any comments and RFC 2822 &"phrase"&
22689 left unchanged. For example, rewriting might change
22690 .code
22691 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
22692 .endd
22693 into
22694 .code
22695 From: Ford Prefect <prefectf@hitch.fict.example>
22696 .endd
22697 .cindex "RFC 2047"
22698 Sometimes there is a need to replace the whole address item, and this can be
22699 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
22700 causes an address in a header line to be rewritten, the entire address is
22701 replaced, not just the working part. The replacement must be a complete RFC
22702 2822 address, including the angle brackets if necessary. If text outside angle
22703 brackets contains a character whose value is greater than 126 or less than 32
22704 (except for tab), the text is encoded according to RFC 2047. The character set
22705 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
22706
22707 When the &"w"& flag is set on a rule that causes an envelope address to be
22708 rewritten, all but the working part of the replacement address is discarded.
22709 .endlist
22710
22711
22712 .section "Rewriting examples" "SECID156"
22713 Here is an example of the two common rewriting paradigms:
22714 .code
22715 *@*.hitch.fict.example  $1@hitch.fict.example
22716 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
22717                      {$value}fail}@hitch.fict.example bctfrF
22718 .endd
22719 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
22720 the string expansion to fail if the lookup does not succeed. In this context it
22721 has the effect of leaving the original address unchanged, but Exim goes on to
22722 consider subsequent rewriting rules, if any, because the &"q"& flag is not
22723 present in that rule. An alternative to &"fail"& would be to supply &$1$&
22724 explicitly, which would cause the rewritten address to be the same as before,
22725 at the cost of a small bit of processing. Not supplying either of these is an
22726 error, since the rewritten address would then contain no local part.
22727
22728 The first example above replaces the domain with a superior, more general
22729 domain. This may not be desirable for certain local parts. If the rule
22730 .code
22731 root@*.hitch.fict.example  *
22732 .endd
22733 were inserted before the first rule, rewriting would be suppressed for the
22734 local part &'root'& at any domain ending in &'hitch.fict.example'&.
22735
22736 Rewriting can be made conditional on a number of tests, by making use of
22737 &${if$& in the expansion item. For example, to apply a rewriting rule only to
22738 messages that originate outside the local host:
22739 .code
22740 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
22741                          {$1@hitch.fict.example}fail}"
22742 .endd
22743 The replacement string is quoted in this example because it contains white
22744 space.
22745
22746 .cindex "rewriting" "bang paths"
22747 .cindex "bang paths" "rewriting"
22748 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
22749 an address it treats it as an unqualified local part which it qualifies with
22750 the local qualification domain (if the source of the message is local or if the
22751 remote host is permitted to send unqualified addresses). Rewriting can
22752 sometimes be used to handle simple bang paths with a fixed number of
22753 components. For example, the rule
22754 .code
22755 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
22756 .endd
22757 rewrites a two-component bang path &'host.name!user'& as the domain address
22758 &'user@host.name'&. However, there is a security implication in using this as
22759 a global rewriting rule for envelope addresses. It can provide a backdoor
22760 method for using your system as a relay, because the incoming addresses appear
22761 to be local. If the bang path addresses are received via SMTP, it is safer to
22762 use the &"S"& flag to rewrite them as they are received, so that relay checking
22763 can be done on the rewritten addresses.
22764 .ecindex IIDaddrew
22765
22766
22767
22768
22769
22770 . ////////////////////////////////////////////////////////////////////////////
22771 . ////////////////////////////////////////////////////////////////////////////
22772
22773 .chapter "Retry configuration" "CHAPretry"
22774 .scindex IIDretconf1 "retry" "configuration, description of"
22775 .scindex IIDregconf2 "configuration file" "retry section"
22776 The &"retry"& section of the runtime configuration file contains a list of
22777 retry rules that control how often Exim tries to deliver messages that cannot
22778 be delivered at the first attempt. If there are no retry rules (the section is
22779 empty or not present), there are no retries. In this situation, temporary
22780 errors are treated as permanent. The default configuration contains a single,
22781 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
22782 line option can be used to test which retry rule will be used for a given
22783 address, domain and error.
22784
22785 The most common cause of retries is temporary failure to deliver to a remote
22786 host because the host is down, or inaccessible because of a network problem.
22787 Exim's retry processing in this case is applied on a per-host (strictly, per IP
22788 address) basis, not on a per-message basis. Thus, if one message has recently
22789 been delayed, delivery of a new message to the same host is not immediately
22790 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
22791 log selector is set, the message
22792 .cindex "retry" "time not reached"
22793 &"retry time not reached"& is written to the main log whenever a delivery is
22794 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
22795 the handling of errors during remote deliveries.
22796
22797 Retry processing applies to routing as well as to delivering, except as covered
22798 in the next paragraph. The retry rules do not distinguish between these
22799 actions. It is not possible, for example, to specify different behaviour for
22800 failures to route the domain &'snark.fict.example'& and failures to deliver to
22801 the host &'snark.fict.example'&. I didn't think anyone would ever need this
22802 added complication, so did not implement it. However, although they share the
22803 same retry rule, the actual retry times for routing and transporting a given
22804 domain are maintained independently.
22805
22806 When a delivery is not part of a queue run (typically an immediate delivery on
22807 receipt of a message), the routers are always run, and local deliveries are
22808 always attempted, even if retry times are set for them. This makes for better
22809 behaviour if one particular message is causing problems (for example, causing
22810 quota overflow, or provoking an error in a filter file). If such a delivery
22811 suffers a temporary failure, the retry data is updated as normal, and
22812 subsequent delivery attempts from queue runs occur only when the retry time for
22813 the local address is reached.
22814
22815 .section "Changing retry rules" "SECID157"
22816 If you change the retry rules in your configuration, you should consider
22817 whether or not to delete the retry data that is stored in Exim's spool area in
22818 files with names like &_db/retry_&. Deleting any of Exim's hints files is
22819 always safe; that is why they are called &"hints"&.
22820
22821 The hints retry data contains suggested retry times based on the previous
22822 rules. In the case of a long-running problem with a remote host, it might
22823 record the fact that the host has timed out. If your new rules increase the
22824 timeout time for such a host, you should definitely remove the old retry data
22825 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
22826 messages that it should now be retaining.
22827
22828
22829
22830 .section "Format of retry rules" "SECID158"
22831 .cindex "retry" "rules"
22832 Each retry rule occupies one line and consists of three or four parts,
22833 separated by white space: a pattern, an error name, an optional list of sender
22834 addresses, and a list of retry parameters. The pattern and sender lists must be
22835 enclosed in double quotes if they contain white space. The rules are searched
22836 in order until one is found where the pattern, error name, and sender list (if
22837 present) match the failing host or address, the error that occurred, and the
22838 message's sender, respectively.
22839
22840
22841 The pattern is any single item that may appear in an address list (see section
22842 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
22843 which means that it is expanded before being tested against the address that
22844 has been delayed. A negated address list item is permitted. Address
22845 list processing treats a plain domain name as if it were preceded by &"*@"&,
22846 which makes it possible for many retry rules to start with just a domain. For
22847 example,
22848 .code
22849 lookingglass.fict.example        *  F,24h,30m;
22850 .endd
22851 provides a rule for any address in the &'lookingglass.fict.example'& domain,
22852 whereas
22853 .code
22854 alice@lookingglass.fict.example  *  F,24h,30m;
22855 .endd
22856 applies only to temporary failures involving the local part &%alice%&.
22857 In practice, almost all rules start with a domain name pattern without a local
22858 part.
22859
22860 .cindex "regular expressions" "in retry rules"
22861 &*Warning*&: If you use a regular expression in a routing rule pattern, it
22862 must match a complete address, not just a domain, because that is how regular
22863 expressions work in address lists.
22864 .display
22865 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
22866 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
22867 .endd
22868
22869
22870 .section "Choosing which retry rule to use for address errors" "SECID159"
22871 When Exim is looking for a retry rule after a routing attempt has failed (for
22872 example, after a DNS timeout), each line in the retry configuration is tested
22873 against the complete address only if &%retry_use_local_part%& is set for the
22874 router. Otherwise, only the domain is used, except when matching against a
22875 regular expression, when the local part of the address is replaced with &"*"&.
22876 A domain on its own can match a domain pattern, or a pattern that starts with
22877 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
22878 &%check_local_user%& is true, and false for other routers.
22879
22880 Similarly, when Exim is looking for a retry rule after a local delivery has
22881 failed (for example, after a mailbox full error), each line in the retry
22882 configuration is tested against the complete address only if
22883 &%retry_use_local_part%& is set for the transport (it defaults true for all
22884 local transports).
22885
22886 .cindex "4&'xx'& responses" "retry rules for"
22887 However, when Exim is looking for a retry rule after a remote delivery attempt
22888 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
22889 whole address is always used as the key when searching the retry rules. The
22890 rule that is found is used to create a retry time for the combination of the
22891 failing address and the message's sender. It is the combination of sender and
22892 recipient that is delayed in subsequent queue runs until its retry time is
22893 reached. You can delay the recipient without regard to the sender by setting
22894 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
22895 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
22896 commands.
22897
22898
22899
22900 .section "Choosing which retry rule to use for host and message errors" &&&
22901          "SECID160"
22902 For a temporary error that is not related to an individual address (for
22903 example, a connection timeout), each line in the retry configuration is checked
22904 twice. First, the name of the remote host is used as a domain name (preceded by
22905 &"*@"& when matching a regular expression). If this does not match the line,
22906 the domain from the email address is tried in a similar fashion. For example,
22907 suppose the MX records for &'a.b.c.example'& are
22908 .code
22909 a.b.c.example  MX  5  x.y.z.example
22910                MX  6  p.q.r.example
22911                MX  7  m.n.o.example
22912 .endd
22913 and the retry rules are
22914 .code
22915 p.q.r.example    *      F,24h,30m;
22916 a.b.c.example    *      F,4d,45m;
22917 .endd
22918 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
22919 first rule matches neither the host nor the domain, so Exim looks at the second
22920 rule. This does not match the host, but it does match the domain, so it is used
22921 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
22922 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
22923 first retry rule is used, because it matches the host.
22924
22925 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
22926 first rule to determine retry times, but for all the other hosts for the domain
22927 &'a.b.c.example'&, the second rule is used. The second rule is also used if
22928 routing to &'a.b.c.example'& suffers a temporary failure.
22929
22930 &*Note*&: The host name is used when matching the patterns, not its IP address.
22931 However, if a message is routed directly to an IP address without the use of a
22932 host name, for example, if a &(manualroute)& router contains a setting such as:
22933 .code
22934 route_list = *.a.example  192.168.34.23
22935 .endd
22936 then the &"host name"& that is used when searching for a retry rule is the
22937 textual form of the IP address.
22938
22939 .section "Retry rules for specific errors" "SECID161"
22940 .cindex "retry" "specific errors; specifying"
22941 The second field in a retry rule is the name of a particular error, or an
22942 asterisk, which matches any error. The errors that can be tested for are:
22943
22944 .vlist
22945 .vitem &%auth_failed%&
22946 Authentication failed when trying to send to a host in the
22947 &%hosts_require_auth%& list in an &(smtp)& transport.
22948
22949 .vitem &%data_4xx%&
22950 A 4&'xx'& error was received for an outgoing DATA command, either immediately
22951 after the command, or after sending the message's data.
22952
22953 .vitem &%mail_4xx%&
22954 A 4&'xx'& error was received for an outgoing MAIL command.
22955
22956 .vitem &%rcpt_4xx%&
22957 A 4&'xx'& error was received for an outgoing RCPT command.
22958 .endlist
22959
22960 For the three 4&'xx'& errors, either the first or both of the x's can be given
22961 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
22962 recognize 452 errors given to RCPT commands for addresses in a certain domain,
22963 and have retries every ten minutes with a one-hour timeout, you could set up a
22964 retry rule of this form:
22965 .code
22966 the.domain.name  rcpt_452   F,1h,10m
22967 .endd
22968 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
22969 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
22970
22971 .vlist
22972 .vitem &%lost_connection%&
22973 A server unexpectedly closed the SMTP connection. There may, of course,
22974 legitimate reasons for this (host died, network died), but if it repeats a lot
22975 for the same host, it indicates something odd.
22976
22977 .vitem &%refused_MX%&
22978 A connection to a host obtained from an MX record was refused.
22979
22980 .vitem &%refused_A%&
22981 A connection to a host not obtained from an MX record was refused.
22982
22983 .vitem &%refused%&
22984 A connection was refused.
22985
22986 .vitem &%timeout_connect_MX%&
22987 A connection attempt to a host obtained from an MX record timed out.
22988
22989 .vitem &%timeout_connect_A%&
22990 A connection attempt to a host not obtained from an MX record timed out.
22991
22992 .vitem &%timeout_connect%&
22993 A connection attempt timed out.
22994
22995 .vitem &%timeout_MX%&
22996 There was a timeout while connecting or during an SMTP session with a host
22997 obtained from an MX record.
22998
22999 .vitem &%timeout_A%&
23000 There was a timeout while connecting or during an SMTP session with a host not
23001 obtained from an MX record.
23002
23003 .vitem &%timeout%&
23004 There was a timeout while connecting or during an SMTP session.
23005
23006 .vitem &%tls_required%&
23007 The server was required to use TLS (it matched &%hosts_require_tls%& in the
23008 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
23009 to STARTTLS, or there was a problem setting up the TLS connection.
23010
23011 .vitem &%quota%&
23012 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23013 transport.
23014
23015 .vitem &%quota_%&<&'time'&>
23016 .cindex "quota" "error testing in retry rule"
23017 .cindex "retry" "quota error testing"
23018 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23019 transport, and the mailbox has not been accessed for <&'time'&>. For example,
23020 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
23021 for four days.
23022 .endlist
23023
23024 .cindex "mailbox" "time of last read"
23025 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
23026 timeouts when the mailbox is full and is not being read by its owner. Ideally,
23027 it should be based on the last time that the user accessed the mailbox.
23028 However, it is not always possible to determine this. Exim uses the following
23029 heuristic rules:
23030
23031 .ilist
23032 If the mailbox is a single file, the time of last access (the &"atime"&) is
23033 used. As no new messages are being delivered (because the mailbox is over
23034 quota), Exim does not access the file, so this is the time of last user access.
23035 .next
23036 .cindex "maildir format" "time of last read"
23037 For a maildir delivery, the time of last modification of the &_new_&
23038 subdirectory is used. As the mailbox is over quota, no new files are created in
23039 the &_new_& subdirectory, because no new messages are being delivered. Any
23040 change to the &_new_& subdirectory is therefore assumed to be the result of an
23041 MUA moving a new message to the &_cur_& directory when it is first read. The
23042 time that is used is therefore the last time that the user read a new message.
23043 .next
23044 For other kinds of multi-file mailbox, the time of last access cannot be
23045 obtained, so a retry rule that uses this type of error field is never matched.
23046 .endlist
23047
23048 The quota errors apply both to system-enforced quotas and to Exim's own quota
23049 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
23050 when a local delivery is deferred because a partition is full (the ENOSPC
23051 error).
23052
23053
23054
23055 .section "Retry rules for specified senders" "SECID162"
23056 .cindex "retry" "rules; sender-specific"
23057 You can specify retry rules that apply only when the failing message has a
23058 specific sender. In particular, this can be used to define retry rules that
23059 apply only to bounce messages. The third item in a retry rule can be of this
23060 form:
23061 .display
23062 &`senders=`&<&'address list'&>
23063 .endd
23064 The retry timings themselves are then the fourth item. For example:
23065 .code
23066 *   rcpt_4xx   senders=:   F,1h,30m
23067 .endd
23068 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
23069 host. If the address list contains white space, it must be enclosed in quotes.
23070 For example:
23071 .code
23072 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
23073 .endd
23074 &*Warning*&: This facility can be unhelpful if it is used for host errors
23075 (which do not depend on the recipient). The reason is that the sender is used
23076 only to match the retry rule. Once the rule has been found for a host error,
23077 its contents are used to set a retry time for the host, and this will apply to
23078 all messages, not just those with specific senders.
23079
23080 When testing retry rules using &%-brt%&, you can supply a sender using the
23081 &%-f%& command line option, like this:
23082 .code
23083 exim -f "" -brt user@dom.ain
23084 .endd
23085 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
23086 list is never matched.
23087
23088
23089
23090
23091
23092 .section "Retry parameters" "SECID163"
23093 .cindex "retry" "parameters in rules"
23094 The third (or fourth, if a senders list is present) field in a retry rule is a
23095 sequence of retry parameter sets, separated by semicolons. Each set consists of
23096 .display
23097 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
23098 .endd
23099 The letter identifies the algorithm for computing a new retry time; the cutoff
23100 time is the time beyond which this algorithm no longer applies, and the
23101 arguments vary the algorithm's action. The cutoff time is measured from the
23102 time that the first failure for the domain (combined with the local part if
23103 relevant) was detected, not from the time the message was received.
23104
23105 .cindex "retry" "algorithms"
23106 .cindex "retry" "fixed intervals"
23107 .cindex "retry" "increasing intervals"
23108 .cindex "retry" "random intervals"
23109 The available algorithms are:
23110
23111 .ilist
23112 &'F'&: retry at fixed intervals. There is a single time parameter specifying
23113 the interval.
23114 .next
23115 &'G'&: retry at geometrically increasing intervals. The first argument
23116 specifies a starting value for the interval, and the second a multiplier, which
23117 is used to increase the size of the interval at each retry.
23118 .next
23119 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
23120 retry, the previous interval is multiplied by the factor in order to get a
23121 maximum for the next interval. The minimum interval is the first argument of
23122 the parameter, and an actual interval is chosen randomly between them. Such a
23123 rule has been found to be helpful in cluster configurations when all the
23124 members of the cluster restart at once, and may therefore synchronize their
23125 queue processing times.
23126 .endlist
23127
23128 When computing the next retry time, the algorithm definitions are scanned in
23129 order until one whose cutoff time has not yet passed is reached. This is then
23130 used to compute a new retry time that is later than the current time. In the
23131 case of fixed interval retries, this simply means adding the interval to the
23132 current time. For geometrically increasing intervals, retry intervals are
23133 computed from the rule's parameters until one that is greater than the previous
23134 interval is found. The main configuration variable
23135 .cindex "limit" "retry interval"
23136 .cindex "retry" "interval, maximum"
23137 .oindex "&%retry_interval_max%&"
23138 &%retry_interval_max%& limits the maximum interval between retries. It
23139 cannot be set greater than &`24h`&, which is its default value.
23140
23141 A single remote domain may have a number of hosts associated with it, and each
23142 host may have more than one IP address. Retry algorithms are selected on the
23143 basis of the domain name, but are applied to each IP address independently. If,
23144 for example, a host has two IP addresses and one is unusable, Exim will
23145 generate retry times for it and will not try to use it until its next retry
23146 time comes. Thus the good IP address is likely to be tried first most of the
23147 time.
23148
23149 .cindex "hints database" "use for retrying"
23150 Retry times are hints rather than promises. Exim does not make any attempt to
23151 run deliveries exactly at the computed times. Instead, a queue runner process
23152 starts delivery processes for delayed messages periodically, and these attempt
23153 new deliveries only for those addresses that have passed their next retry time.
23154 If a new message arrives for a deferred address, an immediate delivery attempt
23155 occurs only if the address has passed its retry time. In the absence of new
23156 messages, the minimum time between retries is the interval between queue runner
23157 processes. There is not much point in setting retry times of five minutes if
23158 your queue runners happen only once an hour, unless there are a significant
23159 number of incoming messages (which might be the case on a system that is
23160 sending everything to a smart host, for example).
23161
23162 The data in the retry hints database can be inspected by using the
23163 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
23164 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
23165 &'exinext'& utility script can be used to find out what the next retry times
23166 are for the hosts associated with a particular mail domain, and also for local
23167 deliveries that have been deferred.
23168
23169
23170 .section "Retry rule examples" "SECID164"
23171 Here are some example retry rules:
23172 .code
23173 alice@wonderland.fict.example quota_5d  F,7d,3h
23174 wonderland.fict.example       quota_5d
23175 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
23176 lookingglass.fict.example     *         F,24h,30m;
23177 *                 refused_A   F,2h,20m;
23178 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
23179 .endd
23180 The first rule sets up special handling for mail to
23181 &'alice@wonderland.fict.example'& when there is an over-quota error and the
23182 mailbox has not been read for at least 5 days. Retries continue every three
23183 hours for 7 days. The second rule handles over-quota errors for all other local
23184 parts at &'wonderland.fict.example'&; the absence of a local part has the same
23185 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
23186 fail are bounced immediately if the mailbox has not been read for at least 5
23187 days.
23188
23189 The third rule handles all other errors at &'wonderland.fict.example'&; retries
23190 happen every 15 minutes for an hour, then with geometrically increasing
23191 intervals until two days have passed since a delivery first failed. After the
23192 first hour there is a delay of one hour, then two hours, then four hours, and
23193 so on (this is a rather extreme example).
23194
23195 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
23196 They happen every 30 minutes for 24 hours only. The remaining two rules handle
23197 all other domains, with special action for connection refusal from hosts that
23198 were not obtained from an MX record.
23199
23200 The final rule in a retry configuration should always have asterisks in the
23201 first two fields so as to provide a general catch-all for any addresses that do
23202 not have their own special handling. This example tries every 15 minutes for 2
23203 hours, then with intervals starting at one hour and increasing by a factor of
23204 1.5 up to 16 hours, then every 8 hours up to 5 days.
23205
23206
23207
23208 .section "Timeout of retry data" "SECID165"
23209 .cindex "timeout" "of retry data"
23210 .oindex "&%retry_data_expire%&"
23211 .cindex "hints database" "data expiry"
23212 .cindex "retry" "timeout of data"
23213 Exim timestamps the data that it writes to its retry hints database. When it
23214 consults the data during a delivery it ignores any that is older than the value
23215 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
23216 been tried for 7 days, Exim will try to deliver to it immediately a message
23217 arrives, and if that fails, it will calculate a retry time as if it were
23218 failing for the first time.
23219
23220 This improves the behaviour for messages routed to rarely-used hosts such as MX
23221 backups. If such a host was down at one time, and happens to be down again when
23222 Exim tries a month later, using the old retry data would imply that it had been
23223 down all the time, which is not a justified assumption.
23224
23225 If a host really is permanently dead, this behaviour causes a burst of retries
23226 every now and again, but only if messages routed to it are rare. If there is a
23227 message at least once every 7 days the retry data never expires.
23228
23229
23230
23231
23232 .section "Long-term failures" "SECID166"
23233 .cindex "delivery failure, long-term"
23234 .cindex "retry" "after long-term failure"
23235 Special processing happens when an email address has been failing for so long
23236 that the cutoff time for the last algorithm is reached. For example, using the
23237 default retry rule:
23238 .code
23239 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
23240 .endd
23241 the cutoff time is four days. Reaching the retry cutoff is independent of how
23242 long any specific message has been failing; it is the length of continuous
23243 failure for the recipient address that counts.
23244
23245 When the cutoff time is reached for a local delivery, or for all the IP
23246 addresses associated with a remote delivery, a subsequent delivery failure
23247 causes Exim to give up on the address, and a bounce message is generated.
23248 In order to cater for new messages that use the failing address, a next retry
23249 time is still computed from the final algorithm, and is used as follows:
23250
23251 For local deliveries, one delivery attempt is always made for any subsequent
23252 messages. If this delivery fails, the address fails immediately. The
23253 post-cutoff retry time is not used.
23254
23255 If the delivery is remote, there are two possibilities, controlled by the
23256 .oindex "&%delay_after_cutoff%&"
23257 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
23258 default. Until the post-cutoff retry time for one of the IP addresses is
23259 reached, the failing email address is bounced immediately, without a delivery
23260 attempt taking place. After that time, one new delivery attempt is made to
23261 those IP addresses that are past their retry times, and if that still fails,
23262 the address is bounced and new retry times are computed.
23263
23264 In other words, when all the hosts for a given email address have been failing
23265 for a long time, Exim bounces rather then defers until one of the hosts' retry
23266 times is reached. Then it tries once, and bounces if that attempt fails. This
23267 behaviour ensures that few resources are wasted in repeatedly trying to deliver
23268 to a broken destination, but if the host does recover, Exim will eventually
23269 notice.
23270
23271 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23272 addresses are past their final cutoff time, Exim tries to deliver to those IP
23273 addresses that have not been tried since the message arrived. If there are
23274 no suitable IP addresses, or if they all fail, the address is bounced. In other
23275 words, it does not delay when a new message arrives, but tries the expired
23276 addresses immediately, unless they have been tried since the message arrived.
23277 If there is a continuous stream of messages for the failing domains, setting
23278 &%delay_after_cutoff%& false means that there will be many more attempts to
23279 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
23280 true.
23281
23282 .section "Deliveries that work intermittently" "SECID167"
23283 .cindex "retry" "intermittently working deliveries"
23284 Some additional logic is needed to cope with cases where a host is
23285 intermittently available, or when a message has some attribute that prevents
23286 its delivery when others to the same address get through. In this situation,
23287 because some messages are successfully delivered, the &"retry clock"& for the
23288 host or address keeps getting reset by the successful deliveries, and so
23289 failing messages remain on the queue for ever because the cutoff time is never
23290 reached.
23291
23292 Two exceptional actions are applied to prevent this happening. The first
23293 applies to errors that are related to a message rather than a remote host.
23294 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
23295 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
23296 commands, and quota failures. For this type of error, if a message's arrival
23297 time is earlier than the &"first failed"& time for the error, the earlier time
23298 is used when scanning the retry rules to decide when to try next and when to
23299 time out the address.
23300
23301 The exceptional second action applies in all cases. If a message has been on
23302 the queue for longer than the cutoff time of any applicable retry rule for a
23303 given address, a delivery is attempted for that address, even if it is not yet
23304 time, and if this delivery fails, the address is timed out. A new retry time is
23305 not computed in this case, so that other messages for the same address are
23306 considered immediately.
23307 .ecindex IIDretconf1
23308 .ecindex IIDregconf2
23309
23310
23311
23312
23313
23314
23315 . ////////////////////////////////////////////////////////////////////////////
23316 . ////////////////////////////////////////////////////////////////////////////
23317
23318 .chapter "SMTP authentication" "CHAPSMTPAUTH"
23319 .scindex IIDauthconf1 "SMTP" "authentication configuration"
23320 .scindex IIDauthconf2 "authentication"
23321 The &"authenticators"& section of Exim's run time configuration is concerned
23322 with SMTP authentication. This facility is an extension to the SMTP protocol,
23323 described in RFC 2554, which allows a client SMTP host to authenticate itself
23324 to a server. This is a common way for a server to recognize clients that are
23325 permitted to use it as a relay. SMTP authentication is not of relevance to the
23326 transfer of mail between servers that have no managerial connection with each
23327 other.
23328
23329 .cindex "AUTH" "description of"
23330 Very briefly, the way SMTP authentication works is as follows:
23331
23332 .ilist
23333 The server advertises a number of authentication &'mechanisms'& in response to
23334 the client's EHLO command.
23335 .next
23336 The client issues an AUTH command, naming a specific mechanism. The command
23337 may, optionally, contain some authentication data.
23338 .next
23339 The server may issue one or more &'challenges'&, to which the client must send
23340 appropriate responses. In simple authentication mechanisms, the challenges are
23341 just prompts for user names and passwords. The server does not have to issue
23342 any challenges &-- in some mechanisms the relevant data may all be transmitted
23343 with the AUTH command.
23344 .next
23345 The server either accepts or denies authentication.
23346 .next
23347 If authentication succeeds, the client may optionally make use of the AUTH
23348 option on the MAIL command to pass an authenticated sender in subsequent
23349 mail transactions. Authentication lasts for the remainder of the SMTP
23350 connection.
23351 .next
23352 If authentication fails, the client may give up, or it may try a different
23353 authentication mechanism, or it may try transferring mail over the
23354 unauthenticated connection.
23355 .endlist
23356
23357 If you are setting up a client, and want to know which authentication
23358 mechanisms the server supports, you can use Telnet to connect to port 25 (the
23359 SMTP port) on the server, and issue an EHLO command. The response to this
23360 includes the list of supported mechanisms. For example:
23361 .display
23362 &`$ `&&*&`telnet server.example 25`&*&
23363 &`Trying 192.168.34.25...`&
23364 &`Connected to server.example.`&
23365 &`Escape character is &#x0027;^]&#x0027;.`&
23366 &`220 server.example ESMTP Exim 4.20 ...`&
23367 &*&`ehlo client.example`&*&
23368 &`250-server.example Hello client.example [10.8.4.5]`&
23369 &`250-SIZE 52428800`&
23370 &`250-PIPELINING`&
23371 &`250-AUTH PLAIN`&
23372 &`250 HELP`&
23373 .endd
23374 The second-last line of this example output shows that the server supports
23375 authentication using the PLAIN mechanism. In Exim, the different authentication
23376 mechanisms are configured by specifying &'authenticator'& drivers. Like the
23377 routers and transports, which authenticators are included in the binary is
23378 controlled by build-time definitions. The following are currently available,
23379 included by setting
23380 .code
23381 AUTH_CRAM_MD5=yes
23382 AUTH_CYRUS_SASL=yes
23383 AUTH_PLAINTEXT=yes
23384 AUTH_SPA=yes
23385 .endd
23386 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
23387 authentication mechanism (RFC 2195), and the second provides an interface to
23388 the Cyrus SASL authentication library. The third can be configured to support
23389 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
23390 not formally documented, but used by several MUAs. The fourth authenticator
23391 supports Microsoft's &'Secure Password Authentication'& mechanism.
23392
23393 The authenticators are configured using the same syntax as other drivers (see
23394 section &<<SECTfordricon>>&). If no authenticators are required, no
23395 authentication section need be present in the configuration file. Each
23396 authenticator can in principle have both server and client functions. When Exim
23397 is receiving SMTP mail, it is acting as a server; when it is sending out
23398 messages over SMTP, it is acting as a client. Authenticator configuration
23399 options are provided for use in both these circumstances.
23400
23401 To make it clear which options apply to which situation, the prefixes
23402 &%server_%& and &%client_%& are used on option names that are specific to
23403 either the server or the client function, respectively. Server and client
23404 functions are disabled if none of their options are set. If an authenticator is
23405 to be used for both server and client functions, a single definition, using
23406 both sets of options, is required. For example:
23407 .code
23408 cram:
23409   driver = cram_md5
23410   public_name = CRAM-MD5
23411   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
23412   client_name = ph10
23413   client_secret = secret2
23414 .endd
23415 The &%server_%& option is used when Exim is acting as a server, and the
23416 &%client_%& options when it is acting as a client.
23417
23418 Descriptions of the individual authenticators are given in subsequent chapters.
23419 The remainder of this chapter covers the generic options for the
23420 authenticators, followed by general discussion of the way authentication works
23421 in Exim.
23422
23423
23424
23425 .section "Generic options for authenticators" "SECID168"
23426 .cindex "authentication" "generic options"
23427 .cindex "options" "generic; for authenticators"
23428
23429 .option client_condition authenticators string&!! unset
23430 When Exim is authenticating as a client, it skips any authenticator whose
23431 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
23432 used, for example, to skip plain text authenticators when the connection is not
23433 encrypted by a setting such as:
23434 .code
23435 client_condition = ${if !eq{$tls_cipher}{}}
23436 .endd
23437 (Older documentation incorrectly states that &$tls_cipher$& contains the cipher
23438 used for incoming messages. In fact, during SMTP delivery, it contains the
23439 cipher used for the delivery.)
23440
23441
23442 .option driver authenticators string unset
23443 This option must always be set. It specifies which of the available
23444 authenticators is to be used.
23445
23446
23447 .option public_name authenticators string unset
23448 This option specifies the name of the authentication mechanism that the driver
23449 implements, and by which it is known to the outside world. These names should
23450 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
23451 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
23452 defaults to the driver's instance name.
23453
23454
23455 .option server_advertise_condition authenticators string&!! unset
23456 When a server is about to advertise an authentication mechanism, the condition
23457 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
23458 mechanism is not advertised.
23459 If the expansion fails, the mechanism is not advertised. If the failure was not
23460 forced, and was not caused by a lookup defer, the incident is logged.
23461 See section &<<SECTauthexiser>>& below for further discussion.
23462
23463
23464 .option server_condition authenticators string&!! unset
23465 This option must be set for a &%plaintext%& server authenticator, where it
23466 is used directly to control authentication. See section &<<SECTplainserver>>&
23467 for details.
23468
23469 For the other authenticators, &%server_condition%& can be used as an additional
23470 authentication or authorization mechanism that is applied after the other
23471 authenticator conditions succeed. If it is set, it is expanded when the
23472 authenticator would otherwise return a success code. If the expansion is forced
23473 to fail, authentication fails. Any other expansion failure causes a temporary
23474 error code to be returned. If the result of a successful expansion is an empty
23475 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23476 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
23477 other result, a temporary error code is returned, with the expanded string as
23478 the error text.
23479
23480
23481 .option server_debug_print authenticators string&!! unset
23482 If this option is set and authentication debugging is enabled (see the &%-d%&
23483 command line option), the string is expanded and included in the debugging
23484 output when the authenticator is run as a server. This can help with checking
23485 out the values of variables.
23486 If expansion of the string fails, the error message is written to the debugging
23487 output, and Exim carries on processing.
23488
23489
23490 .option server_set_id authenticators string&!! unset
23491 .vindex "&$authenticated_id$&"
23492 When an Exim server successfully authenticates a client, this string is
23493 expanded using data from the authentication, and preserved for any incoming
23494 messages in the variable &$authenticated_id$&. It is also included in the log
23495 lines for incoming messages. For example, a user/password authenticator
23496 configuration might preserve the user name that was used to authenticate, and
23497 refer to it subsequently during delivery of the message.
23498 If expansion fails, the option is ignored.
23499
23500
23501 .option server_mail_auth_condition authenticators string&!! unset
23502 This option allows a server to discard authenticated sender addresses supplied
23503 as part of MAIL commands in SMTP connections that are authenticated by the
23504 driver on which &%server_mail_auth_condition%& is set. The option is not used
23505 as part of the authentication process; instead its (unexpanded) value is
23506 remembered for later use.
23507 How it is used is described in the following section.
23508
23509
23510
23511
23512
23513 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
23514 .cindex "authentication" "sender; authenticated"
23515 .cindex "AUTH" "on MAIL command"
23516 When a client supplied an AUTH= item on a MAIL command, Exim applies
23517 the following checks before accepting it as the authenticated sender of the
23518 message:
23519
23520 .ilist
23521 If the connection is not using extended SMTP (that is, HELO was used rather
23522 than EHLO), the use of AUTH= is a syntax error.
23523 .next
23524 If the value of the AUTH= parameter is &"<>"&, it is ignored.
23525 .next
23526 .vindex "&$authenticated_sender$&"
23527 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
23528 running, the value of &$authenticated_sender$& is set to the value obtained
23529 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
23530 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
23531 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
23532 given for the MAIL command.
23533 .next
23534 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
23535 is accepted and placed in &$authenticated_sender$& only if the client has
23536 authenticated.
23537 .next
23538 If the AUTH= value was accepted by either of the two previous rules, and
23539 the client has authenticated, and the authenticator has a setting for the
23540 &%server_mail_auth_condition%&, the condition is checked at this point. The
23541 valued that was saved from the authenticator is expanded. If the expansion
23542 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
23543 &$authenticated_sender$& is deleted. If the expansion yields any other value,
23544 the value of &$authenticated_sender$& is retained and passed on with the
23545 message.
23546 .endlist
23547
23548
23549 When &$authenticated_sender$& is set for a message, it is passed on to other
23550 hosts to which Exim authenticates as a client. Do not confuse this value with
23551 &$authenticated_id$&, which is a string obtained from the authentication
23552 process, and which is not usually a complete email address.
23553
23554 .vindex "&$sender_address$&"
23555 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
23556 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
23557 therefore make use of &$authenticated_sender$&. The converse is not true: the
23558 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
23559 ACL is run.
23560
23561
23562
23563 .section "Authentication on an Exim server" "SECTauthexiser"
23564 .cindex "authentication" "on an Exim server"
23565 When Exim receives an EHLO command, it advertises the public names of those
23566 authenticators that are configured as servers, subject to the following
23567 conditions:
23568
23569 .ilist
23570 The client host must match &%auth_advertise_hosts%& (default *).
23571 .next
23572 It the &%server_advertise_condition%& option is set, its expansion must not
23573 yield the empty string, &"0"&, &"no"&, or &"false"&.
23574 .endlist
23575
23576 The order in which the authenticators are defined controls the order in which
23577 the mechanisms are advertised.
23578
23579 Some mail clients (for example, some versions of Netscape) require the user to
23580 provide a name and password for authentication whenever AUTH is advertised,
23581 even though authentication may not in fact be needed (for example, Exim may be
23582 set up to allow unconditional relaying from the client by an IP address check).
23583 You can make such clients more friendly by not advertising AUTH to them.
23584 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
23585 that runs for RCPT) to relay without authentication, you should set
23586 .code
23587 auth_advertise_hosts = ! 10.9.8.0/24
23588 .endd
23589 so that no authentication mechanisms are advertised to them.
23590
23591 The &%server_advertise_condition%& controls the advertisement of individual
23592 authentication mechanisms. For example, it can be used to restrict the
23593 advertisement of a particular mechanism to encrypted connections, by a setting
23594 such as:
23595 .code
23596 server_advertise_condition = ${if eq{$tls_cipher}{}{no}{yes}}
23597 .endd
23598 .vindex "&$tls_cipher$&"
23599 If the session is encrypted, &$tls_cipher$& is not empty, and so the expansion
23600 yields &"yes"&, which allows the advertisement to happen.
23601
23602 When an Exim server receives an AUTH command from a client, it rejects it
23603 immediately if AUTH was not advertised in response to an earlier EHLO
23604 command. This is the case if
23605
23606 .ilist
23607 The client host does not match &%auth_advertise_hosts%&; or
23608 .next
23609 No authenticators are configured with server options; or
23610 .next
23611 Expansion of &%server_advertise_condition%& blocked the advertising of all the
23612 server authenticators.
23613 .endlist
23614
23615
23616 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
23617 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
23618 AUTH is accepted from any client host.
23619
23620 If AUTH is not rejected by the ACL, Exim searches its configuration for a
23621 server authentication mechanism that was advertised in response to EHLO and
23622 that matches the one named in the AUTH command. If it finds one, it runs
23623 the appropriate authentication protocol, and authentication either succeeds or
23624 fails. If there is no matching advertised mechanism, the AUTH command is
23625 rejected with a 504 error.
23626
23627 .vindex "&$received_protocol$&"
23628 .vindex "&$sender_host_authenticated$&"
23629 When a message is received from an authenticated host, the value of
23630 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
23631 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
23632 public name) of the authenticator driver that successfully authenticated the
23633 client from which the message was received. This variable is empty if there was
23634 no successful authentication.
23635
23636
23637
23638
23639 .section "Testing server authentication" "SECID169"
23640 .cindex "authentication" "testing a server"
23641 .cindex "AUTH" "testing a server"
23642 .cindex "base64 encoding" "creating authentication test data"
23643 Exim's &%-bh%& option can be useful for testing server authentication
23644 configurations. The data for the AUTH command has to be sent using base64
23645 encoding. A quick way to produce such data for testing is the following Perl
23646 script:
23647 .code
23648 use MIME::Base64;
23649 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
23650 .endd
23651 .cindex "binary zero" "in authentication data"
23652 This interprets its argument as a Perl string, and then encodes it. The
23653 interpretation as a Perl string allows binary zeros, which are required for
23654 some kinds of authentication, to be included in the data. For example, a
23655 command line to run this script on such data might be
23656 .code
23657 encode '\0user\0password'
23658 .endd
23659 Note the use of single quotes to prevent the shell interpreting the
23660 backslashes, so that they can be interpreted by Perl to specify characters
23661 whose code value is zero.
23662
23663 &*Warning 1*&: If either of the user or password strings starts with an octal
23664 digit, you must use three zeros instead of one after the leading backslash. If
23665 you do not, the octal digit that starts your string will be incorrectly
23666 interpreted as part of the code for the first character.
23667
23668 &*Warning 2*&: If there are characters in the strings that Perl interprets
23669 specially, you must use a Perl escape to prevent them being misinterpreted. For
23670 example, a command such as
23671 .code
23672 encode '\0user@domain.com\0pas$$word'
23673 .endd
23674 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
23675
23676 If you have the &%mimencode%& command installed, another way to do produce
23677 base64-encoded strings is to run the command
23678 .code
23679 echo -e -n `\0user\0password' | mimencode
23680 .endd
23681 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
23682 in the argument, and the &%-n%& option specifies no newline at the end of its
23683 output. However, not all versions of &%echo%& recognize these options, so you
23684 should check your version before relying on this suggestion.
23685
23686
23687
23688 .section "Authentication by an Exim client" "SECID170"
23689 .cindex "authentication" "on an Exim client"
23690 The &(smtp)& transport has two options called &%hosts_require_auth%& and
23691 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
23692 announces support for authentication, and the host matches an entry in either
23693 of these options, Exim (as a client) tries to authenticate as follows:
23694
23695 .ilist
23696 For each authenticator that is configured as a client, in the order in which
23697 they are defined in the configuration, it searches the authentication
23698 mechanisms announced by the server for one whose name matches the public name
23699 of the authenticator.
23700 .next
23701 .vindex "&$host$&"
23702 .vindex "&$host_address$&"
23703 When it finds one that matches, it runs the authenticator's client code. The
23704 variables &$host$& and &$host_address$& are available for any string expansions
23705 that the client might do. They are set to the server's name and IP address. If
23706 any expansion is forced to fail, the authentication attempt is abandoned, and
23707 Exim moves on to the next authenticator. Otherwise an expansion failure causes
23708 delivery to be deferred.
23709 .next
23710 If the result of the authentication attempt is a temporary error or a timeout,
23711 Exim abandons trying to send the message to the host for the moment. It will
23712 try again later. If there are any backup hosts available, they are tried in the
23713 usual way.
23714 .next
23715 If the response to authentication is a permanent error (5&'xx'& code), Exim
23716 carries on searching the list of authenticators and tries another one if
23717 possible. If all authentication attempts give permanent errors, or if there are
23718 no attempts because no mechanisms match (or option expansions force failure),
23719 what happens depends on whether the host matches &%hosts_require_auth%& or
23720 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
23721 delivery is deferred. The error can be detected in the retry rules, and thereby
23722 turned into a permanent error if you wish. In the second case, Exim tries to
23723 deliver the message unauthenticated.
23724 .endlist
23725
23726 .cindex "AUTH" "on MAIL command"
23727 When Exim has authenticated itself to a remote server, it adds the AUTH
23728 parameter to the MAIL commands it sends, if it has an authenticated sender for
23729 the message. If the message came from a remote host, the authenticated sender
23730 is the one that was receiving on an incoming MAIL command, provided that the
23731 incoming connection was authenticated and the &%server_mail_auth%& condition
23732 allowed the authenticated sender to be retained. If a local process calls Exim
23733 to send a message, the sender address that is built from the login name and
23734 &%qualify_domain%& is treated as authenticated. However, if the
23735 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
23736 the authenticated sender that was received with the message.
23737 .ecindex IIDauthconf1
23738 .ecindex IIDauthconf2
23739
23740
23741
23742
23743
23744
23745 . ////////////////////////////////////////////////////////////////////////////
23746 . ////////////////////////////////////////////////////////////////////////////
23747
23748 .chapter "The plaintext authenticator" "CHAPplaintext"
23749 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
23750 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
23751 The &(plaintext)& authenticator can be configured to support the PLAIN and
23752 LOGIN authentication mechanisms, both of which transfer authentication data as
23753 plain (unencrypted) text (though base64 encoded). The use of plain text is a
23754 security risk; you are strongly advised to insist on the use of SMTP encryption
23755 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
23756 use unencrypted plain text, you should not use the same passwords for SMTP
23757 connections as you do for login accounts.
23758
23759 .section "Plaintext options" "SECID171"
23760 .cindex "options" "&(plaintext)& authenticator (server)"
23761 When configured as a server, &(plaintext)& uses the following options:
23762
23763 .option server_condition authenticators string&!! unset
23764 This is actually a global authentication option, but it must be set in order to
23765 configure the &(plaintext)& driver as a server. Its use is described below.
23766
23767 .option server_prompts plaintext string&!! unset
23768 The contents of this option, after expansion, must be a colon-separated list of
23769 prompt strings. If expansion fails, a temporary authentication rejection is
23770 given.
23771
23772 .section "Using plaintext in a server" "SECTplainserver"
23773 .cindex "AUTH" "in &(plaintext)& authenticator"
23774 .cindex "binary zero" "in &(plaintext)& authenticator"
23775 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
23776         "in &(plaintext)& authenticator"
23777 .vindex "&$auth1$&, &$auth2$&, etc"
23778 .cindex "base64 encoding" "in &(plaintext)& authenticator"
23779
23780 When running as a server, &(plaintext)& performs the authentication test by
23781 expanding a string. The data sent by the client with the AUTH command, or in
23782 response to subsequent prompts, is base64 encoded, and so may contain any byte
23783 values when decoded. If any data is supplied with the command, it is treated as
23784 a list of strings, separated by NULs (binary zeros), the first three of which
23785 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
23786 (neither LOGIN nor PLAIN uses more than three strings).
23787
23788 For compatibility with previous releases of Exim, the values are also placed in
23789 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
23790 variables for this purpose is now deprecated, as it can lead to confusion in
23791 string expansions that also use them for other things.
23792
23793 If there are more strings in &%server_prompts%& than the number of strings
23794 supplied with the AUTH command, the remaining prompts are used to obtain more
23795 data. Each response from the client may be a list of NUL-separated strings.
23796
23797 .vindex "&$authenticated_id$&"
23798 Once a sufficient number of data strings have been received,
23799 &%server_condition%& is expanded. If the expansion is forced to fail,
23800 authentication fails. Any other expansion failure causes a temporary error code
23801 to be returned. If the result of a successful expansion is an empty string,
23802 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23803 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
23804 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
23805 For any other result, a temporary error code is returned, with the expanded
23806 string as the error text.
23807
23808 &*Warning*&: If you use a lookup in the expansion to find the user's
23809 password, be sure to make the authentication fail if the user is unknown.
23810 There are good and bad examples at the end of the next section.
23811
23812
23813
23814 .section "The PLAIN authentication mechanism" "SECID172"
23815 .cindex "PLAIN authentication mechanism"
23816 .cindex "authentication" "PLAIN mechanism"
23817 .cindex "binary zero" "in &(plaintext)& authenticator"
23818 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
23819 sent as one item of data (that is, one combined string containing two NUL
23820 separators). The data is sent either as part of the AUTH command, or
23821 subsequently in response to an empty prompt from the server.
23822
23823 The second and third strings are a user name and a corresponding password.
23824 Using a single fixed user name and password as an example, this could be
23825 configured as follows:
23826 .code
23827 fixed_plain:
23828   driver = plaintext
23829   public_name = PLAIN
23830   server_prompts = :
23831   server_condition = \
23832     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
23833   server_set_id = $auth2
23834 .endd
23835 Note that the default result strings from &%if%& (&"true"& or an empty string)
23836 are exactly what we want here, so they need not be specified. Obviously, if the
23837 password contains expansion-significant characters such as dollar, backslash,
23838 or closing brace, they have to be escaped.
23839
23840 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
23841 the end of a string list are ignored). If all the data comes as part of the
23842 AUTH command, as is commonly the case, the prompt is not used. This
23843 authenticator is advertised in the response to EHLO as
23844 .code
23845 250-AUTH PLAIN
23846 .endd
23847 and a client host can authenticate itself by sending the command
23848 .code
23849 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
23850 .endd
23851 As this contains three strings (more than the number of prompts), no further
23852 data is required from the client. Alternatively, the client may just send
23853 .code
23854 AUTH PLAIN
23855 .endd
23856 to initiate authentication, in which case the server replies with an empty
23857 prompt. The client must respond with the combined data string.
23858
23859 The data string is base64 encoded, as required by the RFC. This example,
23860 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
23861 represents a zero byte. This is split up into three strings, the first of which
23862 is empty. The &%server_condition%& option in the authenticator checks that the
23863 second two are &`username`& and &`mysecret`& respectively.
23864
23865 Having just one fixed user name and password, as in this example, is not very
23866 realistic, though for a small organization with only a handful of
23867 authenticating clients it could make sense.
23868
23869 A more sophisticated instance of this authenticator could use the user name in
23870 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
23871 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
23872 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
23873 This is an incorrect example:
23874 .code
23875 server_condition = \
23876   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
23877 .endd
23878 The expansion uses the user name (&$auth2$&) as the key to look up a password,
23879 which it then compares to the supplied password (&$auth3$&). Why is this example
23880 incorrect? It works fine for existing users, but consider what happens if a
23881 non-existent user name is given. The lookup fails, but as no success/failure
23882 strings are given for the lookup, it yields an empty string. Thus, to defeat
23883 the authentication, all a client has to do is to supply a non-existent user
23884 name and an empty password. The correct way of writing this test is:
23885 .code
23886 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
23887   {${if eq{$value}{$auth3}}} {false}}
23888 .endd
23889 In this case, if the lookup succeeds, the result is checked; if the lookup
23890 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
23891 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
23892 always fails if its second argument is empty. However, the second way of
23893 writing the test makes the logic clearer.
23894
23895
23896 .section "The LOGIN authentication mechanism" "SECID173"
23897 .cindex "LOGIN authentication mechanism"
23898 .cindex "authentication" "LOGIN mechanism"
23899 The LOGIN authentication mechanism is not documented in any RFC, but is in use
23900 in a number of programs. No data is sent with the AUTH command. Instead, a
23901 user name and password are supplied separately, in response to prompts. The
23902 plaintext authenticator can be configured to support this as in this example:
23903 .code
23904 fixed_login:
23905   driver = plaintext
23906   public_name = LOGIN
23907   server_prompts = User Name : Password
23908   server_condition = \
23909     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
23910   server_set_id = $auth1
23911 .endd
23912 Because of the way plaintext operates, this authenticator accepts data supplied
23913 with the AUTH command (in contravention of the specification of LOGIN), but
23914 if the client does not supply it (as is the case for LOGIN clients), the prompt
23915 strings are used to obtain two data items.
23916
23917 .new
23918 Some clients are very particular about the precise text of the prompts. For
23919 example, Outlook Express is reported to recognize only &"Username:"& and
23920 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
23921 strings. It uses the &%ldapauth%& expansion condition to check the user
23922 name and password by binding to an LDAP server:
23923 .code
23924 login:
23925   driver = plaintext
23926   public_name = LOGIN
23927   server_prompts = Username:: : Password::
23928   server_condition = ${if and{{ \
23929     !eq{}{$auth1} }{ \
23930     ldapauth{user="cn=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
23931              pass=${quote:$auth2} \
23932              ldap://ldap.example.org/} }} }
23933   server_set_id = uid=$auth1,ou=people,o=example.org
23934 .endd
23935 We have to check that the username is not empty before using it, because LDAP
23936 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
23937 operator to correctly quote the DN for authentication. However, the basic
23938 &%quote%& operator, rather than any of the LDAP quoting operators, is the
23939 correct one to use for the password, because quoting is needed only to make
23940 the password conform to the Exim syntax. At the LDAP level, the password is an
23941 uninterpreted string.
23942 .wen
23943
23944 .section "Support for different kinds of authentication" "SECID174"
23945 A number of string expansion features are provided for the purpose of
23946 interfacing to different ways of user authentication. These include checking
23947 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
23948 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
23949 &<<SECTexpcond>>&.
23950
23951
23952
23953
23954 .section "Using plaintext in a client" "SECID175"
23955 .cindex "options" "&(plaintext)& authenticator (client)"
23956 The &(plaintext)& authenticator has two client options:
23957
23958 .option client_ignore_invalid_base64 plaintext boolean false
23959 If the client receives a server prompt that is not a valid base64 string,
23960 authentication is abandoned by default. However, if this option is set true,
23961 the error in the challenge is ignored and the client sends the response as
23962 usual.
23963
23964 .option client_send plaintext string&!! unset
23965 The string is a colon-separated list of authentication data strings. Each
23966 string is independently expanded before being sent to the server. The first
23967 string is sent with the AUTH command; any more strings are sent in response
23968 to prompts from the server. Before each string is expanded, the value of the
23969 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
23970 with &$auth1$& for the first prompt. Up to three prompts are stored in this
23971 way. Thus, the prompt that is received in response to sending the first string
23972 (with the AUTH command) can be used in the expansion of the second string, and
23973 so on. If an invalid base64 string is received when
23974 &%client_ignore_invalid_base64%& is set, an empty string is put in the
23975 &$auth$&<&'n'&> variable.
23976
23977 &*Note*&: You cannot use expansion to create multiple strings, because
23978 splitting takes priority and happens first.
23979
23980 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
23981 the data, further processing is applied to each string before it is sent. If
23982 there are any single circumflex characters in the string, they are converted to
23983 NULs. Should an actual circumflex be required as data, it must be doubled in
23984 the string.
23985
23986 This is an example of a client configuration that implements the PLAIN
23987 authentication mechanism with a fixed user name and password:
23988 .code
23989 fixed_plain:
23990   driver = plaintext
23991   public_name = PLAIN
23992   client_send = ^username^mysecret
23993 .endd
23994 The lack of colons means that the entire text is sent with the AUTH
23995 command, with the circumflex characters converted to NULs. A similar example
23996 that uses the LOGIN mechanism is:
23997 .code
23998 fixed_login:
23999   driver = plaintext
24000   public_name = LOGIN
24001   client_send = : username : mysecret
24002 .endd
24003 The initial colon means that the first string is empty, so no data is sent with
24004 the AUTH command itself. The remaining strings are sent in response to
24005 prompts.
24006 .ecindex IIDplaiauth1
24007 .ecindex IIDplaiauth2
24008
24009
24010
24011
24012 . ////////////////////////////////////////////////////////////////////////////
24013 . ////////////////////////////////////////////////////////////////////////////
24014
24015 .chapter "The cram_md5 authenticator" "CHID9"
24016 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
24017 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
24018 .cindex "CRAM-MD5 authentication mechanism"
24019 .cindex "authentication" "CRAM-MD5 mechanism"
24020 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
24021 sends a challenge string to the client, and the response consists of a user
24022 name and the CRAM-MD5 digest of the challenge string combined with a secret
24023 string (password) which is known to both server and client. Thus, the secret
24024 is not sent over the network as plain text, which makes this authenticator more
24025 secure than &(plaintext)&. However, the downside is that the secret has to be
24026 available in plain text at either end.
24027
24028
24029 .section "Using cram_md5 as a server" "SECID176"
24030 .cindex "options" "&(cram_md5)& authenticator (server)"
24031 This authenticator has one server option, which must be set to configure the
24032 authenticator as a server:
24033
24034 .option server_secret cram_md5 string&!! unset
24035 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
24036 When the server receives the client's response, the user name is placed in
24037 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
24038 obtain the password for that user. The server then computes the CRAM-MD5 digest
24039 that the client should have sent, and checks that it received the correct
24040 string. If the expansion of &%server_secret%& is forced to fail, authentication
24041 fails. If the expansion fails for some other reason, a temporary error code is
24042 returned to the client.
24043
24044 For compatibility with previous releases of Exim, the user name is also placed
24045 in &$1$&. However, the use of this variables for this purpose is now
24046 deprecated, as it can lead to confusion in string expansions that also use
24047 numeric variables for other things.
24048
24049 For example, the following authenticator checks that the user name given by the
24050 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
24051 user name, authentication fails.
24052 .code
24053 fixed_cram:
24054   driver = cram_md5
24055   public_name = CRAM-MD5
24056   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
24057   server_set_id = $auth1
24058 .endd
24059 .vindex "&$authenticated_id$&"
24060 If authentication succeeds, the setting of &%server_set_id%& preserves the user
24061 name in &$authenticated_id$&. A more typical configuration might look up the
24062 secret string in a file, using the user name as the key. For example:
24063 .code
24064 lookup_cram:
24065   driver = cram_md5
24066   public_name = CRAM-MD5
24067   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
24068                   {$value}fail}
24069   server_set_id = $auth1
24070 .endd
24071 Note that this expansion explicitly forces failure if the lookup fails
24072 because &$auth1$& contains an unknown user name.
24073
24074
24075 .section "Using cram_md5 as a client" "SECID177"
24076 .cindex "options" "&(cram_md5)& authenticator (client)"
24077 When used as a client, the &(cram_md5)& authenticator has two options:
24078
24079
24080
24081 .option client_name cram_md5 string&!! "the primary host name"
24082 This string is expanded, and the result used as the user name data when
24083 computing the response to the server's challenge.
24084
24085
24086 .option client_secret cram_md5 string&!! unset
24087 This option must be set for the authenticator to work as a client. Its value is
24088 expanded and the result used as the secret string when computing the response.
24089
24090
24091 .vindex "&$host$&"
24092 .vindex "&$host_address$&"
24093 Different user names and secrets can be used for different servers by referring
24094 to &$host$& or &$host_address$& in the options. Forced failure of either
24095 expansion string is treated as an indication that this authenticator is not
24096 prepared to handle this case. Exim moves on to the next configured client
24097 authenticator. Any other expansion failure causes Exim to give up trying to
24098 send the message to the current server.
24099
24100 A simple example configuration of a &(cram_md5)& authenticator, using fixed
24101 strings, is:
24102 .code
24103 fixed_cram:
24104   driver = cram_md5
24105   public_name = CRAM-MD5
24106   client_name = ph10
24107   client_secret = secret
24108 .endd
24109 .ecindex IIDcramauth1
24110 .ecindex IIDcramauth2
24111
24112
24113
24114 . ////////////////////////////////////////////////////////////////////////////
24115 . ////////////////////////////////////////////////////////////////////////////
24116
24117 .chapter "The cyrus_sasl authenticator" "CHID10"
24118 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
24119 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
24120 .cindex "Cyrus" "SASL library"
24121 .cindex "Kerberos"
24122 The code for this authenticator was provided by Matthew Byng-Maddick of A L
24123 Digital Ltd (&url(http://www.aldigital.co.uk)).
24124
24125 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
24126 library implementation of the RFC 2222 (&"Simple Authentication and Security
24127 Layer"&). This library supports a number of authentication mechanisms,
24128 including PLAIN and LOGIN, but also several others that Exim does not support
24129 directly. In particular, there is support for Kerberos authentication.
24130
24131 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
24132 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
24133 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
24134 name of the driver to determine which mechanism to support.
24135
24136 Where access to some kind of secret file is required, for example in GSSAPI
24137 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
24138 user, and that the Cyrus SASL library has no way of escalating privileges
24139 by default. You may also find you need to set environment variables,
24140 depending on the driver you are using.
24141
24142 The application name provided by Exim is &"exim"&, so various SASL options may
24143 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
24144 Kerberos, note that because of limitations in the GSSAPI interface,
24145 changing the server keytab might need to be communicated down to the Kerberos
24146 layer independently. The mechanism for doing so is dependent upon the Kerberos
24147 implementation. For example, for Heimdal, the environment variable KRB5_KTNAME
24148 may be set to point to an alternative keytab file. Exim will pass this
24149 variable through from its own inherited environment when started as root or the
24150 Exim user. The keytab file needs to be readable by the Exim user.
24151
24152
24153 .section "Using cyrus_sasl as a server" "SECID178"
24154 The &(cyrus_sasl)& authenticator has four private options. It puts the username
24155 (on a successful authentication) into &$auth1$&. For compatibility with
24156 previous releases of Exim, the username is also placed in &$1$&. However, the
24157 use of this variable for this purpose is now deprecated, as it can lead to
24158 confusion in string expansions that also use numeric variables for other
24159 things.
24160
24161
24162 .option server_hostname cyrus_sasl string&!! "see below"
24163 This option selects the hostname that is used when communicating with the
24164 library. The default value is &`$primary_hostname`&. It is up to the underlying
24165 SASL plug-in what it does with this data.
24166
24167
24168 .option server_mech cyrus_sasl string "see below"
24169 This option selects the authentication mechanism this driver should use. The
24170 default is the value of the generic &%public_name%& option. This option allows
24171 you to use a different underlying mechanism from the advertised name. For
24172 example:
24173 .code
24174 sasl:
24175   driver = cyrus_sasl
24176   public_name = X-ANYTHING
24177   server_mech = CRAM-MD5
24178   server_set_id = $auth1
24179 .endd
24180
24181 .option server_realm cyrus_sasl string unset
24182 This specifies the SASL realm that the server claims to be in.
24183
24184
24185 .option server_service cyrus_sasl string &`smtp`&
24186 This is the SASL service that the server claims to implement.
24187
24188
24189 For straightforward cases, you do not need to set any of the authenticator's
24190 private options. All you need to do is to specify an appropriate mechanism as
24191 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
24192 PLAIN, you could have two authenticators as follows:
24193 .code
24194 sasl_cram_md5:
24195   driver = cyrus_sasl
24196   public_name = CRAM-MD5
24197   server_set_id = $auth1
24198
24199 sasl_plain:
24200   driver = cyrus_sasl
24201   public_name = PLAIN
24202   server_set_id = $auth2
24203 .endd
24204 Cyrus SASL does implement the LOGIN authentication method, even though it is
24205 not a standard method. It is disabled by default in the source distribution,
24206 but it is present in many binary distributions.
24207 .ecindex IIDcyrauth1
24208 .ecindex IIDcyrauth2
24209
24210
24211
24212
24213 . ////////////////////////////////////////////////////////////////////////////
24214 . ////////////////////////////////////////////////////////////////////////////
24215 .chapter "The dovecot authenticator" "CHAPdovecot"
24216 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
24217 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
24218 This authenticator is an interface to the authentication facility of the
24219 Dovecot POP/IMAP server, which can support a number of authentication methods.
24220 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
24221 to use the same mechanisms for SMTP authentication. This is a server
24222 authenticator only. There is only one option:
24223
24224 .option server_socket dovecot string unset
24225
24226 This option must specify the socket that is the interface to Dovecot
24227 authentication. The &%public_name%& option must specify an authentication
24228 mechanism that Dovecot is configured to support. You can have several
24229 authenticators for different mechanisms. For example:
24230 .code
24231 dovecot_plain:
24232   driver = dovecot
24233   public_name = PLAIN
24234   server_socket = /var/run/dovecot/auth-client
24235   server_set_id = $auth2
24236
24237 dovecot_ntlm:
24238   driver = dovecot
24239   public_name = NTLM
24240   server_socket = /var/run/dovecot/auth-client
24241   server_set_id = $auth1
24242 .endd
24243 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
24244 &$received_ip_address$& (that is, the connection is local), the &"secured"&
24245 option is passed in the Dovecot authentication command. If, for a TLS
24246 connection, a client certificate has been verified, the &"valid-client-cert"&
24247 option is passed. When authentication succeeds, the identity of the user
24248 who authenticated is placed in &$auth1$&.
24249 .ecindex IIDdcotauth1
24250 .ecindex IIDdcotauth2
24251
24252
24253 . ////////////////////////////////////////////////////////////////////////////
24254 . ////////////////////////////////////////////////////////////////////////////
24255
24256 .chapter "The spa authenticator" "CHAPspa"
24257 .scindex IIDspaauth1 "&(spa)& authenticator"
24258 .scindex IIDspaauth2 "authenticators" "&(spa)&"
24259 .cindex "authentication" "Microsoft Secure Password"
24260 .cindex "authentication" "NTLM"
24261 .cindex "Microsoft Secure Password Authentication"
24262 .cindex "NTLM authentication"
24263 The &(spa)& authenticator provides client support for Microsoft's &'Secure
24264 Password Authentication'& mechanism,
24265 which is also sometimes known as NTLM (NT LanMan). The code for client side of
24266 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
24267 taken from the Samba project (&url(http://www.samba.org)). The code for the
24268 server side was subsequently contributed by Tom Kistner. The mechanism works as
24269 follows:
24270
24271 .ilist
24272 After the AUTH command has been accepted, the client sends an SPA
24273 authentication request based on the user name and optional domain.
24274 .next
24275 The server sends back a challenge.
24276 .next
24277 The client builds a challenge response which makes use of the user's password
24278 and sends it to the server, which then accepts or rejects it.
24279 .endlist
24280
24281 Encryption is used to protect the password in transit.
24282
24283
24284
24285 .section "Using spa as a server" "SECID179"
24286 .cindex "options" "&(spa)& authenticator (server)"
24287 The &(spa)& authenticator has just one server option:
24288
24289 .option server_password spa string&!! unset
24290 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
24291 This option is expanded, and the result must be the cleartext password for the
24292 authenticating user, whose name is at this point in &$auth1$&. For
24293 compatibility with previous releases of Exim, the user name is also placed in
24294 &$1$&. However, the use of this variable for this purpose is now deprecated, as
24295 it can lead to confusion in string expansions that also use numeric variables
24296 for other things. For example:
24297 .code
24298 spa:
24299   driver = spa
24300   public_name = NTLM
24301   server_password = \
24302     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
24303 .endd
24304 If the expansion is forced to fail, authentication fails. Any other expansion
24305 failure causes a temporary error code to be returned.
24306
24307
24308
24309
24310
24311 .section "Using spa as a client" "SECID180"
24312 .cindex "options" "&(spa)& authenticator (client)"
24313 The &(spa)& authenticator has the following client options:
24314
24315
24316
24317 .option client_domain spa string&!! unset
24318 This option specifies an optional domain for the authentication.
24319
24320
24321 .option client_password spa string&!! unset
24322 This option specifies the user's password, and must be set.
24323
24324
24325 .option client_username spa string&!! unset
24326 This option specifies the user name, and must be set. Here is an example of a
24327 configuration of this authenticator for use with the mail servers at
24328 &'msn.com'&:
24329 .code
24330 msn:
24331   driver = spa
24332   public_name = MSN
24333   client_username = msn/msn_username
24334   client_password = msn_plaintext_password
24335   client_domain = DOMAIN_OR_UNSET
24336 .endd
24337 .ecindex IIDspaauth1
24338 .ecindex IIDspaauth2
24339
24340
24341
24342
24343
24344 . ////////////////////////////////////////////////////////////////////////////
24345 . ////////////////////////////////////////////////////////////////////////////
24346
24347 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
24348          "Encrypted SMTP connections"
24349 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
24350 .scindex IIDencsmtp2 "SMTP" "encryption"
24351 .cindex "TLS" "on SMTP connection"
24352 .cindex "OpenSSL"
24353 .cindex "GnuTLS"
24354 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
24355 Sockets Layer), is implemented by making use of the OpenSSL library or the
24356 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
24357 cryptographic code in the Exim distribution itself for implementing TLS. In
24358 order to use this feature you must install OpenSSL or GnuTLS, and then build a
24359 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
24360 You also need to understand the basic concepts of encryption at a managerial
24361 level, and in particular, the way that public keys, private keys, and
24362 certificates are used.
24363
24364 RFC 3207 defines how SMTP connections can make use of encryption. Once a
24365 connection is established, the client issues a STARTTLS command. If the
24366 server accepts this, the client and the server negotiate an encryption
24367 mechanism. If the negotiation succeeds, the data that subsequently passes
24368 between them is encrypted.
24369
24370 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
24371 and if so, what cipher suite is in use, whether the client supplied a
24372 certificate, and whether or not that certificate was verified. This makes it
24373 possible for an Exim server to deny or accept certain commands based on the
24374 encryption state.
24375
24376 &*Warning*&: Certain types of firewall and certain anti-virus products can
24377 disrupt TLS connections. You need to turn off SMTP scanning for these products
24378 in order to get TLS to work.
24379
24380
24381
24382 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
24383          "SECID284"
24384 .cindex "ssmtp protocol"
24385 .cindex "smtps protocol"
24386 .cindex "SMTP" "ssmtp protocol"
24387 .cindex "SMTP" "smtps protocol"
24388 Early implementations of encrypted SMTP used a different TCP port from normal
24389 SMTP, and expected an encryption negotiation to start immediately, instead of
24390 waiting for a STARTTLS command from the client using the standard SMTP
24391 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
24392 allocated for this purpose.
24393
24394 This approach was abandoned when encrypted SMTP was standardized, but there are
24395 still some legacy clients that use it. Exim supports these clients by means of
24396 the &%tls_on_connect_ports%& global option. Its value must be a list of port
24397 numbers; the most common use is expected to be:
24398 .code
24399 tls_on_connect_ports = 465
24400 .endd
24401 The port numbers specified by this option apply to all SMTP connections, both
24402 via the daemon and via &'inetd'&. You still need to specify all the ports that
24403 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
24404 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
24405 an extra port &-- rather, it specifies different behaviour on a port that is
24406 defined elsewhere.
24407
24408 There is also a &%-tls-on-connect%& command line option. This overrides
24409 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
24410
24411
24412
24413
24414
24415
24416 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
24417 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
24418 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
24419 followed later, when the first versions of GnuTLS were released. To build Exim
24420 to use GnuTLS, you need to set
24421 .code
24422 USE_GNUTLS=yes
24423 .endd
24424 in Local/Makefile, in addition to
24425 .code
24426 SUPPORT_TLS=yes
24427 .endd
24428 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
24429 include files and libraries for GnuTLS can be found.
24430
24431 There are some differences in usage when using GnuTLS instead of OpenSSL:
24432
24433 .ilist
24434 The &%tls_verify_certificates%& option must contain the name of a file, not the
24435 name of a directory (for OpenSSL it can be either).
24436 .next
24437 The &%tls_dhparam%& option is ignored, because early versions of GnuTLS had no
24438 facility for varying its Diffie-Hellman parameters. I understand that this has
24439 changed, but Exim has not been updated to provide this facility.
24440 .next
24441 .vindex "&$tls_peerdn$&"
24442 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
24443 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
24444 affects the value of the &$tls_peerdn$& variable.
24445 .next
24446 OpenSSL identifies cipher suites using hyphens as separators, for example:
24447 DES-CBC3-SHA. GnuTLS uses underscores, for example: RSA_ARCFOUR_SHA. What is
24448 more, OpenSSL complains if underscores are present in a cipher list. To make
24449 life simpler, Exim changes underscores to hyphens for OpenSSL and hyphens to
24450 underscores for GnuTLS when processing lists of cipher suites in the
24451 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
24452 option).
24453 .next
24454 The &%tls_require_ciphers%& options operate differently, as described in the
24455 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
24456 .endlist
24457
24458
24459 .section "GnuTLS parameter computation" "SECID181"
24460 GnuTLS uses D-H parameters that may take a substantial amount of time
24461 to compute. It is unreasonable to re-compute them for every TLS session.
24462 Therefore, Exim keeps this data in a file in its spool directory, called
24463 &_gnutls-params_&. The file is owned by the Exim user and is readable only by
24464 its owner. Every Exim process that start up GnuTLS reads the D-H
24465 parameters from this file. If the file does not exist, the first Exim process
24466 that needs it computes the data and writes it to a temporary file which is
24467 renamed once it is complete. It does not matter if several Exim processes do
24468 this simultaneously (apart from wasting a few resources). Once a file is in
24469 place, new Exim processes immediately start using it.
24470
24471 For maximum security, the parameters that are stored in this file should be
24472 recalculated periodically, the frequency depending on your paranoia level.
24473 Arranging this is easy in principle; just delete the file when you want new
24474 values to be computed. However, there may be a problem. The calculation of new
24475 parameters needs random numbers, and these are obtained from &_/dev/random_&.
24476 If the system is not very active, &_/dev/random_& may delay returning data
24477 until enough randomness (entropy) is available. This may cause Exim to hang for
24478 a substantial amount of time, causing timeouts on incoming connections.
24479
24480 The solution is to generate the parameters externally to Exim. They are stored
24481 in &_gnutls-params_& in PEM format, which means that they can be generated
24482 externally using the &(certtool)& command that is part of GnuTLS.
24483
24484 To replace the parameters with new ones, instead of deleting the file
24485 and letting Exim re-create it, you can generate new parameters using
24486 &(certtool)& and, when this has been done, replace Exim's cache file by
24487 renaming. The relevant commands are something like this:
24488 .code
24489 # rm -f new-params
24490 # touch new-params
24491 # chown exim:exim new-params
24492 # chmod 0400 new-params
24493 # certtool --generate-privkey --bits 512 >new-params
24494 # echo "" >>new-params
24495 # certtool --generate-dh-params --bits 1024 >> new-params
24496 # mv new-params gnutls-params
24497 .endd
24498 If Exim never has to generate the parameters itself, the possibility of
24499 stalling is removed.
24500
24501
24502 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
24503 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
24504 .oindex "&%tls_require_ciphers%&" "OpenSSL"
24505 There is a function in the OpenSSL library that can be passed a list of cipher
24506 suites before the cipher negotiation takes place. This specifies which ciphers
24507 are acceptable. The list is colon separated and may contain names like
24508 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
24509 directly to this function call. The following quotation from the OpenSSL
24510 documentation specifies what forms of item are allowed in the cipher string:
24511
24512 .ilist
24513 It can consist of a single cipher suite such as RC4-SHA.
24514 .next
24515 It can represent a list of cipher suites containing a certain algorithm,
24516 or cipher suites of a certain type. For example SHA1 represents all
24517 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
24518 SSL v3 algorithms.
24519 .next
24520 Lists of cipher suites can be combined in a single cipher string using
24521 the + character. This is used as a logical and operation. For example
24522 SHA1+DES represents all cipher suites containing the SHA1 and the DES
24523 algorithms.
24524 .endlist
24525
24526 Each cipher string can be optionally preceded by one of the characters &`!`&,
24527 &`-`& or &`+`&.
24528 .ilist
24529 If &`!`& is used, the ciphers are permanently deleted from the list. The
24530 ciphers deleted can never reappear in the list even if they are explicitly
24531 stated.
24532 .next
24533 If &`-`& is used, the ciphers are deleted from the list, but some or all
24534 of the ciphers can be added again by later options.
24535 .next
24536 If &`+`& is used, the ciphers are moved to the end of the list. This
24537 option does not add any new ciphers; it just moves matching existing ones.
24538 .endlist
24539
24540 If none of these characters is present, the string is interpreted as
24541 a list of ciphers to be appended to the current preference list. If the list
24542 includes any ciphers already present they will be ignored: that is, they will
24543 not be moved to the end of the list.
24544 .endlist
24545
24546
24547
24548 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
24549          "SECTreqciphgnu"
24550 .cindex "GnuTLS" "specifying parameters for"
24551 .cindex "TLS" "specifying ciphers (GnuTLS)"
24552 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
24553 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
24554 .cindex "TLS" "specifying protocols (GnuTLS)"
24555 .oindex "&%tls_require_ciphers%&" "GnuTLS"
24556 The GnuTLS library allows the caller to specify separate lists of permitted key
24557 exchange methods, main cipher algorithms, MAC algorithms, and protocols.
24558 Unfortunately, these lists are numerical, and the library does not have a
24559 function for turning names into numbers. Consequently, lists of recognized
24560 names have to be built into the application. The permitted key exchange
24561 methods, ciphers, and MAC algorithms may be used in any combination to form a
24562 cipher suite. This is unlike OpenSSL, where complete cipher suite names are
24563 passed to its control function.
24564
24565 For compatibility with OpenSSL, the &%tls_require_ciphers%& option can be set
24566 to complete cipher suite names such as RSA_ARCFOUR_SHA, but for GnuTLS this
24567 option controls only the cipher algorithms. Exim searches each item in the
24568 list for the name of an available algorithm. For example, if the list
24569 contains RSA_AES_SHA, then AES is recognized, and the behaviour is exactly
24570 the same as if just AES were given.
24571
24572 .oindex "&%gnutls_require_kx%&"
24573 .oindex "&%gnutls_require_mac%&"
24574 .oindex "&%gnutls_require_protocols%&"
24575 There are additional options called &%gnutls_require_kx%&,
24576 &%gnutls_require_mac%&, and &%gnutls_require_protocols%& that can be used to
24577 restrict the key exchange methods, MAC algorithms, and protocols, respectively.
24578 These options are ignored if OpenSSL is in use.
24579
24580 All four options are available as global options, controlling how Exim
24581 behaves as a server, and also as options of the &(smtp)& transport, controlling
24582 how Exim behaves as a client. All the values are string expanded. After
24583 expansion, the values must be colon-separated lists, though the separator
24584 can be changed in the usual way.
24585
24586 Each of the four lists starts out with a default set of algorithms. If the
24587 first item in a list does &'not'& start with an exclamation mark, all the
24588 default items are deleted. In this case, only those that are explicitly
24589 specified can be used. If the first item in a list &'does'& start with an
24590 exclamation mark, the defaults are left on the list.
24591
24592 Then, any item that starts with an exclamation mark causes the relevant
24593 entry to be removed from the list, and any item that does not start with an
24594 exclamation mark causes a new entry to be added to the list. Unrecognized
24595 items in the list are ignored. Thus:
24596 .code
24597 tls_require_ciphers = !ARCFOUR
24598 .endd
24599 allows all the defaults except ARCFOUR, whereas
24600 .code
24601 tls_require_ciphers = AES : 3DES
24602 .endd
24603 allows only cipher suites that use AES or 3DES.
24604
24605 For &%tls_require_ciphers%& the recognized names are AES_256, AES_128, AES
24606 (both of the preceding), 3DES, ARCFOUR_128, ARCFOUR_40, and ARCFOUR (both of
24607 the preceding). The default list does not contain all of these; it just has
24608 AES_256, AES_128, 3DES, and ARCFOUR_128.
24609
24610 For &%gnutls_require_kx%&, the recognized names are DHE_RSA, RSA (which
24611 includes DHE_RSA), DHE_DSS, and DHE (which includes both DHE_RSA and
24612 DHE_DSS). The default list contains RSA, DHE_DSS, DHE_RSA.
24613
24614 For &%gnutls_require_mac%&, the recognized names are SHA (synonym SHA1), and
24615 MD5. The default list contains SHA, MD5.
24616
24617 For &%gnutls_require_protocols%&, the recognized names are TLS1 and SSL3.
24618 The default list contains TLS1, SSL3.
24619
24620 In a server, the order of items in these lists is unimportant. The server
24621 advertises the availability of all the relevant cipher suites. However, in a
24622 client, the order in the &%tls_require_ciphers%& list specifies a preference
24623 order for the cipher algorithms. The first one in the client's list that is
24624 also advertised by the server is tried first. The default order is as listed
24625 above.
24626
24627
24628
24629 .section "Configuring an Exim server to use TLS" "SECID182"
24630 .cindex "TLS" "configuring an Exim server"
24631 When Exim has been built with TLS support, it advertises the availability of
24632 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
24633 but not to any others. The default value of this option is unset, which means
24634 that STARTTLS is not advertised at all. This default is chosen because you
24635 need to set some other options in order to make TLS available, and also it is
24636 sensible for systems that want to use TLS only as a client.
24637
24638 If a client issues a STARTTLS command and there is some configuration
24639 problem in the server, the command is rejected with a 454 error. If the client
24640 persists in trying to issue SMTP commands, all except QUIT are rejected
24641 with the error
24642 .code
24643 554 Security failure
24644 .endd
24645 If a STARTTLS command is issued within an existing TLS session, it is
24646 rejected with a 554 error code.
24647
24648 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
24649 match some hosts. You can, of course, set it to * to match all hosts.
24650 However, this is not all you need to do. TLS sessions to a server won't work
24651 without some further configuration at the server end.
24652
24653 It is rumoured that all existing clients that support TLS/SSL use RSA
24654 encryption. To make this work you need to set, in the server,
24655 .code
24656 tls_certificate = /some/file/name
24657 tls_privatekey = /some/file/name
24658 .endd
24659 These options are, in fact, expanded strings, so you can make them depend on
24660 the identity of the client that is connected if you wish. The first file
24661 contains the server's X509 certificate, and the second contains the private key
24662 that goes with it. These files need to be readable by the Exim user, and must
24663 always be given as full path names. They can be the same file if both the
24664 certificate and the key are contained within it. If &%tls_privatekey%& is not
24665 set, or if its expansion is forced to fail or results in an empty string, this
24666 is assumed to be the case. The certificate file may also contain intermediate
24667 certificates that need to be sent to the client to enable it to authenticate
24668 the server's certificate.
24669
24670 If you do not understand about certificates and keys, please try to find a
24671 source of this background information, which is not Exim-specific. (There are a
24672 few comments below in section &<<SECTcerandall>>&.)
24673
24674 &*Note*&: These options do not apply when Exim is operating as a client &--
24675 they apply only in the case of a server. If you need to use a certificate in an
24676 Exim client, you must set the options of the same names in an &(smtp)&
24677 transport.
24678
24679 With just these options, an Exim server will be able to use TLS. It does not
24680 require the client to have a certificate (but see below for how to insist on
24681 this). There is one other option that may be needed in other situations. If
24682 .code
24683 tls_dhparam = /some/file/name
24684 .endd
24685 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
24686 with the parameters contained in the file. This increases the set of cipher
24687 suites that the server supports. See the command
24688 .code
24689 openssl dhparam
24690 .endd
24691 for a way of generating this data. At present, &%tls_dhparam%& is used only
24692 when Exim is linked with OpenSSL. It is ignored if GnuTLS is being used.
24693
24694 The strings supplied for these three options are expanded every time a client
24695 host connects. It is therefore possible to use different certificates and keys
24696 for different hosts, if you so wish, by making use of the client's IP address
24697 in &$sender_host_address$& to control the expansion. If a string expansion is
24698 forced to fail, Exim behaves as if the option is not set.
24699
24700 .cindex "cipher" "logging"
24701 .cindex "log" "TLS cipher"
24702 .vindex "&$tls_cipher$&"
24703 The variable &$tls_cipher$& is set to the cipher suite that was negotiated for
24704 an incoming TLS connection. It is included in the &'Received:'& header of an
24705 incoming message (by default &-- you can, of course, change this), and it is
24706 also included in the log line that records a message's arrival, keyed by
24707 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
24708 condition can be used to test for specific cipher suites in ACLs.
24709 (For outgoing SMTP deliveries, &$tls_cipher$& is reset &-- see section
24710 &<<SECID185>>&.)
24711
24712 Once TLS has been established, the ACLs that run for subsequent SMTP commands
24713 can check the name of the cipher suite and vary their actions accordingly. The
24714 cipher suite names vary, depending on which TLS library is being used. For
24715 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
24716 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
24717 documentation for more details.
24718
24719
24720 .section "Requesting and verifying client certificates" "SECID183"
24721 .cindex "certificate" "verification of client"
24722 .cindex "TLS" "client certificate verification"
24723 If you want an Exim server to request a certificate when negotiating a TLS
24724 session with a client, you must set either &%tls_verify_hosts%& or
24725 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
24726 apply to all TLS connections. For any host that matches one of these options,
24727 Exim requests a certificate as part of the setup of the TLS session. The
24728 contents of the certificate are verified by comparing it with a list of
24729 expected certificates. These must be available in a file or,
24730 for OpenSSL only (not GnuTLS), a directory, identified by
24731 &%tls_verify_certificates%&.
24732
24733 A file can contain multiple certificates, concatenated end to end. If a
24734 directory is used
24735 (OpenSSL only),
24736 each certificate must be in a separate file, with a name (or a symbolic link)
24737 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
24738 certificate. You can compute the relevant hash by running the command
24739 .code
24740 openssl x509 -hash -noout -in /cert/file
24741 .endd
24742 where &_/cert/file_& contains a single certificate.
24743
24744 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
24745 what happens if the client does not supply a certificate, or if the certificate
24746 does not match any of the certificates in the collection named by
24747 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
24748 attempt to set up a TLS session is aborted, and the incoming connection is
24749 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
24750 session continues. ACLs that run for subsequent SMTP commands can detect the
24751 fact that no certificate was verified, and vary their actions accordingly. For
24752 example, you can insist on a certificate before accepting a message for
24753 relaying, but not when the message is destined for local delivery.
24754
24755 .vindex "&$tls_peerdn$&"
24756 When a client supplies a certificate (whether it verifies or not), the value of
24757 the Distinguished Name of the certificate is made available in the variable
24758 &$tls_peerdn$& during subsequent processing of the message.
24759
24760 .cindex "log" "distinguished name"
24761 Because it is often a long text string, it is not included in the log line or
24762 &'Received:'& header by default. You can arrange for it to be logged, keyed by
24763 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
24764 &%received_header_text%& to change the &'Received:'& header. When no
24765 certificate is supplied, &$tls_peerdn$& is empty.
24766
24767
24768 .section "Revoked certificates" "SECID184"
24769 .cindex "TLS" "revoked certificates"
24770 .cindex "revocation list"
24771 .cindex "certificate" "revocation list"
24772 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
24773 certificates are revoked. If you have such a list, you can pass it to an Exim
24774 server using the global option called &%tls_crl%& and to an Exim client using
24775 an identically named option for the &(smtp)& transport. In each case, the value
24776 of the option is expanded and must then be the name of a file that contains a
24777 CRL in PEM format.
24778
24779
24780 .section "Configuring an Exim client to use TLS" "SECID185"
24781 .cindex "cipher" "logging"
24782 .cindex "log" "TLS cipher"
24783 .cindex "log" "distinguished name"
24784 .cindex "TLS" "configuring an Exim client"
24785 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
24786 deliveries as well as to incoming, the latter one causing logging of the
24787 server certificate's DN. The remaining client configuration for TLS is all
24788 within the &(smtp)& transport.
24789
24790 It is not necessary to set any options to have TLS work in the &(smtp)&
24791 transport. If Exim is built with TLS support, and TLS is advertised by a
24792 server, the &(smtp)& transport always tries to start a TLS session. However,
24793 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
24794 transport) to a list of server hosts for which TLS should not be used.
24795
24796 If you do not want Exim to attempt to send messages unencrypted when an attempt
24797 to set up an encrypted connection fails in any way, you can set
24798 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
24799 those hosts, delivery is always deferred if an encrypted connection cannot be
24800 set up. If there are any other hosts for the address, they are tried in the
24801 usual way.
24802
24803 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
24804 the message unencrypted. It always does this if the response to STARTTLS is
24805 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
24806 session after a success response code, what happens is controlled by the
24807 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
24808 delivery to this host is deferred, and other hosts (if available) are tried. If
24809 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
24810 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
24811 negotiation fails, Exim closes the current connection (because it is in an
24812 unknown state), opens a new one to the same host, and then tries the delivery
24813 unencrypted.
24814
24815 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
24816 transport provide the client with a certificate, which is passed to the server
24817 if it requests it. If the server is Exim, it will request a certificate only if
24818 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
24819
24820 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
24821 must name a file or,
24822 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
24823 expected server certificates. The client verifies the server's certificate
24824 against this collection, taking into account any revoked certificates that are
24825 in the list defined by &%tls_crl%&.
24826
24827 If
24828 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
24829 list of permitted cipher suites. If either of these checks fails, delivery to
24830 the current host is abandoned, and the &(smtp)& transport tries to deliver to
24831 alternative hosts, if any.
24832
24833  &*Note*&:
24834 These options must be set in the &(smtp)& transport for Exim to use TLS when it
24835 is operating as a client. Exim does not assume that a server certificate (set
24836 by the global options of the same name) should also be used when operating as a
24837 client.
24838
24839 .vindex "&$host$&"
24840 .vindex "&$host_address$&"
24841 All the TLS options in the &(smtp)& transport are expanded before use, with
24842 &$host$& and &$host_address$& containing the name and address of the server to
24843 which the client is connected. Forced failure of an expansion causes Exim to
24844 behave as if the relevant option were unset.
24845
24846 .vindex &$tls_cipher$&
24847 .vindex &$tls_peerdn$&
24848 Before an SMTP connection is established, the &$tls_cipher$& and &$tls_peerdn$&
24849 variables are emptied. (Until the first connection, they contain the values
24850 that were set when the message was received.) If STARTTLS is subsequently
24851 successfully obeyed, these variables are set to the relevant values for the
24852 outgoing connection.
24853
24854
24855
24856 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
24857          "SECTmulmessam"
24858 .cindex "multiple SMTP deliveries with TLS"
24859 .cindex "TLS" "multiple message deliveries"
24860 Exim sends multiple messages down the same TCP/IP connection by starting up
24861 an entirely new delivery process for each message, passing the socket from
24862 one process to the next. This implementation does not fit well with the use
24863 of TLS, because there is quite a lot of state information associated with a TLS
24864 connection, not just a socket identification. Passing all the state information
24865 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
24866 session before passing the socket to a new process. The new process may then
24867 try to start a new TLS session, and if successful, may try to re-authenticate
24868 if AUTH is in use, before sending the next message.
24869
24870 The RFC is not clear as to whether or not an SMTP session continues in clear
24871 after TLS has been shut down, or whether TLS may be restarted again later, as
24872 just described. However, if the server is Exim, this shutdown and
24873 reinitialization works. It is not known which (if any) other servers operate
24874 successfully if the client closes a TLS session and continues with unencrypted
24875 SMTP, but there are certainly some that do not work. For such servers, Exim
24876 should not pass the socket to another process, because the failure of the
24877 subsequent attempt to use it would cause Exim to record a temporary host error,
24878 and delay other deliveries to that host.
24879
24880 To test for this case, Exim sends an EHLO command to the server after
24881 closing down the TLS session. If this fails in any way, the connection is
24882 closed instead of being passed to a new delivery process, but no retry
24883 information is recorded.
24884
24885 There is also a manual override; you can set &%hosts_nopass_tls%& on the
24886 &(smtp)& transport to match those hosts for which Exim should not pass
24887 connections to new processes if TLS has been used.
24888
24889
24890
24891
24892 .section "Certificates and all that" "SECTcerandall"
24893 .cindex "certificate" "references to discussion"
24894 In order to understand fully how TLS works, you need to know about
24895 certificates, certificate signing, and certificate authorities. This is not the
24896 place to give a tutorial, especially as I do not know very much about it
24897 myself. Some helpful introduction can be found in the FAQ for the SSL addition
24898 to Apache, currently at
24899 .display
24900 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
24901 .endd
24902 Other parts of the &'modssl'& documentation are also helpful, and have
24903 links to further files.
24904 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
24905 0-201-61598-3), contains both introductory and more in-depth descriptions.
24906 Some sample programs taken from the book are available from
24907 .display
24908 &url(http://www.rtfm.com/openssl-examples/)
24909 .endd
24910
24911
24912 .section "Certificate chains" "SECID186"
24913 The file named by &%tls_certificate%& may contain more than one
24914 certificate. This is useful in the case where the certificate that is being
24915 sent is validated by an intermediate certificate which the other end does
24916 not have. Multiple certificates must be in the correct order in the file.
24917 First the host's certificate itself, then the first intermediate
24918 certificate to validate the issuer of the host certificate, then the next
24919 intermediate certificate to validate the issuer of the first intermediate
24920 certificate, and so on, until finally (optionally) the root certificate.
24921 The root certificate must already be trusted by the recipient for
24922 validation to succeed, of course, but if it's not preinstalled, sending the
24923 root certificate along with the rest makes it available for the user to
24924 install if the receiving end is a client MUA that can interact with a user.
24925
24926
24927 .section "Self-signed certificates" "SECID187"
24928 .cindex "certificate" "self-signed"
24929 You can create a self-signed certificate using the &'req'& command provided
24930 with OpenSSL, like this:
24931 .code
24932 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
24933             -days 9999 -nodes
24934 .endd
24935 &_file1_& and &_file2_& can be the same file; the key and the certificate are
24936 delimited and so can be identified independently. The &%-days%& option
24937 specifies a period for which the certificate is valid. The &%-nodes%& option is
24938 important: if you do not set it, the key is encrypted with a passphrase
24939 that you are prompted for, and any use that is made of the key causes more
24940 prompting for the passphrase. This is not helpful if you are going to use
24941 this certificate and key in an MTA, where prompting is not possible.
24942
24943 A self-signed certificate made in this way is sufficient for testing, and
24944 may be adequate for all your requirements if you are mainly interested in
24945 encrypting transfers, and not in secure identification.
24946
24947 However, many clients require that the certificate presented by the server be a
24948 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
24949 certificate. In this situation, the self-signed certificate described above
24950 must be installed on the client host as a trusted root &'certification
24951 authority'& (CA), and the certificate used by Exim must be a user certificate
24952 signed with that self-signed certificate.
24953
24954 For information on creating self-signed CA certificates and using them to sign
24955 user certificates, see the &'General implementation overview'& chapter of the
24956 Open-source PKI book, available online at
24957 &url(http://ospkibook.sourceforge.net/).
24958 .ecindex IIDencsmtp1
24959 .ecindex IIDencsmtp2
24960
24961
24962
24963 . ////////////////////////////////////////////////////////////////////////////
24964 . ////////////////////////////////////////////////////////////////////////////
24965
24966 .chapter "Access control lists" "CHAPACL"
24967 .scindex IIDacl "&ACL;" "description"
24968 .cindex "control of incoming mail"
24969 .cindex "message" "controlling incoming"
24970 .cindex "policy control" "access control lists"
24971 Access Control Lists (ACLs) are defined in a separate section of the run time
24972 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
24973 name, terminated by a colon. Here is a complete ACL section that contains just
24974 one very small ACL:
24975 .code
24976 begin acl
24977 small_acl:
24978   accept   hosts = one.host.only
24979 .endd
24980 You can have as many lists as you like in the ACL section, and the order in
24981 which they appear does not matter. The lists are self-terminating.
24982
24983 The majority of ACLs are used to control Exim's behaviour when it receives
24984 certain SMTP commands. This applies both to incoming TCP/IP connections, and
24985 when a local process submits a message using SMTP by specifying the &%-bs%&
24986 option. The most common use is for controlling which recipients are accepted
24987 in incoming messages. In addition, you can define an ACL that is used to check
24988 local non-SMTP messages. The default configuration file contains an example of
24989 a realistic ACL for checking RCPT commands. This is discussed in chapter
24990 &<<CHAPdefconfil>>&.
24991
24992
24993 .section "Testing ACLs" "SECID188"
24994 The &%-bh%& command line option provides a way of testing your ACL
24995 configuration locally by running a fake SMTP session with which you interact.
24996 The host &'relay-test.mail-abuse.org'& provides a service for checking your
24997 relaying configuration (see section &<<SECTcheralcon>>& for more details).
24998
24999
25000
25001 .section "Specifying when ACLs are used" "SECID189"
25002 .cindex "&ACL;" "options for specifying"
25003 In order to cause an ACL to be used, you have to name it in one of the relevant
25004 options in the main part of the configuration. These options are:
25005 .cindex "AUTH" "ACL for"
25006 .cindex "DATA" "ACLs for"
25007 .cindex "ETRN" "ACL for"
25008 .cindex "EXPN" "ACL for"
25009 .cindex "HELO" "ACL for"
25010 .cindex "EHLO" "ACL for"
25011 .cindex "MAIL" "ACL for"
25012 .cindex "QUIT, ACL for"
25013 .cindex "RCPT" "ACL for"
25014 .cindex "STARTTLS, ACL for"
25015 .cindex "VRFY" "ACL for"
25016 .cindex "SMTP" "connection, ACL for"
25017 .cindex "non-SMTP messages" "ACLs for"
25018 .cindex "MIME content scanning" "ACL for"
25019
25020 .table2 140pt
25021 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
25022 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
25023 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
25024 .irow &%acl_smtp_auth%&        "ACL for AUTH"
25025 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
25026 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
25027 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
25028 .irow &%acl_smtp_expn%&        "ACL for EXPN"
25029 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
25030 .irow &%acl_smtp_mail%&        "ACL for MAIL"
25031 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
25032 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
25033 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
25034 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
25035 .irow &%acl_smtp_quit%&        "ACL for QUIT"
25036 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
25037 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
25038 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
25039 .endtable
25040
25041 For example, if you set
25042 .code
25043 acl_smtp_rcpt = small_acl
25044 .endd
25045 the little ACL defined above is used whenever Exim receives a RCPT command
25046 in an SMTP dialogue. The majority of policy tests on incoming messages can be
25047 done when RCPT commands arrive. A rejection of RCPT should cause the
25048 sending MTA to give up on the recipient address contained in the RCPT
25049 command, whereas rejection at other times may cause the client MTA to keep on
25050 trying to deliver the message. It is therefore recommended that you do as much
25051 testing as possible at RCPT time.
25052
25053
25054 .section "The non-SMTP ACLs" "SECID190"
25055 .cindex "non-SMTP messages" "ACLs for"
25056 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
25057 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
25058 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
25059 the state of the SMTP connection such as encryption and authentication) are not
25060 relevant and are forbidden in these ACLs. However, the sender and recipients
25061 are known, so the &%senders%& and &%sender_domains%& conditions and the
25062 &$sender_address$& and &$recipients$& variables can be used. Variables such as
25063 &$authenticated_sender$& are also available. You can specify added header lines
25064 in any of these ACLs.
25065
25066 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
25067 non-SMTP message, before any of the message has been read. (This is the
25068 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
25069 batched SMTP input, it runs after the DATA command has been reached. The
25070 result of this ACL is ignored; it cannot be used to reject a message. If you
25071 really need to, you could set a value in an ACL variable here and reject based
25072 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
25073 controls, and in particular, it can be used to set
25074 .code
25075 control = suppress_local_fixups
25076 .endd
25077 This cannot be used in the other non-SMTP ACLs because by the time they are
25078 run, it is too late.
25079
25080 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
25081 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
25082
25083 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
25084 kind of rejection is treated as permanent, because there is no way of sending a
25085 temporary error for these kinds of message.
25086
25087
25088 .section "The SMTP connect ACL" "SECID191"
25089 .cindex "SMTP" "connection, ACL for"
25090 .oindex &%smtp_banner%&
25091 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
25092 session, after the test specified by &%host_reject_connection%& (which is now
25093 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
25094 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
25095 the message override the banner message that is otherwise specified by the
25096 &%smtp_banner%& option.
25097
25098
25099 .section "The EHLO/HELO ACL" "SECID192"
25100 .cindex "EHLO" "ACL for"
25101 .cindex "HELO" "ACL for"
25102 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
25103 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
25104 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
25105 Note that a client may issue more than one EHLO or HELO command in an SMTP
25106 session, and indeed is required to issue a new EHLO or HELO after successfully
25107 setting up encryption following a STARTTLS command.
25108
25109 If the command is accepted by an &%accept%& verb that has a &%message%&
25110 modifier, the message may not contain more than one line (it will be truncated
25111 at the first newline and a panic logged if it does). Such a message cannot
25112 affect the EHLO options that are listed on the second and subsequent lines of
25113 an EHLO response.
25114
25115
25116 .section "The DATA ACLs" "SECID193"
25117 .cindex "DATA" "ACLs for"
25118 Two ACLs are associated with the DATA command, because it is two-stage
25119 command, with two responses being sent to the client.
25120 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
25121 is obeyed. This gives you control after all the RCPT commands, but before
25122 the message itself is received. It offers the opportunity to give a negative
25123 response to the DATA command before the data is transmitted. Header lines
25124 added by MAIL or RCPT ACLs are not visible at this time, but any that
25125 are defined here are visible when the &%acl_smtp_data%& ACL is run.
25126
25127 You cannot test the contents of the message, for example, to verify addresses
25128 in the headers, at RCPT time or when the DATA command is received. Such
25129 tests have to appear in the ACL that is run after the message itself has been
25130 received, before the final response to the DATA command is sent. This is
25131 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
25132 associated with the DATA command.
25133
25134 For both of these ACLs, it is not possible to reject individual recipients. An
25135 error response rejects the entire message. Unfortunately, it is known that some
25136 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
25137 before or after the data) correctly &-- they keep the message on their queues
25138 and try again later, but that is their problem, though it does waste some of
25139 your resources.
25140
25141
25142 .new
25143 .section "The SMTP DKIM ACL" "SECTDKIMACL"
25144 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
25145 enabled (which is the default).
25146
25147 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
25148 received, and is executed for each DKIM signature found in a message.  If not
25149 otherwise specified, the default action is to accept.
25150
25151 For details on the operation of DKIM, see chapter &<<CHID12>>&.
25152 .wen
25153
25154
25155 .section "The SMTP MIME ACL" "SECID194"
25156 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
25157 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
25158
25159
25160 .section "The QUIT ACL" "SECTQUITACL"
25161 .cindex "QUIT, ACL for"
25162 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
25163 does not affect the response code to QUIT, which is always 221. Thus, the ACL
25164 does not in fact control any access. For this reason, the only verbs that are
25165 permitted are &%accept%& and &%warn%&.
25166
25167 This ACL can be used for tasks such as custom logging at the end of an SMTP
25168 session. For example, you can use ACL variables in other ACLs to count
25169 messages, recipients, etc., and log the totals at QUIT time using one or
25170 more &%logwrite%& modifiers on a &%warn%& verb.
25171
25172 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
25173 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
25174
25175 You do not need to have a final &%accept%&, but if you do, you can use a
25176 &%message%& modifier to specify custom text that is sent as part of the 221
25177 response to QUIT.
25178
25179 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
25180 failure (for example, failure to open a log file, or when Exim is bombing out
25181 because it has detected an unrecoverable error), all SMTP commands from the
25182 client are given temporary error responses until QUIT is received or the
25183 connection is closed. In these special cases, the QUIT ACL does not run.
25184
25185
25186 .section "The not-QUIT ACL" "SECTNOTQUITACL"
25187 .vindex &$acl_smtp_notquit$&
25188 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
25189 an SMTP session ends without sending QUIT. However, when Exim itself is is bad
25190 trouble, such as being unable to write to its log files, this ACL is not run,
25191 because it might try to do things (such as write to log files) that make the
25192 situation even worse.
25193
25194 Like the QUIT ACL, this ACL is provided to make it possible to do customized
25195 logging or to gather statistics, and its outcome is ignored. The &%delay%&
25196 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
25197 and &%warn%&.
25198
25199 .vindex &$smtp_notquit_reason$&
25200 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
25201 to a string that indicates the reason for the termination of the SMTP
25202 connection. The possible values are:
25203 .table2
25204 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
25205 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
25206 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
25207 .irow &`connection-lost`&          "The SMTP connection has been lost"
25208 .irow &`data-timeout`&             "Timeout while reading message data"
25209 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
25210 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
25211 .irow &`signal-exit`&              "SIGTERM or SIGINT"
25212 .irow &`synchronization-error`&    "SMTP synchronization error"
25213 .irow &`tls-failed`&               "TLS failed to start"
25214 .endtable
25215 In most cases when an SMTP connection is closed without having received QUIT,
25216 Exim sends an SMTP response message before actually closing the connection.
25217 With the exception of the &`acl-drop`& case, the default message can be
25218 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
25219 &%drop%& verb in another ACL, it is the message from the other ACL that is
25220 used.
25221
25222
25223 .section "Finding an ACL to use" "SECID195"
25224 .cindex "&ACL;" "finding which to use"
25225 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
25226 you can use different ACLs in different circumstances. For example,
25227 .code
25228 acl_smtp_rcpt = ${if ={25}{$interface_port} \
25229                      {acl_check_rcpt} {acl_check_rcpt_submit} }
25230 .endd
25231 In the default configuration file there are some example settings for
25232 providing an RFC 4409 message submission service on port 587 and a
25233 non-standard &"smtps"& service on port 465. You can use a string
25234 expansion like this to choose an ACL for MUAs on these ports which is
25235 more appropriate for this purpose than the default ACL on port 25.
25236
25237 The expanded string does not have to be the name of an ACL in the
25238 configuration file; there are other possibilities. Having expanded the
25239 string, Exim searches for an ACL as follows:
25240
25241 .ilist
25242 If the string begins with a slash, Exim uses it as a file name, and reads its
25243 contents as an ACL. The lines are processed in the same way as lines in the
25244 Exim configuration file. In particular, continuation lines are supported, blank
25245 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
25246 If the file does not exist or cannot be read, an error occurs (typically
25247 causing a temporary failure of whatever caused the ACL to be run). For example:
25248 .code
25249 acl_smtp_data = /etc/acls/\
25250   ${lookup{$sender_host_address}lsearch\
25251   {/etc/acllist}{$value}{default}}
25252 .endd
25253 This looks up an ACL file to use on the basis of the host's IP address, falling
25254 back to a default if the lookup fails. If an ACL is successfully read from a
25255 file, it is retained in memory for the duration of the Exim process, so that it
25256 can be re-used without having to re-read the file.
25257 .next
25258 If the string does not start with a slash, and does not contain any spaces,
25259 Exim searches the ACL section of the configuration for an ACL whose name
25260 matches the string.
25261 .next
25262 If no named ACL is found, or if the string contains spaces, Exim parses
25263 the string as an inline ACL. This can save typing in cases where you just
25264 want to have something like
25265 .code
25266 acl_smtp_vrfy = accept
25267 .endd
25268 in order to allow free use of the VRFY command. Such a string may contain
25269 newlines; it is processed in the same way as an ACL that is read from a file.
25270 .endlist
25271
25272
25273
25274
25275 .section "ACL return codes" "SECID196"
25276 .cindex "&ACL;" "return codes"
25277 Except for the QUIT ACL, which does not affect the SMTP return code (see
25278 section &<<SECTQUITACL>>& above), the result of running an ACL is either
25279 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
25280 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
25281 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
25282 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
25283 This also causes a 4&'xx'& return code.
25284
25285 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
25286 &"deny"&, because there is no mechanism for passing temporary errors to the
25287 submitters of non-SMTP messages.
25288
25289
25290 ACLs that are relevant to message reception may also return &"discard"&. This
25291 has the effect of &"accept"&, but causes either the entire message or an
25292 individual recipient address to be discarded. In other words, it is a
25293 blackholing facility. Use it with care.
25294
25295 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
25296 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
25297 RCPT ACL is to discard just the one recipient address. If there are no
25298 recipients left when the message's data is received, the DATA ACL is not
25299 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
25300 remaining recipients. The &"discard"& return is not permitted for the
25301 &%acl_smtp_predata%& ACL.
25302
25303
25304 .cindex "&[local_scan()]& function" "when all recipients discarded"
25305 The &[local_scan()]& function is always run, even if there are no remaining
25306 recipients; it may create new recipients.
25307
25308
25309
25310 .section "Unset ACL options" "SECID197"
25311 .cindex "&ACL;" "unset options"
25312 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
25313 all the same. &*Note*&: These defaults apply only when the relevant ACL is
25314 not defined at all. For any defined ACL, the default action when control
25315 reaches the end of the ACL statements is &"deny"&.
25316
25317 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
25318 these two are ACLs that are used only for their side effects. They cannot be
25319 used to accept or reject anything.
25320
25321 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
25322 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
25323 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
25324 when the ACL is not defined is &"accept"&.
25325
25326 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
25327 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
25328 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
25329 messages over an SMTP connection. For an example, see the ACL in the default
25330 configuration file.
25331
25332
25333
25334
25335 .section "Data for message ACLs" "SECID198"
25336 .cindex "&ACL;" "data for message ACL"
25337 .vindex &$domain$&
25338 .vindex &$local_part$&
25339 .vindex &$sender_address$&
25340 .vindex &$sender_host_address$&
25341 .vindex &$smtp_command$&
25342 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
25343 that contain information about the host and the message's sender (for example,
25344 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
25345 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
25346 &$local_part$& are set from the argument address. The entire SMTP command
25347 is available in &$smtp_command$&.
25348
25349 When an ACL for the AUTH parameter of MAIL is running, the variables that
25350 contain information about the host are set, but &$sender_address$& is not yet
25351 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
25352 how it is used.
25353
25354 .vindex "&$message_size$&"
25355 The &$message_size$& variable is set to the value of the SIZE parameter on
25356 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
25357 that parameter is not given. The value is updated to the true message size by
25358 the time the final DATA ACL is run (after the message data has been
25359 received).
25360
25361 .vindex "&$rcpt_count$&"
25362 .vindex "&$recipients_count$&"
25363 The &$rcpt_count$& variable increases by one for each RCPT command received.
25364 The &$recipients_count$& variable increases by one each time a RCPT command is
25365 accepted, so while an ACL for RCPT is being processed, it contains the number
25366 of previously accepted recipients. At DATA time (for both the DATA ACLs),
25367 &$rcpt_count$& contains the total number of RCPT commands, and
25368 &$recipients_count$& contains the total number of accepted recipients.
25369
25370
25371
25372
25373
25374 .section "Data for non-message ACLs" "SECTdatfornon"
25375 .cindex "&ACL;" "data for non-message ACL"
25376 .vindex &$smtp_command_argument$&
25377 .vindex &$smtp_command$&
25378 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
25379 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
25380 and the entire SMTP command is available in &$smtp_command$&.
25381 These variables can be tested using a &%condition%& condition. For example,
25382 here is an ACL for use with AUTH, which insists that either the session is
25383 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
25384 does not permit authentication methods that use cleartext passwords on
25385 unencrypted connections.
25386 .code
25387 acl_check_auth:
25388   accept encrypted = *
25389   accept condition = ${if eq{${uc:$smtp_command_argument}}\
25390                      {CRAM-MD5}}
25391   deny   message   = TLS encryption or CRAM-MD5 required
25392 .endd
25393 (Another way of applying this restriction is to arrange for the authenticators
25394 that use cleartext passwords not to be advertised when the connection is not
25395 encrypted. You can use the generic &%server_advertise_condition%& authenticator
25396 option to do this.)
25397
25398
25399
25400 .section "Format of an ACL" "SECID199"
25401 .cindex "&ACL;" "format of"
25402 .cindex "&ACL;" "verbs, definition of"
25403 An individual ACL consists of a number of statements. Each statement starts
25404 with a verb, optionally followed by a number of conditions and &"modifiers"&.
25405 Modifiers can change the way the verb operates, define error and log messages,
25406 set variables, insert delays, and vary the processing of accepted messages.
25407
25408 If all the conditions are met, the verb is obeyed. The same condition may be
25409 used (with different arguments) more than once in the same statement. This
25410 provides a means of specifying an &"and"& conjunction between conditions. For
25411 example:
25412 .code
25413 deny  dnslists = list1.example
25414 dnslists = list2.example
25415 .endd
25416 If there are no conditions, the verb is always obeyed. Exim stops evaluating
25417 the conditions and modifiers when it reaches a condition that fails. What
25418 happens then depends on the verb (and in one case, on a special modifier). Not
25419 all the conditions make sense at every testing point. For example, you cannot
25420 test a sender address in the ACL that is run for a VRFY command.
25421
25422
25423 .section "ACL verbs" "SECID200"
25424 The ACL verbs are as follows:
25425
25426 .ilist
25427 .cindex "&%accept%& ACL verb"
25428 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
25429 of the conditions are not met, what happens depends on whether &%endpass%&
25430 appears among the conditions (for syntax see below). If the failing condition
25431 is before &%endpass%&, control is passed to the next ACL statement; if it is
25432 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
25433 check a RCPT command:
25434 .code
25435 accept domains = +local_domains
25436 endpass
25437 verify = recipient
25438 .endd
25439 If the recipient domain does not match the &%domains%& condition, control
25440 passes to the next statement. If it does match, the recipient is verified, and
25441 the command is accepted if verification succeeds. However, if verification
25442 fails, the ACL yields &"deny"&, because the failing condition is after
25443 &%endpass%&.
25444
25445 The &%endpass%& feature has turned out to be confusing to many people, so its
25446 use is not recommended nowadays. It is always possible to rewrite an ACL so
25447 that &%endpass%& is not needed, and it is no longer used in the default
25448 configuration.
25449
25450 .cindex "&%message%& ACL modifier" "with &%accept%&"
25451 If a &%message%& modifier appears on an &%accept%& statement, its action
25452 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
25453 (when an &%accept%& verb either accepts or passes control to the next
25454 statement), &%message%& can be used to vary the message that is sent when an
25455 SMTP command is accepted. For example, in a RCPT ACL you could have:
25456 .display
25457 &`accept  `&<&'some conditions'&>
25458 &`        message = OK, I will allow you through today`&
25459 .endd
25460 You can specify an SMTP response code, optionally followed by an &"extended
25461 response code"& at the start of the message, but the first digit must be the
25462 same as would be sent by default, which is 2 for an &%accept%& verb.
25463
25464 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
25465 an error message that is used when access is denied. This behaviour is retained
25466 for backward compatibility, but current &"best practice"& is to avoid the use
25467 of &%endpass%&.
25468
25469
25470 .next
25471 .cindex "&%defer%& ACL verb"
25472 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
25473 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
25474 &%defer%& is the same as &%deny%&, because there is no way of sending a
25475 temporary error. For a RCPT command, &%defer%& is much the same as using a
25476 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
25477 be used in any ACL, and even for a recipient it might be a simpler approach.
25478
25479
25480 .next
25481 .cindex "&%deny%& ACL verb"
25482 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
25483 the conditions are not met, control is passed to the next ACL statement. For
25484 example,
25485 .code
25486 deny dnslists = blackholes.mail-abuse.org
25487 .endd
25488 rejects commands from hosts that are on a DNS black list.
25489
25490
25491 .next
25492 .cindex "&%discard%& ACL verb"
25493 &%discard%&: This verb behaves like &%accept%&, except that it returns
25494 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
25495 that are concerned with receiving messages. When all the conditions are true,
25496 the sending entity receives a &"success"& response. However, &%discard%& causes
25497 recipients to be discarded. If it is used in an ACL for RCPT, just the one
25498 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
25499 message's recipients are discarded. Recipients that are discarded before DATA
25500 do not appear in the log line when the &%received_recipients%& log selector is set.
25501
25502 If the &%log_message%& modifier is set when &%discard%& operates,
25503 its contents are added to the line that is automatically written to the log.
25504 The &%message%& modifier operates exactly as it does for &%accept%&.
25505
25506
25507 .next
25508 .cindex "&%drop%& ACL verb"
25509 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
25510 forcibly closed after the 5&'xx'& error message has been sent. For example:
25511 .code
25512 drop   message   = I don't take more than 20 RCPTs
25513        condition = ${if > {$rcpt_count}{20}}
25514 .endd
25515 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
25516 The connection is always dropped after sending a 550 response.
25517
25518 .next
25519 .cindex "&%require%& ACL verb"
25520 &%require%&: If all the conditions are met, control is passed to the next ACL
25521 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
25522 example, when checking a RCPT command,
25523 .code
25524 require message = Sender did not verify
25525         verify  = sender
25526 .endd
25527 passes control to subsequent statements only if the message's sender can be
25528 verified. Otherwise, it rejects the command. Note the positioning of the
25529 &%message%& modifier, before the &%verify%& condition. The reason for this is
25530 discussed in section &<<SECTcondmodproc>>&.
25531
25532 .next
25533 .cindex "&%warn%& ACL verb"
25534 &%warn%&: If all the conditions are true, a line specified by the
25535 &%log_message%& modifier is written to Exim's main log. Control always passes
25536 to the next ACL statement. If any condition is false, the log line is not
25537 written. If an identical log line is requested several times in the same
25538 message, only one copy is actually written to the log. If you want to force
25539 duplicates to be written, use the &%logwrite%& modifier instead.
25540
25541 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
25542 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
25543 &%logwrite%&, and &%add_header%&) that appear before the first failing
25544 condition. There is more about adding header lines in section
25545 &<<SECTaddheadacl>>&.
25546
25547 If any condition on a &%warn%& statement cannot be completed (that is, there is
25548 some sort of defer), the log line specified by &%log_message%& is not written.
25549 This does not include the case of a forced failure from a lookup, which
25550 is considered to be a successful completion. After a defer, no further
25551 conditions or modifiers in the &%warn%& statement are processed. The incident
25552 is logged, and the ACL continues to be processed, from the next statement
25553 onwards.
25554
25555
25556 .vindex "&$acl_verify_message$&"
25557 When one of the &%warn%& conditions is an address verification that fails, the
25558 text of the verification failure message is in &$acl_verify_message$&. If you
25559 want this logged, you must set it up explicitly. For example:
25560 .code
25561 warn   !verify = sender
25562        log_message = sender verify failed: $acl_verify_message
25563 .endd
25564 .endlist
25565
25566 At the end of each ACL there is an implicit unconditional &%deny%&.
25567
25568 As you can see from the examples above, the conditions and modifiers are
25569 written one to a line, with the first one on the same line as the verb, and
25570 subsequent ones on following lines. If you have a very long condition, you can
25571 continue it onto several physical lines by the usual backslash continuation
25572 mechanism. It is conventional to align the conditions vertically.
25573
25574
25575
25576 .section "ACL variables" "SECTaclvariables"
25577 .cindex "&ACL;" "variables"
25578 There are some special variables that can be set during ACL processing. They
25579 can be used to pass information between different ACLs, different invocations
25580 of the same ACL in the same SMTP connection, and between ACLs and the routers,
25581 transports, and filters that are used to deliver a message. The names of these
25582 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
25583 an underscore, but the remainder of the name can be any sequence of
25584 alphanumeric characters and underscores that you choose. There is no limit on
25585 the number of ACL variables. The two sets act as follows:
25586 .ilist
25587 The values of those variables whose names begin with &$acl_c$& persist
25588 throughout an SMTP connection. They are never reset. Thus, a value that is set
25589 while receiving one message is still available when receiving the next message
25590 on the same SMTP connection.
25591 .next
25592 The values of those variables whose names begin with &$acl_m$& persist only
25593 while a message is being received. They are reset afterwards. They are also
25594 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
25595 .endlist
25596
25597 When a message is accepted, the current values of all the ACL variables are
25598 preserved with the message and are subsequently made available at delivery
25599 time. The ACL variables are set by a modifier called &%set%&. For example:
25600 .code
25601 accept hosts = whatever
25602        set acl_m4 = some value
25603 accept authenticated = *
25604        set acl_c_auth = yes
25605 .endd
25606 &*Note*&: A leading dollar sign is not used when naming a variable that is to
25607 be set. If you want to set a variable without taking any action, you can use a
25608 &%warn%& verb without any other modifiers or conditions.
25609
25610 .oindex &%strict_acl_vars%&
25611 What happens if a syntactically valid but undefined ACL variable is
25612 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
25613 false (the default), an empty string is substituted; if it is true, an
25614 error is generated.
25615
25616 Versions of Exim before 4.64 have a limited set of numbered variables, but
25617 their names are compatible, so there is no problem with upgrading.
25618
25619
25620 .section "Condition and modifier processing" "SECTcondmodproc"
25621 .cindex "&ACL;" "conditions; processing"
25622 .cindex "&ACL;" "modifiers; processing"
25623 An exclamation mark preceding a condition negates its result. For example:
25624 .code
25625 deny   domains = *.dom.example
25626       !verify  = recipient
25627 .endd
25628 causes the ACL to return &"deny"& if the recipient domain ends in
25629 &'dom.example'& and the recipient address cannot be verified. Sometimes
25630 negation can be used on the right-hand side of a condition. For example, these
25631 two statements are equivalent:
25632 .code
25633 deny  hosts = !192.168.3.4
25634 deny !hosts =  192.168.3.4
25635 .endd
25636 However, for many conditions (&%verify%& being a good example), only left-hand
25637 side negation of the whole condition is possible.
25638
25639 The arguments of conditions and modifiers are expanded. A forced failure
25640 of an expansion causes a condition to be ignored, that is, it behaves as if the
25641 condition is true. Consider these two statements:
25642 .code
25643 accept  senders = ${lookup{$host_name}lsearch\
25644                   {/some/file}{$value}fail}
25645 accept  senders = ${lookup{$host_name}lsearch\
25646                   {/some/file}{$value}{}}
25647 .endd
25648 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
25649 the returned list is searched, but if the lookup fails the behaviour is
25650 different in the two cases. The &%fail%& in the first statement causes the
25651 condition to be ignored, leaving no further conditions. The &%accept%& verb
25652 therefore succeeds. The second statement, however, generates an empty list when
25653 the lookup fails. No sender can match an empty list, so the condition fails,
25654 and therefore the &%accept%& also fails.
25655
25656 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
25657 specify actions that are taken as the conditions for a statement are checked;
25658 others specify text for messages that are used when access is denied or a
25659 warning is generated. The &%control%& modifier affects the way an incoming
25660 message is handled.
25661
25662 The positioning of the modifiers in an ACL statement important, because the
25663 processing of a verb ceases as soon as its outcome is known. Only those
25664 modifiers that have already been encountered will take effect. For example,
25665 consider this use of the &%message%& modifier:
25666 .code
25667 require message = Can't verify sender
25668         verify  = sender
25669         message = Can't verify recipient
25670         verify  = recipient
25671         message = This message cannot be used
25672 .endd
25673 If sender verification fails, Exim knows that the result of the statement is
25674 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
25675 so its text is used as the error message. If sender verification succeeds, but
25676 recipient verification fails, the second message is used. If recipient
25677 verification succeeds, the third message becomes &"current"&, but is never used
25678 because there are no more conditions to cause failure.
25679
25680 For the &%deny%& verb, on the other hand, it is always the last &%message%&
25681 modifier that is used, because all the conditions must be true for rejection to
25682 happen. Specifying more than one &%message%& modifier does not make sense, and
25683 the message can even be specified after all the conditions. For example:
25684 .code
25685 deny   hosts = ...
25686       !senders = *@my.domain.example
25687        message = Invalid sender from client host
25688 .endd
25689 The &"deny"& result does not happen until the end of the statement is reached,
25690 by which time Exim has set up the message.
25691
25692
25693
25694 .section "ACL modifiers" "SECTACLmodi"
25695 .cindex "&ACL;" "modifiers; list of"
25696 The ACL modifiers are as follows:
25697
25698 .vlist
25699 .vitem &*add_header*&&~=&~<&'text'&>
25700 This modifier specifies one or more header lines that are to be added to an
25701 incoming message, assuming, of course, that the message is ultimately
25702 accepted. For details, see section &<<SECTaddheadacl>>&.
25703
25704 .vitem &*continue*&&~=&~<&'text'&>
25705 .cindex "&%continue%& ACL modifier"
25706 .cindex "database" "updating in ACL"
25707 This modifier does nothing of itself, and processing of the ACL always
25708 continues with the next condition or modifier. The value of &%continue%& is in
25709 the side effects of expanding its argument. Typically this could be used to
25710 update a database. It is really just a syntactic tidiness, to avoid having to
25711 write rather ugly lines like this:
25712 .display
25713 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
25714 .endd
25715 Instead, all you need is
25716 .display
25717 &`continue = `&<&'some expansion'&>
25718 .endd
25719
25720 .vitem &*control*&&~=&~<&'text'&>
25721 .cindex "&%control%& ACL modifier"
25722 This modifier affects the subsequent processing of the SMTP connection or of an
25723 incoming message that is accepted. The effect of the first type of control
25724 lasts for the duration of the connection, whereas the effect of the second type
25725 lasts only until the current message has been received. The message-specific
25726 controls always apply to the whole message, not to individual recipients,
25727 even if the &%control%& modifier appears in a RCPT ACL.
25728
25729 As there are now quite a few controls that can be applied, they are described
25730 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
25731 in several different ways. For example:
25732
25733 . ==== As this is a nested list, any displays it contains must be indented
25734 . ==== as otherwise they are too far to the left. That comment applies only
25735 . ==== when xmlto and fop are used; formatting with sdop gets it right either
25736 . ==== way.
25737
25738 .ilist
25739 It can be at the end of an &%accept%& statement:
25740 .code
25741     accept  ...some conditions
25742             control = queue_only
25743 .endd
25744 In this case, the control is applied when this statement yields &"accept"&, in
25745 other words, when the conditions are all true.
25746
25747 .next
25748 It can be in the middle of an &%accept%& statement:
25749 .code
25750     accept  ...some conditions...
25751             control = queue_only
25752             ...some more conditions...
25753 .endd
25754 If the first set of conditions are true, the control is applied, even if the
25755 statement does not accept because one of the second set of conditions is false.
25756 In this case, some subsequent statement must yield &"accept"& for the control
25757 to be relevant.
25758
25759 .next
25760 It can be used with &%warn%& to apply the control, leaving the
25761 decision about accepting or denying to a subsequent verb. For
25762 example:
25763 .code
25764     warn    ...some conditions...
25765             control = freeze
25766     accept  ...
25767 .endd
25768 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
25769 &%logwrite%&, so it does not add anything to the message and does not write a
25770 log entry.
25771
25772 .next
25773 If you want to apply a control unconditionally, you can use it with a
25774 &%require%& verb. For example:
25775 .code
25776     require  control = no_multiline_responses
25777 .endd
25778 .endlist
25779
25780 .vitem &*delay*&&~=&~<&'time'&>
25781 .cindex "&%delay%& ACL modifier"
25782 .oindex "&%-bh%&"
25783 This modifier may appear in any ACL. It causes Exim to wait for the time
25784 interval before proceeding. However, when testing Exim using the &%-bh%&
25785 option, the delay is not actually imposed (an appropriate message is output
25786 instead). The time is given in the usual Exim notation, and the delay happens
25787 as soon as the modifier is processed. In an SMTP session, pending output is
25788 flushed before the delay is imposed.
25789
25790 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
25791 example:
25792 .code
25793 deny    ...some conditions...
25794         delay = 30s
25795 .endd
25796 The delay happens if all the conditions are true, before the statement returns
25797 &"deny"&. Compare this with:
25798 .code
25799 deny    delay = 30s
25800         ...some conditions...
25801 .endd
25802 which waits for 30s before processing the conditions. The &%delay%& modifier
25803 can also be used with &%warn%& and together with &%control%&:
25804 .code
25805 warn    ...some conditions...
25806         delay = 2m
25807         control = freeze
25808 accept  ...
25809 .endd
25810
25811 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
25812 responses to several commands are no longer buffered and sent in one packet (as
25813 they would normally be) because all output is flushed before imposing the
25814 delay. This optimization is disabled so that a number of small delays do not
25815 appear to the client as one large aggregated delay that might provoke an
25816 unwanted timeout. You can, however, disable output flushing for &%delay%& by
25817 using a &%control%& modifier to set &%no_delay_flush%&.
25818
25819
25820 .vitem &*endpass*&
25821 .cindex "&%endpass%& ACL modifier"
25822 This modifier, which has no argument, is recognized only in &%accept%& and
25823 &%discard%& statements. It marks the boundary between the conditions whose
25824 failure causes control to pass to the next statement, and the conditions whose
25825 failure causes the ACL to return &"deny"&. This concept has proved to be
25826 confusing to some people, so the use of &%endpass%& is no longer recommended as
25827 &"best practice"&. See the description of &%accept%& above for more details.
25828
25829
25830 .vitem &*log_message*&&~=&~<&'text'&>
25831 .cindex "&%log_message%& ACL modifier"
25832 This modifier sets up a message that is used as part of the log message if the
25833 ACL denies access or a &%warn%& statement's conditions are true. For example:
25834 .code
25835 require log_message = wrong cipher suite $tls_cipher
25836         encrypted   = DES-CBC3-SHA
25837 .endd
25838 &%log_message%& is also used when recipients are discarded by &%discard%&. For
25839 example:
25840 .display
25841 &`discard `&<&'some conditions'&>
25842 &`        log_message = Discarded $local_part@$domain because...`&
25843 .endd
25844 When access is denied, &%log_message%& adds to any underlying error message
25845 that may exist because of a condition failure. For example, while verifying a
25846 recipient address, a &':fail:'& redirection might have already set up a
25847 message.
25848
25849 The message may be defined before the conditions to which it applies, because
25850 the string expansion does not happen until Exim decides that access is to be
25851 denied. This means that any variables that are set by the condition are
25852 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
25853 variables are set after a DNS black list lookup succeeds. If the expansion of
25854 &%log_message%& fails, or if the result is an empty string, the modifier is
25855 ignored.
25856
25857 .vindex "&$acl_verify_message$&"
25858 If you want to use a &%warn%& statement to log the result of an address
25859 verification, you can use &$acl_verify_message$& to include the verification
25860 error message.
25861
25862 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
25863 the start of the logged message. If the same warning log message is requested
25864 more than once while receiving  a single email message, only one copy is
25865 actually logged. If you want to log multiple copies, use &%logwrite%& instead
25866 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
25867 is logged for a successful &%warn%& statement.
25868
25869 If &%log_message%& is not present and there is no underlying error message (for
25870 example, from the failure of address verification), but &%message%& is present,
25871 the &%message%& text is used for logging rejections. However, if any text for
25872 logging contains newlines, only the first line is logged. In the absence of
25873 both &%log_message%& and &%message%&, a default built-in message is used for
25874 logging rejections.
25875
25876
25877 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
25878 .cindex "&%log_reject_target%& ACL modifier"
25879 .cindex "logging in ACL" "specifying which log"
25880 This modifier makes it possible to specify which logs are used for messages
25881 about ACL rejections. Its argument is a colon-separated list of words that can
25882 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
25883 may be empty, in which case a rejection is not logged at all. For example, this
25884 ACL fragment writes no logging information when access is denied:
25885 .display
25886 &`deny `&<&'some conditions'&>
25887 &`     log_reject_target =`&
25888 .endd
25889 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
25890 permanent and temporary rejections. Its effect lasts for the rest of the
25891 current ACL.
25892
25893
25894 .vitem &*logwrite*&&~=&~<&'text'&>
25895 .cindex "&%logwrite%& ACL modifier"
25896 .cindex "logging in ACL" "immediate"
25897 This modifier writes a message to a log file as soon as it is encountered when
25898 processing an ACL. (Compare &%log_message%&, which, except in the case of
25899 &%warn%& and &%discard%&, is used only if the ACL statement denies
25900 access.) The &%logwrite%& modifier can be used to log special incidents in
25901 ACLs. For example:
25902 .display
25903 &`accept `&<&'some special conditions'&>
25904 &`       control  = freeze`&
25905 &`       logwrite = froze message because ...`&
25906 .endd
25907 By default, the message is written to the main log. However, it may begin
25908 with a colon, followed by a comma-separated list of log names, and then
25909 another colon, to specify exactly which logs are to be written. For
25910 example:
25911 .code
25912 logwrite = :main,reject: text for main and reject logs
25913 logwrite = :panic: text for panic log only
25914 .endd
25915
25916
25917 .vitem &*message*&&~=&~<&'text'&>
25918 .cindex "&%message%& ACL modifier"
25919 This modifier sets up a text string that is expanded and used as a response
25920 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
25921 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
25922 there is some complication if &%endpass%& is involved; see the description of
25923 &%accept%& for details.)
25924
25925 The expansion of the message happens at the time Exim decides that the ACL is
25926 to end, not at the time it processes &%message%&. If the expansion fails, or
25927 generates an empty string, the modifier is ignored. Here is an example where
25928 &%message%& must be specified first, because the ACL ends with a rejection if
25929 the &%hosts%& condition fails:
25930 .code
25931 require  message = Host not recognized
25932          hosts = 10.0.0.0/8
25933 .endd
25934 (Once a condition has failed, no further conditions or modifiers are
25935 processed.)
25936
25937 .cindex "SMTP" "error codes"
25938 .oindex "&%smtp_banner%&
25939 For ACLs that are triggered by SMTP commands, the message is returned as part
25940 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
25941 is meaningful only for SMTP, as no message is returned when a non-SMTP message
25942 is accepted. In the case of the connect ACL, accepting with a message modifier
25943 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
25944 accept message may not contain more than one line (otherwise it will be
25945 truncated at the first newline and a panic logged), and it cannot affect the
25946 EHLO options.
25947
25948 When SMTP is involved, the message may begin with an overriding response code,
25949 consisting of three digits optionally followed by an &"extended response code"&
25950 of the form &'n.n.n'&, each code being followed by a space. For example:
25951 .code
25952 deny  message = 599 1.2.3 Host not welcome
25953       hosts = 192.168.34.0/24
25954 .endd
25955 The first digit of the supplied response code must be the same as would be sent
25956 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
25957 access, but for the predata ACL, note that the default success code is 354, not
25958 2&'xx'&.
25959
25960 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
25961 the message modifier cannot override the 221 response code.
25962
25963 The text in a &%message%& modifier is literal; any quotes are taken as
25964 literals, but because the string is expanded, backslash escapes are processed
25965 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
25966 response.
25967
25968 .vindex "&$acl_verify_message$&"
25969 If &%message%& is used on a statement that verifies an address, the message
25970 specified overrides any message that is generated by the verification process.
25971 However, the original message is available in the variable
25972 &$acl_verify_message$&, so you can incorporate it into your message if you
25973 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
25974 routers to be passed back as part of the SMTP response, you should either not
25975 use a &%message%& modifier, or make use of &$acl_verify_message$&.
25976
25977 For compatibility with previous releases of Exim, a &%message%& modifier that
25978 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
25979 modifier, but this usage is now deprecated. However, &%message%& acts only when
25980 all the conditions are true, wherever it appears in an ACL command, whereas
25981 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
25982 &%warn%& in an ACL that is not concerned with receiving a message, it has no
25983 effect.
25984
25985
25986 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
25987 .cindex "&%set%& ACL modifier"
25988 This modifier puts a value into one of the ACL variables (see section
25989 &<<SECTaclvariables>>&).
25990 .endlist
25991
25992
25993
25994
25995
25996 .section "Use of the control modifier" "SECTcontrols"
25997 .cindex "&%control%& ACL modifier"
25998 The &%control%& modifier supports the following settings:
25999
26000 .vlist
26001 .vitem &*control&~=&~allow_auth_unadvertised*&
26002 This modifier allows a client host to use the SMTP AUTH command even when it
26003 has not been advertised in response to EHLO. Furthermore, because there are
26004 apparently some really broken clients that do this, Exim will accept AUTH after
26005 HELO (rather than EHLO) when this control is set. It should be used only if you
26006 really need it, and you should limit its use to those broken clients that do
26007 not work without it. For example:
26008 .code
26009 warn hosts   = 192.168.34.25
26010      control = allow_auth_unadvertised
26011 .endd
26012 Normally, when an Exim server receives an AUTH command, it checks the name of
26013 the authentication mechanism that is given in the command to ensure that it
26014 matches an advertised mechanism. When this control is set, the check that a
26015 mechanism has been advertised is bypassed. Any configured mechanism can be used
26016 by the client. This control is permitted only in the connection and HELO ACLs.
26017
26018
26019 .vitem &*control&~=&~caseful_local_part*& &&&
26020        &*control&~=&~caselower_local_part*&
26021 .cindex "&ACL;" "case of local part in"
26022 .cindex "case of local parts"
26023 .vindex "&$local_part$&"
26024 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
26025 (that is, during RCPT processing). By default, the contents of &$local_part$&
26026 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
26027 any uppercase letters in the original local part are restored in &$local_part$&
26028 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
26029 is encountered.
26030
26031 These controls affect only the current recipient. Moreover, they apply only to
26032 local part handling that takes place directly in the ACL (for example, as a key
26033 in lookups). If a test to verify the recipient is obeyed, the case-related
26034 handling of the local part during the verification is controlled by the router
26035 configuration (see the &%caseful_local_part%& generic router option).
26036
26037 This facility could be used, for example, to add a spam score to local parts
26038 containing upper case letters. For example, using &$acl_m4$& to accumulate the
26039 spam score:
26040 .code
26041 warn  control = caseful_local_part
26042       set acl_m4 = ${eval:\
26043                      $acl_m4 + \
26044                      ${if match{$local_part}{[A-Z]}{1}{0}}\
26045                     }
26046       control = caselower_local_part
26047 .endd
26048 Notice that we put back the lower cased version afterwards, assuming that
26049 is what is wanted for subsequent tests.
26050
26051 .new
26052 .vitem &*control&~=&~debug/*&<&'options'&>
26053 .cindex "&ACL;" "enabling debug logging"
26054 .cindex "debugging" "enabling from an ACL"
26055 This control turns on debug logging, almost as though Exim had been invoked
26056 with &`-d`&, with the output going to a new logfile, by default called
26057 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
26058 may access any variables already defined.  The logging may be adjusted with
26059 the &'opts'& option, which takes the same values as the &`-d`& command-line
26060 option.  Some examples (which depend on variables that don't exist in all
26061 contexts):
26062 .code
26063       control = debug
26064       control = debug/tag=.$sender_host_address
26065       control = debug/opts=+expand+acl
26066       control = debug/tag=.$message_exim_id/opts=+expand
26067 .endd
26068 .wen
26069
26070 .vitem &*control&~=&~enforce_sync*& &&&
26071        &*control&~=&~no_enforce_sync*&
26072 .cindex "SMTP" "synchronization checking"
26073 .cindex "synchronization checking in SMTP"
26074 These controls make it possible to be selective about when SMTP synchronization
26075 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
26076 state of the switch (it is true by default). See the description of this option
26077 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
26078
26079 The effect of these two controls lasts for the remainder of the SMTP
26080 connection. They can appear in any ACL except the one for the non-SMTP
26081 messages. The most straightforward place to put them is in the ACL defined by
26082 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
26083 before the first synchronization check. The expected use is to turn off the
26084 synchronization checks for badly-behaved hosts that you nevertheless need to
26085 work with.
26086
26087
26088 .vitem &*control&~=&~fakedefer/*&<&'message'&>
26089 .cindex "fake defer"
26090 .cindex "defer, fake"
26091 This control works in exactly the same way as &%fakereject%& (described below)
26092 except that it causes an SMTP 450 response after the message data instead of a
26093 550 response. You must take care when using &%fakedefer%& because it causes the
26094 messages to be duplicated when the sender retries. Therefore, you should not
26095 use &%fakedefer%& if the message is to be delivered normally.
26096
26097 .vitem &*control&~=&~fakereject/*&<&'message'&>
26098 .cindex "fake rejection"
26099 .cindex "rejection, fake"
26100 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
26101 words, only when an SMTP message is being received. If Exim accepts the
26102 message, instead the final 250 response, a 550 rejection message is sent.
26103 However, Exim proceeds to deliver the message as normal. The control applies
26104 only to the current message, not to any subsequent ones that may be received in
26105 the same SMTP connection.
26106
26107 The text for the 550 response is taken from the &%control%& modifier. If no
26108 message is supplied, the following is used:
26109 .code
26110 550-Your message has been rejected but is being
26111 550-kept for evaluation.
26112 550-If it was a legitimate message, it may still be
26113 550 delivered to the target recipient(s).
26114 .endd
26115 This facility should be used with extreme caution.
26116
26117 .vitem &*control&~=&~freeze*&
26118 .cindex "frozen messages" "forcing in ACL"
26119 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
26120 other words, only when a message is being received. If the message is accepted,
26121 it is placed on Exim's queue and frozen. The control applies only to the
26122 current message, not to any subsequent ones that may be received in the same
26123 SMTP connection.
26124
26125 This modifier can optionally be followed by &`/no_tell`&. If the global option
26126 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
26127 is told about the freezing), provided all the &*control=freeze*& modifiers that
26128 are obeyed for the current message have the &`/no_tell`& option.
26129
26130 .vitem &*control&~=&~no_delay_flush*&
26131 .cindex "SMTP" "output flushing, disabling for delay"
26132 Exim normally flushes SMTP output before implementing a delay in an ACL, to
26133 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
26134 use. This control, as long as it is encountered before the &%delay%& modifier,
26135 disables such output flushing.
26136
26137 .vitem &*control&~=&~no_callout_flush*&
26138 .cindex "SMTP" "output flushing, disabling for callout"
26139 Exim normally flushes SMTP output before performing a callout in an ACL, to
26140 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
26141 use. This control, as long as it is encountered before the &%verify%& condition
26142 that causes the callout, disables such output flushing.
26143
26144 .vitem &*control&~=&~no_mbox_unspool*&
26145 This control is available when Exim is compiled with the content scanning
26146 extension. Content scanning may require a copy of the current message, or parts
26147 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
26148 or spam scanner. Normally, such copies are deleted when they are no longer
26149 needed. If this control is set, the copies are not deleted. The control applies
26150 only to the current message, not to any subsequent ones that may be received in
26151 the same SMTP connection. It is provided for debugging purposes and is unlikely
26152 to be useful in production.
26153
26154 .vitem &*control&~=&~no_multiline_responses*&
26155 .cindex "multiline responses, suppressing"
26156 This control is permitted for any ACL except the one for non-SMTP messages.
26157 It seems that there are broken clients in use that cannot handle multiline
26158 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
26159
26160 If this control is set, multiline SMTP responses from ACL rejections are
26161 suppressed. One way of doing this would have been to put out these responses as
26162 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
26163 (&"use multiline responses for more"& it says &-- ha!), and some of the
26164 responses might get close to that. So this facility, which is after all only a
26165 sop to broken clients, is implemented by doing two very easy things:
26166
26167 .ilist
26168 Extra information that is normally output as part of a rejection caused by
26169 sender verification failure is omitted. Only the final line (typically &"sender
26170 verification failed"&) is sent.
26171 .next
26172 If a &%message%& modifier supplies a multiline response, only the first
26173 line is output.
26174 .endlist
26175
26176 The setting of the switch can, of course, be made conditional on the
26177 calling host. Its effect lasts until the end of the SMTP connection.
26178
26179 .vitem &*control&~=&~no_pipelining*&
26180 .cindex "PIPELINING" "suppressing advertising"
26181 This control turns off the advertising of the PIPELINING extension to SMTP in
26182 the current session. To be useful, it must be obeyed before Exim sends its
26183 response to an EHLO command. Therefore, it should normally appear in an ACL
26184 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
26185 &%pipelining_advertise_hosts%&.
26186
26187 .vitem &*control&~=&~queue_only*&
26188 .oindex "&%queue_only%&"
26189 .cindex "queueing incoming messages"
26190 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
26191 other words, only when a message is being received. If the message is accepted,
26192 it is placed on Exim's queue and left there for delivery by a subsequent queue
26193 runner. No immediate delivery process is started. In other words, it has the
26194 effect as the &%queue_only%& global option. However, the control applies only
26195 to the current message, not to any subsequent ones that may be received in the
26196 same SMTP connection.
26197
26198 .vitem &*control&~=&~submission/*&<&'options'&>
26199 .cindex "message" "submission"
26200 .cindex "submission mode"
26201 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
26202 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
26203 the current message is a submission from a local MUA. In this case, Exim
26204 operates in &"submission mode"&, and applies certain fixups to the message if
26205 necessary. For example, it adds a &'Date:'& header line if one is not present.
26206 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
26207 late (the message has already been created).
26208
26209 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
26210 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
26211 submission mode; the available options for this control are described there.
26212 The control applies only to the current message, not to any subsequent ones
26213 that may be received in the same SMTP connection.
26214
26215 .vitem &*control&~=&~suppress_local_fixups*&
26216 .cindex "submission fixups, suppressing"
26217 This control applies to locally submitted (non TCP/IP) messages, and is the
26218 complement of &`control = submission`&. It disables the fixups that are
26219 normally applied to locally-submitted messages. Specifically:
26220
26221 .ilist
26222 Any &'Sender:'& header line is left alone (in this respect, it is a
26223 dynamic version of &%local_sender_retain%&).
26224 .next
26225 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
26226 .next
26227 There is no check that &'From:'& corresponds to the actual sender.
26228 .endlist ilist
26229
26230 This control may be useful when a remotely-originated message is accepted,
26231 passed to some scanning program, and then re-submitted for delivery. It can be
26232 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
26233 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
26234 data is read.
26235
26236 &*Note:*& This control applies only to the current message, not to any others
26237 that are being submitted at the same time using &%-bs%& or &%-bS%&.
26238 .endlist vlist
26239
26240
26241 .section "Summary of message fixup control" "SECTsummesfix"
26242 All four possibilities for message fixups can be specified:
26243
26244 .ilist
26245 Locally submitted, fixups applied: the default.
26246 .next
26247 Locally submitted, no fixups applied: use
26248 &`control = suppress_local_fixups`&.
26249 .next
26250 Remotely submitted, no fixups applied: the default.
26251 .next
26252 Remotely submitted, fixups applied: use &`control = submission`&.
26253 .endlist
26254
26255
26256
26257 .section "Adding header lines in ACLs" "SECTaddheadacl"
26258 .cindex "header lines" "adding in an ACL"
26259 .cindex "header lines" "position of added lines"
26260 .cindex "&%message%& ACL modifier"
26261 The &%add_header%& modifier can be used to add one or more extra header lines
26262 to an incoming message, as in this example:
26263 .code
26264 warn dnslists = sbl.spamhaus.org : \
26265                 dialup.mail-abuse.org
26266      add_header = X-blacklisted-at: $dnslist_domain
26267 .endd
26268 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
26269 MIME, and non-SMTP ACLs (in other words, those that are concerned with
26270 receiving a message). The message must ultimately be accepted for
26271 &%add_header%& to have any significant effect. You can use &%add_header%& with
26272 any ACL verb, including &%deny%& (though this is potentially useful only in a
26273 RCPT ACL).
26274
26275 If the data for the &%add_header%& modifier contains one or more newlines that
26276 are not followed by a space or a tab, it is assumed to contain multiple header
26277 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
26278 front of any line that is not a valid header line.
26279
26280 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
26281 They are added to the message before processing the DATA and MIME ACLs.
26282 However, if an identical header line is requested more than once, only one copy
26283 is actually added to the message. Further header lines may be accumulated
26284 during the DATA and MIME ACLs, after which they are added to the message, again
26285 with duplicates suppressed. Thus, it is possible to add two identical header
26286 lines to an SMTP message, but only if one is added before DATA and one after.
26287 In the case of non-SMTP messages, new headers are accumulated during the
26288 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
26289 message is rejected after DATA or by the non-SMTP ACL, all added header lines
26290 are included in the entry that is written to the reject log.
26291
26292 .cindex "header lines" "added; visibility of"
26293 Header lines are not visible in string expansions until they are added to the
26294 message. It follows that header lines defined in the MAIL, RCPT, and predata
26295 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
26296 header lines that are added by the DATA or MIME ACLs are not visible in those
26297 ACLs. Because of this restriction, you cannot use header lines as a way of
26298 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
26299 this, you can use ACL variables, as described in section
26300 &<<SECTaclvariables>>&.
26301
26302 The &%add_header%& modifier acts immediately it is encountered during the
26303 processing of an ACL. Notice the difference between these two cases:
26304 .display
26305 &`accept add_header = ADDED: some text`&
26306 &`       `&<&'some condition'&>
26307
26308 &`accept `&<&'some condition'&>
26309 &`       add_header = ADDED: some text`&
26310 .endd
26311 In the first case, the header line is always added, whether or not the
26312 condition is true. In the second case, the header line is added only if the
26313 condition is true. Multiple occurrences of &%add_header%& may occur in the same
26314 ACL statement. All those that are encountered before a condition fails are
26315 honoured.
26316
26317 .cindex "&%warn%& ACL verb"
26318 For compatibility with previous versions of Exim, a &%message%& modifier for a
26319 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
26320 effect only if all the conditions are true, even if it appears before some of
26321 them. Furthermore, only the last occurrence of &%message%& is honoured. This
26322 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
26323 are present on a &%warn%& verb, both are processed according to their
26324 specifications.
26325
26326 By default, new header lines are added to a message at the end of the existing
26327 header lines. However, you can specify that any particular header line should
26328 be added right at the start (before all the &'Received:'& lines), immediately
26329 after the first block of &'Received:'& lines, or immediately before any line
26330 that is not a &'Received:'& or &'Resent-something:'& header.
26331
26332 This is done by specifying &":at_start:"&, &":after_received:"&, or
26333 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
26334 header line, respectively. (Header text cannot start with a colon, as there has
26335 to be a header name first.) For example:
26336 .code
26337 warn add_header = \
26338        :after_received:X-My-Header: something or other...
26339 .endd
26340 If more than one header line is supplied in a single &%add_header%& modifier,
26341 each one is treated independently and can therefore be placed differently. If
26342 you add more than one line at the start, or after the Received: block, they end
26343 up in reverse order.
26344
26345 &*Warning*&: This facility currently applies only to header lines that are
26346 added in an ACL. It does NOT work for header lines that are added in a
26347 system filter or in a router or transport.
26348
26349
26350
26351
26352 .section "ACL conditions" "SECTaclconditions"
26353 .cindex "&ACL;" "conditions; list of"
26354 Some of conditions listed in this section are available only when Exim is
26355 compiled with the content-scanning extension. They are included here briefly
26356 for completeness. More detailed descriptions can be found in the discussion on
26357 content scanning in chapter &<<CHAPexiscan>>&.
26358
26359 Not all conditions are relevant in all circumstances. For example, testing
26360 senders and recipients does not make sense in an ACL that is being run as the
26361 result of the arrival of an ETRN command, and checks on message headers can be
26362 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
26363 can use the same condition (with different parameters) more than once in the
26364 same ACL statement. This provides a way of specifying an &"and"& conjunction.
26365 The conditions are as follows:
26366
26367
26368 .vlist
26369 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
26370 .cindex "&ACL;" "nested"
26371 .cindex "&ACL;" "indirect"
26372 .cindex "&%acl%& ACL condition"
26373 The possible values of the argument are the same as for the
26374 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
26375 &"accept"& the condition is true; if it returns &"deny"& the condition is
26376 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
26377 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
26378 condition false. This means that further processing of the &%warn%& verb
26379 ceases, but processing of the ACL continues.
26380
26381 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
26382 the connection is dropped. If it returns &"discard"&, the verb must be
26383 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
26384 conditions are tested.
26385
26386 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
26387 loops. This condition allows you to use different ACLs in different
26388 circumstances. For example, different ACLs can be used to handle RCPT commands
26389 for different local users or different local domains.
26390
26391 .vitem &*authenticated&~=&~*&<&'string&~list'&>
26392 .cindex "&%authenticated%& ACL condition"
26393 .cindex "authentication" "ACL checking"
26394 .cindex "&ACL;" "testing for authentication"
26395 If the SMTP connection is not authenticated, the condition is false. Otherwise,
26396 the name of the authenticator is tested against the list. To test for
26397 authentication by any authenticator, you can set
26398 .code
26399 authenticated = *
26400 .endd
26401
26402 .vitem &*condition&~=&~*&<&'string'&>
26403 .cindex "&%condition%& ACL condition"
26404 .cindex "customizing" "ACL condition"
26405 .cindex "&ACL;" "customized test"
26406 .cindex "&ACL;" "testing, customized"
26407 This feature allows you to make up custom conditions. If the result of
26408 expanding the string is an empty string, the number zero, or one of the strings
26409 &"no"& or &"false"&, the condition is false. If the result is any non-zero
26410 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
26411 any other value, some error is assumed to have occurred, and the ACL returns
26412 &"defer"&. However, if the expansion is forced to fail, the condition is
26413 ignored. The effect is to treat it as true, whether it is positive or
26414 negative.
26415
26416 .vitem &*decode&~=&~*&<&'location'&>
26417 .cindex "&%decode%& ACL condition"
26418 This condition is available only when Exim is compiled with the
26419 content-scanning extension, and it is allowed only in the ACL defined by
26420 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
26421 If all goes well, the condition is true. It is false only if there are
26422 problems such as a syntax error or a memory shortage. For more details, see
26423 chapter &<<CHAPexiscan>>&.
26424
26425 .vitem &*demime&~=&~*&<&'extension&~list'&>
26426 .cindex "&%demime%& ACL condition"
26427 This condition is available only when Exim is compiled with the
26428 content-scanning extension. Its use is described in section
26429 &<<SECTdemimecond>>&.
26430
26431 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
26432 .cindex "&%dnslists%& ACL condition"
26433 .cindex "DNS list" "in ACL"
26434 .cindex "black list (DNS)"
26435 .cindex "&ACL;" "testing a DNS list"
26436 This condition checks for entries in DNS black lists. These are also known as
26437 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
26438 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
26439 different variants of this condition to describe briefly here. See sections
26440 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
26441
26442 .vitem &*domains&~=&~*&<&'domain&~list'&>
26443 .cindex "&%domains%& ACL condition"
26444 .cindex "domain" "ACL checking"
26445 .cindex "&ACL;" "testing a recipient domain"
26446 .vindex "&$domain_data$&"
26447 This condition is relevant only after a RCPT command. It checks that the domain
26448 of the recipient address is in the domain list. If percent-hack processing is
26449 enabled, it is done before this test is done. If the check succeeds with a
26450 lookup, the result of the lookup is placed in &$domain_data$& until the next
26451 &%domains%& test.
26452
26453 &*Note carefully*& (because many people seem to fall foul of this): you cannot
26454 use &%domains%& in a DATA ACL.
26455
26456
26457 .vitem &*encrypted&~=&~*&<&'string&~list'&>
26458 .cindex "&%encrypted%& ACL condition"
26459 .cindex "encryption" "checking in an ACL"
26460 .cindex "&ACL;" "testing for encryption"
26461 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
26462 name of the cipher suite in use is tested against the list. To test for
26463 encryption without testing for any specific cipher suite(s), set
26464 .code
26465 encrypted = *
26466 .endd
26467
26468
26469 .vitem &*hosts&~=&~*&<&'&~host&~list'&>
26470 .cindex "&%hosts%& ACL condition"
26471 .cindex "host" "ACL checking"
26472 .cindex "&ACL;" "testing the client host"
26473 This condition tests that the calling host matches the host list. If you have
26474 name lookups or wildcarded host names and IP addresses in the same host list,
26475 you should normally put the IP addresses first. For example, you could have:
26476 .code
26477 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
26478 .endd
26479 The lookup in this example uses the host name for its key. This is implied by
26480 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
26481 and it wouldn't matter which way round you had these two items.)
26482
26483 The reason for the problem with host names lies in the left-to-right way that
26484 Exim processes lists. It can test IP addresses without doing any DNS lookups,
26485 but when it reaches an item that requires a host name, it fails if it cannot
26486 find a host name to compare with the pattern. If the above list is given in the
26487 opposite order, the &%accept%& statement fails for a host whose name cannot be
26488 found, even if its IP address is 10.9.8.7.
26489
26490 If you really do want to do the name check first, and still recognize the IP
26491 address even if the name lookup fails, you can rewrite the ACL like this:
26492 .code
26493 accept hosts = dbm;/etc/friendly/hosts
26494 accept hosts = 10.9.8.7
26495 .endd
26496 The default action on failing to find the host name is to assume that the host
26497 is not in the list, so the first &%accept%& statement fails. The second
26498 statement can then check the IP address.
26499
26500 .vindex "&$host_data$&"
26501 If a &%hosts%& condition is satisfied by means of a lookup, the result
26502 of the lookup is made available in the &$host_data$& variable. This
26503 allows you, for example, to set up a statement like this:
26504 .code
26505 deny  hosts = net-lsearch;/some/file
26506 message = $host_data
26507 .endd
26508 which gives a custom error message for each denied host.
26509
26510 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
26511 .cindex "&%local_parts%& ACL condition"
26512 .cindex "local part" "ACL checking"
26513 .cindex "&ACL;" "testing a local part"
26514 .vindex "&$local_part_data$&"
26515 This condition is relevant only after a RCPT command. It checks that the local
26516 part of the recipient address is in the list. If percent-hack processing is
26517 enabled, it is done before this test. If the check succeeds with a lookup, the
26518 result of the lookup is placed in &$local_part_data$&, which remains set until
26519 the next &%local_parts%& test.
26520
26521 .vitem &*malware&~=&~*&<&'option'&>
26522 .cindex "&%malware%& ACL condition"
26523 .cindex "&ACL;" "virus scanning"
26524 .cindex "&ACL;" "scanning for viruses"
26525 This condition is available only when Exim is compiled with the
26526 content-scanning extension. It causes the incoming message to be scanned for
26527 viruses. For details, see chapter &<<CHAPexiscan>>&.
26528
26529 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
26530 .cindex "&%mime_regex%& ACL condition"
26531 .cindex "&ACL;" "testing by regex matching"
26532 This condition is available only when Exim is compiled with the
26533 content-scanning extension, and it is allowed only in the ACL defined by
26534 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
26535 with any of the regular expressions. For details, see chapter
26536 &<<CHAPexiscan>>&.
26537
26538 .vitem &*ratelimit&~=&~*&<&'parameters'&>
26539 .cindex "rate limiting"
26540 This condition can be used to limit the rate at which a user or host submits
26541 messages. Details are given in section &<<SECTratelimiting>>&.
26542
26543 .vitem &*recipients&~=&~*&<&'address&~list'&>
26544 .cindex "&%recipients%& ACL condition"
26545 .cindex "recipient" "ACL checking"
26546 .cindex "&ACL;" "testing a recipient"
26547 This condition is relevant only after a RCPT command. It checks the entire
26548 recipient address against a list of recipients.
26549
26550 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
26551 .cindex "&%regex%& ACL condition"
26552 .cindex "&ACL;" "testing by regex matching"
26553 This condition is available only when Exim is compiled with the
26554 content-scanning extension, and is available only in the DATA, MIME, and
26555 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
26556 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
26557
26558 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
26559 .cindex "&%sender_domains%& ACL condition"
26560 .cindex "sender" "ACL checking"
26561 .cindex "&ACL;" "testing a sender domain"
26562 .vindex "&$domain$&"
26563 .vindex "&$sender_address_domain$&"
26564 This condition tests the domain of the sender of the message against the given
26565 domain list. &*Note*&: The domain of the sender address is in
26566 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
26567 of this condition. This is an exception to the general rule for testing domain
26568 lists. It is done this way so that, if this condition is used in an ACL for a
26569 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
26570 influence the sender checking.
26571
26572 &*Warning*&: It is a bad idea to use this condition on its own as a control on
26573 relaying, because sender addresses are easily, and commonly, forged.
26574
26575 .vitem &*senders&~=&~*&<&'address&~list'&>
26576 .cindex "&%senders%& ACL condition"
26577 .cindex "sender" "ACL checking"
26578 .cindex "&ACL;" "testing a sender"
26579 This condition tests the sender of the message against the given list. To test
26580 for a bounce message, which has an empty sender, set
26581 .code
26582 senders = :
26583 .endd
26584 &*Warning*&: It is a bad idea to use this condition on its own as a control on
26585 relaying, because sender addresses are easily, and commonly, forged.
26586
26587 .vitem &*spam&~=&~*&<&'username'&>
26588 .cindex "&%spam%& ACL condition"
26589 .cindex "&ACL;" "scanning for spam"
26590 This condition is available only when Exim is compiled with the
26591 content-scanning extension. It causes the incoming message to be scanned by
26592 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
26593
26594 .vitem &*verify&~=&~certificate*&
26595 .cindex "&%verify%& ACL condition"
26596 .cindex "TLS" "client certificate verification"
26597 .cindex "certificate" "verification of client"
26598 .cindex "&ACL;" "certificate verification"
26599 .cindex "&ACL;" "testing a TLS certificate"
26600 This condition is true in an SMTP session if the session is encrypted, and a
26601 certificate was received from the client, and the certificate was verified. The
26602 server requests a certificate only if the client matches &%tls_verify_hosts%&
26603 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
26604
26605 .vitem &*verify&~=&~csa*&
26606 .cindex "CSA verification"
26607 This condition checks whether the sending host (the client) is authorized to
26608 send email. Details of how this works are given in section
26609 &<<SECTverifyCSA>>&.
26610
26611 .vitem &*verify&~=&~header_sender/*&<&'options'&>
26612 .cindex "&%verify%& ACL condition"
26613 .cindex "&ACL;" "verifying sender in the header"
26614 .cindex "header lines" "verifying the sender in"
26615 .cindex "sender" "verifying in header"
26616 .cindex "verifying" "sender in header"
26617 This condition is relevant only in an ACL that is run after a message has been
26618 received, that is, in an ACL specified by &%acl_smtp_data%& or
26619 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
26620 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
26621 is loosely thought of as a &"sender"& address (hence the name of the test).
26622 However, an address that appears in one of these headers need not be an address
26623 that accepts bounce messages; only sender addresses in envelopes are required
26624 to accept bounces. Therefore, if you use the callout option on this check, you
26625 might want to arrange for a non-empty address in the MAIL command.
26626
26627 Details of address verification and the options are given later, starting at
26628 section &<<SECTaddressverification>>& (callouts are described in section
26629 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
26630 condition to restrict it to bounce messages only:
26631 .code
26632 deny    senders = :
26633         message = A valid sender header is required for bounces
26634        !verify  = header_sender
26635 .endd
26636
26637 .vitem &*verify&~=&~header_syntax*&
26638 .cindex "&%verify%& ACL condition"
26639 .cindex "&ACL;" "verifying header syntax"
26640 .cindex "header lines" "verifying syntax"
26641 .cindex "verifying" "header syntax"
26642 This condition is relevant only in an ACL that is run after a message has been
26643 received, that is, in an ACL specified by &%acl_smtp_data%& or
26644 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
26645 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
26646 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
26647 permitted only in locally generated messages and from hosts that match
26648 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26649 appropriate.
26650
26651 Note that this condition is a syntax check only. However, a common spamming
26652 ploy used to be to send syntactically invalid headers such as
26653 .code
26654 To: @
26655 .endd
26656 and this condition can be used to reject such messages, though they are not as
26657 common as they used to be.
26658
26659 .vitem &*verify&~=&~helo*&
26660 .cindex "&%verify%& ACL condition"
26661 .cindex "&ACL;" "verifying HELO/EHLO"
26662 .cindex "HELO" "verifying"
26663 .cindex "EHLO" "verifying"
26664 .cindex "verifying" "EHLO"
26665 .cindex "verifying" "HELO"
26666 This condition is true if a HELO or EHLO command has been received from the
26667 client host, and its contents have been verified. If there has been no previous
26668 attempt to verify the HELO/EHLO contents, it is carried out when this
26669 condition is encountered. See the description of the &%helo_verify_hosts%& and
26670 &%helo_try_verify_hosts%& options for details of how to request verification
26671 independently of this condition.
26672
26673 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
26674 option), this condition is always true.
26675
26676
26677 .vitem &*verify&~=&~not_blind*&
26678 .cindex "verifying" "not blind"
26679 .cindex "bcc recipients, verifying none"
26680 This condition checks that there are no blind (bcc) recipients in the message.
26681 Every envelope recipient must appear either in a &'To:'& header line or in a
26682 &'Cc:'& header line for this condition to be true. Local parts are checked
26683 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
26684 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
26685 used only in a DATA or non-SMTP ACL.
26686
26687 There are, of course, many legitimate messages that make use of blind (bcc)
26688 recipients. This check should not be used on its own for blocking messages.
26689
26690
26691 .vitem &*verify&~=&~recipient/*&<&'options'&>
26692 .cindex "&%verify%& ACL condition"
26693 .cindex "&ACL;" "verifying recipient"
26694 .cindex "recipient" "verifying"
26695 .cindex "verifying" "recipient"
26696 .vindex "&$address_data$&"
26697 This condition is relevant only after a RCPT command. It verifies the current
26698 recipient. Details of address verification are given later, starting at section
26699 &<<SECTaddressverification>>&. After a recipient has been verified, the value
26700 of &$address_data$& is the last value that was set while routing the address.
26701 This applies even if the verification fails. When an address that is being
26702 verified is redirected to a single address, verification continues with the new
26703 address, and in that case, the subsequent value of &$address_data$& is the
26704 value for the child address.
26705
26706 .vitem &*verify&~=&~reverse_host_lookup*&
26707 .cindex "&%verify%& ACL condition"
26708 .cindex "&ACL;" "verifying host reverse lookup"
26709 .cindex "host" "verifying reverse lookup"
26710 This condition ensures that a verified host name has been looked up from the IP
26711 address of the client host. (This may have happened already if the host name
26712 was needed for checking a host list, or if the host matched &%host_lookup%&.)
26713 Verification ensures that the host name obtained from a reverse DNS lookup, or
26714 one of its aliases, does, when it is itself looked up in the DNS, yield the
26715 original IP address.
26716
26717 If this condition is used for a locally generated message (that is, when there
26718 is no client host involved), it always succeeds.
26719
26720 .vitem &*verify&~=&~sender/*&<&'options'&>
26721 .cindex "&%verify%& ACL condition"
26722 .cindex "&ACL;" "verifying sender"
26723 .cindex "sender" "verifying"
26724 .cindex "verifying" "sender"
26725 This condition is relevant only after a MAIL or RCPT command, or after a
26726 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
26727 the message's sender is empty (that is, this is a bounce message), the
26728 condition is true. Otherwise, the sender address is verified.
26729
26730 .vindex "&$address_data$&"
26731 .vindex "&$sender_address_data$&"
26732 If there is data in the &$address_data$& variable at the end of routing, its
26733 value is placed in &$sender_address_data$& at the end of verification. This
26734 value can be used in subsequent conditions and modifiers in the same ACL
26735 statement. It does not persist after the end of the current statement. If you
26736 want to preserve the value for longer, you can save it in an ACL variable.
26737
26738 Details of verification are given later, starting at section
26739 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
26740 to avoid doing it more than once per message.
26741
26742 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
26743 .cindex "&%verify%& ACL condition"
26744 This is a variation of the previous option, in which a modified address is
26745 verified as a sender.
26746 .endlist
26747
26748
26749
26750 .section "Using DNS lists" "SECTmorednslists"
26751 .cindex "DNS list" "in ACL"
26752 .cindex "black list (DNS)"
26753 .cindex "&ACL;" "testing a DNS list"
26754 In its simplest form, the &%dnslists%& condition tests whether the calling host
26755 is on at least one of a number of DNS lists by looking up the inverted IP
26756 address in one or more DNS domains. (Note that DNS list domains are not mail
26757 domains, so the &`+`& syntax for named lists doesn't work - it is used for
26758 special options instead.) For example, if the calling host's IP
26759 address is 192.168.62.43, and the ACL statement is
26760 .code
26761 deny dnslists = blackholes.mail-abuse.org : \
26762                 dialups.mail-abuse.org
26763 .endd
26764 the following records are looked up:
26765 .code
26766 43.62.168.192.blackholes.mail-abuse.org
26767 43.62.168.192.dialups.mail-abuse.org
26768 .endd
26769 As soon as Exim finds an existing DNS record, processing of the list stops.
26770 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
26771 to test that a host is on more than one list (an &"and"& conjunction), you can
26772 use two separate conditions:
26773 .code
26774 deny dnslists = blackholes.mail-abuse.org
26775      dnslists = dialups.mail-abuse.org
26776 .endd
26777 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
26778 behaves as if the host does not match the list item, that is, as if the DNS
26779 record does not exist. If there are further items in the DNS list, they are
26780 processed.
26781
26782 This is usually the required action when &%dnslists%& is used with &%deny%&
26783 (which is the most common usage), because it prevents a DNS failure from
26784 blocking mail. However, you can change this behaviour by putting one of the
26785 following special items in the list:
26786 .display
26787 &`+include_unknown `&   behave as if the item is on the list
26788 &`+exclude_unknown `&   behave as if the item is not on the list (default)
26789 &`+defer_unknown   `&   give a temporary error
26790 .endd
26791 .cindex "&`+include_unknown`&"
26792 .cindex "&`+exclude_unknown`&"
26793 .cindex "&`+defer_unknown`&"
26794 Each of these applies to any subsequent items on the list. For example:
26795 .code
26796 deny dnslists = +defer_unknown : foo.bar.example
26797 .endd
26798 Testing the list of domains stops as soon as a match is found. If you want to
26799 warn for one list and block for another, you can use two different statements:
26800 .code
26801 deny  dnslists = blackholes.mail-abuse.org
26802 warn  message  = X-Warn: sending host is on dialups list
26803       dnslists = dialups.mail-abuse.org
26804 .endd
26805 DNS list lookups are cached by Exim for the duration of the SMTP session,
26806 so a lookup based on the IP address is done at most once for any incoming
26807 connection. Exim does not share information between multiple incoming
26808 connections (but your local name server cache should be active).
26809
26810
26811
26812 .section "Specifying the IP address for a DNS list lookup" "SECID201"
26813 .cindex "DNS list" "keyed by explicit IP address"
26814 By default, the IP address that is used in a DNS list lookup is the IP address
26815 of the calling host. However, you can specify another IP address by listing it
26816 after the domain name, introduced by a slash. For example:
26817 .code
26818 deny dnslists = black.list.tld/192.168.1.2
26819 .endd
26820 This feature is not very helpful with explicit IP addresses; it is intended for
26821 use with IP addresses that are looked up, for example, the IP addresses of the
26822 MX hosts or nameservers of an email sender address. For an example, see section
26823 &<<SECTmulkeyfor>>& below.
26824
26825
26826
26827
26828 .section "DNS lists keyed on domain names" "SECID202"
26829 .cindex "DNS list" "keyed by domain name"
26830 There are some lists that are keyed on domain names rather than inverted IP
26831 addresses (see for example the &'domain based zones'& link at
26832 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
26833 with these lists. You can change the name that is looked up in a DNS list by
26834 listing it after the domain name, introduced by a slash. For example,
26835 .code
26836 deny  message  = Sender's domain is listed at $dnslist_domain
26837       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
26838 .endd
26839 This particular example is useful only in ACLs that are obeyed after the
26840 RCPT or DATA commands, when a sender address is available. If (for
26841 example) the message's sender is &'user@tld.example'& the name that is looked
26842 up by this example is
26843 .code
26844 tld.example.dsn.rfc-ignorant.org
26845 .endd
26846 A single &%dnslists%& condition can contain entries for both names and IP
26847 addresses. For example:
26848 .code
26849 deny dnslists = sbl.spamhaus.org : \
26850                 dsn.rfc-ignorant.org/$sender_address_domain
26851 .endd
26852 The first item checks the sending host's IP address; the second checks a domain
26853 name. The whole condition is true if either of the DNS lookups succeeds.
26854
26855
26856
26857
26858 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
26859 .cindex "DNS list" "multiple keys for"
26860 The syntax described above for looking up explicitly-defined values (either
26861 names or IP addresses) in a DNS blacklist is a simplification. After the domain
26862 name for the DNS list, what follows the slash can in fact be a list of items.
26863 As with all lists in Exim, the default separator is a colon. However, because
26864 this is a sublist within the list of DNS blacklist domains, it is necessary
26865 either to double the separators like this:
26866 .code
26867 dnslists = black.list.tld/name.1::name.2
26868 .endd
26869 or to change the separator character, like this:
26870 .code
26871 dnslists = black.list.tld/<;name.1;name.2
26872 .endd
26873 If an item in the list is an IP address, it is inverted before the DNS
26874 blacklist domain is appended. If it is not an IP address, no inversion
26875 occurs. Consider this condition:
26876 .code
26877 dnslists = black.list.tld/<;192.168.1.2;a.domain
26878 .endd
26879 The DNS lookups that occur are:
26880 .code
26881 2.1.168.192.black.list.tld
26882 a.domain.black.list.tld
26883 .endd
26884 Once a DNS record has been found (that matches a specific IP return
26885 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
26886 are done. If there is a temporary DNS error, the rest of the sublist of domains
26887 or IP addresses is tried. A temporary error for the whole dnslists item occurs
26888 only if no other DNS lookup in this sublist succeeds. In other words, a
26889 successful lookup for any of the items in the sublist overrides a temporary
26890 error for a previous item.
26891
26892 The ability to supply a list of items after the slash is in some sense just a
26893 syntactic convenience. These two examples have the same effect:
26894 .code
26895 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
26896 dnslists = black.list.tld/a.domain::b.domain
26897 .endd
26898 However, when the data for the list is obtained from a lookup, the second form
26899 is usually much more convenient. Consider this example:
26900 .code
26901 deny message  = The mail servers for the domain \
26902                 $sender_address_domain \
26903                 are listed at $dnslist_domain ($dnslist_value); \
26904                 see $dnslist_text.
26905      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
26906                                    ${lookup dnsdb {>|mxh=\
26907                                    $sender_address_domain} }} }
26908 .endd
26909 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
26910 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
26911 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
26912 of expanding the condition might be something like this:
26913 .code
26914 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
26915 .endd
26916 Thus, this example checks whether or not the IP addresses of the sender
26917 domain's mail servers are on the Spamhaus black list.
26918
26919 The key that was used for a successful DNS list lookup is put into the variable
26920 &$dnslist_matched$& (see section &<<SECID204>>&).
26921
26922
26923
26924
26925 .section "Data returned by DNS lists" "SECID203"
26926 .cindex "DNS list" "data returned from"
26927 DNS lists are constructed using address records in the DNS. The original RBL
26928 just used the address 127.0.0.1 on the right hand side of each record, but the
26929 RBL+ list and some other lists use a number of values with different meanings.
26930 The values used on the RBL+ list are:
26931 .display
26932 127.1.0.1  RBL
26933 127.1.0.2  DUL
26934 127.1.0.3  DUL and RBL
26935 127.1.0.4  RSS
26936 127.1.0.5  RSS and RBL
26937 127.1.0.6  RSS and DUL
26938 127.1.0.7  RSS and DUL and RBL
26939 .endd
26940 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
26941 different values. Some DNS lists may return more than one address record;
26942 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
26943
26944
26945 .section "Variables set from DNS lists" "SECID204"
26946 .cindex "expansion" "variables, set from DNS list"
26947 .cindex "DNS list" "variables set from"
26948 .vindex "&$dnslist_domain$&"
26949 .vindex "&$dnslist_matched$&"
26950 .vindex "&$dnslist_text$&"
26951 .vindex "&$dnslist_value$&"
26952 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
26953 the name of the overall domain that matched (for example,
26954 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
26955 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
26956 the DNS record. When the key is an IP address, it is not reversed in
26957 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
26958 cases, for example:
26959 .code
26960 deny dnslists = spamhaus.example
26961 .endd
26962 the key is also available in another variable (in this case,
26963 &$sender_host_address$&). In more complicated cases, however, this is not true.
26964 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
26965 might generate a dnslists lookup like this:
26966 .code
26967 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
26968 .endd
26969 If this condition succeeds, the value in &$dnslist_matched$& might be
26970 &`192.168.6.7`& (for example).
26971
26972 If more than one address record is returned by the DNS lookup, all the IP
26973 addresses are included in &$dnslist_value$&, separated by commas and spaces.
26974 The variable &$dnslist_text$& contains the contents of any associated TXT
26975 record. For lists such as RBL+ the TXT record for a merged entry is often not
26976 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
26977 information.
26978
26979 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
26980 &-- although these appear before the condition in the ACL, they are not
26981 expanded until after it has failed. For example:
26982 .code
26983 deny    hosts = !+local_networks
26984         message = $sender_host_address is listed \
26985                   at $dnslist_domain
26986         dnslists = rbl-plus.mail-abuse.example
26987 .endd
26988
26989
26990
26991 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
26992 .cindex "DNS list" "matching specific returned data"
26993 You can add an equals sign and an IP address after a &%dnslists%& domain name
26994 in order to restrict its action to DNS records with a matching right hand side.
26995 For example,
26996 .code
26997 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
26998 .endd
26999 rejects only those hosts that yield 127.0.0.2. Without this additional data,
27000 any address record is considered to be a match. For the moment, we assume
27001 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
27002 describes how multiple records are handled.
27003
27004 More than one IP address may be given for checking, using a comma as a
27005 separator. These are alternatives &-- if any one of them matches, the
27006 &%dnslists%& condition is true. For example:
27007 .code
27008 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
27009 .endd
27010 If you want to specify a constraining address list and also specify names or IP
27011 addresses to be looked up, the constraining address list must be specified
27012 first. For example:
27013 .code
27014 deny dnslists = dsn.rfc-ignorant.org\
27015                 =127.0.0.2/$sender_address_domain
27016 .endd
27017
27018 If the character &`&&`& is used instead of &`=`&, the comparison for each
27019 listed IP address is done by a bitwise &"and"& instead of by an equality test.
27020 In other words, the listed addresses are used as bit masks. The comparison is
27021 true if all the bits in the mask are present in the address that is being
27022 tested. For example:
27023 .code
27024 dnslists = a.b.c&0.0.0.3
27025 .endd
27026 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
27027 want to test whether one bit or another bit is present (as opposed to both
27028 being present), you must use multiple values. For example:
27029 .code
27030 dnslists = a.b.c&0.0.0.1,0.0.0.2
27031 .endd
27032 matches if the final component of the address is an odd number or two times
27033 an odd number.
27034
27035
27036
27037 .section "Negated DNS matching conditions" "SECID205"
27038 You can supply a negative list of IP addresses as part of a &%dnslists%&
27039 condition. Whereas
27040 .code
27041 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
27042 .endd
27043 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
27044 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
27045 .code
27046 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
27047 .endd
27048 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
27049 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
27050 words, the result of the test is inverted if an exclamation mark appears before
27051 the &`=`& (or the &`&&`&) sign.
27052
27053 &*Note*&: This kind of negation is not the same as negation in a domain,
27054 host, or address list (which is why the syntax is different).
27055
27056 If you are using just one list, the negation syntax does not gain you much. The
27057 previous example is precisely equivalent to
27058 .code
27059 deny  dnslists = a.b.c
27060      !dnslists = a.b.c=127.0.0.2,127.0.0.3
27061 .endd
27062 However, if you are using multiple lists, the negation syntax is clearer.
27063 Consider this example:
27064 .code
27065 deny  dnslists = sbl.spamhaus.org : \
27066                  list.dsbl.org : \
27067                  dnsbl.njabl.org!=127.0.0.3 : \
27068                  relays.ordb.org
27069 .endd
27070 Using only positive lists, this would have to be:
27071 .code
27072 deny  dnslists = sbl.spamhaus.org : \
27073                  list.dsbl.org
27074 deny  dnslists = dnsbl.njabl.org
27075      !dnslists = dnsbl.njabl.org=127.0.0.3
27076 deny  dnslists = relays.ordb.org
27077 .endd
27078 which is less clear, and harder to maintain.
27079
27080
27081
27082
27083 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
27084 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
27085 thereby providing more than one IP address. When an item in a &%dnslists%& list
27086 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
27087 the match to specific results from the DNS lookup, there are two ways in which
27088 the checking can be handled. For example, consider the condition:
27089 .code
27090 dnslists = a.b.c=127.0.0.1
27091 .endd
27092 What happens if the DNS lookup for the incoming IP address yields both
27093 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
27094 condition true because at least one given value was found, or is it false
27095 because at least one of the found values was not listed? And how does this
27096 affect negated conditions? Both possibilities are provided for with the help of
27097 additional separators &`==`& and &`=&&`&.
27098
27099 .ilist
27100 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
27101 IP addresses matches one of the listed addresses. For the example above, the
27102 condition is true because 127.0.0.1 matches.
27103 .next
27104 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
27105 looked up IP addresses matches one of the listed addresses. If the condition is
27106 changed to:
27107 .code
27108 dnslists = a.b.c==127.0.0.1
27109 .endd
27110 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27111 false because 127.0.0.2 is not listed. You would need to have:
27112 .code
27113 dnslists = a.b.c==127.0.0.1,127.0.0.2
27114 .endd
27115 for the condition to be true.
27116 .endlist
27117
27118 When &`!`& is used to negate IP address matching, it inverts the result, giving
27119 the precise opposite of the behaviour above. Thus:
27120 .ilist
27121 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
27122 addresses matches one of the listed addresses. Consider:
27123 .code
27124 dnslists = a.b.c!&0.0.0.1
27125 .endd
27126 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27127 false because 127.0.0.1 matches.
27128 .next
27129 If &`!==`& or &`!=&&`& is used, the condition is true there is at least one
27130 looked up IP address that does not match. Consider:
27131 .code
27132 dnslists = a.b.c!=&0.0.0.1
27133 .endd
27134 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27135 true, because 127.0.0.2 does not match. You would need to have:
27136 .code
27137 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
27138 .endd
27139 for the condition to be false.
27140 .endlist
27141 When the DNS lookup yields only a single IP address, there is no difference
27142 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
27143
27144
27145
27146
27147 .section "Detailed information from merged DNS lists" "SECTmordetinf"
27148 .cindex "DNS list" "information from merged"
27149 When the facility for restricting the matching IP values in a DNS list is used,
27150 the text from the TXT record that is set in &$dnslist_text$& may not reflect
27151 the true reason for rejection. This happens when lists are merged and the IP
27152 address in the A record is used to distinguish them; unfortunately there is
27153 only one TXT record. One way round this is not to use merged lists, but that
27154 can be inefficient because it requires multiple DNS lookups where one would do
27155 in the vast majority of cases when the host of interest is not on any of the
27156 lists.
27157
27158 A less inefficient way of solving this problem is available. If
27159 two domain names, comma-separated, are given, the second is used first to
27160 do an initial check, making use of any IP value restrictions that are set.
27161 If there is a match, the first domain is used, without any IP value
27162 restrictions, to get the TXT record. As a byproduct of this, there is also
27163 a check that the IP being tested is indeed on the first list. The first
27164 domain is the one that is put in &$dnslist_domain$&. For example:
27165 .code
27166 reject message  = \
27167          rejected because $sender_host_address is blacklisted \
27168          at $dnslist_domain\n$dnslist_text
27169        dnslists = \
27170          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
27171          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27172 .endd
27173 For the first blacklist item, this starts by doing a lookup in
27174 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
27175 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
27176 value, and as long as something is found, it looks for the corresponding TXT
27177 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
27178 The second blacklist item is processed similarly.
27179
27180 If you are interested in more than one merged list, the same list must be
27181 given several times, but because the results of the DNS lookups are cached,
27182 the DNS calls themselves are not repeated. For example:
27183 .code
27184 reject dnslists = \
27185          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
27186          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
27187          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
27188          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27189 .endd
27190 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
27191 values matches (or if no record is found), this is the only lookup that is
27192 done. Only if there is a match is one of the more specific lists consulted.
27193
27194
27195
27196 .section "DNS lists and IPv6" "SECTmorednslistslast"
27197 .cindex "IPv6" "DNS black lists"
27198 .cindex "DNS list" "IPv6 usage"
27199 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
27200 nibble by nibble. For example, if the calling host's IP address is
27201 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
27202 .code
27203 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
27204   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
27205 .endd
27206 (split over two lines here to fit on the page). Unfortunately, some of the DNS
27207 lists contain wildcard records, intended for IPv4, that interact badly with
27208 IPv6. For example, the DNS entry
27209 .code
27210 *.3.some.list.example.    A    127.0.0.1
27211 .endd
27212 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
27213 Unfortunately, it also matches the entire 3::/4 IPv6 network.
27214
27215 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
27216 &%condition%& condition, as in this example:
27217 .code
27218 deny   condition = ${if isip4{$sender_host_address}}
27219        dnslists  = some.list.example
27220 .endd
27221
27222 .section "Rate limiting incoming messages" "SECTratelimiting"
27223 .cindex "rate limiting" "client sending"
27224 .cindex "limiting client sending rates"
27225 .oindex "&%smtp_ratelimit_*%&"
27226 The &%ratelimit%& ACL condition can be used to measure and control the rate at
27227 which clients can send email. This is more powerful than the
27228 &%smtp_ratelimit_*%& options, because those options control the rate of
27229 commands in a single SMTP session only, whereas the &%ratelimit%& condition
27230 works across all connections (concurrent and sequential) from the same client
27231 host. The syntax of the &%ratelimit%& condition is:
27232 .display
27233 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
27234 .endd
27235 If the average client sending rate is less than &'m'& messages per time
27236 period &'p'& then the condition is false; otherwise it is true.
27237
27238 As a side-effect, the &%ratelimit%& condition sets the expansion variable
27239 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
27240 configured value of &'m'&, and &$sender_rate_period$& to the configured value
27241 of &'p'&.
27242
27243 The parameter &'p'& is the smoothing time constant, in the form of an Exim
27244 time interval, for example, &`8h`& for eight hours. A larger time constant
27245 means that it takes Exim longer to forget a client's past behaviour. The
27246 parameter &'m'& is the maximum number of messages that a client is permitted to
27247 send in each time interval. It also specifies the number of messages permitted
27248 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
27249 constant, you can allow a client to send more messages in a burst without
27250 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
27251 both small, messages must be sent at an even rate.
27252
27253 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
27254 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
27255 when deploying the &%ratelimit%& ACL condition. The script prints usage
27256 instructions when it is run with no arguments.
27257
27258 The key is used to look up the data for calculating the client's average
27259 sending rate. This data is stored in Exim's spool directory, alongside the
27260 retry and other hints databases. The default key is &$sender_host_address$&,
27261 which means Exim computes the sending rate of each client host IP address.
27262 By changing the key you can change how Exim identifies clients for the purpose
27263 of ratelimiting. For example, to limit the sending rate of each authenticated
27264 user, independent of the computer they are sending from, set the key to
27265 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
27266 example, &$authenticated_id$& is only meaningful if the client has
27267 authenticated (which you can check with the &%authenticated%& ACL condition).
27268
27269 The lookup key does not have to identify clients: If you want to limit the
27270 rate at which a recipient receives messages, you can use the key
27271 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
27272 ACL.
27273
27274 Internally, Exim appends the smoothing constant &'p'& and the options onto the
27275 lookup key because they alter the meaning of the stored data. This is not true
27276 for the limit &'m'&, so you can alter the configured maximum rate and Exim will
27277 still remember clients' past behaviour, but if you alter the other ratelimit
27278 parameters Exim forgets past behaviour.
27279
27280 Each &%ratelimit%& condition can have up to three options. One option
27281 specifies what Exim measures the rate of, and the second specifies how Exim
27282 handles excessively fast clients. The third option can be &`noupdate`&, to
27283 disable updating of the ratelimiting database (see section &<<rearatdat>>&).
27284 The options are separated by a slash, like the other parameters. They may
27285 appear in any order.
27286
27287 .section "Ratelimit options for what is being measured" "ratoptmea"
27288 The &%per_conn%& option limits the client's connection rate.
27289
27290 The &%per_mail%& option limits the client's rate of sending messages. This is
27291 the default if none of the &%per_*%& options is specified.
27292
27293 The &%per_byte%& option limits the sender's email bandwidth. Note that it is
27294 best to use this option in the DATA ACL; if it is used in an earlier ACL it
27295 relies on the SIZE parameter specified by the client in its MAIL command,
27296 which may be inaccurate or completely missing. You can follow the limit &'m'&
27297 in the configuration with K, M, or G to specify limits in kilobytes,
27298 megabytes, or gigabytes, respectively.
27299
27300 The &%per_rcpt%& option causes Exim to limit the rate at which
27301 recipients are accepted. To be effective, it would need to be used in
27302 either the &%acl_smtp_rcpt%& or the &%acl_not_smtp%& ACL. In the
27303 &%acl_smtp_rcpt%& ACL, the number of recipients is incremented by one.
27304 In the case of a locally submitted message in the &%acl_not_smtp%& ACL,
27305 the number of recipients is incremented by the &%$recipients_count%&
27306 for the entire message. Note that in either case the rate limiting
27307 engine will see a message with many recipients as a large high-speed
27308 burst.
27309
27310 The &%per_cmd%& option causes Exim to recompute the rate every time the
27311 condition is processed. This can be used to limit the SMTP command rate.
27312 This command is essentially an alias of &%per_rcpt%& to make it clear
27313 that the effect is to limit the rate at which individual commands,
27314 rather than recipients, are accepted.
27315
27316 .section "Ratelimit options for handling fast clients" "ratophanfas"
27317 If a client's average rate is greater than the maximum, the rate limiting
27318 engine can react in two possible ways, depending on the presence of the
27319 &%strict%& or &%leaky%& options. This is independent of the other
27320 counter-measures (such as rejecting the message) that may be specified by the
27321 rest of the ACL. The default mode is leaky, which avoids a sender's
27322 over-aggressive retry rate preventing it from getting any email through.
27323
27324 The &%strict%& option means that the client's recorded rate is always
27325 updated. The effect of this is that Exim measures the client's average rate
27326 of attempts to send email, which can be much higher than the maximum it is
27327 actually allowed. If the client is over the limit it may be subjected to
27328 counter-measures by the ACL until it slows down below the maximum rate. If
27329 the client stops attempting to send email for the time specified in the &'p'&
27330 parameter then its computed rate will decay exponentially to 37% of its peak
27331 value. You can work out the time (the number of smoothing periods) that a
27332 client is subjected to counter-measures after an over-limit burst with this
27333 formula:
27334 .code
27335         ln(peakrate/maxrate)
27336 .endd
27337 The &%leaky%& (default) option means that the client's recorded rate is not
27338 updated if it is above the limit. The effect of this is that Exim measures the
27339 client's average rate of successfully sent email, which cannot be greater than
27340 the maximum allowed. If the client is over the limit it may suffer some
27341 counter-measures (as specified in the ACL), but it will still be able to send
27342 email at the configured maximum rate, whatever the rate of its attempts. This
27343 is generally the better choice if you have clients that retry automatically.
27344
27345 .section "Using rate limiting" "useratlim"
27346 Exim's other ACL facilities are used to define what counter-measures are taken
27347 when the rate limit is exceeded. This might be anything from logging a warning
27348 (for example, while measuring existing sending rates in order to define
27349 policy), through time delays to slow down fast senders, up to rejecting the
27350 message. For example:
27351 .code
27352 # Log all senders' rates
27353 warn ratelimit = 0 / 1h / strict
27354      log_message = Sender rate $sender_rate / $sender_rate_period
27355
27356 # Slow down fast senders; note the need to truncate $sender_rate
27357 # at the decimal point.
27358 warn ratelimit = 100 / 1h / per_rcpt / strict
27359      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
27360                    $sender_rate_limit }s
27361
27362 # Keep authenticated users under control
27363 deny authenticated = *
27364      ratelimit = 100 / 1d / strict / $authenticated_id
27365
27366 # System-wide rate limit
27367 defer message = Sorry, too busy. Try again later.
27368      ratelimit = 10 / 1s / $primary_hostname
27369
27370 # Restrict incoming rate from each host, with a default
27371 # set using a macro and special cases looked up in a table.
27372 defer message = Sender rate exceeds $sender_rate_limit \
27373                messages per $sender_rate_period
27374      ratelimit = ${lookup {$sender_host_address} \
27375                    cdb {DB/ratelimits.cdb} \
27376                    {$value} {RATELIMIT} }
27377 .endd
27378 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
27379 especially with the &%per_rcpt%& option, you may suffer from a performance
27380 bottleneck caused by locking on the ratelimit hints database. Apart from
27381 making your ACLs less complicated, you can reduce the problem by using a
27382 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
27383 this means that Exim will lose its hints data after a reboot (including retry
27384 hints, the callout cache, and ratelimit data).
27385
27386
27387 .section "Reading ratelimit data without updating" "rearatdat"
27388 .cindex "rate limitint" "reading data without updating"
27389 If the &%noupdate%& option is present on a &%ratelimit%& ACL condition, Exim
27390 computes the rate and checks the limit as normal, but it does not update the
27391 saved data. This means that, in relevant ACLs, it is possible to lookup the
27392 existence of a specified (or auto-generated) ratelimit key without incrementing
27393 the ratelimit counter for that key. In order for this to be useful, another ACL
27394 entry must set the rate for the same key (otherwise it will always be zero).
27395 For example:
27396 .code
27397 acl_check_connect:
27398   deny ratelimit = 100 / 5m / strict / per_cmd / noupdate
27399        log_message = RATE: $sender_rate/$sender_rate_period \
27400                      (max $sender_rate_limit)
27401 .endd
27402 .display
27403 &'... some other logic and tests...'&
27404 .endd
27405 .code
27406 acl_check_mail:
27407   warn ratelimit = 100 / 5m / strict / per_cmd
27408        condition = ${if le{$sender_rate}{$sender_rate_limit}}
27409        logwrite  = RATE UPDATE: $sender_rate/$sender_rate_period \
27410                      (max $sender_rate_limit)
27411 .endd
27412 In this example, the rate is tested and used to deny access (when it is too
27413 high) in the connect ACL, but the actual computation of the remembered rate
27414 happens later, on a per-command basis, in another ACL.
27415
27416
27417
27418 .section "Address verification" "SECTaddressverification"
27419 .cindex "verifying address" "options for"
27420 .cindex "policy control" "address verification"
27421 Several of the &%verify%& conditions described in section
27422 &<<SECTaclconditions>>& cause addresses to be verified. Section
27423 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
27424 The verification conditions can be followed by options that modify the
27425 verification process. The options are separated from the keyword and from each
27426 other by slashes, and some of them contain parameters. For example:
27427 .code
27428 verify = sender/callout
27429 verify = recipient/defer_ok/callout=10s,defer_ok
27430 .endd
27431 The first stage of address verification, which always happens, is to run the
27432 address through the routers, in &"verify mode"&. Routers can detect the
27433 difference between verification and routing for delivery, and their actions can
27434 be varied by a number of generic options such as &%verify%& and &%verify_only%&
27435 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
27436 The available options are as follows:
27437
27438 .ilist
27439 If the &%callout%& option is specified, successful routing to one or more
27440 remote hosts is followed by a &"callout"& to those hosts as an additional
27441 check. Callouts and their sub-options are discussed in the next section.
27442 .next
27443 If there is a defer error while doing verification routing, the ACL
27444 normally returns &"defer"&. However, if you include &%defer_ok%& in the
27445 options, the condition is forced to be true instead. Note that this is a main
27446 verification option as well as a suboption for callouts.
27447 .next
27448 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
27449 discusses the reporting of sender address verification failures.
27450 .next
27451 The &%success_on_redirect%& option causes verification always to succeed
27452 immediately after a successful redirection. By default, if a redirection
27453 generates just one address, that address is also verified. See further
27454 discussion in section &<<SECTredirwhilveri>>&.
27455 .endlist
27456
27457 .cindex "verifying address" "differentiating failures"
27458 .vindex "&$recipient_verify_failure$&"
27459 .vindex "&$sender_verify_failure$&"
27460 .vindex "&$acl_verify_message$&"
27461 After an address verification failure, &$acl_verify_message$& contains the
27462 error message that is associated with the failure. It can be preserved by
27463 coding like this:
27464 .code
27465 warn  !verify = sender
27466        set acl_m0 = $acl_verify_message
27467 .endd
27468 If you are writing your own custom rejection message or log message when
27469 denying access, you can use this variable to include information about the
27470 verification failure.
27471
27472 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
27473 appropriate) contains one of the following words:
27474
27475 .ilist
27476 &%qualify%&: The address was unqualified (no domain), and the message
27477 was neither local nor came from an exempted host.
27478 .next
27479 &%route%&: Routing failed.
27480 .next
27481 &%mail%&: Routing succeeded, and a callout was attempted; rejection
27482 occurred at or before the MAIL command (that is, on initial
27483 connection, HELO, or MAIL).
27484 .next
27485 &%recipient%&: The RCPT command in a callout was rejected.
27486 .next
27487 &%postmaster%&: The postmaster check in a callout was rejected.
27488 .endlist
27489
27490 The main use of these variables is expected to be to distinguish between
27491 rejections of MAIL and rejections of RCPT in callouts.
27492
27493
27494
27495
27496 .section "Callout verification" "SECTcallver"
27497 .cindex "verifying address" "by callout"
27498 .cindex "callout" "verification"
27499 .cindex "SMTP" "callout verification"
27500 For non-local addresses, routing verifies the domain, but is unable to do any
27501 checking of the local part. There are situations where some means of verifying
27502 the local part is desirable. One way this can be done is to make an SMTP
27503 &'callback'& to a delivery host for the sender address or a &'callforward'& to
27504 a subsequent host for a recipient address, to see if the host accepts the
27505 address. We use the term &'callout'& to cover both cases. Note that for a
27506 sender address, the callback is not to the client host that is trying to
27507 deliver the message, but to one of the hosts that accepts incoming mail for the
27508 sender's domain.
27509
27510 Exim does not do callouts by default. If you want them to happen, you must
27511 request them by setting appropriate options on the &%verify%& condition, as
27512 described below. This facility should be used with care, because it can add a
27513 lot of resource usage to the cost of verifying an address. However, Exim does
27514 cache the results of callouts, which helps to reduce the cost. Details of
27515 caching are in section &<<SECTcallvercache>>&.
27516
27517 Recipient callouts are usually used only between hosts that are controlled by
27518 the same administration. For example, a corporate gateway host could use
27519 callouts to check for valid recipients on an internal mailserver. A successful
27520 callout does not guarantee that a real delivery to the address would succeed;
27521 on the other hand, a failing callout does guarantee that a delivery would fail.
27522
27523 If the &%callout%& option is present on a condition that verifies an address, a
27524 second stage of verification occurs if the address is successfully routed to
27525 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
27526 &(manualroute)& router, where the router specifies the hosts. However, if a
27527 router that does not set up hosts routes to an &(smtp)& transport with a
27528 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
27529 &%hosts_override%& set, its hosts are always used, whether or not the router
27530 supplies a host list.
27531
27532 The port that is used is taken from the transport, if it is specified and is a
27533 remote transport. (For routers that do verification only, no transport need be
27534 specified.) Otherwise, the default SMTP port is used. If a remote transport
27535 specifies an outgoing interface, this is used; otherwise the interface is not
27536 specified. Likewise, the text that is used for the HELO command is taken from
27537 the transport's &%helo_data%& option; if there is no transport, the value of
27538 &$smtp_active_hostname$& is used.
27539
27540 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
27541 test whether a bounce message could be delivered to the sender address. The
27542 following SMTP commands are sent:
27543 .display
27544 &`HELO `&<&'local host name'&>
27545 &`MAIL FROM:<>`&
27546 &`RCPT TO:`&<&'the address to be tested'&>
27547 &`QUIT`&
27548 .endd
27549 LHLO is used instead of HELO if the transport's &%protocol%& option is
27550 set to &"lmtp"&.
27551
27552 A recipient callout check is similar. By default, it also uses an empty address
27553 for the sender. This default is chosen because most hosts do not make use of
27554 the sender address when verifying a recipient. Using the same address means
27555 that a single cache entry can be used for each recipient. Some sites, however,
27556 do make use of the sender address when verifying. These are catered for by the
27557 &%use_sender%& and &%use_postmaster%& options, described in the next section.
27558
27559 If the response to the RCPT command is a 2&'xx'& code, the verification
27560 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
27561 Exim tries the next host, if any. If there is a problem with all the remote
27562 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
27563 &%callout%& option is given, in which case the condition is forced to succeed.
27564
27565 .cindex "SMTP" "output flushing, disabling for callout"
27566 A callout may take a little time. For this reason, Exim normally flushes SMTP
27567 output before performing a callout in an ACL, to avoid unexpected timeouts in
27568 clients when the SMTP PIPELINING extension is in use. The flushing can be
27569 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
27570
27571
27572
27573
27574 .section "Additional parameters for callouts" "CALLaddparcall"
27575 .cindex "callout" "additional parameters for"
27576 The &%callout%& option can be followed by an equals sign and a number of
27577 optional parameters, separated by commas. For example:
27578 .code
27579 verify = recipient/callout=10s,defer_ok
27580 .endd
27581 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
27582 separate verify options, is retained for backwards compatibility, but is now
27583 deprecated. The additional parameters for &%callout%& are as follows:
27584
27585
27586 .vlist
27587 .vitem <&'a&~time&~interval'&>
27588 .cindex "callout" "timeout, specifying"
27589 This specifies the timeout that applies for the callout attempt to each host.
27590 For example:
27591 .code
27592 verify = sender/callout=5s
27593 .endd
27594 The default is 30 seconds. The timeout is used for each response from the
27595 remote host. It is also used for the initial connection, unless overridden by
27596 the &%connect%& parameter.
27597
27598
27599 .vitem &*connect&~=&~*&<&'time&~interval'&>
27600 .cindex "callout" "connection timeout, specifying"
27601 This parameter makes it possible to set a different (usually smaller) timeout
27602 for making the SMTP connection. For example:
27603 .code
27604 verify = sender/callout=5s,connect=1s
27605 .endd
27606 If not specified, this timeout defaults to the general timeout value.
27607
27608 .vitem &*defer_ok*&
27609 .cindex "callout" "defer, action on"
27610 When this parameter is present, failure to contact any host, or any other kind
27611 of temporary error, is treated as success by the ACL. However, the cache is not
27612 updated in this circumstance.
27613
27614 .vitem &*fullpostmaster*&
27615 .cindex "callout" "full postmaster check"
27616 This operates like the &%postmaster%& option (see below), but if the check for
27617 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
27618 accordance with the specification in RFC 2821. The RFC states that the
27619 unqualified address &'postmaster'& should be accepted.
27620
27621
27622 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
27623 .cindex "callout" "sender when verifying header"
27624 When verifying addresses in header lines using the &%header_sender%&
27625 verification option, Exim behaves by default as if the addresses are envelope
27626 sender addresses from a message. Callout verification therefore tests to see
27627 whether a bounce message could be delivered, by using an empty address in the
27628 MAIL command. However, it is arguable that these addresses might never be used
27629 as envelope senders, and could therefore justifiably reject bounce messages
27630 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
27631 address to use in the MAIL command. For example:
27632 .code
27633 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
27634 .endd
27635 This parameter is available only for the &%header_sender%& verification option.
27636
27637
27638 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
27639 .cindex "callout" "overall timeout, specifying"
27640 This parameter sets an overall timeout for performing a callout verification.
27641 For example:
27642 .code
27643 verify = sender/callout=5s,maxwait=30s
27644 .endd
27645 This timeout defaults to four times the callout timeout for individual SMTP
27646 commands. The overall timeout applies when there is more than one host that can
27647 be tried. The timeout is checked before trying the next host. This prevents
27648 very long delays if there are a large number of hosts and all are timing out
27649 (for example, when network connections are timing out).
27650
27651
27652 .vitem &*no_cache*&
27653 .cindex "callout" "cache, suppressing"
27654 .cindex "caching callout, suppressing"
27655 When this parameter is given, the callout cache is neither read nor updated.
27656
27657 .vitem &*postmaster*&
27658 .cindex "callout" "postmaster; checking"
27659 When this parameter is set, a successful callout check is followed by a similar
27660 check for the local part &'postmaster'& at the same domain. If this address is
27661 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
27662 the postmaster check is recorded in a cache record; if it is a failure, this is
27663 used to fail subsequent callouts for the domain without a connection being
27664 made, until the cache record expires.
27665
27666 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
27667 The postmaster check uses an empty sender in the MAIL command by default.
27668 You can use this parameter to do a postmaster check using a different address.
27669 For example:
27670 .code
27671 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
27672 .endd
27673 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
27674 one overrides. The &%postmaster%& parameter is equivalent to this example:
27675 .code
27676 require  verify = sender/callout=postmaster_mailfrom=
27677 .endd
27678 &*Warning*&: The caching arrangements for postmaster checking do not take
27679 account of the sender address. It is assumed that either the empty address or
27680 a fixed non-empty address will be used. All that Exim remembers is that the
27681 postmaster check for the domain succeeded or failed.
27682
27683
27684 .vitem &*random*&
27685 .cindex "callout" "&""random""& check"
27686 When this parameter is set, before doing the normal callout check, Exim does a
27687 check for a &"random"& local part at the same domain. The local part is not
27688 really random &-- it is defined by the expansion of the option
27689 &%callout_random_local_part%&, which defaults to
27690 .code
27691 $primary_host_name-$tod_epoch-testing
27692 .endd
27693 The idea here is to try to determine whether the remote host accepts all local
27694 parts without checking. If it does, there is no point in doing callouts for
27695 specific local parts. If the &"random"& check succeeds, the result is saved in
27696 a cache record, and used to force the current and subsequent callout checks to
27697 succeed without a connection being made, until the cache record expires.
27698
27699 .vitem &*use_postmaster*&
27700 .cindex "callout" "sender for recipient check"
27701 This parameter applies to recipient callouts only. For example:
27702 .code
27703 deny  !verify = recipient/callout=use_postmaster
27704 .endd
27705 .vindex "&$qualify_domain$&"
27706 It causes a non-empty postmaster address to be used in the MAIL command when
27707 performing the callout for the recipient, and also for a &"random"& check if
27708 that is configured. The local part of the address is &`postmaster`& and the
27709 domain is the contents of &$qualify_domain$&.
27710
27711 .vitem &*use_sender*&
27712 This option applies to recipient callouts only. For example:
27713 .code
27714 require  verify = recipient/callout=use_sender
27715 .endd
27716 It causes the message's actual sender address to be used in the MAIL
27717 command when performing the callout, instead of an empty address. There is no
27718 need to use this option unless you know that the called hosts make use of the
27719 sender when checking recipients. If used indiscriminately, it reduces the
27720 usefulness of callout caching.
27721 .endlist
27722
27723 If you use any of the parameters that set a non-empty sender for the MAIL
27724 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
27725 &%use_sender%&), you should think about possible loops. Recipient checking is
27726 usually done between two hosts that are under the same management, and the host
27727 that receives the callouts is not normally configured to do callouts itself.
27728 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
27729 these circumstances.
27730
27731 However, if you use a non-empty sender address for a callout to an arbitrary
27732 host, there is the likelihood that the remote host will itself initiate a
27733 callout check back to your host. As it is checking what appears to be a message
27734 sender, it is likely to use an empty address in MAIL, thus avoiding a
27735 callout loop. However, to be on the safe side it would be best to set up your
27736 own ACLs so that they do not do sender verification checks when the recipient
27737 is the address you use for header sender or postmaster callout checking.
27738
27739 Another issue to think about when using non-empty senders for callouts is
27740 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
27741 by the sender/recipient combination; thus, for any given recipient, many more
27742 actual callouts are performed than when an empty sender or postmaster is used.
27743
27744
27745
27746
27747 .section "Callout caching" "SECTcallvercache"
27748 .cindex "hints database" "callout cache"
27749 .cindex "callout" "cache, description of"
27750 .cindex "caching" "callout"
27751 Exim caches the results of callouts in order to reduce the amount of resources
27752 used, unless you specify the &%no_cache%& parameter with the &%callout%&
27753 option. A hints database called &"callout"& is used for the cache. Two
27754 different record types are used: one records the result of a callout check for
27755 a specific address, and the other records information that applies to the
27756 entire domain (for example, that it accepts the local part &'postmaster'&).
27757
27758 When an original callout fails, a detailed SMTP error message is given about
27759 the failure. However, for subsequent failures use the cache data, this message
27760 is not available.
27761
27762 The expiry times for negative and positive address cache records are
27763 independent, and can be set by the global options &%callout_negative_expire%&
27764 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
27765
27766 If a host gives a negative response to an SMTP connection, or rejects any
27767 commands up to and including
27768 .code
27769 MAIL FROM:<>
27770 .endd
27771 (but not including the MAIL command with a non-empty address),
27772 any callout attempt is bound to fail. Exim remembers such failures in a
27773 domain cache record, which it uses to fail callouts for the domain without
27774 making new connections, until the domain record times out. There are two
27775 separate expiry times for domain cache records:
27776 &%callout_domain_negative_expire%& (default 3h) and
27777 &%callout_domain_positive_expire%& (default 7d).
27778
27779 Domain records expire when the negative expiry time is reached if callouts
27780 cannot be made for the domain, or if the postmaster check failed.
27781 Otherwise, they expire when the positive expiry time is reached. This
27782 ensures that, for example, a host that stops accepting &"random"& local parts
27783 will eventually be noticed.
27784
27785 The callout caching mechanism is based on the domain of the address that is
27786 being tested. If the domain routes to several hosts, it is assumed that their
27787 behaviour will be the same.
27788
27789
27790
27791 .section "Sender address verification reporting" "SECTsenaddver"
27792 .cindex "verifying" "suppressing error details"
27793 See section &<<SECTaddressverification>>& for a general discussion of
27794 verification. When sender verification fails in an ACL, the details of the
27795 failure are given as additional output lines before the 550 response to the
27796 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
27797 you might see:
27798 .code
27799 MAIL FROM:<xyz@abc.example>
27800 250 OK
27801 RCPT TO:<pqr@def.example>
27802 550-Verification failed for <xyz@abc.example>
27803 550-Called:   192.168.34.43
27804 550-Sent:     RCPT TO:<xyz@abc.example>
27805 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
27806 550 Sender verification failed
27807 .endd
27808 If more than one RCPT command fails in the same way, the details are given
27809 only for the first of them. However, some administrators do not want to send
27810 out this much information. You can suppress the details by adding
27811 &`/no_details`& to the ACL statement that requests sender verification. For
27812 example:
27813 .code
27814 verify = sender/no_details
27815 .endd
27816
27817 .section "Redirection while verifying" "SECTredirwhilveri"
27818 .cindex "verifying" "redirection while"
27819 .cindex "address redirection" "while verifying"
27820 A dilemma arises when a local address is redirected by aliasing or forwarding
27821 during verification: should the generated addresses themselves be verified,
27822 or should the successful expansion of the original address be enough to verify
27823 it? By default, Exim takes the following pragmatic approach:
27824
27825 .ilist
27826 When an incoming address is redirected to just one child address, verification
27827 continues with the child address, and if that fails to verify, the original
27828 verification also fails.
27829 .next
27830 When an incoming address is redirected to more than one child address,
27831 verification does not continue. A success result is returned.
27832 .endlist
27833
27834 This seems the most reasonable behaviour for the common use of aliasing as a
27835 way of redirecting different local parts to the same mailbox. It means, for
27836 example, that a pair of alias entries of the form
27837 .code
27838 A.Wol:   aw123
27839 aw123:   :fail: Gone away, no forwarding address
27840 .endd
27841 work as expected, with both local parts causing verification failure. When a
27842 redirection generates more than one address, the behaviour is more like a
27843 mailing list, where the existence of the alias itself is sufficient for
27844 verification to succeed.
27845
27846 It is possible, however, to change the default behaviour so that all successful
27847 redirections count as successful verifications, however many new addresses are
27848 generated. This is specified by the &%success_on_redirect%& verification
27849 option. For example:
27850 .code
27851 require verify = recipient/success_on_redirect/callout=10s
27852 .endd
27853 In this example, verification succeeds if a router generates a new address, and
27854 the callout does not occur, because no address was routed to a remote host.
27855
27856 When verification is being tested via the &%-bv%& option, the treatment of
27857 redirections is as just described, unless the &%-v%& or any debugging option is
27858 also specified. In that case, full verification is done for every generated
27859 address and a report is output for each of them.
27860
27861
27862
27863 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
27864 .cindex "CSA" "verifying"
27865 Client SMTP Authorization is a system that allows a site to advertise
27866 which machines are and are not permitted to send email. This is done by placing
27867 special SRV records in the DNS; these are looked up using the client's HELO
27868 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
27869 Authorization checks in Exim are performed by the ACL condition:
27870 .code
27871 verify = csa
27872 .endd
27873 This fails if the client is not authorized. If there is a DNS problem, or if no
27874 valid CSA SRV record is found, or if the client is authorized, the condition
27875 succeeds. These three cases can be distinguished using the expansion variable
27876 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
27877 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
27878 be likely to cause problems for legitimate email.
27879
27880 The error messages produced by the CSA code include slightly more
27881 detail. If &$csa_status$& is &"defer"&, this may be because of problems
27882 looking up the CSA SRV record, or problems looking up the CSA target
27883 address record. There are four reasons for &$csa_status$& being &"fail"&:
27884
27885 .ilist
27886 The client's host name is explicitly not authorized.
27887 .next
27888 The client's IP address does not match any of the CSA target IP addresses.
27889 .next
27890 The client's host name is authorized but it has no valid target IP addresses
27891 (for example, the target's addresses are IPv6 and the client is using IPv4).
27892 .next
27893 The client's host name has no CSA SRV record but a parent domain has asserted
27894 that all subdomains must be explicitly authorized.
27895 .endlist
27896
27897 The &%csa%& verification condition can take an argument which is the domain to
27898 use for the DNS query. The default is:
27899 .code
27900 verify = csa/$sender_helo_name
27901 .endd
27902 This implementation includes an extension to CSA. If the query domain
27903 is an address literal such as [192.0.2.95], or if it is a bare IP
27904 address, Exim searches for CSA SRV records in the reverse DNS as if
27905 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
27906 meaningful to say:
27907 .code
27908 verify = csa/$sender_host_address
27909 .endd
27910 In fact, this is the check that Exim performs if the client does not say HELO.
27911 This extension can be turned off by setting the main configuration option
27912 &%dns_csa_use_reverse%& to be false.
27913
27914 If a CSA SRV record is not found for the domain itself, a search
27915 is performed through its parent domains for a record which might be
27916 making assertions about subdomains. The maximum depth of this search is limited
27917 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
27918 default. Exim does not look for CSA SRV records in a top level domain, so the
27919 default settings handle HELO domains as long as seven
27920 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
27921 of legitimate HELO domains.
27922
27923 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
27924 direct SRV lookups, this is not sufficient because of the extra parent domain
27925 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
27926 addresses into lookups in the reverse DNS space. The result of a successful
27927 lookup such as:
27928 .code
27929 ${lookup dnsdb {csa=$sender_helo_name}}
27930 .endd
27931 has two space-separated fields: an authorization code and a target host name.
27932 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
27933 authorization required but absent, or &"?"& for unknown.
27934
27935
27936
27937
27938 .section "Bounce address tag validation" "SECTverifyPRVS"
27939 .cindex "BATV, verifying"
27940 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
27941 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
27942 Genuine incoming bounce messages should therefore always be addressed to
27943 recipients that have a valid tag. This scheme is a way of detecting unwanted
27944 bounce messages caused by sender address forgeries (often called &"collateral
27945 spam"&), because the recipients of such messages do not include valid tags.
27946
27947 There are two expansion items to help with the implementation of the BATV
27948 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
27949 the original envelope sender address by using a simple key to add a hash of the
27950 address and some time-based randomizing information. The &%prvs%& expansion
27951 item creates a signed address, and the &%prvscheck%& expansion item checks one.
27952 The syntax of these expansion items is described in section
27953 &<<SECTexpansionitems>>&.
27954
27955 As an example, suppose the secret per-address keys are stored in an MySQL
27956 database. A query to look up the key for an address could be defined as a macro
27957 like this:
27958 .code
27959 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
27960                 WHERE sender='${quote_mysql:$prvscheck_address}'\
27961                 }{$value}}
27962 .endd
27963 Suppose also that the senders who make use of BATV are defined by an address
27964 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
27965 use this:
27966 .code
27967 # Bounces: drop unsigned addresses for BATV senders
27968 deny message = This address does not send an unsigned reverse path
27969      senders = :
27970      recipients = +batv_senders
27971
27972 # Bounces: In case of prvs-signed address, check signature.
27973 deny message = Invalid reverse path signature.
27974      senders = :
27975      condition  = ${prvscheck {$local_part@$domain}\
27976                   {PRVSCHECK_SQL}{1}}
27977      !condition = $prvscheck_result
27978 .endd
27979 The first statement rejects recipients for bounce messages that are addressed
27980 to plain BATV sender addresses, because it is known that BATV senders do not
27981 send out messages with plain sender addresses. The second statement rejects
27982 recipients that are prvs-signed, but with invalid signatures (either because
27983 the key is wrong, or the signature has timed out).
27984
27985 A non-prvs-signed address is not rejected by the second statement, because the
27986 &%prvscheck%& expansion yields an empty string if its first argument is not a
27987 prvs-signed address, thus causing the &%condition%& condition to be false. If
27988 the first argument is a syntactically valid prvs-signed address, the yield is
27989 the third string (in this case &"1"&), whether or not the cryptographic and
27990 timeout checks succeed. The &$prvscheck_result$& variable contains the result
27991 of the checks (empty for failure, &"1"& for success).
27992
27993 There is one more issue you must consider when implementing prvs-signing:
27994 you have to ensure that the routers accept prvs-signed addresses and
27995 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
27996 router to remove the signature with a configuration along these lines:
27997 .code
27998 batv_redirect:
27999   driver = redirect
28000   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
28001 .endd
28002 This works because, if the third argument of &%prvscheck%& is empty, the result
28003 of the expansion of a prvs-signed address is the decoded value of the original
28004 address. This router should probably be the first of your routers that handles
28005 local addresses.
28006
28007 To create BATV-signed addresses in the first place, a transport of this form
28008 can be used:
28009 .code
28010 external_smtp_batv:
28011   driver = smtp
28012   return_path = ${prvs {$return_path} \
28013                        {${lookup mysql{SELECT \
28014                        secret FROM batv_prvs WHERE \
28015                        sender='${quote_mysql:$sender_address}'} \
28016                        {$value}fail}}}
28017 .endd
28018 If no key can be found for the existing return path, no signing takes place.
28019
28020
28021
28022 .section "Using an ACL to control relaying" "SECTrelaycontrol"
28023 .cindex "&ACL;" "relay control"
28024 .cindex "relaying" "control by ACL"
28025 .cindex "policy control" "relay control"
28026 An MTA is said to &'relay'& a message if it receives it from some host and
28027 delivers it directly to another host as a result of a remote address contained
28028 within it. Redirecting a local address via an alias or forward file and then
28029 passing the message on to another host is not relaying,
28030 .cindex "&""percent hack""&"
28031 but a redirection as a result of the &"percent hack"& is.
28032
28033 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
28034 A host which is acting as a gateway or an MX backup is concerned with incoming
28035 relaying from arbitrary hosts to a specific set of domains. On the other hand,
28036 a host which is acting as a smart host for a number of clients is concerned
28037 with outgoing relaying from those clients to the Internet at large. Often the
28038 same host is fulfilling both functions,
28039 . ///
28040 . as illustrated in the diagram below,
28041 . ///
28042 but in principle these two kinds of relaying are entirely independent. What is
28043 not wanted is the transmission of mail from arbitrary remote hosts through your
28044 system to arbitrary domains.
28045
28046
28047 You can implement relay control by means of suitable statements in the ACL that
28048 runs for each RCPT command. For convenience, it is often easiest to use
28049 Exim's named list facility to define the domains and hosts involved. For
28050 example, suppose you want to do the following:
28051
28052 .ilist
28053 Deliver a number of domains to mailboxes on the local host (or process them
28054 locally in some other way). Let's say these are &'my.dom1.example'& and
28055 &'my.dom2.example'&.
28056 .next
28057 Relay mail for a number of other domains for which you are the secondary MX.
28058 These might be &'friend1.example'& and &'friend2.example'&.
28059 .next
28060 Relay mail from the hosts on your local LAN, to whatever domains are involved.
28061 Suppose your LAN is 192.168.45.0/24.
28062 .endlist
28063
28064
28065 In the main part of the configuration, you put the following definitions:
28066 .code
28067 domainlist local_domains = my.dom1.example : my.dom2.example
28068 domainlist relay_domains = friend1.example : friend2.example
28069 hostlist   relay_hosts   = 192.168.45.0/24
28070 .endd
28071 Now you can use these definitions in the ACL that is run for every RCPT
28072 command:
28073 .code
28074 acl_check_rcpt:
28075   accept domains = +local_domains : +relay_domains
28076   accept hosts   = +relay_hosts
28077 .endd
28078 The first statement accepts any RCPT command that contains an address in
28079 the local or relay domains. For any other domain, control passes to the second
28080 statement, which accepts the command only if it comes from one of the relay
28081 hosts. In practice, you will probably want to make your ACL more sophisticated
28082 than this, for example, by including sender and recipient verification. The
28083 default configuration includes a more comprehensive example, which is described
28084 in chapter &<<CHAPdefconfil>>&.
28085
28086
28087
28088 .section "Checking a relay configuration" "SECTcheralcon"
28089 .cindex "relaying" "checking control of"
28090 You can check the relay characteristics of your configuration in the same way
28091 that you can test any ACL behaviour for an incoming SMTP connection, by using
28092 the &%-bh%& option to run a fake SMTP session with which you interact.
28093
28094 For specifically testing for unwanted relaying, the host
28095 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
28096 host from the host on which Exim is running, using the normal telnet port, you
28097 will see a normal telnet connection message and then quite a long delay. Be
28098 patient. The remote host is making an SMTP connection back to your host, and
28099 trying a number of common probes to test for open relay vulnerability. The
28100 results of the tests will eventually appear on your terminal.
28101 .ecindex IIDacl
28102
28103
28104
28105 . ////////////////////////////////////////////////////////////////////////////
28106 . ////////////////////////////////////////////////////////////////////////////
28107
28108 .chapter "Content scanning at ACL time" "CHAPexiscan"
28109 .scindex IIDcosca "content scanning" "at ACL time"
28110 The extension of Exim to include content scanning at ACL time, formerly known
28111 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
28112 was integrated into the main source for Exim release 4.50, and Tom continues to
28113 maintain it. Most of the wording of this chapter is taken from Tom's
28114 specification.
28115
28116 It is also possible to scan the content of messages at other times. The
28117 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
28118 scanning after all the ACLs have run. A transport filter can be used to scan
28119 messages at delivery time (see the &%transport_filter%& option, described in
28120 chapter &<<CHAPtransportgeneric>>&).
28121
28122 If you want to include the ACL-time content-scanning features when you compile
28123 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
28124 &_Local/Makefile_&. When you do that, the Exim binary is built with:
28125
28126 .ilist
28127 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
28128 for all MIME parts for SMTP and non-SMTP messages, respectively.
28129 .next
28130 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
28131 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
28132 run at the end of message reception (the &%acl_smtp_data%& ACL).
28133 .next
28134 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
28135 of messages, or parts of messages, for debugging purposes.
28136 .next
28137 Additional expansion variables that are set in the new ACL and by the new
28138 conditions.
28139 .next
28140 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
28141 .endlist
28142
28143 There is another content-scanning configuration option for &_Local/Makefile_&,
28144 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
28145 condition is compiled, in addition to all the other content-scanning features.
28146
28147 Content-scanning is continually evolving, and new features are still being
28148 added. While such features are still unstable and liable to incompatible
28149 changes, they are made available in Exim by setting options whose names begin
28150 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
28151 this manual. You can find out about them by reading the file called
28152 &_doc/experimental.txt_&.
28153
28154 All the content-scanning facilities work on a MBOX copy of the message that is
28155 temporarily created in a file called:
28156 .display
28157 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
28158 .endd
28159 The &_.eml_& extension is a friendly hint to virus scanners that they can
28160 expect an MBOX-like structure inside that file. The file is created when the
28161 first content scanning facility is called. Subsequent calls to content
28162 scanning conditions open the same file again. The directory is recursively
28163 removed when the &%acl_smtp_data%& ACL has finished running, unless
28164 .code
28165 control = no_mbox_unspool
28166 .endd
28167 has been encountered. When the MIME ACL decodes files, they are put into the
28168 same directory by default.
28169
28170
28171
28172 .section "Scanning for viruses" "SECTscanvirus"
28173 .cindex "virus scanning"
28174 .cindex "content scanning" "for viruses"
28175 .cindex "content scanning" "the &%malware%& condition"
28176 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
28177 It supports a &"generic"& interface to scanners called via the shell, and
28178 specialized interfaces for &"daemon"& type virus scanners, which are resident
28179 in memory and thus are much faster.
28180
28181 .new
28182 .oindex "&%av_scanner%&"
28183 You can set the &%av_scanner%& option in first part of the Exim configuration
28184 file to specify which scanner to use, together with any additional options that
28185 are needed. The basic syntax is as follows:
28186 .display
28187 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
28188 .endd
28189 If you do not set &%av_scanner%&, it defaults to
28190 .code
28191 av_scanner = sophie:/var/run/sophie
28192 .endd
28193 If the value of &%av_scanner%& starts with a dollar character, it is expanded
28194 before use. The following scanner types are supported in this release:
28195 .wen
28196 .vlist
28197 .vitem &%aveserver%&
28198 .cindex "virus scanners" "Kaspersky"
28199 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
28200 at &url(http://www.kaspersky.com). This scanner type takes one option,
28201 which is the path to the daemon's UNIX socket. The default is shown in this
28202 example:
28203 .code
28204 av_scanner = aveserver:/var/run/aveserver
28205 .endd
28206
28207 .new
28208 .vitem &%clamd%&
28209 .cindex "virus scanners" "clamd"
28210 This daemon-type scanner is GPL and free. You can get it at
28211 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
28212 unpack MIME containers, so it used to be recommended to unpack MIME attachments
28213 in the MIME ACL. This no longer believed to be necessary. One option is
28214 required: either the path and name of a UNIX socket file, or a hostname or IP
28215 number, and a port, separated by space, as in the second of these examples:
28216 .code
28217 av_scanner = clamd:/opt/clamd/socket
28218 av_scanner = clamd:192.0.2.3 1234
28219 av_scanner = clamd:192.0.2.3 1234:local
28220 .endd
28221 If the value of av_scanner points to a UNIX socket file or contains the local
28222 keyword, then the ClamAV interface will pass a filename containing the data
28223 to be scanned, which will should normally result in less I/O happening and be
28224 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
28225 Exim does not assume that there is a common filesystem with the remote host.
28226 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
28227 you be running a version of ClamAV prior to 0.95.
28228 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
28229 contributing the code for this scanner.
28230 .wen
28231 .vitem &%cmdline%&
28232 .cindex "virus scanners" "command line interface"
28233 This is the keyword for the generic command line scanner interface. It can be
28234 used to attach virus scanners that are invoked from the shell. This scanner
28235 type takes 3 mandatory options:
28236
28237 .olist
28238 The full path and name of the scanner binary, with all command line options,
28239 and a placeholder (&`%s`&) for the directory to scan.
28240
28241 .next
28242 A regular expression to match against the STDOUT and STDERR output of the
28243 virus scanner. If the expression matches, a virus was found. You must make
28244 absolutely sure that this expression matches on &"virus found"&. This is called
28245 the &"trigger"& expression.
28246
28247 .next
28248 Another regular expression, containing exactly one pair of parentheses, to
28249 match the name of the virus found in the scanners output. This is called the
28250 &"name"& expression.
28251 .endlist olist
28252
28253 For example, Sophos Sweep reports a virus on a line like this:
28254 .code
28255 Virus 'W32/Magistr-B' found in file ./those.bat
28256 .endd
28257 For the trigger expression, we can match the phrase &"found in file"&. For the
28258 name expression, we want to extract the W32/Magistr-B string, so we can match
28259 for the single quotes left and right of it. Altogether, this makes the
28260 configuration setting:
28261 .code
28262 av_scanner = cmdline:\
28263              /path/to/sweep -ss -all -rec -archive %s:\
28264              found in file:'(.+)'
28265 .endd
28266 .vitem &%drweb%&
28267 .cindex "virus scanners" "DrWeb"
28268 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
28269 argument, either a full path to a UNIX socket, or an IP address and port
28270 separated by white space, as in these examples:
28271 .code
28272 av_scanner = drweb:/var/run/drwebd.sock
28273 av_scanner = drweb:192.168.2.20 31337
28274 .endd
28275 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
28276 is used. Thanks to Alex Miller for contributing the code for this scanner.
28277
28278 .vitem &%fsecure%&
28279 .cindex "virus scanners" "F-Secure"
28280 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
28281 argument which is the path to a UNIX socket. For example:
28282 .code
28283 av_scanner = fsecure:/path/to/.fsav
28284 .endd
28285 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
28286 Thelmen for contributing the code for this scanner.
28287
28288 .vitem &%kavdaemon%&
28289 .cindex "virus scanners" "Kaspersky"
28290 This is the scanner daemon of Kaspersky Version 4. This version of the
28291 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
28292 scanner type takes one option, which is the path to the daemon's UNIX socket.
28293 For example:
28294 .code
28295 av_scanner = kavdaemon:/opt/AVP/AvpCtl
28296 .endd
28297 The default path is &_/var/run/AvpCtl_&.
28298
28299 .vitem &%mksd%&
28300 .cindex "virus scanners" "mksd"
28301 This is a daemon type scanner that is aimed mainly at Polish users, though some
28302 parts of documentation are now available in English. You can get it at
28303 &url(http://linux.mks.com.pl/). The only option for this scanner type is
28304 the maximum number of processes used simultaneously to scan the attachments,
28305 provided that the demime facility is employed and also provided that mksd has
28306 been run with at least the same number of child processes. For example:
28307 .code
28308 av_scanner = mksd:2
28309 .endd
28310 You can safely omit this option (the default value is 1).
28311
28312 .vitem &%sophie%&
28313 .cindex "virus scanners" "Sophos and Sophie"
28314 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
28315 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
28316 for this scanner type is the path to the UNIX socket that Sophie uses for
28317 client communication. For example:
28318 .code
28319 av_scanner = sophie:/tmp/sophie
28320 .endd
28321 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
28322 the option.
28323 .endlist
28324
28325 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
28326 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
28327 ACL.
28328
28329 The &%av_scanner%& option is expanded each time &%malware%& is called. This
28330 makes it possible to use different scanners. See further below for an example.
28331 The &%malware%& condition caches its results, so when you use it multiple times
28332 for the same message, the actual scanning process is only carried out once.
28333 However, using expandable items in &%av_scanner%& disables this caching, in
28334 which case each use of the &%malware%& condition causes a new scan of the
28335 message.
28336
28337 The &%malware%& condition takes a right-hand argument that is expanded before
28338 use. It can then be one of
28339
28340 .ilist
28341 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
28342 The condition succeeds if a virus was found, and fail otherwise. This is the
28343 recommended usage.
28344 .next
28345 &"false"& or &"0"& or an empty string, in which case no scanning is done and
28346 the condition fails immediately.
28347 .next
28348 A regular expression, in which case the message is scanned for viruses. The
28349 condition succeeds if a virus is found and its name matches the regular
28350 expression. This allows you to take special actions on certain types of virus.
28351 .endlist
28352
28353 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
28354 even if there is a problem with the virus scanner. Otherwise, such a problem
28355 causes the ACL to defer.
28356
28357 .vindex "&$malware_name$&"
28358 When a virus is found, the condition sets up an expansion variable called
28359 &$malware_name$& that contains the name of the virus. You can use it in a
28360 &%message%& modifier that specifies the error returned to the sender, and/or in
28361 logging data.
28362
28363 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
28364 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
28365 &%malware%& condition.
28366
28367 .new
28368 Beware the interaction of Exim's &%message_size_limit%& with any size limits
28369 imposed by your anti-virus scanner.
28370 .wen
28371
28372 Here is a very simple scanning example:
28373 .code
28374 deny message = This message contains malware ($malware_name)
28375      demime = *
28376      malware = *
28377 .endd
28378 The next example accepts messages when there is a problem with the scanner:
28379 .code
28380 deny message = This message contains malware ($malware_name)
28381      demime = *
28382      malware = */defer_ok
28383 .endd
28384 The next example shows how to use an ACL variable to scan with both sophie and
28385 aveserver. It assumes you have set:
28386 .code
28387 av_scanner = $acl_m0
28388 .endd
28389 in the main Exim configuration.
28390 .code
28391 deny message = This message contains malware ($malware_name)
28392      set acl_m0 = sophie
28393      malware = *
28394
28395 deny message = This message contains malware ($malware_name)
28396      set acl_m0 = aveserver
28397      malware = *
28398 .endd
28399
28400
28401 .section "Scanning with SpamAssassin" "SECTscanspamass"
28402 .cindex "content scanning" "for spam"
28403 .cindex "spam scanning"
28404 .cindex "SpamAssassin"
28405 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
28406 score and a report for the message. You can get SpamAssassin at
28407 &url(http://www.spamassassin.org), or, if you have a working Perl
28408 installation, you can use CPAN by running:
28409 .code
28410 perl -MCPAN -e 'install Mail::SpamAssassin'
28411 .endd
28412 SpamAssassin has its own set of configuration files. Please review its
28413 documentation to see how you can tweak it. The default installation should work
28414 nicely, however.
28415
28416 .oindex "&%spamd_address%&"
28417 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
28418 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
28419 port for &%spamd%&, you must set the &%spamd_address%& option in the global
28420 part of the Exim configuration as follows (example):
28421 .code
28422 spamd_address = 192.168.99.45 387
28423 .endd
28424 You do not need to set this option if you use the default. As of version 2.60,
28425 &%spamd%& also supports communication over UNIX sockets. If you want to use
28426 these, supply &%spamd_address%& with an absolute file name instead of a
28427 address/port pair:
28428 .code
28429 spamd_address = /var/run/spamd_socket
28430 .endd
28431 You can have multiple &%spamd%& servers to improve scalability. These can
28432 reside on other hardware reachable over the network. To specify multiple
28433 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
28434 option, separated with colons:
28435 .code
28436 spamd_address = 192.168.2.10 783 : \
28437                 192.168.2.11 783 : \
28438                 192.168.2.12 783
28439 .endd
28440 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
28441 fashion. When a server fails to respond to the connection attempt, all other
28442 servers are tried until one succeeds. If no server responds, the &%spam%&
28443 condition defers.
28444
28445 &*Warning*&: It is not possible to use the UNIX socket connection method with
28446 multiple &%spamd%& servers.
28447
28448 The &%spamd_address%& variable is expanded before use if it starts with
28449 a dollar sign. In this case, the expansion may return a string that is
28450 used as the list so that multiple spamd servers can be the result of an
28451 expansion.
28452
28453 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
28454 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
28455 .code
28456 deny message = This message was classified as SPAM
28457      spam = joe
28458 .endd
28459 The right-hand side of the &%spam%& condition specifies a name. This is
28460 relevant if you have set up multiple SpamAssassin profiles. If you do not want
28461 to scan using a specific profile, but rather use the SpamAssassin system-wide
28462 default profile, you can scan for an unknown name, or simply use &"nobody"&.
28463 However, you must put something on the right-hand side.
28464
28465 The name allows you to use per-domain or per-user antispam profiles in
28466 principle, but this is not straightforward in practice, because a message may
28467 have multiple recipients, not necessarily all in the same domain. Because the
28468 &%spam%& condition has to be called from a DATA ACL in order to be able to
28469 read the contents of the message, the variables &$local_part$& and &$domain$&
28470 are not set.
28471
28472 The right-hand side of the &%spam%& condition is expanded before being used, so
28473 you can put lookups or conditions there. When the right-hand side evaluates to
28474 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
28475
28476
28477 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
28478 large ones may cause significant performance degradation. As most spam messages
28479 are quite small, it is recommended that you do not scan the big ones. For
28480 example:
28481 .code
28482 deny message = This message was classified as SPAM
28483      condition = ${if < {$message_size}{10K}}
28484      spam = nobody
28485 .endd
28486
28487 The &%spam%& condition returns true if the threshold specified in the user's
28488 SpamAssassin profile has been matched or exceeded. If you want to use the
28489 &%spam%& condition for its side effects (see the variables below), you can make
28490 it always return &"true"& by appending &`:true`& to the username.
28491
28492 .new
28493 .cindex "spam scanning" "returned variables"
28494 When the &%spam%& condition is run, it sets up a number of expansion
28495 variables. These variables are saved with the received message, thus they are
28496 available for use at delivery time.
28497 .wen
28498
28499 .vlist
28500 .vitem &$spam_score$&
28501 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
28502 for inclusion in log or reject messages.
28503
28504 .new
28505 .vitem &$spam_score_int$&
28506 The spam score of the message, multiplied by ten, as an integer value. For
28507 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
28508 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
28509 The integer value is useful for numeric comparisons in conditions.
28510 .wen
28511
28512 .vitem &$spam_bar$&
28513 A string consisting of a number of &"+"& or &"-"& characters, representing the
28514 integer part of the spam score value. A spam score of 4.4 would have a
28515 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
28516 headers, since MUAs can match on such strings.
28517
28518 .vitem &$spam_report$&
28519 A multiline text table, containing the full SpamAssassin report for the
28520 message. Useful for inclusion in headers or reject messages.
28521 .endlist
28522
28523 The &%spam%& condition caches its results unless expansion in
28524 spamd_address was used. If you call it again with the same user name, it
28525 does not scan again, but rather returns the same values as before.
28526
28527 The &%spam%& condition returns DEFER if there is any error while running
28528 the message through SpamAssassin or if the expansion of spamd_address
28529 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
28530 statement block), append &`/defer_ok`& to the right-hand side of the
28531 spam condition, like this:
28532 .code
28533 deny message = This message was classified as SPAM
28534      spam    = joe/defer_ok
28535 .endd
28536 This causes messages to be accepted even if there is a problem with &%spamd%&.
28537
28538 Here is a longer, commented example of the use of the &%spam%&
28539 condition:
28540 .code
28541 # put headers in all messages (no matter if spam or not)
28542 warn  spam = nobody:true
28543       add_header = X-Spam-Score: $spam_score ($spam_bar)
28544       add_header = X-Spam-Report: $spam_report
28545
28546 # add second subject line with *SPAM* marker when message
28547 # is over threshold
28548 warn  spam = nobody
28549       add_header = Subject: *SPAM* $h_Subject:
28550
28551 # reject spam at high scores (> 12)
28552 deny  message = This message scored $spam_score spam points.
28553       spam = nobody:true
28554       condition = ${if >{$spam_score_int}{120}{1}{0}}
28555 .endd
28556
28557
28558
28559 .section "Scanning MIME parts" "SECTscanmimepart"
28560 .cindex "content scanning" "MIME parts"
28561 .cindex "MIME content scanning"
28562 .oindex "&%acl_smtp_mime%&"
28563 .oindex "&%acl_not_smtp_mime%&"
28564 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
28565 each MIME part of an SMTP message, including multipart types, in the sequence
28566 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
28567 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
28568 options may both refer to the same ACL if you want the same processing in both
28569 cases.
28570
28571 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
28572 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
28573 the case of a non-SMTP message. However, a MIME ACL is called only if the
28574 message contains a &'Content-Type:'& header line. When a call to a MIME
28575 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
28576 result code is sent to the client. In the case of an SMTP message, the
28577 &%acl_smtp_data%& ACL is not called when this happens.
28578
28579 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
28580 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
28581 condition to match against the raw MIME part. You can also use the
28582 &%mime_regex%& condition to match against the decoded MIME part (see section
28583 &<<SECTscanregex>>&).
28584
28585 At the start of a MIME ACL, a number of variables are set from the header
28586 information for the relevant MIME part. These are described below. The contents
28587 of the MIME part are not by default decoded into a disk file except for MIME
28588 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
28589 part into a disk file, you can use the &%decode%& condition. The general
28590 syntax is:
28591 .display
28592 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
28593 .endd
28594 The right hand side is expanded before use. After expansion,
28595 the value can be:
28596
28597 .olist
28598 &"0"& or &"false"&, in which case no decoding is done.
28599 .next
28600 The string &"default"&. In that case, the file is put in the temporary
28601 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
28602 a sequential file name consisting of the message id and a sequence number. The
28603 full path and name is available in &$mime_decoded_filename$& after decoding.
28604 .next
28605 A full path name starting with a slash. If the full name is an existing
28606 directory, it is used as a replacement for the default directory. The filename
28607 is then sequentially assigned. If the path does not exist, it is used as
28608 the full path and file name.
28609 .next
28610 If the string does not start with a slash, it is used as the
28611 filename, and the default path is then used.
28612 .endlist
28613 The &%decode%& condition normally succeeds. It is only false for syntax
28614 errors or unusual circumstances such as memory shortages. You can easily decode
28615 a file with its original, proposed filename using
28616 .code
28617 decode = $mime_filename
28618 .endd
28619 However, you should keep in mind that &$mime_filename$& might contain
28620 anything. If you place files outside of the default path, they are not
28621 automatically unlinked.
28622
28623 For RFC822 attachments (these are messages attached to messages, with a
28624 content-type of &"message/rfc822"&), the ACL is called again in the same manner
28625 as for the primary message, only that the &$mime_is_rfc822$& expansion
28626 variable is set (see below). Attached messages are always decoded to disk
28627 before being checked, and the files are unlinked once the check is done.
28628
28629 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
28630 used to match regular expressions against raw and decoded MIME parts,
28631 respectively. They are described in section &<<SECTscanregex>>&.
28632
28633 .cindex "MIME content scanning" "returned variables"
28634 The following list describes all expansion variables that are
28635 available in the MIME ACL:
28636
28637 .vlist
28638 .vitem &$mime_boundary$&
28639 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
28640 have a boundary string, which is stored in this variable. If the current part
28641 has no boundary parameter in the &'Content-Type:'& header, this variable
28642 contains the empty string.
28643
28644 .vitem &$mime_charset$&
28645 This variable contains the character set identifier, if one was found in the
28646 &'Content-Type:'& header. Examples for charset identifiers are:
28647 .code
28648 us-ascii
28649 gb2312 (Chinese)
28650 iso-8859-1
28651 .endd
28652 Please note that this value is not normalized, so you should do matches
28653 case-insensitively.
28654
28655 .vitem &$mime_content_description$&
28656 This variable contains the normalized content of the &'Content-Description:'&
28657 header. It can contain a human-readable description of the parts content. Some
28658 implementations repeat the filename for attachments here, but they are usually
28659 only used for display purposes.
28660
28661 .vitem &$mime_content_disposition$&
28662 This variable contains the normalized content of the &'Content-Disposition:'&
28663 header. You can expect strings like &"attachment"& or &"inline"& here.
28664
28665 .vitem &$mime_content_id$&
28666 This variable contains the normalized content of the &'Content-ID:'& header.
28667 This is a unique ID that can be used to reference a part from another part.
28668
28669 .vitem &$mime_content_size$&
28670 This variable is set only after the &%decode%& modifier (see above) has been
28671 successfully run. It contains the size of the decoded part in kilobytes. The
28672 size is always rounded up to full kilobytes, so only a completely empty part
28673 has a &$mime_content_size$& of zero.
28674
28675 .vitem &$mime_content_transfer_encoding$&
28676 This variable contains the normalized content of the
28677 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
28678 type. Typical values are &"base64"& and &"quoted-printable"&.
28679
28680 .vitem &$mime_content_type$&
28681 If the MIME part has a &'Content-Type:'& header, this variable contains its
28682 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
28683 are some examples of popular MIME types, as they may appear in this variable:
28684 .code
28685 text/plain
28686 text/html
28687 application/octet-stream
28688 image/jpeg
28689 audio/midi
28690 .endd
28691 If the MIME part has no &'Content-Type:'& header, this variable contains the
28692 empty string.
28693
28694 .vitem &$mime_decoded_filename$&
28695 This variable is set only after the &%decode%& modifier (see above) has been
28696 successfully run. It contains the full path and file name of the file
28697 containing the decoded data.
28698 .endlist
28699
28700 .cindex "RFC 2047"
28701 .vlist
28702 .vitem &$mime_filename$&
28703 This is perhaps the most important of the MIME variables. It contains a
28704 proposed filename for an attachment, if one was found in either the
28705 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
28706 RFC2047 decoded, but no additional sanity checks are done. If no filename was
28707 found, this variable contains the empty string.
28708
28709 .vitem &$mime_is_coverletter$&
28710 This variable attempts to differentiate the &"cover letter"& of an e-mail from
28711 attached data. It can be used to clamp down on flashy or unnecessarily encoded
28712 content in the cover letter, while not restricting attachments at all.
28713
28714 The variable contains 1 (true) for a MIME part believed to be part of the
28715 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
28716 follows:
28717
28718 .olist
28719 The outermost MIME part of a message is always a cover letter.
28720
28721 .next
28722 If a multipart/alternative or multipart/related MIME part is a cover letter,
28723 so are all MIME subparts within that multipart.
28724
28725 .next
28726 If any other multipart is a cover letter, the first subpart is a cover letter,
28727 and the rest are attachments.
28728
28729 .next
28730 All parts contained within an attachment multipart are attachments.
28731 .endlist olist
28732
28733 As an example, the following will ban &"HTML mail"& (including that sent with
28734 alternative plain text), while allowing HTML files to be attached. HTML
28735 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
28736 .code
28737 deny message = HTML mail is not accepted here
28738 !condition = $mime_is_rfc822
28739 condition = $mime_is_coverletter
28740 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
28741 .endd
28742 .vitem &$mime_is_multipart$&
28743 This variable has the value 1 (true) when the current part has the main type
28744 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
28745 Since multipart entities only serve as containers for other parts, you may not
28746 want to carry out specific actions on them.
28747
28748 .vitem &$mime_is_rfc822$&
28749 This variable has the value 1 (true) if the current part is not a part of the
28750 checked message itself, but part of an attached message. Attached message
28751 decoding is fully recursive.
28752
28753 .vitem &$mime_part_count$&
28754 This variable is a counter that is raised for each processed MIME part. It
28755 starts at zero for the very first part (which is usually a multipart). The
28756 counter is per-message, so it is reset when processing RFC822 attachments (see
28757 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
28758 complete, so you can use it in the DATA ACL to determine the number of MIME
28759 parts of a message. For non-MIME messages, this variable contains the value -1.
28760 .endlist
28761
28762
28763
28764 .section "Scanning with regular expressions" "SECTscanregex"
28765 .cindex "content scanning" "with regular expressions"
28766 .cindex "regular expressions" "content scanning with"
28767 You can specify your own custom regular expression matches on the full body of
28768 the message, or on individual MIME parts.
28769
28770 The &%regex%& condition takes one or more regular expressions as arguments and
28771 matches them against the full message (when called in the DATA ACL) or a raw
28772 MIME part (when called in the MIME ACL). The &%regex%& condition matches
28773 linewise, with a maximum line length of 32K characters. That means you cannot
28774 have multiline matches with the &%regex%& condition.
28775
28776 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
28777 to 32K of decoded content (the whole content at once, not linewise). If the
28778 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
28779 is decoded automatically when &%mime_regex%& is executed (using default path
28780 and filename values). If the decoded data is larger than  32K, only the first
28781 32K characters are checked.
28782
28783 The regular expressions are passed as a colon-separated list. To include a
28784 literal colon, you must double it. Since the whole right-hand side string is
28785 expanded before being used, you must also escape dollar signs and backslashes
28786 with more backslashes, or use the &`\N`& facility to disable expansion.
28787 Here is a simple example that contains two regular expressions:
28788 .code
28789 deny message = contains blacklisted regex ($regex_match_string)
28790      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
28791 .endd
28792 The conditions returns true if any one of the regular expressions matches. The
28793 &$regex_match_string$& expansion variable is then set up and contains the
28794 matching regular expression.
28795
28796 &*Warning*&: With large messages, these conditions can be fairly
28797 CPU-intensive.
28798
28799
28800
28801
28802 .section "The demime condition" "SECTdemimecond"
28803 .cindex "content scanning" "MIME checking"
28804 .cindex "MIME content scanning"
28805 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
28806 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
28807 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
28808 ACL functionality, but provides no additional facilities. Please note that this
28809 condition is deprecated and kept only for backward compatibility. You must set
28810 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
28811 use the &%demime%& condition.
28812
28813 The &%demime%& condition unpacks MIME containers in the message. It detects
28814 errors in MIME containers and can match file extensions found in the message
28815 against a list. Using this facility produces files containing the unpacked MIME
28816 parts of the message in the temporary scan directory. If you do antivirus
28817 scanning, it is recommended that you use the &%demime%& condition before the
28818 antivirus (&%malware%&) condition.
28819
28820 On the right-hand side of the &%demime%& condition you can pass a
28821 colon-separated list of file extensions that it should match against. For
28822 example:
28823 .code
28824 deny message = Found blacklisted file attachment
28825      demime  = vbs:com:bat:pif:prf:lnk
28826 .endd
28827 If one of the file extensions is found, the condition is true, otherwise it is
28828 false. If there is a temporary error while demimeing (for example, &"disk
28829 full"&), the condition defers, and the message is temporarily rejected (unless
28830 the condition is on a &%warn%& verb).
28831
28832 The right-hand side is expanded before being treated as a list, so you can have
28833 conditions and lookups there. If it expands to an empty string, &"false"&, or
28834 zero (&"0"&), no demimeing is done and the condition is false.
28835
28836 The &%demime%& condition set the following variables:
28837
28838 .vlist
28839 .vitem &$demime_errorlevel$&
28840 .vindex "&$demime_errorlevel$&"
28841 When an error is detected in a MIME container, this variable contains the
28842 severity of the error, as an integer number. The higher the value, the more
28843 severe the error (the current maximum value is 3). If this variable is unset or
28844 zero, no error occurred.
28845
28846 .vitem &$demime_reason$&
28847 .vindex "&$demime_reason$&"
28848 When &$demime_errorlevel$& is greater than zero, this variable contains a
28849 human-readable text string describing the MIME error that occurred.
28850 .endlist
28851
28852 .vlist
28853 .vitem &$found_extension$&
28854 .vindex "&$found_extension$&"
28855 When the &%demime%& condition is true, this variable contains the file
28856 extension it found.
28857 .endlist
28858
28859 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
28860 the &%demime%& condition, and are not changed on subsequent calls.
28861
28862 If you do not want to check for file extensions, but rather use the &%demime%&
28863 condition for unpacking or error checking purposes, pass &"*"& as the
28864 right-hand side value. Here is a more elaborate example of how to use this
28865 facility:
28866 .code
28867 # Reject messages with serious MIME container errors
28868 deny  message = Found MIME error ($demime_reason).
28869       demime = *
28870       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
28871
28872 # Reject known virus spreading file extensions.
28873 # Accepting these is pretty much braindead.
28874 deny  message = contains $found_extension file (blacklisted).
28875       demime  = com:vbs:bat:pif:scr
28876
28877 # Freeze .exe and .doc files. Postmaster can
28878 # examine them and eventually thaw them.
28879 deny  log_message = Another $found_extension file.
28880       demime = exe:doc
28881       control = freeze
28882 .endd
28883 .ecindex IIDcosca
28884
28885
28886
28887
28888 . ////////////////////////////////////////////////////////////////////////////
28889 . ////////////////////////////////////////////////////////////////////////////
28890
28891 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
28892          "Local scan function"
28893 .scindex IIDlosca "&[local_scan()]& function" "description of"
28894 .cindex "customizing" "input scan using C function"
28895 .cindex "policy control" "by local scan function"
28896 In these days of email worms, viruses, and ever-increasing spam, some sites
28897 want to apply a lot of checking to messages before accepting them.
28898
28899 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
28900 passing messages to external virus and spam scanning software. You can also do
28901 a certain amount in Exim itself through string expansions and the &%condition%&
28902 condition in the ACL that runs after the SMTP DATA command or the ACL for
28903 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
28904
28905 To allow for further customization to a site's own requirements, there is the
28906 possibility of linking Exim with a private message scanning function, written
28907 in C. If you want to run code that is written in something other than C, you
28908 can of course use a little C stub to call it.
28909
28910 The local scan function is run once for every incoming message, at the point
28911 when Exim is just about to accept the message.
28912 It can therefore be used to control non-SMTP messages from local processes as
28913 well as messages arriving via SMTP.
28914
28915 Exim applies a timeout to calls of the local scan function, and there is an
28916 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
28917 Zero means &"no timeout"&.
28918 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
28919 before calling the local scan function, so that the most common types of crash
28920 are caught. If the timeout is exceeded or one of those signals is caught, the
28921 incoming message is rejected with a temporary error if it is an SMTP message.
28922 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
28923 code. The incident is logged on the main and reject logs.
28924
28925
28926
28927 .section "Building Exim to use a local scan function" "SECID207"
28928 .cindex "&[local_scan()]& function" "building Exim to use"
28929 To make use of the local scan function feature, you must tell Exim where your
28930 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
28931 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
28932 directory, so you might set
28933 .code
28934 LOCAL_SCAN_SOURCE=Local/local_scan.c
28935 .endd
28936 for example. The function must be called &[local_scan()]&. It is called by
28937 Exim after it has received a message, when the success return code is about to
28938 be sent. This is after all the ACLs have been run. The return code from your
28939 function controls whether the message is actually accepted or not. There is a
28940 commented template function (that just accepts the message) in the file
28941 _src/local_scan.c_.
28942
28943 If you want to make use of Exim's run time configuration file to set options
28944 for your &[local_scan()]& function, you must also set
28945 .code
28946 LOCAL_SCAN_HAS_OPTIONS=yes
28947 .endd
28948 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
28949
28950
28951
28952
28953 .section "API for local_scan()" "SECTapiforloc"
28954 .cindex "&[local_scan()]& function" "API description"
28955 You must include this line near the start of your code:
28956 .code
28957 #include "local_scan.h"
28958 .endd
28959 This header file defines a number of variables and other values, and the
28960 prototype for the function itself. Exim is coded to use unsigned char values
28961 almost exclusively, and one of the things this header defines is a shorthand
28962 for &`unsigned char`& called &`uschar`&.
28963 It also contains the following macro definitions, to simplify casting character
28964 strings and pointers to character strings:
28965 .code
28966 #define CS   (char *)
28967 #define CCS  (const char *)
28968 #define CSS  (char **)
28969 #define US   (unsigned char *)
28970 #define CUS  (const unsigned char *)
28971 #define USS  (unsigned char **)
28972 .endd
28973 The function prototype for &[local_scan()]& is:
28974 .code
28975 extern int local_scan(int fd, uschar **return_text);
28976 .endd
28977 The arguments are as follows:
28978
28979 .ilist
28980 &%fd%& is a file descriptor for the file that contains the body of the message
28981 (the -D file). The file is open for reading and writing, but updating it is not
28982 recommended. &*Warning*&: You must &'not'& close this file descriptor.
28983
28984 The descriptor is positioned at character 19 of the file, which is the first
28985 character of the body itself, because the first 19 characters are the message
28986 id followed by &`-D`& and a newline. If you rewind the file, you should use the
28987 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
28988 case this changes in some future version.
28989 .next
28990 &%return_text%& is an address which you can use to return a pointer to a text
28991 string at the end of the function. The value it points to on entry is NULL.
28992 .endlist
28993
28994 The function must return an &%int%& value which is one of the following macros:
28995
28996 .vlist
28997 .vitem &`LOCAL_SCAN_ACCEPT`&
28998 .vindex "&$local_scan_data$&"
28999 The message is accepted. If you pass back a string of text, it is saved with
29000 the message, and made available in the variable &$local_scan_data$&. No
29001 newlines are permitted (if there are any, they are turned into spaces) and the
29002 maximum length of text is 1000 characters.
29003
29004 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
29005 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
29006 queued without immediate delivery, and is frozen.
29007
29008 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
29009 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
29010 queued without immediate delivery.
29011
29012 .vitem &`LOCAL_SCAN_REJECT`&
29013 The message is rejected; the returned text is used as an error message which is
29014 passed back to the sender and which is also logged. Newlines are permitted &--
29015 they cause a multiline response for SMTP rejections, but are converted to
29016 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
29017 used.
29018
29019 .vitem &`LOCAL_SCAN_TEMPREJECT`&
29020 The message is temporarily rejected; the returned text is used as an error
29021 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
29022 problem"& is used.
29023
29024 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
29025 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
29026 message is not written to the reject log. It has the effect of unsetting the
29027 &%rejected_header%& log selector for just this rejection. If
29028 &%rejected_header%& is already unset (see the discussion of the
29029 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
29030 same as LOCAL_SCAN_REJECT.
29031
29032 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
29033 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
29034 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
29035 .endlist
29036
29037 If the message is not being received by interactive SMTP, rejections are
29038 reported by writing to &%stderr%& or by sending an email, as configured by the
29039 &%-oe%& command line options.
29040
29041
29042
29043 .section "Configuration options for local_scan()" "SECTconoptloc"
29044 .cindex "&[local_scan()]& function" "configuration options"
29045 It is possible to have option settings in the main configuration file
29046 that set values in static variables in the &[local_scan()]& module. If you
29047 want to do this, you must have the line
29048 .code
29049 LOCAL_SCAN_HAS_OPTIONS=yes
29050 .endd
29051 in your &_Local/Makefile_& when you build Exim. (This line is in
29052 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
29053 file, you must define static variables to hold the option values, and a table
29054 to define them.
29055
29056 The table must be a vector called &%local_scan_options%&, of type
29057 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
29058 and a pointer to the variable that holds the value. The entries must appear in
29059 alphabetical order. Following &%local_scan_options%& you must also define a
29060 variable called &%local_scan_options_count%& that contains the number of
29061 entries in the table. Here is a short example, showing two kinds of option:
29062 .code
29063 static int my_integer_option = 42;
29064 static uschar *my_string_option = US"a default string";
29065
29066 optionlist local_scan_options[] = {
29067   { "my_integer", opt_int,       &my_integer_option },
29068   { "my_string",  opt_stringptr, &my_string_option }
29069 };
29070
29071 int local_scan_options_count =
29072   sizeof(local_scan_options)/sizeof(optionlist);
29073 .endd
29074 The values of the variables can now be changed from Exim's runtime
29075 configuration file by including a local scan section as in this example:
29076 .code
29077 begin local_scan
29078 my_integer = 99
29079 my_string = some string of text...
29080 .endd
29081 The available types of option data are as follows:
29082
29083 .vlist
29084 .vitem &*opt_bool*&
29085 This specifies a boolean (true/false) option. The address should point to a
29086 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
29087 that are defined as &"1"& and &"0"&, respectively. If you want to detect
29088 whether such a variable has been set at all, you can initialize it to
29089 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
29090 values.)
29091
29092 .vitem &*opt_fixed*&
29093 This specifies a fixed point number, such as is used for load averages.
29094 The address should point to a variable of type &`int`&. The value is stored
29095 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
29096
29097 .vitem &*opt_int*&
29098 This specifies an integer; the address should point to a variable of type
29099 &`int`&. The value may be specified in any of the integer formats accepted by
29100 Exim.
29101
29102 .vitem &*opt_mkint*&
29103 This is the same as &%opt_int%&, except that when such a value is output in a
29104 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
29105 printed with the suffix K or M.
29106
29107 .vitem &*opt_octint*&
29108 This also specifies an integer, but the value is always interpreted as an
29109 octal integer, whether or not it starts with the digit zero, and it is
29110 always output in octal.
29111
29112 .vitem &*opt_stringptr*&
29113 This specifies a string value; the address must be a pointer to a
29114 variable that points to a string (for example, of type &`uschar *`&).
29115
29116 .vitem &*opt_time*&
29117 This specifies a time interval value. The address must point to a variable of
29118 type &`int`&. The value that is placed there is a number of seconds.
29119 .endlist
29120
29121 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
29122 out the values of all the &[local_scan()]& options.
29123
29124
29125
29126 .section "Available Exim variables" "SECID208"
29127 .cindex "&[local_scan()]& function" "available Exim variables"
29128 The header &_local_scan.h_& gives you access to a number of C variables. These
29129 are the only ones that are guaranteed to be maintained from release to release.
29130 Note, however, that you can obtain the value of any Exim expansion variable,
29131 including &$recipients$&, by calling &'expand_string()'&. The exported
29132 C variables are as follows:
29133
29134 .vlist
29135 .vitem &*int&~body_linecount*&
29136 This variable contains the number of lines in the message's body.
29137
29138 .vitem &*int&~body_zerocount*&
29139 This variable contains the number of binary zero bytes in the message's body.
29140
29141 .vitem &*unsigned&~int&~debug_selector*&
29142 This variable is set to zero when no debugging is taking place. Otherwise, it
29143 is a bitmap of debugging selectors. Two bits are identified for use in
29144 &[local_scan()]&; they are defined as macros:
29145
29146 .ilist
29147 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
29148 testing option that is not privileged &-- any caller may set it. All the
29149 other selector bits can be set only by admin users.
29150
29151 .next
29152 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
29153 by the &`+local_scan`& debug selector. It is not included in the default set
29154 of debugging bits.
29155 .endlist ilist
29156
29157 Thus, to write to the debugging output only when &`+local_scan`& has been
29158 selected, you should use code like this:
29159 .code
29160 if ((debug_selector & D_local_scan) != 0)
29161   debug_printf("xxx", ...);
29162 .endd
29163 .vitem &*uschar&~*expand_string_message*&
29164 After a failing call to &'expand_string()'& (returned value NULL), the
29165 variable &%expand_string_message%& contains the error message, zero-terminated.
29166
29167 .vitem &*header_line&~*header_list*&
29168 A pointer to a chain of header lines. The &%header_line%& structure is
29169 discussed below.
29170
29171 .vitem &*header_line&~*header_last*&
29172 A pointer to the last of the header lines.
29173
29174 .vitem &*uschar&~*headers_charset*&
29175 The value of the &%headers_charset%& configuration option.
29176
29177 .vitem &*BOOL&~host_checking*&
29178 This variable is TRUE during a host checking session that is initiated by the
29179 &%-bh%& command line option.
29180
29181 .vitem &*uschar&~*interface_address*&
29182 The IP address of the interface that received the message, as a string. This
29183 is NULL for locally submitted messages.
29184
29185 .vitem &*int&~interface_port*&
29186 The port on which this message was received. When testing with the &%-bh%&
29187 command line option, the value of this variable is -1 unless a port has been
29188 specified via the &%-oMi%& option.
29189
29190 .vitem &*uschar&~*message_id*&
29191 This variable contains Exim's message id for the incoming message (the value of
29192 &$message_exim_id$&) as a zero-terminated string.
29193
29194 .vitem &*uschar&~*received_protocol*&
29195 The name of the protocol by which the message was received.
29196
29197 .vitem &*int&~recipients_count*&
29198 The number of accepted recipients.
29199
29200 .vitem &*recipient_item&~*recipients_list*&
29201 .cindex "recipient" "adding in local scan"
29202 .cindex "recipient" "removing in local scan"
29203 The list of accepted recipients, held in a vector of length
29204 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
29205 can add additional recipients by calling &'receive_add_recipient()'& (see
29206 below). You can delete recipients by removing them from the vector and
29207 adjusting the value in &%recipients_count%&. In particular, by setting
29208 &%recipients_count%& to zero you remove all recipients. If you then return the
29209 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
29210 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
29211 and then call &'receive_add_recipient()'& as often as needed.
29212
29213 .vitem &*uschar&~*sender_address*&
29214 The envelope sender address. For bounce messages this is the empty string.
29215
29216 .vitem &*uschar&~*sender_host_address*&
29217 The IP address of the sending host, as a string. This is NULL for
29218 locally-submitted messages.
29219
29220 .vitem &*uschar&~*sender_host_authenticated*&
29221 The name of the authentication mechanism that was used, or NULL if the message
29222 was not received over an authenticated SMTP connection.
29223
29224 .vitem &*uschar&~*sender_host_name*&
29225 The name of the sending host, if known.
29226
29227 .vitem &*int&~sender_host_port*&
29228 The port on the sending host.
29229
29230 .vitem &*BOOL&~smtp_input*&
29231 This variable is TRUE for all SMTP input, including BSMTP.
29232
29233 .vitem &*BOOL&~smtp_batched_input*&
29234 This variable is TRUE for BSMTP input.
29235
29236 .vitem &*int&~store_pool*&
29237 The contents of this variable control which pool of memory is used for new
29238 requests. See section &<<SECTmemhanloc>>& for details.
29239 .endlist
29240
29241
29242 .section "Structure of header lines" "SECID209"
29243 The &%header_line%& structure contains the members listed below.
29244 You can add additional header lines by calling the &'header_add()'& function
29245 (see below). You can cause header lines to be ignored (deleted) by setting
29246 their type to *.
29247
29248
29249 .vlist
29250 .vitem &*struct&~header_line&~*next*&
29251 A pointer to the next header line, or NULL for the last line.
29252
29253 .vitem &*int&~type*&
29254 A code identifying certain headers that Exim recognizes. The codes are printing
29255 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
29256 Notice in particular that any header line whose type is * is not transmitted
29257 with the message. This flagging is used for header lines that have been
29258 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
29259 lines.) Effectively, * means &"deleted"&.
29260
29261 .vitem &*int&~slen*&
29262 The number of characters in the header line, including the terminating and any
29263 internal newlines.
29264
29265 .vitem &*uschar&~*text*&
29266 A pointer to the text of the header. It always ends with a newline, followed by
29267 a zero byte. Internal newlines are preserved.
29268 .endlist
29269
29270
29271
29272 .section "Structure of recipient items" "SECID210"
29273 The &%recipient_item%& structure contains these members:
29274
29275 .vlist
29276 .vitem &*uschar&~*address*&
29277 This is a pointer to the recipient address as it was received.
29278
29279 .vitem &*int&~pno*&
29280 This is used in later Exim processing when top level addresses are created by
29281 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
29282 and must always contain -1 at this stage.
29283
29284 .vitem &*uschar&~*errors_to*&
29285 If this value is not NULL, bounce messages caused by failing to deliver to the
29286 recipient are sent to the address it contains. In other words, it overrides the
29287 envelope sender for this one recipient. (Compare the &%errors_to%& generic
29288 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
29289 an unqualified address, Exim qualifies it using the domain from
29290 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
29291 is NULL for all recipients.
29292 .endlist
29293
29294
29295
29296 .section "Available Exim functions" "SECID211"
29297 .cindex "&[local_scan()]& function" "available Exim functions"
29298 The header &_local_scan.h_& gives you access to a number of Exim functions.
29299 These are the only ones that are guaranteed to be maintained from release to
29300 release:
29301
29302 .vlist
29303 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
29304        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
29305
29306 This function creates a child process that runs the command specified by
29307 &%argv%&. The environment for the process is specified by &%envp%&, which can
29308 be NULL if no environment variables are to be passed. A new umask is supplied
29309 for the process in &%newumask%&.
29310
29311 Pipes to the standard input and output of the new process are set up
29312 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
29313 standard error is cloned to the standard output. If there are any file
29314 descriptors &"in the way"& in the new process, they are closed. If the final
29315 argument is TRUE, the new process is made into a process group leader.
29316
29317 The function returns the pid of the new process, or -1 if things go wrong.
29318
29319 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
29320 This function waits for a child process to terminate, or for a timeout (in
29321 seconds) to expire. A timeout value of zero means wait as long as it takes. The
29322 return value is as follows:
29323
29324 .ilist
29325 >= 0
29326
29327 The process terminated by a normal exit and the value is the process
29328 ending status.
29329
29330 .next
29331 < 0 and > &--256
29332
29333 The process was terminated by a signal and the value is the negation of the
29334 signal number.
29335
29336 .next
29337 &--256
29338
29339 The process timed out.
29340 .next
29341 &--257
29342
29343 The was some other error in wait(); &%errno%& is still set.
29344 .endlist
29345
29346 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
29347 This function provide you with a means of submitting a new message to
29348 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
29349 want, but this packages it all up for you.) The function creates a pipe,
29350 forks a subprocess that is running
29351 .code
29352 exim -t -oem -oi -f <>
29353 .endd
29354 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
29355 that is connected to the standard input. The yield of the function is the PID
29356 of the subprocess. You can then write a message to the file descriptor, with
29357 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
29358
29359 When you have finished, call &'child_close()'& to wait for the process to
29360 finish and to collect its ending status. A timeout value of zero is usually
29361 fine in this circumstance. Unless you have made a mistake with the recipient
29362 addresses, you should get a return code of zero.
29363
29364
29365 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
29366        *sender_authentication)*&
29367 This function is a more sophisticated version of &'child_open()'&. The command
29368 that it runs is:
29369 .display
29370 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
29371 .endd
29372 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
29373
29374
29375 .vitem &*void&~debug_printf(char&~*,&~...)*&
29376 This is Exim's debugging function, with arguments as for &'(printf()'&. The
29377 output is written to the standard error stream. If no debugging is selected,
29378 calls to &'debug_printf()'& have no effect. Normally, you should make calls
29379 conditional on the &`local_scan`& debug selector by coding like this:
29380 .code
29381 if ((debug_selector & D_local_scan) != 0)
29382   debug_printf("xxx", ...);
29383 .endd
29384
29385 .vitem &*uschar&~*expand_string(uschar&~*string)*&
29386 This is an interface to Exim's string expansion code. The return value is the
29387 expanded string, or NULL if there was an expansion failure.
29388 The C variable &%expand_string_message%& contains an error message after an
29389 expansion failure. If expansion does not change the string, the return value is
29390 the pointer to the input string. Otherwise, the return value points to a new
29391 block of memory that was obtained by a call to &'store_get()'&. See section
29392 &<<SECTmemhanloc>>& below for a discussion of memory handling.
29393
29394 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
29395 This function allows you to an add additional header line at the end of the
29396 existing ones. The first argument is the type, and should normally be a space
29397 character. The second argument is a format string and any number of
29398 substitution arguments as for &[sprintf()]&. You may include internal newlines
29399 if you want, and you must ensure that the string ends with a newline.
29400
29401 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
29402         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
29403 This function adds a new header line at a specified point in the header
29404 chain. The header itself is specified as for &'header_add()'&.
29405
29406 If &%name%& is NULL, the new header is added at the end of the chain if
29407 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
29408 NULL, the header lines are searched for the first non-deleted header that
29409 matches the name. If one is found, the new header is added before it if
29410 &%after%& is false. If &%after%& is true, the new header is added after the
29411 found header and any adjacent subsequent ones with the same name (even if
29412 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
29413 option controls where the header is added. If it is true, addition is at the
29414 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
29415 headers, or at the top if there are no &'Received:'& headers, you could use
29416 .code
29417 header_add_at_position(TRUE, US"Received", TRUE,
29418   ' ', "X-xxx: ...");
29419 .endd
29420 Normally, there is always at least one non-deleted &'Received:'& header, but
29421 there may not be if &%received_header_text%& expands to an empty string.
29422
29423
29424 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
29425 This function removes header lines. If &%occurrence%& is zero or negative, all
29426 occurrences of the header are removed. If occurrence is greater than zero, that
29427 particular instance of the header is removed. If no header(s) can be found that
29428 match the specification, the function does nothing.
29429
29430
29431 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
29432         int&~length,&~BOOL&~notdel)*&"
29433 This function tests whether the given header has the given name. It is not just
29434 a string comparison, because white space is permitted between the name and the
29435 colon. If the &%notdel%& argument is true, a false return is forced for all
29436 &"deleted"& headers; otherwise they are not treated specially. For example:
29437 .code
29438 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
29439 .endd
29440 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
29441 .cindex "base64 encoding" "functions for &[local_scan()]& use"
29442 This function base64-encodes a string, which is passed by address and length.
29443 The text may contain bytes of any value, including zero. The result is passed
29444 back in dynamic memory that is obtained by calling &'store_get()'&. It is
29445 zero-terminated.
29446
29447 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
29448 This function decodes a base64-encoded string. Its arguments are a
29449 zero-terminated base64-encoded string and the address of a variable that is set
29450 to point to the result, which is in dynamic memory. The length of the decoded
29451 string is the yield of the function. If the input is invalid base64 data, the
29452 yield is -1. A zero byte is added to the end of the output string to make it
29453 easy to interpret as a C string (assuming it contains no zeros of its own). The
29454 added zero byte is not included in the returned count.
29455
29456 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
29457 This function checks for a match in a domain list. Domains are always
29458 matched caselessly. The return value is one of the following:
29459 .display
29460 &`OK     `& match succeeded
29461 &`FAIL   `& match failed
29462 &`DEFER  `& match deferred
29463 .endd
29464 DEFER is usually caused by some kind of lookup defer, such as the
29465 inability to contact a database.
29466
29467 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
29468         BOOL&~caseless)*&"
29469 This function checks for a match in a local part list. The third argument
29470 controls case-sensitivity. The return values are as for
29471 &'lss_match_domain()'&.
29472
29473 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
29474         BOOL&~caseless)*&"
29475 This function checks for a match in an address list. The third argument
29476 controls the case-sensitivity of the local part match. The domain is always
29477 matched caselessly. The return values are as for &'lss_match_domain()'&.
29478
29479 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
29480         uschar&~*list)*&"
29481 This function checks for a match in a host list. The most common usage is
29482 expected to be
29483 .code
29484 lss_match_host(sender_host_name, sender_host_address, ...)
29485 .endd
29486 .vindex "&$sender_host_address$&"
29487 An empty address field matches an empty item in the host list. If the host name
29488 is NULL, the name corresponding to &$sender_host_address$& is automatically
29489 looked up if a host name is required to match an item in the list. The return
29490 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
29491 returns ERROR in the case when it had to look up a host name, but the lookup
29492 failed.
29493
29494 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
29495         *format,&~...)*&"
29496 This function writes to Exim's log files. The first argument should be zero (it
29497 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
29498 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
29499 them. It specifies to which log or logs the message is written. The remaining
29500 arguments are a format and relevant insertion arguments. The string should not
29501 contain any newlines, not even at the end.
29502
29503
29504 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
29505 This function adds an additional recipient to the message. The first argument
29506 is the recipient address. If it is unqualified (has no domain), it is qualified
29507 with the &%qualify_recipient%& domain. The second argument must always be -1.
29508
29509 This function does not allow you to specify a private &%errors_to%& address (as
29510 described with the structure of &%recipient_item%& above), because it pre-dates
29511 the addition of that field to the structure. However, it is easy to add such a
29512 value afterwards. For example:
29513 .code
29514  receive_add_recipient(US"monitor@mydom.example", -1);
29515  recipients_list[recipients_count-1].errors_to =
29516    US"postmaster@mydom.example";
29517 .endd
29518
29519 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
29520 This is a convenience function to remove a named recipient from the list of
29521 recipients. It returns true if a recipient was removed, and false if no
29522 matching recipient could be found. The argument must be a complete email
29523 address.
29524 .endlist
29525
29526
29527 .cindex "RFC 2047"
29528 .vlist
29529 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
29530   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
29531 This function decodes strings that are encoded according to RFC 2047. Typically
29532 these are the contents of header lines. First, each &"encoded word"& is decoded
29533 from the Q or B encoding into a byte-string. Then, if provided with the name of
29534 a charset encoding, and if the &[iconv()]& function is available, an attempt is
29535 made  to translate the result to the named character set. If this fails, the
29536 binary string is returned with an error message.
29537
29538 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
29539 maximum MIME word length is enforced. The third argument is the target
29540 encoding, or NULL if no translation is wanted.
29541
29542 .cindex "binary zero" "in RFC 2047 decoding"
29543 .cindex "RFC 2047" "binary zero in"
29544 If a binary zero is encountered in the decoded string, it is replaced by the
29545 contents of the &%zeroval%& argument. For use with Exim headers, the value must
29546 not be 0 because header lines are handled as zero-terminated strings.
29547
29548 The function returns the result of processing the string, zero-terminated; if
29549 &%lenptr%& is not NULL, the length of the result is set in the variable to
29550 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
29551
29552 If an error is encountered, the function returns NULL and uses the &%error%&
29553 argument to return an error message. The variable pointed to by &%error%& is
29554 set to NULL if there is no error; it may be set non-NULL even when the function
29555 returns a non-NULL value if decoding was successful, but there was a problem
29556 with translation.
29557
29558
29559 .vitem &*int&~smtp_fflush(void)*&
29560 This function is used in conjunction with &'smtp_printf()'&, as described
29561 below.
29562
29563 .vitem &*void&~smtp_printf(char&~*,&~...)*&
29564 The arguments of this function are like &[printf()]&; it writes to the SMTP
29565 output stream. You should use this function only when there is an SMTP output
29566 stream, that is, when the incoming message is being received via interactive
29567 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
29568 is FALSE. If you want to test for an incoming message from another host (as
29569 opposed to a local process that used the &%-bs%& command line option), you can
29570 test the value of &%sender_host_address%&, which is non-NULL when a remote host
29571 is involved.
29572
29573 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
29574 output function, so it can be used for all forms of SMTP connection.
29575
29576 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
29577 must start with an appropriate response code: 550 if you are going to return
29578 LOCAL_SCAN_REJECT, 451 if you are going to return
29579 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
29580 initial lines of a multi-line response, the code must be followed by a hyphen
29581 to indicate that the line is not the final response line. You must also ensure
29582 that the lines you write terminate with CRLF. For example:
29583 .code
29584 smtp_printf("550-this is some extra info\r\n");
29585 return LOCAL_SCAN_REJECT;
29586 .endd
29587 Note that you can also create multi-line responses by including newlines in
29588 the data returned via the &%return_text%& argument. The added value of using
29589 &'smtp_printf()'& is that, for instance, you could introduce delays between
29590 multiple output lines.
29591
29592 The &'smtp_printf()'& function does not return any error indication, because it
29593 does not automatically flush pending output, and therefore does not test
29594 the state of the stream. (In the main code of Exim, flushing and error
29595 detection is done when Exim is ready for the next SMTP input command.) If
29596 you want to flush the output and check for an error (for example, the
29597 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
29598 arguments. It flushes the output stream, and returns a non-zero value if there
29599 is an error.
29600
29601 .vitem &*void&~*store_get(int)*&
29602 This function accesses Exim's internal store (memory) manager. It gets a new
29603 chunk of memory whose size is given by the argument. Exim bombs out if it ever
29604 runs out of memory. See the next section for a discussion of memory handling.
29605
29606 .vitem &*void&~*store_get_perm(int)*&
29607 This function is like &'store_get()'&, but it always gets memory from the
29608 permanent pool. See the next section for a discussion of memory handling.
29609
29610 .vitem &*uschar&~*string_copy(uschar&~*string)*&
29611 See below.
29612
29613 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
29614 See below.
29615
29616 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
29617 These three functions create strings using Exim's dynamic memory facilities.
29618 The first makes a copy of an entire string. The second copies up to a maximum
29619 number of characters, indicated by the second argument. The third uses a format
29620 and insertion arguments to create a new string. In each case, the result is a
29621 pointer to a new string in the current memory pool. See the next section for
29622 more discussion.
29623 .endlist
29624
29625
29626
29627 .section "More about Exim's memory handling" "SECTmemhanloc"
29628 .cindex "&[local_scan()]& function" "memory handling"
29629 No function is provided for freeing memory, because that is never needed.
29630 The dynamic memory that Exim uses when receiving a message is automatically
29631 recycled if another message is received by the same process (this applies only
29632 to incoming SMTP connections &-- other input methods can supply only one
29633 message at a time). After receiving the last message, a reception process
29634 terminates.
29635
29636 Because it is recycled, the normal dynamic memory cannot be used for holding
29637 data that must be preserved over a number of incoming messages on the same SMTP
29638 connection. However, Exim in fact uses two pools of dynamic memory; the second
29639 one is not recycled, and can be used for this purpose.
29640
29641 If you want to allocate memory that remains available for subsequent messages
29642 in the same SMTP connection, you should set
29643 .code
29644 store_pool = POOL_PERM
29645 .endd
29646 before calling the function that does the allocation. There is no need to
29647 restore the value if you do not need to; however, if you do want to revert to
29648 the normal pool, you can either restore the previous value of &%store_pool%& or
29649 set it explicitly to POOL_MAIN.
29650
29651 The pool setting applies to all functions that get dynamic memory, including
29652 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
29653 There is also a convenience function called &'store_get_perm()'& that gets a
29654 block of memory from the permanent pool while preserving the value of
29655 &%store_pool%&.
29656 .ecindex IIDlosca
29657
29658
29659
29660
29661 . ////////////////////////////////////////////////////////////////////////////
29662 . ////////////////////////////////////////////////////////////////////////////
29663
29664 .chapter "System-wide message filtering" "CHAPsystemfilter"
29665 .scindex IIDsysfil1 "filter" "system filter"
29666 .scindex IIDsysfil2 "filtering all mail"
29667 .scindex IIDsysfil3 "system filter"
29668 The previous chapters (on ACLs and the local scan function) describe checks
29669 that can be applied to messages before they are accepted by a host. There is
29670 also a mechanism for checking messages once they have been received, but before
29671 they are delivered. This is called the &'system filter'&.
29672
29673 The system filter operates in a similar manner to users' filter files, but it
29674 is run just once per message (however many recipients the message has).
29675 It should not normally be used as a substitute for routing, because &%deliver%&
29676 commands in a system router provide new envelope recipient addresses.
29677 The system filter must be an Exim filter. It cannot be a Sieve filter.
29678
29679 The system filter is run at the start of a delivery attempt, before any routing
29680 is done. If a message fails to be completely delivered at the first attempt,
29681 the system filter is run again at the start of every retry.
29682 If you want your filter to do something only once per message, you can make use
29683 of the &%first_delivery%& condition in an &%if%& command in the filter to
29684 prevent it happening on retries.
29685
29686 .vindex "&$domain$&"
29687 .vindex "&$local_part$&"
29688 &*Warning*&: Because the system filter runs just once, variables that are
29689 specific to individual recipient addresses, such as &$local_part$& and
29690 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
29691 you want to run a centrally-specified filter for each recipient address
29692 independently, you can do so by setting up a suitable &(redirect)& router, as
29693 described in section &<<SECTperaddfil>>& below.
29694
29695
29696 .section "Specifying a system filter" "SECID212"
29697 .cindex "uid (user id)" "system filter"
29698 .cindex "gid (group id)" "system filter"
29699 The name of the file that contains the system filter must be specified by
29700 setting &%system_filter%&. If you want the filter to run under a uid and gid
29701 other than root, you must also set &%system_filter_user%& and
29702 &%system_filter_group%& as appropriate. For example:
29703 .code
29704 system_filter = /etc/mail/exim.filter
29705 system_filter_user = exim
29706 .endd
29707 If a system filter generates any deliveries directly to files or pipes (via the
29708 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
29709 specified by setting &%system_filter_file_transport%& and
29710 &%system_filter_pipe_transport%&, respectively. Similarly,
29711 &%system_filter_reply_transport%& must be set to handle any messages generated
29712 by the &%reply%& command.
29713
29714
29715 .section "Testing a system filter" "SECID213"
29716 You can run simple tests of a system filter in the same way as for a user
29717 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
29718 are permitted only in system filters are recognized.
29719
29720 If you want to test the combined effect of a system filter and a user filter,
29721 you can use both &%-bF%& and &%-bf%& on the same command line.
29722
29723
29724
29725 .section "Contents of a system filter" "SECID214"
29726 The language used to specify system filters is the same as for users' filter
29727 files. It is described in the separate end-user document &'Exim's interface to
29728 mail filtering'&. However, there are some additional features that are
29729 available only in system filters; these are described in subsequent sections.
29730 If they are encountered in a user's filter file or when testing with &%-bf%&,
29731 they cause errors.
29732
29733 .cindex "frozen messages" "manual thaw; testing in filter"
29734 There are two special conditions which, though available in users' filter
29735 files, are designed for use in system filters. The condition &%first_delivery%&
29736 is true only for the first attempt at delivering a message, and
29737 &%manually_thawed%& is true only if the message has been frozen, and
29738 subsequently thawed by an admin user. An explicit forced delivery counts as a
29739 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
29740
29741 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
29742 specify an &"unseen"& (non-significant) delivery, and that delivery does not
29743 succeed, it will not be tried again.
29744 If you want Exim to retry an unseen delivery until it succeeds, you should
29745 arrange to set it up every time the filter runs.
29746
29747 When a system filter finishes running, the values of the variables &$n0$& &--
29748 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
29749 users' filter files. Thus a system filter can, for example, set up &"scores"&
29750 to which users' filter files can refer.
29751
29752
29753
29754 .section "Additional variable for system filters" "SECID215"
29755 .vindex "&$recipients$&"
29756 The expansion variable &$recipients$&, containing a list of all the recipients
29757 of the message (separated by commas and white space), is available in system
29758 filters. It is not available in users' filters for privacy reasons.
29759
29760
29761
29762 .section "Defer, freeze, and fail commands for system filters" "SECID216"
29763 .cindex "freezing messages"
29764 .cindex "message" "freezing"
29765 .cindex "message" "forced failure"
29766 .cindex "&%fail%&" "in system filter"
29767 .cindex "&%freeze%& in system filter"
29768 .cindex "&%defer%& in system filter"
29769 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
29770 always available in system filters, but are not normally enabled in users'
29771 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
29772 for the &(redirect)& router.) These commands can optionally be followed by the
29773 word &%text%& and a string containing an error message, for example:
29774 .code
29775 fail text "this message looks like spam to me"
29776 .endd
29777 The keyword &%text%& is optional if the next character is a double quote.
29778
29779 The &%defer%& command defers delivery of the original recipients of the
29780 message. The &%fail%& command causes all the original recipients to be failed,
29781 and a bounce message to be created. The &%freeze%& command suspends all
29782 delivery attempts for the original recipients. In all cases, any new deliveries
29783 that are specified by the filter are attempted as normal after the filter has
29784 run.
29785
29786 The &%freeze%& command is ignored if the message has been manually unfrozen and
29787 not manually frozen since. This means that automatic freezing by a system
29788 filter can be used as a way of checking out suspicious messages. If a message
29789 is found to be all right, manually unfreezing it allows it to be delivered.
29790
29791 .cindex "log" "&%fail%& command log line"
29792 .cindex "&%fail%&" "log line; reducing"
29793 The text given with a fail command is used as part of the bounce message as
29794 well as being written to the log. If the message is quite long, this can fill
29795 up a lot of log space when such failures are common. To reduce the size of the
29796 log message, Exim interprets the text in a special way if it starts with the
29797 two characters &`<<`& and contains &`>>`& later. The text between these two
29798 strings is written to the log, and the rest of the text is used in the bounce
29799 message. For example:
29800 .code
29801 fail "<<filter test 1>>Your message is rejected \
29802      because it contains attachments that we are \
29803      not prepared to receive."
29804 .endd
29805
29806 .cindex "loop" "caused by &%fail%&"
29807 Take great care with the &%fail%& command when basing the decision to fail on
29808 the contents of the message, because the bounce message will of course include
29809 the contents of the original message and will therefore trigger the &%fail%&
29810 command again (causing a mail loop) unless steps are taken to prevent this.
29811 Testing the &%error_message%& condition is one way to prevent this. You could
29812 use, for example
29813 .code
29814 if $message_body contains "this is spam" and not error_message
29815 then fail text "spam is not wanted here" endif
29816 .endd
29817 though of course that might let through unwanted bounce messages. The
29818 alternative is clever checking of the body and/or headers to detect bounces
29819 generated by the filter.
29820
29821 The interpretation of a system filter file ceases after a
29822 &%defer%&,
29823 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
29824 set up earlier in the filter file are honoured, so you can use a sequence such
29825 as
29826 .code
29827 mail ...
29828 freeze
29829 .endd
29830 to send a specified message when the system filter is freezing (or deferring or
29831 failing) a message. The normal deliveries for the message do not, of course,
29832 take place.
29833
29834
29835
29836 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
29837 .cindex "header lines" "adding; in system filter"
29838 .cindex "header lines" "removing; in system filter"
29839 .cindex "filter" "header lines; adding/removing"
29840 Two filter commands that are available only in system filters are:
29841 .code
29842 headers add <string>
29843 headers remove <string>
29844 .endd
29845 The argument for the &%headers add%& is a string that is expanded and then
29846 added to the end of the message's headers. It is the responsibility of the
29847 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
29848 space is ignored, and if the string is otherwise empty, or if the expansion is
29849 forced to fail, the command has no effect.
29850
29851 You can use &"\n"& within the string, followed by white space, to specify
29852 continued header lines. More than one header may be added in one command by
29853 including &"\n"& within the string without any following white space. For
29854 example:
29855 .code
29856 headers add "X-header-1: ....\n  \
29857              continuation of X-header-1 ...\n\
29858              X-header-2: ...."
29859 .endd
29860 Note that the header line continuation white space after the first newline must
29861 be placed before the backslash that continues the input string, because white
29862 space after input continuations is ignored.
29863
29864 The argument for &%headers remove%& is a colon-separated list of header names.
29865 This command applies only to those headers that are stored with the message;
29866 those that are added at delivery time (such as &'Envelope-To:'& and
29867 &'Return-Path:'&) cannot be removed by this means. If there is more than one
29868 header with the same name, they are all removed.
29869
29870 The &%headers%& command in a system filter makes an immediate change to the set
29871 of header lines that was received with the message (with possible additions
29872 from ACL processing). Subsequent commands in the system filter operate on the
29873 modified set, which also forms the basis for subsequent message delivery.
29874 Unless further modified during routing or transporting, this set of headers is
29875 used for all recipients of the message.
29876
29877 During routing and transporting, the variables that refer to the contents of
29878 header lines refer only to those lines that are in this set. Thus, header lines
29879 that are added by a system filter are visible to users' filter files and to all
29880 routers and transports. This contrasts with the manipulation of header lines by
29881 routers and transports, which is not immediate, but which instead is saved up
29882 until the message is actually being written (see section
29883 &<<SECTheadersaddrem>>&).
29884
29885 If the message is not delivered at the first attempt, header lines that were
29886 added by the system filter are stored with the message, and so are still
29887 present at the next delivery attempt. Header lines that were removed are still
29888 present, but marked &"deleted"& so that they are not transported with the
29889 message. For this reason, it is usual to make the &%headers%& command
29890 conditional on &%first_delivery%& so that the set of header lines is not
29891 modified more than once.
29892
29893 Because header modification in a system filter acts immediately, you have to
29894 use an indirect approach if you want to modify the contents of a header line.
29895 For example:
29896 .code
29897 headers add "Old-Subject: $h_subject:"
29898 headers remove "Subject"
29899 headers add "Subject: new subject (was: $h_old-subject:)"
29900 headers remove "Old-Subject"
29901 .endd
29902
29903
29904
29905 .section "Setting an errors address in a system filter" "SECID217"
29906 .cindex "envelope sender"
29907 In a system filter, if a &%deliver%& command is followed by
29908 .code
29909 errors_to <some address>
29910 .endd
29911 in order to change the envelope sender (and hence the error reporting) for that
29912 delivery, any address may be specified. (In a user filter, only the current
29913 user's address can be set.) For example, if some mail is being monitored, you
29914 might use
29915 .code
29916 unseen deliver monitor@spying.example errors_to root@local.example
29917 .endd
29918 to take a copy which would not be sent back to the normal error reporting
29919 address if its delivery failed.
29920
29921
29922
29923 .section "Per-address filtering" "SECTperaddfil"
29924 .vindex "&$domain$&"
29925 .vindex "&$local_part$&"
29926 In contrast to the system filter, which is run just once per message for each
29927 delivery attempt, it is also possible to set up a system-wide filtering
29928 operation that runs once for each recipient address. In this case, variables
29929 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
29930 filter file could be made dependent on them. This is an example of a router
29931 which implements such a filter:
29932 .code
29933 central_filter:
29934   check_local_user
29935   driver = redirect
29936   domains = +local_domains
29937   file = /central/filters/$local_part
29938   no_verify
29939   allow_filter
29940   allow_freeze
29941 .endd
29942 The filter is run in a separate process under its own uid. Therefore, either
29943 &%check_local_user%& must be set (as above), in which case the filter is run as
29944 the local user, or the &%user%& option must be used to specify which user to
29945 use. If both are set, &%user%& overrides.
29946
29947 Care should be taken to ensure that none of the commands in the filter file
29948 specify a significant delivery if the message is to go on to be delivered to
29949 its intended recipient. The router will not then claim to have dealt with the
29950 address, so it will be passed on to subsequent routers to be delivered in the
29951 normal way.
29952 .ecindex IIDsysfil1
29953 .ecindex IIDsysfil2
29954 .ecindex IIDsysfil3
29955
29956
29957
29958
29959
29960
29961 . ////////////////////////////////////////////////////////////////////////////
29962 . ////////////////////////////////////////////////////////////////////////////
29963
29964 .chapter "Message processing" "CHAPmsgproc"
29965 .scindex IIDmesproc "message" "general processing"
29966 Exim performs various transformations on the sender and recipient addresses of
29967 all messages that it handles, and also on the messages' header lines. Some of
29968 these are optional and configurable, while others always take place. All of
29969 this processing, except rewriting as a result of routing, and the addition or
29970 removal of header lines while delivering, happens when a message is received,
29971 before it is placed on Exim's queue.
29972
29973 Some of the automatic processing takes place by default only for
29974 &"locally-originated"& messages. This adjective is used to describe messages
29975 that are not received over TCP/IP, but instead are passed to an Exim process on
29976 its standard input. This includes the interactive &"local SMTP"& case that is
29977 set up by the &%-bs%& command line option.
29978
29979 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
29980 or ::1) are not considered to be locally-originated. Exim does not treat the
29981 loopback interface specially in any way.
29982
29983 If you want the loopback interface to be treated specially, you must ensure
29984 that there are appropriate entries in your ACLs.
29985
29986
29987
29988
29989 .section "Submission mode for non-local messages" "SECTsubmodnon"
29990 .cindex "message" "submission"
29991 .cindex "submission mode"
29992 Processing that happens automatically for locally-originated messages (unless
29993 &%suppress_local_fixups%& is set) can also be requested for messages that are
29994 received over TCP/IP. The term &"submission mode"& is used to describe this
29995 state. Submission mode is set by the modifier
29996 .code
29997 control = submission
29998 .endd
29999 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
30000 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
30001 a local submission, and is normally used when the source of the message is
30002 known to be an MUA running on a client host (as opposed to an MTA). For
30003 example, to set submission mode for messages originating on the IPv4 loopback
30004 interface, you could include the following in the MAIL ACL:
30005 .code
30006 warn  hosts = 127.0.0.1
30007       control = submission
30008 .endd
30009 .cindex "&%sender_retain%& submission option"
30010 There are some options that can be used when setting submission mode. A slash
30011 is used to separate options. For example:
30012 .code
30013 control = submission/sender_retain
30014 .endd
30015 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
30016 true and &%local_from_check%& false for the current incoming message. The first
30017 of these allows an existing &'Sender:'& header in the message to remain, and
30018 the second suppresses the check to ensure that &'From:'& matches the
30019 authenticated sender. With this setting, Exim still fixes up messages by adding
30020 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
30021 attempt to check sender authenticity in header lines.
30022
30023 When &%sender_retain%& is not set, a submission mode setting may specify a
30024 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
30025 example:
30026 .code
30027 control = submission/domain=some.domain
30028 .endd
30029 The domain may be empty. How this value is used is described in sections
30030 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
30031 that allows you to specify the user's full name for inclusion in a created
30032 &'Sender:'& or &'From:'& header line. For example:
30033 .code
30034 accept authenticated = *
30035        control = submission/domain=wonderland.example/\
30036                             name=${lookup {$authenticated_id} \
30037                                    lsearch {/etc/exim/namelist}}
30038 .endd
30039 Because the name may contain any characters, including slashes, the &%name%&
30040 option must be given last. The remainder of the string is used as the name. For
30041 the example above, if &_/etc/exim/namelist_& contains:
30042 .code
30043 bigegg:  Humpty Dumpty
30044 .endd
30045 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
30046 line would be:
30047 .code
30048 Sender: Humpty Dumpty <bigegg@wonderland.example>
30049 .endd
30050 .cindex "return path" "in submission mode"
30051 By default, submission mode forces the return path to the same address as is
30052 used to create the &'Sender:'& header. However, if &%sender_retain%& is
30053 specified, the return path is also left unchanged.
30054
30055 &*Note*&: The changes caused by submission mode take effect after the predata
30056 ACL. This means that any sender checks performed before the fix-ups use the
30057 untrusted sender address specified by the user, not the trusted sender address
30058 specified by submission mode. Although this might be slightly unexpected, it
30059 does mean that you can configure ACL checks to spot that a user is trying to
30060 spoof another's address.
30061
30062 .section "Line endings" "SECTlineendings"
30063 .cindex "line endings"
30064 .cindex "carriage return"
30065 .cindex "linefeed"
30066 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
30067 linefeed) is the line ending for messages transmitted over the Internet using
30068 SMTP over TCP/IP. However, within individual operating systems, different
30069 conventions are used. For example, Unix-like systems use just LF, but others
30070 use CRLF or just CR.
30071
30072 Exim was designed for Unix-like systems, and internally, it stores messages
30073 using the system's convention of a single LF as a line terminator. When
30074 receiving a message, all line endings are translated to this standard format.
30075 Originally, it was thought that programs that passed messages directly to an
30076 MTA within an operating system would use that system's convention. Experience
30077 has shown that this is not the case; for example, there are Unix applications
30078 that use CRLF in this circumstance. For this reason, and for compatibility with
30079 other MTAs, the way Exim handles line endings for all messages is now as
30080 follows:
30081
30082 .ilist
30083 LF not preceded by CR is treated as a line ending.
30084 .next
30085 CR is treated as a line ending; if it is immediately followed by LF, the LF
30086 is ignored.
30087 .next
30088 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
30089 nor a local message in the state where a line containing only a dot is a
30090 terminator.
30091 .next
30092 If a bare CR is encountered within a header line, an extra space is added after
30093 the line terminator so as not to end the header line. The reasoning behind this
30094 is that bare CRs in header lines are most likely either to be mistakes, or
30095 people trying to play silly games.
30096 .next
30097 If the first header line received in a message ends with CRLF, a subsequent
30098 bare LF in a header line is treated in the same way as a bare CR in a header
30099 line.
30100 .endlist
30101
30102
30103
30104
30105
30106 .section "Unqualified addresses" "SECID218"
30107 .cindex "unqualified addresses"
30108 .cindex "address" "qualification"
30109 By default, Exim expects every envelope address it receives from an external
30110 host to be fully qualified. Unqualified addresses cause negative responses to
30111 SMTP commands. However, because SMTP is used as a means of transporting
30112 messages from MUAs running on personal workstations, there is sometimes a
30113 requirement to accept unqualified addresses from specific hosts or IP networks.
30114
30115 Exim has two options that separately control which hosts may send unqualified
30116 sender or recipient addresses in SMTP commands, namely
30117 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
30118 cases, if an unqualified address is accepted, it is qualified by adding the
30119 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
30120
30121 .oindex "&%qualify_domain%&"
30122 .oindex "&%qualify_recipient%&"
30123 Unqualified addresses in header lines are automatically qualified for messages
30124 that are locally originated, unless the &%-bnq%& option is given on the command
30125 line. For messages received over SMTP, unqualified addresses in header lines
30126 are qualified only if unqualified addresses are permitted in SMTP commands. In
30127 other words, such qualification is also controlled by
30128 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
30129
30130
30131
30132
30133 .section "The UUCP From line" "SECID219"
30134 .cindex "&""From""& line"
30135 .cindex "UUCP" "&""From""& line"
30136 .cindex "sender" "address"
30137 .oindex "&%uucp_from_pattern%&"
30138 .oindex "&%uucp_from_sender%&"
30139 .cindex "envelope sender"
30140 .cindex "Sendmail compatibility" "&""From""& line"
30141 Messages that have come from UUCP (and some other applications) often begin
30142 with a line containing the envelope sender and a timestamp, following the word
30143 &"From"&. Examples of two common formats are:
30144 .code
30145 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
30146 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
30147 .endd
30148 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
30149 Exim recognizes such lines at the start of messages that are submitted to it
30150 via the command line (that is, on the standard input). It does not recognize
30151 such lines in incoming SMTP messages, unless the sending host matches
30152 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
30153 and &%ignore_fromline_local%& is set. The recognition is controlled by a
30154 regular expression that is defined by the &%uucp_from_pattern%& option, whose
30155 default value matches the two common cases shown above and puts the address
30156 that follows &"From"& into &$1$&.
30157
30158 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
30159 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
30160 a trusted user, the message's sender address is constructed by expanding the
30161 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
30162 then parsed as an RFC 2822 address. If there is no domain, the local part is
30163 qualified with &%qualify_domain%& unless it is the empty string. However, if
30164 the command line &%-f%& option is used, it overrides the &"From"& line.
30165
30166 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
30167 sender address is not changed. This is also the case for incoming SMTP messages
30168 that are permitted to contain &"From"& lines.
30169
30170 Only one &"From"& line is recognized. If there is more than one, the second is
30171 treated as a data line that starts the body of the message, as it is not valid
30172 as a header line. This also happens if a &"From"& line is present in an
30173 incoming SMTP message from a source that is not permitted to send them.
30174
30175
30176
30177 .section "Resent- header lines" "SECID220"
30178 .cindex "&%Resent-%& header lines"
30179 RFC 2822 makes provision for sets of header lines starting with the string
30180 &`Resent-`& to be added to a message when it is resent by the original
30181 recipient to somebody else. These headers are &'Resent-Date:'&,
30182 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
30183 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
30184
30185 .blockquote
30186 &'Resent fields are strictly informational. They MUST NOT be used in the normal
30187 processing of replies or other such automatic actions on messages.'&
30188 .endblockquote
30189
30190 This leaves things a bit vague as far as other processing actions such as
30191 address rewriting are concerned. Exim treats &%Resent-%& header lines as
30192 follows:
30193
30194 .ilist
30195 A &'Resent-From:'& line that just contains the login id of the submitting user
30196 is automatically rewritten in the same way as &'From:'& (see below).
30197 .next
30198 If there's a rewriting rule for a particular header line, it is also applied to
30199 &%Resent-%& header lines of the same type. For example, a rule that rewrites
30200 &'From:'& also rewrites &'Resent-From:'&.
30201 .next
30202 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
30203 also removed.
30204 .next
30205 For a locally-submitted message,
30206 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
30207 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
30208 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
30209 included in log lines in this case.
30210 .next
30211 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
30212 &%Resent-%& header lines are present.
30213 .endlist
30214
30215
30216
30217
30218 .section "The Auto-Submitted: header line" "SECID221"
30219 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
30220 includes the header line:
30221 .code
30222 Auto-Submitted: auto-replied
30223 .endd
30224
30225 .section "The Bcc: header line" "SECID222"
30226 .cindex "&'Bcc:'& header line"
30227 If Exim is called with the &%-t%& option, to take recipient addresses from a
30228 message's header, it removes any &'Bcc:'& header line that may exist (after
30229 extracting its addresses). If &%-t%& is not present on the command line, any
30230 existing &'Bcc:'& is not removed.
30231
30232
30233 .section "The Date: header line" "SECID223"
30234 .cindex "&'Date:'& header line"
30235 If a locally-generated or submission-mode message has no &'Date:'& header line,
30236 Exim adds one, using the current date and time, unless the
30237 &%suppress_local_fixups%& control has been specified.
30238
30239 .section "The Delivery-date: header line" "SECID224"
30240 .cindex "&'Delivery-date:'& header line"
30241 .oindex "&%delivery_date_remove%&"
30242 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
30243 set. Exim can be configured to add them to the final delivery of messages. (See
30244 the generic &%delivery_date_add%& transport option.) They should not be present
30245 in messages in transit. If the &%delivery_date_remove%& configuration option is
30246 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
30247 messages.
30248
30249
30250 .section "The Envelope-to: header line" "SECID225"
30251 .cindex "&'Envelope-to:'& header line"
30252 .oindex "&%envelope_to_remove%&"
30253 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
30254 Exim can be configured to add them to the final delivery of messages. (See the
30255 generic &%envelope_to_add%& transport option.) They should not be present in
30256 messages in transit. If the &%envelope_to_remove%& configuration option is set
30257 (the default), Exim removes &'Envelope-to:'& header lines from incoming
30258 messages.
30259
30260
30261 .section "The From: header line" "SECTthefrohea"
30262 .cindex "&'From:'& header line"
30263 .cindex "Sendmail compatibility" "&""From""& line"
30264 .cindex "message" "submission"
30265 .cindex "submission mode"
30266 If a submission-mode message does not contain a &'From:'& header line, Exim
30267 adds one if either of the following conditions is true:
30268
30269 .ilist
30270 The envelope sender address is not empty (that is, this is not a bounce
30271 message). The added header line copies the envelope sender address.
30272 .next
30273 .vindex "&$authenticated_id$&"
30274 The SMTP session is authenticated and &$authenticated_id$& is not empty.
30275 .olist
30276 .vindex "&$qualify_domain$&"
30277 If no domain is specified by the submission control, the local part is
30278 &$authenticated_id$& and the domain is &$qualify_domain$&.
30279 .next
30280 If a non-empty domain is specified by the submission control, the local
30281 part is &$authenticated_id$&, and the domain is the specified domain.
30282 .next
30283 If an empty domain is specified by the submission control,
30284 &$authenticated_id$& is assumed to be the complete address.
30285 .endlist
30286 .endlist
30287
30288 A non-empty envelope sender takes precedence.
30289
30290 If a locally-generated incoming message does not contain a &'From:'& header
30291 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
30292 containing the sender's address. The calling user's login name and full name
30293 are used to construct the address, as described in section &<<SECTconstr>>&.
30294 They are obtained from the password data by calling &[getpwuid()]& (but see the
30295 &%unknown_login%& configuration option). The address is qualified with
30296 &%qualify_domain%&.
30297
30298 For compatibility with Sendmail, if an incoming, non-SMTP message has a
30299 &'From:'& header line containing just the unqualified login name of the calling
30300 user, this is replaced by an address containing the user's login name and full
30301 name as described in section &<<SECTconstr>>&.
30302
30303
30304 .section "The Message-ID: header line" "SECID226"
30305 .cindex "&'Message-ID:'& header line"
30306 .cindex "message" "submission"
30307 .oindex "&%message_id_header_text%&"
30308 If a locally-generated or submission-mode incoming message does not contain a
30309 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
30310 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
30311 to the message. If there are any &'Resent-:'& headers in the message, it
30312 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
30313 message id, preceded by the letter E to ensure it starts with a letter, and
30314 followed by @ and the primary host name. Additional information can be included
30315 in this header line by setting the &%message_id_header_text%& and/or
30316 &%message_id_header_domain%& options.
30317
30318
30319 .section "The Received: header line" "SECID227"
30320 .cindex "&'Received:'& header line"
30321 A &'Received:'& header line is added at the start of every message. The
30322 contents are defined by the &%received_header_text%& configuration option, and
30323 Exim automatically adds a semicolon and a timestamp to the configured string.
30324
30325 The &'Received:'& header is generated as soon as the message's header lines
30326 have been received. At this stage, the timestamp in the &'Received:'& header
30327 line is the time that the message started to be received. This is the value
30328 that is seen by the DATA ACL and by the &[local_scan()]& function.
30329
30330 Once a message is accepted, the timestamp in the &'Received:'& header line is
30331 changed to the time of acceptance, which is (apart from a small delay while the
30332 -H spool file is written) the earliest time at which delivery could start.
30333
30334
30335 .section "The References: header line" "SECID228"
30336 .cindex "&'References:'& header line"
30337 Messages created by the &(autoreply)& transport include a &'References:'&
30338 header line. This is constructed according to the rules that are described in
30339 section 3.64 of RFC 2822 (which states that replies should contain such a
30340 header line), and section 3.14 of RFC 3834 (which states that automatic
30341 responses are not different in this respect). However, because some mail
30342 processing software does not cope well with very long header lines, no more
30343 than 12 message IDs are copied from the &'References:'& header line in the
30344 incoming message. If there are more than 12, the first one and then the final
30345 11 are copied, before adding the message ID of the incoming message.
30346
30347
30348
30349 .section "The Return-path: header line" "SECID229"
30350 .cindex "&'Return-path:'& header line"
30351 .oindex "&%return_path_remove%&"
30352 &'Return-path:'& header lines are defined as something an MTA may insert when
30353 it does the final delivery of messages. (See the generic &%return_path_add%&
30354 transport option.) Therefore, they should not be present in messages in
30355 transit. If the &%return_path_remove%& configuration option is set (the
30356 default), Exim removes &'Return-path:'& header lines from incoming messages.
30357
30358
30359
30360 .section "The Sender: header line" "SECTthesenhea"
30361 .cindex "&'Sender:'& header line"
30362 .cindex "message" "submission"
30363 For a locally-originated message from an untrusted user, Exim may remove an
30364 existing &'Sender:'& header line, and it may add a new one. You can modify
30365 these actions by setting the &%local_sender_retain%& option true, the
30366 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
30367 control setting.
30368
30369 When a local message is received from an untrusted user and
30370 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
30371 control has not been set, a check is made to see if the address given in the
30372 &'From:'& header line is the correct (local) sender of the message. The address
30373 that is expected has the login name as the local part and the value of
30374 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
30375 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
30376 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
30377 line is added to the message.
30378
30379 If you set &%local_from_check%& false, this checking does not occur. However,
30380 the removal of an existing &'Sender:'& line still happens, unless you also set
30381 &%local_sender_retain%& to be true. It is not possible to set both of these
30382 options true at the same time.
30383
30384 .cindex "submission mode"
30385 By default, no processing of &'Sender:'& header lines is done for messages
30386 received over TCP/IP or for messages submitted by trusted users. However, when
30387 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
30388 not specified on the submission control, the following processing takes place:
30389
30390 .vindex "&$authenticated_id$&"
30391 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
30392 authenticated, and &$authenticated_id$& is not empty, a sender address is
30393 created as follows:
30394
30395 .ilist
30396 .vindex "&$qualify_domain$&"
30397 If no domain is specified by the submission control, the local part is
30398 &$authenticated_id$& and the domain is &$qualify_domain$&.
30399 .next
30400 If a non-empty domain is specified by the submission control, the local part
30401 is &$authenticated_id$&, and the domain is the specified domain.
30402 .next
30403 If an empty domain is specified by the submission control,
30404 &$authenticated_id$& is assumed to be the complete address.
30405 .endlist
30406
30407 This address is compared with the address in the &'From:'& header line. If they
30408 are different, a &'Sender:'& header line containing the created address is
30409 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
30410 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
30411
30412 .cindex "return path" "created from &'Sender:'&"
30413 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
30414 the message (the envelope sender address) is changed to be the same address,
30415 except in the case of submission mode when &%sender_retain%& is specified.
30416
30417
30418
30419 .section "Adding and removing header lines in routers and transports" &&&
30420          "SECTheadersaddrem"
30421 .cindex "header lines" "adding; in router or transport"
30422 .cindex "header lines" "removing; in router or transport"
30423 When a message is delivered, the addition and removal of header lines can be
30424 specified in a system filter, or on any of the routers and transports that
30425 process the message. Section &<<SECTaddremheasys>>& contains details about
30426 modifying headers in a system filter. Header lines can also be added in an ACL
30427 as a message is received (see section &<<SECTaddheadacl>>&).
30428
30429 In contrast to what happens in a system filter, header modifications that are
30430 specified on routers and transports apply only to the particular recipient
30431 addresses that are being processed by those routers and transports. These
30432 changes do not actually take place until a copy of the message is being
30433 transported. Therefore, they do not affect the basic set of header lines, and
30434 they do not affect the values of the variables that refer to header lines.
30435
30436 &*Note*&: In particular, this means that any expansions in the configuration of
30437 the transport cannot refer to the modified header lines, because such
30438 expansions all occur before the message is actually transported.
30439
30440 For both routers and transports, the result of expanding a &%headers_add%&
30441 option must be in the form of one or more RFC 2822 header lines, separated by
30442 newlines (coded as &"\n"&). For example:
30443 .code
30444 headers_add = X-added-header: added by $primary_hostname\n\
30445               X-added-second: another added header line
30446 .endd
30447 Exim does not check the syntax of these added header lines.
30448
30449 The result of expanding &%headers_remove%& must consist of a colon-separated
30450 list of header names. This is confusing, because header names themselves are
30451 often terminated by colons. In this case, the colons are the list separators,
30452 not part of the names. For example:
30453 .code
30454 headers_remove = return-receipt-to:acknowledge-to
30455 .endd
30456 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
30457 is expanded at routing time, and then associated with all addresses that are
30458 accepted by that router, and also with any new addresses that it generates. If
30459 an address passes through several routers as a result of aliasing or
30460 forwarding, the changes are cumulative.
30461
30462 .oindex "&%unseen%&"
30463 However, this does not apply to multiple routers that result from the use of
30464 the &%unseen%& option. Any header modifications that were specified by the
30465 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
30466
30467 Addresses that end up with different &%headers_add%& or &%headers_remove%&
30468 settings cannot be delivered together in a batch, so a transport is always
30469 dealing with a set of addresses that have the same header-processing
30470 requirements.
30471
30472 The transport starts by writing the original set of header lines that arrived
30473 with the message, possibly modified by the system filter. As it writes out
30474 these lines, it consults the list of header names that were attached to the
30475 recipient address(es) by &%headers_remove%& options in routers, and it also
30476 consults the transport's own &%headers_remove%& option. Header lines whose
30477 names are on either of these lists are not written out. If there are multiple
30478 instances of any listed header, they are all skipped.
30479
30480 After the remaining original header lines have been written, new header
30481 lines that were specified by routers' &%headers_add%& options are written, in
30482 the order in which they were attached to the address. These are followed by any
30483 header lines specified by the transport's &%headers_add%& option.
30484
30485 This way of handling header line modifications in routers and transports has
30486 the following consequences:
30487
30488 .ilist
30489 The original set of header lines, possibly modified by the system filter,
30490 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
30491 to it, at all times.
30492 .next
30493 Header lines that are added by a router's
30494 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
30495 expansion syntax in subsequent routers or the transport.
30496 .next
30497 Conversely, header lines that are specified for removal by &%headers_remove%&
30498 in a router remain visible to subsequent routers and the transport.
30499 .next
30500 Headers added to an address by &%headers_add%& in a router cannot be removed by
30501 a later router or by a transport.
30502 .next
30503 An added header can refer to the contents of an original header that is to be
30504 removed, even it has the same name as the added header. For example:
30505 .code
30506 headers_remove = subject
30507 headers_add = Subject: new subject (was: $h_subject:)
30508 .endd
30509 .endlist
30510
30511 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
30512 for a &(redirect)& router that has the &%one_time%& option set.
30513
30514
30515
30516
30517
30518 .section "Constructed addresses" "SECTconstr"
30519 .cindex "address" "constructed"
30520 .cindex "constructed address"
30521 When Exim constructs a sender address for a locally-generated message, it uses
30522 the form
30523 .display
30524 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
30525 .endd
30526 For example:
30527 .code
30528 Zaphod Beeblebrox <zaphod@end.univ.example>
30529 .endd
30530 The user name is obtained from the &%-F%& command line option if set, or
30531 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
30532 &"gecos"& field from the password entry. If the &"gecos"& field contains an
30533 ampersand character, this is replaced by the login name with the first letter
30534 upper cased, as is conventional in a number of operating systems. See the
30535 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
30536 The &%unknown_username%& option can be used to specify user names in cases when
30537 there is no password file entry.
30538
30539 .cindex "RFC 2047"
30540 In all cases, the user name is made to conform to RFC 2822 by quoting all or
30541 parts of it if necessary. In addition, if it contains any non-printing
30542 characters, it is encoded as described in RFC 2047, which defines a way of
30543 including non-ASCII characters in header lines. The value of the
30544 &%headers_charset%& option specifies the name of the encoding that is used (the
30545 characters are assumed to be in this encoding). The setting of
30546 &%print_topbitchars%& controls whether characters with the top bit set (that
30547 is, with codes greater than 127) count as printing characters or not.
30548
30549
30550
30551 .section "Case of local parts" "SECID230"
30552 .cindex "case of local parts"
30553 .cindex "local part" "case of"
30554 RFC 2822 states that the case of letters in the local parts of addresses cannot
30555 be assumed to be non-significant. Exim preserves the case of local parts of
30556 addresses, but by default it uses a lower-cased form when it is routing,
30557 because on most Unix systems, usernames are in lower case and case-insensitive
30558 routing is required. However, any particular router can be made to use the
30559 original case for local parts by setting the &%caseful_local_part%& generic
30560 router option.
30561
30562 .cindex "mixed-case login names"
30563 If you must have mixed-case user names on your system, the best way to proceed,
30564 assuming you want case-independent handling of incoming email, is to set up
30565 your first router to convert incoming local parts in your domains to the
30566 correct case by means of a file lookup. For example:
30567 .code
30568 correct_case:
30569   driver = redirect
30570   domains = +local_domains
30571   data = ${lookup{$local_part}cdb\
30572               {/etc/usercased.cdb}{$value}fail}\
30573               @$domain
30574 .endd
30575 For this router, the local part is forced to lower case by the default action
30576 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
30577 up a new local part in the correct case. If you then set &%caseful_local_part%&
30578 on any subsequent routers which process your domains, they will operate on
30579 local parts with the correct case in a case-sensitive manner.
30580
30581
30582
30583 .section "Dots in local parts" "SECID231"
30584 .cindex "dot" "in local part"
30585 .cindex "local part" "dots in"
30586 RFC 2822 forbids empty components in local parts. That is, an unquoted local
30587 part may not begin or end with a dot, nor have two consecutive dots in the
30588 middle. However, it seems that many MTAs do not enforce this, so Exim permits
30589 empty components for compatibility.
30590
30591
30592
30593 .section "Rewriting addresses" "SECID232"
30594 .cindex "rewriting" "addresses"
30595 Rewriting of sender and recipient addresses, and addresses in headers, can
30596 happen automatically, or as the result of configuration options, as described
30597 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
30598 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
30599
30600 Automatic rewriting includes qualification, as mentioned above. The other case
30601 in which it can happen is when an incomplete non-local domain is given. The
30602 routing process may cause this to be expanded into the full domain name. For
30603 example, a header such as
30604 .code
30605 To: hare@teaparty
30606 .endd
30607 might get rewritten as
30608 .code
30609 To: hare@teaparty.wonderland.fict.example
30610 .endd
30611 Rewriting as a result of routing is the one kind of message processing that
30612 does not happen at input time, as it cannot be done until the address has
30613 been routed.
30614
30615 Strictly, one should not do &'any'& deliveries of a message until all its
30616 addresses have been routed, in case any of the headers get changed as a
30617 result of routing. However, doing this in practice would hold up many
30618 deliveries for unreasonable amounts of time, just because one address could not
30619 immediately be routed. Exim therefore does not delay other deliveries when
30620 routing of one or more addresses is deferred.
30621 .ecindex IIDmesproc
30622
30623
30624
30625 . ////////////////////////////////////////////////////////////////////////////
30626 . ////////////////////////////////////////////////////////////////////////////
30627
30628 .chapter "SMTP processing" "CHAPSMTP"
30629 .scindex IIDsmtpproc1 "SMTP" "processing details"
30630 .scindex IIDsmtpproc2 "LMTP" "processing details"
30631 Exim supports a number of different ways of using the SMTP protocol, and its
30632 LMTP variant, which is an interactive protocol for transferring messages into a
30633 closed mail store application. This chapter contains details of how SMTP is
30634 processed. For incoming mail, the following are available:
30635
30636 .ilist
30637 SMTP over TCP/IP (Exim daemon or &'inetd'&);
30638 .next
30639 SMTP over the standard input and output (the &%-bs%& option);
30640 .next
30641 Batched SMTP on the standard input (the &%-bS%& option).
30642 .endlist
30643
30644 For mail delivery, the following are available:
30645
30646 .ilist
30647 SMTP over TCP/IP (the &(smtp)& transport);
30648 .next
30649 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
30650 &"lmtp"&);
30651 .next
30652 LMTP over a pipe to a process running in the local host (the &(lmtp)&
30653 transport);
30654 .next
30655 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
30656 the &%use_bsmtp%& option set).
30657 .endlist
30658
30659 &'Batched SMTP'& is the name for a process in which batches of messages are
30660 stored in or read from files (or pipes), in a format in which SMTP commands are
30661 used to contain the envelope information.
30662
30663
30664
30665 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
30666 .cindex "SMTP" "outgoing over TCP/IP"
30667 .cindex "outgoing SMTP over TCP/IP"
30668 .cindex "LMTP" "over TCP/IP"
30669 .cindex "outgoing LMTP over TCP/IP"
30670 .cindex "EHLO"
30671 .cindex "HELO"
30672 .cindex "SIZE option on MAIL command"
30673 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
30674 The &%protocol%& option selects which protocol is to be used, but the actual
30675 processing is the same in both cases.
30676
30677 If, in response to its EHLO command, Exim is told that the SIZE
30678 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
30679 command. The value of <&'n'&> is the message size plus the value of the
30680 &%size_addition%& option (default 1024) to allow for additions to the message
30681 such as per-transport header lines, or changes made in a
30682 .cindex "transport" "filter"
30683 .cindex "filter" "transport filter"
30684 transport filter. If &%size_addition%& is set negative, the use of SIZE is
30685 suppressed.
30686
30687 If the remote server advertises support for PIPELINING, Exim uses the
30688 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
30689 required for the transaction.
30690
30691 If the remote server advertises support for the STARTTLS command, and Exim
30692 was built to support TLS encryption, it tries to start a TLS session unless the
30693 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
30694
30695 If the remote server advertises support for the AUTH command, Exim scans
30696 the authenticators configuration for any suitable client settings, as described
30697 in chapter &<<CHAPSMTPAUTH>>&.
30698
30699 .cindex "carriage return"
30700 .cindex "linefeed"
30701 Responses from the remote host are supposed to be terminated by CR followed by
30702 LF. However, there are known to be hosts that do not send CR characters, so in
30703 order to be able to interwork with such hosts, Exim treats LF on its own as a
30704 line terminator.
30705
30706 If a message contains a number of different addresses, all those with the same
30707 characteristics (for example, the same envelope sender) that resolve to the
30708 same set of hosts, in the same order, are sent in a single SMTP transaction,
30709 even if they are for different domains, unless there are more than the setting
30710 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
30711 they are split into groups containing no more than &%max_rcpt%&s addresses
30712 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
30713 in parallel sessions. The order of hosts with identical MX values is not
30714 significant when checking whether addresses can be batched in this way.
30715
30716 When the &(smtp)& transport suffers a temporary failure that is not
30717 message-related, Exim updates its transport-specific database, which contains
30718 records indexed by host name that remember which messages are waiting for each
30719 particular host. It also updates the retry database with new retry times.
30720
30721 .cindex "hints database" "retry keys"
30722 Exim's retry hints are based on host name plus IP address, so if one address of
30723 a multi-homed host is broken, it will soon be skipped most of the time.
30724 See the next section for more detail about error handling.
30725
30726 .cindex "SMTP" "passed connection"
30727 .cindex "SMTP" "batching over TCP/IP"
30728 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
30729 looks in the hints database for the transport to see if there are any queued
30730 messages waiting for the host to which it is connected. If it finds one, it
30731 creates a new Exim process using the &%-MC%& option (which can only be used by
30732 a process running as root or the Exim user) and passes the TCP/IP socket to it
30733 so that it can deliver another message using the same socket. The new process
30734 does only those deliveries that are routed to the connected host, and may in
30735 turn pass the socket on to a third process, and so on.
30736
30737 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
30738 limit the number of messages sent down a single TCP/IP connection.
30739
30740 .cindex "asterisk" "after IP address"
30741 The second and subsequent messages delivered down an existing connection are
30742 identified in the main log by the addition of an asterisk after the closing
30743 square bracket of the IP address.
30744
30745
30746
30747
30748 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
30749 .cindex "error" "in outgoing SMTP"
30750 .cindex "SMTP" "errors in outgoing"
30751 .cindex "host" "error"
30752 Three different kinds of error are recognized for outgoing SMTP: host errors,
30753 message errors, and recipient errors.
30754
30755 .vlist
30756 .vitem "&*Host errors*&"
30757 A host error is not associated with a particular message or with a
30758 particular recipient of a message. The host errors are:
30759
30760 .ilist
30761 Connection refused or timed out,
30762 .next
30763 Any error response code on connection,
30764 .next
30765 Any error response code to EHLO or HELO,
30766 .next
30767 Loss of connection at any time, except after &"."&,
30768 .next
30769 I/O errors at any time,
30770 .next
30771 Timeouts during the session, other than in response to MAIL, RCPT or
30772 the &"."& at the end of the data.
30773 .endlist ilist
30774
30775 For a host error, a permanent error response on connection, or in response to
30776 EHLO, causes all addresses routed to the host to be failed. Any other host
30777 error causes all addresses to be deferred, and retry data to be created for the
30778 host. It is not tried again, for any message, until its retry time arrives. If
30779 the current set of addresses are not all delivered in this run (to some
30780 alternative host), the message is added to the list of those waiting for this
30781 host, so if it is still undelivered when a subsequent successful delivery is
30782 made to the host, it will be sent down the same SMTP connection.
30783
30784 .vitem "&*Message errors*&"
30785 .cindex "message" "error"
30786 A message error is associated with a particular message when sent to a
30787 particular host, but not with a particular recipient of the message. The
30788 message errors are:
30789
30790 .ilist
30791 Any error response code to MAIL, DATA, or the &"."& that terminates
30792 the data,
30793 .next
30794 Timeout after MAIL,
30795 .next
30796 Timeout or loss of connection after the &"."& that terminates the data. A
30797 timeout after the DATA command itself is treated as a host error, as is loss of
30798 connection at any other time.
30799 .endlist ilist
30800
30801 For a message error, a permanent error response (5&'xx'&) causes all addresses
30802 to be failed, and a delivery error report to be returned to the sender. A
30803 temporary error response (4&'xx'&), or one of the timeouts, causes all
30804 addresses to be deferred. Retry data is not created for the host, but instead,
30805 a retry record for the combination of host plus message id is created. The
30806 message is not added to the list of those waiting for this host. This ensures
30807 that the failing message will not be sent to this host again until the retry
30808 time arrives. However, other messages that are routed to the host are not
30809 affected, so if it is some property of the message that is causing the error,
30810 it will not stop the delivery of other mail.
30811
30812 If the remote host specified support for the SIZE parameter in its response
30813 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
30814 over-large message will cause a message error because the error arrives as a
30815 response to MAIL.
30816
30817 .vitem "&*Recipient errors*&"
30818 .cindex "recipient" "error"
30819 A recipient error is associated with a particular recipient of a message. The
30820 recipient errors are:
30821
30822 .ilist
30823 Any error response to RCPT,
30824 .next
30825 Timeout after RCPT.
30826 .endlist
30827
30828 For a recipient error, a permanent error response (5&'xx'&) causes the
30829 recipient address to be failed, and a bounce message to be returned to the
30830 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
30831 address to be deferred, and routing retry data to be created for it. This is
30832 used to delay processing of the address in subsequent queue runs, until its
30833 routing retry time arrives. This applies to all messages, but because it
30834 operates only in queue runs, one attempt will be made to deliver a new message
30835 to the failing address before the delay starts to operate. This ensures that,
30836 if the failure is really related to the message rather than the recipient
30837 (&"message too big for this recipient"& is a possible example), other messages
30838 have a chance of getting delivered. If a delivery to the address does succeed,
30839 the retry information gets cleared, so all stuck messages get tried again, and
30840 the retry clock is reset.
30841
30842 The message is not added to the list of those waiting for this host. Use of the
30843 host for other messages is unaffected, and except in the case of a timeout,
30844 other recipients are processed independently, and may be successfully delivered
30845 in the current SMTP session. After a timeout it is of course impossible to
30846 proceed with the session, so all addresses get deferred. However, those other
30847 than the one that failed do not suffer any subsequent retry delays. Therefore,
30848 if one recipient is causing trouble, the others have a chance of getting
30849 through when a subsequent delivery attempt occurs before the failing
30850 recipient's retry time.
30851 .endlist
30852
30853 In all cases, if there are other hosts (or IP addresses) available for the
30854 current set of addresses (for example, from multiple MX records), they are
30855 tried in this run for any undelivered addresses, subject of course to their
30856 own retry data. In other words, recipient error retry data does not take effect
30857 until the next delivery attempt.
30858
30859 Some hosts have been observed to give temporary error responses to every
30860 MAIL command at certain times (&"insufficient space"& has been seen). It
30861 would be nice if such circumstances could be recognized, and defer data for the
30862 host itself created, but this is not possible within the current Exim design.
30863 What actually happens is that retry data for every (host, message) combination
30864 is created.
30865
30866 The reason that timeouts after MAIL and RCPT are treated specially is that
30867 these can sometimes arise as a result of the remote host's verification
30868 procedures. Exim makes this assumption, and treats them as if a temporary error
30869 response had been received. A timeout after &"."& is treated specially because
30870 it is known that some broken implementations fail to recognize the end of the
30871 message if the last character of the last line is a binary zero. Thus, it is
30872 helpful to treat this case as a message error.
30873
30874 Timeouts at other times are treated as host errors, assuming a problem with the
30875 host, or the connection to it. If a timeout after MAIL, RCPT,
30876 or &"."& is really a connection problem, the assumption is that at the next try
30877 the timeout is likely to occur at some other point in the dialogue, causing it
30878 then to be treated as a host error.
30879
30880 There is experimental evidence that some MTAs drop the connection after the
30881 terminating &"."& if they do not like the contents of the message for some
30882 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
30883 should be given. That is why Exim treats this case as a message rather than a
30884 host error, in order not to delay other messages to the same host.
30885
30886
30887
30888
30889 .section "Incoming SMTP messages over TCP/IP" "SECID233"
30890 .cindex "SMTP" "incoming over TCP/IP"
30891 .cindex "incoming SMTP over TCP/IP"
30892 .cindex "inetd"
30893 .cindex "daemon"
30894 Incoming SMTP messages can be accepted in one of two ways: by running a
30895 listening daemon, or by using &'inetd'&. In the latter case, the entry in
30896 &_/etc/inetd.conf_& should be like this:
30897 .code
30898 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
30899 .endd
30900 Exim distinguishes between this case and the case of a locally running user
30901 agent using the &%-bs%& option by checking whether or not the standard input is
30902 a socket. When it is, either the port must be privileged (less than 1024), or
30903 the caller must be root or the Exim user. If any other user passes a socket
30904 with an unprivileged port number, Exim prints a message on the standard error
30905 stream and exits with an error code.
30906
30907 By default, Exim does not make a log entry when a remote host connects or
30908 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
30909 unexpected. It can be made to write such log entries by setting the
30910 &%smtp_connection%& log selector.
30911
30912 .cindex "carriage return"
30913 .cindex "linefeed"
30914 Commands from the remote host are supposed to be terminated by CR followed by
30915 LF. However, there are known to be hosts that do not send CR characters. In
30916 order to be able to interwork with such hosts, Exim treats LF on its own as a
30917 line terminator.
30918 Furthermore, because common code is used for receiving messages from all
30919 sources, a CR on its own is also interpreted as a line terminator. However, the
30920 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
30921
30922 .cindex "EHLO" "invalid data"
30923 .cindex "HELO" "invalid data"
30924 One area that sometimes gives rise to problems concerns the EHLO or
30925 HELO commands. Some clients send syntactically invalid versions of these
30926 commands, which Exim rejects by default. (This is nothing to do with verifying
30927 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
30928 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
30929 match the broken hosts that send invalid commands.
30930
30931 .cindex "SIZE option on MAIL command"
30932 .cindex "MAIL" "SIZE option"
30933 The amount of disk space available is checked whenever SIZE is received on
30934 a MAIL command, independently of whether &%message_size_limit%& or
30935 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
30936 false. A temporary error is given if there is not enough space. If
30937 &%check_spool_space%& is set, the check is for that amount of space plus the
30938 value given with SIZE, that is, it checks that the addition of the incoming
30939 message will not reduce the space below the threshold.
30940
30941 When a message is successfully received, Exim includes the local message id in
30942 its response to the final &"."& that terminates the data. If the remote host
30943 logs this text it can help with tracing what has happened to a message.
30944
30945 The Exim daemon can limit the number of simultaneous incoming connections it is
30946 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
30947 number of simultaneous incoming connections from a single remote host (see the
30948 &%smtp_accept_max_per_host%& option). Additional connection attempts are
30949 rejected using the SMTP temporary error code 421.
30950
30951 The Exim daemon does not rely on the SIGCHLD signal to detect when a
30952 subprocess has finished, as this can get lost at busy times. Instead, it looks
30953 for completed subprocesses every time it wakes up. Provided there are other
30954 things happening (new incoming calls, starts of queue runs), completed
30955 processes will be noticed and tidied away. On very quiet systems you may
30956 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
30957 it will be noticed when the daemon next wakes up.
30958
30959 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
30960 and can also be set up to reject SMTP calls from non-reserved hosts at times of
30961 high system load &-- for details see the &%smtp_accept_reserve%&,
30962 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
30963 applies in both the daemon and &'inetd'& cases.
30964
30965 Exim normally starts a delivery process for each message received, though this
30966 can be varied by means of the &%-odq%& command line option and the
30967 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
30968 number of simultaneously running delivery processes started in this way from
30969 SMTP input can be limited by the &%smtp_accept_queue%& and
30970 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
30971 subsequently received messages are just put on the input queue without starting
30972 a delivery process.
30973
30974 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
30975 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
30976 started up from the &'inetd'& daemon, because in that case each connection is
30977 handled by an entirely independent Exim process. Control by load average is,
30978 however, available with &'inetd'&.
30979
30980 Exim can be configured to verify addresses in incoming SMTP commands as they
30981 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
30982 to rewrite addresses at this time &-- before any syntax checking is done. See
30983 section &<<SECTrewriteS>>&.
30984
30985 Exim can also be configured to limit the rate at which a client host submits
30986 MAIL and RCPT commands in a single SMTP session. See the
30987 &%smtp_ratelimit_hosts%& option.
30988
30989
30990
30991 .section "Unrecognized SMTP commands" "SECID234"
30992 .cindex "SMTP" "unrecognized commands"
30993 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
30994 commands during a single SMTP connection, it drops the connection after sending
30995 the error response to the last command. The default value for
30996 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
30997 abuse that subvert web servers into making connections to SMTP ports; in these
30998 circumstances, a number of non-SMTP lines are sent first.
30999
31000
31001 .section "Syntax and protocol errors in SMTP commands" "SECID235"
31002 .cindex "SMTP" "syntax errors"
31003 .cindex "SMTP" "protocol errors"
31004 A syntax error is detected if an SMTP command is recognized, but there is
31005 something syntactically wrong with its data, for example, a malformed email
31006 address in a RCPT command. Protocol errors include invalid command
31007 sequencing such as RCPT before MAIL. If Exim receives more than
31008 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
31009 drops the connection after sending the error response to the last command. The
31010 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
31011 broken clients that loop sending bad commands (yes, it has been seen).
31012
31013
31014
31015 .section "Use of non-mail SMTP commands" "SECID236"
31016 .cindex "SMTP" "non-mail commands"
31017 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
31018 DATA. Exim counts such commands, and drops the connection if there are too
31019 many of them in a single SMTP session. This action catches some
31020 denial-of-service attempts and things like repeated failing AUTHs, or a mad
31021 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
31022 defines what &"too many"& means. Its default value is 10.
31023
31024 When a new message is expected, one occurrence of RSET is not counted. This
31025 allows a client to send one RSET between messages (this is not necessary,
31026 but some clients do it). Exim also allows one uncounted occurrence of HELO
31027 or EHLO, and one occurrence of STARTTLS between messages. After
31028 starting up a TLS session, another EHLO is expected, and so it too is not
31029 counted.
31030
31031 The first occurrence of AUTH in a connection, or immediately following
31032 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
31033 RCPT, DATA, and QUIT are counted.
31034
31035 You can control which hosts are subject to the limit set by
31036 &%smtp_accept_max_nonmail%& by setting
31037 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
31038 the limit apply to all hosts. This option means that you can exclude any
31039 specific badly-behaved hosts that you have to live with.
31040
31041
31042
31043
31044 .section "The VRFY and EXPN commands" "SECID237"
31045 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
31046 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
31047 appropriate) in order to decide whether the command should be accepted or not.
31048 If no ACL is defined, the command is rejected.
31049
31050 .cindex "VRFY" "processing"
31051 When VRFY is accepted, it runs exactly the same code as when Exim is
31052 called with the &%-bv%& option.
31053
31054 .cindex "EXPN" "processing"
31055 When EXPN is accepted, a single-level expansion of the address is done.
31056 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
31057 than a verification (the &%-bv%& option). If an unqualified local part is given
31058 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
31059 of VRFY and EXPN commands are logged on the main and reject logs, and
31060 VRFY verification failures are logged on the main log for consistency with
31061 RCPT failures.
31062
31063
31064
31065 .section "The ETRN command" "SECTETRN"
31066 .cindex "ETRN" "processing"
31067 RFC 1985 describes an SMTP command called ETRN that is designed to
31068 overcome the security problems of the TURN command (which has fallen into
31069 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
31070 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
31071 should be accepted or not. If no ACL is defined, the command is rejected.
31072
31073 The ETRN command is concerned with &"releasing"& messages that are awaiting
31074 delivery to certain hosts. As Exim does not organize its message queue by host,
31075 the only form of ETRN that is supported by default is the one where the
31076 text starts with the &"#"& prefix, in which case the remainder of the text is
31077 specific to the SMTP server. A valid ETRN command causes a run of Exim with
31078 the &%-R%& option to happen, with the remainder of the ETRN text as its
31079 argument. For example,
31080 .code
31081 ETRN #brigadoon
31082 .endd
31083 runs the command
31084 .code
31085 exim -R brigadoon
31086 .endd
31087 which causes a delivery attempt on all messages with undelivered addresses
31088 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
31089 default), Exim prevents the simultaneous execution of more than one queue run
31090 for the same argument string as a result of an ETRN command. This stops
31091 a misbehaving client from starting more than one queue runner at once.
31092
31093 .cindex "hints database" "ETRN serialization"
31094 Exim implements the serialization by means of a hints database in which a
31095 record is written whenever a process is started by ETRN, and deleted when
31096 the process completes. However, Exim does not keep the SMTP session waiting for
31097 the ETRN process to complete. Once ETRN is accepted, the client is sent
31098 a &"success"& return code. Obviously there is scope for hints records to get
31099 left lying around if there is a system or program crash. To guard against this,
31100 Exim ignores any records that are more than six hours old.
31101
31102 .oindex "&%smtp_etrn_command%&"
31103 For more control over what ETRN does, the &%smtp_etrn_command%& option can
31104 used. This specifies a command that is run whenever ETRN is received,
31105 whatever the form of its argument. For
31106 example:
31107 .code
31108 smtp_etrn_command = /etc/etrn_command $domain \
31109                     $sender_host_address
31110 .endd
31111 .vindex "&$domain$&"
31112 The string is split up into arguments which are independently expanded. The
31113 expansion variable &$domain$& is set to the argument of the ETRN command,
31114 and no syntax checking is done on the contents of this argument. Exim does not
31115 wait for the command to complete, so its status code is not checked. Exim runs
31116 under its own uid and gid when receiving incoming SMTP, so it is not possible
31117 for it to change them before running the command.
31118
31119
31120
31121 .section "Incoming local SMTP" "SECID238"
31122 .cindex "SMTP" "local incoming"
31123 Some user agents use SMTP to pass messages to their local MTA using the
31124 standard input and output, as opposed to passing the envelope on the command
31125 line and writing the message to the standard input. This is supported by the
31126 &%-bs%& option. This form of SMTP is handled in the same way as incoming
31127 messages over TCP/IP (including the use of ACLs), except that the envelope
31128 sender given in a MAIL command is ignored unless the caller is trusted. In
31129 an ACL you can detect this form of SMTP input by testing for an empty host
31130 identification. It is common to have this as the first line in the ACL that
31131 runs for RCPT commands:
31132 .code
31133 accept hosts = :
31134 .endd
31135 This accepts SMTP messages from local processes without doing any other tests.
31136
31137
31138
31139 .section "Outgoing batched SMTP" "SECTbatchSMTP"
31140 .cindex "SMTP" "batched outgoing"
31141 .cindex "batched SMTP output"
31142 Both the &(appendfile)& and &(pipe)& transports can be used for handling
31143 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
31144 be output in BSMTP format. No SMTP responses are possible for this form of
31145 delivery. All it is doing is using SMTP commands as a way of transmitting the
31146 envelope along with the message.
31147
31148 The message is written to the file or pipe preceded by the SMTP commands
31149 MAIL and RCPT, and followed by a line containing a single dot. Lines in
31150 the message that start with a dot have an extra dot added. The SMTP command
31151 HELO is not normally used. If it is required, the &%message_prefix%& option
31152 can be used to specify it.
31153
31154 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
31155 one recipient address at a time by default. However, you can arrange for them
31156 to handle several addresses at once by setting the &%batch_max%& option. When
31157 this is done for BSMTP, messages may contain multiple RCPT commands. See
31158 chapter &<<CHAPbatching>>& for more details.
31159
31160 .vindex "&$host$&"
31161 When one or more addresses are routed to a BSMTP transport by a router that
31162 sets up a host list, the name of the first host on the list is available to the
31163 transport in the variable &$host$&. Here is an example of such a transport and
31164 router:
31165 .code
31166 begin routers
31167 route_append:
31168   driver = manualroute
31169   transport = smtp_appendfile
31170   route_list = domain.example  batch.host.example
31171
31172 begin transports
31173 smtp_appendfile:
31174   driver = appendfile
31175   directory = /var/bsmtp/$host
31176   batch_max = 1000
31177   use_bsmtp
31178   user = exim
31179 .endd
31180 This causes messages addressed to &'domain.example'& to be written in BSMTP
31181 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
31182 message (unless there are more than 1000 recipients).
31183
31184
31185
31186 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
31187 .cindex "SMTP" "batched incoming"
31188 .cindex "batched SMTP input"
31189 The &%-bS%& command line option causes Exim to accept one or more messages by
31190 reading SMTP on the standard input, but to generate no responses. If the caller
31191 is trusted, the senders in the MAIL commands are believed; otherwise the
31192 sender is always the caller of Exim. Unqualified senders and receivers are not
31193 rejected (there seems little point) but instead just get qualified. HELO
31194 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
31195 as NOOP; QUIT quits.
31196
31197 .new
31198 Minimal policy checking is done for BSMTP input. Only the non-SMTP
31199 ACL is run in the same way as for non-SMTP local input.
31200 .wen
31201 If an error is detected while reading a message, including a missing &"."& at
31202 the end, Exim gives up immediately. It writes details of the error to the
31203 standard output in a stylized way that the calling program should be able to
31204 make some use of automatically, for example:
31205 .code
31206 554 Unexpected end of file
31207 Transaction started in line 10
31208 Error detected in line 14
31209 .endd
31210 It writes a more verbose version, for human consumption, to the standard error
31211 file, for example:
31212 .code
31213 An error was detected while processing a file of BSMTP input.
31214 The error message was:
31215
31216 501 '>' missing at end of address
31217
31218 The SMTP transaction started in line 10.
31219 The error was detected in line 12.
31220 The SMTP command at fault was:
31221
31222 rcpt to:<malformed@in.com.plete
31223
31224 1 previous message was successfully processed.
31225 The rest of the batch was abandoned.
31226 .endd
31227 The return code from Exim is zero only if there were no errors. It is 1 if some
31228 messages were accepted before an error was detected, and 2 if no messages were
31229 accepted.
31230 .ecindex IIDsmtpproc1
31231 .ecindex IIDsmtpproc2
31232
31233
31234
31235 . ////////////////////////////////////////////////////////////////////////////
31236 . ////////////////////////////////////////////////////////////////////////////
31237
31238 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
31239          "Customizing messages"
31240 When a message fails to be delivered, or remains on the queue for more than a
31241 configured amount of time, Exim sends a message to the original sender, or
31242 to an alternative configured address. The text of these messages is built into
31243 the code of Exim, but it is possible to change it, either by adding a single
31244 string, or by replacing each of the paragraphs by text supplied in a file.
31245
31246 The &'From:'& and &'To:'& header lines are automatically generated; you can
31247 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
31248 option. Exim also adds the line
31249 .code
31250 Auto-Submitted: auto-generated
31251 .endd
31252 to all warning and bounce messages,
31253
31254
31255 .section "Customizing bounce messages" "SECID239"
31256 .cindex "customizing" "bounce message"
31257 .cindex "bounce message" "customizing"
31258 If &%bounce_message_text%& is set, its contents are included in the default
31259 message immediately after &"This message was created automatically by mail
31260 delivery software."& The string is not expanded. It is not used if
31261 &%bounce_message_file%& is set.
31262
31263 When &%bounce_message_file%& is set, it must point to a template file for
31264 constructing error messages. The file consists of a series of text items,
31265 separated by lines consisting of exactly four asterisks. If the file cannot be
31266 opened, default text is used and a message is written to the main and panic
31267 logs. If any text item in the file is empty, default text is used for that
31268 item.
31269
31270 .vindex "&$bounce_recipient$&"
31271 .vindex "&$bounce_return_size_limit$&"
31272 Each item of text that is read from the file is expanded, and there are two
31273 expansion variables which can be of use here: &$bounce_recipient$& is set to
31274 the recipient of an error message while it is being created, and
31275 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
31276 option, rounded to a whole number.
31277
31278 The items must appear in the file in the following order:
31279
31280 .ilist
31281 The first item is included in the headers, and should include at least a
31282 &'Subject:'& header. Exim does not check the syntax of these headers.
31283 .next
31284 The second item forms the start of the error message. After it, Exim lists the
31285 failing addresses with their error messages.
31286 .next
31287 The third item is used to introduce any text from pipe transports that is to be
31288 returned to the sender. It is omitted if there is no such text.
31289 .next
31290 The fourth item is used to introduce the copy of the message that is returned
31291 as part of the error report.
31292 .next
31293 The fifth item is added after the fourth one if the returned message is
31294 truncated because it is bigger than &%return_size_limit%&.
31295 .next
31296 The sixth item is added after the copy of the original message.
31297 .endlist
31298
31299 The default state (&%bounce_message_file%& unset) is equivalent to the
31300 following file, in which the sixth item is empty. The &'Subject:'& and some
31301 other lines have been split in order to fit them on the page:
31302 .code
31303 Subject: Mail delivery failed
31304   ${if eq{$sender_address}{$bounce_recipient}
31305   {: returning message to sender}}
31306 ****
31307 This message was created automatically by mail delivery software.
31308
31309 A message ${if eq{$sender_address}{$bounce_recipient}
31310   {that you sent }{sent by
31311
31312 <$sender_address>
31313
31314 }}could not be delivered to all of its recipients.
31315 This is a permanent error. The following address(es) failed:
31316 ****
31317 The following text was generated during the delivery attempt(s):
31318 ****
31319 ------ This is a copy of the message, including all the headers.
31320   ------
31321 ****
31322 ------ The body of the message is $message_size characters long;
31323   only the first
31324 ------ $bounce_return_size_limit or so are included here.
31325 ****
31326 .endd
31327 .section "Customizing warning messages" "SECTcustwarn"
31328 .cindex "customizing" "warning message"
31329 .cindex "warning of delay" "customizing the message"
31330 The option &%warn_message_file%& can be pointed at a template file for use when
31331 warnings about message delays are created. In this case there are only three
31332 text sections:
31333
31334 .ilist
31335 The first item is included in the headers, and should include at least a
31336 &'Subject:'& header. Exim does not check the syntax of these headers.
31337 .next
31338 The second item forms the start of the warning message. After it, Exim lists
31339 the delayed addresses.
31340 .next
31341 The third item then ends the message.
31342 .endlist
31343
31344 The default state is equivalent to the following file, except that some lines
31345 have been split here, in order to fit them on the page:
31346 .code
31347 Subject: Warning: message $message_exim_id delayed
31348   $warn_message_delay
31349 ****
31350 This message was created automatically by mail delivery software.
31351
31352 A message ${if eq{$sender_address}{$warn_message_recipients}
31353 {that you sent }{sent by
31354
31355 <$sender_address>
31356
31357 }}has not been delivered to all of its recipients after
31358 more than $warn_message_delay on the queue on $primary_hostname.
31359
31360 The message identifier is:     $message_exim_id
31361 The subject of the message is: $h_subject
31362 The date of the message is:    $h_date
31363
31364 The following address(es) have not yet been delivered:
31365 ****
31366 No action is required on your part. Delivery attempts will
31367 continue for some time, and this warning may be repeated at
31368 intervals if the message remains undelivered. Eventually the
31369 mail delivery software will give up, and when that happens,
31370 the message will be returned to you.
31371 .endd
31372 .vindex "&$warn_message_delay$&"
31373 .vindex "&$warn_message_recipients$&"
31374 However, in the default state the subject and date lines are omitted if no
31375 appropriate headers exist. During the expansion of this file,
31376 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
31377 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
31378 of recipients for the warning message. There may be more than one if there are
31379 multiple addresses with different &%errors_to%& settings on the routers that
31380 handled them.
31381
31382
31383
31384
31385 . ////////////////////////////////////////////////////////////////////////////
31386 . ////////////////////////////////////////////////////////////////////////////
31387
31388 .chapter "Some common configuration settings" "CHAPcomconreq"
31389 This chapter discusses some configuration settings that seem to be fairly
31390 common. More examples and discussion can be found in the Exim book.
31391
31392
31393
31394 .section "Sending mail to a smart host" "SECID240"
31395 .cindex "smart host" "example router"
31396 If you want to send all mail for non-local domains to a &"smart host"&, you
31397 should replace the default &(dnslookup)& router with a router which does the
31398 routing explicitly:
31399 .code
31400 send_to_smart_host:
31401   driver = manualroute
31402   route_list = !+local_domains smart.host.name
31403   transport = remote_smtp
31404 .endd
31405 You can use the smart host's IP address instead of the name if you wish.
31406 If you are using Exim only to submit messages to a smart host, and not for
31407 receiving incoming messages, you can arrange for it to do the submission
31408 synchronously by setting the &%mua_wrapper%& option (see chapter
31409 &<<CHAPnonqueueing>>&).
31410
31411
31412
31413
31414 .section "Using Exim to handle mailing lists" "SECTmailinglists"
31415 .cindex "mailing lists"
31416 Exim can be used to run simple mailing lists, but for large and/or complicated
31417 requirements, the use of additional specialized mailing list software such as
31418 Majordomo or Mailman is recommended.
31419
31420 The &(redirect)& router can be used to handle mailing lists where each list
31421 is maintained in a separate file, which can therefore be managed by an
31422 independent manager. The &%domains%& router option can be used to run these
31423 lists in a separate domain from normal mail. For example:
31424 .code
31425 lists:
31426   driver = redirect
31427   domains = lists.example
31428   file = /usr/lists/$local_part
31429   forbid_pipe
31430   forbid_file
31431   errors_to = $local_part-request@lists.example
31432   no_more
31433 .endd
31434 This router is skipped for domains other than &'lists.example'&. For addresses
31435 in that domain, it looks for a file that matches the local part. If there is no
31436 such file, the router declines, but because &%no_more%& is set, no subsequent
31437 routers are tried, and so the whole delivery fails.
31438
31439 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
31440 expanded into a file name or a pipe delivery, which is usually inappropriate in
31441 a mailing list.
31442
31443 .oindex "&%errors_to%&"
31444 The &%errors_to%& option specifies that any delivery errors caused by addresses
31445 taken from a mailing list are to be sent to the given address rather than the
31446 original sender of the message. However, before acting on this, Exim verifies
31447 the error address, and ignores it if verification fails.
31448
31449 For example, using the configuration above, mail sent to
31450 &'dicts@lists.example'& is passed on to those addresses contained in
31451 &_/usr/lists/dicts_&, with error reports directed to
31452 &'dicts-request@lists.example'&, provided that this address can be verified.
31453 There could be a file called &_/usr/lists/dicts-request_& containing
31454 the address(es) of this particular list's manager(s), but other approaches,
31455 such as setting up an earlier router (possibly using the &%local_part_prefix%&
31456 or &%local_part_suffix%& options) to handle addresses of the form
31457 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
31458
31459
31460
31461 .section "Syntax errors in mailing lists" "SECID241"
31462 .cindex "mailing lists" "syntax errors in"
31463 If an entry in redirection data contains a syntax error, Exim normally defers
31464 delivery of the original address. That means that a syntax error in a mailing
31465 list holds up all deliveries to the list. This may not be appropriate when a
31466 list is being maintained automatically from data supplied by users, and the
31467 addresses are not rigorously checked.
31468
31469 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
31470 entries that fail to parse, noting the incident in the log. If in addition
31471 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
31472 whenever a broken address is skipped. It is usually appropriate to set
31473 &%syntax_errors_to%& to the same address as &%errors_to%&.
31474
31475
31476
31477 .section "Re-expansion of mailing lists" "SECID242"
31478 .cindex "mailing lists" "re-expansion of"
31479 Exim remembers every individual address to which a message has been delivered,
31480 in order to avoid duplication, but it normally stores only the original
31481 recipient addresses with a message. If all the deliveries to a mailing list
31482 cannot be done at the first attempt, the mailing list is re-expanded when the
31483 delivery is next tried. This means that alterations to the list are taken into
31484 account at each delivery attempt, so addresses that have been added to
31485 the list since the message arrived will therefore receive a copy of the
31486 message, even though it pre-dates their subscription.
31487
31488 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
31489 on the &(redirect)& router. If this is done, any addresses generated by the
31490 router that fail to deliver at the first attempt are added to the message as
31491 &"top level"& addresses, and the parent address that generated them is marked
31492 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
31493 subsequent delivery attempts. The disadvantage of this is that if any of the
31494 failing addresses are incorrect, correcting them in the file has no effect on
31495 pre-existing messages.
31496
31497 The original top-level address is remembered with each of the generated
31498 addresses, and is output in any log messages. However, any intermediate parent
31499 addresses are not recorded. This makes a difference to the log only if the
31500 &%all_parents%& selector is set, but for mailing lists there is normally only
31501 one level of expansion anyway.
31502
31503
31504
31505 .section "Closed mailing lists" "SECID243"
31506 .cindex "mailing lists" "closed"
31507 The examples so far have assumed open mailing lists, to which anybody may
31508 send mail. It is also possible to set up closed lists, where mail is accepted
31509 from specified senders only. This is done by making use of the generic
31510 &%senders%& option to restrict the router that handles the list.
31511
31512 The following example uses the same file as a list of recipients and as a list
31513 of permitted senders. It requires three routers:
31514 .code
31515 lists_request:
31516   driver = redirect
31517   domains = lists.example
31518   local_part_suffix = -request
31519   file = /usr/lists/$local_part$local_part_suffix
31520   no_more
31521
31522 lists_post:
31523   driver = redirect
31524   domains = lists.example
31525   senders = ${if exists {/usr/lists/$local_part}\
31526              {lsearch;/usr/lists/$local_part}{*}}
31527   file = /usr/lists/$local_part
31528   forbid_pipe
31529   forbid_file
31530   errors_to = $local_part-request@lists.example
31531   no_more
31532
31533 lists_closed:
31534   driver = redirect
31535   domains = lists.example
31536   allow_fail
31537   data = :fail: $local_part@lists.example is a closed mailing list
31538 .endd
31539 All three routers have the same &%domains%& setting, so for any other domains,
31540 they are all skipped. The first router runs only if the local part ends in
31541 &%-request%&. It handles messages to the list manager(s) by means of an open
31542 mailing list.
31543
31544 The second router runs only if the &%senders%& precondition is satisfied. It
31545 checks for the existence of a list that corresponds to the local part, and then
31546 checks that the sender is on the list by means of a linear search. It is
31547 necessary to check for the existence of the file before trying to search it,
31548 because otherwise Exim thinks there is a configuration error. If the file does
31549 not exist, the expansion of &%senders%& is *, which matches all senders. This
31550 means that the router runs, but because there is no list, declines, and
31551 &%no_more%& ensures that no further routers are run. The address fails with an
31552 &"unrouteable address"& error.
31553
31554 The third router runs only if the second router is skipped, which happens when
31555 a mailing list exists, but the sender is not on it. This router forcibly fails
31556 the address, giving a suitable error message.
31557
31558
31559
31560
31561 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
31562 .cindex "VERP"
31563 .cindex "Variable Envelope Return Paths"
31564 .cindex "envelope sender"
31565 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
31566 are a way of helping mailing list administrators discover which subscription
31567 address is the cause of a particular delivery failure. The idea is to encode
31568 the original recipient address in the outgoing envelope sender address, so that
31569 if the message is forwarded by another host and then subsequently bounces, the
31570 original recipient can be extracted from the recipient address of the bounce.
31571
31572 .oindex &%errors_to%&
31573 .oindex &%return_path%&
31574 Envelope sender addresses can be modified by Exim using two different
31575 facilities: the &%errors_to%& option on a router (as shown in previous mailing
31576 list examples), or the &%return_path%& option on a transport. The second of
31577 these is effective only if the message is successfully delivered to another
31578 host; it is not used for errors detected on the local host (see the description
31579 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
31580 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
31581 .code
31582 verp_smtp:
31583   driver = smtp
31584   max_rcpt = 1
31585   return_path = \
31586     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
31587       {$1-request+$local_part=$domain@your.dom.example}fail}
31588 .endd
31589 This has the effect of rewriting the return path (envelope sender) on outgoing
31590 SMTP messages, if the local part of the original return path ends in
31591 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
31592 local part and domain of the recipient into the return path. Suppose, for
31593 example, that a message whose return path has been set to
31594 &'somelist-request@your.dom.example'& is sent to
31595 &'subscriber@other.dom.example'&. In the transport, the return path is
31596 rewritten as
31597 .code
31598 somelist-request+subscriber=other.dom.example@your.dom.example
31599 .endd
31600 .vindex "&$local_part$&"
31601 For this to work, you must tell Exim to send multiple copies of messages that
31602 have more than one recipient, so that each copy has just one recipient. This is
31603 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
31604 might be sent to several different recipients in the same domain, in which case
31605 &$local_part$& is not available in the transport, because it is not unique.
31606
31607 Unless your host is doing nothing but mailing list deliveries, you should
31608 probably use a separate transport for the VERP deliveries, so as not to use
31609 extra resources in making one-per-recipient copies for other deliveries. This
31610 can easily be done by expanding the &%transport%& option in the router:
31611 .code
31612 dnslookup:
31613   driver = dnslookup
31614   domains = ! +local_domains
31615   transport = \
31616     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
31617       {verp_smtp}{remote_smtp}}
31618   no_more
31619 .endd
31620 If you want to change the return path using &%errors_to%& in a router instead
31621 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
31622 routers that handle mailing list addresses. This will ensure that all delivery
31623 errors, including those detected on the local host, are sent to the VERP
31624 address.
31625
31626 On a host that does no local deliveries and has no manual routing, only the
31627 &(dnslookup)& router needs to be changed. A special transport is not needed for
31628 SMTP deliveries. Every mailing list recipient has its own return path value,
31629 and so Exim must hand them to the transport one at a time. Here is an example
31630 of a &(dnslookup)& router that implements VERP:
31631 .code
31632 verp_dnslookup:
31633   driver = dnslookup
31634   domains = ! +local_domains
31635   transport = remote_smtp
31636   errors_to = \
31637     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
31638      {$1-request+$local_part=$domain@your.dom.example}fail}
31639   no_more
31640 .endd
31641 Before you start sending out messages with VERPed return paths, you must also
31642 configure Exim to accept the bounce messages that come back to those paths.
31643 Typically this is done by setting a &%local_part_suffix%& option for a
31644 router, and using this to route the messages to wherever you want to handle
31645 them.
31646
31647 The overhead incurred in using VERP depends very much on the size of the
31648 message, the number of recipient addresses that resolve to the same remote
31649 host, and the speed of the connection over which the message is being sent. If
31650 a lot of addresses resolve to the same host and the connection is slow, sending
31651 a separate copy of the message for each address may take substantially longer
31652 than sending a single copy with many recipients (for which VERP cannot be
31653 used).
31654
31655
31656
31657
31658
31659
31660 .section "Virtual domains" "SECTvirtualdomains"
31661 .cindex "virtual domains"
31662 .cindex "domain" "virtual"
31663 The phrase &'virtual domain'& is unfortunately used with two rather different
31664 meanings:
31665
31666 .ilist
31667 A domain for which there are no real mailboxes; all valid local parts are
31668 aliases for other email addresses. Common examples are organizational
31669 top-level domains and &"vanity"& domains.
31670 .next
31671 One of a number of independent domains that are all handled by the same host,
31672 with mailboxes on that host, but where the mailbox owners do not necessarily
31673 have login accounts on that host.
31674 .endlist
31675
31676 The first usage is probably more common, and does seem more &"virtual"& than
31677 the second. This kind of domain can be handled in Exim with a straightforward
31678 aliasing router. One approach is to create a separate alias file for each
31679 virtual domain. Exim can test for the existence of the alias file to determine
31680 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
31681 to a router of this form:
31682 .code
31683 virtual:
31684   driver = redirect
31685   domains = dsearch;/etc/mail/virtual
31686   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
31687   no_more
31688 .endd
31689 The &%domains%& option specifies that the router is to be skipped, unless there
31690 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
31691 domain that is being processed. When the router runs, it looks up the local
31692 part in the file to find a new address (or list of addresses). The &%no_more%&
31693 setting ensures that if the lookup fails (leading to &%data%& being an empty
31694 string), Exim gives up on the address without trying any subsequent routers.
31695
31696 This one router can handle all the virtual domains because the alias file names
31697 follow a fixed pattern. Permissions can be arranged so that appropriate people
31698 can edit the different alias files. A successful aliasing operation results in
31699 a new envelope recipient address, which is then routed from scratch.
31700
31701 The other kind of &"virtual"& domain can also be handled in a straightforward
31702 way. One approach is to create a file for each domain containing a list of
31703 valid local parts, and use it in a router like this:
31704 .code
31705 my_domains:
31706   driver = accept
31707   domains = dsearch;/etc/mail/domains
31708   local_parts = lsearch;/etc/mail/domains/$domain
31709   transport = my_mailboxes
31710 .endd
31711 The address is accepted if there is a file for the domain, and the local part
31712 can be found in the file. The &%domains%& option is used to check for the
31713 file's existence because &%domains%& is tested before the &%local_parts%&
31714 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
31715 because that option is tested after &%local_parts%&. The transport is as
31716 follows:
31717 .code
31718 my_mailboxes:
31719   driver = appendfile
31720   file = /var/mail/$domain/$local_part
31721   user = mail
31722 .endd
31723 This uses a directory of mailboxes for each domain. The &%user%& setting is
31724 required, to specify which uid is to be used for writing to the mailboxes.
31725
31726 The configuration shown here is just one example of how you might support this
31727 requirement. There are many other ways this kind of configuration can be set
31728 up, for example, by using a database instead of separate files to hold all the
31729 information about the domains.
31730
31731
31732
31733 .section "Multiple user mailboxes" "SECTmulbox"
31734 .cindex "multiple mailboxes"
31735 .cindex "mailbox" "multiple"
31736 .cindex "local part" "prefix"
31737 .cindex "local part" "suffix"
31738 Heavy email users often want to operate with multiple mailboxes, into which
31739 incoming mail is automatically sorted. A popular way of handling this is to
31740 allow users to use multiple sender addresses, so that replies can easily be
31741 identified. Users are permitted to add prefixes or suffixes to their local
31742 parts for this purpose. The wildcard facility of the generic router options
31743 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
31744 example, consider this router:
31745 .code
31746 userforward:
31747   driver = redirect
31748   check_local_user
31749   file = $home/.forward
31750   local_part_suffix = -*
31751   local_part_suffix_optional
31752   allow_filter
31753 .endd
31754 .vindex "&$local_part_suffix$&"
31755 It runs a user's &_.forward_& file for all local parts of the form
31756 &'username-*'&. Within the filter file the user can distinguish different
31757 cases by testing the variable &$local_part_suffix$&. For example:
31758 .code
31759 if $local_part_suffix contains -special then
31760 save /home/$local_part/Mail/special
31761 endif
31762 .endd
31763 If the filter file does not exist, or does not deal with such addresses, they
31764 fall through to subsequent routers, and, assuming no subsequent use of the
31765 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
31766 control over which suffixes are valid.
31767
31768 Alternatively, a suffix can be used to trigger the use of a different
31769 &_.forward_& file &-- which is the way a similar facility is implemented in
31770 another MTA:
31771 .code
31772 userforward:
31773   driver = redirect
31774   check_local_user
31775   file = $home/.forward$local_part_suffix
31776   local_part_suffix = -*
31777   local_part_suffix_optional
31778   allow_filter
31779 .endd
31780 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
31781 example, &_.forward-special_& is used. Once again, if the appropriate file
31782 does not exist, or does not deal with the address, it is passed on to
31783 subsequent routers, which could, if required, look for an unqualified
31784 &_.forward_& file to use as a default.
31785
31786
31787
31788 .section "Simplified vacation processing" "SECID244"
31789 .cindex "vacation processing"
31790 The traditional way of running the &'vacation'& program is for a user to set up
31791 a pipe command in a &_.forward_& file
31792 (see section &<<SECTspecitredli>>& for syntax details).
31793 This is prone to error by inexperienced users. There are two features of Exim
31794 that can be used to make this process simpler for users:
31795
31796 .ilist
31797 A local part prefix such as &"vacation-"& can be specified on a router which
31798 can cause the message to be delivered directly to the &'vacation'& program, or
31799 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
31800 &_.forward_& file are then much simpler. For example:
31801 .code
31802 spqr, vacation-spqr
31803 .endd
31804 .next
31805 The &%require_files%& generic router option can be used to trigger a
31806 vacation delivery by checking for the existence of a certain file in the
31807 user's home directory. The &%unseen%& generic option should also be used, to
31808 ensure that the original delivery also proceeds. In this case, all the user has
31809 to do is to create a file called, say, &_.vacation_&, containing a vacation
31810 message.
31811 .endlist
31812
31813 Another advantage of both these methods is that they both work even when the
31814 use of arbitrary pipes by users is locked out.
31815
31816
31817
31818 .section "Taking copies of mail" "SECID245"
31819 .cindex "message" "copying every"
31820 Some installations have policies that require archive copies of all messages to
31821 be made. A single copy of each message can easily be taken by an appropriate
31822 command in a system filter, which could, for example, use a different file for
31823 each day's messages.
31824
31825 There is also a shadow transport mechanism that can be used to take copies of
31826 messages that are successfully delivered by local transports, one copy per
31827 delivery. This could be used, &'inter alia'&, to implement automatic
31828 notification of delivery by sites that insist on doing such things.
31829
31830
31831
31832 .section "Intermittently connected hosts" "SECID246"
31833 .cindex "intermittently connected hosts"
31834 It has become quite common (because it is cheaper) for hosts to connect to the
31835 Internet periodically rather than remain connected all the time. The normal
31836 arrangement is that mail for such hosts accumulates on a system that is
31837 permanently connected.
31838
31839 Exim was designed for use on permanently connected hosts, and so it is not
31840 particularly well-suited to use in an intermittently connected environment.
31841 Nevertheless there are some features that can be used.
31842
31843
31844 .section "Exim on the upstream server host" "SECID247"
31845 It is tempting to arrange for incoming mail for the intermittently connected
31846 host to remain on Exim's queue until the client connects. However, this
31847 approach does not scale very well. Two different kinds of waiting message are
31848 being mixed up in the same queue &-- those that cannot be delivered because of
31849 some temporary problem, and those that are waiting for their destination host
31850 to connect. This makes it hard to manage the queue, as well as wasting
31851 resources, because each queue runner scans the entire queue.
31852
31853 A better approach is to separate off those messages that are waiting for an
31854 intermittently connected host. This can be done by delivering these messages
31855 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
31856 format, from where they are transmitted by other software when their
31857 destination connects. This makes it easy to collect all the mail for one host
31858 in a single directory, and to apply local timeout rules on a per-message basis
31859 if required.
31860
31861 On a very small scale, leaving the mail on Exim's queue can be made to work. If
31862 you are doing this, you should configure Exim with a long retry period for the
31863 intermittent host. For example:
31864 .code
31865 cheshire.wonderland.fict.example    *   F,5d,24h
31866 .endd
31867 This stops a lot of failed delivery attempts from occurring, but Exim remembers
31868 which messages it has queued up for that host. Once the intermittent host comes
31869 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
31870 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
31871 causes all the queued up messages to be delivered, often down a single SMTP
31872 connection. While the host remains connected, any new messages get delivered
31873 immediately.
31874
31875 If the connecting hosts do not have fixed IP addresses, that is, if a host is
31876 issued with a different IP address each time it connects, Exim's retry
31877 mechanisms on the holding host get confused, because the IP address is normally
31878 used as part of the key string for holding retry information. This can be
31879 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
31880 Since this has disadvantages for permanently connected hosts, it is best to
31881 arrange a separate transport for the intermittently connected ones.
31882
31883
31884
31885 .section "Exim on the intermittently connected client host" "SECID248"
31886 The value of &%smtp_accept_queue_per_connection%& should probably be
31887 increased, or even set to zero (that is, disabled) on the intermittently
31888 connected host, so that all incoming messages down a single connection get
31889 delivered immediately.
31890
31891 .cindex "SMTP" "passed connection"
31892 .cindex "SMTP" "multiple deliveries"
31893 .cindex "multiple SMTP deliveries"
31894 Mail waiting to be sent from an intermittently connected host will probably
31895 not have been routed, because without a connection DNS lookups are not
31896 possible. This means that if a normal queue run is done at connection time,
31897 each message is likely to be sent in a separate SMTP session. This can be
31898 avoided by starting the queue run with a command line option beginning with
31899 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
31900 first pass, routing is done but no deliveries take place. The second pass is a
31901 normal queue run; since all the messages have been previously routed, those
31902 destined for the same host are likely to get sent as multiple deliveries in a
31903 single SMTP connection.
31904
31905
31906
31907 . ////////////////////////////////////////////////////////////////////////////
31908 . ////////////////////////////////////////////////////////////////////////////
31909
31910 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
31911          "Exim as a non-queueing client"
31912 .cindex "client, non-queueing"
31913 .cindex "smart host" "suppressing queueing"
31914 On a personal computer, it is a common requirement for all
31915 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
31916 configured to operate that way, for all the popular operating systems.
31917 However, there are some MUAs for Unix-like systems that cannot be so
31918 configured: they submit messages using the command line interface of
31919 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
31920 messages this way.
31921
31922 If the personal computer runs continuously, there is no problem, because it can
31923 run a conventional MTA that handles delivery to the smart host, and deal with
31924 any delays via its queueing mechanism. However, if the computer does not run
31925 continuously or runs different operating systems at different times, queueing
31926 email is not desirable.
31927
31928 There is therefore a requirement for something that can provide the
31929 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
31930 any queueing or retrying facilities. Furthermore, the delivery to the smart
31931 host should be synchronous, so that if it fails, the sending MUA is immediately
31932 informed. In other words, we want something that extends an MUA that submits
31933 to a local MTA via the command line so that it behaves like one that submits
31934 to a remote smart host using TCP/SMTP.
31935
31936 There are a number of applications (for example, there is one called &'ssmtp'&)
31937 that do this job. However, people have found them to be lacking in various
31938 ways. For instance, you might want to allow aliasing and forwarding to be done
31939 before sending a message to the smart host.
31940
31941 Exim already had the necessary infrastructure for doing this job. Just a few
31942 tweaks were needed to make it behave as required, though it is somewhat of an
31943 overkill to use a fully-featured MTA for this purpose.
31944
31945 .oindex "&%mua_wrapper%&"
31946 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
31947 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
31948 assumes that it is being used to &"wrap"& a command-line MUA in the manner
31949 just described. As well as setting &%mua_wrapper%&, you also need to provide a
31950 compatible router and transport configuration. Typically there will be just one
31951 router and one transport, sending everything to a smart host.
31952
31953 When run in MUA wrapping mode, the behaviour of Exim changes in the
31954 following ways:
31955
31956 .ilist
31957 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
31958 In other words, the only way to submit messages is via the command line.
31959 .next
31960 Each message is synchronously delivered as soon as it is received (&%-odi%& is
31961 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
31962 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
31963 does not finish until the delivery attempt is complete. If the delivery is
31964 successful, a zero return code is given.
31965 .next
31966 Address redirection is permitted, but the final routing for all addresses must
31967 be to the same remote transport, and to the same list of hosts. Furthermore,
31968 the return address (envelope sender) must be the same for all recipients, as
31969 must any added or deleted header lines. In other words, it must be possible to
31970 deliver the message in a single SMTP transaction, however many recipients there
31971 are.
31972 .next
31973 If these conditions are not met, or if routing any address results in a
31974 failure or defer status, or if Exim is unable to deliver all the recipients
31975 successfully to one of the smart hosts, delivery of the entire message fails.
31976 .next
31977 Because no queueing is allowed, all failures are treated as permanent; there
31978 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
31979 smart host. Furthermore, because only a single yes/no response can be given to
31980 the caller, it is not possible to deliver to some recipients and not others. If
31981 there is an error (temporary or permanent) for any recipient, all are failed.
31982 .next
31983 If more than one smart host is listed, Exim will try another host after a
31984 connection failure or a timeout, in the normal way. However, if this kind of
31985 failure happens for all the hosts, the delivery fails.
31986 .next
31987 When delivery fails, an error message is written to the standard error stream
31988 (as well as to Exim's log), and Exim exits to the caller with a return code
31989 value 1. The message is expunged from Exim's spool files. No bounce messages
31990 are ever generated.
31991 .next
31992 No retry data is maintained, and any retry rules are ignored.
31993 .next
31994 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
31995 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
31996 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
31997 .endlist
31998
31999 The overall effect is that Exim makes a single synchronous attempt to deliver
32000 the message, failing if there is any kind of problem. Because no local
32001 deliveries are done and no daemon can be run, Exim does not need root
32002 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
32003 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
32004 the advantages and disadvantages of running without root privilege.
32005
32006
32007
32008
32009 . ////////////////////////////////////////////////////////////////////////////
32010 . ////////////////////////////////////////////////////////////////////////////
32011
32012 .chapter "Log files" "CHAPlog"
32013 .scindex IIDloggen "log" "general description"
32014 .cindex "log" "types of"
32015 Exim writes three different logs, referred to as the main log, the reject log,
32016 and the panic log:
32017
32018 .ilist
32019 .cindex "main log"
32020 The main log records the arrival of each message and each delivery in a single
32021 line in each case. The format is as compact as possible, in an attempt to keep
32022 down the size of log files. Two-character flag sequences make it easy to pick
32023 out these lines. A number of other events are recorded in the main log. Some of
32024 them are optional, in which case the &%log_selector%& option controls whether
32025 they are included or not. A Perl script called &'eximstats'&, which does simple
32026 analysis of main log files, is provided in the Exim distribution (see section
32027 &<<SECTmailstat>>&).
32028 .next
32029 .cindex "reject log"
32030 The reject log records information from messages that are rejected as a result
32031 of a configuration option (that is, for policy reasons).
32032 The first line of each rejection is a copy of the line that is also written to
32033 the main log. Then, if the message's header has been read at the time the log
32034 is written, its contents are written to this log. Only the original header
32035 lines are available; header lines added by ACLs are not logged. You can use the
32036 reject log to check that your policy controls are working correctly; on a busy
32037 host this may be easier than scanning the main log for rejection messages. You
32038 can suppress the writing of the reject log by setting &%write_rejectlog%&
32039 false.
32040 .next
32041 .cindex "panic log"
32042 .cindex "system log"
32043 When certain serious errors occur, Exim writes entries to its panic log. If the
32044 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
32045 are usually written to the main log as well, but can get lost amid the mass of
32046 other entries. The panic log should be empty under normal circumstances. It is
32047 therefore a good idea to check it (or to have a &'cron'& script check it)
32048 regularly, in order to become aware of any problems. When Exim cannot open its
32049 panic log, it tries as a last resort to write to the system log (syslog). This
32050 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
32051 message itself is written at priority LOG_CRIT.
32052 .endlist
32053
32054 Every log line starts with a timestamp, in the format shown in the following
32055 example. Note that many of the examples shown in this chapter are line-wrapped.
32056 In the log file, this would be all on one line:
32057 .code
32058 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
32059   by QUIT
32060 .endd
32061 By default, the timestamps are in the local timezone. There are two
32062 ways of changing this:
32063
32064 .ilist
32065 You can set the &%timezone%& option to a different time zone; in particular, if
32066 you set
32067 .code
32068 timezone = UTC
32069 .endd
32070 the timestamps will be in UTC (aka GMT).
32071 .next
32072 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
32073 example:
32074 .code
32075 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
32076 .endd
32077 .endlist
32078
32079 .cindex "log" "process ids in"
32080 .cindex "pid (process id)" "in log lines"
32081 Exim does not include its process id in log lines by default, but you can
32082 request that it does so by specifying the &`pid`& log selector (see section
32083 &<<SECTlogselector>>&). When this is set, the process id is output, in square
32084 brackets, immediately after the time and date.
32085
32086
32087
32088
32089 .section "Where the logs are written" "SECTwhelogwri"
32090 .cindex "log" "destination"
32091 .cindex "log" "to file"
32092 .cindex "log" "to syslog"
32093 .cindex "syslog"
32094 The logs may be written to local files, or to syslog, or both. However, it
32095 should be noted that many syslog implementations use UDP as a transport, and
32096 are therefore unreliable in the sense that messages are not guaranteed to
32097 arrive at the loghost, nor is the ordering of messages necessarily maintained.
32098 It has also been reported that on large log files (tens of megabytes) you may
32099 need to tweak syslog to prevent it syncing the file with each write &-- on
32100 Linux this has been seen to make syslog take 90% plus of CPU time.
32101
32102 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
32103 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
32104 configuration. This latter string is expanded, so it can contain, for example,
32105 references to the host name:
32106 .code
32107 log_file_path = /var/log/$primary_hostname/exim_%slog
32108 .endd
32109 It is generally advisable, however, to set the string in &_Local/Makefile_&
32110 rather than at run time, because then the setting is available right from the
32111 start of Exim's execution. Otherwise, if there's something it wants to log
32112 before it has read the configuration file (for example, an error in the
32113 configuration file) it will not use the path you want, and may not be able to
32114 log at all.
32115
32116 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
32117 list, currently limited to at most two items. This is one option where the
32118 facility for changing a list separator may not be used. The list must always be
32119 colon-separated. If an item in the list is &"syslog"& then syslog is used;
32120 otherwise the item must either be an absolute path, containing &`%s`& at the
32121 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
32122 implying the use of a default path.
32123
32124 When Exim encounters an empty item in the list, it searches the list defined by
32125 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
32126 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
32127 mean &"use the path specified at build time"&. It no such item exists, log
32128 files are written in the &_log_& subdirectory of the spool directory. This is
32129 equivalent to the setting:
32130 .code
32131 log_file_path = $spool_directory/log/%slog
32132 .endd
32133 If you do not specify anything at build time or run time, that is where the
32134 logs are written.
32135
32136 .new
32137 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
32138 are in use &-- see section &<<SECTdatlogfil>>& below.
32139 .wen
32140
32141 Here are some examples of possible settings:
32142 .display
32143 &`LOG_FILE_PATH=syslog                    `& syslog only
32144 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
32145 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
32146 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
32147 .endd
32148 If there are more than two paths in the list, the first is used and a panic
32149 error is logged.
32150
32151
32152
32153 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
32154 .cindex "log" "cycling local files"
32155 .cindex "cycling logs"
32156 .cindex "&'exicyclog'&"
32157 .cindex "log" "local files; writing to"
32158 Some operating systems provide centralized and standardized methods for cycling
32159 log files. For those that do not, a utility script called &'exicyclog'& is
32160 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
32161 main and reject logs each time it is called. The maximum number of old logs to
32162 keep can be set. It is suggested this script is run as a daily &'cron'& job.
32163
32164 An Exim delivery process opens the main log when it first needs to write to it,
32165 and it keeps the file open in case subsequent entries are required &-- for
32166 example, if a number of different deliveries are being done for the same
32167 message. However, remote SMTP deliveries can take a long time, and this means
32168 that the file may be kept open long after it is renamed if &'exicyclog'& or
32169 something similar is being used to rename log files on a regular basis. To
32170 ensure that a switch of log files is noticed as soon as possible, Exim calls
32171 &[stat()]& on the main log's name before reusing an open file, and if the file
32172 does not exist, or its inode has changed, the old file is closed and Exim
32173 tries to open the main log from scratch. Thus, an old log file may remain open
32174 for quite some time, but no Exim processes should write to it once it has been
32175 renamed.
32176
32177
32178
32179 .new
32180 .section "Datestamped log files" "SECTdatlogfil"
32181 .cindex "log" "datestamped files"
32182 Instead of cycling the main and reject log files by renaming them
32183 periodically, some sites like to use files whose names contain a datestamp,
32184 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
32185 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
32186 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
32187 point where the datestamp is required. For example:
32188 .code
32189 log_file_path = /var/spool/exim/log/%slog-%D
32190 log_file_path = /var/log/exim-%s-%D.log
32191 log_file_path = /var/spool/exim/log/%D-%slog
32192 log_file_path = /var/log/exim/%s.%M
32193 .endd
32194 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
32195 examples of names generated by the above examples:
32196 .code
32197 /var/spool/exim/log/mainlog-20021225
32198 /var/log/exim-reject-20021225.log
32199 /var/spool/exim/log/20021225-mainlog
32200 /var/log/exim/main.200212
32201 .endd
32202 When this form of log file is specified, Exim automatically switches to new
32203 files at midnight. It does not make any attempt to compress old logs; you
32204 will need to write your own script if you require this. You should not
32205 run &'exicyclog'& with this form of logging.
32206
32207 The location of the panic log is also determined by &%log_file_path%&, but it
32208 is not datestamped, because rotation of the panic log does not make sense.
32209 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
32210 the string. In addition, if it immediately follows a slash, a following
32211 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
32212 character is removed. Thus, the four examples above would give these panic
32213 log names:
32214 .code
32215 /var/spool/exim/log/paniclog
32216 /var/log/exim-panic.log
32217 /var/spool/exim/log/paniclog
32218 /var/log/exim/panic
32219 .endd
32220 .wen
32221
32222
32223 .section "Logging to syslog" "SECID249"
32224 .cindex "log" "syslog; writing to"
32225 The use of syslog does not change what Exim logs or the format of its messages,
32226 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
32227 Exim's log lines are omitted when these lines are sent to syslog. Apart from
32228 that, the same strings are written to syslog as to log files. The syslog
32229 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
32230 by default, but you can change these by setting the &%syslog_facility%& and
32231 &%syslog_processname%& options, respectively. If Exim was compiled with
32232 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
32233 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
32234 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
32235 the time and host name to each line.
32236 The three log streams are mapped onto syslog priorities as follows:
32237
32238 .ilist
32239 &'mainlog'& is mapped to LOG_INFO
32240 .next
32241 &'rejectlog'& is mapped to LOG_NOTICE
32242 .next
32243 &'paniclog'& is mapped to LOG_ALERT
32244 .endlist
32245
32246 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
32247 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
32248 these are routed by syslog to the same place. You can suppress this duplication
32249 by setting &%syslog_duplication%& false.
32250
32251 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
32252 entries contain multiple lines when headers are included. To cope with both
32253 these cases, entries written to syslog are split into separate &[syslog()]&
32254 calls at each internal newline, and also after a maximum of
32255 870 data characters. (This allows for a total syslog line length of 1024, when
32256 additions such as timestamps are added.) If you are running a syslog
32257 replacement that can handle lines longer than the 1024 characters allowed by
32258 RFC 3164, you should set
32259 .code
32260 SYSLOG_LONG_LINES=yes
32261 .endd
32262 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
32263 lines, but it still splits at internal newlines in &'reject'& log entries.
32264
32265 To make it easy to re-assemble split lines later, each component of a split
32266 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
32267 where <&'n'&> is the component number and <&'m'&> is the total number of
32268 components in the entry. The / delimiter is used when the line was split
32269 because it was too long; if it was split because of an internal newline, the \
32270 delimiter is used. For example, supposing the length limit to be 50 instead of
32271 870, the following would be the result of a typical rejection message to
32272 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
32273 name, and pid as added by syslog:
32274 .code
32275 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
32276 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
32277 [3/5]  when scanning for sender: missing or malformed lo
32278 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
32279 [5/5] mple>)
32280 .endd
32281 The same error might cause the following lines to be written to &"rejectlog"&
32282 (LOG_NOTICE):
32283 .code
32284 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
32285 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
32286 [3/18] er when scanning for sender: missing or malformed
32287 [4/18]  local part in "<>" (envelope sender is <ph10@cam
32288 [5\18] .example>)
32289 [6\18] Recipients: ph10@some.domain.cam.example
32290 [7\18] P Received: from [127.0.0.1] (ident=ph10)
32291 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
32292 [9\18]        id 16RdAL-0006pc-00
32293 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
32294 [11\18] 09:43 +0100
32295 [12\18] F From: <>
32296 [13\18]   Subject: this is a test header
32297 [18\18]   X-something: this is another header
32298 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
32299 [16\18] le>
32300 [17\18] B Bcc:
32301 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
32302 .endd
32303 Log lines that are neither too long nor contain newlines are written to syslog
32304 without modification.
32305
32306 If only syslog is being used, the Exim monitor is unable to provide a log tail
32307 display, unless syslog is routing &'mainlog'& to a file on the local host and
32308 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
32309 where it is.
32310
32311
32312
32313 .section "Log line flags" "SECID250"
32314 One line is written to the main log for each message received, and for each
32315 successful, unsuccessful, and delayed delivery. These lines can readily be
32316 picked out by the distinctive two-character flags that immediately follow the
32317 timestamp. The flags are:
32318 .display
32319 &`<=`&     message arrival
32320 &`=>`&     normal message delivery
32321 &`->`&     additional address in same delivery
32322 &`*>`&     delivery suppressed by &%-N%&
32323 &`**`&     delivery failed; address bounced
32324 &`==`&     delivery deferred; temporary problem
32325 .endd
32326
32327
32328 .section "Logging message reception" "SECID251"
32329 .cindex "log" "reception line"
32330 The format of the single-line entry in the main log that is written for every
32331 message received is shown in the basic example below, which is split over
32332 several lines in order to fit it on the page:
32333 .code
32334 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
32335   H=mailer.fict.example [192.168.123.123] U=exim
32336   P=smtp S=5678 id=<incoming message id>
32337 .endd
32338 The address immediately following &"<="& is the envelope sender address. A
32339 bounce message is shown with the sender address &"<>"&, and if it is locally
32340 generated, this is followed by an item of the form
32341 .code
32342 R=<message id>
32343 .endd
32344 which is a reference to the message that caused the bounce to be sent.
32345
32346 .cindex "HELO"
32347 .cindex "EHLO"
32348 For messages from other hosts, the H and U fields identify the remote host and
32349 record the RFC 1413 identity of the user that sent the message, if one was
32350 received. The number given in square brackets is the IP address of the sending
32351 host. If there is a single, unparenthesized  host name in the H field, as
32352 above, it has been verified to correspond to the IP address (see the
32353 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
32354 by the remote host in the SMTP HELO or EHLO command, and has not been
32355 verified. If verification yields a different name to that given for HELO or
32356 EHLO, the verified name appears first, followed by the HELO or EHLO
32357 name in parentheses.
32358
32359 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
32360 without brackets, in the HELO or EHLO command, leading to entries in
32361 the log containing text like these examples:
32362 .code
32363 H=(10.21.32.43) [192.168.8.34]
32364 H=([10.21.32.43]) [192.168.8.34]
32365 .endd
32366 This can be confusing. Only the final address in square brackets can be relied
32367 on.
32368
32369 For locally generated messages (that is, messages not received over TCP/IP),
32370 the H field is omitted, and the U field contains the login name of the caller
32371 of Exim.
32372
32373 .cindex "authentication" "logging"
32374 .cindex "AUTH" "logging"
32375 For all messages, the P field specifies the protocol used to receive the
32376 message. This is the value that is stored in &$received_protocol$&. In the case
32377 of incoming SMTP messages, the value indicates whether or not any SMTP
32378 extensions (ESMTP), encryption, or authentication were used. If the SMTP
32379 session was encrypted, there is an additional X field that records the cipher
32380 suite that was used.
32381
32382 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
32383 hosts that have authenticated themselves using the SMTP AUTH command. The first
32384 value is used when the SMTP connection was encrypted (&"secure"&). In this case
32385 there is an additional item A= followed by the name of the authenticator that
32386 was used. If an authenticated identification was set up by the authenticator's
32387 &%server_set_id%& option, this is logged too, separated by a colon from the
32388 authenticator name.
32389
32390 .cindex "size" "of message"
32391 The id field records the existing message id, if present. The size of the
32392 received message is given by the S field. When the message is delivered,
32393 headers may be removed or added, so that the size of delivered copies of the
32394 message may not correspond with this value (and indeed may be different to each
32395 other).
32396
32397 The &%log_selector%& option can be used to request the logging of additional
32398 data when a message is received. See section &<<SECTlogselector>>& below.
32399
32400
32401
32402 .section "Logging deliveries" "SECID252"
32403 .cindex "log" "delivery line"
32404 The format of the single-line entry in the main log that is written for every
32405 delivery is shown in one of the examples below, for local and remote
32406 deliveries, respectively. Each example has been split into two lines in order
32407 to fit it on the page:
32408 .code
32409 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
32410   <marv@hitch.fict.example> R=localuser T=local_delivery
32411 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
32412   monk@holistic.fict.example R=dnslookup T=remote_smtp
32413   H=holistic.fict.example [192.168.234.234]
32414 .endd
32415 For ordinary local deliveries, the original address is given in angle brackets
32416 after the final delivery address, which might be a pipe or a file. If
32417 intermediate address(es) exist between the original and the final address, the
32418 last of these is given in parentheses after the final address. The R and T
32419 fields record the router and transport that were used to process the address.
32420
32421 If a shadow transport was run after a successful local delivery, the log line
32422 for the successful delivery has an item added on the end, of the form
32423 .display
32424 &`ST=<`&&'shadow transport name'&&`>`&
32425 .endd
32426 If the shadow transport did not succeed, the error message is put in
32427 parentheses afterwards.
32428
32429 .cindex "asterisk" "after IP address"
32430 When more than one address is included in a single delivery (for example, two
32431 SMTP RCPT commands in one transaction) the second and subsequent addresses are
32432 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
32433 down a single SMTP connection, an asterisk follows the IP address in the log
32434 lines for the second and subsequent messages.
32435
32436 The generation of a reply message by a filter file gets logged as a
32437 &"delivery"& to the addressee, preceded by &">"&.
32438
32439 The &%log_selector%& option can be used to request the logging of additional
32440 data when a message is delivered. See section &<<SECTlogselector>>& below.
32441
32442
32443 .section "Discarded deliveries" "SECID253"
32444 .cindex "discarded messages"
32445 .cindex "message" "discarded"
32446 .cindex "delivery" "discarded; logging"
32447 When a message is discarded as a result of the command &"seen finish"& being
32448 obeyed in a filter file which generates no deliveries, a log entry of the form
32449 .code
32450 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
32451   <low.club@bridge.example> R=userforward
32452 .endd
32453 is written, to record why no deliveries are logged. When a message is discarded
32454 because it is aliased to &":blackhole:"& the log line is like this:
32455 .code
32456 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
32457   <hole@nowhere.example> R=blackhole_router
32458 .endd
32459
32460
32461 .section "Deferred deliveries" "SECID254"
32462 When a delivery is deferred, a line of the following form is logged:
32463 .code
32464 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
32465   R=dnslookup T=smtp defer (146): Connection refused
32466 .endd
32467 In the case of remote deliveries, the error is the one that was given for the
32468 last IP address that was tried. Details of individual SMTP failures are also
32469 written to the log, so the above line would be preceded by something like
32470 .code
32471 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
32472   mail1.endrest.example [192.168.239.239]: Connection refused
32473 .endd
32474 When a deferred address is skipped because its retry time has not been reached,
32475 a message is written to the log, but this can be suppressed by setting an
32476 appropriate value in &%log_selector%&.
32477
32478
32479
32480 .section "Delivery failures" "SECID255"
32481 .cindex "delivery" "failure; logging"
32482 If a delivery fails because an address cannot be routed, a line of the
32483 following form is logged:
32484 .code
32485 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
32486   <jim@trek99.example>: unknown mail domain
32487 .endd
32488 If a delivery fails at transport time, the router and transport are shown, and
32489 the response from the remote host is included, as in this example:
32490 .code
32491 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
32492   R=dnslookup T=remote_smtp: SMTP error from remote mailer
32493   after pipelined RCPT TO:<ace400@pb.example>: host
32494   pbmail3.py.example [192.168.63.111]: 553 5.3.0
32495   <ace400@pb.example>...Addressee unknown
32496 .endd
32497 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
32498 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
32499 disabling PIPELINING. The log lines for all forms of delivery failure are
32500 flagged with &`**`&.
32501
32502
32503
32504 .section "Fake deliveries" "SECID256"
32505 .cindex "delivery" "fake; logging"
32506 If a delivery does not actually take place because the &%-N%& option has been
32507 used to suppress it, a normal delivery line is written to the log, except that
32508 &"=>"& is replaced by &"*>"&.
32509
32510
32511
32512 .section "Completion" "SECID257"
32513 A line of the form
32514 .code
32515 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
32516 .endd
32517 is written to the main log when a message is about to be removed from the spool
32518 at the end of its processing.
32519
32520
32521
32522
32523 .section "Summary of Fields in Log Lines" "SECID258"
32524 .cindex "log" "summary of fields"
32525 A summary of the field identifiers that are used in log lines is shown in
32526 the following table:
32527 .display
32528 &`A   `&        authenticator name (and optional id)
32529 &`C   `&        SMTP confirmation on delivery
32530 &`    `&        command list for &"no mail in SMTP session"&
32531 &`CV  `&        certificate verification status
32532 &`D   `&        duration of &"no mail in SMTP session"&
32533 &`DN  `&        distinguished name from peer certificate
32534 &`DT  `&        on &`=>`& lines: time taken for a delivery
32535 &`F   `&        sender address (on delivery lines)
32536 &`H   `&        host name and IP address
32537 &`I   `&        local interface used
32538 &`id  `&        message id for incoming message
32539 &`P   `&        on &`<=`& lines: protocol used
32540 &`    `&        on &`=>`& and &`**`& lines: return path
32541 &`QT  `&        on &`=>`& lines: time spent on queue so far
32542 &`    `&        on &"Completed"& lines: time spent on queue
32543 &`R   `&        on &`<=`& lines: reference for local bounce
32544 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
32545 &`S   `&        size of message
32546 &`ST  `&        shadow transport name
32547 &`T   `&        on &`<=`& lines: message subject (topic)
32548 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
32549 &`U   `&        local user or RFC 1413 identity
32550 &`X   `&        TLS cipher suite
32551 .endd
32552
32553
32554 .section "Other log entries" "SECID259"
32555 Various other types of log entry are written from time to time. Most should be
32556 self-explanatory. Among the more common are:
32557
32558 .ilist
32559 .cindex "retry" "time not reached"
32560 &'retry time not reached'&&~&~An address previously suffered a temporary error
32561 during routing or local delivery, and the time to retry has not yet arrived.
32562 This message is not written to an individual message log file unless it happens
32563 during the first delivery attempt.
32564 .next
32565 &'retry time not reached for any host'&&~&~An address previously suffered
32566 temporary errors during remote delivery, and the retry time has not yet arrived
32567 for any of the hosts to which it is routed.
32568 .next
32569 .cindex "spool directory" "file locked"
32570 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
32571 some other Exim process is already working on the message. This can be quite
32572 common if queue running processes are started at frequent intervals. The
32573 &'exiwhat'& utility script can be used to find out what Exim processes are
32574 doing.
32575 .next
32576 .cindex "error" "ignored"
32577 &'error ignored'&&~&~There are several circumstances that give rise to this
32578 message:
32579 .olist
32580 Exim failed to deliver a bounce message whose age was greater than
32581 &%ignore_bounce_errors_after%&. The bounce was discarded.
32582 .next
32583 A filter file set up a delivery using the &"noerror"& option, and the delivery
32584 failed. The delivery was discarded.
32585 .next
32586 A delivery set up by a router configured with
32587 . ==== As this is a nested list, any displays it contains must be indented
32588 . ==== as otherwise they are too far to the left.
32589 .code
32590     errors_to = <>
32591 .endd
32592 failed. The delivery was discarded.
32593 .endlist olist
32594 .endlist ilist
32595
32596
32597
32598
32599
32600 .section "Reducing or increasing what is logged" "SECTlogselector"
32601 .cindex "log" "selectors"
32602 By setting the &%log_selector%& global option, you can disable some of Exim's
32603 default logging, or you can request additional logging. The value of
32604 &%log_selector%& is made up of names preceded by plus or minus characters. For
32605 example:
32606 .code
32607 log_selector = +arguments -retry_defer
32608 .endd
32609 The list of optional log items is in the following table, with the default
32610 selection marked by asterisks:
32611 .display
32612 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
32613 &` address_rewrite            `&  address rewriting
32614 &` all_parents                `&  all parents in => lines
32615 &` arguments                  `&  command line arguments
32616 &`*connection_reject          `&  connection rejections
32617 &`*delay_delivery             `&  immediate delivery delayed
32618 &` deliver_time               `&  time taken to perform delivery
32619 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
32620 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
32621 &`*etrn                       `&  ETRN commands
32622 &`*host_lookup_failed         `&  as it says
32623 &` ident_timeout              `&  timeout for ident connection
32624 &` incoming_interface         `&  incoming interface on <= lines
32625 &` incoming_port              `&  incoming port on <= lines
32626 &`*lost_incoming_connection   `&  as it says (includes timeouts)
32627 &` outgoing_port              `&  add remote port to => lines
32628 &`*queue_run                  `&  start and end queue runs
32629 &` queue_time                 `&  time on queue for one recipient
32630 &` queue_time_overall         `&  time on queue for whole message
32631 &` pid                        `&  Exim process id
32632 &` received_recipients        `&  recipients on <= lines
32633 &` received_sender            `&  sender on <= lines
32634 &`*rejected_header            `&  header contents on reject log
32635 &`*retry_defer                `&  &"retry time not reached"&
32636 &` return_path_on_delivery    `&  put return path on => and ** lines
32637 &` sender_on_delivery         `&  add sender to => lines
32638 &`*sender_verify_fail         `&  sender verification failures
32639 &`*size_reject                `&  rejection because too big
32640 &`*skip_delivery              `&  delivery skipped in a queue run
32641 &` smtp_confirmation          `&  SMTP confirmation on => lines
32642 &` smtp_connection            `&  SMTP connections
32643 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
32644 &` smtp_no_mail               `&  session with no MAIL commands
32645 &` smtp_protocol_error        `&  SMTP protocol errors
32646 &` smtp_syntax_error          `&  SMTP syntax errors
32647 &` subject                    `&  contents of &'Subject:'& on <= lines
32648 &` tls_certificate_verified   `&  certificate verification status
32649 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
32650 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
32651 &` unknown_in_list            `&  DNS lookup failed in list match
32652
32653 &` all                        `&  all of the above
32654 .endd
32655 More details on each of these items follows:
32656
32657 .ilist
32658 .cindex "&%warn%& ACL verb" "log when skipping"
32659 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
32660 its conditions cannot be evaluated, a log line to this effect is written if
32661 this log selector is set.
32662 .next
32663 .cindex "log" "rewriting"
32664 .cindex "rewriting" "logging"
32665 &%address_rewrite%&: This applies both to global rewrites and per-transport
32666 rewrites, but not to rewrites in filters run as an unprivileged user (because
32667 such users cannot access the log).
32668 .next
32669 .cindex "log" "full parentage"
32670 &%all_parents%&: Normally only the original and final addresses are logged on
32671 delivery lines; with this selector, intermediate parents are given in
32672 parentheses between them.
32673 .next
32674 .cindex "log" "Exim arguments"
32675 .cindex "Exim arguments, logging"
32676 &%arguments%&: This causes Exim to write the arguments with which it was called
32677 to the main log, preceded by the current working directory. This is a debugging
32678 feature, added to make it easier to find out how certain MUAs call
32679 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
32680 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
32681 that are empty or that contain white space are quoted. Non-printing characters
32682 are shown as escape sequences. This facility cannot log unrecognized arguments,
32683 because the arguments are checked before the configuration file is read. The
32684 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
32685 between the caller and Exim.
32686 .next
32687 .cindex "log" "connection rejections"
32688 &%connection_reject%&: A log entry is written whenever an incoming SMTP
32689 connection is rejected, for whatever reason.
32690 .next
32691 .cindex "log" "delayed delivery"
32692 .cindex "delayed delivery, logging"
32693 &%delay_delivery%&: A log entry is written whenever a delivery process is not
32694 started for an incoming message because the load is too high or too many
32695 messages were received on one connection. Logging does not occur if no delivery
32696 process is started because &%queue_only%& is set or &%-odq%& was used.
32697 .next
32698 .cindex "log" "delivery duration"
32699 &%deliver_time%&: For each delivery, the amount of real time it has taken to
32700 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
32701 .next
32702 .cindex "log" "message size on delivery"
32703 .cindex "size" "of message"
32704 &%delivery_size%&: For each delivery, the size of message delivered is added to
32705 the &"=>"& line, tagged with S=.
32706 .next
32707 .cindex "log" "dnslist defer"
32708 .cindex "DNS list" "logging defer"
32709 .cindex "black list (DNS)"
32710 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
32711 DNS black list suffers a temporary error.
32712 .next
32713 .cindex "log" "ETRN commands"
32714 .cindex "ETRN" "logging"
32715 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
32716 is run to determine whether or not it is actually accepted. An invalid ETRN
32717 command, or one received within a message transaction is not logged by this
32718 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
32719 .next
32720 .cindex "log" "host lookup failure"
32721 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
32722 any addresses, or when a lookup of an IP address fails to find a host name, a
32723 log line is written. This logging does not apply to direct DNS lookups when
32724 routing email addresses, but it does apply to &"byname"& lookups.
32725 .next
32726 .cindex "log" "ident timeout"
32727 .cindex "RFC 1413" "logging timeout"
32728 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
32729 client's ident port times out.
32730 .next
32731 .cindex "log" "incoming interface"
32732 .cindex "interface" "logging"
32733 &%incoming_interface%&: The interface on which a message was received is added
32734 to the &"<="& line as an IP address in square brackets, tagged by I= and
32735 followed by a colon and the port number. The local interface and port are also
32736 added to other SMTP log lines, for example &"SMTP connection from"&, and to
32737 rejection lines.
32738 .next
32739 .cindex "log" "incoming remote port"
32740 .cindex "port" "logging remote"
32741 .cindex "TCP/IP" "logging incoming remote port"
32742 .vindex "&$sender_fullhost$&"
32743 .vindex "&$sender_rcvhost$&"
32744 &%incoming_port%&: The remote port number from which a message was received is
32745 added to log entries and &'Received:'& header lines, following the IP address
32746 in square brackets, and separated from it by a colon. This is implemented by
32747 changing the value that is put in the &$sender_fullhost$& and
32748 &$sender_rcvhost$& variables. Recording the remote port number has become more
32749 important with the widening use of NAT (see RFC 2505).
32750 .next
32751 .cindex "log" "dropped connection"
32752 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
32753 connection is unexpectedly dropped.
32754 .next
32755 .cindex "log" "outgoing remote port"
32756 .cindex "port" "logging outgoint remote"
32757 .cindex "TCP/IP" "logging ougtoing remote port"
32758 &%outgoing_port%&: The remote port number is added to delivery log lines (those
32759 containing => tags) following the IP address. This option is not included in
32760 the default setting, because for most ordinary configurations, the remote port
32761 number is always 25 (the SMTP port).
32762 .next
32763 .cindex "log" "process ids in"
32764 .cindex "pid (process id)" "in log lines"
32765 &%pid%&: The current process id is added to every log line, in square brackets,
32766 immediately after the time and date.
32767 .next
32768 .cindex "log" "queue run"
32769 .cindex "queue runner" "logging"
32770 &%queue_run%&: The start and end of every queue run are logged.
32771 .next
32772 .cindex "log" "queue time"
32773 &%queue_time%&: The amount of time the message has been in the queue on the
32774 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
32775 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
32776 includes reception time as well as the delivery time for the current address.
32777 This means that it may be longer than the difference between the arrival and
32778 delivery log line times, because the arrival log line is not written until the
32779 message has been successfully received.
32780 .next
32781 &%queue_time_overall%&: The amount of time the message has been in the queue on
32782 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
32783 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
32784 message, so it includes reception time as well as the total delivery time.
32785 .next
32786 .cindex "log" "recipients"
32787 &%received_recipients%&: The recipients of a message are listed in the main log
32788 as soon as the message is received. The list appears at the end of the log line
32789 that is written when a message is received, preceded by the word &"for"&. The
32790 addresses are listed after they have been qualified, but before any rewriting
32791 has taken place.
32792 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
32793 in the list.
32794 .next
32795 .cindex "log" "sender reception"
32796 &%received_sender%&: The unrewritten original sender of a message is added to
32797 the end of the log line that records the message's arrival, after the word
32798 &"from"& (before the recipients if &%received_recipients%& is also set).
32799 .next
32800 .cindex "log" "header lines for rejection"
32801 &%rejected_header%&: If a message's header has been received at the time a
32802 rejection is written to the reject log, the complete header is added to the
32803 log. Header logging can be turned off individually for messages that are
32804 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
32805 .next
32806 .cindex "log" "retry defer"
32807 &%retry_defer%&: A log line is written if a delivery is deferred because a
32808 retry time has not yet been reached. However, this &"retry time not reached"&
32809 message is always omitted from individual message logs after the first delivery
32810 attempt.
32811 .next
32812 .cindex "log" "return path"
32813 &%return_path_on_delivery%&: The return path that is being transmitted with
32814 the message is included in delivery and bounce lines, using the tag P=.
32815 This is omitted if no delivery actually happens, for example, if routing fails,
32816 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
32817 .next
32818 .cindex "log" "sender on delivery"
32819 &%sender_on_delivery%&: The message's sender address is added to every delivery
32820 and bounce line, tagged by F= (for &"from"&).
32821 This is the original sender that was received with the message; it is not
32822 necessarily the same as the outgoing return path.
32823 .next
32824 .cindex "log" "sender verify failure"
32825 &%sender_verify_fail%&: If this selector is unset, the separate log line that
32826 gives details of a sender verification failure is not written. Log lines for
32827 the rejection of SMTP commands contain just &"sender verify failed"&, so some
32828 detail is lost.
32829 .next
32830 .cindex "log" "size rejection"
32831 &%size_reject%&: A log line is written whenever a message is rejected because
32832 it is too big.
32833 .next
32834 .cindex "log" "frozen messages; skipped"
32835 .cindex "frozen messages" "logging skipping"
32836 &%skip_delivery%&: A log line is written whenever a message is skipped during a
32837 queue run because it is frozen or because another process is already delivering
32838 it.
32839 .cindex "&""spool file is locked""&"
32840 The message that is written is &"spool file is locked"&.
32841 .next
32842 .cindex "log" "smtp confirmation"
32843 .cindex "SMTP" "logging confirmation"
32844 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
32845 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
32846 A number of MTAs (including Exim) return an identifying string in this
32847 response.
32848 .next
32849 .cindex "log" "SMTP connections"
32850 .cindex "SMTP" "logging connections"
32851 &%smtp_connection%&: A log line is written whenever an SMTP connection is
32852 established or closed, unless the connection is from a host that matches
32853 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
32854 only when the closure is unexpected.) This applies to connections from local
32855 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
32856 dropped in the middle of a message, a log line is always written, whether or
32857 not this selector is set, but otherwise nothing is written at the start and end
32858 of connections unless this selector is enabled.
32859
32860 For TCP/IP connections to an Exim daemon, the current number of connections is
32861 included in the log message for each new connection, but note that the count is
32862 reset if the daemon is restarted.
32863 Also, because connections are closed (and the closure is logged) in
32864 subprocesses, the count may not include connections that have been closed but
32865 whose termination the daemon has not yet noticed. Thus, while it is possible to
32866 match up the opening and closing of connections in the log, the value of the
32867 logged counts may not be entirely accurate.
32868 .next
32869 .cindex "log" "SMTP transaction; incomplete"
32870 .cindex "SMTP" "logging incomplete transactions"
32871 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
32872 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
32873 and the message sender plus any accepted recipients are included in the log
32874 line. This can provide evidence of dictionary attacks.
32875 .next
32876 .cindex "log" "non-MAIL SMTP sessions"
32877 .cindex "MAIL" "logging session without"
32878 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
32879 connection terminates without having issued a MAIL command. This includes both
32880 the case when the connection is dropped, and the case when QUIT is used. It
32881 does not include cases where the connection is rejected right at the start (by
32882 an ACL, or because there are too many connections, or whatever). These cases
32883 already have their own log lines.
32884
32885 The log line that is written contains the identity of the client in the usual
32886 way, followed by D= and a time, which records the duration of the connection.
32887 If the connection was authenticated, this fact is logged exactly as it is for
32888 an incoming message, with an A= item. If the connection was encrypted, CV=,
32889 DN=, and X= items may appear as they do for an incoming message, controlled by
32890 the same logging options.
32891
32892 Finally, if any SMTP commands were issued during the connection, a C= item
32893 is added to the line, listing the commands that were used. For example,
32894 .code
32895 C=EHLO,QUIT
32896 .endd
32897 shows that the client issued QUIT straight after EHLO. If there were fewer
32898 than 20 commands, they are all listed. If there were more than 20 commands,
32899 the last 20 are listed, preceded by &"..."&. However, with the default
32900 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
32901 have been aborted before 20 non-mail commands are processed.
32902 .next
32903 .cindex "log" "SMTP protocol error"
32904 .cindex "SMTP" "logging protocol error"
32905 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
32906 encountered. Exim does not have perfect detection of all protocol errors
32907 because of transmission delays and the use of pipelining. If PIPELINING has
32908 been advertised to a client, an Exim server assumes that the client will use
32909 it, and therefore it does not count &"expected"& errors (for example, RCPT
32910 received after rejecting MAIL) as protocol errors.
32911 .next
32912 .cindex "SMTP" "logging syntax errors"
32913 .cindex "SMTP" "syntax errors; logging"
32914 .cindex "SMTP" "unknown command; logging"
32915 .cindex "log" "unknown SMTP command"
32916 .cindex "log" "SMTP syntax error"
32917 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
32918 encountered. An unrecognized command is treated as a syntax error. For an
32919 external connection, the host identity is given; for an internal connection
32920 using &%-bs%& the sender identification (normally the calling user) is given.
32921 .next
32922 .cindex "log" "subject"
32923 .cindex "subject, logging"
32924 &%subject%&: The subject of the message is added to the arrival log line,
32925 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
32926 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
32927 specifies whether characters with values greater than 127 should be logged
32928 unchanged, or whether they should be rendered as escape sequences.
32929 .next
32930 .cindex "log" "certificate verification"
32931 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
32932 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
32933 verified, and &`CV=no`& if not.
32934 .next
32935 .cindex "log" "TLS cipher"
32936 .cindex "TLS" "logging cipher"
32937 &%tls_cipher%&: When a message is sent or received over an encrypted
32938 connection, the cipher suite used is added to the log line, preceded by X=.
32939 .next
32940 .cindex "log" "TLS peer DN"
32941 .cindex "TLS" "logging peer DN"
32942 &%tls_peerdn%&: When a message is sent or received over an encrypted
32943 connection, and a certificate is supplied by the remote host, the peer DN is
32944 added to the log line, preceded by DN=.
32945 .next
32946 .cindex "log" "DNS failure in list"
32947 &%unknown_in_list%&: This setting causes a log entry to be written when the
32948 result of a list match is failure because a DNS lookup failed.
32949 .endlist
32950
32951
32952 .section "Message log" "SECID260"
32953 .cindex "message" "log file for"
32954 .cindex "log" "message log; description of"
32955 .cindex "&_msglog_& directory"
32956 .oindex "&%preserve_message_logs%&"
32957 In addition to the general log files, Exim writes a log file for each message
32958 that it handles. The names of these per-message logs are the message ids, and
32959 they are kept in the &_msglog_& sub-directory of the spool directory. Each
32960 message log contains copies of the log lines that apply to the message. This
32961 makes it easier to inspect the status of an individual message without having
32962 to search the main log. A message log is deleted when processing of the message
32963 is complete, unless &%preserve_message_logs%& is set, but this should be used
32964 only with great care because they can fill up your disk very quickly.
32965
32966 On a heavily loaded system, it may be desirable to disable the use of
32967 per-message logs, in order to reduce disk I/O. This can be done by setting the
32968 &%message_logs%& option false.
32969 .ecindex IIDloggen
32970
32971
32972
32973
32974 . ////////////////////////////////////////////////////////////////////////////
32975 . ////////////////////////////////////////////////////////////////////////////
32976
32977 .chapter "Exim utilities" "CHAPutils"
32978 .scindex IIDutils "utilities"
32979 A number of utility scripts and programs are supplied with Exim and are
32980 described in this chapter. There is also the Exim Monitor, which is covered in
32981 the next chapter. The utilities described here are:
32982
32983 .itable none 0 0 3  7* left  15* left  40* left
32984 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
32985   "list what Exim processes are doing"
32986 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
32987 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
32988 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
32989 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
32990                                                 various criteria"
32991 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
32992 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
32993   "extract statistics from the log"
32994 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
32995   "check address acceptance from given IP"
32996 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
32997 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
32998 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
32999 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
33000 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
33001 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
33002 .endtable
33003
33004 Another utility that might be of use to sites with many MTAs is Tom Kistner's
33005 &'exilog'&. It provides log visualizations across multiple Exim servers. See
33006 &url(http://duncanthrax.net/exilog/) for details.
33007
33008
33009
33010
33011 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
33012 .cindex "&'exiwhat'&"
33013 .cindex "process, querying"
33014 .cindex "SIGUSR1"
33015 On operating systems that can restart a system call after receiving a signal
33016 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
33017 a line describing what it is doing to the file &_exim-process.info_& in the
33018 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
33019 processes it can find, having first emptied the file. It then waits for one
33020 second to allow the Exim processes to react before displaying the results. In
33021 order to run &'exiwhat'& successfully you have to have sufficient privilege to
33022 send the signal to the Exim processes, so it is normally run as root.
33023
33024 &*Warning*&: This is not an efficient process. It is intended for occasional
33025 use by system administrators. It is not sensible, for example, to set up a
33026 script that sends SIGUSR1 signals to Exim processes at short intervals.
33027
33028
33029 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
33030 varies in different operating systems. Not only are different options used,
33031 but the format of the output is different. For this reason, there are some
33032 system configuration options that configure exactly how &'exiwhat'& works. If
33033 it doesn't seem to be working for you, check the following compile-time
33034 options:
33035 .display
33036 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
33037 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
33038 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
33039 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
33040 .endd
33041 An example of typical output from &'exiwhat'& is
33042 .code
33043 164 daemon: -q1h, listening on port 25
33044 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
33045 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
33046   [10.19.42.42] (editor@ref.example)
33047 10592 handling incoming call from [192.168.243.242]
33048 10628 accepting a local non-SMTP message
33049 .endd
33050 The first number in the output line is the process number. The third line has
33051 been split here, in order to fit it on the page.
33052
33053
33054
33055 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
33056 .cindex "&'exiqgrep'&"
33057 .cindex "queue" "grepping"
33058 This utility is a Perl script contributed by Matt Hubbard. It runs
33059 .code
33060 exim -bpu
33061 .endd
33062 to obtain a queue listing with undelivered recipients only, and then greps the
33063 output to select messages that match given criteria. The following selection
33064 options are available:
33065
33066 .vlist
33067 .vitem &*-f*&&~<&'regex'&>
33068 Match the sender address. The field that is tested is enclosed in angle
33069 brackets, so you can test for bounce messages with
33070 .code
33071 exiqgrep -f '^<>$'
33072 .endd
33073 .vitem &*-r*&&~<&'regex'&>
33074 Match a recipient address. The field that is tested is not enclosed in angle
33075 brackets.
33076
33077 .vitem &*-s*&&~<&'regex'&>
33078 Match against the size field.
33079
33080 .vitem &*-y*&&~<&'seconds'&>
33081 Match messages that are younger than the given time.
33082
33083 .vitem &*-o*&&~<&'seconds'&>
33084 Match messages that are older than the given time.
33085
33086 .vitem &*-z*&
33087 Match only frozen messages.
33088
33089 .vitem &*-x*&
33090 Match only non-frozen messages.
33091 .endlist
33092
33093 The following options control the format of the output:
33094
33095 .vlist
33096 .vitem &*-c*&
33097 Display only the count of matching messages.
33098
33099 .vitem &*-l*&
33100 Long format &-- display the full message information as output by Exim. This is
33101 the default.
33102
33103 .vitem &*-i*&
33104 Display message ids only.
33105
33106 .vitem &*-b*&
33107 Brief format &-- one line per message.
33108
33109 .vitem &*-R*&
33110 Display messages in reverse order.
33111 .endlist
33112
33113 There is one more option, &%-h%&, which outputs a list of options.
33114
33115
33116
33117 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
33118 .cindex "&'exiqsumm'&"
33119 .cindex "queue" "summary"
33120 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
33121 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
33122 running a command such as
33123 .code
33124 exim -bp | exiqsumm
33125 .endd
33126 The output consists of one line for each domain that has messages waiting for
33127 it, as in the following example:
33128 .code
33129 3   2322   74m   66m  msn.com.example
33130 .endd
33131 Each line lists the number of pending deliveries for a domain, their total
33132 volume, and the length of time that the oldest and the newest messages have
33133 been waiting. Note that the number of pending deliveries is greater than the
33134 number of messages when messages have more than one recipient.
33135
33136 A summary line is output at the end. By default the output is sorted on the
33137 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
33138 the output to be sorted by oldest message and by count of messages,
33139 respectively. There are also three options that split the messages for each
33140 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
33141 separates frozen messages, and &%-s%& separates messages according to their
33142 sender.
33143
33144 The output of &'exim -bp'& contains the original addresses in the message, so
33145 this also applies to the output from &'exiqsumm'&. No domains from addresses
33146 generated by aliasing or forwarding are included (unless the &%one_time%&
33147 option of the &(redirect)& router has been used to convert them into &"top
33148 level"& addresses).
33149
33150
33151
33152
33153 .section "Extracting specific information from the log (exigrep)" &&&
33154          "SECTextspeinf"
33155 .cindex "&'exigrep'&"
33156 .cindex "log" "extracts; grepping for"
33157 The &'exigrep'& utility is a Perl script that searches one or more main log
33158 files for entries that match a given pattern. When it finds a match, it
33159 extracts all the log entries for the relevant message, not just those that
33160 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
33161 given message, or all mail for a given user, or for a given host, for example.
33162 The input files can be in Exim log format or syslog format.
33163 If a matching log line is not associated with a specific message, it is
33164 included in &'exigrep'&'s output without any additional lines. The usage is:
33165 .display
33166 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
33167 .endd
33168 If no log file names are given on the command line, the standard input is read.
33169
33170 The &%-t%& argument specifies a number of seconds. It adds an additional
33171 condition for message selection. Messages that are complete are shown only if
33172 they spent more than <&'n'&> seconds on the queue.
33173
33174 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
33175 makes it case-sensitive. This may give a performance improvement when searching
33176 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
33177 option; with &%-I%& they do not. In both cases it is possible to change the
33178 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
33179
33180 The &%-l%& option means &"literal"&, that is, treat all characters in the
33181 pattern as standing for themselves. Otherwise the pattern must be a Perl
33182 regular expression.
33183
33184 The &%-v%& option inverts the matching condition. That is, a line is selected
33185 if it does &'not'& match the pattern.
33186
33187 If the location of a &'zcat'& command is known from the definition of
33188 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
33189 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
33190
33191
33192 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
33193 .cindex "&'exipick'&"
33194 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
33195 lists messages from the queue according to a variety of criteria. For details
33196 of &'exipick'&'s facilities, visit the web page at
33197 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
33198 the &%--help%& option.
33199
33200
33201 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
33202 .cindex "log" "cycling local files"
33203 .cindex "cycling logs"
33204 .cindex "&'exicyclog'&"
33205 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
33206 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
33207 you are using log files with datestamps in their names (see section
33208 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
33209 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
33210 There are two command line options for &'exicyclog'&:
33211 .ilist
33212 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
33213 default that is set when Exim is built. The default default is 10.
33214 .next
33215 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
33216 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
33217 overriding the script's default, which is to find the setting from Exim's
33218 configuration.
33219 .endlist
33220
33221 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
33222 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
33223 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
33224 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
33225 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
33226 logs are handled similarly.
33227
33228 If the limit is greater than 99, the script uses 3-digit numbers such as
33229 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
33230 to one that is greater, or &'vice versa'&, you will have to fix the names of
33231 any existing log files.
33232
33233 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
33234 the end are deleted. All files with numbers greater than 01 are compressed,
33235 using a compression command which is configured by the COMPRESS_COMMAND
33236 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
33237 root &%crontab%& entry of the form
33238 .code
33239 1 0 * * * su exim -c /usr/exim/bin/exicyclog
33240 .endd
33241 assuming you have used the name &"exim"& for the Exim user. You can run
33242 &'exicyclog'& as root if you wish, but there is no need.
33243
33244
33245
33246 .section "Mail statistics (eximstats)" "SECTmailstat"
33247 .cindex "statistics"
33248 .cindex "&'eximstats'&"
33249 A Perl script called &'eximstats'& is provided for extracting statistical
33250 information from log files. The output is either plain text, or HTML.
33251 Exim log files are also supported by the &'Lire'& system produced by the
33252 LogReport Foundation &url(http://www.logreport.org).
33253
33254 The &'eximstats'& script has been hacked about quite a bit over time. The
33255 latest version is the result of some extensive revision by Steve Campbell. A
33256 lot of information is given by default, but there are options for suppressing
33257 various parts of it. Following any options, the arguments to the script are a
33258 list of files, which should be main log files. For example:
33259 .code
33260 eximstats -nr /var/spool/exim/log/mainlog.01
33261 .endd
33262 By default, &'eximstats'& extracts information about the number and volume of
33263 messages received from or delivered to various hosts. The information is sorted
33264 both by message count and by volume, and the top fifty hosts in each category
33265 are listed on the standard output. Similar information, based on email
33266 addresses or domains instead of hosts can be requested by means of various
33267 options. For messages delivered and received locally, similar statistics are
33268 also produced per user.
33269
33270 The output also includes total counts and statistics about delivery errors, and
33271 histograms showing the number of messages received and deliveries made in each
33272 hour of the day. A delivery with more than one address in its envelope (for
33273 example, an SMTP transaction with more than one RCPT command) is counted
33274 as a single delivery by &'eximstats'&.
33275
33276 Though normally more deliveries than receipts are reported (as messages may
33277 have multiple recipients), it is possible for &'eximstats'& to report more
33278 messages received than delivered, even though the queue is empty at the start
33279 and end of the period in question. If an incoming message contains no valid
33280 recipients, no deliveries are recorded for it. A bounce message is handled as
33281 an entirely separate message.
33282
33283 &'eximstats'& always outputs a grand total summary giving the volume and number
33284 of messages received and deliveries made, and the number of hosts involved in
33285 each case. It also outputs the number of messages that were delayed (that is,
33286 not completely delivered at the first attempt), and the number that had at
33287 least one address that failed.
33288
33289 The remainder of the output is in sections that can be independently disabled
33290 or modified by various options. It consists of a summary of deliveries by
33291 transport, histograms of messages received and delivered per time interval
33292 (default per hour), information about the time messages spent on the queue,
33293 a list of relayed messages, lists of the top fifty sending hosts, local
33294 senders, destination hosts, and destination local users by count and by volume,
33295 and a list of delivery errors that occurred.
33296
33297 The relay information lists messages that were actually relayed, that is, they
33298 came from a remote host and were directly delivered to some other remote host,
33299 without being processed (for example, for aliasing or forwarding) locally.
33300
33301 There are quite a few options for &'eximstats'& to control exactly what it
33302 outputs. These are documented in the Perl script itself, and can be extracted
33303 by running the command &(perldoc)& on the script. For example:
33304 .code
33305 perldoc /usr/exim/bin/eximstats
33306 .endd
33307
33308 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
33309 .cindex "&'exim_checkaccess'&"
33310 .cindex "policy control" "checking access"
33311 .cindex "checking access"
33312 The &%-bh%& command line argument allows you to run a fake SMTP session with
33313 debugging output, in order to check what Exim is doing when it is applying
33314 policy controls to incoming SMTP mail. However, not everybody is sufficiently
33315 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
33316 sometimes you just want to answer the question &"Does this address have
33317 access?"& without bothering with any further details.
33318
33319 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
33320 two arguments, an IP address and an email address:
33321 .code
33322 exim_checkaccess 10.9.8.7 A.User@a.domain.example
33323 .endd
33324 The utility runs a call to Exim with the &%-bh%& option, to test whether the
33325 given email address would be accepted in a RCPT command in a TCP/IP
33326 connection from the host with the given IP address. The output of the utility
33327 is either the word &"accepted"&, or the SMTP error response, for example:
33328 .code
33329 Rejected:
33330 550 Relay not permitted
33331 .endd
33332 When running this test, the utility uses &`<>`& as the envelope sender address
33333 for the MAIL command, but you can change this by providing additional
33334 options. These are passed directly to the Exim command. For example, to specify
33335 that the test is to be run with the sender address &'himself@there.example'&
33336 you can use:
33337 .code
33338 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
33339                  -f himself@there.example
33340 .endd
33341 Note that these additional Exim command line items must be given after the two
33342 mandatory arguments.
33343
33344 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
33345 while running its checks. You can run checks that include callouts by using
33346 &%-bhc%&, but this is not yet available in a &"packaged"& form.
33347
33348
33349
33350 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
33351 .cindex "DBM" "building dbm files"
33352 .cindex "building DBM files"
33353 .cindex "&'exim_dbmbuild'&"
33354 .cindex "lower casing"
33355 .cindex "binary zero" "in lookup key"
33356 The &'exim_dbmbuild'& program reads an input file containing keys and data in
33357 the format used by the &(lsearch)& lookup (see section
33358 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
33359 names as keys and the remainder of the information as data. The lower-casing
33360 can be prevented by calling the program with the &%-nolc%& option.
33361
33362 A terminating zero is included as part of the key string. This is expected by
33363 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
33364 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
33365 strings or the data strings. The &(dbmnz)& lookup type can be used with such
33366 files.
33367
33368 The program requires two arguments: the name of the input file (which can be a
33369 single hyphen to indicate the standard input), and the name of the output file.
33370 It creates the output under a temporary name, and then renames it if all went
33371 well.
33372
33373 .cindex "USE_DB"
33374 If the native DB interface is in use (USE_DB is set in a compile-time
33375 configuration file &-- this is common in free versions of Unix) the two file
33376 names must be different, because in this mode the Berkeley DB functions create
33377 a single output file using exactly the name given. For example,
33378 .code
33379 exim_dbmbuild /etc/aliases /etc/aliases.db
33380 .endd
33381 reads the system alias file and creates a DBM version of it in
33382 &_/etc/aliases.db_&.
33383
33384 In systems that use the &'ndbm'& routines (mostly proprietary versions of
33385 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
33386 environment, the suffixes are added to the second argument of
33387 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
33388 when the Berkeley functions are used in compatibility mode (though this is not
33389 recommended), because in that case it adds a &_.db_& suffix to the file name.
33390
33391 If a duplicate key is encountered, the program outputs a warning, and when it
33392 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
33393 option is used. By default, only the first of a set of duplicates is used &--
33394 this makes it compatible with &(lsearch)& lookups. There is an option
33395 &%-lastdup%& which causes it to use the data for the last duplicate instead.
33396 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
33397 &%stderr%&. For other errors, where it doesn't actually make a new file, the
33398 return code is 2.
33399
33400
33401
33402
33403 .section "Finding individual retry times (exinext)" "SECTfinindret"
33404 .cindex "retry" "times"
33405 .cindex "&'exinext'&"
33406 A utility called &'exinext'& (mostly a Perl script) provides the ability to
33407 fish specific information out of the retry database. Given a mail domain (or a
33408 complete address), it looks up the hosts for that domain, and outputs any retry
33409 information for the hosts or for the domain. At present, the retry information
33410 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
33411 output. For example:
33412 .code
33413 $ exinext piglet@milne.fict.example
33414 kanga.milne.example:192.168.8.1 error 146: Connection refused
33415   first failed: 21-Feb-1996 14:57:34
33416   last tried:   21-Feb-1996 14:57:34
33417   next try at:  21-Feb-1996 15:02:34
33418 roo.milne.example:192.168.8.3 error 146: Connection refused
33419   first failed: 20-Jan-1996 13:12:08
33420   last tried:   21-Feb-1996 11:42:03
33421   next try at:  21-Feb-1996 19:42:03
33422   past final cutoff time
33423 .endd
33424 You can also give &'exinext'& a local part, without a domain, and it
33425 will give any retry information for that local part in your default domain.
33426 A message id can be used to obtain retry information pertaining to a specific
33427 message. This exists only when an attempt to deliver a message to a remote host
33428 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
33429 &'exinext'& is not particularly efficient, but then it is not expected to be
33430 run very often.
33431
33432 The &'exinext'& utility calls Exim to find out information such as the location
33433 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
33434 passed on to the &'exim'& commands. The first specifies an alternate Exim
33435 configuration file, and the second sets macros for use within the configuration
33436 file. These features are mainly to help in testing, but might also be useful in
33437 environments where more than one configuration file is in use.
33438
33439
33440
33441 .section "Hints database maintenance" "SECThindatmai"
33442 .cindex "hints database" "maintenance"
33443 .cindex "maintaining Exim's hints database"
33444 Three utility programs are provided for maintaining the DBM files that Exim
33445 uses to contain its delivery hint information. Each program requires two
33446 arguments. The first specifies the name of Exim's spool directory, and the
33447 second is the name of the database it is to operate on. These are as follows:
33448
33449 .ilist
33450 &'retry'&: the database of retry information
33451 .next
33452 &'wait-'&<&'transport name'&>: databases of information about messages waiting
33453 for remote hosts
33454 .next
33455 &'callout'&: the callout cache
33456 .next
33457 &'ratelimit'&: the data for implementing the ratelimit ACL condition
33458 .next
33459 &'misc'&: other hints data
33460 .endlist
33461
33462 The &'misc'& database is used for
33463
33464 .ilist
33465 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
33466 .next
33467 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
33468 &(smtp)& transport)
33469 .endlist
33470
33471
33472
33473 .section "exim_dumpdb" "SECID261"
33474 .cindex "&'exim_dumpdb'&"
33475 The entire contents of a database are written to the standard output by the
33476 &'exim_dumpdb'& program, which has no options or arguments other than the
33477 spool and database names. For example, to dump the retry database:
33478 .code
33479 exim_dumpdb /var/spool/exim retry
33480 .endd
33481 Two lines of output are produced for each entry:
33482 .code
33483 T:mail.ref.example:192.168.242.242 146 77 Connection refused
33484 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
33485 .endd
33486 The first item on the first line is the key of the record. It starts with one
33487 of the letters R, or T, depending on whether it refers to a routing or
33488 transport retry. For a local delivery, the next part is the local address; for
33489 a remote delivery it is the name of the remote host, followed by its failing IP
33490 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
33491 transport). If the remote port is not the standard one (port 25), it is added
33492 to the IP address. Then there follows an error code, an additional error code,
33493 and a textual description of the error.
33494
33495 The three times on the second line are the time of first failure, the time of
33496 the last delivery attempt, and the computed time for the next attempt. The line
33497 ends with an asterisk if the cutoff time for the last retry rule has been
33498 exceeded.
33499
33500 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
33501 consists of a host name followed by a list of ids for messages that are or were
33502 waiting to be delivered to that host. If there are a very large number for any
33503 one host, continuation records, with a sequence number added to the host name,
33504 may be seen. The data in these records is often out of date, because a message
33505 may be routed to several alternative hosts, and Exim makes no effort to keep
33506 cross-references.
33507
33508
33509
33510 .section "exim_tidydb" "SECID262"
33511 .cindex "&'exim_tidydb'&"
33512 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
33513 database. If run with no options, it removes all records that are more than 30
33514 days old. The age is calculated from the date and time that the record was last
33515 updated. Note that, in the case of the retry database, it is &'not'& the time
33516 since the first delivery failure. Information about a host that has been down
33517 for more than 30 days will remain in the database, provided that the record is
33518 updated sufficiently often.
33519
33520 The cutoff date can be altered by means of the &%-t%& option, which must be
33521 followed by a time. For example, to remove all records older than a week from
33522 the retry database:
33523 .code
33524 exim_tidydb -t 7d /var/spool/exim retry
33525 .endd
33526 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
33527 message ids. In the former these appear as data in records keyed by host &--
33528 they were messages that were waiting for that host &-- and in the latter they
33529 are the keys for retry information for messages that have suffered certain
33530 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
33531 message ids in database records are those of messages that are still on the
33532 queue. Message ids for messages that no longer exist are removed from
33533 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
33534 For the &'retry'& database, records whose keys are non-existent message ids are
33535 removed. The &'exim_tidydb'& utility outputs comments on the standard output
33536 whenever it removes information from the database.
33537
33538 Certain records are automatically removed by Exim when they are no longer
33539 needed, but others are not. For example, if all the MX hosts for a domain are
33540 down, a retry record is created for each one. If the primary MX host comes back
33541 first, its record is removed when Exim successfully delivers to it, but the
33542 records for the others remain because Exim has not tried to use those hosts.
33543
33544 It is important, therefore, to run &'exim_tidydb'& periodically on all the
33545 hints databases. You should do this at a quiet time of day, because it requires
33546 a database to be locked (and therefore inaccessible to Exim) while it does its
33547 work. Removing records from a DBM file does not normally make the file smaller,
33548 but all the common DBM libraries are able to re-use the space that is released.
33549 After an initial phase of increasing in size, the databases normally reach a
33550 point at which they no longer get any bigger, as long as they are regularly
33551 tidied.
33552
33553 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
33554 databases is likely to keep on increasing.
33555
33556
33557
33558
33559 .section "exim_fixdb" "SECID263"
33560 .cindex "&'exim_fixdb'&"
33561 The &'exim_fixdb'& program is a utility for interactively modifying databases.
33562 Its main use is for testing Exim, but it might also be occasionally useful for
33563 getting round problems in a live system. It has no options, and its interface
33564 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
33565 key of a database record can then be entered, and the data for that record is
33566 displayed.
33567
33568 If &"d"& is typed at the next prompt, the entire record is deleted. For all
33569 except the &'retry'& database, that is the only operation that can be carried
33570 out. For the &'retry'& database, each field is output preceded by a number, and
33571 data for individual fields can be changed by typing the field number followed
33572 by new data, for example:
33573 .code
33574 > 4 951102:1000
33575 .endd
33576 resets the time of the next delivery attempt. Time values are given as a
33577 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
33578 used as optional separators.
33579
33580
33581
33582
33583 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
33584 .cindex "mailbox" "maintenance"
33585 .cindex "&'exim_lock'&"
33586 .cindex "locking mailboxes"
33587 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
33588 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
33589 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
33590 a user agent while investigating a problem. The utility requires the name of
33591 the file as its first argument. If the locking is successful, the second
33592 argument is run as a command (using C's &[system()]& function); if there is no
33593 second argument, the value of the SHELL environment variable is used; if this
33594 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
33595 is unlocked and the utility ends. The following options are available:
33596
33597 .vlist
33598 .vitem &%-fcntl%&
33599 Use &[fcntl()]& locking on the open mailbox.
33600
33601 .vitem &%-flock%&
33602 Use &[flock()]& locking on the open mailbox, provided the operating system
33603 supports it.
33604
33605 .vitem &%-interval%&
33606 This must be followed by a number, which is a number of seconds; it sets the
33607 interval to sleep between retries (default 3).
33608
33609 .vitem &%-lockfile%&
33610 Create a lock file before opening the mailbox.
33611
33612 .vitem &%-mbx%&
33613 Lock the mailbox using MBX rules.
33614
33615 .vitem &%-q%&
33616 Suppress verification output.
33617
33618 .vitem &%-retries%&
33619 This must be followed by a number; it sets the number of times to try to get
33620 the lock (default 10).
33621
33622 .vitem &%-restore_time%&
33623 This option causes &%exim_lock%& to restore the modified and read times to the
33624 locked file before exiting. This allows you to access a locked mailbox (for
33625 example, to take a backup copy) without disturbing the times that the user
33626 subsequently sees.
33627
33628 .vitem &%-timeout%&
33629 This must be followed by a number, which is a number of seconds; it sets a
33630 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
33631 default), a non-blocking call is used.
33632
33633 .vitem &%-v%&
33634 Generate verbose output.
33635 .endlist
33636
33637 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
33638 default is to create a lock file and also to use &[fcntl()]& locking on the
33639 mailbox, which is the same as Exim's default. The use of &%-flock%& or
33640 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
33641 requires that the directory containing the file be writeable. Locking by lock
33642 file does not last for ever; Exim assumes that a lock file is expired if it is
33643 more than 30 minutes old.
33644
33645 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
33646 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
33647 to be taken out on the open mailbox, and an exclusive lock on the file
33648 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
33649 number of the mailbox file. When the locking is released, if an exclusive lock
33650 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
33651
33652 The default output contains verification of the locking that takes place. The
33653 &%-v%& option causes some additional information to be given. The &%-q%& option
33654 suppresses all output except error messages.
33655
33656 A command such as
33657 .code
33658 exim_lock /var/spool/mail/spqr
33659 .endd
33660 runs an interactive shell while the file is locked, whereas
33661 .display
33662 &`exim_lock -q /var/spool/mail/spqr <<End`&
33663 <&'some commands'&>
33664 &`End`&
33665 .endd
33666 runs a specific non-interactive sequence of commands while the file is locked,
33667 suppressing all verification output. A single command can be run by a command
33668 such as
33669 .code
33670 exim_lock -q /var/spool/mail/spqr \
33671   "cp /var/spool/mail/spqr /some/where"
33672 .endd
33673 Note that if a command is supplied, it must be entirely contained within the
33674 second argument &-- hence the quotes.
33675 .ecindex IIDutils
33676
33677
33678 . ////////////////////////////////////////////////////////////////////////////
33679 . ////////////////////////////////////////////////////////////////////////////
33680
33681 .chapter "The Exim monitor" "CHAPeximon"
33682 .scindex IIDeximon "Exim monitor" "description"
33683 .cindex "X-windows"
33684 .cindex "&'eximon'&"
33685 .cindex "Local/eximon.conf"
33686 .cindex "&_exim_monitor/EDITME_&"
33687 The Exim monitor is an application which displays in an X window information
33688 about the state of Exim's queue and what Exim is doing. An admin user can
33689 perform certain operations on messages from this GUI interface; however all
33690 such facilities are also available from the command line, and indeed, the
33691 monitor itself makes use of the command line to perform any actions requested.
33692
33693
33694
33695 .section "Running the monitor" "SECID264"
33696 The monitor is started by running the script called &'eximon'&. This is a shell
33697 script that sets up a number of environment variables, and then runs the
33698 binary called &_eximon.bin_&. The default appearance of the monitor window can
33699 be changed by editing the &_Local/eximon.conf_& file created by editing
33700 &_exim_monitor/EDITME_&. Comments in that file describe what the various
33701 parameters are for.
33702
33703 The parameters that get built into the &'eximon'& script can be overridden for
33704 a particular invocation by setting up environment variables of the same names,
33705 preceded by &`EXIMON_`&. For example, a shell command such as
33706 .code
33707 EXIMON_LOG_DEPTH=400 eximon
33708 .endd
33709 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
33710 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
33711 overrides the Exim log file configuration. This makes it possible to have
33712 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
33713 syslog messages are routed to a file on the local host.
33714
33715 X resources can be used to change the appearance of the window in the normal
33716 way. For example, a resource setting of the form
33717 .code
33718 Eximon*background: gray94
33719 .endd
33720 changes the colour of the background to light grey rather than white. The
33721 stripcharts are drawn with both the data lines and the reference lines in
33722 black. This means that the reference lines are not visible when on top of the
33723 data. However, their colour can be changed by setting a resource called
33724 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
33725 For example, if your X server is running Unix, you could set up lighter
33726 reference lines in the stripcharts by obeying
33727 .code
33728 xrdb -merge <<End
33729 Eximon*highlight: gray
33730 End
33731 .endd
33732 .cindex "admin user"
33733 In order to see the contents of messages on the queue, and to operate on them,
33734 &'eximon'& must either be run as root or by an admin user.
33735
33736 The monitor's window is divided into three parts. The first contains one or
33737 more stripcharts and two action buttons, the second contains a &"tail"& of the
33738 main log file, and the third is a display of the queue of messages awaiting
33739 delivery, with two more action buttons. The following sections describe these
33740 different parts of the display.
33741
33742
33743
33744
33745 .section "The stripcharts" "SECID265"
33746 .cindex "stripchart"
33747 The first stripchart is always a count of messages on the queue. Its name can
33748 be configured by setting QUEUE_STRIPCHART_NAME in the
33749 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
33750 configuration script by regular expression matches on log file entries, making
33751 it possible to display, for example, counts of messages delivered to certain
33752 hosts or using certain transports. The supplied defaults display counts of
33753 received and delivered messages, and of local and SMTP deliveries. The default
33754 period between stripchart updates is one minute; this can be adjusted by a
33755 parameter in the &_Local/eximon.conf_& file.
33756
33757 The stripchart displays rescale themselves automatically as the value they are
33758 displaying changes. There are always 10 horizontal lines in each chart; the
33759 title string indicates the value of each division when it is greater than one.
33760 For example, &"x2"& means that each division represents a value of 2.
33761
33762 It is also possible to have a stripchart which shows the percentage fullness of
33763 a particular disk partition, which is useful when local deliveries are confined
33764 to a single partition.
33765
33766 .cindex "&%statvfs%& function"
33767 This relies on the availability of the &[statvfs()]& function or equivalent in
33768 the operating system. Most, but not all versions of Unix that support Exim have
33769 this. For this particular stripchart, the top of the chart always represents
33770 100%, and the scale is given as &"x10%"&. This chart is configured by setting
33771 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
33772 &_Local/eximon.conf_& file.
33773
33774
33775
33776
33777 .section "Main action buttons" "SECID266"
33778 .cindex "size" "of monitor window"
33779 .cindex "Exim monitor" "window size"
33780 .cindex "window size"
33781 Below the stripcharts there is an action button for quitting the monitor. Next
33782 to this is another button marked &"Size"&. They are placed here so that
33783 shrinking the window to its default minimum size leaves just the queue count
33784 stripchart and these two buttons visible. Pressing the &"Size"& button causes
33785 the window to expand to its maximum size, unless it is already at the maximum,
33786 in which case it is reduced to its minimum.
33787
33788 When expanding to the maximum, if the window cannot be fully seen where it
33789 currently is, it is moved back to where it was the last time it was at full
33790 size. When it is expanding from its minimum size, the old position is
33791 remembered, and next time it is reduced to the minimum it is moved back there.
33792
33793 The idea is that you can keep a reduced window just showing one or two
33794 stripcharts at a convenient place on your screen, easily expand it to show
33795 the full window when required, and just as easily put it back to what it was.
33796 The idea is copied from what the &'twm'& window manager does for its
33797 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
33798 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
33799
33800 Normally, the monitor starts up with the window at its full size, but it can be
33801 built so that it starts up with the window at its smallest size, by setting
33802 START_SMALL=yes in &_Local/eximon.conf_&.
33803
33804
33805
33806 .section "The log display" "SECID267"
33807 .cindex "log" "tail of; in monitor"
33808 The second section of the window is an area in which a display of the tail of
33809 the main log is maintained.
33810 To save space on the screen, the timestamp on each log line is shortened by
33811 removing the date and, if &%log_timezone%& is set, the timezone.
33812 The log tail is not available when the only destination for logging data is
33813 syslog, unless the syslog lines are routed to a local file whose name is passed
33814 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
33815
33816 The log sub-window has a scroll bar at its lefthand side which can be used to
33817 move back to look at earlier text, and the up and down arrow keys also have a
33818 scrolling effect. The amount of log that is kept depends on the setting of
33819 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
33820 to use. When this is full, the earlier 50% of data is discarded &-- this is
33821 much more efficient than throwing it away line by line. The sub-window also has
33822 a horizontal scroll bar for accessing the ends of long log lines. This is the
33823 only means of horizontal scrolling; the right and left arrow keys are not
33824 available. Text can be cut from this part of the window using the mouse in the
33825 normal way. The size of this subwindow is controlled by parameters in the
33826 configuration file &_Local/eximon.conf_&.
33827
33828 Searches of the text in the log window can be carried out by means of the ^R
33829 and ^S keystrokes, which default to a reverse and a forward search,
33830 respectively. The search covers only the text that is displayed in the window.
33831 It cannot go further back up the log.
33832
33833 The point from which the search starts is indicated by a caret marker. This is
33834 normally at the end of the text in the window, but can be positioned explicitly
33835 by pointing and clicking with the left mouse button, and is moved automatically
33836 by a successful search. If new text arrives in the window when it is scrolled
33837 back, the caret remains where it is, but if the window is not scrolled back,
33838 the caret is moved to the end of the new text.
33839
33840 Pressing ^R or ^S pops up a window into which the search text can be typed.
33841 There are buttons for selecting forward or reverse searching, for carrying out
33842 the search, and for cancelling. If the &"Search"& button is pressed, the search
33843 happens and the window remains so that further searches can be done. If the
33844 &"Return"& key is pressed, a single search is done and the window is closed. If
33845 ^C is typed the search is cancelled.
33846
33847 The searching facility is implemented using the facilities of the Athena text
33848 widget. By default this pops up a window containing both &"search"& and
33849 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
33850 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
33851 However, the linkers in BSDI and HP-UX seem unable to handle an externally
33852 provided version of &%TextPop%& when the remaining parts of the text widget
33853 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
33854 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
33855 on these systems, at the expense of having unwanted items in the search popup
33856 window.
33857
33858
33859
33860 .section "The queue display" "SECID268"
33861 .cindex "queue" "display in monitor"
33862 The bottom section of the monitor window contains a list of all messages that
33863 are on the queue, which includes those currently being received or delivered,
33864 as well as those awaiting delivery. The size of this subwindow is controlled by
33865 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
33866 at which it is updated is controlled by another parameter in the same file &--
33867 the default is 5 minutes, since queue scans can be quite expensive. However,
33868 there is an &"Update"& action button just above the display which can be used
33869 to force an update of the queue display at any time.
33870
33871 When a host is down for some time, a lot of pending mail can build up for it,
33872 and this can make it hard to deal with other messages on the queue. To help
33873 with this situation there is a button next to &"Update"& called &"Hide"&. If
33874 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
33875 type anything in here and press &"Return"&, the text is added to a chain of
33876 such texts, and if every undelivered address in a message matches at least one
33877 of the texts, the message is not displayed.
33878
33879 If there is an address that does not match any of the texts, all the addresses
33880 are displayed as normal. The matching happens on the ends of addresses so, for
33881 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
33882 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
33883 has been set up, a button called &"Unhide"& is displayed. If pressed, it
33884 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
33885 a hide request is automatically cancelled after one hour.
33886
33887 While the dialogue box is displayed, you can't press any buttons or do anything
33888 else to the monitor window. For this reason, if you want to cut text from the
33889 queue display to use in the dialogue box, you have to do the cutting before
33890 pressing the &"Hide"& button.
33891
33892 The queue display contains, for each unhidden queued message, the length of
33893 time it has been on the queue, the size of the message, the message id, the
33894 message sender, and the first undelivered recipient, all on one line. If it is
33895 a bounce message, the sender is shown as &"<>"&. If there is more than one
33896 recipient to which the message has not yet been delivered, subsequent ones are
33897 listed on additional lines, up to a maximum configured number, following which
33898 an ellipsis is displayed. Recipients that have already received the message are
33899 not shown.
33900
33901 .cindex "frozen messages" "display"
33902 If a message is frozen, an asterisk is displayed at the left-hand side.
33903
33904 The queue display has a vertical scroll bar, and can also be scrolled by means
33905 of the arrow keys. Text can be cut from it using the mouse in the normal way.
33906 The text searching facilities, as described above for the log window, are also
33907 available, but the caret is always moved to the end of the text when the queue
33908 display is updated.
33909
33910
33911
33912 .section "The queue menu" "SECID269"
33913 .cindex "queue" "menu in monitor"
33914 If the &%shift%& key is held down and the left button is clicked when the mouse
33915 pointer is over the text for any message, an action menu pops up, and the first
33916 line of the queue display for the message is highlighted. This does not affect
33917 any selected text.
33918
33919 If you want to use some other event for popping up the menu, you can set the
33920 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
33921 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
33922 value set in this parameter is a standard X event description. For example, to
33923 run eximon using &%ctrl%& rather than &%shift%& you could use
33924 .code
33925 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
33926 .endd
33927 The title of the menu is the message id, and it contains entries which act as
33928 follows:
33929
33930 .ilist
33931 &'message log'&: The contents of the message log for the message are displayed
33932 in a new text window.
33933 .next
33934 &'headers'&: Information from the spool file that contains the envelope
33935 information and headers is displayed in a new text window. See chapter
33936 &<<CHAPspool>>& for a description of the format of spool files.
33937 .next
33938 &'body'&: The contents of the spool file containing the body of the message are
33939 displayed in a new text window. There is a default limit of 20,000 bytes to the
33940 amount of data displayed. This can be changed by setting the BODY_MAX
33941 option at compile time, or the EXIMON_BODY_MAX option at run time.
33942 .next
33943 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
33944 delivery of the message. This causes an automatic thaw if the message is
33945 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
33946 a new text window. The delivery is run in a separate process, to avoid holding
33947 up the monitor while the delivery proceeds.
33948 .next
33949 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
33950 that the message be frozen.
33951 .next
33952 .cindex "thawing messages"
33953 .cindex "unfreezing messages"
33954 .cindex "frozen messages" "thawing"
33955 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
33956 that the message be thawed.
33957 .next
33958 .cindex "delivery" "forcing failure"
33959 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
33960 that Exim gives up trying to deliver the message. A bounce message is generated
33961 for any remaining undelivered addresses.
33962 .next
33963 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
33964 that the message be deleted from the system without generating a bounce
33965 message.
33966 .next
33967 &'add recipient'&: A dialog box is displayed into which a recipient address can
33968 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
33969 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
33970 Otherwise it must be entered as a fully qualified address. Pressing RETURN
33971 causes a call to Exim to be made using the &%-Mar%& option to request that an
33972 additional recipient be added to the message, unless the entry box is empty, in
33973 which case no action is taken.
33974 .next
33975 &'mark delivered'&: A dialog box is displayed into which a recipient address
33976 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
33977 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
33978 Otherwise it must be entered as a fully qualified address. Pressing RETURN
33979 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
33980 recipient address as already delivered, unless the entry box is empty, in which
33981 case no action is taken.
33982 .next
33983 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
33984 mark all recipient addresses as already delivered.
33985 .next
33986 &'edit sender'&: A dialog box is displayed initialized with the current
33987 sender's address. Pressing RETURN causes a call to Exim to be made using the
33988 &%-Mes%& option to replace the sender address, unless the entry box is empty,
33989 in which case no action is taken. If you want to set an empty sender (as in
33990 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
33991 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
33992 the address is qualified with that domain.
33993 .endlist
33994
33995 When a delivery is forced, a window showing the &%-v%& output is displayed. In
33996 other cases when a call to Exim is made, if there is any output from Exim (in
33997 particular, if the command fails) a window containing the command and the
33998 output is displayed. Otherwise, the results of the action are normally apparent
33999 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
34000 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
34001 if no output is generated.
34002
34003 The queue display is automatically updated for actions such as freezing and
34004 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
34005 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
34006 force an update of the display after one of these actions.
34007
34008 In any text window that is displayed as result of a menu action, the normal
34009 cut-and-paste facility is available, and searching can be carried out using ^R
34010 and ^S, as described above for the log tail window.
34011 .ecindex IIDeximon
34012
34013
34014
34015
34016
34017 . ////////////////////////////////////////////////////////////////////////////
34018 . ////////////////////////////////////////////////////////////////////////////
34019
34020 .chapter "Security considerations" "CHAPsecurity"
34021 .scindex IIDsecurcon "security" "discussion of"
34022 This chapter discusses a number of issues concerned with security, some of
34023 which are also covered in other parts of this manual.
34024
34025 For reasons that this author does not understand, some people have promoted
34026 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
34027 existence of this chapter in the documentation. However, the intent of the
34028 chapter is simply to describe the way Exim works in relation to certain
34029 security concerns, not to make any specific claims about the effectiveness of
34030 its security as compared with other MTAs.
34031
34032 What follows is a description of the way Exim is supposed to be. Best efforts
34033 have been made to try to ensure that the code agrees with the theory, but an
34034 absence of bugs can never be guaranteed. Any that are reported will get fixed
34035 as soon as possible.
34036
34037
34038 .section "Building a more &""hardened""& Exim" "SECID286"
34039 .cindex "security" "build-time features"
34040 There are a number of build-time options that can be set in &_Local/Makefile_&
34041 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
34042 Exim administrator who does not have the root password, or by someone who has
34043 penetrated the Exim (but not the root) account. These options are as follows:
34044
34045 .ilist
34046 ALT_CONFIG_PREFIX can be set to a string that is required to match the
34047 start of any file names used with the &%-C%& option. When it is set, these file
34048 names are also not allowed to contain the sequence &"/../"&. (However, if the
34049 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
34050 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
34051 default setting for &%ALT_CONFIG_PREFIX%&.
34052
34053 .new
34054 If the permitted configuration files are confined to a directory to
34055 which only root has access, this guards against someone who has broken
34056 into the Exim account from running a privileged Exim with an arbitrary
34057 configuration file, and using it to break into other accounts.
34058 .next
34059
34060 If a non-trusted configuration file (i.e. not the default configuration file
34061 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
34062 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
34063 the next item), then root privilege is retained only if the caller of Exim is
34064 root. This locks out the possibility of testing a configuration using &%-C%&
34065 right through message reception and delivery, even if the caller is root. The
34066 reception works, but by that time, Exim is running as the Exim user, so when
34067 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
34068 privilege to be lost. However, root can test reception and delivery using two
34069 separate commands.
34070
34071 .next
34072 The WHITELIST_D_MACROS build option declares some macros to be safe to override
34073 with &%-D%& if the real uid is one of root, the Exim run-time user or the
34074 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
34075 requiring the run-time value supplied to &%-D%& to match a regex that errs on
34076 the restrictive side.  Requiring build-time selection of safe macros is onerous
34077 but this option is intended solely as a transition mechanism to permit
34078 previously-working configurations to continue to work after release 4.73.
34079 .next
34080 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
34081 is disabled.
34082 .next
34083 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
34084 never to be used for any deliveries. This is like the &%never_users%& runtime
34085 option, but it cannot be overridden; the runtime option adds additional users
34086 to the list. The default setting is &"root"&; this prevents a non-root user who
34087 is permitted to modify the runtime file from using Exim as a way to get root.
34088 .endlist
34089 .wen
34090
34091
34092
34093 .section "Root privilege" "SECID270"
34094 .cindex "setuid"
34095 .cindex "root privilege"
34096 The Exim binary is normally setuid to root, which means that it gains root
34097 privilege (runs as root) when it starts execution. In some special cases (for
34098 example, when the daemon is not in use and there are no local deliveries), it
34099 may be possible to run Exim setuid to some user other than root. This is
34100 discussed in the next section. However, in most installations, root privilege
34101 is required for two things:
34102
34103 .ilist
34104 To set up a socket connected to the standard SMTP port (25) when initialising
34105 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
34106 not required.
34107 .next
34108 To be able to change uid and gid in order to read users' &_.forward_& files and
34109 perform local deliveries as the receiving user or as specified in the
34110 configuration.
34111 .endlist
34112
34113 It is not necessary to be root to do any of the other things Exim does, such as
34114 receiving messages and delivering them externally over SMTP, and it is
34115 obviously more secure if Exim does not run as root except when necessary.
34116 For this reason, a user and group for Exim to use must be defined in
34117 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
34118 group"&. Their values can be changed by the run time configuration, though this
34119 is not recommended. Often a user called &'exim'& is used, but some sites use
34120 &'mail'& or another user name altogether.
34121
34122 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
34123 abdication; the process cannot regain root afterwards. Prior to release 4.00,
34124 &[seteuid()]& was used in some circumstances, but this is no longer the case.
34125
34126 After a new Exim process has interpreted its command line options, it changes
34127 uid and gid in the following cases:
34128
34129 .new
34130 .ilist
34131 .oindex "&%-C%&"
34132 .oindex "&%-D%&"
34133 If the &%-C%& option is used to specify an alternate configuration file, or if
34134 the &%-D%& option is used to define macro values for the configuration, and the
34135 calling process is not running as root, the uid and gid are changed to those of
34136 the calling process.
34137 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
34138 option may not be used at all.
34139 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
34140 can be supplied if the calling process is running as root, the Exim run-time
34141 user or CONFIGURE_OWNER, if defined.
34142 .next
34143 .oindex "&%-be%&"
34144 .oindex "&%-bf%&"
34145 .oindex "&%-bF%&"
34146 If the expansion test option (&%-be%&) or one of the filter testing options
34147 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
34148 calling process.
34149 .next
34150 If the process is not a daemon process or a queue runner process or a delivery
34151 process or a process for testing address routing (started with &%-bt%&), the
34152 uid and gid are changed to the Exim user and group. This means that Exim always
34153 runs under its own uid and gid when receiving messages. This also applies when
34154 testing address verification
34155 .oindex "&%-bv%&"
34156 .oindex "&%-bh%&"
34157 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
34158 option).
34159 .next
34160 For a daemon, queue runner, delivery, or address testing process, the uid
34161 remains as root at this stage, but the gid is changed to the Exim group.
34162 .endlist
34163 .wen
34164 The processes that initially retain root privilege behave as follows:
34165
34166 .ilist
34167 A daemon process changes the gid to the Exim group and the uid to the Exim
34168 user after setting up one or more listening sockets. The &[initgroups()]&
34169 function is called, so that if the Exim user is in any additional groups, they
34170 will be used during message reception.
34171 .next
34172 A queue runner process retains root privilege throughout its execution. Its
34173 job is to fork a controlled sequence of delivery processes.
34174 .next
34175 A delivery process retains root privilege throughout most of its execution,
34176 but any actual deliveries (that is, the transports themselves) are run in
34177 subprocesses which always change to a non-root uid and gid. For local
34178 deliveries this is typically the uid and gid of the owner of the mailbox; for
34179 remote deliveries, the Exim uid and gid are used. Once all the delivery
34180 subprocesses have been run, a delivery process changes to the Exim uid and gid
34181 while doing post-delivery tidying up such as updating the retry database and
34182 generating bounce and warning messages.
34183
34184 While the recipient addresses in a message are being routed, the delivery
34185 process runs as root. However, if a user's filter file has to be processed,
34186 this is done in a subprocess that runs under the individual user's uid and
34187 gid. A system filter is run as root unless &%system_filter_user%& is set.
34188 .next
34189 A process that is testing addresses (the &%-bt%& option) runs as root so that
34190 the routing is done in the same environment as a message delivery.
34191 .endlist
34192
34193
34194
34195
34196 .section "Running Exim without privilege" "SECTrunexiwitpri"
34197 .cindex "privilege, running without"
34198 .cindex "unprivileged running"
34199 .cindex "root privilege" "running without"
34200 Some installations like to run Exim in an unprivileged state for more of its
34201 operation, for added security. Support for this mode of operation is provided
34202 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
34203 gid are changed to the Exim user and group at the start of a delivery process
34204 (and also queue runner and address testing processes). This means that address
34205 routing is no longer run as root, and the deliveries themselves cannot change
34206 to any other uid.
34207
34208 .cindex SIGHUP
34209 .cindex "daemon" "restarting"
34210 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
34211 that the daemon can still be started in the usual way, and it can respond
34212 correctly to SIGHUP because the re-invocation regains root privilege.
34213
34214 An alternative approach is to make Exim setuid to the Exim user and also setgid
34215 to the Exim group. If you do this, the daemon must be started from a root
34216 process. (Calling Exim from a root process makes it behave in the way it does
34217 when it is setuid root.) However, the daemon cannot restart itself after a
34218 SIGHUP signal because it cannot regain privilege.
34219
34220 It is still useful to set &%deliver_drop_privilege%& in this case, because it
34221 stops Exim from trying to re-invoke itself to do a delivery after a message has
34222 been received. Such a re-invocation is a waste of resources because it has no
34223 effect.
34224
34225 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
34226 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
34227 to the Exim user seems a clean approach, but there is one complication:
34228
34229 In this style of operation, Exim is running with the real uid and gid set to
34230 those of the calling process, and the effective uid/gid set to Exim's values.
34231 Ideally, any association with the calling process' uid/gid should be dropped,
34232 that is, the real uid/gid should be reset to the effective values so as to
34233 discard any privileges that the caller may have. While some operating systems
34234 have a function that permits this action for a non-root effective uid, quite a
34235 number of them do not. Because of this lack of standardization, Exim does not
34236 address this problem at this time.
34237
34238 For this reason, the recommended approach for &"mostly unprivileged"& running
34239 is to keep the Exim binary setuid to root, and to set
34240 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
34241 be used in the most straightforward way.
34242
34243 If you configure Exim not to run delivery processes as root, there are a
34244 number of restrictions on what you can do:
34245
34246 .ilist
34247 You can deliver only as the Exim user/group. You should  explicitly use the
34248 &%user%& and &%group%& options to override routers or local transports that
34249 normally deliver as the recipient. This makes sure that configurations that
34250 work in this mode function the same way in normal mode. Any implicit or
34251 explicit specification of another user causes an error.
34252 .next
34253 Use of &_.forward_& files is severely restricted, such that it is usually
34254 not worthwhile to include them in the configuration.
34255 .next
34256 Users who wish to use &_.forward_& would have to make their home directory and
34257 the file itself accessible to the Exim user. Pipe and append-to-file entries,
34258 and their equivalents in Exim filters, cannot be used. While they could be
34259 enabled in the Exim user's name, that would be insecure and not very useful.
34260 .next
34261 Unless the local user mailboxes are all owned by the Exim user (possible in
34262 some POP3 or IMAP-only environments):
34263
34264 .olist
34265 They must be owned by the Exim group and be writeable by that group. This
34266 implies you must set &%mode%& in the appendfile configuration, as well as the
34267 mode of the mailbox files themselves.
34268 .next
34269 You must set &%no_check_owner%&, since most or all of the files will not be
34270 owned by the Exim user.
34271 .next
34272 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
34273 on a newly created mailbox when unprivileged. This also implies that new
34274 mailboxes need to be created manually.
34275 .endlist olist
34276 .endlist ilist
34277
34278
34279 These restrictions severely restrict what can be done in local deliveries.
34280 However, there are no restrictions on remote deliveries. If you are running a
34281 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
34282 gives more security at essentially no cost.
34283
34284 If you are using the &%mua_wrapper%& facility (see chapter
34285 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
34286
34287
34288
34289
34290 .section "Delivering to local files" "SECID271"
34291 Full details of the checks applied by &(appendfile)& before it writes to a file
34292 are given in chapter &<<CHAPappendfile>>&.
34293
34294
34295
34296 .section "IPv4 source routing" "SECID272"
34297 .cindex "source routing" "in IP packets"
34298 .cindex "IP source routing"
34299 Many operating systems suppress IP source-routed packets in the kernel, but
34300 some cannot be made to do this, so Exim does its own check. It logs incoming
34301 IPv4 source-routed TCP calls, and then drops them. Things are all different in
34302 IPv6. No special checking is currently done.
34303
34304
34305
34306 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
34307 Support for these SMTP commands is disabled by default. If required, they can
34308 be enabled by defining suitable ACLs.
34309
34310
34311
34312
34313 .section "Privileged users" "SECID274"
34314 .cindex "trusted users"
34315 .cindex "admin user"
34316 .cindex "privileged user"
34317 .cindex "user" "trusted"
34318 .cindex "user" "admin"
34319 Exim recognizes two sets of users with special privileges. Trusted users are
34320 able to submit new messages to Exim locally, but supply their own sender
34321 addresses and information about a sending host. For other users submitting
34322 local messages, Exim sets up the sender address from the uid, and doesn't
34323 permit a remote host to be specified.
34324
34325 .oindex "&%-f%&"
34326 However, an untrusted user is permitted to use the &%-f%& command line option
34327 in the special form &%-f <>%& to indicate that a delivery failure for the
34328 message should not cause an error report. This affects the message's envelope,
34329 but it does not affect the &'Sender:'& header. Untrusted users may also be
34330 permitted to use specific forms of address with the &%-f%& option by setting
34331 the &%untrusted_set_sender%& option.
34332
34333 Trusted users are used to run processes that receive mail messages from some
34334 other mail domain and pass them on to Exim for delivery either locally, or over
34335 the Internet. Exim trusts a caller that is running as root, as the Exim user,
34336 as any user listed in the &%trusted_users%& configuration option, or under any
34337 group listed in the &%trusted_groups%& option.
34338
34339 Admin users are permitted to do things to the messages on Exim's queue. They
34340 can freeze or thaw messages, cause them to be returned to their senders, remove
34341 them entirely, or modify them in various ways. In addition, admin users can run
34342 the Exim monitor and see all the information it is capable of providing, which
34343 includes the contents of files on the spool.
34344
34345 .oindex "&%-M%&"
34346 .oindex "&%-q%&"
34347 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
34348 delivery of messages on its queue is restricted to admin users. This
34349 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
34350 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
34351 queue is also restricted to admin users. This restriction can be relaxed by
34352 setting &%no_queue_list_requires_admin%&.
34353
34354 Exim recognizes an admin user if the calling process is running as root or as
34355 the Exim user or if any of the groups associated with the calling process is
34356 the Exim group. It is not necessary actually to be running under the Exim
34357 group. However, if admin users who are not root or the Exim user are to access
34358 the contents of files on the spool via the Exim monitor (which runs
34359 unprivileged), Exim must be built to allow group read access to its spool
34360 files.
34361
34362
34363
34364 .section "Spool files" "SECID275"
34365 .cindex "spool directory" "files"
34366 Exim's spool directory and everything it contains is owned by the Exim user and
34367 set to the Exim group. The mode for spool files is defined in the
34368 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
34369 any user who is a member of the Exim group can access these files.
34370
34371
34372
34373 .section "Use of argv[0]" "SECID276"
34374 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
34375 of specific strings, Exim assumes certain options. For example, calling Exim
34376 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
34377 to calling it with the option &%-bS%&. There are no security implications in
34378 this.
34379
34380
34381
34382 .section "Use of %f formatting" "SECID277"
34383 The only use made of &"%f"& by Exim is in formatting load average values. These
34384 are actually stored in integer variables as 1000 times the load average.
34385 Consequently, their range is limited and so therefore is the length of the
34386 converted output.
34387
34388
34389
34390 .section "Embedded Exim path" "SECID278"
34391 Exim uses its own path name, which is embedded in the code, only when it needs
34392 to re-exec in order to regain root privilege. Therefore, it is not root when it
34393 does so. If some bug allowed the path to get overwritten, it would lead to an
34394 arbitrary program's being run as exim, not as root.
34395
34396
34397
34398 .new
34399 .section "Dynamic module directory" "SECTdynmoddir"
34400 Any dynamically loadable modules must be installed into the directory
34401 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
34402 loading it.
34403 .wen
34404
34405
34406 .section "Use of sprintf()" "SECID279"
34407 .cindex "&[sprintf()]&"
34408 A large number of occurrences of &"sprintf"& in the code are actually calls to
34409 &'string_sprintf()'&, a function that returns the result in malloc'd store.
34410 The intermediate formatting is done into a large fixed buffer by a function
34411 that runs through the format string itself, and checks the length of each
34412 conversion before performing it, thus preventing buffer overruns.
34413
34414 The remaining uses of &[sprintf()]& happen in controlled circumstances where
34415 the output buffer is known to be sufficiently long to contain the converted
34416 string.
34417
34418
34419
34420 .section "Use of debug_printf() and log_write()" "SECID280"
34421 Arbitrary strings are passed to both these functions, but they do their
34422 formatting by calling the function &'string_vformat()'&, which runs through
34423 the format string itself, and checks the length of each conversion.
34424
34425
34426
34427 .section "Use of strcat() and strcpy()" "SECID281"
34428 These are used only in cases where the output buffer is known to be large
34429 enough to hold the result.
34430 .ecindex IIDsecurcon
34431
34432
34433
34434
34435 . ////////////////////////////////////////////////////////////////////////////
34436 . ////////////////////////////////////////////////////////////////////////////
34437
34438 .chapter "Format of spool files" "CHAPspool"
34439 .scindex IIDforspo1 "format" "spool files"
34440 .scindex IIDforspo2 "spool directory" "format of files"
34441 .scindex IIDforspo3 "spool files" "format of"
34442 .cindex "spool files" "editing"
34443 A message on Exim's queue consists of two files, whose names are the message id
34444 followed by -D and -H, respectively. The data portion of the message is kept in
34445 the -D file on its own. The message's envelope, status, and headers are all
34446 kept in the -H file, whose format is described in this chapter. Each of these
34447 two files contains the final component of its own name as its first line. This
34448 is insurance against disk crashes where the directory is lost but the files
34449 themselves are recoverable.
34450
34451 Some people are tempted into editing -D files in order to modify messages. You
34452 need to be extremely careful if you do this; it is not recommended and you are
34453 on your own if you do it. Here are some of the pitfalls:
34454
34455 .ilist
34456 You must ensure that Exim does not try to deliver the message while you are
34457 fiddling with it. The safest way is to take out a write lock on the -D file,
34458 which is what Exim itself does, using &[fcntl()]&. If you update the file in
34459 place, the lock will be retained. If you write a new file and rename it, the
34460 lock will be lost at the instant of rename.
34461 .next
34462 .vindex "&$body_linecount$&"
34463 If you change the number of lines in the file, the value of
34464 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
34465 present, this value is not used by Exim, but there is no guarantee that this
34466 will always be the case.
34467 .next
34468 If the message is in MIME format, you must take care not to break it.
34469 .next
34470 If the message is cryptographically signed, any change will invalidate the
34471 signature.
34472 .endlist
34473 All in all, modifying -D files is fraught with danger.
34474
34475 Files whose names end with -J may also be seen in the &_input_& directory (or
34476 its subdirectories when &%split_spool_directory%& is set). These are journal
34477 files, used to record addresses to which the message has been delivered during
34478 the course of a delivery attempt. If there are still undelivered recipients at
34479 the end, the -H file is updated, and the -J file is deleted. If, however, there
34480 is some kind of crash (for example, a power outage) before this happens, the -J
34481 file remains in existence. When Exim next processes the message, it notices the
34482 -J file and uses it to update the -H file before starting the next delivery
34483 attempt.
34484
34485 .section "Format of the -H file" "SECID282"
34486 .cindex "uid (user id)" "in spool file"
34487 .cindex "gid (group id)" "in spool file"
34488 The second line of the -H file contains the login name for the uid of the
34489 process that called Exim to read the message, followed by the numerical uid and
34490 gid. For a locally generated message, this is normally the user who sent the
34491 message. For a message received over TCP/IP via the daemon, it is
34492 normally the Exim user.
34493
34494 The third line of the file contains the address of the message's sender as
34495 transmitted in the envelope, contained in angle brackets. The sender address is
34496 empty for bounce messages. For incoming SMTP mail, the sender address is given
34497 in the MAIL command. For locally generated mail, the sender address is
34498 created by Exim from the login name of the current user and the configured
34499 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
34500 leading &"From&~"& line if the caller is trusted, or if the supplied address is
34501 &"<>"& or an address that matches &%untrusted_set_senders%&.
34502
34503 The fourth line contains two numbers. The first is the time that the message
34504 was received, in the conventional Unix form &-- the number of seconds since the
34505 start of the epoch. The second number is a count of the number of messages
34506 warning of delayed delivery that have been sent to the sender.
34507
34508 There follow a number of lines starting with a hyphen. These can appear in any
34509 order, and are omitted when not relevant:
34510
34511 .vlist
34512 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
34513 This item is obsolete, and is not generated from Exim release 4.61 onwards;
34514 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
34515 recognized, to provide backward compatibility. In the old format, a line of
34516 this form is present for every ACL variable that is not empty. The number
34517 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
34518 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
34519 the data string for the variable. The string itself starts at the beginning of
34520 the next line, and is followed by a newline character. It may contain internal
34521 newlines.
34522
34523 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
34524 A line of this form is present for every ACL connection variable that is
34525 defined. Note that there is a space between &%-aclc%& and the rest of the name.
34526 The length is the length of the data string for the variable. The string itself
34527 starts at the beginning of the next line, and is followed by a newline
34528 character. It may contain internal newlines.
34529
34530 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
34531 A line of this form is present for every ACL message variable that is defined.
34532 Note that there is a space between &%-aclm%& and the rest of the name. The
34533 length is the length of the data string for the variable. The string itself
34534 starts at the beginning of the next line, and is followed by a newline
34535 character. It may contain internal newlines.
34536
34537 .vitem "&%-active_hostname%&&~<&'hostname'&>"
34538 This is present if, when the message was received over SMTP, the value of
34539 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
34540
34541 .vitem &%-allow_unqualified_recipient%&
34542 This is present if unqualified recipient addresses are permitted in header
34543 lines (to stop such addresses from being qualified if rewriting occurs at
34544 transport time). Local messages that were input using &%-bnq%& and remote
34545 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
34546
34547 .vitem &%-allow_unqualified_sender%&
34548 This is present if unqualified sender addresses are permitted in header lines
34549 (to stop such addresses from being qualified if rewriting occurs at transport
34550 time). Local messages that were input using &%-bnq%& and remote messages from
34551 hosts that match &%sender_unqualified_hosts%& set this flag.
34552
34553 .vitem "&%-auth_id%&&~<&'text'&>"
34554 The id information for a message received on an authenticated SMTP connection
34555 &-- the value of the &$authenticated_id$& variable.
34556
34557 .vitem "&%-auth_sender%&&~<&'address'&>"
34558 The address of an authenticated sender &-- the value of the
34559 &$authenticated_sender$& variable.
34560
34561 .vitem "&%-body_linecount%&&~<&'number'&>"
34562 This records the number of lines in the body of the message, and is always
34563 present.
34564
34565 .vitem "&%-body_zerocount%&&~<&'number'&>"
34566 This records the number of binary zero bytes in the body of the message, and is
34567 present if the number is greater than zero.
34568
34569 .vitem &%-deliver_firsttime%&
34570 This is written when a new message is first added to the spool. When the spool
34571 file is updated after a deferral, it is omitted.
34572
34573 .vitem "&%-frozen%&&~<&'time'&>"
34574 .cindex "frozen messages" "spool data"
34575 The message is frozen, and the freezing happened at <&'time'&>.
34576
34577 .vitem "&%-helo_name%&&~<&'text'&>"
34578 This records the host name as specified by a remote host in a HELO or EHLO
34579 command.
34580
34581 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
34582 This records the IP address of the host from which the message was received and
34583 the remote port number that was used. It is omitted for locally generated
34584 messages.
34585
34586 .vitem "&%-host_auth%&&~<&'text'&>"
34587 If the message was received on an authenticated SMTP connection, this records
34588 the name of the authenticator &-- the value of the
34589 &$sender_host_authenticated$& variable.
34590
34591 .vitem &%-host_lookup_failed%&
34592 This is present if an attempt to look up the sending host's name from its IP
34593 address failed. It corresponds to the &$host_lookup_failed$& variable.
34594
34595 .vitem "&%-host_name%&&~<&'text'&>"
34596 .cindex "reverse DNS lookup"
34597 .cindex "DNS" "reverse lookup"
34598 This records the name of the remote host from which the message was received,
34599 if the host name was looked up from the IP address when the message was being
34600 received. It is not present if no reverse lookup was done.
34601
34602 .vitem "&%-ident%&&~<&'text'&>"
34603 For locally submitted messages, this records the login of the originating user,
34604 unless it was a trusted user and the &%-oMt%& option was used to specify an
34605 ident value. For messages received over TCP/IP, this records the ident string
34606 supplied by the remote host, if any.
34607
34608 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
34609 This records the IP address of the local interface and the port number through
34610 which a message was received from a remote host. It is omitted for locally
34611 generated messages.
34612
34613 .vitem &%-local%&
34614 The message is from a local sender.
34615
34616 .vitem &%-localerror%&
34617 The message is a locally-generated bounce message.
34618
34619 .vitem "&%-local_scan%&&~<&'string'&>"
34620 This records the data string that was returned by the &[local_scan()]& function
34621 when the message was received &-- the value of the &$local_scan_data$&
34622 variable. It is omitted if no data was returned.
34623
34624 .vitem &%-manual_thaw%&
34625 The message was frozen but has been thawed manually, that is, by an explicit
34626 Exim command rather than via the auto-thaw process.
34627
34628 .vitem &%-N%&
34629 A testing delivery process was started using the &%-N%& option to suppress any
34630 actual deliveries, but delivery was deferred. At any further delivery attempts,
34631 &%-N%& is assumed.
34632
34633 .vitem &%-received_protocol%&
34634 This records the value of the &$received_protocol$& variable, which contains
34635 the name of the protocol by which the message was received.
34636
34637 .vitem &%-sender_set_untrusted%&
34638 The envelope sender of this message was set by an untrusted local caller (used
34639 to ensure that the caller is displayed in queue listings).
34640
34641 .vitem "&%-spam_score_int%&&~<&'number'&>"
34642 If a message was scanned by SpamAssassin, this is present. It records the value
34643 of &$spam_score_int$&.
34644
34645 .vitem &%-tls_certificate_verified%&
34646 A TLS certificate was received from the client that sent this message, and the
34647 certificate was verified by the server.
34648
34649 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
34650 When the message was received over an encrypted connection, this records the
34651 name of the cipher suite that was used.
34652
34653 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
34654 When the message was received over an encrypted connection, and a certificate
34655 was received from the client, this records the Distinguished Name from that
34656 certificate.
34657 .endlist
34658
34659 Following the options there is a list of those addresses to which the message
34660 is not to be delivered. This set of addresses is initialized from the command
34661 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
34662 is set; otherwise it starts out empty. Whenever a successful delivery is made,
34663 the address is added to this set. The addresses are kept internally as a
34664 balanced binary tree, and it is a representation of that tree which is written
34665 to the spool file. If an address is expanded via an alias or forward file, the
34666 original address is added to the tree when deliveries to all its child
34667 addresses are complete.
34668
34669 If the tree is empty, there is a single line in the spool file containing just
34670 the text &"XX"&. Otherwise, each line consists of two letters, which are either
34671 Y or N, followed by an address. The address is the value for the node of the
34672 tree, and the letters indicate whether the node has a left branch and/or a
34673 right branch attached to it, respectively. If branches exist, they immediately
34674 follow. Here is an example of a three-node tree:
34675 .code
34676 YY darcy@austen.fict.example
34677 NN alice@wonderland.fict.example
34678 NN editor@thesaurus.ref.example
34679 .endd
34680 After the non-recipients tree, there is a list of the message's recipients.
34681 This is a simple list, preceded by a count. It includes all the original
34682 recipients of the message, including those to whom the message has already been
34683 delivered. In the simplest case, the list contains one address per line. For
34684 example:
34685 .code
34686 4
34687 editor@thesaurus.ref.example
34688 darcy@austen.fict.example
34689 rdo@foundation
34690 alice@wonderland.fict.example
34691 .endd
34692 However, when a child address has been added to the top-level addresses as a
34693 result of the use of the &%one_time%& option on a &(redirect)& router, each
34694 line is of the following form:
34695 .display
34696 <&'top-level address'&> <&'errors_to address'&> &&&
34697   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
34698 .endd
34699 The 01 flag bit indicates the presence of the three other fields that follow
34700 the top-level address. Other bits may be used in future to support additional
34701 fields. The <&'parent number'&> is the offset in the recipients list of the
34702 original parent of the &"one time"& address. The first two fields are the
34703 envelope sender that is associated with this address and its length. If the
34704 length is zero, there is no special envelope sender (there are then two space
34705 characters in the line). A non-empty field can arise from a &(redirect)& router
34706 that has an &%errors_to%& setting.
34707
34708
34709 A blank line separates the envelope and status information from the headers
34710 which follow. A header may occupy several lines of the file, and to save effort
34711 when reading it in, each header is preceded by a number and an identifying
34712 character. The number is the number of characters in the header, including any
34713 embedded newlines and the terminating newline. The character is one of the
34714 following:
34715
34716 .table2 50pt
34717 .row <&'blank'&>         "header in which Exim has no special interest"
34718 .row &`B`&               "&'Bcc:'& header"
34719 .row &`C`&               "&'Cc:'& header"
34720 .row &`F`&               "&'From:'& header"
34721 .row &`I`&               "&'Message-id:'& header"
34722 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
34723 .row &`R`&               "&'Reply-To:'& header"
34724 .row &`S`&               "&'Sender:'& header"
34725 .row &`T`&               "&'To:'& header"
34726 .row &`*`&               "replaced or deleted header"
34727 .endtable
34728
34729 Deleted or replaced (rewritten) headers remain in the spool file for debugging
34730 purposes. They are not transmitted when the message is delivered. Here is a
34731 typical set of headers:
34732 .code
34733 111P Received: by hobbit.fict.example with local (Exim 4.00)
34734 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
34735 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
34736 038* X-rewrote-sender: bb@hobbit.fict.example
34737 042* From: Bilbo Baggins <bb@hobbit.fict.example>
34738 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
34739 099* To: alice@wonderland.fict.example, rdo@foundation,
34740 darcy@austen.fict.example, editor@thesaurus.ref.example
34741 104T To: alice@wonderland.fict.example, rdo@foundation.example,
34742 darcy@austen.fict.example, editor@thesaurus.ref.example
34743 038  Date: Fri, 11 May 2001 10:28:59 +0100
34744 .endd
34745 The asterisked headers indicate that the envelope sender, &'From:'& header, and
34746 &'To:'& header have been rewritten, the last one because routing expanded the
34747 unqualified domain &'foundation'&.
34748 .ecindex IIDforspo1
34749 .ecindex IIDforspo2
34750 .ecindex IIDforspo3
34751
34752 . ////////////////////////////////////////////////////////////////////////////
34753 . ////////////////////////////////////////////////////////////////////////////
34754
34755 .chapter "Support for DKIM (DomainKeys Identified Mail) - RFC4871" "CHID12" &&&
34756          "DKIM Support"
34757 .cindex "DKIM"
34758
34759 Since version 4.70, DKIM support is compiled into Exim by default. It can be
34760 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
34761
34762 .new
34763 Exim's DKIM implementation allows to
34764 .olist
34765 Sign outgoing messages: This function is implemented in the SMTP transport.
34766 It can co-exist with all other Exim features, including transport filters.
34767 .next
34768 Verify signatures in incoming messages: This is implemented by an additional
34769 ACL (acl_smtp_dkim), which can be called several times per message, with
34770 different signature contexts.
34771 .endlist
34772 .wen
34773 In typical Exim style, the verification implementation does not include any
34774 default "policy". Instead it enables you to build your own policy using
34775 Exim's standard controls.
34776
34777 Please note that verification of DKIM signatures in incoming mail is turned
34778 on by default for logging purposes. For each signature in incoming email,
34779 exim will log a line displaying the most important signature details, and the
34780 signature status. Here is an example:
34781 .code
34782 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]
34783 .endd
34784 You might want to turn off DKIM verification processing entirely for internal
34785 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
34786 control modifier. This should typically be done in the RCPT ACL, at points
34787 where you accept mail from relay sources (internal hosts or authenticated
34788 senders).
34789
34790
34791 .section "Signing outgoing messages" "SECID513"
34792 .cindex "DKIM" "signing"
34793
34794 Signing is implemented by setting private options on the SMTP transport.
34795 These options take (expandable) strings as arguments.
34796
34797 .new
34798 .option dkim_domain smtp string&!! unset
34799 MANDATORY:
34800 The domain you want to sign with. The result of this expanded
34801 option is put into the &%$dkim_domain%& expansion variable.
34802
34803 .option dkim_selector smtp string&!! unset
34804 MANDATORY:
34805 This sets the key selector string. You can use the &%$dkim_domain%& expansion
34806 variable to look up a matching selector. The result is put in the expansion
34807 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
34808 option along with &%$dkim_domain%&.
34809
34810 .option dkim_private_key smtp string&!! unset
34811 MANDATORY:
34812 This sets the private key to use. You can use the &%$dkim_domain%& and
34813 &%$dkim_selector%& expansion variables to determine the private key to use.
34814 The result can either
34815 .ilist
34816 be a valid RSA private key in ASCII armor, including line breaks.
34817 .next
34818 start with a slash, in which case it is treated as a file that contains
34819 the private key.
34820 .next
34821 be "0", "false" or the empty string, in which case the message will not
34822 be signed. This case will not result in an error, even if &%dkim_strict%&
34823 is set.
34824 .endlist
34825
34826 .option dkim_canon smtp string&!! unset
34827 OPTIONAL:
34828 This option sets the canonicalization method used when signing a message.
34829 The DKIM RFC currently supports two methods: "simple" and "relaxed".
34830 The option defaults to "relaxed" when unset. Note: the current implementation
34831 only supports using the same canonicalization method for both headers and body.
34832
34833 .option dkim_strict smtp string&!! unset
34834 OPTIONAL:
34835 This  option  defines  how  Exim  behaves  when  signing a message that
34836 should be signed fails for some reason.  When the expansion evaluates to
34837 either "1" or "true", Exim will defer. Otherwise Exim will send the message
34838 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
34839 variables here.
34840
34841 .option dkim_sign_headers smtp string&!! unset
34842 OPTIONAL:
34843 When set, this option must expand to (or be specified as) a colon-separated
34844 list of header names. Headers with these names will be included in the message
34845 signature. When unspecified, the header names recommended in RFC4871 will be
34846 used.
34847 .wen
34848
34849 .section "Verifying DKIM signatures in incoming mail" "SECID514"
34850 .cindex "DKIM" "verification"
34851
34852 Verification of DKIM signatures in incoming email is implemented via the
34853 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
34854 syntactically(!) correct signature in the incoming message.
34855
34856 To evaluate the signature in the ACL a large number of expansion variables
34857 containing the signature status and its details are set up during the
34858 runtime of the ACL.
34859
34860 Calling the ACL only for existing signatures is not sufficient to build
34861 more advanced policies. For that reason, the global option
34862 &%dkim_verify_signers%&, and a global expansion variable
34863 &%$dkim_signers%& exist.
34864
34865 .new
34866 The global option &%dkim_verify_signers%& can be set to a colon-separated
34867 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
34868 called. It is expanded when the message has been received. At this point,
34869 the expansion variable &%$dkim_signers%& already contains a colon-separated
34870 list of signer domains and identities for the message. When
34871 &%dkim_verify_signers%& is not specified in the main configuration,
34872 it defaults as:
34873 .code
34874 dkim_verify_signers = $dkim_signers
34875 .endd
34876 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
34877 DKIM signature in the message. Current DKIM verifiers may want to explicitly
34878 call the ACL for known domains or identities. This would be achieved as follows:
34879 .code
34880 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
34881 .endd
34882 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
34883 and "ebay.com", plus all domains and identities that have signatures in the message.
34884 You can also be more creative in constructing your policy. For example:
34885 .code
34886 dkim_verify_signers = $sender_address_domain:$dkim_signers
34887 .endd
34888 .wen
34889 If a domain or identity is listed several times in the (expanded) value of
34890 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
34891
34892
34893 Inside the &%acl_smtp_dkim%&, the following expansion variables are
34894 available (from most to least important):
34895
34896 .new
34897 .vlist
34898 .vitem &%$dkim_cur_signer%&
34899 The signer that is being evaluated in this ACL run. This can be a domain or
34900 an identity. This is one of the list items from the expanded main option
34901 &%dkim_verify_signers%& (see above).
34902 .vitem &%$dkim_verify_status%&
34903 A string describing the general status of the signature. One of
34904 .ilist
34905 &%none%&: There is no signature in the message for the current domain or
34906 identity (as reflected by &%$dkim_cur_signer%&).
34907 .next
34908 &%invalid%&: The signature could not be verified due to a processing error.
34909 More detail is available in &%$dkim_verify_reason%&.
34910 .next
34911 &%fail%&: Verification of the signature failed.  More detail is
34912 available in &%$dkim_verify_reason%&.
34913 .next
34914 &%pass%&: The signature passed verification. It is valid.
34915 .endlist
34916 .vitem &%$dkim_verify_reason%&
34917 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
34918 "fail" or "invalid". One of
34919 .ilist
34920 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
34921 key for the domain could not be retrieved. This may be a temporary problem.
34922 .next
34923 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
34924 record for the domain is syntactically invalid.
34925 .next
34926 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
34927 body hash does not match the one specified in the signature header. This
34928 means that the message body was modified in transit.
34929 .next
34930 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
34931 could not be verified. This may mean that headers were modified,
34932 re-written or otherwise changed in a way which is incompatible with
34933 DKIM verification. It may of course also mean that the signature is forged.
34934 .endlist
34935 .vitem &%$dkim_domain%&
34936 The signing domain. IMPORTANT: This variable is only populated if there is
34937 an actual signature in the message for the current domain or identity (as
34938 reflected by &%$dkim_cur_signer%&).
34939 .vitem &%$dkim_identity%&
34940 The signing identity, if present. IMPORTANT: This variable is only populated
34941 if there is an actual signature in the message for the current domain or
34942 identity (as reflected by &%$dkim_cur_signer%&).
34943 .vitem &%$dkim_selector%&
34944 The key record selector string.
34945 .vitem &%$dkim_algo%&
34946 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
34947 .vitem &%$dkim_canon_body%&
34948 The body canonicalization method. One of 'relaxed' or 'simple'.
34949 .vitem &%dkim_canon_headers%&
34950 The header canonicalization method. One of 'relaxed' or 'simple'.
34951 .vitem &%$dkim_copiedheaders%&
34952 A transcript of headers and their values which are included in the signature
34953 (copied from the 'z=' tag of the signature).
34954 .vitem &%$dkim_bodylength%&
34955 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
34956 limit was set by the signer, "9999999999999" is returned. This makes sure
34957 that this variable always expands to an integer value.
34958 .vitem &%$dkim_created%&
34959 UNIX timestamp reflecting the date and time when the signature was created.
34960 When this was not specified by the signer, "0" is returned.
34961 .vitem &%$dkim_expires%&
34962 UNIX timestamp reflecting the date and time when the signer wants the
34963 signature to be treated as "expired". When this was not specified by the
34964 signer, "9999999999999" is returned. This makes it possible to do useful
34965 integer size comparisons against this value.
34966 .vitem &%$dkim_headernames%&
34967 A colon-separated list of names of headers included in the signature.
34968 .vitem &%$dkim_key_testing%&
34969 "1" if the key record has the "testing" flag set, "0" if not.
34970 .vitem &%$dkim_key_nosubdomaining%&
34971 "1" if the key record forbids subdomaining, "0" otherwise.
34972 .vitem &%$dkim_key_srvtype%&
34973 Service type (tag s=) from the key record. Defaults to "*" if not specified
34974 in the key record.
34975 .vitem &%$dkim_key_granularity%&
34976 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
34977 in the key record.
34978 .vitem &%$dkim_key_notes%&
34979 Notes from the key record (tag n=).
34980 .endlist
34981 .wen
34982 In addition, two ACL conditions are provided:
34983
34984 .new
34985 .vlist
34986 .vitem &%dkim_signers%&
34987 ACL condition that checks a colon-separated list of domains or identities
34988 for a match against the domain or identity that the ACL is currently verifying
34989 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
34990 verb to a group of domains or identities. For example:
34991 .wen
34992 .code
34993 # Warn when message apparently from GMail has no signature at all
34994 warn log_message = GMail sender without DKIM signature
34995      sender_domains = gmail.com
34996      dkim_signers = gmail.com
34997      dkim_status = none
34998 .endd
34999
35000 .vitem &%dkim_status%&
35001 ACL condition that checks a colon-separated list of possible DKIM verification
35002 results agains the actual result of verification. This is typically used
35003 to restrict an ACL verb to a list of verification outcomes, like:
35004
35005 .code
35006 deny message = Message from Paypal with invalid or missing signature
35007      sender_domains = paypal.com:paypal.de
35008      dkim_signers = paypal.com:paypal.de
35009      dkim_status = none:invalid:fail
35010 .endd
35011
35012 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
35013 see the documentation of the &%$dkim_verify_status%& expansion variable above
35014 for more information of what they mean.
35015 .endlist
35016
35017 . ////////////////////////////////////////////////////////////////////////////
35018 . ////////////////////////////////////////////////////////////////////////////
35019
35020 .chapter "Adding new drivers or lookup types" "CHID13" &&&
35021          "Adding drivers or lookups"
35022 .cindex "adding drivers"
35023 .cindex "new drivers, adding"
35024 .cindex "drivers" "adding new"
35025 The following actions have to be taken in order to add a new router, transport,
35026 authenticator, or lookup type to Exim:
35027
35028 .olist
35029 Choose a name for the driver or lookup type that does not conflict with any
35030 existing name; I will use &"newdriver"& in what follows.
35031 .next
35032 Add to &_src/EDITME_& the line:
35033 .display
35034 <&'type'&>&`_NEWDRIVER=yes`&
35035 .endd
35036 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
35037 code is not to be included in the binary by default, comment this line out. You
35038 should also add any relevant comments about the driver or lookup type.
35039 .next
35040 Add to &_src/config.h.defaults_& the line:
35041 .code
35042 #define <type>_NEWDRIVER
35043 .endd
35044 .next
35045 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
35046 and create a table entry as is done for all the other drivers and lookup types.
35047 .next
35048 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
35049 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
35050 driver or lookup type and add it to the definition of OBJ.
35051 .next
35052 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
35053 &_src_&.
35054 .next
35055 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
35056 as for other drivers and lookups.
35057 .endlist
35058
35059 Then all you need to do is write the code! A good way to start is to make a
35060 proforma by copying an existing module of the same type, globally changing all
35061 occurrences of the name, and cutting out most of the code. Note that any
35062 options you create must be listed in alphabetical order, because the tables are
35063 searched using a binary chop procedure.
35064
35065 There is a &_README_& file in each of the sub-directories of &_src_& describing
35066 the interface that is expected.
35067
35068
35069
35070
35071 . ////////////////////////////////////////////////////////////////////////////
35072 . ////////////////////////////////////////////////////////////////////////////
35073
35074 . /////////////////////////////////////////////////////////////////////////////
35075 . These lines are processing instructions for the Simple DocBook Processor that
35076 . Philip Hazel has developed as a less cumbersome way of making PostScript and
35077 . PDFs than using xmlto and fop. They will be ignored by all other XML
35078 . processors.
35079 . /////////////////////////////////////////////////////////////////////////////
35080
35081 .literal xml
35082 <?sdop
35083   format="newpage"
35084   foot_right_recto="&chaptertitle;"
35085   foot_right_verso="&chaptertitle;"
35086 ?>
35087 .literal off
35088
35089 .makeindex "Options index"   "option"
35090 .makeindex "Variables index" "variable"
35091 .makeindex "Concept index"   "concept"
35092
35093
35094 . /////////////////////////////////////////////////////////////////////////////
35095 . /////////////////////////////////////////////////////////////////////////////