Add dnsdb lookup pseudo-type "a+". Addresses bug 1269.
[users/heiko/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printing and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generate the outermost <book> element that wraps then entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing. Remember that
45 . the <bookinfo> element must also be updated for each new edition.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.80"
49 .set version "4.80"
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54
55 . /////////////////////////////////////////////////////////////////////////////
56 . Additional xfpt markup used by this document, over and above the default
57 . provided in the xfpt library.
58 . /////////////////////////////////////////////////////////////////////////////
59
60 . --- Override the &$ flag to automatically insert a $ with the variable name
61
62 .flag &$  $&   "<varname>$"  "</varname>"
63
64 . --- Short flags for daggers in option headings. They will always be inside
65 . --- an italic string, but we want the daggers to be roman.
66
67 .flag &!!      "</emphasis>&dagger;<emphasis>"
68 .flag &!?      "</emphasis>&Dagger;<emphasis>"
69
70 . --- A macro for an Exim option definition heading, generating a one-line
71 . --- table with four columns. For cases when the option name is given with
72 . --- a space, so that it can be split, a fifth argument is used for the
73 . --- index entry.
74
75 .macro option
76 .arg 5
77 .oindex "&%$5%&"
78 .endarg
79 .arg -5
80 .oindex "&%$1%&"
81 .endarg
82 .itable all 0 0 4 8* left 6* center 6* center 6* right
83 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
84 .endtable
85 .endmacro
86
87 . --- A macro for the common 2-column tables. The width of the first column
88 . --- is suitable for the many tables at the start of the main options chapter;
89 . --- the small number of other 2-column tables override it.
90
91 .macro table2 196pt 254pt
92 .itable none 0 0 2 $1 left $2 left
93 .endmacro
94
95 . --- A macro that generates .row, but puts &I; at the start of the first
96 . --- argument, thus indenting it. Assume a minimum of two arguments, and
97 . --- allow up to four arguments, which is as many as we'll ever need.
98
99 .macro irow
100 .arg 4
101 .row "&I;$1" "$2" "$3" "$4"
102 .endarg
103 .arg -4
104 .arg 3
105 .row "&I;$1" "$2" "$3"
106 .endarg
107 .arg -3
108 .row "&I;$1" "$2"
109 .endarg
110 .endarg
111 .endmacro
112
113 . --- Macros for option, variable, and concept index entries. For a "range"
114 . --- style of entry, use .scindex for the start and .ecindex for the end. The
115 . --- first argument of .scindex and the only argument of .ecindex must be the
116 . --- ID that ties them together.
117
118 .macro cindex
119 &<indexterm role="concept">&
120 &<primary>&$1&</primary>&
121 .arg 2
122 &<secondary>&$2&</secondary>&
123 .endarg
124 &</indexterm>&
125 .endmacro
126
127 .macro scindex
128 &<indexterm role="concept" id="$1" class="startofrange">&
129 &<primary>&$2&</primary>&
130 .arg 3
131 &<secondary>&$3&</secondary>&
132 .endarg
133 &</indexterm>&
134 .endmacro
135
136 .macro ecindex
137 &<indexterm role="concept" startref="$1" class="endofrange"/>&
138 .endmacro
139
140 .macro oindex
141 &<indexterm role="option">&
142 &<primary>&$1&</primary>&
143 .arg 2
144 &<secondary>&$2&</secondary>&
145 .endarg
146 &</indexterm>&
147 .endmacro
148
149 .macro vindex
150 &<indexterm role="variable">&
151 &<primary>&$1&</primary>&
152 .arg 2
153 &<secondary>&$2&</secondary>&
154 .endarg
155 &</indexterm>&
156 .endmacro
157
158 .macro index
159 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
160 .endmacro
161 . ////////////////////////////////////////////////////////////////////////////
162
163
164 . ////////////////////////////////////////////////////////////////////////////
165 . The <bookinfo> element is removed from the XML before processing for Ascii
166 . output formats.
167 . ////////////////////////////////////////////////////////////////////////////
168
169 .literal xml
170 <bookinfo>
171 <title>Specification of the Exim Mail Transfer Agent</title>
172 <titleabbrev>The Exim MTA</titleabbrev>
173 <date>17 May 2012</date>
174 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
175 <authorinitials>EM</authorinitials>
176 <revhistory><revision>
177   <revnumber>4.80</revnumber>
178   <date>17 May 2012</date>
179   <authorinitials>EM</authorinitials>
180 </revision></revhistory>
181 <copyright><year>2012</year><holder>University of Cambridge</holder></copyright>
182 </bookinfo>
183 .literal off
184
185
186 . /////////////////////////////////////////////////////////////////////////////
187 . This chunk of literal XML implements index entries of the form "x, see y" and
188 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
189 . at the top level, so we have to put the .chapter directive first.
190 . /////////////////////////////////////////////////////////////////////////////
191
192 .chapter "Introduction" "CHID1"
193 .literal xml
194
195 <indexterm role="variable">
196   <primary>$1, $2, etc.</primary>
197   <see><emphasis>numerical variables</emphasis></see>
198 </indexterm>
199 <indexterm role="concept">
200   <primary>address</primary>
201   <secondary>rewriting</secondary>
202   <see><emphasis>rewriting</emphasis></see>
203 </indexterm>
204 <indexterm role="concept">
205   <primary>Bounce Address Tag Validation</primary>
206   <see><emphasis>BATV</emphasis></see>
207 </indexterm>
208 <indexterm role="concept">
209   <primary>Client SMTP Authorization</primary>
210   <see><emphasis>CSA</emphasis></see>
211 </indexterm>
212 <indexterm role="concept">
213   <primary>CR character</primary>
214   <see><emphasis>carriage return</emphasis></see>
215 </indexterm>
216 <indexterm role="concept">
217   <primary>CRL</primary>
218   <see><emphasis>certificate revocation list</emphasis></see>
219 </indexterm>
220 <indexterm role="concept">
221   <primary>delivery</primary>
222   <secondary>failure report</secondary>
223   <see><emphasis>bounce message</emphasis></see>
224 </indexterm>
225 <indexterm role="concept">
226   <primary>dialup</primary>
227   <see><emphasis>intermittently connected hosts</emphasis></see>
228 </indexterm>
229 <indexterm role="concept">
230   <primary>exiscan</primary>
231   <see><emphasis>content scanning</emphasis></see>
232 </indexterm>
233 <indexterm role="concept">
234   <primary>failover</primary>
235   <see><emphasis>fallback</emphasis></see>
236 </indexterm>
237 <indexterm role="concept">
238   <primary>fallover</primary>
239   <see><emphasis>fallback</emphasis></see>
240 </indexterm>
241 <indexterm role="concept">
242   <primary>filter</primary>
243   <secondary>Sieve</secondary>
244   <see><emphasis>Sieve filter</emphasis></see>
245 </indexterm>
246 <indexterm role="concept">
247   <primary>ident</primary>
248   <see><emphasis>RFC 1413</emphasis></see>
249 </indexterm>
250 <indexterm role="concept">
251   <primary>LF character</primary>
252   <see><emphasis>linefeed</emphasis></see>
253 </indexterm>
254 <indexterm role="concept">
255   <primary>maximum</primary>
256   <seealso><emphasis>limit</emphasis></seealso>
257 </indexterm>
258 <indexterm role="concept">
259   <primary>monitor</primary>
260   <see><emphasis>Exim monitor</emphasis></see>
261 </indexterm>
262 <indexterm role="concept">
263   <primary>no_<emphasis>xxx</emphasis></primary>
264   <see>entry for xxx</see>
265 </indexterm>
266 <indexterm role="concept">
267   <primary>NUL</primary>
268   <see><emphasis>binary zero</emphasis></see>
269 </indexterm>
270 <indexterm role="concept">
271   <primary>passwd file</primary>
272   <see><emphasis>/etc/passwd</emphasis></see>
273 </indexterm>
274 <indexterm role="concept">
275   <primary>process id</primary>
276   <see><emphasis>pid</emphasis></see>
277 </indexterm>
278 <indexterm role="concept">
279   <primary>RBL</primary>
280   <see><emphasis>DNS list</emphasis></see>
281 </indexterm>
282 <indexterm role="concept">
283   <primary>redirection</primary>
284   <see><emphasis>address redirection</emphasis></see>
285 </indexterm>
286 <indexterm role="concept">
287   <primary>return path</primary>
288   <seealso><emphasis>envelope sender</emphasis></seealso>
289 </indexterm>
290 <indexterm role="concept">
291   <primary>scanning</primary>
292   <see><emphasis>content scanning</emphasis></see>
293 </indexterm>
294 <indexterm role="concept">
295   <primary>SSL</primary>
296   <see><emphasis>TLS</emphasis></see>
297 </indexterm>
298 <indexterm role="concept">
299   <primary>string</primary>
300   <secondary>expansion</secondary>
301   <see><emphasis>expansion</emphasis></see>
302 </indexterm>
303 <indexterm role="concept">
304   <primary>top bit</primary>
305   <see><emphasis>8-bit characters</emphasis></see>
306 </indexterm>
307 <indexterm role="concept">
308   <primary>variables</primary>
309   <see><emphasis>expansion, variables</emphasis></see>
310 </indexterm>
311 <indexterm role="concept">
312   <primary>zero, binary</primary>
313   <see><emphasis>binary zero</emphasis></see>
314 </indexterm>
315
316 .literal off
317
318
319 . /////////////////////////////////////////////////////////////////////////////
320 . This is the real start of the first chapter. See the comment above as to why
321 . we can't have the .chapter line here.
322 . chapter "Introduction"
323 . /////////////////////////////////////////////////////////////////////////////
324
325 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
326 Unix-like operating systems. It was designed on the assumption that it would be
327 run on hosts that are permanently connected to the Internet. However, it can be
328 used on intermittently connected hosts with suitable configuration adjustments.
329
330 Configuration files currently exist for the following operating systems: AIX,
331 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
332 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
333 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
334 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
335 Some of these operating systems are no longer current and cannot easily be
336 tested, so the configuration files may no longer work in practice.
337
338 There are also configuration files for compiling Exim in the Cygwin environment
339 that can be installed on systems running Windows. However, this document does
340 not contain any information about running Exim in the Cygwin environment.
341
342 The terms and conditions for the use and distribution of Exim are contained in
343 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
344 Public Licence, a copy of which may be found in the file &_LICENCE_&.
345
346 The use, supply or promotion of Exim for the purpose of sending bulk,
347 unsolicited electronic mail is incompatible with the basic aims of the program,
348 which revolve around the free provision of a service that enhances the quality
349 of personal communications. The author of Exim regards indiscriminate
350 mass-mailing as an antisocial, irresponsible abuse of the Internet.
351
352 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
353 experience of running and working on the Smail 3 code, I could never have
354 contemplated starting to write a new MTA. Many of the ideas and user interfaces
355 were originally taken from Smail 3, though the actual code of Exim is entirely
356 new, and has developed far beyond the initial concept.
357
358 Many people, both in Cambridge and around the world, have contributed to the
359 development and the testing of Exim, and to porting it to various operating
360 systems. I am grateful to them all. The distribution now contains a file called
361 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
362 contributors.
363
364
365 .section "Exim documentation" "SECID1"
366 . Keep this example change bar when updating the documentation!
367
368 .new
369 .cindex "documentation"
370 This edition of the Exim specification applies to version &version; of Exim.
371 Substantive changes from the &previousversion; edition are marked in some
372 renditions of the document; this paragraph is so marked if the rendition is
373 capable of showing a change indicator.
374 .wen
375
376 This document is very much a reference manual; it is not a tutorial. The reader
377 is expected to have some familiarity with the SMTP mail transfer protocol and
378 with general Unix system administration. Although there are some discussions
379 and examples in places, the information is mostly organized in a way that makes
380 it easy to look up, rather than in a natural order for sequential reading.
381 Furthermore, the manual aims to cover every aspect of Exim in detail, including
382 a number of rarely-used, special-purpose features that are unlikely to be of
383 very wide interest.
384
385 .cindex "books about Exim"
386 An &"easier"& discussion of Exim which provides more in-depth explanatory,
387 introductory, and tutorial material can be found in a book entitled &'The Exim
388 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
389 (&url(http://www.uit.co.uk/exim-book/)).
390
391 This book also contains a chapter that gives a general introduction to SMTP and
392 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
393 with the latest release of Exim. (Note that the earlier book about Exim,
394 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
395
396 .cindex "Debian" "information sources"
397 If you are using a Debian distribution of Exim, you will find information about
398 Debian-specific features in the file
399 &_/usr/share/doc/exim4-base/README.Debian_&.
400 The command &(man update-exim.conf)& is another source of Debian-specific
401 information.
402
403 .cindex "&_doc/NewStuff_&"
404 .cindex "&_doc/ChangeLog_&"
405 .cindex "change log"
406 As the program develops, there may be features in newer versions that have not
407 yet made it into this document, which is updated only when the most significant
408 digit of the fractional part of the version number changes. Specifications of
409 new features that are not yet in this manual are placed in the file
410 &_doc/NewStuff_& in the Exim distribution.
411
412 Some features may be classified as &"experimental"&. These may change
413 incompatibly while they are developing, or even be withdrawn. For this reason,
414 they are not documented in this manual. Information about experimental features
415 can be found in the file &_doc/experimental.txt_&.
416
417 All changes to the program (whether new features, bug fixes, or other kinds of
418 change) are noted briefly in the file called &_doc/ChangeLog_&.
419
420 .cindex "&_doc/spec.txt_&"
421 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
422 that it can easily be searched with a text editor. Other files in the &_doc_&
423 directory are:
424
425 .table2 100pt
426 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
427 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
428 .row &_exim.8_&              "a man page of Exim's command line options"
429 .row &_experimental.txt_&    "documentation of experimental features"
430 .row &_filter.txt_&          "specification of the filter language"
431 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
432 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
433 .endtable
434
435 The main specification and the specification of the filtering language are also
436 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
437 &<<SECTavail>>& below tells you how to get hold of these.
438
439
440
441 .section "FTP and web sites" "SECID2"
442 .cindex "web site"
443 .cindex "FTP site"
444 The primary site for Exim source distributions is currently the University of
445 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
446 distribution'& below. In addition, there is a web site and an FTP site at
447 &%exim.org%&. These are now also hosted at the University of Cambridge. The
448 &%exim.org%& site was previously hosted for a number of years by Energis
449 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
450
451 .cindex "wiki"
452 .cindex "FAQ"
453 As well as Exim distribution tar files, the Exim web site contains a number of
454 differently formatted versions of the documentation. A recent addition to the
455 online information is the Exim wiki (&url(http://wiki.exim.org)),
456 which contains what used to be a separate FAQ, as well as various other
457 examples, tips, and know-how that have been contributed by Exim users.
458
459 .cindex Bugzilla
460 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
461 this to report bugs, and also to add items to the wish list. Please search
462 first to check that you are not duplicating a previous entry.
463
464
465
466 .section "Mailing lists" "SECID3"
467 .cindex "mailing lists" "for Exim users"
468 The following Exim mailing lists exist:
469
470 .table2 140pt
471 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
472 .row &'exim-users@exim.org'&      "General discussion list"
473 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
474 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
475 .endtable
476
477 You can subscribe to these lists, change your existing subscriptions, and view
478 or search the archives via the mailing lists link on the Exim home page.
479 .cindex "Debian" "mailing list for"
480 If you are using a Debian distribution of Exim, you may wish to subscribe to
481 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
482 via this web page:
483 .display
484 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
485 .endd
486 Please ask Debian-specific questions on this list and not on the general Exim
487 lists.
488
489 .section "Exim training" "SECID4"
490 .cindex "training courses"
491 Training courses in Cambridge (UK) used to be run annually by the author of
492 Exim, before he retired. At the time of writing, there are no plans to run
493 further Exim courses in Cambridge. However, if that changes, relevant
494 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
495
496 .section "Bug reports" "SECID5"
497 .cindex "bug reports"
498 .cindex "reporting bugs"
499 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
500 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
501 whether some behaviour is a bug or not, the best thing to do is to post a
502 message to the &'exim-dev'& mailing list and have it discussed.
503
504
505
506 .section "Where to find the Exim distribution" "SECTavail"
507 .cindex "FTP site"
508 .cindex "distribution" "ftp site"
509 The master ftp site for the Exim distribution is
510 .display
511 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
512 .endd
513 This is mirrored by
514 .display
515 &*ftp://ftp.exim.org/pub/exim*&
516 .endd
517 The file references that follow are relative to the &_exim_& directories at
518 these sites. There are now quite a number of independent mirror sites around
519 the world. Those that I know about are listed in the file called &_Mirrors_&.
520
521 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
522 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
523 distributions), and &_Testing_& for testing versions. In the &_exim4_&
524 subdirectory, the current release can always be found in files called
525 .display
526 &_exim-n.nn.tar.gz_&
527 &_exim-n.nn.tar.bz2_&
528 .endd
529 where &'n.nn'& is the highest such version number in the directory. The two
530 files contain identical data; the only difference is the type of compression.
531 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
532
533 .cindex "distribution" "signing details"
534 .cindex "distribution" "public key"
535 .cindex "public key for signed distribution"
536 The distributions are currently signed with Nigel Metheringham's GPG key. The
537 corresponding public key is available from a number of keyservers, and there is
538 also a copy in the file &_nigel-pubkey.asc_&. The signatures for the tar bundles are
539 in:
540 .display
541 &_exim-n.nn.tar.gz.asc_&
542 &_exim-n.nn.tar.bz2.asc_&
543 .endd
544 For each released version, the log of changes is made separately available in a
545 separate file in the directory &_ChangeLogs_& so that it is possible to
546 find out what has changed without having to download the entire distribution.
547
548 .cindex "documentation" "available formats"
549 The main distribution contains ASCII versions of this specification and other
550 documentation; other formats of the documents are available in separate files
551 inside the &_exim4_& directory of the FTP site:
552 .display
553 &_exim-html-n.nn.tar.gz_&
554 &_exim-pdf-n.nn.tar.gz_&
555 &_exim-postscript-n.nn.tar.gz_&
556 &_exim-texinfo-n.nn.tar.gz_&
557 .endd
558 These tar files contain only the &_doc_& directory, not the complete
559 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
560
561
562 .section "Limitations" "SECID6"
563 .ilist
564 .cindex "limitations of Exim"
565 .cindex "bang paths" "not handled by Exim"
566 Exim is designed for use as an Internet MTA, and therefore handles addresses in
567 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
568 simple two-component bang paths can be converted by a straightforward rewriting
569 configuration. This restriction does not prevent Exim from being interfaced to
570 UUCP as a transport mechanism, provided that domain addresses are used.
571 .next
572 .cindex "domainless addresses"
573 .cindex "address" "without domain"
574 Exim insists that every address it handles has a domain attached. For incoming
575 local messages, domainless addresses are automatically qualified with a
576 configured domain value. Configuration options specify from which remote
577 systems unqualified addresses are acceptable. These are then qualified on
578 arrival.
579 .next
580 .cindex "transport" "external"
581 .cindex "external transports"
582 The only external transport mechanisms that are currently implemented are SMTP
583 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
584 transport is available, and there are facilities for writing messages to files
585 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
586 to send messages to other transport mechanisms such as UUCP, provided they can
587 handle domain-style addresses. Batched SMTP input is also catered for.
588 .next
589 Exim is not designed for storing mail for dial-in hosts. When the volumes of
590 such mail are large, it is better to get the messages &"delivered"& into files
591 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
592 other means.
593 .next
594 Although Exim does have basic facilities for scanning incoming messages, these
595 are not comprehensive enough to do full virus or spam scanning. Such operations
596 are best carried out using additional specialized software packages. If you
597 compile Exim with the content-scanning extension, straightforward interfaces to
598 a number of common scanners are provided.
599 .endlist
600
601
602 .section "Run time configuration" "SECID7"
603 Exim's run time configuration is held in a single text file that is divided
604 into a number of sections. The entries in this file consist of keywords and
605 values, in the style of Smail 3 configuration files. A default configuration
606 file which is suitable for simple online installations is provided in the
607 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
608
609
610 .section "Calling interface" "SECID8"
611 .cindex "Sendmail compatibility" "command line interface"
612 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
613 can be a straight replacement for &_/usr/lib/sendmail_& or
614 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
615 about Sendmail in order to run Exim. For actions other than sending messages,
616 Sendmail-compatible options also exist, but those that produce output (for
617 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
618 format. There are also some additional options that are compatible with Smail
619 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
620 documents all Exim's command line options. This information is automatically
621 made into the man page that forms part of the Exim distribution.
622
623 Control of messages on the queue can be done via certain privileged command
624 line options. There is also an optional monitor program called &'eximon'&,
625 which displays current information in an X window, and which contains a menu
626 interface to Exim's command line administration options.
627
628
629
630 .section "Terminology" "SECID9"
631 .cindex "terminology definitions"
632 .cindex "body of message" "definition of"
633 The &'body'& of a message is the actual data that the sender wants to transmit.
634 It is the last part of a message, and is separated from the &'header'& (see
635 below) by a blank line.
636
637 .cindex "bounce message" "definition of"
638 When a message cannot be delivered, it is normally returned to the sender in a
639 delivery failure message or a &"non-delivery report"& (NDR). The term
640 &'bounce'& is commonly used for this action, and the error reports are often
641 called &'bounce messages'&. This is a convenient shorthand for &"delivery
642 failure error report"&. Such messages have an empty sender address in the
643 message's &'envelope'& (see below) to ensure that they cannot themselves give
644 rise to further bounce messages.
645
646 The term &'default'& appears frequently in this manual. It is used to qualify a
647 value which is used in the absence of any setting in the configuration. It may
648 also qualify an action which is taken unless a configuration setting specifies
649 otherwise.
650
651 The term &'defer'& is used when the delivery of a message to a specific
652 destination cannot immediately take place for some reason (a remote host may be
653 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
654 until a later time.
655
656 The word &'domain'& is sometimes used to mean all but the first component of a
657 host's name. It is &'not'& used in that sense here, where it normally refers to
658 the part of an email address following the @ sign.
659
660 .cindex "envelope, definition of"
661 .cindex "sender" "definition of"
662 A message in transit has an associated &'envelope'&, as well as a header and a
663 body. The envelope contains a sender address (to which bounce messages should
664 be delivered), and any number of recipient addresses. References to the
665 sender or the recipients of a message usually mean the addresses in the
666 envelope. An MTA uses these addresses for delivery, and for returning bounce
667 messages, not the addresses that appear in the header lines.
668
669 .cindex "message" "header, definition of"
670 .cindex "header section" "definition of"
671 The &'header'& of a message is the first part of a message's text, consisting
672 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
673 &'Subject:'&, etc. Long header lines can be split over several text lines by
674 indenting the continuations. The header is separated from the body by a blank
675 line.
676
677 .cindex "local part" "definition of"
678 .cindex "domain" "definition of"
679 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
680 part of an email address that precedes the @ sign. The part that follows the
681 @ sign is called the &'domain'& or &'mail domain'&.
682
683 .cindex "local delivery" "definition of"
684 .cindex "remote delivery, definition of"
685 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
686 delivery to a file or a pipe on the local host from delivery by SMTP over
687 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
688 host it is running on are &'remote'&.
689
690 .cindex "return path" "definition of"
691 &'Return path'& is another name that is used for the sender address in a
692 message's envelope.
693
694 .cindex "queue" "definition of"
695 The term &'queue'& is used to refer to the set of messages awaiting delivery,
696 because this term is in widespread use in the context of MTAs. However, in
697 Exim's case the reality is more like a pool than a queue, because there is
698 normally no ordering of waiting messages.
699
700 .cindex "queue runner" "definition of"
701 The term &'queue runner'& is used to describe a process that scans the queue
702 and attempts to deliver those messages whose retry times have come. This term
703 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
704 the waiting messages are normally processed in an unpredictable order.
705
706 .cindex "spool directory" "definition of"
707 The term &'spool directory'& is used for a directory in which Exim keeps the
708 messages on its queue &-- that is, those that it is in the process of
709 delivering. This should not be confused with the directory in which local
710 mailboxes are stored, which is called a &"spool directory"& by some people. In
711 the Exim documentation, &"spool"& is always used in the first sense.
712
713
714
715
716
717
718 . ////////////////////////////////////////////////////////////////////////////
719 . ////////////////////////////////////////////////////////////////////////////
720
721 .chapter "Incorporated code" "CHID2"
722 .cindex "incorporated code"
723 .cindex "regular expressions" "library"
724 .cindex "PCRE"
725 A number of pieces of external code are included in the Exim distribution.
726
727 .ilist
728 Regular expressions are supported in the main Exim program and in the
729 Exim monitor using the freely-distributable PCRE library, copyright
730 &copy; University of Cambridge. The source to PCRE is no longer shipped with
731 Exim, so you will need to use the version of PCRE shipped with your system,
732 or obtain and install the full version of the library from
733 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
734 .next
735 .cindex "cdb" "acknowledgment"
736 Support for the cdb (Constant DataBase) lookup method is provided by code
737 contributed by Nigel Metheringham of (at the time he contributed it) Planet
738 Online Ltd. The implementation is completely contained within the code of Exim.
739 It does not link against an external cdb library. The code contains the
740 following statements:
741
742 .blockquote
743 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
744
745 This program is free software; you can redistribute it and/or modify it under
746 the terms of the GNU General Public License as published by the Free Software
747 Foundation; either version 2 of the License, or (at your option) any later
748 version.
749 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
750 the spec and sample code for cdb can be obtained from
751 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
752 some code from Dan Bernstein's implementation (which has no license
753 restrictions applied to it).
754 .endblockquote
755 .next
756 .cindex "SPA authentication"
757 .cindex "Samba project"
758 .cindex "Microsoft Secure Password Authentication"
759 Client support for Microsoft's &'Secure Password Authentication'& is provided
760 by code contributed by Marc Prud'hommeaux. Server support was contributed by
761 Tom Kistner. This includes code taken from the Samba project, which is released
762 under the Gnu GPL.
763 .next
764 .cindex "Cyrus"
765 .cindex "&'pwcheck'& daemon"
766 .cindex "&'pwauthd'& daemon"
767 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
768 by code taken from the Cyrus-SASL library and adapted by Alexander S.
769 Sabourenkov. The permission notice appears below, in accordance with the
770 conditions expressed therein.
771
772 .blockquote
773 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
774
775 Redistribution and use in source and binary forms, with or without
776 modification, are permitted provided that the following conditions
777 are met:
778
779 .olist
780 Redistributions of source code must retain the above copyright
781 notice, this list of conditions and the following disclaimer.
782 .next
783 Redistributions in binary form must reproduce the above copyright
784 notice, this list of conditions and the following disclaimer in
785 the documentation and/or other materials provided with the
786 distribution.
787 .next
788 The name &"Carnegie Mellon University"& must not be used to
789 endorse or promote products derived from this software without
790 prior written permission. For permission or any other legal
791 details, please contact
792 .display
793               Office of Technology Transfer
794               Carnegie Mellon University
795               5000 Forbes Avenue
796               Pittsburgh, PA  15213-3890
797               (412) 268-4387, fax: (412) 268-7395
798               tech-transfer@andrew.cmu.edu
799 .endd
800 .next
801 Redistributions of any form whatsoever must retain the following
802 acknowledgment:
803
804 &"This product includes software developed by Computing Services
805 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
806
807 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
808 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
809 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
810 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
811 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
812 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
813 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
814 .endlist
815 .endblockquote
816
817 .next
818 .cindex "Exim monitor" "acknowledgment"
819 .cindex "X-windows"
820 .cindex "Athena"
821 The Exim Monitor program, which is an X-Window application, includes
822 modified versions of the Athena StripChart and TextPop widgets.
823 This code is copyright by DEC and MIT, and their permission notice appears
824 below, in accordance with the conditions expressed therein.
825
826 .blockquote
827 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
828 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
829
830 All Rights Reserved
831
832 Permission to use, copy, modify, and distribute this software and its
833 documentation for any purpose and without fee is hereby granted,
834 provided that the above copyright notice appear in all copies and that
835 both that copyright notice and this permission notice appear in
836 supporting documentation, and that the names of Digital or MIT not be
837 used in advertising or publicity pertaining to distribution of the
838 software without specific, written prior permission.
839
840 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
841 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
842 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
843 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
844 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
845 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
846 SOFTWARE.
847 .endblockquote
848
849 .next
850 Many people have contributed code fragments, some large, some small, that were
851 not covered by any specific licence requirements. It is assumed that the
852 contributors are happy to see their code incorporated into Exim under the GPL.
853 .endlist
854
855
856
857
858
859 . ////////////////////////////////////////////////////////////////////////////
860 . ////////////////////////////////////////////////////////////////////////////
861
862 .chapter "How Exim receives and delivers mail" "CHID11" &&&
863          "Receiving and delivering mail"
864
865
866 .section "Overall philosophy" "SECID10"
867 .cindex "design philosophy"
868 Exim is designed to work efficiently on systems that are permanently connected
869 to the Internet and are handling a general mix of mail. In such circumstances,
870 most messages can be delivered immediately. Consequently, Exim does not
871 maintain independent queues of messages for specific domains or hosts, though
872 it does try to send several messages in a single SMTP connection after a host
873 has been down, and it also maintains per-host retry information.
874
875
876 .section "Policy control" "SECID11"
877 .cindex "policy control" "overview"
878 Policy controls are now an important feature of MTAs that are connected to the
879 Internet. Perhaps their most important job is to stop MTAs being abused as
880 &"open relays"& by misguided individuals who send out vast amounts of
881 unsolicited junk, and want to disguise its source. Exim provides flexible
882 facilities for specifying policy controls on incoming mail:
883
884 .ilist
885 .cindex "&ACL;" "introduction"
886 Exim 4 (unlike previous versions of Exim) implements policy controls on
887 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
888 series of statements that may either grant or deny access. ACLs can be used at
889 several places in the SMTP dialogue while receiving a message from a remote
890 host. However, the most common places are after each RCPT command, and at the
891 very end of the message. The sysadmin can specify conditions for accepting or
892 rejecting individual recipients or the entire message, respectively, at these
893 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
894 error code.
895 .next
896 An ACL is also available for locally generated, non-SMTP messages. In this
897 case, the only available actions are to accept or deny the entire message.
898 .next
899 When Exim is compiled with the content-scanning extension, facilities are
900 provided in the ACL mechanism for passing the message to external virus and/or
901 spam scanning software. The result of such a scan is passed back to the ACL,
902 which can then use it to decide what to do with the message.
903 .next
904 When a message has been received, either from a remote host or from the local
905 host, but before the final acknowledgment has been sent, a locally supplied C
906 function called &[local_scan()]& can be run to inspect the message and decide
907 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
908 is accepted, the list of recipients can be modified by the function.
909 .next
910 Using the &[local_scan()]& mechanism is another way of calling external scanner
911 software. The &%SA-Exim%& add-on package works this way. It does not require
912 Exim to be compiled with the content-scanning extension.
913 .next
914 After a message has been accepted, a further checking mechanism is available in
915 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
916 runs at the start of every delivery process.
917 .endlist
918
919
920
921 .section "User filters" "SECID12"
922 .cindex "filter" "introduction"
923 .cindex "Sieve filter"
924 In a conventional Exim configuration, users are able to run private filters by
925 setting up appropriate &_.forward_& files in their home directories. See
926 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
927 configuration needed to support this, and the separate document entitled
928 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
929 of filtering are available:
930
931 .ilist
932 Sieve filters are written in the standard filtering language that is defined
933 by RFC 3028.
934 .next
935 Exim filters are written in a syntax that is unique to Exim, but which is more
936 powerful than Sieve, which it pre-dates.
937 .endlist
938
939 User filters are run as part of the routing process, described below.
940
941
942
943 .section "Message identification" "SECTmessiden"
944 .cindex "message ids" "details of format"
945 .cindex "format" "of message id"
946 .cindex "id of message"
947 .cindex "base62"
948 .cindex "base36"
949 .cindex "Darwin"
950 .cindex "Cygwin"
951 Every message handled by Exim is given a &'message id'& which is sixteen
952 characters long. It is divided into three parts, separated by hyphens, for
953 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
954 normally encoding numbers in base 62. However, in the Darwin operating
955 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
956 (avoiding the use of lower case letters) is used instead, because the message
957 id is used to construct file names, and the names of files in those systems are
958 not always case-sensitive.
959
960 .cindex "pid (process id)" "re-use of"
961 The detail of the contents of the message id have changed as Exim has evolved.
962 Earlier versions relied on the operating system not re-using a process id (pid)
963 within one second. On modern operating systems, this assumption can no longer
964 be made, so the algorithm had to be changed. To retain backward compatibility,
965 the format of the message id was retained, which is why the following rules are
966 somewhat eccentric:
967
968 .ilist
969 The first six characters of the message id are the time at which the message
970 started to be received, to a granularity of one second. That is, this field
971 contains the number of seconds since the start of the epoch (the normal Unix
972 way of representing the date and time of day).
973 .next
974 After the first hyphen, the next six characters are the id of the process that
975 received the message.
976 .next
977 There are two different possibilities for the final two characters:
978 .olist
979 .oindex "&%localhost_number%&"
980 If &%localhost_number%& is not set, this value is the fractional part of the
981 time of reception, normally in units of 1/2000 of a second, but for systems
982 that must use base 36 instead of base 62 (because of case-insensitive file
983 systems), the units are 1/1000 of a second.
984 .next
985 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
986 the fractional part of the time, which in this case is in units of 1/200
987 (1/100) of a second.
988 .endlist
989 .endlist
990
991 After a message has been received, Exim waits for the clock to tick at the
992 appropriate resolution before proceeding, so that if another message is
993 received by the same process, or by another process with the same (re-used)
994 pid, it is guaranteed that the time will be different. In most cases, the clock
995 will already have ticked while the message was being received.
996
997
998 .section "Receiving mail" "SECID13"
999 .cindex "receiving mail"
1000 .cindex "message" "reception"
1001 The only way Exim can receive mail from another host is using SMTP over
1002 TCP/IP, in which case the sender and recipient addresses are transferred using
1003 SMTP commands. However, from a locally running process (such as a user's MUA),
1004 there are several possibilities:
1005
1006 .ilist
1007 If the process runs Exim with the &%-bm%& option, the message is read
1008 non-interactively (usually via a pipe), with the recipients taken from the
1009 command line, or from the body of the message if &%-t%& is also used.
1010 .next
1011 If the process runs Exim with the &%-bS%& option, the message is also read
1012 non-interactively, but in this case the recipients are listed at the start of
1013 the message in a series of SMTP RCPT commands, terminated by a DATA
1014 command. This is so-called &"batch SMTP"& format,
1015 but it isn't really SMTP. The SMTP commands are just another way of passing
1016 envelope addresses in a non-interactive submission.
1017 .next
1018 If the process runs Exim with the &%-bs%& option, the message is read
1019 interactively, using the SMTP protocol. A two-way pipe is normally used for
1020 passing data between the local process and the Exim process.
1021 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1022 example, the ACLs for SMTP commands are used for this form of submission.
1023 .next
1024 A local process may also make a TCP/IP call to the host's loopback address
1025 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1026 does not treat the loopback address specially. It treats all such connections
1027 in the same way as connections from other hosts.
1028 .endlist
1029
1030
1031 .cindex "message sender, constructed by Exim"
1032 .cindex "sender" "constructed by Exim"
1033 In the three cases that do not involve TCP/IP, the sender address is
1034 constructed from the login name of the user that called Exim and a default
1035 qualification domain (which can be set by the &%qualify_domain%& configuration
1036 option). For local or batch SMTP, a sender address that is passed using the
1037 SMTP MAIL command is ignored. However, the system administrator may allow
1038 certain users (&"trusted users"&) to specify a different sender address
1039 unconditionally, or all users to specify certain forms of different sender
1040 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1041 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1042 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1043 users to change sender addresses.
1044
1045 Messages received by either of the non-interactive mechanisms are subject to
1046 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1047 (either over TCP/IP, or interacting with a local process) can be checked by a
1048 number of ACLs that operate at different times during the SMTP session. Either
1049 individual recipients, or the entire message, can be rejected if local policy
1050 requirements are not met. The &[local_scan()]& function (see chapter
1051 &<<CHAPlocalscan>>&) is run for all incoming messages.
1052
1053 Exim can be configured not to start a delivery process when a message is
1054 received; this can be unconditional, or depend on the number of incoming SMTP
1055 connections or the system load. In these situations, new messages wait on the
1056 queue until a queue runner process picks them up. However, in standard
1057 configurations under normal conditions, delivery is started as soon as a
1058 message is received.
1059
1060
1061
1062
1063
1064 .section "Handling an incoming message" "SECID14"
1065 .cindex "spool directory" "files that hold a message"
1066 .cindex "file" "how a message is held"
1067 When Exim accepts a message, it writes two files in its spool directory. The
1068 first contains the envelope information, the current status of the message, and
1069 the header lines, and the second contains the body of the message. The names of
1070 the two spool files consist of the message id, followed by &`-H`& for the
1071 file containing the envelope and header, and &`-D`& for the data file.
1072
1073 .cindex "spool directory" "&_input_& sub-directory"
1074 By default all these message files are held in a single directory called
1075 &_input_& inside the general Exim spool directory. Some operating systems do
1076 not perform very well if the number of files in a directory gets large; to
1077 improve performance in such cases, the &%split_spool_directory%& option can be
1078 used. This causes Exim to split up the input files into 62 sub-directories
1079 whose names are single letters or digits. When this is done, the queue is
1080 processed one sub-directory at a time instead of all at once, which can improve
1081 overall performance even when there are not enough files in each directory to
1082 affect file system performance.
1083
1084 The envelope information consists of the address of the message's sender and
1085 the addresses of the recipients. This information is entirely separate from
1086 any addresses contained in the header lines. The status of the message includes
1087 a list of recipients who have already received the message. The format of the
1088 first spool file is described in chapter &<<CHAPspool>>&.
1089
1090 .cindex "rewriting" "addresses"
1091 Address rewriting that is specified in the rewrite section of the configuration
1092 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1093 both in the header lines and the envelope, at the time the message is accepted.
1094 If during the course of delivery additional addresses are generated (for
1095 example, via aliasing), these new addresses are rewritten as soon as they are
1096 generated. At the time a message is actually delivered (transported) further
1097 rewriting can take place; because this is a transport option, it can be
1098 different for different forms of delivery. It is also possible to specify the
1099 addition or removal of certain header lines at the time the message is
1100 delivered (see chapters &<<CHAProutergeneric>>& and
1101 &<<CHAPtransportgeneric>>&).
1102
1103
1104
1105 .section "Life of a message" "SECID15"
1106 .cindex "message" "life of"
1107 .cindex "message" "frozen"
1108 A message remains in the spool directory until it is completely delivered to
1109 its recipients or to an error address, or until it is deleted by an
1110 administrator or by the user who originally created it. In cases when delivery
1111 cannot proceed &-- for example, when a message can neither be delivered to its
1112 recipients nor returned to its sender, the message is marked &"frozen"& on the
1113 spool, and no more deliveries are attempted.
1114
1115 .cindex "frozen messages" "thawing"
1116 .cindex "message" "thawing frozen"
1117 An administrator can &"thaw"& such messages when the problem has been
1118 corrected, and can also freeze individual messages by hand if necessary. In
1119 addition, an administrator can force a delivery error, causing a bounce message
1120 to be sent.
1121
1122 .oindex "&%timeout_frozen_after%&"
1123 .oindex "&%ignore_bounce_errors_after%&"
1124 There are options called &%ignore_bounce_errors_after%& and
1125 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1126 The first applies only to frozen bounces, the second to any frozen messages.
1127
1128 .cindex "message" "log file for"
1129 .cindex "log" "file for each message"
1130 While Exim is working on a message, it writes information about each delivery
1131 attempt to its main log file. This includes successful, unsuccessful, and
1132 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1133 lines are also written to a separate &'message log'& file for each message.
1134 These logs are solely for the benefit of the administrator, and are normally
1135 deleted along with the spool files when processing of a message is complete.
1136 The use of individual message logs can be disabled by setting
1137 &%no_message_logs%&; this might give an improvement in performance on very busy
1138 systems.
1139
1140 .cindex "journal file"
1141 .cindex "file" "journal"
1142 All the information Exim itself needs to set up a delivery is kept in the first
1143 spool file, along with the header lines. When a successful delivery occurs, the
1144 address is immediately written at the end of a journal file, whose name is the
1145 message id followed by &`-J`&. At the end of a delivery run, if there are some
1146 addresses left to be tried again later, the first spool file (the &`-H`& file)
1147 is updated to indicate which these are, and the journal file is then deleted.
1148 Updating the spool file is done by writing a new file and renaming it, to
1149 minimize the possibility of data loss.
1150
1151 Should the system or the program crash after a successful delivery but before
1152 the spool file has been updated, the journal is left lying around. The next
1153 time Exim attempts to deliver the message, it reads the journal file and
1154 updates the spool file before proceeding. This minimizes the chances of double
1155 deliveries caused by crashes.
1156
1157
1158
1159 .section "Processing an address for delivery" "SECTprocaddress"
1160 .cindex "drivers" "definition of"
1161 .cindex "router" "definition of"
1162 .cindex "transport" "definition of"
1163 The main delivery processing elements of Exim are called &'routers'& and
1164 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1165 number of them is provided in the source distribution, and compile-time options
1166 specify which ones are included in the binary. Run time options specify which
1167 ones are actually used for delivering messages.
1168
1169 .cindex "drivers" "instance definition"
1170 Each driver that is specified in the run time configuration is an &'instance'&
1171 of that particular driver type. Multiple instances are allowed; for example,
1172 you can set up several different &(smtp)& transports, each with different
1173 option values that might specify different ports or different timeouts. Each
1174 instance has its own identifying name. In what follows we will normally use the
1175 instance name when discussing one particular instance (that is, one specific
1176 configuration of the driver), and the generic driver name when discussing
1177 the driver's features in general.
1178
1179 A &'router'& is a driver that operates on an address, either determining how
1180 its delivery should happen, by assigning it to a specific transport, or
1181 converting the address into one or more new addresses (for example, via an
1182 alias file). A router may also explicitly choose to fail an address, causing it
1183 to be bounced.
1184
1185 A &'transport'& is a driver that transmits a copy of the message from Exim's
1186 spool to some destination. There are two kinds of transport: for a &'local'&
1187 transport, the destination is a file or a pipe on the local host, whereas for a
1188 &'remote'& transport the destination is some other host. A message is passed
1189 to a specific transport as a result of successful routing. If a message has
1190 several recipients, it may be passed to a number of different transports.
1191
1192 .cindex "preconditions" "definition of"
1193 An address is processed by passing it to each configured router instance in
1194 turn, subject to certain preconditions, until a router accepts the address or
1195 specifies that it should be bounced. We will describe this process in more
1196 detail shortly. First, as a simple example, we consider how each recipient
1197 address in a message is processed in a small configuration of three routers.
1198
1199 To make this a more concrete example, it is described in terms of some actual
1200 routers, but remember, this is only an example. You can configure Exim's
1201 routers in many different ways, and there may be any number of routers in a
1202 configuration.
1203
1204 The first router that is specified in a configuration is often one that handles
1205 addresses in domains that are not recognized specially by the local host. These
1206 are typically addresses for arbitrary domains on the Internet. A precondition
1207 is set up which looks for the special domains known to the host (for example,
1208 its own domain name), and the router is run for addresses that do &'not'&
1209 match. Typically, this is a router that looks up domains in the DNS in order to
1210 find the hosts to which this address routes. If it succeeds, the address is
1211 assigned to a suitable SMTP transport; if it does not succeed, the router is
1212 configured to fail the address.
1213
1214 The second router is reached only when the domain is recognized as one that
1215 &"belongs"& to the local host. This router does redirection &-- also known as
1216 aliasing and forwarding. When it generates one or more new addresses from the
1217 original, each of them is routed independently from the start. Otherwise, the
1218 router may cause an address to fail, or it may simply decline to handle the
1219 address, in which case the address is passed to the next router.
1220
1221 The final router in many configurations is one that checks to see if the
1222 address belongs to a local mailbox. The precondition may involve a check to
1223 see if the local part is the name of a login account, or it may look up the
1224 local part in a file or a database. If its preconditions are not met, or if
1225 the router declines, we have reached the end of the routers. When this happens,
1226 the address is bounced.
1227
1228
1229
1230 .section "Processing an address for verification" "SECID16"
1231 .cindex "router" "for verification"
1232 .cindex "verifying address" "overview"
1233 As well as being used to decide how to deliver to an address, Exim's routers
1234 are also used for &'address verification'&. Verification can be requested as
1235 one of the checks to be performed in an ACL for incoming messages, on both
1236 sender and recipient addresses, and it can be tested using the &%-bv%& and
1237 &%-bvs%& command line options.
1238
1239 When an address is being verified, the routers are run in &"verify mode"&. This
1240 does not affect the way the routers work, but it is a state that can be
1241 detected. By this means, a router can be skipped or made to behave differently
1242 when verifying. A common example is a configuration in which the first router
1243 sends all messages to a message-scanning program, unless they have been
1244 previously scanned. Thus, the first router accepts all addresses without any
1245 checking, making it useless for verifying. Normally, the &%no_verify%& option
1246 would be set for such a router, causing it to be skipped in verify mode.
1247
1248
1249
1250
1251 .section "Running an individual router" "SECTrunindrou"
1252 .cindex "router" "running details"
1253 .cindex "preconditions" "checking"
1254 .cindex "router" "result of running"
1255 As explained in the example above, a number of preconditions are checked before
1256 running a router. If any are not met, the router is skipped, and the address is
1257 passed to the next router. When all the preconditions on a router &'are'& met,
1258 the router is run. What happens next depends on the outcome, which is one of
1259 the following:
1260
1261 .ilist
1262 &'accept'&: The router accepts the address, and either assigns it to a
1263 transport, or generates one or more &"child"& addresses. Processing the
1264 original address ceases,
1265 .oindex "&%unseen%&"
1266 unless the &%unseen%& option is set on the router. This option
1267 can be used to set up multiple deliveries with different routing (for example,
1268 for keeping archive copies of messages). When &%unseen%& is set, the address is
1269 passed to the next router. Normally, however, an &'accept'& return marks the
1270 end of routing.
1271
1272 Any child addresses generated by the router are processed independently,
1273 starting with the first router by default. It is possible to change this by
1274 setting the &%redirect_router%& option to specify which router to start at for
1275 child addresses. Unlike &%pass_router%& (see below) the router specified by
1276 &%redirect_router%& may be anywhere in the router configuration.
1277 .next
1278 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1279 requests that the address be passed to another router. By default the address
1280 is passed to the next router, but this can be changed by setting the
1281 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1282 must be below the current router (to avoid loops).
1283 .next
1284 &'decline'&: The router declines to accept the address because it does not
1285 recognize it at all. By default, the address is passed to the next router, but
1286 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1287 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1288 &'decline'& into &'fail'&.
1289 .next
1290 &'fail'&: The router determines that the address should fail, and queues it for
1291 the generation of a bounce message. There is no further processing of the
1292 original address unless &%unseen%& is set on the router.
1293 .next
1294 &'defer'&: The router cannot handle the address at the present time. (A
1295 database may be offline, or a DNS lookup may have timed out.) No further
1296 processing of the address happens in this delivery attempt. It is tried again
1297 next time the message is considered for delivery.
1298 .next
1299 &'error'&: There is some error in the router (for example, a syntax error in
1300 its configuration). The action is as for defer.
1301 .endlist
1302
1303 If an address reaches the end of the routers without having been accepted by
1304 any of them, it is bounced as unrouteable. The default error message in this
1305 situation is &"unrouteable address"&, but you can set your own message by
1306 making use of the &%cannot_route_message%& option. This can be set for any
1307 router; the value from the last router that &"saw"& the address is used.
1308
1309 Sometimes while routing you want to fail a delivery when some conditions are
1310 met but others are not, instead of passing the address on for further routing.
1311 You can do this by having a second router that explicitly fails the delivery
1312 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1313 facility for this purpose.
1314
1315
1316 .section "Duplicate addresses" "SECID17"
1317 .cindex "case of local parts"
1318 .cindex "address duplicate, discarding"
1319 .cindex "duplicate addresses"
1320 Once routing is complete, Exim scans the addresses that are assigned to local
1321 and remote transports, and discards any duplicates that it finds. During this
1322 check, local parts are treated as case-sensitive. This happens only when
1323 actually delivering a message; when testing routers with &%-bt%&, all the
1324 routed addresses are shown.
1325
1326
1327
1328 .section "Router preconditions" "SECTrouprecon"
1329 .cindex "router" "preconditions, order of processing"
1330 .cindex "preconditions" "order of processing"
1331 The preconditions that are tested for each router are listed below, in the
1332 order in which they are tested. The individual configuration options are
1333 described in more detail in chapter &<<CHAProutergeneric>>&.
1334
1335 .ilist
1336 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1337 the local parts handled by the router may or must have certain prefixes and/or
1338 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1339 skipped. These conditions are tested first. When an affix is present, it is
1340 removed from the local part before further processing, including the evaluation
1341 of any other conditions.
1342 .next
1343 Routers can be designated for use only when not verifying an address, that is,
1344 only when routing it for delivery (or testing its delivery routing). If the
1345 &%verify%& option is set false, the router is skipped when Exim is verifying an
1346 address.
1347 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1348 &%verify_recipient%&, which independently control the use of the router for
1349 sender and recipient verification. You can set these options directly if
1350 you want a router to be used for only one type of verification.
1351 .next
1352 If the &%address_test%& option is set false, the router is skipped when Exim is
1353 run with the &%-bt%& option to test an address routing. This can be helpful
1354 when the first router sends all new messages to a scanner of some sort; it
1355 makes it possible to use &%-bt%& to test subsequent delivery routing without
1356 having to simulate the effect of the scanner.
1357 .next
1358 Routers can be designated for use only when verifying an address, as
1359 opposed to routing it for delivery. The &%verify_only%& option controls this.
1360 .next
1361 Individual routers can be explicitly skipped when running the routers to
1362 check an address given in the SMTP EXPN command (see the &%expn%& option).
1363 .next
1364 If the &%domains%& option is set, the domain of the address must be in the set
1365 of domains that it defines.
1366 .next
1367 .vindex "&$local_part_prefix$&"
1368 .vindex "&$local_part$&"
1369 .vindex "&$local_part_suffix$&"
1370 If the &%local_parts%& option is set, the local part of the address must be in
1371 the set of local parts that it defines. If &%local_part_prefix%& or
1372 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1373 part before this check. If you want to do precondition tests on local parts
1374 that include affixes, you can do so by using a &%condition%& option (see below)
1375 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1376 &$local_part_suffix$& as necessary.
1377 .next
1378 .vindex "&$local_user_uid$&"
1379 .vindex "&$local_user_gid$&"
1380 .vindex "&$home$&"
1381 If the &%check_local_user%& option is set, the local part must be the name of
1382 an account on the local host. If this check succeeds, the uid and gid of the
1383 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1384 user's home directory is placed in &$home$&; these values can be used in the
1385 remaining preconditions.
1386 .next
1387 If the &%router_home_directory%& option is set, it is expanded at this point,
1388 because it overrides the value of &$home$&. If this expansion were left till
1389 later, the value of &$home$& as set by &%check_local_user%& would be used in
1390 subsequent tests. Having two different values of &$home$& in the same router
1391 could lead to confusion.
1392 .next
1393 If the &%senders%& option is set, the envelope sender address must be in the
1394 set of addresses that it defines.
1395 .next
1396 If the &%require_files%& option is set, the existence or non-existence of
1397 specified files is tested.
1398 .next
1399 .cindex "customizing" "precondition"
1400 If the &%condition%& option is set, it is evaluated and tested. This option
1401 uses an expanded string to allow you to set up your own custom preconditions.
1402 Expanded strings are described in chapter &<<CHAPexpand>>&.
1403 .endlist
1404
1405
1406 Note that &%require_files%& comes near the end of the list, so you cannot use
1407 it to check for the existence of a file in which to lookup up a domain, local
1408 part, or sender. However, as these options are all expanded, you can use the
1409 &%exists%& expansion condition to make such tests within each condition. The
1410 &%require_files%& option is intended for checking files that the router may be
1411 going to use internally, or which are needed by a specific transport (for
1412 example, &_.procmailrc_&).
1413
1414
1415
1416 .section "Delivery in detail" "SECID18"
1417 .cindex "delivery" "in detail"
1418 When a message is to be delivered, the sequence of events is as follows:
1419
1420 .ilist
1421 If a system-wide filter file is specified, the message is passed to it. The
1422 filter may add recipients to the message, replace the recipients, discard the
1423 message, cause a new message to be generated, or cause the message delivery to
1424 fail. The format of the system filter file is the same as for Exim user filter
1425 files, described in the separate document entitled &'Exim's interfaces to mail
1426 filtering'&.
1427 .cindex "Sieve filter" "not available for system filter"
1428 (&*Note*&: Sieve cannot be used for system filter files.)
1429
1430 Some additional features are available in system filters &-- see chapter
1431 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1432 filter only once per delivery attempt, however many recipients it has. However,
1433 if there are several delivery attempts because one or more addresses could not
1434 be immediately delivered, the system filter is run each time. The filter
1435 condition &%first_delivery%& can be used to detect the first run of the system
1436 filter.
1437 .next
1438 Each recipient address is offered to each configured router in turn, subject to
1439 its preconditions, until one is able to handle it. If no router can handle the
1440 address, that is, if they all decline, the address is failed. Because routers
1441 can be targeted at particular domains, several locally handled domains can be
1442 processed entirely independently of each other.
1443 .next
1444 .cindex "routing" "loops in"
1445 .cindex "loop" "while routing"
1446 A router that accepts an address may assign it to a local or a remote
1447 transport. However, the transport is not run at this time. Instead, the address
1448 is placed on a list for the particular transport, which will be run later.
1449 Alternatively, the router may generate one or more new addresses (typically
1450 from alias, forward, or filter files). New addresses are fed back into this
1451 process from the top, but in order to avoid loops, a router ignores any address
1452 which has an identically-named ancestor that was processed by itself.
1453 .next
1454 When all the routing has been done, addresses that have been successfully
1455 handled are passed to their assigned transports. When local transports are
1456 doing real local deliveries, they handle only one address at a time, but if a
1457 local transport is being used as a pseudo-remote transport (for example, to
1458 collect batched SMTP messages for transmission by some other means) multiple
1459 addresses can be handled. Remote transports can always handle more than one
1460 address at a time, but can be configured not to do so, or to restrict multiple
1461 addresses to the same domain.
1462 .next
1463 Each local delivery to a file or a pipe runs in a separate process under a
1464 non-privileged uid, and these deliveries are run one at a time. Remote
1465 deliveries also run in separate processes, normally under a uid that is private
1466 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1467 run in parallel. The maximum number of simultaneous remote deliveries for any
1468 one message is set by the &%remote_max_parallel%& option.
1469 The order in which deliveries are done is not defined, except that all local
1470 deliveries happen before any remote deliveries.
1471 .next
1472 .cindex "queue runner"
1473 When it encounters a local delivery during a queue run, Exim checks its retry
1474 database to see if there has been a previous temporary delivery failure for the
1475 address before running the local transport. If there was a previous failure,
1476 Exim does not attempt a new delivery until the retry time for the address is
1477 reached. However, this happens only for delivery attempts that are part of a
1478 queue run. Local deliveries are always attempted when delivery immediately
1479 follows message reception, even if retry times are set for them. This makes for
1480 better behaviour if one particular message is causing problems (for example,
1481 causing quota overflow, or provoking an error in a filter file).
1482 .next
1483 .cindex "delivery" "retry in remote transports"
1484 Remote transports do their own retry handling, since an address may be
1485 deliverable to one of a number of hosts, each of which may have a different
1486 retry time. If there have been previous temporary failures and no host has
1487 reached its retry time, no delivery is attempted, whether in a queue run or
1488 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1489 .next
1490 If there were any permanent errors, a bounce message is returned to an
1491 appropriate address (the sender in the common case), with details of the error
1492 for each failing address. Exim can be configured to send copies of bounce
1493 messages to other addresses.
1494 .next
1495 .cindex "delivery" "deferral"
1496 If one or more addresses suffered a temporary failure, the message is left on
1497 the queue, to be tried again later. Delivery of these addresses is said to be
1498 &'deferred'&.
1499 .next
1500 When all the recipient addresses have either been delivered or bounced,
1501 handling of the message is complete. The spool files and message log are
1502 deleted, though the message log can optionally be preserved if required.
1503 .endlist
1504
1505
1506
1507
1508 .section "Retry mechanism" "SECID19"
1509 .cindex "delivery" "retry mechanism"
1510 .cindex "retry" "description of mechanism"
1511 .cindex "queue runner"
1512 Exim's mechanism for retrying messages that fail to get delivered at the first
1513 attempt is the queue runner process. You must either run an Exim daemon that
1514 uses the &%-q%& option with a time interval to start queue runners at regular
1515 intervals, or use some other means (such as &'cron'&) to start them. If you do
1516 not arrange for queue runners to be run, messages that fail temporarily at the
1517 first attempt will remain on your queue for ever. A queue runner process works
1518 its way through the queue, one message at a time, trying each delivery that has
1519 passed its retry time.
1520 You can run several queue runners at once.
1521
1522 Exim uses a set of configured rules to determine when next to retry the failing
1523 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1524 should give up trying to deliver to the address, at which point it generates a
1525 bounce message. If no retry rules are set for a particular host, address, and
1526 error combination, no retries are attempted, and temporary errors are treated
1527 as permanent.
1528
1529
1530
1531 .section "Temporary delivery failure" "SECID20"
1532 .cindex "delivery" "temporary failure"
1533 There are many reasons why a message may not be immediately deliverable to a
1534 particular address. Failure to connect to a remote machine (because it, or the
1535 connection to it, is down) is one of the most common. Temporary failures may be
1536 detected during routing as well as during the transport stage of delivery.
1537 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1538 is on a file system where the user is over quota. Exim can be configured to
1539 impose its own quotas on local mailboxes; where system quotas are set they will
1540 also apply.
1541
1542 If a host is unreachable for a period of time, a number of messages may be
1543 waiting for it by the time it recovers, and sending them in a single SMTP
1544 connection is clearly beneficial. Whenever a delivery to a remote host is
1545 deferred,
1546 .cindex "hints database"
1547 Exim makes a note in its hints database, and whenever a successful
1548 SMTP delivery has happened, it looks to see if any other messages are waiting
1549 for the same host. If any are found, they are sent over the same SMTP
1550 connection, subject to a configuration limit as to the maximum number in any
1551 one connection.
1552
1553
1554
1555 .section "Permanent delivery failure" "SECID21"
1556 .cindex "delivery" "permanent failure"
1557 .cindex "bounce message" "when generated"
1558 When a message cannot be delivered to some or all of its intended recipients, a
1559 bounce message is generated. Temporary delivery failures turn into permanent
1560 errors when their timeout expires. All the addresses that fail in a given
1561 delivery attempt are listed in a single message. If the original message has
1562 many recipients, it is possible for some addresses to fail in one delivery
1563 attempt and others to fail subsequently, giving rise to more than one bounce
1564 message. The wording of bounce messages can be customized by the administrator.
1565 See chapter &<<CHAPemsgcust>>& for details.
1566
1567 .cindex "&'X-Failed-Recipients:'& header line"
1568 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1569 failed addresses, for the benefit of programs that try to analyse such messages
1570 automatically.
1571
1572 .cindex "bounce message" "recipient of"
1573 A bounce message is normally sent to the sender of the original message, as
1574 obtained from the message's envelope. For incoming SMTP messages, this is the
1575 address given in the MAIL command. However, when an address is expanded via a
1576 forward or alias file, an alternative address can be specified for delivery
1577 failures of the generated addresses. For a mailing list expansion (see section
1578 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1579 of the list.
1580
1581
1582
1583 .section "Failures to deliver bounce messages" "SECID22"
1584 .cindex "bounce message" "failure to deliver"
1585 If a bounce message (either locally generated or received from a remote host)
1586 itself suffers a permanent delivery failure, the message is left on the queue,
1587 but it is frozen, awaiting the attention of an administrator. There are options
1588 that can be used to make Exim discard such failed messages, or to keep them
1589 for only a short time (see &%timeout_frozen_after%& and
1590 &%ignore_bounce_errors_after%&).
1591
1592
1593
1594
1595
1596 . ////////////////////////////////////////////////////////////////////////////
1597 . ////////////////////////////////////////////////////////////////////////////
1598
1599 .chapter "Building and installing Exim" "CHID3"
1600 .scindex IIDbuex "building Exim"
1601
1602 .section "Unpacking" "SECID23"
1603 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1604 creates a directory with the name of the current release (for example,
1605 &_exim-&version;_&) into which the following files are placed:
1606
1607 .table2 140pt
1608 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1609 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1610   documented"
1611 .irow &_LICENCE_&         "the GNU General Public Licence"
1612 .irow &_Makefile_&        "top-level make file"
1613 .irow &_NOTICE_&          "conditions for the use of Exim"
1614 .irow &_README_&          "list of files, directories and simple build &&&
1615   instructions"
1616 .endtable
1617
1618 Other files whose names begin with &_README_& may also be present. The
1619 following subdirectories are created:
1620
1621 .table2 140pt
1622 .irow &_Local_&           "an empty directory for local configuration files"
1623 .irow &_OS_&              "OS-specific files"
1624 .irow &_doc_&             "documentation files"
1625 .irow &_exim_monitor_&    "source files for the Exim monitor"
1626 .irow &_scripts_&         "scripts used in the build process"
1627 .irow &_src_&             "remaining source files"
1628 .irow &_util_&            "independent utilities"
1629 .endtable
1630
1631 The main utility programs are contained in the &_src_& directory, and are built
1632 with the Exim binary. The &_util_& directory contains a few optional scripts
1633 that may be useful to some sites.
1634
1635
1636 .section "Multiple machine architectures and operating systems" "SECID24"
1637 .cindex "building Exim" "multiple OS/architectures"
1638 The building process for Exim is arranged to make it easy to build binaries for
1639 a number of different architectures and operating systems from the same set of
1640 source files. Compilation does not take place in the &_src_& directory.
1641 Instead, a &'build directory'& is created for each architecture and operating
1642 system.
1643 .cindex "symbolic link" "to build directory"
1644 Symbolic links to the sources are installed in this directory, which is where
1645 the actual building takes place. In most cases, Exim can discover the machine
1646 architecture and operating system for itself, but the defaults can be
1647 overridden if necessary.
1648
1649
1650 .section "PCRE library" "SECTpcre"
1651 .cindex "PCRE library"
1652 Exim no longer has an embedded PCRE library as the vast majority of
1653 modern systems include PCRE as a system library, although you may need
1654 to install the PCRE or PCRE development package for your operating
1655 system. If your system has a normal PCRE installation the Exim build
1656 process will need no further configuration. If the library or the
1657 headers are in an unusual location you will need to either set the PCRE_LIBS
1658 and INCLUDE directives appropriately,
1659 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1660 If your operating system has no
1661 PCRE support then you will need to obtain and build the current PCRE
1662 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1663 More information on PCRE is available at &url(http://www.pcre.org/).
1664
1665 .section "DBM libraries" "SECTdb"
1666 .cindex "DBM libraries" "discussion of"
1667 .cindex "hints database" "DBM files used for"
1668 Even if you do not use any DBM files in your configuration, Exim still needs a
1669 DBM library in order to operate, because it uses indexed files for its hints
1670 databases. Unfortunately, there are a number of DBM libraries in existence, and
1671 different operating systems often have different ones installed.
1672
1673 .cindex "Solaris" "DBM library for"
1674 .cindex "IRIX, DBM library for"
1675 .cindex "BSD, DBM library for"
1676 .cindex "Linux, DBM library for"
1677 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1678 Linux distribution, the DBM configuration should happen automatically, and you
1679 may be able to ignore this section. Otherwise, you may have to learn more than
1680 you would like about DBM libraries from what follows.
1681
1682 .cindex "&'ndbm'& DBM library"
1683 Licensed versions of Unix normally contain a library of DBM functions operating
1684 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1685 versions of Unix seem to vary in what they contain as standard. In particular,
1686 some early versions of Linux have no default DBM library, and different
1687 distributors have chosen to bundle different libraries with their packaged
1688 versions. However, the more recent releases seem to have standardized on the
1689 Berkeley DB library.
1690
1691 Different DBM libraries have different conventions for naming the files they
1692 use. When a program opens a file called &_dbmfile_&, there are several
1693 possibilities:
1694
1695 .olist
1696 A traditional &'ndbm'& implementation, such as that supplied as part of
1697 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1698 .next
1699 .cindex "&'gdbm'& DBM library"
1700 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1701 compatibility interface it makes two different hard links to it with names
1702 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1703 file name is used unmodified.
1704 .next
1705 .cindex "Berkeley DB library"
1706 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1707 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1708 programmer exactly the same as the traditional &'ndbm'& implementation.
1709 .next
1710 If the Berkeley package is used in its native mode, it operates on a single
1711 file called &_dbmfile_&; the programmer's interface is somewhat different to
1712 the traditional &'ndbm'& interface.
1713 .next
1714 To complicate things further, there are several very different versions of the
1715 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1716 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1717 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1718 versions of Berkeley DB can be obtained from
1719 &url(http://www.sleepycat.com/).
1720 .next
1721 .cindex "&'tdb'& DBM library"
1722 Yet another DBM library, called &'tdb'&, is available from
1723 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1724 operates on a single file.
1725 .endlist
1726
1727 .cindex "USE_DB"
1728 .cindex "DBM libraries" "configuration for building"
1729 Exim and its utilities can be compiled to use any of these interfaces. In order
1730 to use any version of the Berkeley DB package in native mode, you must set
1731 USE_DB in an appropriate configuration file (typically
1732 &_Local/Makefile_&). For example:
1733 .code
1734 USE_DB=yes
1735 .endd
1736 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1737 error is diagnosed if you set more than one of these.
1738
1739 At the lowest level, the build-time configuration sets none of these options,
1740 thereby assuming an interface of type (1). However, some operating system
1741 configuration files (for example, those for the BSD operating systems and
1742 Linux) assume type (4) by setting USE_DB as their default, and the
1743 configuration files for Cygwin set USE_GDBM. Anything you set in
1744 &_Local/Makefile_&, however, overrides these system defaults.
1745
1746 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1747 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1748 in one of these lines:
1749 .code
1750 DBMLIB = -ldb
1751 DBMLIB = -ltdb
1752 .endd
1753 Settings like that will work if the DBM library is installed in the standard
1754 place. Sometimes it is not, and the library's header file may also not be in
1755 the default path. You may need to set INCLUDE to specify where the header
1756 file is, and to specify the path to the library more fully in DBMLIB, as in
1757 this example:
1758 .code
1759 INCLUDE=-I/usr/local/include/db-4.1
1760 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1761 .endd
1762 There is further detailed discussion about the various DBM libraries in the
1763 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1764
1765
1766
1767 .section "Pre-building configuration" "SECID25"
1768 .cindex "building Exim" "pre-building configuration"
1769 .cindex "configuration for building Exim"
1770 .cindex "&_Local/Makefile_&"
1771 .cindex "&_src/EDITME_&"
1772 Before building Exim, a local configuration file that specifies options
1773 independent of any operating system has to be created with the name
1774 &_Local/Makefile_&. A template for this file is supplied as the file
1775 &_src/EDITME_&, and it contains full descriptions of all the option settings
1776 therein. These descriptions are therefore not repeated here. If you are
1777 building Exim for the first time, the simplest thing to do is to copy
1778 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1779
1780 There are three settings that you must supply, because Exim will not build
1781 without them. They are the location of the run time configuration file
1782 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1783 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1784 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1785 a colon-separated list of file names; Exim uses the first of them that exists.
1786
1787 There are a few other parameters that can be specified either at build time or
1788 at run time, to enable the same binary to be used on a number of different
1789 machines. However, if the locations of Exim's spool directory and log file
1790 directory (if not within the spool directory) are fixed, it is recommended that
1791 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1792 detected early in Exim's execution (such as a malformed configuration file) can
1793 be logged.
1794
1795 .cindex "content scanning" "specifying at build time"
1796 Exim's interfaces for calling virus and spam scanning software directly from
1797 access control lists are not compiled by default. If you want to include these
1798 facilities, you need to set
1799 .code
1800 WITH_CONTENT_SCAN=yes
1801 .endd
1802 in your &_Local/Makefile_&. For details of the facilities themselves, see
1803 chapter &<<CHAPexiscan>>&.
1804
1805
1806 .cindex "&_Local/eximon.conf_&"
1807 .cindex "&_exim_monitor/EDITME_&"
1808 If you are going to build the Exim monitor, a similar configuration process is
1809 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1810 your installation and saved under the name &_Local/eximon.conf_&. If you are
1811 happy with the default settings described in &_exim_monitor/EDITME_&,
1812 &_Local/eximon.conf_& can be empty, but it must exist.
1813
1814 This is all the configuration that is needed in straightforward cases for known
1815 operating systems. However, the building process is set up so that it is easy
1816 to override options that are set by default or by operating-system-specific
1817 configuration files, for example to change the name of the C compiler, which
1818 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1819 do this.
1820
1821
1822
1823 .section "Support for iconv()" "SECID26"
1824 .cindex "&[iconv()]& support"
1825 .cindex "RFC 2047"
1826 The contents of header lines in messages may be encoded according to the rules
1827 described RFC 2047. This makes it possible to transmit characters that are not
1828 in the ASCII character set, and to label them as being in a particular
1829 character set. When Exim is inspecting header lines by means of the &%$h_%&
1830 mechanism, it decodes them, and translates them into a specified character set
1831 (default ISO-8859-1). The translation is possible only if the operating system
1832 supports the &[iconv()]& function.
1833
1834 However, some of the operating systems that supply &[iconv()]& do not support
1835 very many conversions. The GNU &%libiconv%& library (available from
1836 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1837 systems to remedy this deficiency, as well as on systems that do not supply
1838 &[iconv()]& at all. After installing &%libiconv%&, you should add
1839 .code
1840 HAVE_ICONV=yes
1841 .endd
1842 to your &_Local/Makefile_& and rebuild Exim.
1843
1844
1845
1846 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1847 .cindex "TLS" "including support for TLS"
1848 .cindex "encryption" "including support for"
1849 .cindex "SUPPORT_TLS"
1850 .cindex "OpenSSL" "building Exim with"
1851 .cindex "GnuTLS" "building Exim with"
1852 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1853 command as per RFC 2487. It can also support legacy clients that expect to
1854 start a TLS session immediately on connection to a non-standard port (see the
1855 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1856 line option).
1857
1858 If you want to build Exim with TLS support, you must first install either the
1859 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1860 implementing SSL.
1861
1862 If OpenSSL is installed, you should set
1863 .code
1864 SUPPORT_TLS=yes
1865 TLS_LIBS=-lssl -lcrypto
1866 .endd
1867 in &_Local/Makefile_&. You may also need to specify the locations of the
1868 OpenSSL library and include files. For example:
1869 .code
1870 SUPPORT_TLS=yes
1871 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1872 TLS_INCLUDE=-I/usr/local/openssl/include/
1873 .endd
1874 .cindex "pkg-config" "OpenSSL"
1875 If you have &'pkg-config'& available, then instead you can just use:
1876 .code
1877 SUPPORT_TLS=yes
1878 USE_OPENSSL_PC=openssl
1879 .endd
1880 .cindex "USE_GNUTLS"
1881 If GnuTLS is installed, you should set
1882 .code
1883 SUPPORT_TLS=yes
1884 USE_GNUTLS=yes
1885 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1886 .endd
1887 in &_Local/Makefile_&, and again you may need to specify the locations of the
1888 library and include files. For example:
1889 .code
1890 SUPPORT_TLS=yes
1891 USE_GNUTLS=yes
1892 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1893 TLS_INCLUDE=-I/usr/gnu/include
1894 .endd
1895 .cindex "pkg-config" "GnuTLS"
1896 If you have &'pkg-config'& available, then instead you can just use:
1897 .code
1898 SUPPORT_TLS=yes
1899 USE_GNUTLS=yes
1900 USE_GNUTLS_PC=gnutls
1901 .endd
1902
1903 You do not need to set TLS_INCLUDE if the relevant directory is already
1904 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1905 given in chapter &<<CHAPTLS>>&.
1906
1907
1908
1909
1910 .section "Use of tcpwrappers" "SECID27"
1911
1912 .cindex "tcpwrappers, building Exim to support"
1913 .cindex "USE_TCP_WRAPPERS"
1914 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1915 .cindex "tcp_wrappers_daemon_name"
1916 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1917 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1918 alternative to Exim's own checking facilities for installations that are
1919 already making use of &'tcpwrappers'& for other purposes. To do this, you
1920 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1921 &_tcpd.h_& to be available at compile time, and also ensure that the library
1922 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1923 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1924 you might have
1925 .code
1926 USE_TCP_WRAPPERS=yes
1927 CFLAGS=-O -I/usr/local/include
1928 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1929 .endd
1930 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1931 files is &"exim"&. For example, the line
1932 .code
1933 exim : LOCAL  192.168.1.  .friendly.domain.example
1934 .endd
1935 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1936 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1937 All other connections are denied. The daemon name used by &'tcpwrappers'&
1938 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1939 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1940 configure file. Consult the &'tcpwrappers'& documentation for
1941 further details.
1942
1943
1944 .section "Including support for IPv6" "SECID28"
1945 .cindex "IPv6" "including support for"
1946 Exim contains code for use on systems that have IPv6 support. Setting
1947 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1948 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1949 where the IPv6 support is not fully integrated into the normal include and
1950 library files.
1951
1952 Two different types of DNS record for handling IPv6 addresses have been
1953 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1954 currently seen as the mainstream. Another record type called A6 was proposed
1955 as better than AAAA because it had more flexibility. However, it was felt to be
1956 over-complex, and its status was reduced to &"experimental"&. It is not known
1957 if anyone is actually using A6 records. Exim has support for A6 records, but
1958 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1959 support has not been tested for some time.
1960
1961
1962
1963 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1964 .cindex "lookup modules"
1965 .cindex "dynamic modules"
1966 .cindex ".so building"
1967 On some platforms, Exim supports not compiling all lookup types directly into
1968 the main binary, instead putting some into external modules which can be loaded
1969 on demand.
1970 This permits packagers to build Exim with support for lookups with extensive
1971 library dependencies without requiring all users to install all of those
1972 dependencies.
1973 Most, but not all, lookup types can be built this way.
1974
1975 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
1976 installed; Exim will only load modules from that directory, as a security
1977 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
1978 for your OS; see &_OS/Makefile-Linux_& for an example.
1979 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
1980 see &_src/EDITME_& for details.
1981
1982 Then, for each module to be loaded dynamically, define the relevant
1983 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
1984 For example, this will build in lsearch but load sqlite and mysql support
1985 on demand:
1986 .code
1987 LOOKUP_LSEARCH=yes
1988 LOOKUP_SQLITE=2
1989 LOOKUP_MYSQL=2
1990 .endd
1991
1992
1993 .section "The building process" "SECID29"
1994 .cindex "build directory"
1995 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
1996 created, run &'make'& at the top level. It determines the architecture and
1997 operating system types, and creates a build directory if one does not exist.
1998 For example, on a Sun system running Solaris 8, the directory
1999 &_build-SunOS5-5.8-sparc_& is created.
2000 .cindex "symbolic link" "to source files"
2001 Symbolic links to relevant source files are installed in the build directory.
2002
2003 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
2004 building process fails if it is set.
2005
2006 If this is the first time &'make'& has been run, it calls a script that builds
2007 a make file inside the build directory, using the configuration files from the
2008 &_Local_& directory. The new make file is then passed to another instance of
2009 &'make'&. This does the real work, building a number of utility scripts, and
2010 then compiling and linking the binaries for the Exim monitor (if configured), a
2011 number of utility programs, and finally Exim itself. The command &`make
2012 makefile`& can be used to force a rebuild of the make file in the build
2013 directory, should this ever be necessary.
2014
2015 If you have problems building Exim, check for any comments there may be in the
2016 &_README_& file concerning your operating system, and also take a look at the
2017 FAQ, where some common problems are covered.
2018
2019
2020
2021 .section 'Output from &"make"&' "SECID283"
2022 The output produced by the &'make'& process for compile lines is often very
2023 unreadable, because these lines can be very long. For this reason, the normal
2024 output is suppressed by default, and instead output similar to that which
2025 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2026 each module that is being compiled or linked. However, it is still possible to
2027 get the full output, by calling &'make'& like this:
2028 .code
2029 FULLECHO='' make -e
2030 .endd
2031 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2032 command reflection in &'make'&. When you ask for the full output, it is
2033 given in addition to the short output.
2034
2035
2036
2037 .section "Overriding build-time options for Exim" "SECToverride"
2038 .cindex "build-time options, overriding"
2039 The main make file that is created at the beginning of the building process
2040 consists of the concatenation of a number of files which set configuration
2041 values, followed by a fixed set of &'make'& instructions. If a value is set
2042 more than once, the last setting overrides any previous ones. This provides a
2043 convenient way of overriding defaults. The files that are concatenated are, in
2044 order:
2045 .display
2046 &_OS/Makefile-Default_&
2047 &_OS/Makefile-_&<&'ostype'&>
2048 &_Local/Makefile_&
2049 &_Local/Makefile-_&<&'ostype'&>
2050 &_Local/Makefile-_&<&'archtype'&>
2051 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2052 &_OS/Makefile-Base_&
2053 .endd
2054 .cindex "&_Local/Makefile_&"
2055 .cindex "building Exim" "operating system type"
2056 .cindex "building Exim" "architecture type"
2057 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2058 architecture type. &_Local/Makefile_& is required to exist, and the building
2059 process fails if it is absent. The other three &_Local_& files are optional,
2060 and are often not needed.
2061
2062 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2063 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2064 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2065 values are used, thereby providing a means of forcing particular settings.
2066 Otherwise, the scripts try to get values from the &%uname%& command. If this
2067 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2068 of &'ad hoc'& transformations are then applied, to produce the standard names
2069 that Exim expects. You can run these scripts directly from the shell in order
2070 to find out what values are being used on your system.
2071
2072
2073 &_OS/Makefile-Default_& contains comments about the variables that are set
2074 therein. Some (but not all) are mentioned below. If there is something that
2075 needs changing, review the contents of this file and the contents of the make
2076 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2077 default values are.
2078
2079
2080 .cindex "building Exim" "overriding default settings"
2081 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2082 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2083 need to change the original files. Instead, you should make the changes by
2084 putting the new values in an appropriate &_Local_& file. For example,
2085 .cindex "Tru64-Unix build-time settings"
2086 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2087 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2088 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2089 called with the option &%-std1%&, to make it recognize some of the features of
2090 Standard C that Exim uses. (Most other compilers recognize Standard C by
2091 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2092 containing the lines
2093 .code
2094 CC=cc
2095 CFLAGS=-std1
2096 .endd
2097 If you are compiling for just one operating system, it may be easier to put
2098 these lines directly into &_Local/Makefile_&.
2099
2100 Keeping all your local configuration settings separate from the distributed
2101 files makes it easy to transfer them to new versions of Exim simply by copying
2102 the contents of the &_Local_& directory.
2103
2104
2105 .cindex "NIS lookup type" "including support for"
2106 .cindex "NIS+ lookup type" "including support for"
2107 .cindex "LDAP" "including support for"
2108 .cindex "lookup" "inclusion in binary"
2109 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2110 lookup, but not all systems have these components installed, so the default is
2111 not to include the relevant code in the binary. All the different kinds of file
2112 and database lookup that Exim supports are implemented as separate code modules
2113 which are included only if the relevant compile-time options are set. In the
2114 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2115 .code
2116 LOOKUP_LDAP=yes
2117 LOOKUP_NIS=yes
2118 LOOKUP_NISPLUS=yes
2119 .endd
2120 and similar settings apply to the other lookup types. They are all listed in
2121 &_src/EDITME_&. In many cases the relevant include files and interface
2122 libraries need to be installed before compiling Exim.
2123 .cindex "cdb" "including support for"
2124 However, there are some optional lookup types (such as cdb) for which
2125 the code is entirely contained within Exim, and no external include
2126 files or libraries are required. When a lookup type is not included in the
2127 binary, attempts to configure Exim to use it cause run time configuration
2128 errors.
2129
2130 .cindex "pkg-config" "lookups"
2131 .cindex "pkg-config" "authenticators"
2132 Many systems now use a tool called &'pkg-config'& to encapsulate information
2133 about how to compile against a library; Exim has some initial support for
2134 being able to use pkg-config for lookups and authenticators.  For any given
2135 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2136 variable with the &`_PC`& suffix in the name and assign as the value the
2137 name of the package to be queried.  The results of querying via the
2138 &'pkg-config'& command will be added to the appropriate Makefile variables
2139 with &`+=`& directives, so your version of &'make'& will need to support that
2140 syntax.  For instance:
2141 .code
2142 LOOKUP_SQLITE=yes
2143 LOOKUP_SQLITE_PC=sqlite3
2144 AUTH_GSASL=yes
2145 AUTH_GSASL_PC=libgsasl
2146 AUTH_HEIMDAL_GSSAPI=yes
2147 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2148 .endd
2149
2150 .cindex "Perl" "including support for"
2151 Exim can be linked with an embedded Perl interpreter, allowing Perl
2152 subroutines to be called during string expansion. To enable this facility,
2153 .code
2154 EXIM_PERL=perl.o
2155 .endd
2156 must be defined in &_Local/Makefile_&. Details of this facility are given in
2157 chapter &<<CHAPperl>>&.
2158
2159 .cindex "X11 libraries, location of"
2160 The location of the X11 libraries is something that varies a lot between
2161 operating systems, and there may be different versions of X11 to cope
2162 with. Exim itself makes no use of X11, but if you are compiling the Exim
2163 monitor, the X11 libraries must be available.
2164 The following three variables are set in &_OS/Makefile-Default_&:
2165 .code
2166 X11=/usr/X11R6
2167 XINCLUDE=-I$(X11)/include
2168 XLFLAGS=-L$(X11)/lib
2169 .endd
2170 These are overridden in some of the operating-system configuration files. For
2171 example, in &_OS/Makefile-SunOS5_& there is
2172 .code
2173 X11=/usr/openwin
2174 XINCLUDE=-I$(X11)/include
2175 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2176 .endd
2177 If you need to override the default setting for your operating system, place a
2178 definition of all three of these variables into your
2179 &_Local/Makefile-<ostype>_& file.
2180
2181 .cindex "EXTRALIBS"
2182 If you need to add any extra libraries to the link steps, these can be put in a
2183 variable called EXTRALIBS, which appears in all the link commands, but by
2184 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2185 command for linking the main Exim binary, and not for any associated utilities.
2186
2187 .cindex "DBM libraries" "configuration for building"
2188 There is also DBMLIB, which appears in the link commands for binaries that
2189 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2190 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2191 binary, and which can be used, for example, to include additional X11
2192 libraries.
2193
2194 .cindex "configuration file" "editing"
2195 The make file copes with rebuilding Exim correctly if any of the configuration
2196 files are edited. However, if an optional configuration file is deleted, it is
2197 necessary to touch the associated non-optional file (that is,
2198 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2199
2200
2201 .section "OS-specific header files" "SECID30"
2202 .cindex "&_os.h_&"
2203 .cindex "building Exim" "OS-specific C header files"
2204 The &_OS_& directory contains a number of files with names of the form
2205 &_os.h-<ostype>_&. These are system-specific C header files that should not
2206 normally need to be changed. There is a list of macro settings that are
2207 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2208 are porting Exim to a new operating system.
2209
2210
2211
2212 .section "Overriding build-time options for the monitor" "SECID31"
2213 .cindex "building Eximon"
2214 A similar process is used for overriding things when building the Exim monitor,
2215 where the files that are involved are
2216 .display
2217 &_OS/eximon.conf-Default_&
2218 &_OS/eximon.conf-_&<&'ostype'&>
2219 &_Local/eximon.conf_&
2220 &_Local/eximon.conf-_&<&'ostype'&>
2221 &_Local/eximon.conf-_&<&'archtype'&>
2222 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2223 .endd
2224 .cindex "&_Local/eximon.conf_&"
2225 As with Exim itself, the final three files need not exist, and in this case the
2226 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2227 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2228 variables of the same name, preceded by EXIMON_. For example, setting
2229 EXIMON_LOG_DEPTH in the environment overrides the value of
2230 LOG_DEPTH at run time.
2231 .ecindex IIDbuex
2232
2233
2234 .section "Installing Exim binaries and scripts" "SECID32"
2235 .cindex "installing Exim"
2236 .cindex "BIN_DIRECTORY"
2237 The command &`make install`& runs the &(exim_install)& script with no
2238 arguments. The script copies binaries and utility scripts into the directory
2239 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2240 .cindex "setuid" "installing Exim with"
2241 The install script copies files only if they are newer than the files they are
2242 going to replace. The Exim binary is required to be owned by root and have the
2243 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2244 install`& as root so that it can set up the Exim binary in this way. However, in
2245 some special situations (for example, if a host is doing no local deliveries)
2246 it may be possible to run Exim without making the binary setuid root (see
2247 chapter &<<CHAPsecurity>>& for details).
2248
2249 .cindex "CONFIGURE_FILE"
2250 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2251 in &_Local/Makefile_&. If this names a single file, and the file does not
2252 exist, the default configuration file &_src/configure.default_& is copied there
2253 by the installation script. If a run time configuration file already exists, it
2254 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2255 alternative files, no default is installed.
2256
2257 .cindex "system aliases file"
2258 .cindex "&_/etc/aliases_&"
2259 One change is made to the default configuration file when it is installed: the
2260 default configuration contains a router that references a system aliases file.
2261 The path to this file is set to the value specified by
2262 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2263 If the system aliases file does not exist, the installation script creates it,
2264 and outputs a comment to the user.
2265
2266 The created file contains no aliases, but it does contain comments about the
2267 aliases a site should normally have. Mail aliases have traditionally been
2268 kept in &_/etc/aliases_&. However, some operating systems are now using
2269 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2270 Exim's configuration if necessary.
2271
2272 The default configuration uses the local host's name as the only local domain,
2273 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2274 running as the local user. System aliases and &_.forward_& files in users' home
2275 directories are supported, but no NIS or NIS+ support is configured. Domains
2276 other than the name of the local host are routed using the DNS, with delivery
2277 over SMTP.
2278
2279 It is possible to install Exim for special purposes (such as building a binary
2280 distribution) in a private part of the file system. You can do this by a
2281 command such as
2282 .code
2283 make DESTDIR=/some/directory/ install
2284 .endd
2285 This has the effect of pre-pending the specified directory to all the file
2286 paths, except the name of the system aliases file that appears in the default
2287 configuration. (If a default alias file is created, its name &'is'& modified.)
2288 For backwards compatibility, ROOT is used if DESTDIR is not set,
2289 but this usage is deprecated.
2290
2291 .cindex "installing Exim" "what is not installed"
2292 Running &'make install'& does not copy the Exim 4 conversion script
2293 &'convert4r4'&. You will probably run this only once if you are
2294 upgrading from Exim 3. None of the documentation files in the &_doc_&
2295 directory are copied, except for the info files when you have set
2296 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2297
2298 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2299 to their names. The Exim binary itself, however, is handled differently. It is
2300 installed under a name that includes the version number and the compile number,
2301 for example &_exim-&version;-1_&. The script then arranges for a symbolic link
2302 called &_exim_& to point to the binary. If you are updating a previous version
2303 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2304 from the directory (as seen by other processes).
2305
2306 .cindex "installing Exim" "testing the script"
2307 If you want to see what the &'make install'& will do before running it for
2308 real, you can pass the &%-n%& option to the installation script by this
2309 command:
2310 .code
2311 make INSTALL_ARG=-n install
2312 .endd
2313 The contents of the variable INSTALL_ARG are passed to the installation
2314 script. You do not need to be root to run this test. Alternatively, you can run
2315 the installation script directly, but this must be from within the build
2316 directory. For example, from the top-level Exim directory you could use this
2317 command:
2318 .code
2319 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2320 .endd
2321 .cindex "installing Exim" "install script options"
2322 There are two other options that can be supplied to the installation script.
2323
2324 .ilist
2325 &%-no_chown%& bypasses the call to change the owner of the installed binary
2326 to root, and the call to make it a setuid binary.
2327 .next
2328 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2329 installed binary.
2330 .endlist
2331
2332 INSTALL_ARG can be used to pass these options to the script. For example:
2333 .code
2334 make INSTALL_ARG=-no_symlink install
2335 .endd
2336 The installation script can also be given arguments specifying which files are
2337 to be copied. For example, to install just the Exim binary, and nothing else,
2338 without creating the symbolic link, you could use:
2339 .code
2340 make INSTALL_ARG='-no_symlink exim' install
2341 .endd
2342
2343
2344
2345 .section "Installing info documentation" "SECTinsinfdoc"
2346 .cindex "installing Exim" "&'info'& documentation"
2347 Not all systems use the GNU &'info'& system for documentation, and for this
2348 reason, the Texinfo source of Exim's documentation is not included in the main
2349 distribution. Instead it is available separately from the ftp site (see section
2350 &<<SECTavail>>&).
2351
2352 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2353 source of the documentation is found in the source tree, running &`make
2354 install`& automatically builds the info files and installs them.
2355
2356
2357
2358 .section "Setting up the spool directory" "SECID33"
2359 .cindex "spool directory" "creating"
2360 When it starts up, Exim tries to create its spool directory if it does not
2361 exist. The Exim uid and gid are used for the owner and group of the spool
2362 directory. Sub-directories are automatically created in the spool directory as
2363 necessary.
2364
2365
2366
2367
2368 .section "Testing" "SECID34"
2369 .cindex "testing" "installation"
2370 Having installed Exim, you can check that the run time configuration file is
2371 syntactically valid by running the following command, which assumes that the
2372 Exim binary directory is within your PATH environment variable:
2373 .code
2374 exim -bV
2375 .endd
2376 If there are any errors in the configuration file, Exim outputs error messages.
2377 Otherwise it outputs the version number and build date,
2378 the DBM library that is being used, and information about which drivers and
2379 other optional code modules are included in the binary.
2380 Some simple routing tests can be done by using the address testing option. For
2381 example,
2382 .display
2383 &`exim -bt`& <&'local username'&>
2384 .endd
2385 should verify that it recognizes a local mailbox, and
2386 .display
2387 &`exim -bt`& <&'remote address'&>
2388 .endd
2389 a remote one. Then try getting it to deliver mail, both locally and remotely.
2390 This can be done by passing messages directly to Exim, without going through a
2391 user agent. For example:
2392 .code
2393 exim -v postmaster@your.domain.example
2394 From: user@your.domain.example
2395 To: postmaster@your.domain.example
2396 Subject: Testing Exim
2397
2398 This is a test message.
2399 ^D
2400 .endd
2401 The &%-v%& option causes Exim to output some verification of what it is doing.
2402 In this case you should see copies of three log lines, one for the message's
2403 arrival, one for its delivery, and one containing &"Completed"&.
2404
2405 .cindex "delivery" "problems with"
2406 If you encounter problems, look at Exim's log files (&'mainlog'& and
2407 &'paniclog'&) to see if there is any relevant information there. Another source
2408 of information is running Exim with debugging turned on, by specifying the
2409 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2410 with debugging turned on by a command of the form
2411 .display
2412 &`exim -d -M`& <&'exim-message-id'&>
2413 .endd
2414 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2415 produces rather a lot of output, but you can cut this down to specific areas.
2416 For example, if you use &%-d-all+route%& only the debugging information
2417 relevant to routing is included. (See the &%-d%& option in chapter
2418 &<<CHAPcommandline>>& for more details.)
2419
2420 .cindex '&"sticky"& bit'
2421 .cindex "lock files"
2422 One specific problem that has shown up on some sites is the inability to do
2423 local deliveries into a shared mailbox directory, because it does not have the
2424 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2425 writing to a mailbox file, and if it cannot create the lock file, the delivery
2426 is deferred. You can get round this either by setting the &"sticky bit"& on the
2427 directory, or by setting a specific group for local deliveries and allowing
2428 that group to create files in the directory (see the comments above the
2429 &(local_delivery)& transport in the default configuration file). Another
2430 approach is to configure Exim not to use lock files, but just to rely on
2431 &[fcntl()]& locking instead. However, you should do this only if all user
2432 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2433 see chapter &<<CHAPappendfile>>&.
2434
2435 One thing that cannot be tested on a system that is already running an MTA is
2436 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2437 &%-oX%& option can be used to run an Exim daemon that listens on some other
2438 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2439 &'exim_checkaccess'& utility can be used to check out policy controls on
2440 incoming SMTP mail.
2441
2442 Testing a new version on a system that is already running Exim can most easily
2443 be done by building a binary with a different CONFIGURE_FILE setting. From
2444 within the run time configuration, all other file and directory names
2445 that Exim uses can be altered, in order to keep it entirely clear of the
2446 production version.
2447
2448
2449 .section "Replacing another MTA with Exim" "SECID35"
2450 .cindex "replacing another MTA"
2451 Building and installing Exim for the first time does not of itself put it in
2452 general use. The name by which the system's MTA is called by mail user agents
2453 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2454 operating system), and it is necessary to make this name point to the &'exim'&
2455 binary in order to get the user agents to pass messages to Exim. This is
2456 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2457 or &_/usr/lib/sendmail_&
2458 .cindex "symbolic link" "to &'exim'& binary"
2459 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2460 privilege and executable status from the old MTA. It is then necessary to stop
2461 and restart the mailer daemon, if one is running.
2462
2463 .cindex "FreeBSD, MTA indirection"
2464 .cindex "&_/etc/mail/mailer.conf_&"
2465 Some operating systems have introduced alternative ways of switching MTAs. For
2466 example, if you are running FreeBSD, you need to edit the file
2467 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2468 described. A typical example of the contents of this file for running Exim is
2469 as follows:
2470 .code
2471 sendmail            /usr/exim/bin/exim
2472 send-mail           /usr/exim/bin/exim
2473 mailq               /usr/exim/bin/exim -bp
2474 newaliases          /usr/bin/true
2475 .endd
2476 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2477 your Exim installation is &"live"&. Check it by sending a message from your
2478 favourite user agent.
2479
2480 You should consider what to tell your users about the change of MTA. Exim may
2481 have different capabilities to what was previously running, and there are
2482 various operational differences such as the text of messages produced by
2483 command line options and in bounce messages. If you allow your users to make
2484 use of Exim's filtering capabilities, you should make the document entitled
2485 &'Exim's interface to mail filtering'& available to them.
2486
2487
2488
2489 .section "Upgrading Exim" "SECID36"
2490 .cindex "upgrading Exim"
2491 If you are already running Exim on your host, building and installing a new
2492 version automatically makes it available to MUAs, or any other programs that
2493 call the MTA directly. However, if you are running an Exim daemon, you do need
2494 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2495 new binary. You do not need to stop processing mail in order to install a new
2496 version of Exim. The install script does not modify an existing runtime
2497 configuration file.
2498
2499
2500
2501
2502 .section "Stopping the Exim daemon on Solaris" "SECID37"
2503 .cindex "Solaris" "stopping Exim on"
2504 The standard command for stopping the mailer daemon on Solaris is
2505 .code
2506 /etc/init.d/sendmail stop
2507 .endd
2508 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2509 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2510 for the text &"sendmail"&; this is not present because the actual program name
2511 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2512 solution is to replace the line that finds the process id with something like
2513 .code
2514 pid=`cat /var/spool/exim/exim-daemon.pid`
2515 .endd
2516 to obtain the daemon's pid directly from the file that Exim saves it in.
2517
2518 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2519 still be received from local processes, and if automatic delivery is configured
2520 (the normal case), deliveries will still occur.
2521
2522
2523
2524
2525 . ////////////////////////////////////////////////////////////////////////////
2526 . ////////////////////////////////////////////////////////////////////////////
2527
2528 .chapter "The Exim command line" "CHAPcommandline"
2529 .scindex IIDclo1 "command line" "options"
2530 .scindex IIDclo2 "options" "command line"
2531 Exim's command line takes the standard Unix form of a sequence of options,
2532 each starting with a hyphen character, followed by a number of arguments. The
2533 options are compatible with the main options of Sendmail, and there are also
2534 some additional options, some of which are compatible with Smail 3. Certain
2535 combinations of options do not make sense, and provoke an error if used.
2536 The form of the arguments depends on which options are set.
2537
2538
2539 .section "Setting options by program name" "SECID38"
2540 .cindex "&'mailq'&"
2541 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2542 were present before any other options.
2543 The &%-bp%& option requests a listing of the contents of the mail queue on the
2544 standard output.
2545 This feature is for compatibility with some systems that contain a command of
2546 that name in one of the standard libraries, symbolically linked to
2547 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2548
2549 .cindex "&'rsmtp'&"
2550 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2551 were present before any other options, for compatibility with Smail. The
2552 &%-bS%& option is used for reading in a number of messages in batched SMTP
2553 format.
2554
2555 .cindex "&'rmail'&"
2556 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2557 &%-oee%& options were present before any other options, for compatibility with
2558 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2559
2560 .cindex "&'runq'&"
2561 .cindex "queue runner"
2562 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2563 were present before any other options, for compatibility with Smail. The &%-q%&
2564 option causes a single queue runner process to be started.
2565
2566 .cindex "&'newaliases'&"
2567 .cindex "alias file" "building"
2568 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2569 If Exim is called under the name &'newaliases'& it behaves as if the option
2570 &%-bi%& were present before any other options, for compatibility with Sendmail.
2571 This option is used for rebuilding Sendmail's alias file. Exim does not have
2572 the concept of a single alias file, but can be configured to run a given
2573 command if called with the &%-bi%& option.
2574
2575
2576 .section "Trusted and admin users" "SECTtrustedadmin"
2577 Some Exim options are available only to &'trusted users'& and others are
2578 available only to &'admin users'&. In the description below, the phrases &"Exim
2579 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2580 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2581 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2582
2583 .ilist
2584 .cindex "trusted users" "definition of"
2585 .cindex "user" "trusted definition of"
2586 The trusted users are root, the Exim user, any user listed in the
2587 &%trusted_users%& configuration option, and any user whose current group or any
2588 supplementary group is one of those listed in the &%trusted_groups%&
2589 configuration option. Note that the Exim group is not automatically trusted.
2590
2591 .cindex '&"From"& line'
2592 .cindex "envelope sender"
2593 Trusted users are always permitted to use the &%-f%& option or a leading
2594 &"From&~"& line to specify the envelope sender of a message that is passed to
2595 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2596 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2597 users to set envelope senders.
2598
2599 .cindex "&'From:'& header line"
2600 .cindex "&'Sender:'& header line"
2601 For a trusted user, there is never any check on the contents of the &'From:'&
2602 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2603 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2604
2605 Trusted users may also specify a host name, host address, interface address,
2606 protocol name, ident value, and authentication data when submitting a message
2607 locally. Thus, they are able to insert messages into Exim's queue locally that
2608 have the characteristics of messages received from a remote host. Untrusted
2609 users may in some circumstances use &%-f%&, but can never set the other values
2610 that are available to trusted users.
2611 .next
2612 .cindex "user" "admin definition of"
2613 .cindex "admin user" "definition of"
2614 The admin users are root, the Exim user, and any user that is a member of the
2615 Exim group or of any group listed in the &%admin_groups%& configuration option.
2616 The current group does not have to be one of these groups.
2617
2618 Admin users are permitted to list the queue, and to carry out certain
2619 operations on messages, for example, to force delivery failures. It is also
2620 necessary to be an admin user in order to see the full information provided by
2621 the Exim monitor, and full debugging output.
2622
2623 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2624 Exim to attempt delivery of messages on its queue is restricted to admin users.
2625 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2626 option false (that is, specifying &%no_prod_requires_admin%&).
2627
2628 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2629 is restricted to admin users unless &%queue_list_requires_admin%& is set
2630 false.
2631 .endlist
2632
2633
2634 &*Warning*&: If you configure your system so that admin users are able to
2635 edit Exim's configuration file, you are giving those users an easy way of
2636 getting root. There is further discussion of this issue at the start of chapter
2637 &<<CHAPconf>>&.
2638
2639
2640
2641
2642 .section "Command line options" "SECID39"
2643 Exim's command line options are described in alphabetical order below. If none
2644 of the options that specifies a specific action (such as starting the daemon or
2645 a queue runner, or testing an address, or receiving a message in a specific
2646 format, or listing the queue) are present, and there is at least one argument
2647 on the command line, &%-bm%& (accept a local message on the standard input,
2648 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2649 outputs a brief message about itself and exits.
2650
2651 . ////////////////////////////////////////////////////////////////////////////
2652 . Insert a stylized XML comment here, to identify the start of the command line
2653 . options. This is for the benefit of the Perl script that automatically
2654 . creates a man page for the options.
2655 . ////////////////////////////////////////////////////////////////////////////
2656
2657 .literal xml
2658 <!-- === Start of command line options === -->
2659 .literal off
2660
2661
2662 .vlist
2663 .vitem &%--%&
2664 .oindex "--"
2665 .cindex "options" "command line; terminating"
2666 This is a pseudo-option whose only purpose is to terminate the options and
2667 therefore to cause subsequent command line items to be treated as arguments
2668 rather than options, even if they begin with hyphens.
2669
2670 .vitem &%--help%&
2671 .oindex "&%--help%&"
2672 This option causes Exim to output a few sentences stating what it is.
2673 The same output is generated if the Exim binary is called with no options and
2674 no arguments.
2675
2676 .vitem &%--version%&
2677 .oindex "&%--version%&"
2678 This option is an alias for &%-bV%& and causes version information to be
2679 displayed.
2680
2681 .new
2682 .vitem &%-Ac%& &&&
2683        &%-Am%&
2684 .oindex "&%-Ac%&"
2685 .oindex "&%-Am%&"
2686 These options are used by Sendmail for selecting configuration files and are
2687 ignored by Exim.
2688 .wen
2689
2690 .vitem &%-B%&<&'type'&>
2691 .oindex "&%-B%&"
2692 .cindex "8-bit characters"
2693 .cindex "Sendmail compatibility" "8-bit characters"
2694 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2695 clean; it ignores this option.
2696
2697 .vitem &%-bd%&
2698 .oindex "&%-bd%&"
2699 .cindex "daemon"
2700 .cindex "SMTP" "listener"
2701 .cindex "queue runner"
2702 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2703 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2704 that the daemon should also initiate periodic queue runs.
2705
2706 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2707 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2708 disconnect from the controlling terminal. When running this way, it can be
2709 stopped by pressing ctrl-C.
2710
2711 By default, Exim listens for incoming connections to the standard SMTP port on
2712 all the host's running interfaces. However, it is possible to listen on other
2713 ports, on multiple ports, and only on specific interfaces. Chapter
2714 &<<CHAPinterfaces>>& contains a description of the options that control this.
2715
2716 When a listening daemon
2717 .cindex "daemon" "process id (pid)"
2718 .cindex "pid (process id)" "of daemon"
2719 is started without the use of &%-oX%& (that is, without overriding the normal
2720 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2721 in Exim's spool directory. This location can be overridden by setting
2722 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2723 running as root.
2724
2725 When &%-oX%& is used on the command line to start a listening daemon, the
2726 process id is not written to the normal pid file path. However, &%-oP%& can be
2727 used to specify a path on the command line if a pid file is required.
2728
2729 The SIGHUP signal
2730 .cindex "SIGHUP"
2731 .cindex "daemon" "restarting"
2732 can be used to cause the daemon to re-execute itself. This should be done
2733 whenever Exim's configuration file, or any file that is incorporated into it by
2734 means of the &%.include%& facility, is changed, and also whenever a new version
2735 of Exim is installed. It is not necessary to do this when other files that are
2736 referenced from the configuration (for example, alias files) are changed,
2737 because these are reread each time they are used.
2738
2739 .vitem &%-bdf%&
2740 .oindex "&%-bdf%&"
2741 This option has the same effect as &%-bd%& except that it never disconnects
2742 from the controlling terminal, even when no debugging is specified.
2743
2744 .vitem &%-be%&
2745 .oindex "&%-be%&"
2746 .cindex "testing" "string expansion"
2747 .cindex "expansion" "testing"
2748 Run Exim in expansion testing mode. Exim discards its root privilege, to
2749 prevent ordinary users from using this mode to read otherwise inaccessible
2750 files. If no arguments are given, Exim runs interactively, prompting for lines
2751 of data. Otherwise, it processes each argument in turn.
2752
2753 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2754 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2755 used without command line arguments. If successful, it uses the &[readline()]&
2756 function, which provides extensive line-editing facilities, for reading the
2757 test data. A line history is supported.
2758
2759 Long expansion expressions can be split over several lines by using backslash
2760 continuations. As in Exim's run time configuration, white space at the start of
2761 continuation lines is ignored. Each argument or data line is passed through the
2762 string expansion mechanism, and the result is output. Variable values from the
2763 configuration file (for example, &$qualify_domain$&) are available, but no
2764 message-specific values (such as &$sender_domain$&) are set, because no message
2765 is being processed (but see &%-bem%& and &%-Mset%&).
2766
2767 &*Note*&: If you use this mechanism to test lookups, and you change the data
2768 files or databases you are using, you must exit and restart Exim before trying
2769 the same lookup again. Otherwise, because each Exim process caches the results
2770 of lookups, you will just get the same result as before.
2771
2772 .vitem &%-bem%&&~<&'filename'&>
2773 .oindex "&%-bem%&"
2774 .cindex "testing" "string expansion"
2775 .cindex "expansion" "testing"
2776 This option operates like &%-be%& except that it must be followed by the name
2777 of a file. For example:
2778 .code
2779 exim -bem /tmp/testmessage
2780 .endd
2781 The file is read as a message (as if receiving a locally-submitted non-SMTP
2782 message) before any of the test expansions are done. Thus, message-specific
2783 variables such as &$message_size$& and &$header_from:$& are available. However,
2784 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2785 recipients are read from the headers in the normal way, and are shown in the
2786 &$recipients$& variable. Note that recipients cannot be given on the command
2787 line, because further arguments are taken as strings to expand (just like
2788 &%-be%&).
2789
2790 .vitem &%-bF%&&~<&'filename'&>
2791 .oindex "&%-bF%&"
2792 .cindex "system filter" "testing"
2793 .cindex "testing" "system filter"
2794 This option is the same as &%-bf%& except that it assumes that the filter being
2795 tested is a system filter. The additional commands that are available only in
2796 system filters are recognized.
2797
2798 .vitem &%-bf%&&~<&'filename'&>
2799 .oindex "&%-bf%&"
2800 .cindex "filter" "testing"
2801 .cindex "testing" "filter file"
2802 .cindex "forward file" "testing"
2803 .cindex "testing" "forward file"
2804 .cindex "Sieve filter" "testing"
2805 This option runs Exim in user filter testing mode; the file is the filter file
2806 to be tested, and a test message must be supplied on the standard input. If
2807 there are no message-dependent tests in the filter, an empty file can be
2808 supplied.
2809
2810 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2811 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2812 filter and a user filter in the same run. For example:
2813 .code
2814 exim -bF /system/filter -bf /user/filter </test/message
2815 .endd
2816 This is helpful when the system filter adds header lines or sets filter
2817 variables that are used by the user filter.
2818
2819 If the test filter file does not begin with one of the special lines
2820 .code
2821 # Exim filter
2822 # Sieve filter
2823 .endd
2824 it is taken to be a normal &_.forward_& file, and is tested for validity under
2825 that interpretation. See sections &<<SECTitenonfilred>>& to
2826 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2827 redirection lists.
2828
2829 The result of an Exim command that uses &%-bf%&, provided no errors are
2830 detected, is a list of the actions that Exim would try to take if presented
2831 with the message for real. More details of filter testing are given in the
2832 separate document entitled &'Exim's interfaces to mail filtering'&.
2833
2834 When testing a filter file,
2835 .cindex "&""From""& line"
2836 .cindex "envelope sender"
2837 .oindex "&%-f%&" "for filter testing"
2838 the envelope sender can be set by the &%-f%& option,
2839 or by a &"From&~"& line at the start of the test message. Various parameters
2840 that would normally be taken from the envelope recipient address of the message
2841 can be set by means of additional command line options (see the next four
2842 options).
2843
2844 .vitem &%-bfd%&&~<&'domain'&>
2845 .oindex "&%-bfd%&"
2846 .vindex "&$qualify_domain$&"
2847 This sets the domain of the recipient address when a filter file is being
2848 tested by means of the &%-bf%& option. The default is the value of
2849 &$qualify_domain$&.
2850
2851 .vitem &%-bfl%&&~<&'local&~part'&>
2852 .oindex "&%-bfl%&"
2853 This sets the local part of the recipient address when a filter file is being
2854 tested by means of the &%-bf%& option. The default is the username of the
2855 process that calls Exim. A local part should be specified with any prefix or
2856 suffix stripped, because that is how it appears to the filter when a message is
2857 actually being delivered.
2858
2859 .vitem &%-bfp%&&~<&'prefix'&>
2860 .oindex "&%-bfp%&"
2861 This sets the prefix of the local part of the recipient address when a filter
2862 file is being tested by means of the &%-bf%& option. The default is an empty
2863 prefix.
2864
2865 .vitem &%-bfs%&&~<&'suffix'&>
2866 .oindex "&%-bfs%&"
2867 This sets the suffix of the local part of the recipient address when a filter
2868 file is being tested by means of the &%-bf%& option. The default is an empty
2869 suffix.
2870
2871 .vitem &%-bh%&&~<&'IP&~address'&>
2872 .oindex "&%-bh%&"
2873 .cindex "testing" "incoming SMTP"
2874 .cindex "SMTP" "testing incoming"
2875 .cindex "testing" "relay control"
2876 .cindex "relaying" "testing configuration"
2877 .cindex "policy control" "testing"
2878 .cindex "debugging" "&%-bh%& option"
2879 This option runs a fake SMTP session as if from the given IP address, using the
2880 standard input and output. The IP address may include a port number at the end,
2881 after a full stop. For example:
2882 .code
2883 exim -bh 10.9.8.7.1234
2884 exim -bh fe80::a00:20ff:fe86:a061.5678
2885 .endd
2886 When an IPv6 address is given, it is converted into canonical form. In the case
2887 of the second example above, the value of &$sender_host_address$& after
2888 conversion to the canonical form is
2889 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2890
2891 Comments as to what is going on are written to the standard error file. These
2892 include lines beginning with &"LOG"& for anything that would have been logged.
2893 This facility is provided for testing configuration options for incoming
2894 messages, to make sure they implement the required policy. For example, you can
2895 test your relay controls using &%-bh%&.
2896
2897 &*Warning 1*&:
2898 .cindex "RFC 1413"
2899 You can test features of the configuration that rely on ident (RFC 1413)
2900 information by using the &%-oMt%& option. However, Exim cannot actually perform
2901 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2902 connection.
2903
2904 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2905 are also skipped when testing using &%-bh%&. If you want these callouts to
2906 occur, use &%-bhc%& instead.
2907
2908 Messages supplied during the testing session are discarded, and nothing is
2909 written to any of the real log files. There may be pauses when DNS (and other)
2910 lookups are taking place, and of course these may time out. The &%-oMi%& option
2911 can be used to specify a specific IP interface and port if this is important,
2912 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2913 session were authenticated.
2914
2915 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2916 output just states whether a given recipient address from a given host is
2917 acceptable or not. See section &<<SECTcheckaccess>>&.
2918
2919 Features such as authentication and encryption, where the client input is not
2920 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2921 specialized SMTP test program such as
2922 &url(http://jetmore.org/john/code/#swaks,swaks).
2923
2924 .vitem &%-bhc%&&~<&'IP&~address'&>
2925 .oindex "&%-bhc%&"
2926 This option operates in the same way as &%-bh%&, except that address
2927 verification callouts are performed if required. This includes consulting and
2928 updating the callout cache database.
2929
2930 .vitem &%-bi%&
2931 .oindex "&%-bi%&"
2932 .cindex "alias file" "building"
2933 .cindex "building alias file"
2934 .cindex "Sendmail compatibility" "&%-bi%& option"
2935 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2936 Exim does not have the concept of a single alias file, and so it cannot mimic
2937 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2938 tend to appear in various scripts such as NIS make files, so the option must be
2939 recognized.
2940
2941 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2942 configuration option is run, under the uid and gid of the caller of Exim. If
2943 the &%-oA%& option is used, its value is passed to the command as an argument.
2944 The command set by &%bi_command%& may not contain arguments. The command can
2945 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2946 if this is required. If the &%bi_command%& option is not set, calling Exim with
2947 &%-bi%& is a no-op.
2948
2949 .new
2950 . // Keep :help first, then the rest in alphabetical order
2951 .vitem &%-bI:help%&
2952 .oindex "&%-bI:help%&"
2953 .cindex "querying exim information"
2954 We shall provide various options starting &`-bI:`& for querying Exim for
2955 information.  The output of many of these will be intended for machine
2956 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2957 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2958 options shall cause Exim to exit after producing the requested output.
2959
2960 .vitem &%-bI:dscp%&
2961 .oindex "&%-bI:dscp%&"
2962 .cindex "DSCP" "values"
2963 This option causes Exim to emit an alphabetically sorted list of all
2964 recognised DSCP names.
2965
2966 .vitem &%-bI:sieve%&
2967 .oindex "&%-bI:sieve%&"
2968 .cindex "Sieve filter" "capabilities"
2969 This option causes Exim to emit an alphabetically sorted list of all supported
2970 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
2971 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
2972 &`SIEVE`& capability response line.  As the precise list may depend upon
2973 compile-time build options, which this option will adapt to, this is the only
2974 way to guarantee a correct response.
2975 .wen
2976
2977 .vitem &%-bm%&
2978 .oindex "&%-bm%&"
2979 .cindex "local message reception"
2980 This option runs an Exim receiving process that accepts an incoming,
2981 locally-generated message on the standard input. The recipients are given as the
2982 command arguments (except when &%-t%& is also present &-- see below). Each
2983 argument can be a comma-separated list of RFC 2822 addresses. This is the
2984 default option for selecting the overall action of an Exim call; it is assumed
2985 if no other conflicting option is present.
2986
2987 If any addresses in the message are unqualified (have no domain), they are
2988 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
2989 options, as appropriate. The &%-bnq%& option (see below) provides a way of
2990 suppressing this for special cases.
2991
2992 Policy checks on the contents of local messages can be enforced by means of
2993 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
2994
2995 .cindex "return code" "for &%-bm%&"
2996 The return code is zero if the message is successfully accepted. Otherwise, the
2997 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
2998
2999 The format
3000 .cindex "message" "format"
3001 .cindex "format" "message"
3002 .cindex "&""From""& line"
3003 .cindex "UUCP" "&""From""& line"
3004 .cindex "Sendmail compatibility" "&""From""& line"
3005 of the message must be as defined in RFC 2822, except that, for
3006 compatibility with Sendmail and Smail, a line in one of the forms
3007 .code
3008 From sender Fri Jan  5 12:55 GMT 1997
3009 From sender Fri, 5 Jan 97 12:55:01
3010 .endd
3011 (with the weekday optional, and possibly with additional text after the date)
3012 is permitted to appear at the start of the message. There appears to be no
3013 authoritative specification of the format of this line. Exim recognizes it by
3014 matching against the regular expression defined by the &%uucp_from_pattern%&
3015 option, which can be changed if necessary.
3016
3017 .oindex "&%-f%&" "overriding &""From""& line"
3018 The specified sender is treated as if it were given as the argument to the
3019 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3020 preference to the address taken from the message. The caller of Exim must be a
3021 trusted user for the sender of a message to be set in this way.
3022
3023 .vitem &%-bmalware%&&~<&'filename'&>
3024 .oindex "&%-bmalware%&"
3025 .cindex "testing", "malware"
3026 .cindex "malware scan test"
3027 This debugging option causes Exim to scan the given file,
3028 using the malware scanning framework.  The option of &%av_scanner%& influences
3029 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3030 the expansion should have defaults which apply to this invocation.  ACLs are
3031 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3032 will never be populated and &%-bmalware%& will fail.
3033
3034 Exim will have changed working directory before resolving the filename, so
3035 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3036 user when it tries to open the file, rather than as the invoking user.
3037 This option requires admin privileges.
3038
3039 The &%-bmalware%& option will not be extended to be more generally useful,
3040 there are better tools for file-scanning.  This option exists to help
3041 administrators verify their Exim and AV scanner configuration.
3042
3043 .vitem &%-bnq%&
3044 .oindex "&%-bnq%&"
3045 .cindex "address qualification, suppressing"
3046 By default, Exim automatically qualifies unqualified addresses (those
3047 without domains) that appear in messages that are submitted locally (that
3048 is, not over TCP/IP). This qualification applies both to addresses in
3049 envelopes, and addresses in header lines. Sender addresses are qualified using
3050 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3051 defaults to the value of &%qualify_domain%&).
3052
3053 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3054 being used to re-submit messages that originally came from remote hosts after
3055 content scanning, you probably do not want to qualify unqualified addresses in
3056 header lines. (Such lines will be present only if you have not enabled a header
3057 syntax check in the appropriate ACL.)
3058
3059 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3060 messages that originate on the local host. When this is used, unqualified
3061 addresses in the envelope provoke errors (causing message rejection) and
3062 unqualified addresses in header lines are left alone.
3063
3064
3065 .vitem &%-bP%&
3066 .oindex "&%-bP%&"
3067 .cindex "configuration options" "extracting"
3068 .cindex "options" "configuration &-- extracting"
3069 If this option is given with no arguments, it causes the values of all Exim's
3070 main configuration options to be written to the standard output. The values
3071 of one or more specific options can be requested by giving their names as
3072 arguments, for example:
3073 .code
3074 exim -bP qualify_domain hold_domains
3075 .endd
3076 .cindex "hiding configuration option values"
3077 .cindex "configuration options" "hiding value of"
3078 .cindex "options" "hiding value of"
3079 However, any option setting that is preceded by the word &"hide"& in the
3080 configuration file is not shown in full, except to an admin user. For other
3081 users, the output is as in this example:
3082 .code
3083 mysql_servers = <value not displayable>
3084 .endd
3085 If &%configure_file%& is given as an argument, the name of the run time
3086 configuration file is output.
3087 If a list of configuration files was supplied, the value that is output here
3088 is the name of the file that was actually used.
3089
3090 .new
3091 .cindex "options" "hiding name of"
3092 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3093 name will not be output.
3094 .wen
3095
3096 .cindex "daemon" "process id (pid)"
3097 .cindex "pid (process id)" "of daemon"
3098 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3099 directories where log files and daemon pid files are written are output,
3100 respectively. If these values are unset, log files are written in a
3101 sub-directory of the spool directory called &%log%&, and the pid file is
3102 written directly into the spool directory.
3103
3104 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3105 .code
3106 exim -bP +local_domains
3107 .endd
3108 it searches for a matching named list of any type (domain, host, address, or
3109 local part) and outputs what it finds.
3110
3111 .cindex "options" "router &-- extracting"
3112 .cindex "options" "transport &-- extracting"
3113 .cindex "options" "authenticator &-- extracting"
3114 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3115 followed by the name of an appropriate driver instance, the option settings for
3116 that driver are output. For example:
3117 .code
3118 exim -bP transport local_delivery
3119 .endd
3120 The generic driver options are output first, followed by the driver's private
3121 options. A list of the names of drivers of a particular type can be obtained by
3122 using one of the words &%router_list%&, &%transport_list%&, or
3123 &%authenticator_list%&, and a complete list of all drivers with their option
3124 settings can be obtained by using &%routers%&, &%transports%&, or
3125 &%authenticators%&.
3126
3127 .cindex "options" "macro &-- extracting"
3128 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3129 are available, similarly to the drivers.  Because macros are sometimes used
3130 for storing passwords, this option is restricted.
3131 The output format is one item per line.
3132
3133 .vitem &%-bp%&
3134 .oindex "&%-bp%&"
3135 .cindex "queue" "listing messages on"
3136 .cindex "listing" "messages on the queue"
3137 This option requests a listing of the contents of the mail queue on the
3138 standard output. If the &%-bp%& option is followed by a list of message ids,
3139 just those messages are listed. By default, this option can be used only by an
3140 admin user. However, the &%queue_list_requires_admin%& option can be set false
3141 to allow any user to see the queue.
3142
3143 Each message on the queue is displayed as in the following example:
3144 .code
3145 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3146           red.king@looking-glass.fict.example
3147           <other addresses>
3148 .endd
3149 .cindex "message" "size in queue listing"
3150 .cindex "size" "of message"
3151 The first line contains the length of time the message has been on the queue
3152 (in this case 25 minutes), the size of the message (2.9K), the unique local
3153 identifier for the message, and the message sender, as contained in the
3154 envelope. For bounce messages, the sender address is empty, and appears as
3155 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3156 the default sender address, the user's login name is shown in parentheses
3157 before the sender address.
3158
3159 .cindex "frozen messages" "in queue listing"
3160 If the message is frozen (attempts to deliver it are suspended) then the text
3161 &"*** frozen ***"& is displayed at the end of this line.
3162
3163 The recipients of the message (taken from the envelope, not the headers) are
3164 displayed on subsequent lines. Those addresses to which the message has already
3165 been delivered are marked with the letter D. If an original address gets
3166 expanded into several addresses via an alias or forward file, the original is
3167 displayed with a D only when deliveries for all of its child addresses are
3168 complete.
3169
3170
3171 .vitem &%-bpa%&
3172 .oindex "&%-bpa%&"
3173 This option operates like &%-bp%&, but in addition it shows delivered addresses
3174 that were generated from the original top level address(es) in each message by
3175 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3176 of just &"D"&.
3177
3178
3179 .vitem &%-bpc%&
3180 .oindex "&%-bpc%&"
3181 .cindex "queue" "count of messages on"
3182 This option counts the number of messages on the queue, and writes the total
3183 to the standard output. It is restricted to admin users, unless
3184 &%queue_list_requires_admin%& is set false.
3185
3186
3187 .vitem &%-bpr%&
3188 .oindex "&%-bpr%&"
3189 This option operates like &%-bp%&, but the output is not sorted into
3190 chronological order of message arrival. This can speed it up when there are
3191 lots of messages on the queue, and is particularly useful if the output is
3192 going to be post-processed in a way that doesn't need the sorting.
3193
3194 .vitem &%-bpra%&
3195 .oindex "&%-bpra%&"
3196 This option is a combination of &%-bpr%& and &%-bpa%&.
3197
3198 .vitem &%-bpru%&
3199 .oindex "&%-bpru%&"
3200 This option is a combination of &%-bpr%& and &%-bpu%&.
3201
3202
3203 .vitem &%-bpu%&
3204 .oindex "&%-bpu%&"
3205 This option operates like &%-bp%& but shows only undelivered top-level
3206 addresses for each message displayed. Addresses generated by aliasing or
3207 forwarding are not shown, unless the message was deferred after processing by a
3208 router with the &%one_time%& option set.
3209
3210
3211 .vitem &%-brt%&
3212 .oindex "&%-brt%&"
3213 .cindex "testing" "retry configuration"
3214 .cindex "retry" "configuration testing"
3215 This option is for testing retry rules, and it must be followed by up to three
3216 arguments. It causes Exim to look for a retry rule that matches the values
3217 and to write it to the standard output. For example:
3218 .code
3219 exim -brt bach.comp.mus.example
3220 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3221 .endd
3222 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3223 argument, which is required, can be a complete address in the form
3224 &'local_part@domain'&, or it can be just a domain name. If the second argument
3225 contains a dot, it is interpreted as an optional second domain name; if no
3226 retry rule is found for the first argument, the second is tried. This ties in
3227 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3228 rule is found that matches the host, one that matches the mail domain is
3229 sought. Finally, an argument that is the name of a specific delivery error, as
3230 used in setting up retry rules, can be given. For example:
3231 .code
3232 exim -brt haydn.comp.mus.example quota_3d
3233 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3234 .endd
3235
3236 .vitem &%-brw%&
3237 .oindex "&%-brw%&"
3238 .cindex "testing" "rewriting"
3239 .cindex "rewriting" "testing"
3240 This option is for testing address rewriting rules, and it must be followed by
3241 a single argument, consisting of either a local part without a domain, or a
3242 complete address with a fully qualified domain. Exim outputs how this address
3243 would be rewritten for each possible place it might appear. See chapter
3244 &<<CHAPrewrite>>& for further details.
3245
3246 .vitem &%-bS%&
3247 .oindex "&%-bS%&"
3248 .cindex "SMTP" "batched incoming"
3249 .cindex "batched SMTP input"
3250 This option is used for batched SMTP input, which is an alternative interface
3251 for non-interactive local message submission. A number of messages can be
3252 submitted in a single run. However, despite its name, this is not really SMTP
3253 input. Exim reads each message's envelope from SMTP commands on the standard
3254 input, but generates no responses. If the caller is trusted, or
3255 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3256 believed; otherwise the sender is always the caller of Exim.
3257
3258 The message itself is read from the standard input, in SMTP format (leading
3259 dots doubled), terminated by a line containing just a single dot. An error is
3260 provoked if the terminating dot is missing. A further message may then follow.
3261
3262 As for other local message submissions, the contents of incoming batch SMTP
3263 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3264 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3265 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3266
3267 Some other SMTP commands are recognized in the input. HELO and EHLO act
3268 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3269 QUIT quits, ignoring the rest of the standard input.
3270
3271 .cindex "return code" "for &%-bS%&"
3272 If any error is encountered, reports are written to the standard output and
3273 error streams, and Exim gives up immediately. The return code is 0 if no error
3274 was detected; it is 1 if one or more messages were accepted before the error
3275 was detected; otherwise it is 2.
3276
3277 More details of input using batched SMTP are given in section
3278 &<<SECTincomingbatchedSMTP>>&.
3279
3280 .vitem &%-bs%&
3281 .oindex "&%-bs%&"
3282 .cindex "SMTP" "local input"
3283 .cindex "local SMTP input"
3284 This option causes Exim to accept one or more messages by reading SMTP commands
3285 on the standard input, and producing SMTP replies on the standard output. SMTP
3286 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3287 Some user agents use this interface as a way of passing locally-generated
3288 messages to the MTA.
3289
3290 In
3291 .cindex "sender" "source of"
3292 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3293 set, the senders of messages are taken from the SMTP MAIL commands.
3294 Otherwise the content of these commands is ignored and the sender is set up as
3295 the calling user. Unqualified addresses are automatically qualified using
3296 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3297 &%-bnq%& option is used.
3298
3299 .cindex "inetd"
3300 The
3301 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3302 using a listening daemon. Exim can distinguish the two cases by checking
3303 whether the standard input is a TCP/IP socket. When Exim is called from
3304 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3305 above concerning senders and qualification do not apply. In this situation,
3306 Exim behaves in exactly the same way as it does when receiving a message via
3307 the listening daemon.
3308
3309 .vitem &%-bt%&
3310 .oindex "&%-bt%&"
3311 .cindex "testing" "addresses"
3312 .cindex "address" "testing"
3313 This option runs Exim in address testing mode, in which each argument is taken
3314 as a recipient address to be tested for deliverability. The results are
3315 written to the standard output. If a test fails, and the caller is not an admin
3316 user, no details of the failure are output, because these might contain
3317 sensitive information such as 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 tested.
3321
3322 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3323 &[readline()]& function, because it is running as &'root'& and there are
3324 security issues.
3325
3326 Each address is handled as if it were the recipient address of a message
3327 (compare the &%-bv%& option). It is passed to the routers and the result is
3328 written to the standard output. However, any router that has
3329 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3330 genuine routing tests if your first router passes everything to a scanner
3331 program.
3332
3333 .cindex "return code" "for &%-bt%&"
3334 The return code is 2 if any address failed outright; it is 1 if no address
3335 failed outright but at least one could not be resolved for some reason. Return
3336 code 0 is given only when all addresses succeed.
3337
3338 .cindex "duplicate addresses"
3339 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3340 addresses after routing is complete, so that only one delivery takes place.
3341 This does not happen when testing with &%-bt%&; the full results of routing are
3342 always shown.
3343
3344 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3345 routers in the configuration makes any tests on the sender address of a
3346 message,
3347 .oindex "&%-f%&" "for address testing"
3348 you can use the &%-f%& option to set an appropriate sender when running
3349 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3350 default qualifying domain. However, if you have set up (for example) routers
3351 whose behaviour depends on the contents of an incoming message, you cannot test
3352 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3353 doing such tests.
3354
3355 .vitem &%-bV%&
3356 .oindex "&%-bV%&"
3357 .cindex "version number of Exim"
3358 This option causes Exim to write the current version number, compilation
3359 number, and compilation date of the &'exim'& binary to the standard output.
3360 It also lists the DBM library that is being used, the optional modules (such as
3361 specific lookup types), the drivers that are included in the binary, and the
3362 name of the run time configuration file that is in use.
3363
3364 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3365 configuration file. However, this is a static check only. It cannot check
3366 values that are to be expanded. For example, although a misspelt ACL verb is
3367 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3368 alone to discover (for example) all the typos in the configuration; some
3369 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3370 dynamic testing facilities.
3371
3372 .vitem &%-bv%&
3373 .oindex "&%-bv%&"
3374 .cindex "verifying address" "using &%-bv%&"
3375 .cindex "address" "verification"
3376 This option runs Exim in address verification mode, in which each argument is
3377 taken as a recipient address to be verified by the routers. (This does
3378 not involve any verification callouts). During normal operation, verification
3379 happens mostly as a consequence processing a &%verify%& condition in an ACL
3380 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3381 including callouts, see the &%-bh%& and &%-bhc%& options.
3382
3383 If verification fails, and the caller is not an admin user, no details of the
3384 failure are output, because these might contain sensitive information such as
3385 usernames and passwords for database lookups.
3386
3387 If no arguments are given, Exim runs in an interactive manner, prompting with a
3388 right angle bracket for addresses to be verified.
3389
3390 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3391 &[readline()]& function, because it is running as &'exim'& and there are
3392 security issues.
3393
3394 Verification differs from address testing (the &%-bt%& option) in that routers
3395 that have &%no_verify%& set are skipped, and if the address is accepted by a
3396 router that has &%fail_verify%& set, verification fails. The address is
3397 verified as a recipient if &%-bv%& is used; to test verification for a sender
3398 address, &%-bvs%& should be used.
3399
3400 If the &%-v%& option is not set, the output consists of a single line for each
3401 address, stating whether it was verified or not, and giving a reason in the
3402 latter case. Without &%-v%&, generating more than one address by redirection
3403 causes verification to end successfully, without considering the generated
3404 addresses. However, if just one address is generated, processing continues,
3405 and the generated address must verify successfully for the overall verification
3406 to succeed.
3407
3408 When &%-v%& is set, more details are given of how the address has been handled,
3409 and in the case of address redirection, all the generated addresses are also
3410 considered. Verification may succeed for some and fail for others.
3411
3412 The
3413 .cindex "return code" "for &%-bv%&"
3414 return code is 2 if any address failed outright; it is 1 if no address
3415 failed outright but at least one could not be resolved for some reason. Return
3416 code 0 is given only when all addresses succeed.
3417
3418 If any of the routers in the configuration makes any tests on the sender
3419 address of a message, you should use the &%-f%& option to set an appropriate
3420 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3421 calling user at the default qualifying domain.
3422
3423 .vitem &%-bvs%&
3424 .oindex "&%-bvs%&"
3425 This option acts like &%-bv%&, but verifies the address as a sender rather
3426 than a recipient address. This affects any rewriting and qualification that
3427 might happen.
3428
3429 .vitem &%-bw%&
3430 .oindex "&%-bw%&"
3431 .cindex "daemon"
3432 .cindex "inetd"
3433 .cindex "inetd" "wait mode"
3434 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3435 similarly to the &%-bd%& option.  All port specifications on the command-line
3436 and in the configuration file are ignored.  Queue-running may not be specified.
3437
3438 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3439 listening for connections.  This permits the system to start up and have
3440 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3441 each port only when the first connection is received.
3442
3443 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3444 which the daemon will exit, which should cause inetd to listen once more.
3445
3446 .vitem &%-C%&&~<&'filelist'&>
3447 .oindex "&%-C%&"
3448 .cindex "configuration file" "alternate"
3449 .cindex "CONFIGURE_FILE"
3450 .cindex "alternate configuration file"
3451 This option causes Exim to find the run time configuration file from the given
3452 list instead of from the list specified by the CONFIGURE_FILE
3453 compile-time setting. Usually, the list will consist of just a single file
3454 name, but it can be a colon-separated list of names. In this case, the first
3455 file that exists is used. Failure to open an existing file stops Exim from
3456 proceeding any further along the list, and an error is generated.
3457
3458 When this option is used by a caller other than root, and the list is different
3459 from the compiled-in list, Exim gives up its root privilege immediately, and
3460 runs with the real and effective uid and gid set to those of the caller.
3461 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3462 file contains a list of full pathnames, one per line, for configuration files
3463 which are trusted. Root privilege is retained for any configuration file so
3464 listed, as long as the caller is the Exim user (or the user specified in the
3465 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3466 not writeable by inappropriate users or groups.
3467
3468 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3469 configuration using &%-C%& right through message reception and delivery,
3470 even if the caller is root. The reception works, but by that time, Exim is
3471 running as the Exim user, so when it re-executes to regain privilege for the
3472 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3473 test reception and delivery using two separate commands (one to put a message
3474 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3475
3476 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3477 prefix string with which any file named in a &%-C%& command line option
3478 must start. In addition, the file name must not contain the sequence &`/../`&.
3479 However, if the value of the &%-C%& option is identical to the value of
3480 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3481 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3482 unset, any file name can be used with &%-C%&.
3483
3484 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3485 to a directory to which only root has access. This prevents someone who has
3486 broken into the Exim account from running a privileged Exim with an arbitrary
3487 configuration file.
3488
3489 The &%-C%& facility is useful for ensuring that configuration files are
3490 syntactically correct, but cannot be used for test deliveries, unless the
3491 caller is privileged, or unless it is an exotic configuration that does not
3492 require privilege. No check is made on the owner or group of the files
3493 specified by this option.
3494
3495
3496 .vitem &%-D%&<&'macro'&>=<&'value'&>
3497 .oindex "&%-D%&"
3498 .cindex "macro" "setting on command line"
3499 This option can be used to override macro definitions in the configuration file
3500 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3501 unprivileged caller, it causes Exim to give up its root privilege.
3502 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3503 completely disabled, and its use causes an immediate error exit.
3504
3505 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3506 colon-separated list of macros which are considered safe and, if &%-D%& only
3507 supplies macros from this list, and the values are acceptable, then Exim will
3508 not give up root privilege if the caller is root, the Exim run-time user, or
3509 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3510 to be removed in the future.  Acceptable values for the macros satisfy the
3511 regexp: &`^[A-Za-z0-9_/.-]*$`&
3512
3513 The entire option (including equals sign if present) must all be within one
3514 command line item. &%-D%& can be used to set the value of a macro to the empty
3515 string, in which case the equals sign is optional. These two commands are
3516 synonymous:
3517 .code
3518 exim -DABC  ...
3519 exim -DABC= ...
3520 .endd
3521 To include spaces in a macro definition item, quotes must be used. If you use
3522 quotes, spaces are permitted around the macro name and the equals sign. For
3523 example:
3524 .code
3525 exim '-D ABC = something' ...
3526 .endd
3527 &%-D%& may be repeated up to 10 times on a command line.
3528
3529
3530 .vitem &%-d%&<&'debug&~options'&>
3531 .oindex "&%-d%&"
3532 .cindex "debugging" "list of selectors"
3533 .cindex "debugging" "&%-d%& option"
3534 This option causes debugging information to be written to the standard
3535 error stream. It is restricted to admin users because debugging output may show
3536 database queries that contain password information. Also, the details of users'
3537 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3538 writes an error message to the standard error stream and exits with a non-zero
3539 return code.
3540
3541 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3542 standard debugging data is output. This can be reduced, or increased to include
3543 some more rarely needed information, by directly following &%-d%& with a string
3544 made up of names preceded by plus or minus characters. These add or remove sets
3545 of debugging data, respectively. For example, &%-d+filter%& adds filter
3546 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3547 no spaces are allowed in the debug setting. The available debugging categories
3548 are:
3549 .display
3550 &`acl            `& ACL interpretation
3551 &`auth           `& authenticators
3552 &`deliver        `& general delivery logic
3553 &`dns            `& DNS lookups (see also resolver)
3554 &`dnsbl          `& DNS black list (aka RBL) code
3555 &`exec           `& arguments for &[execv()]& calls
3556 &`expand         `& detailed debugging for string expansions
3557 &`filter         `& filter handling
3558 &`hints_lookup   `& hints data lookups
3559 &`host_lookup    `& all types of name-to-IP address handling
3560 &`ident          `& ident lookup
3561 &`interface      `& lists of local interfaces
3562 &`lists          `& matching things in lists
3563 &`load           `& system load checks
3564 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3565                     &<<CHAPlocalscan>>&)
3566 &`lookup         `& general lookup code and all lookups
3567 &`memory         `& memory handling
3568 &`pid            `& add pid to debug output lines
3569 &`process_info   `& setting info for the process log
3570 &`queue_run      `& queue runs
3571 &`receive        `& general message reception logic
3572 &`resolver       `& turn on the DNS resolver's debugging output
3573 &`retry          `& retry handling
3574 &`rewrite        `& address rewriting
3575 &`route          `& address routing
3576 &`timestamp      `& add timestamp to debug output lines
3577 &`tls            `& TLS logic
3578 &`transport      `& transports
3579 &`uid            `& changes of uid/gid and looking up uid/gid
3580 &`verify         `& address verification logic
3581 &`all            `& almost all of the above (see below), and also &%-v%&
3582 .endd
3583 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3584 for &`-all`&. The reason for this is that &`+all`& is something that people
3585 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3586 is included, an awful lot of output that is very rarely of interest is
3587 generated, so it now has to be explicitly requested. However, &`-all`& does
3588 turn everything off.
3589
3590 .cindex "resolver, debugging output"
3591 .cindex "DNS resolver, debugging output"
3592 The &`resolver`& option produces output only if the DNS resolver was compiled
3593 with DEBUG enabled. This is not the case in some operating systems. Also,
3594 unfortunately, debugging output from the DNS resolver is written to stdout
3595 rather than stderr.
3596
3597 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3598 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3599 However, the &`pid`& selector is forced when debugging is turned on for a
3600 daemon, which then passes it on to any re-executed Exims. Exim also
3601 automatically adds the pid to debug lines when several remote deliveries are
3602 run in parallel.
3603
3604 The &`timestamp`& selector causes the current time to be inserted at the start
3605 of all debug output lines. This can be useful when trying to track down delays
3606 in processing.
3607
3608 If the &%debug_print%& option is set in any driver, it produces output whenever
3609 any debugging is selected, or if &%-v%& is used.
3610
3611 .vitem &%-dd%&<&'debug&~options'&>
3612 .oindex "&%-dd%&"
3613 This option behaves exactly like &%-d%& except when used on a command that
3614 starts a daemon process. In that case, debugging is turned off for the
3615 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3616 behaviour of the daemon without creating as much output as full debugging does.
3617
3618 .vitem &%-dropcr%&
3619 .oindex "&%-dropcr%&"
3620 This is an obsolete option that is now a no-op. It used to affect the way Exim
3621 handled CR and LF characters in incoming messages. What happens now is
3622 described in section &<<SECTlineendings>>&.
3623
3624 .vitem &%-E%&
3625 .oindex "&%-E%&"
3626 .cindex "bounce message" "generating"
3627 This option specifies that an incoming message is a locally-generated delivery
3628 failure report. It is used internally by Exim when handling delivery failures
3629 and is not intended for external use. Its only effect is to stop Exim
3630 generating certain messages to the postmaster, as otherwise message cascades
3631 could occur in some situations. As part of the same option, a message id may
3632 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3633 new message contains the id, following &"R="&, as a cross-reference.
3634
3635 .vitem &%-e%&&'x'&
3636 .oindex "&%-e%&&'x'&"
3637 There are a number of Sendmail options starting with &%-oe%& which seem to be
3638 called by various programs without the leading &%o%& in the option. For
3639 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3640 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3641
3642 .vitem &%-F%&&~<&'string'&>
3643 .oindex "&%-F%&"
3644 .cindex "sender" "name"
3645 .cindex "name" "of sender"
3646 This option sets the sender's full name for use when a locally-generated
3647 message is being accepted. In the absence of this option, the user's &'gecos'&
3648 entry from the password data is used. As users are generally permitted to alter
3649 their &'gecos'& entries, no security considerations are involved. White space
3650 between &%-F%& and the <&'string'&> is optional.
3651
3652 .vitem &%-f%&&~<&'address'&>
3653 .oindex "&%-f%&"
3654 .cindex "sender" "address"
3655 .cindex "address" "sender"
3656 .cindex "trusted users"
3657 .cindex "envelope sender"
3658 .cindex "user" "trusted"
3659 This option sets the address of the envelope sender of a locally-generated
3660 message (also known as the return path). The option can normally be used only
3661 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3662 users to use it.
3663
3664 Processes running as root or the Exim user are always trusted. Other
3665 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3666 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3667 of a local message is set to the caller's login name at the default qualify
3668 domain.
3669
3670 There is one exception to the restriction on the use of &%-f%&: an empty sender
3671 can be specified by any user, trusted or not, to create a message that can
3672 never provoke a bounce. An empty sender can be specified either as an empty
3673 string, or as a pair of angle brackets with nothing between them, as in these
3674 examples of shell commands:
3675 .code
3676 exim -f '<>' user@domain
3677 exim -f "" user@domain
3678 .endd
3679 In addition, the use of &%-f%& is not restricted when testing a filter file
3680 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3681 &%-bv%& options.
3682
3683 Allowing untrusted users to change the sender address does not of itself make
3684 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3685 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3686 though this can be overridden by setting &%no_local_from_check%&.
3687
3688 White
3689 .cindex "&""From""& line"
3690 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3691 given as two arguments or one combined argument). The sender of a
3692 locally-generated message can also be set (when permitted) by an initial
3693 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3694 if &%-f%& is also present, it overrides &"From&~"&.
3695
3696 .vitem &%-G%&
3697 .oindex "&%-G%&"
3698 .cindex "submission fixups, suppressing (command-line)"
3699 .new
3700 This option is equivalent to an ACL applying:
3701 .code
3702 control = suppress_local_fixups
3703 .endd
3704 for every message received.  Note that Sendmail will complain about such
3705 bad formatting, where Exim silently just does not fix it up.  This may change
3706 in future.
3707
3708 As this affects audit information, the caller must be a trusted user to use
3709 this option.
3710 .wen
3711
3712 .vitem &%-h%&&~<&'number'&>
3713 .oindex "&%-h%&"
3714 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3715 This option is accepted for compatibility with Sendmail, but has no effect. (In
3716 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3717 headers.)
3718
3719 .vitem &%-i%&
3720 .oindex "&%-i%&"
3721 .cindex "Solaris" "&'mail'& command"
3722 .cindex "dot" "in incoming non-SMTP message"
3723 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3724 line by itself should not terminate an incoming, non-SMTP message. I can find
3725 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3726 command in Solaris 2.4 uses it. See also &%-ti%&.
3727
3728 .new
3729 .vitem &%-L%&&~<&'tag'&>
3730 .oindex "&%-L%&"
3731 .cindex "syslog" "process name; set with flag"
3732 This option is equivalent to setting &%syslog_processname%& in the config
3733 file and setting &%log_file_path%& to &`syslog`&.
3734 Its use is restricted to administrators.  The configuration file has to be
3735 read and parsed, to determine access rights, before this is set and takes
3736 effect, so early configuration file errors will not honour this flag.
3737
3738 The tag should not be longer than 32 characters.
3739 .wen
3740
3741 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3742 .oindex "&%-M%&"
3743 .cindex "forcing delivery"
3744 .cindex "delivery" "forcing attempt"
3745 .cindex "frozen messages" "forcing delivery"
3746 This option requests Exim to run a delivery attempt on each message in turn. If
3747 any of the messages are frozen, they are automatically thawed before the
3748 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3749 and &%hold_domains%& are ignored.
3750
3751 Retry
3752 .cindex "hints database" "overriding retry hints"
3753 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3754 the normal retry time has not yet been reached. This option requires the caller
3755 to be an admin user. However, there is an option called &%prod_requires_admin%&
3756 which can be set false to relax this restriction (and also the same requirement
3757 for the &%-q%&, &%-R%&, and &%-S%& options).
3758
3759 The deliveries happen synchronously, that is, the original Exim process does
3760 not terminate until all the delivery attempts have finished. No output is
3761 produced unless there is a serious error. If you want to see what is happening,
3762 use the &%-v%& option as well, or inspect Exim's main log.
3763
3764 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3765 .oindex "&%-Mar%&"
3766 .cindex "message" "adding recipients"
3767 .cindex "recipient" "adding"
3768 This option requests Exim to add the addresses to the list of recipients of the
3769 message (&"ar"& for &"add recipients"&). The first argument must be a message
3770 id, and the remaining ones must be email addresses. However, if the message is
3771 active (in the middle of a delivery attempt), it is not altered. This option
3772 can be used only by an admin user.
3773
3774 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3775         &~<&'message&~id'&>"
3776 .oindex "&%-MC%&"
3777 .cindex "SMTP" "passed connection"
3778 .cindex "SMTP" "multiple deliveries"
3779 .cindex "multiple SMTP deliveries"
3780 This option is not intended for use by external callers. It is used internally
3781 by Exim to invoke another instance of itself to deliver a waiting message using
3782 an existing SMTP connection, which is passed as the standard input. Details are
3783 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3784 must be root or the Exim user in order to use it.
3785
3786 .vitem &%-MCA%&
3787 .oindex "&%-MCA%&"
3788 This option is not intended for use by external callers. It is used internally
3789 by Exim in conjunction with the &%-MC%& option. It signifies that the
3790 connection to the remote host has been authenticated.
3791
3792 .vitem &%-MCP%&
3793 .oindex "&%-MCP%&"
3794 This option is not intended for use by external callers. It is used internally
3795 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3796 which Exim is connected supports pipelining.
3797
3798 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3799 .oindex "&%-MCQ%&"
3800 This option is not intended for use by external callers. It is used internally
3801 by Exim in conjunction with the &%-MC%& option when the original delivery was
3802 started by a queue runner. It passes on the process id of the queue runner,
3803 together with the file descriptor number of an open pipe. Closure of the pipe
3804 signals the final completion of the sequence of processes that are passing
3805 messages through the same SMTP connection.
3806
3807 .vitem &%-MCS%&
3808 .oindex "&%-MCS%&"
3809 This option is not intended for use by external callers. It is used internally
3810 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3811 SMTP SIZE option should be used on messages delivered down the existing
3812 connection.
3813
3814 .vitem &%-MCT%&
3815 .oindex "&%-MCT%&"
3816 This option is not intended for use by external callers. It is used internally
3817 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3818 host to which Exim is connected supports TLS encryption.
3819
3820 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3821 .oindex "&%-Mc%&"
3822 .cindex "hints database" "not overridden by &%-Mc%&"
3823 .cindex "delivery" "manually started &-- not forced"
3824 This option requests Exim to run a delivery attempt on each message in turn,
3825 but unlike the &%-M%& option, it does check for retry hints, and respects any
3826 that are found. This option is not very useful to external callers. It is
3827 provided mainly for internal use by Exim when it needs to re-invoke itself in
3828 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3829 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3830 respects retry times and other options such as &%hold_domains%& that are
3831 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3832 If you want to run a specific delivery as if in a queue run, you should use
3833 &%-q%& with a message id argument. A distinction between queue run deliveries
3834 and other deliveries is made in one or two places.
3835
3836 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3837 .oindex "&%-Mes%&"
3838 .cindex "message" "changing sender"
3839 .cindex "sender" "changing"
3840 This option requests Exim to change the sender address in the message to the
3841 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3842 &"edit sender"&). There must be exactly two arguments. The first argument must
3843 be a message id, and the second one an email address. However, if the message
3844 is active (in the middle of a delivery attempt), its status is not altered.
3845 This option can be used only by an admin user.
3846
3847 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3848 .oindex "&%-Mf%&"
3849 .cindex "freezing messages"
3850 .cindex "message" "manually freezing"
3851 This option requests Exim to mark each listed message as &"frozen"&. This
3852 prevents any delivery attempts taking place until the message is &"thawed"&,
3853 either manually or as a result of the &%auto_thaw%& configuration option.
3854 However, if any of the messages are active (in the middle of a delivery
3855 attempt), their status is not altered. This option can be used only by an admin
3856 user.
3857
3858 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3859 .oindex "&%-Mg%&"
3860 .cindex "giving up on messages"
3861 .cindex "message" "abandoning delivery attempts"
3862 .cindex "delivery" "abandoning further attempts"
3863 This option requests Exim to give up trying to deliver the listed messages,
3864 including any that are frozen. However, if any of the messages are active,
3865 their status is not altered. For non-bounce messages, a delivery error message
3866 is sent to the sender, containing the text &"cancelled by administrator"&.
3867 Bounce messages are just discarded. This option can be used only by an admin
3868 user.
3869
3870 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3871 .oindex "&%-Mmad%&"
3872 .cindex "delivery" "cancelling all"
3873 This option requests Exim to mark all the recipient addresses in the messages
3874 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3875 message is active (in the middle of a delivery attempt), its status is not
3876 altered. This option can be used only by an admin user.
3877
3878 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3879 .oindex "&%-Mmd%&"
3880 .cindex "delivery" "cancelling by address"
3881 .cindex "recipient" "removing"
3882 .cindex "removing recipients"
3883 This option requests Exim to mark the given addresses as already delivered
3884 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3885 the remaining ones must be email addresses. These are matched to recipient
3886 addresses in the message in a case-sensitive manner. If the message is active
3887 (in the middle of a delivery attempt), its status is not altered. This option
3888 can be used only by an admin user.
3889
3890 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3891 .oindex "&%-Mrm%&"
3892 .cindex "removing messages"
3893 .cindex "abandoning mail"
3894 .cindex "message" "manually discarding"
3895 This option requests Exim to remove the given messages from the queue. No
3896 bounce messages are sent; each message is simply forgotten. However, if any of
3897 the messages are active, their status is not altered. This option can be used
3898 only by an admin user or by the user who originally caused the message to be
3899 placed on the queue.
3900
3901 .vitem &%-Mset%&&~<&'message&~id'&>
3902 .oindex "&%-Mset%&
3903 .cindex "testing" "string expansion"
3904 .cindex "expansion" "testing"
3905 This option is useful only in conjunction with &%-be%& (that is, when testing
3906 string expansions). Exim loads the given message from its spool before doing
3907 the test expansions, thus setting message-specific variables such as
3908 &$message_size$& and the header variables. The &$recipients$& variable is made
3909 available. This feature is provided to make it easier to test expansions that
3910 make use of these variables. However, this option can be used only by an admin
3911 user. See also &%-bem%&.
3912
3913 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3914 .oindex "&%-Mt%&"
3915 .cindex "thawing messages"
3916 .cindex "unfreezing messages"
3917 .cindex "frozen messages" "thawing"
3918 .cindex "message" "thawing frozen"
3919 This option requests Exim to &"thaw"& any of the listed messages that are
3920 &"frozen"&, so that delivery attempts can resume. However, if any of the
3921 messages are active, their status is not altered. This option can be used only
3922 by an admin user.
3923
3924 .vitem &%-Mvb%&&~<&'message&~id'&>
3925 .oindex "&%-Mvb%&"
3926 .cindex "listing" "message body"
3927 .cindex "message" "listing body of"
3928 This option causes the contents of the message body (-D) spool file to be
3929 written to the standard output. This option can be used only by an admin user.
3930
3931 .vitem &%-Mvc%&&~<&'message&~id'&>
3932 .oindex "&%-Mvc%&"
3933 .cindex "message" "listing in RFC 2822 format"
3934 .cindex "listing" "message in RFC 2822 format"
3935 This option causes a copy of the complete message (header lines plus body) to
3936 be written to the standard output in RFC 2822 format. This option can be used
3937 only by an admin user.
3938
3939 .vitem &%-Mvh%&&~<&'message&~id'&>
3940 .oindex "&%-Mvh%&"
3941 .cindex "listing" "message headers"
3942 .cindex "header lines" "listing"
3943 .cindex "message" "listing header lines"
3944 This option causes the contents of the message headers (-H) spool file to be
3945 written to the standard output. This option can be used only by an admin user.
3946
3947 .vitem &%-Mvl%&&~<&'message&~id'&>
3948 .oindex "&%-Mvl%&"
3949 .cindex "listing" "message log"
3950 .cindex "message" "listing message log"
3951 This option causes the contents of the message log spool file to be written to
3952 the standard output. This option can be used only by an admin user.
3953
3954 .vitem &%-m%&
3955 .oindex "&%-m%&"
3956 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3957 treats it that way too.
3958
3959 .vitem &%-N%&
3960 .oindex "&%-N%&"
3961 .cindex "debugging" "&%-N%& option"
3962 .cindex "debugging" "suppressing delivery"
3963 This is a debugging option that inhibits delivery of a message at the transport
3964 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3965 it just doesn't actually transport the message, but instead behaves as if it
3966 had successfully done so. However, it does not make any updates to the retry
3967 database, and the log entries for deliveries are flagged with &"*>"& rather
3968 than &"=>"&.
3969
3970 Because &%-N%& discards any message to which it applies, only root or the Exim
3971 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3972 words, an ordinary user can use it only when supplying an incoming message to
3973 which it will apply. Although transportation never fails when &%-N%& is set, an
3974 address may be deferred because of a configuration problem on a transport, or a
3975 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3976 the message, and applies to any subsequent delivery attempts that may happen
3977 for that message.
3978
3979 .vitem &%-n%&
3980 .oindex "&%-n%&"
3981 This option is interpreted by Sendmail to mean &"no aliasing"&.
3982 For normal modes of operation, it is ignored by Exim.
3983 When combined with &%-bP%& it suppresses the name of an option from being output.
3984
3985 .vitem &%-O%&&~<&'data'&>
3986 .oindex "&%-O%&"
3987 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
3988 Exim.
3989
3990 .vitem &%-oA%&&~<&'file&~name'&>
3991 .oindex "&%-oA%&"
3992 .cindex "Sendmail compatibility" "&%-oA%& option"
3993 This option is used by Sendmail in conjunction with &%-bi%& to specify an
3994 alternative alias file name. Exim handles &%-bi%& differently; see the
3995 description above.
3996
3997 .vitem &%-oB%&&~<&'n'&>
3998 .oindex "&%-oB%&"
3999 .cindex "SMTP" "passed connection"
4000 .cindex "SMTP" "multiple deliveries"
4001 .cindex "multiple SMTP deliveries"
4002 This is a debugging option which limits the maximum number of messages that can
4003 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4004 transport. If <&'n'&> is omitted, the limit is set to 1.
4005
4006 .vitem &%-odb%&
4007 .oindex "&%-odb%&"
4008 .cindex "background delivery"
4009 .cindex "delivery" "in the background"
4010 This option applies to all modes in which Exim accepts incoming messages,
4011 including the listening daemon. It requests &"background"& delivery of such
4012 messages, which means that the accepting process automatically starts a
4013 delivery process for each message received, but does not wait for the delivery
4014 processes to finish.
4015
4016 When all the messages have been received, the reception process exits,
4017 leaving the delivery processes to finish in their own time. The standard output
4018 and error streams are closed at the start of each delivery process.
4019 This is the default action if none of the &%-od%& options are present.
4020
4021 If one of the queueing options in the configuration file
4022 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4023 overrides it if &%queue_only_override%& is set true, which is the default
4024 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4025
4026 .vitem &%-odf%&
4027 .oindex "&%-odf%&"
4028 .cindex "foreground delivery"
4029 .cindex "delivery" "in the foreground"
4030 This option requests &"foreground"& (synchronous) delivery when Exim has
4031 accepted a locally-generated message. (For the daemon it is exactly the same as
4032 &%-odb%&.) A delivery process is automatically started to deliver the message,
4033 and Exim waits for it to complete before proceeding.
4034
4035 The original Exim reception process does not finish until the delivery
4036 process for the final message has ended. The standard error stream is left open
4037 during deliveries.
4038
4039 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4040 false and one of the queueing options in the configuration file is in effect.
4041
4042 If there is a temporary delivery error during foreground delivery, the
4043 message is left on the queue for later delivery, and the original reception
4044 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4045 restricted configuration that never queues messages.
4046
4047
4048 .vitem &%-odi%&
4049 .oindex "&%-odi%&"
4050 This option is synonymous with &%-odf%&. It is provided for compatibility with
4051 Sendmail.
4052
4053 .vitem &%-odq%&
4054 .oindex "&%-odq%&"
4055 .cindex "non-immediate delivery"
4056 .cindex "delivery" "suppressing immediate"
4057 .cindex "queueing incoming messages"
4058 This option applies to all modes in which Exim accepts incoming messages,
4059 including the listening daemon. It specifies that the accepting process should
4060 not automatically start a delivery process for each message received. Messages
4061 are placed on the queue, and remain there until a subsequent queue runner
4062 process encounters them. There are several configuration options (such as
4063 &%queue_only%&) that can be used to queue incoming messages under certain
4064 conditions. This option overrides all of them and also &%-odqs%&. It always
4065 forces queueing.
4066
4067 .vitem &%-odqs%&
4068 .oindex "&%-odqs%&"
4069 .cindex "SMTP" "delaying delivery"
4070 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4071 However, like &%-odb%& and &%-odi%&, this option has no effect if
4072 &%queue_only_override%& is false and one of the queueing options in the
4073 configuration file is in effect.
4074
4075 When &%-odqs%& does operate, a delivery process is started for each incoming
4076 message, in the background by default, but in the foreground if &%-odi%& is
4077 also present. The recipient addresses are routed, and local deliveries are done
4078 in the normal way. However, if any SMTP deliveries are required, they are not
4079 done at this time, so the message remains on the queue until a subsequent queue
4080 runner process encounters it. Because routing was done, Exim knows which
4081 messages are waiting for which hosts, and so a number of messages for the same
4082 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4083 configuration option has the same effect for specific domains. See also the
4084 &%-qq%& option.
4085
4086 .vitem &%-oee%&
4087 .oindex "&%-oee%&"
4088 .cindex "error" "reporting"
4089 If an error is detected while a non-SMTP message is being received (for
4090 example, a malformed address), the error is reported to the sender in a mail
4091 message.
4092
4093 .cindex "return code" "for &%-oee%&"
4094 Provided
4095 this error message is successfully sent, the Exim receiving process
4096 exits with a return code of zero. If not, the return code is 2 if the problem
4097 is that the original message has no recipients, or 1 for any other error.
4098 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4099
4100 .vitem &%-oem%&
4101 .oindex "&%-oem%&"
4102 .cindex "error" "reporting"
4103 .cindex "return code" "for &%-oem%&"
4104 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4105 return code, whether or not the error message was successfully sent.
4106 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4107
4108 .vitem &%-oep%&
4109 .oindex "&%-oep%&"
4110 .cindex "error" "reporting"
4111 If an error is detected while a non-SMTP message is being received, the
4112 error is reported by writing a message to the standard error file (stderr).
4113 .cindex "return code" "for &%-oep%&"
4114 The return code is 1 for all errors.
4115
4116 .vitem &%-oeq%&
4117 .oindex "&%-oeq%&"
4118 .cindex "error" "reporting"
4119 This option is supported for compatibility with Sendmail, but has the same
4120 effect as &%-oep%&.
4121
4122 .vitem &%-oew%&
4123 .oindex "&%-oew%&"
4124 .cindex "error" "reporting"
4125 This option is supported for compatibility with Sendmail, but has the same
4126 effect as &%-oem%&.
4127
4128 .vitem &%-oi%&
4129 .oindex "&%-oi%&"
4130 .cindex "dot" "in incoming non-SMTP message"
4131 This option, which has the same effect as &%-i%&, specifies that a dot on a
4132 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4133 single dot does terminate, though Exim does no special processing for other
4134 lines that start with a dot. This option is set by default if Exim is called as
4135 &'rmail'&. See also &%-ti%&.
4136
4137 .vitem &%-oitrue%&
4138 .oindex "&%-oitrue%&"
4139 This option is treated as synonymous with &%-oi%&.
4140
4141 .vitem &%-oMa%&&~<&'host&~address'&>
4142 .oindex "&%-oMa%&"
4143 .cindex "sender" "host address, specifying for local message"
4144 A number of options starting with &%-oM%& can be used to set values associated
4145 with remote hosts on locally-submitted messages (that is, messages not received
4146 over TCP/IP). These options can be used by any caller in conjunction with the
4147 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4148 other circumstances, they are ignored unless the caller is trusted.
4149
4150 The &%-oMa%& option sets the sender host address. This may include a port
4151 number at the end, after a full stop (period). For example:
4152 .code
4153 exim -bs -oMa 10.9.8.7.1234
4154 .endd
4155 An alternative syntax is to enclose the IP address in square brackets,
4156 followed by a colon and the port number:
4157 .code
4158 exim -bs -oMa [10.9.8.7]:1234
4159 .endd
4160 The IP address is placed in the &$sender_host_address$& variable, and the
4161 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4162 are present on the command line, the sender host IP address is taken from
4163 whichever one is last.
4164
4165 .vitem &%-oMaa%&&~<&'name'&>
4166 .oindex "&%-oMaa%&"
4167 .cindex "authentication" "name, specifying for local message"
4168 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4169 option sets the value of &$sender_host_authenticated$& (the authenticator
4170 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4171 This option can be used with &%-bh%& and &%-bs%& to set up an
4172 authenticated SMTP session without actually using the SMTP AUTH command.
4173
4174 .vitem &%-oMai%&&~<&'string'&>
4175 .oindex "&%-oMai%&"
4176 .cindex "authentication" "id, specifying for local message"
4177 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4178 option sets the value of &$authenticated_id$& (the id that was authenticated).
4179 This overrides the default value (the caller's login id, except with &%-bh%&,
4180 where there is no default) for messages from local sources. See chapter
4181 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4182
4183 .vitem &%-oMas%&&~<&'address'&>
4184 .oindex "&%-oMas%&"
4185 .cindex "authentication" "sender, specifying for local message"
4186 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4187 option sets the authenticated sender value in &$authenticated_sender$&. It
4188 overrides the sender address that is created from the caller's login id for
4189 messages from local sources, except when &%-bh%& is used, when there is no
4190 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4191 specified on a MAIL command overrides this value. See chapter
4192 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4193
4194 .vitem &%-oMi%&&~<&'interface&~address'&>
4195 .oindex "&%-oMi%&"
4196 .cindex "interface" "address, specifying for local message"
4197 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4198 option sets the IP interface address value. A port number may be included,
4199 using the same syntax as for &%-oMa%&. The interface address is placed in
4200 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4201
4202 .vitem &%-oMr%&&~<&'protocol&~name'&>
4203 .oindex "&%-oMr%&"
4204 .cindex "protocol, specifying for local message"
4205 .vindex "&$received_protocol$&"
4206 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4207 option sets the received protocol value that is stored in
4208 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4209 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4210 SMTP protocol names (see the description of &$received_protocol$& in section
4211 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4212 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4213 be set by &%-oMr%&.
4214
4215 .vitem &%-oMs%&&~<&'host&~name'&>
4216 .oindex "&%-oMs%&"
4217 .cindex "sender" "host name, specifying for local message"
4218 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4219 option sets the sender host name in &$sender_host_name$&. When this option is
4220 present, Exim does not attempt to look up a host name from an IP address; it
4221 uses the name it is given.
4222
4223 .vitem &%-oMt%&&~<&'ident&~string'&>
4224 .oindex "&%-oMt%&"
4225 .cindex "sender" "ident string, specifying for local message"
4226 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4227 option sets the sender ident value in &$sender_ident$&. The default setting for
4228 local callers is the login id of the calling process, except when &%-bh%& is
4229 used, when there is no default.
4230
4231 .vitem &%-om%&
4232 .oindex "&%-om%&"
4233 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4234 In Sendmail, this option means &"me too"&, indicating that the sender of a
4235 message should receive a copy of the message if the sender appears in an alias
4236 expansion. Exim always does this, so the option does nothing.
4237
4238 .vitem &%-oo%&
4239 .oindex "&%-oo%&"
4240 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4241 This option is ignored. In Sendmail it specifies &"old style headers"&,
4242 whatever that means.
4243
4244 .vitem &%-oP%&&~<&'path'&>
4245 .oindex "&%-oP%&"
4246 .cindex "pid (process id)" "of daemon"
4247 .cindex "daemon" "process id (pid)"
4248 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4249 value. The option specifies the file to which the process id of the daemon is
4250 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4251 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4252 because in those cases, the normal pid file is not used.
4253
4254 .vitem &%-or%&&~<&'time'&>
4255 .oindex "&%-or%&"
4256 .cindex "timeout" "for non-SMTP input"
4257 This option sets a timeout value for incoming non-SMTP messages. If it is not
4258 set, Exim will wait forever for the standard input. The value can also be set
4259 by the &%receive_timeout%& option. The format used for specifying times is
4260 described in section &<<SECTtimeformat>>&.
4261
4262 .vitem &%-os%&&~<&'time'&>
4263 .oindex "&%-os%&"
4264 .cindex "timeout" "for SMTP input"
4265 .cindex "SMTP" "input timeout"
4266 This option sets a timeout value for incoming SMTP messages. The timeout
4267 applies to each SMTP command and block of data. The value can also be set by
4268 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4269 for specifying times is described in section &<<SECTtimeformat>>&.
4270
4271 .vitem &%-ov%&
4272 .oindex "&%-ov%&"
4273 This option has exactly the same effect as &%-v%&.
4274
4275 .vitem &%-oX%&&~<&'number&~or&~string'&>
4276 .oindex "&%-oX%&"
4277 .cindex "TCP/IP" "setting listening ports"
4278 .cindex "TCP/IP" "setting listening interfaces"
4279 .cindex "port" "receiving TCP/IP"
4280 This option is relevant only when the &%-bd%& (start listening daemon) option
4281 is also given. It controls which ports and interfaces the daemon uses. Details
4282 of the syntax, and how it interacts with configuration file options, are given
4283 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4284 file is written unless &%-oP%& is also present to specify a pid file name.
4285
4286 .vitem &%-pd%&
4287 .oindex "&%-pd%&"
4288 .cindex "Perl" "starting the interpreter"
4289 This option applies when an embedded Perl interpreter is linked with Exim (see
4290 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4291 option, forcing the starting of the interpreter to be delayed until it is
4292 needed.
4293
4294 .vitem &%-ps%&
4295 .oindex "&%-ps%&"
4296 .cindex "Perl" "starting the interpreter"
4297 This option applies when an embedded Perl interpreter is linked with Exim (see
4298 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4299 option, forcing the starting of the interpreter to occur as soon as Exim is
4300 started.
4301
4302 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4303 .oindex "&%-p%&"
4304 For compatibility with Sendmail, this option is equivalent to
4305 .display
4306 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4307 .endd
4308 It sets the incoming protocol and host name (for trusted callers). The
4309 host name and its colon can be omitted when only the protocol is to be set.
4310 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4311 to embedded Perl. It is therefore impossible to set a protocol value of &`p`&
4312 or &`s`& using this option (but that does not seem a real limitation).
4313
4314 .vitem &%-q%&
4315 .oindex "&%-q%&"
4316 .cindex "queue runner" "starting manually"
4317 This option is normally restricted to admin users. However, there is a
4318 configuration option called &%prod_requires_admin%& which can be set false to
4319 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4320 and &%-S%& options).
4321
4322 .cindex "queue runner" "description of operation"
4323 The &%-q%& option starts one queue runner process. This scans the queue of
4324 waiting messages, and runs a delivery process for each one in turn. It waits
4325 for each delivery process to finish before starting the next one. A delivery
4326 process may not actually do any deliveries if the retry times for the addresses
4327 have not been reached. Use &%-qf%& (see below) if you want to override this.
4328
4329 If
4330 .cindex "SMTP" "passed connection"
4331 .cindex "SMTP" "multiple deliveries"
4332 .cindex "multiple SMTP deliveries"
4333 the delivery process spawns other processes to deliver other messages down
4334 passed SMTP connections, the queue runner waits for these to finish before
4335 proceeding.
4336
4337 When all the queued messages have been considered, the original queue runner
4338 process terminates. In other words, a single pass is made over the waiting
4339 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4340 this to be repeated periodically.
4341
4342 Exim processes the waiting messages in an unpredictable order. It isn't very
4343 random, but it is likely to be different each time, which is all that matters.
4344 If one particular message screws up a remote MTA, other messages to the same
4345 MTA have a chance of getting through if they get tried first.
4346
4347 It is possible to cause the messages to be processed in lexical message id
4348 order, which is essentially the order in which they arrived, by setting the
4349 &%queue_run_in_order%& option, but this is not recommended for normal use.
4350
4351 .vitem &%-q%&<&'qflags'&>
4352 The &%-q%& option may be followed by one or more flag letters that change its
4353 behaviour. They are all optional, but if more than one is present, they must
4354 appear in the correct order. Each flag is described in a separate item below.
4355
4356 .vitem &%-qq...%&
4357 .oindex "&%-qq%&"
4358 .cindex "queue" "double scanning"
4359 .cindex "queue" "routing"
4360 .cindex "routing" "whole queue before delivery"
4361 An option starting with &%-qq%& requests a two-stage queue run. In the first
4362 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4363 every domain. Addresses are routed, local deliveries happen, but no remote
4364 transports are run.
4365
4366 .cindex "hints database" "remembering routing"
4367 The hints database that remembers which messages are waiting for specific hosts
4368 is updated, as if delivery to those hosts had been deferred. After this is
4369 complete, a second, normal queue scan happens, with routing and delivery taking
4370 place as normal. Messages that are routed to the same host should mostly be
4371 delivered down a single SMTP
4372 .cindex "SMTP" "passed connection"
4373 .cindex "SMTP" "multiple deliveries"
4374 .cindex "multiple SMTP deliveries"
4375 connection because of the hints that were set up during the first queue scan.
4376 This option may be useful for hosts that are connected to the Internet
4377 intermittently.
4378
4379 .vitem &%-q[q]i...%&
4380 .oindex "&%-qi%&"
4381 .cindex "queue" "initial delivery"
4382 If the &'i'& flag is present, the queue runner runs delivery processes only for
4383 those messages that haven't previously been tried. (&'i'& stands for &"initial
4384 delivery"&.) This can be helpful if you are putting messages on the queue using
4385 &%-odq%& and want a queue runner just to process the new messages.
4386
4387 .vitem &%-q[q][i]f...%&
4388 .oindex "&%-qf%&"
4389 .cindex "queue" "forcing delivery"
4390 .cindex "delivery" "forcing in queue run"
4391 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4392 message, whereas without &'f'& only those non-frozen addresses that have passed
4393 their retry times are tried.
4394
4395 .vitem &%-q[q][i]ff...%&
4396 .oindex "&%-qff%&"
4397 .cindex "frozen messages" "forcing delivery"
4398 If &'ff'& is present, a delivery attempt is forced for every message, whether
4399 frozen or not.
4400
4401 .vitem &%-q[q][i][f[f]]l%&
4402 .oindex "&%-ql%&"
4403 .cindex "queue" "local deliveries only"
4404 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4405 be done. If a message requires any remote deliveries, it remains on the queue
4406 for later delivery.
4407
4408 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4409 .cindex "queue" "delivering specific messages"
4410 When scanning the queue, Exim can be made to skip over messages whose ids are
4411 lexically less than a given value by following the &%-q%& option with a
4412 starting message id. For example:
4413 .code
4414 exim -q 0t5C6f-0000c8-00
4415 .endd
4416 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4417 second message id is given, messages whose ids are lexically greater than it
4418 are also skipped. If the same id is given twice, for example,
4419 .code
4420 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4421 .endd
4422 just one delivery process is started, for that message. This differs from
4423 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4424 that it counts as a delivery from a queue run. Note that the selection
4425 mechanism does not affect the order in which the messages are scanned. There
4426 are also other ways of selecting specific sets of messages for delivery in a
4427 queue run &-- see &%-R%& and &%-S%&.
4428
4429 .vitem &%-q%&<&'qflags'&><&'time'&>
4430 .cindex "queue runner" "starting periodically"
4431 .cindex "periodic queue running"
4432 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4433 starting a queue runner process at intervals specified by the given time value
4434 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4435 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4436 single daemon process handles both functions. A common way of starting up a
4437 combined daemon at system boot time is to use a command such as
4438 .code
4439 /usr/exim/bin/exim -bd -q30m
4440 .endd
4441 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4442 process every 30 minutes.
4443
4444 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4445 pid file is written unless one is explicitly requested by the &%-oP%& option.
4446
4447 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4448 .oindex "&%-qR%&"
4449 This option is synonymous with &%-R%&. It is provided for Sendmail
4450 compatibility.
4451
4452 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4453 .oindex "&%-qS%&"
4454 This option is synonymous with &%-S%&.
4455
4456 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4457 .oindex "&%-R%&"
4458 .cindex "queue runner" "for specific recipients"
4459 .cindex "delivery" "to given domain"
4460 .cindex "domain" "delivery to"
4461 The <&'rsflags'&> may be empty, in which case the white space before the string
4462 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4463 which are the possible values for <&'rsflags'&>. White space is required if
4464 <&'rsflags'&> is not empty.
4465
4466 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4467 perform a single queue run, except that, when scanning the messages on the
4468 queue, Exim processes only those that have at least one undelivered recipient
4469 address containing the given string, which is checked in a case-independent
4470 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4471 regular expression; otherwise it is a literal string.
4472
4473 If you want to do periodic queue runs for messages with specific recipients,
4474 you can combine &%-R%& with &%-q%& and a time value. For example:
4475 .code
4476 exim -q25m -R @special.domain.example
4477 .endd
4478 This example does a queue run for messages with recipients in the given domain
4479 every 25 minutes. Any additional flags that are specified with &%-q%& are
4480 applied to each queue run.
4481
4482 Once a message is selected for delivery by this mechanism, all its addresses
4483 are processed. For the first selected message, Exim overrides any retry
4484 information and forces a delivery attempt for each undelivered address. This
4485 means that if delivery of any address in the first message is successful, any
4486 existing retry information is deleted, and so delivery attempts for that
4487 address in subsequently selected messages (which are processed without forcing)
4488 will run. However, if delivery of any address does not succeed, the retry
4489 information is updated, and in subsequently selected messages, the failing
4490 address will be skipped.
4491
4492 .cindex "frozen messages" "forcing delivery"
4493 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4494 all selected messages, not just the first; frozen messages are included when
4495 &'ff'& is present.
4496
4497 The &%-R%& option makes it straightforward to initiate delivery of all messages
4498 to a given domain after a host has been down for some time. When the SMTP
4499 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4500 effect is to run Exim with the &%-R%& option, but it can be configured to run
4501 an arbitrary command instead.
4502
4503 .vitem &%-r%&
4504 .oindex "&%-r%&"
4505 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4506
4507 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4508 .oindex "&%-S%&"
4509 .cindex "delivery" "from given sender"
4510 .cindex "queue runner" "for specific senders"
4511 This option acts like &%-R%& except that it checks the string against each
4512 message's sender instead of against the recipients. If &%-R%& is also set, both
4513 conditions must be met for a message to be selected. If either of the options
4514 has &'f'& or &'ff'& in its flags, the associated action is taken.
4515
4516 .vitem &%-Tqt%&&~<&'times'&>
4517 .oindex "&%-Tqt%&"
4518 This is an option that is exclusively for use by the Exim testing suite. It is not
4519 recognized when Exim is run normally. It allows for the setting up of explicit
4520 &"queue times"& so that various warning/retry features can be tested.
4521
4522 .vitem &%-t%&
4523 .oindex "&%-t%&"
4524 .cindex "recipient" "extracting from header lines"
4525 .cindex "&'Bcc:'& header line"
4526 .cindex "&'Cc:'& header line"
4527 .cindex "&'To:'& header line"
4528 When Exim is receiving a locally-generated, non-SMTP message on its standard
4529 input, the &%-t%& option causes the recipients of the message to be obtained
4530 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4531 from the command arguments. The addresses are extracted before any rewriting
4532 takes place and the &'Bcc:'& header line, if present, is then removed.
4533
4534 .cindex "Sendmail compatibility" "&%-t%& option"
4535 If the command has any arguments, they specify addresses to which the message
4536 is &'not'& to be delivered. That is, the argument addresses are removed from
4537 the recipients list obtained from the headers. This is compatible with Smail 3
4538 and in accordance with the documented behaviour of several versions of
4539 Sendmail, as described in man pages on a number of operating systems (e.g.
4540 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4541 argument addresses to those obtained from the headers, and the O'Reilly
4542 Sendmail book documents it that way. Exim can be made to add argument addresses
4543 instead of subtracting them by setting the option
4544 &%extract_addresses_remove_arguments%& false.
4545
4546 .cindex "&%Resent-%& header lines" "with &%-t%&"
4547 If there are any &%Resent-%& header lines in the message, Exim extracts
4548 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4549 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4550 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4551 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4552
4553 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4554 message is resent several times). The RFC also specifies that they should be
4555 added at the front of the message, and separated by &'Received:'& lines. It is
4556 not at all clear how &%-t%& should operate in the present of multiple sets,
4557 nor indeed exactly what constitutes a &"set"&.
4558 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4559 are often added at the end of the header, and if a message is resent more than
4560 once, it is common for the original set of &%Resent-%& headers to be renamed as
4561 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4562
4563 .vitem &%-ti%&
4564 .oindex "&%-ti%&"
4565 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4566 compatibility with Sendmail.
4567
4568 .vitem &%-tls-on-connect%&
4569 .oindex "&%-tls-on-connect%&"
4570 .cindex "TLS" "use without STARTTLS"
4571 .cindex "TLS" "automatic start"
4572 This option is available when Exim is compiled with TLS support. It forces all
4573 incoming SMTP connections to behave as if the incoming port is listed in the
4574 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4575 &<<CHAPTLS>>& for further details.
4576
4577
4578 .vitem &%-U%&
4579 .oindex "&%-U%&"
4580 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4581 Sendmail uses this option for &"initial message submission"&, and its
4582 documentation states that in future releases, it may complain about
4583 syntactically invalid messages rather than fixing them when this flag is not
4584 set. Exim ignores this option.
4585
4586 .vitem &%-v%&
4587 .oindex "&%-v%&"
4588 This option causes Exim to write information to the standard error stream,
4589 describing what it is doing. In particular, it shows the log lines for
4590 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4591 dialogue is shown. Some of the log lines shown may not actually be written to
4592 the log if the setting of &%log_selector%& discards them. Any relevant
4593 selectors are shown with each log line. If none are shown, the logging is
4594 unconditional.
4595
4596 .vitem &%-x%&
4597 .oindex "&%-x%&"
4598 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4599 National Language Support extended characters in the body of the mail item"&).
4600 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4601 this option.
4602
4603 .new
4604 .vitem &%-X%&&~<&'logfile'&>
4605 .oindex "&%-X%&"
4606 This option is interpreted by Sendmail to cause debug information to be sent
4607 to the named file.  It is ignored by Exim.
4608 .wen
4609 .endlist
4610
4611 .ecindex IIDclo1
4612 .ecindex IIDclo2
4613
4614
4615 . ////////////////////////////////////////////////////////////////////////////
4616 . Insert a stylized DocBook comment here, to identify the end of the command
4617 . line options. This is for the benefit of the Perl script that automatically
4618 . creates a man page for the options.
4619 . ////////////////////////////////////////////////////////////////////////////
4620
4621 .literal xml
4622 <!-- === End of command line options === -->
4623 .literal off
4624
4625
4626
4627
4628
4629 . ////////////////////////////////////////////////////////////////////////////
4630 . ////////////////////////////////////////////////////////////////////////////
4631
4632
4633 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4634          "The runtime configuration file"
4635
4636 .cindex "run time configuration"
4637 .cindex "configuration file" "general description"
4638 .cindex "CONFIGURE_FILE"
4639 .cindex "configuration file" "errors in"
4640 .cindex "error" "in configuration file"
4641 .cindex "return code" "for bad configuration"
4642 Exim uses a single run time configuration file that is read whenever an Exim
4643 binary is executed. Note that in normal operation, this happens frequently,
4644 because Exim is designed to operate in a distributed manner, without central
4645 control.
4646
4647 If a syntax error is detected while reading the configuration file, Exim
4648 writes a message on the standard error, and exits with a non-zero return code.
4649 The message is also written to the panic log. &*Note*&: Only simple syntax
4650 errors can be detected at this time. The values of any expanded options are
4651 not checked until the expansion happens, even when the expansion does not
4652 actually alter the string.
4653
4654 The name of the configuration file is compiled into the binary for security
4655 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4656 most configurations, this specifies a single file. However, it is permitted to
4657 give a colon-separated list of file names, in which case Exim uses the first
4658 existing file in the list.
4659
4660 .cindex "EXIM_USER"
4661 .cindex "EXIM_GROUP"
4662 .cindex "CONFIGURE_OWNER"
4663 .cindex "CONFIGURE_GROUP"
4664 .cindex "configuration file" "ownership"
4665 .cindex "ownership" "configuration file"
4666 The run time configuration file must be owned by root or by the user that is
4667 specified at compile time by the CONFIGURE_OWNER option (if set). The
4668 configuration file must not be world-writeable, or group-writeable unless its
4669 group is the root group or the one specified at compile time by the
4670 CONFIGURE_GROUP option.
4671
4672 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4673 to root, anybody who is able to edit the run time configuration file has an
4674 easy way to run commands as root. If you specify a user or group in the
4675 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4676 who are members of that group will trivially be able to obtain root privileges.
4677
4678 Up to Exim version 4.72, the run time configuration file was also permitted to
4679 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4680 since it offered a simple privilege escalation for any attacker who managed to
4681 compromise the Exim user account.
4682
4683 A default configuration file, which will work correctly in simple situations,
4684 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4685 defines just one file name, the installation process copies the default
4686 configuration to a new file of that name if it did not previously exist. If
4687 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4688 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4689 configuration.
4690
4691
4692
4693 .section "Using a different configuration file" "SECID40"
4694 .cindex "configuration file" "alternate"
4695 A one-off alternate configuration can be specified by the &%-C%& command line
4696 option, which may specify a single file or a list of files. However, when
4697 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4698 unless the argument for &%-C%& is identical to the built-in value from
4699 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4700 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4701 is useful mainly for checking the syntax of configuration files before
4702 installing them. No owner or group checks are done on a configuration file
4703 specified by &%-C%&, if root privilege has been dropped.
4704
4705 Even the Exim user is not trusted to specify an arbitrary configuration file
4706 with the &%-C%& option to be used with root privileges, unless that file is
4707 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4708 testing a configuration using &%-C%& right through message reception and
4709 delivery, even if the caller is root. The reception works, but by that time,
4710 Exim is running as the Exim user, so when it re-execs to regain privilege for
4711 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4712 can test reception and delivery using two separate commands (one to put a
4713 message on the queue, using &%-odq%&, and another to do the delivery, using
4714 &%-M%&).
4715
4716 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4717 prefix string with which any file named in a &%-C%& command line option must
4718 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4719 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4720 name can be used with &%-C%&.
4721
4722 One-off changes to a configuration can be specified by the &%-D%& command line
4723 option, which defines and overrides values for macros used inside the
4724 configuration file. However, like &%-C%&, the use of this option by a
4725 non-privileged user causes Exim to discard its root privilege.
4726 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4727 completely disabled, and its use causes an immediate error exit.
4728
4729 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4730 to declare certain macro names trusted, such that root privilege will not
4731 necessarily be discarded.
4732 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4733 considered safe and, if &%-D%& only supplies macros from this list, and the
4734 values are acceptable, then Exim will not give up root privilege if the caller
4735 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4736 transition mechanism and is expected to be removed in the future.  Acceptable
4737 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4738
4739 Some sites may wish to use the same Exim binary on different machines that
4740 share a file system, but to use different configuration files on each machine.
4741 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4742 looks for a file whose name is the configuration file name followed by a dot
4743 and the machine's node name, as obtained from the &[uname()]& function. If this
4744 file does not exist, the standard name is tried. This processing occurs for
4745 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4746
4747 In some esoteric situations different versions of Exim may be run under
4748 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4749 help with this. See the comments in &_src/EDITME_& for details.
4750
4751
4752
4753 .section "Configuration file format" "SECTconffilfor"
4754 .cindex "configuration file" "format of"
4755 .cindex "format" "configuration file"
4756 Exim's configuration file is divided into a number of different parts. General
4757 option settings must always appear at the start of the file. The other parts
4758 are all optional, and may appear in any order. Each part other than the first
4759 is introduced by the word &"begin"& followed by the name of the part. The
4760 optional parts are:
4761
4762 .ilist
4763 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4764 &<<CHAPACL>>&).
4765 .next
4766 .cindex "AUTH" "configuration"
4767 &'authenticators'&: Configuration settings for the authenticator drivers. These
4768 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4769 .next
4770 &'routers'&: Configuration settings for the router drivers. Routers process
4771 addresses and determine how the message is to be delivered (see chapters
4772 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4773 .next
4774 &'transports'&: Configuration settings for the transport drivers. Transports
4775 define mechanisms for copying messages to destinations (see chapters
4776 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4777 .next
4778 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4779 If there is no retry section, or if it is empty (that is, no retry rules are
4780 defined), Exim will not retry deliveries. In this situation, temporary errors
4781 are treated the same as permanent errors. Retry rules are discussed in chapter
4782 &<<CHAPretry>>&.
4783 .next
4784 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4785 when new addresses are generated during delivery. Rewriting is discussed in
4786 chapter &<<CHAPrewrite>>&.
4787 .next
4788 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4789 want to use this feature, you must set
4790 .code
4791 LOCAL_SCAN_HAS_OPTIONS=yes
4792 .endd
4793 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4794 facility are given in chapter &<<CHAPlocalscan>>&.
4795 .endlist
4796
4797 .cindex "configuration file" "leading white space in"
4798 .cindex "configuration file" "trailing white space in"
4799 .cindex "white space" "in configuration file"
4800 Leading and trailing white space in configuration lines is always ignored.
4801
4802 Blank lines in the file, and lines starting with a # character (ignoring
4803 leading white space) are treated as comments and are ignored. &*Note*&: A
4804 # character other than at the beginning of a line is not treated specially,
4805 and does not introduce a comment.
4806
4807 Any non-comment line can be continued by ending it with a backslash. Note that
4808 the general rule for white space means that trailing white space after the
4809 backslash and leading white space at the start of continuation
4810 lines is ignored. Comment lines beginning with # (but not empty lines) may
4811 appear in the middle of a sequence of continuation lines.
4812
4813 A convenient way to create a configuration file is to start from the
4814 default, which is supplied in &_src/configure.default_&, and add, delete, or
4815 change settings as required.
4816
4817 The ACLs, retry rules, and rewriting rules have their own syntax which is
4818 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4819 respectively. The other parts of the configuration file have some syntactic
4820 items in common, and these are described below, from section &<<SECTcos>>&
4821 onwards. Before that, the inclusion, macro, and conditional facilities are
4822 described.
4823
4824
4825
4826 .section "File inclusions in the configuration file" "SECID41"
4827 .cindex "inclusions in configuration file"
4828 .cindex "configuration file" "including other files"
4829 .cindex "&`.include`& in configuration file"
4830 .cindex "&`.include_if_exists`& in configuration file"
4831 You can include other files inside Exim's run time configuration file by
4832 using this syntax:
4833 .display
4834 &`.include`& <&'file name'&>
4835 &`.include_if_exists`& <&'file name'&>
4836 .endd
4837 on a line by itself. Double quotes round the file name are optional. If you use
4838 the first form, a configuration error occurs if the file does not exist; the
4839 second form does nothing for non-existent files. In all cases, an absolute file
4840 name is required.
4841
4842 Includes may be nested to any depth, but remember that Exim reads its
4843 configuration file often, so it is a good idea to keep them to a minimum.
4844 If you change the contents of an included file, you must HUP the daemon,
4845 because an included file is read only when the configuration itself is read.
4846
4847 The processing of inclusions happens early, at a physical line level, so, like
4848 comment lines, an inclusion can be used in the middle of an option setting,
4849 for example:
4850 .code
4851 hosts_lookup = a.b.c \
4852                .include /some/file
4853 .endd
4854 Include processing happens after macro processing (see below). Its effect is to
4855 process the lines of the included file as if they occurred inline where the
4856 inclusion appears.
4857
4858
4859
4860 .section "Macros in the configuration file" "SECTmacrodefs"
4861 .cindex "macro" "description of"
4862 .cindex "configuration file" "macros"
4863 If a line in the main part of the configuration (that is, before the first
4864 &"begin"& line) begins with an upper case letter, it is taken as a macro
4865 definition, and must be of the form
4866 .display
4867 <&'name'&> = <&'rest of line'&>
4868 .endd
4869 The name must consist of letters, digits, and underscores, and need not all be
4870 in upper case, though that is recommended. The rest of the line, including any
4871 continuations, is the replacement text, and has leading and trailing white
4872 space removed. Quotes are not removed. The replacement text can never end with
4873 a backslash character, but this doesn't seem to be a serious limitation.
4874
4875 Macros may also be defined between router, transport, authenticator, or ACL
4876 definitions. They may not, however, be defined within an individual driver or
4877 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4878
4879 .section "Macro substitution" "SECID42"
4880 Once a macro is defined, all subsequent lines in the file (and any included
4881 files) are scanned for the macro name; if there are several macros, the line is
4882 scanned for each in turn, in the order in which the macros are defined. The
4883 replacement text is not re-scanned for the current macro, though it is scanned
4884 for subsequently defined macros. For this reason, a macro name may not contain
4885 the name of a previously defined macro as a substring. You could, for example,
4886 define
4887 .display
4888 &`ABCD_XYZ = `&<&'something'&>
4889 &`ABCD = `&<&'something else'&>
4890 .endd
4891 but putting the definitions in the opposite order would provoke a configuration
4892 error. Macro expansion is applied to individual physical lines from the file,
4893 before checking for line continuation or file inclusion (see above). If a line
4894 consists solely of a macro name, and the expansion of the macro is empty, the
4895 line is ignored. A macro at the start of a line may turn the line into a
4896 comment line or a &`.include`& line.
4897
4898
4899 .section "Redefining macros" "SECID43"
4900 Once defined, the value of a macro can be redefined later in the configuration
4901 (or in an included file). Redefinition is specified by using &'=='& instead of
4902 &'='&. For example:
4903 .code
4904 MAC =  initial value
4905 ...
4906 MAC == updated value
4907 .endd
4908 Redefinition does not alter the order in which the macros are applied to the
4909 subsequent lines of the configuration file. It is still the same order in which
4910 the macros were originally defined. All that changes is the macro's value.
4911 Redefinition makes it possible to accumulate values. For example:
4912 .code
4913 MAC =  initial value
4914 ...
4915 MAC == MAC and something added
4916 .endd
4917 This can be helpful in situations where the configuration file is built
4918 from a number of other files.
4919
4920 .section "Overriding macro values" "SECID44"
4921 The values set for macros in the configuration file can be overridden by the
4922 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4923 used, unless called by root or the Exim user. A definition on the command line
4924 using the &%-D%& option causes all definitions and redefinitions within the
4925 file to be ignored.
4926
4927
4928
4929 .section "Example of macro usage" "SECID45"
4930 As an example of macro usage, consider a configuration where aliases are looked
4931 up in a MySQL database. It helps to keep the file less cluttered if long
4932 strings such as SQL statements are defined separately as macros, for example:
4933 .code
4934 ALIAS_QUERY = select mailbox from user where \
4935               login='${quote_mysql:$local_part}';
4936 .endd
4937 This can then be used in a &(redirect)& router setting like this:
4938 .code
4939 data = ${lookup mysql{ALIAS_QUERY}}
4940 .endd
4941 In earlier versions of Exim macros were sometimes used for domain, host, or
4942 address lists. In Exim 4 these are handled better by named lists &-- see
4943 section &<<SECTnamedlists>>&.
4944
4945
4946 .section "Conditional skips in the configuration file" "SECID46"
4947 .cindex "configuration file" "conditional skips"
4948 .cindex "&`.ifdef`&"
4949 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4950 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4951 portions of the configuration file. The processing happens whenever the file is
4952 read (that is, when an Exim binary starts to run).
4953
4954 The implementation is very simple. Instances of the first four directives must
4955 be followed by text that includes the names of one or macros. The condition
4956 that is tested is whether or not any macro substitution has taken place in the
4957 line. Thus:
4958 .code
4959 .ifdef AAA
4960 message_size_limit = 50M
4961 .else
4962 message_size_limit = 100M
4963 .endif
4964 .endd
4965 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
4966 otherwise. If there is more than one macro named on the line, the condition
4967 is true if any of them are defined. That is, it is an &"or"& condition. To
4968 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
4969
4970 Although you can use a macro expansion to generate one of these directives,
4971 it is not very useful, because the condition &"there was a macro substitution
4972 in this line"& will always be true.
4973
4974 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
4975 to clarify complicated nestings.
4976
4977
4978
4979 .section "Common option syntax" "SECTcos"
4980 .cindex "common option syntax"
4981 .cindex "syntax of common options"
4982 .cindex "configuration file" "common option syntax"
4983 For the main set of options, driver options, and &[local_scan()]& options,
4984 each setting is on a line by itself, and starts with a name consisting of
4985 lower-case letters and underscores. Many options require a data value, and in
4986 these cases the name must be followed by an equals sign (with optional white
4987 space) and then the value. For example:
4988 .code
4989 qualify_domain = mydomain.example.com
4990 .endd
4991 .cindex "hiding configuration option values"
4992 .cindex "configuration options" "hiding value of"
4993 .cindex "options" "hiding value of"
4994 Some option settings may contain sensitive data, for example, passwords for
4995 accessing databases. To stop non-admin users from using the &%-bP%& command
4996 line option to read these values, you can precede the option settings with the
4997 word &"hide"&. For example:
4998 .code
4999 hide mysql_servers = localhost/users/admin/secret-password
5000 .endd
5001 For non-admin users, such options are displayed like this:
5002 .code
5003 mysql_servers = <value not displayable>
5004 .endd
5005 If &"hide"& is used on a driver option, it hides the value of that option on
5006 all instances of the same driver.
5007
5008 The following sections describe the syntax used for the different data types
5009 that are found in option settings.
5010
5011
5012 .section "Boolean options" "SECID47"
5013 .cindex "format" "boolean"
5014 .cindex "boolean configuration values"
5015 .oindex "&%no_%&&'xxx'&"
5016 .oindex "&%not_%&&'xxx'&"
5017 Options whose type is given as boolean are on/off switches. There are two
5018 different ways of specifying such options: with and without a data value. If
5019 the option name is specified on its own without data, the switch is turned on;
5020 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5021 boolean options may be followed by an equals sign and one of the words
5022 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5023 the following two settings have exactly the same effect:
5024 .code
5025 queue_only
5026 queue_only = true
5027 .endd
5028 The following two lines also have the same (opposite) effect:
5029 .code
5030 no_queue_only
5031 queue_only = false
5032 .endd
5033 You can use whichever syntax you prefer.
5034
5035
5036
5037
5038 .section "Integer values" "SECID48"
5039 .cindex "integer configuration values"
5040 .cindex "format" "integer"
5041 If an option's type is given as &"integer"&, the value can be given in decimal,
5042 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5043 number is assumed. Otherwise, it is treated as an octal number unless it starts
5044 with the characters &"0x"&, in which case the remainder is interpreted as a
5045 hexadecimal number.
5046
5047 If an integer value is followed by the letter K, it is multiplied by 1024; if
5048 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5049 of integer option settings are output, values which are an exact multiple of
5050 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5051 and M. The printing style is independent of the actual input format that was
5052 used.
5053
5054
5055 .section "Octal integer values" "SECID49"
5056 .cindex "integer format"
5057 .cindex "format" "octal integer"
5058 If an option's type is given as &"octal integer"&, its value is always
5059 interpreted as an octal number, whether or not it starts with the digit zero.
5060 Such options are always output in octal.
5061
5062
5063 .section "Fixed point numbers" "SECID50"
5064 .cindex "fixed point configuration values"
5065 .cindex "format" "fixed point"
5066 If an option's type is given as &"fixed-point"&, its value must be a decimal
5067 integer, optionally followed by a decimal point and up to three further digits.
5068
5069
5070
5071 .section "Time intervals" "SECTtimeformat"
5072 .cindex "time interval" "specifying in configuration"
5073 .cindex "format" "time interval"
5074 A time interval is specified as a sequence of numbers, each followed by one of
5075 the following letters, with no intervening white space:
5076
5077 .table2 30pt
5078 .irow &%s%& seconds
5079 .irow &%m%& minutes
5080 .irow &%h%& hours
5081 .irow &%d%& days
5082 .irow &%w%& weeks
5083 .endtable
5084
5085 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5086 intervals are output in the same format. Exim does not restrict the values; it
5087 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5088
5089
5090
5091 .section "String values" "SECTstrings"
5092 .cindex "string" "format of configuration values"
5093 .cindex "format" "string"
5094 If an option's type is specified as &"string"&, the value can be specified with
5095 or without double-quotes. If it does not start with a double-quote, the value
5096 consists of the remainder of the line plus any continuation lines, starting at
5097 the first character after any leading white space, with trailing white space
5098 removed, and with no interpretation of the characters in the string. Because
5099 Exim removes comment lines (those beginning with #) at an early stage, they can
5100 appear in the middle of a multi-line string. The following two settings are
5101 therefore equivalent:
5102 .code
5103 trusted_users = uucp:mail
5104 trusted_users = uucp:\
5105                 # This comment line is ignored
5106                 mail
5107 .endd
5108 .cindex "string" "quoted"
5109 .cindex "escape characters in quoted strings"
5110 If a string does start with a double-quote, it must end with a closing
5111 double-quote, and any backslash characters other than those used for line
5112 continuation are interpreted as escape characters, as follows:
5113
5114 .table2 100pt
5115 .irow &`\\`&                     "single backslash"
5116 .irow &`\n`&                     "newline"
5117 .irow &`\r`&                     "carriage return"
5118 .irow &`\t`&                     "tab"
5119 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5120 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5121                                    character"
5122 .endtable
5123
5124 If a backslash is followed by some other character, including a double-quote
5125 character, that character replaces the pair.
5126
5127 Quoting is necessary only if you want to make use of the backslash escapes to
5128 insert special characters, or if you need to specify a value with leading or
5129 trailing spaces. These cases are rare, so quoting is almost never needed in
5130 current versions of Exim. In versions of Exim before 3.14, quoting was required
5131 in order to continue lines, so you may come across older configuration files
5132 and examples that apparently quote unnecessarily.
5133
5134
5135 .section "Expanded strings" "SECID51"
5136 .cindex "expansion" "definition of"
5137 Some strings in the configuration file are subjected to &'string expansion'&,
5138 by which means various parts of the string may be changed according to the
5139 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5140 is as just described; in particular, the handling of backslashes in quoted
5141 strings is done as part of the input process, before expansion takes place.
5142 However, backslash is also an escape character for the expander, so any
5143 backslashes that are required for that reason must be doubled if they are
5144 within a quoted configuration string.
5145
5146
5147 .section "User and group names" "SECID52"
5148 .cindex "user name" "format of"
5149 .cindex "format" "user name"
5150 .cindex "groups" "name format"
5151 .cindex "format" "group name"
5152 User and group names are specified as strings, using the syntax described
5153 above, but the strings are interpreted specially. A user or group name must
5154 either consist entirely of digits, or be a name that can be looked up using the
5155 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5156
5157
5158 .section "List construction" "SECTlistconstruct"
5159 .cindex "list" "syntax of in configuration"
5160 .cindex "format" "list item in configuration"
5161 .cindex "string" "list, definition of"
5162 The data for some configuration options is a list of items, with colon as the
5163 default separator. Many of these options are shown with type &"string list"& in
5164 the descriptions later in this document. Others are listed as &"domain list"&,
5165 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5166 are all the same; however, those other than &"string list"& are subject to
5167 particular kinds of interpretation, as described in chapter
5168 &<<CHAPdomhosaddlists>>&.
5169
5170 In all these cases, the entire list is treated as a single string as far as the
5171 input syntax is concerned. The &%trusted_users%& setting in section
5172 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5173 in a list, it must be entered as two colons. Leading and trailing white space
5174 on each item in a list is ignored. This makes it possible to include items that
5175 start with a colon, and in particular, certain forms of IPv6 address. For
5176 example, the list
5177 .code
5178 local_interfaces = 127.0.0.1 : ::::1
5179 .endd
5180 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5181
5182 &*Note*&: Although leading and trailing white space is ignored in individual
5183 list items, it is not ignored when parsing the list. The space after the first
5184 colon in the example above is necessary. If it were not there, the list would
5185 be interpreted as the two items 127.0.0.1:: and 1.
5186
5187 .section "Changing list separators" "SECID53"
5188 .cindex "list separator" "changing"
5189 .cindex "IPv6" "addresses in lists"
5190 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5191 introduced to allow the separator character to be changed. If a list begins
5192 with a left angle bracket, followed by any punctuation character, that
5193 character is used instead of colon as the list separator. For example, the list
5194 above can be rewritten to use a semicolon separator like this:
5195 .code
5196 local_interfaces = <; 127.0.0.1 ; ::1
5197 .endd
5198 This facility applies to all lists, with the exception of the list in
5199 &%log_file_path%&. It is recommended that the use of non-colon separators be
5200 confined to circumstances where they really are needed.
5201
5202 .cindex "list separator" "newline as"
5203 .cindex "newline" "as list separator"
5204 It is also possible to use newline and other control characters (those with
5205 code values less than 32, plus DEL) as separators in lists. Such separators
5206 must be provided literally at the time the list is processed. For options that
5207 are string-expanded, you can write the separator using a normal escape
5208 sequence. This will be processed by the expander before the string is
5209 interpreted as a list. For example, if a newline-separated list of domains is
5210 generated by a lookup, you can process it directly by a line such as this:
5211 .code
5212 domains = <\n ${lookup mysql{.....}}
5213 .endd
5214 This avoids having to change the list separator in such data. You are unlikely
5215 to want to use a control character as a separator in an option that is not
5216 expanded, because the value is literal text. However, it can be done by giving
5217 the value in quotes. For example:
5218 .code
5219 local_interfaces = "<\n 127.0.0.1 \n ::1"
5220 .endd
5221 Unlike printing character separators, which can be included in list items by
5222 doubling, it is not possible to include a control character as data when it is
5223 set as the separator. Two such characters in succession are interpreted as
5224 enclosing an empty list item.
5225
5226
5227
5228 .section "Empty items in lists" "SECTempitelis"
5229 .cindex "list" "empty item in"
5230 An empty item at the end of a list is always ignored. In other words, trailing
5231 separator characters are ignored. Thus, the list in
5232 .code
5233 senders = user@domain :
5234 .endd
5235 contains only a single item. If you want to include an empty string as one item
5236 in a list, it must not be the last item. For example, this list contains three
5237 items, the second of which is empty:
5238 .code
5239 senders = user1@domain : : user2@domain
5240 .endd
5241 &*Note*&: There must be white space between the two colons, as otherwise they
5242 are interpreted as representing a single colon data character (and the list
5243 would then contain just one item). If you want to specify a list that contains
5244 just one, empty item, you can do it as in this example:
5245 .code
5246 senders = :
5247 .endd
5248 In this case, the first item is empty, and the second is discarded because it
5249 is at the end of the list.
5250
5251
5252
5253
5254 .section "Format of driver configurations" "SECTfordricon"
5255 .cindex "drivers" "configuration format"
5256 There are separate parts in the configuration for defining routers, transports,
5257 and authenticators. In each part, you are defining a number of driver
5258 instances, each with its own set of options. Each driver instance is defined by
5259 a sequence of lines like this:
5260 .display
5261 <&'instance name'&>:
5262   <&'option'&>
5263   ...
5264   <&'option'&>
5265 .endd
5266 In the following example, the instance name is &(localuser)&, and it is
5267 followed by three options settings:
5268 .code
5269 localuser:
5270   driver = accept
5271   check_local_user
5272   transport = local_delivery
5273 .endd
5274 For each driver instance, you specify which Exim code module it uses &-- by the
5275 setting of the &%driver%& option &-- and (optionally) some configuration
5276 settings. For example, in the case of transports, if you want a transport to
5277 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5278 a local file you would use the &(appendfile)& driver. Each of the drivers is
5279 described in detail in its own separate chapter later in this manual.
5280
5281 You can have several routers, transports, or authenticators that are based on
5282 the same underlying driver (each must have a different instance name).
5283
5284 The order in which routers are defined is important, because addresses are
5285 passed to individual routers one by one, in order. The order in which
5286 transports are defined does not matter at all. The order in which
5287 authenticators are defined is used only when Exim, as a client, is searching
5288 them to find one that matches an authentication mechanism offered by the
5289 server.
5290
5291 .cindex "generic options"
5292 .cindex "options" "generic &-- definition of"
5293 Within a driver instance definition, there are two kinds of option: &'generic'&
5294 and &'private'&. The generic options are those that apply to all drivers of the
5295 same type (that is, all routers, all transports or all authenticators). The
5296 &%driver%& option is a generic option that must appear in every definition.
5297 .cindex "private options"
5298 The private options are special for each driver, and none need appear, because
5299 they all have default values.
5300
5301 The options may appear in any order, except that the &%driver%& option must
5302 precede any private options, since these depend on the particular driver. For
5303 this reason, it is recommended that &%driver%& always be the first option.
5304
5305 Driver instance names, which are used for reference in log entries and
5306 elsewhere, can be any sequence of letters, digits, and underscores (starting
5307 with a letter) and must be unique among drivers of the same type. A router and
5308 a transport (for example) can each have the same name, but no two router
5309 instances can have the same name. The name of a driver instance should not be
5310 confused with the name of the underlying driver module. For example, the
5311 configuration lines:
5312 .code
5313 remote_smtp:
5314   driver = smtp
5315 .endd
5316 create an instance of the &(smtp)& transport driver whose name is
5317 &(remote_smtp)&. The same driver code can be used more than once, with
5318 different instance names and different option settings each time. A second
5319 instance of the &(smtp)& transport, with different options, might be defined
5320 thus:
5321 .code
5322 special_smtp:
5323   driver = smtp
5324   port = 1234
5325   command_timeout = 10s
5326 .endd
5327 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5328 these transport instances from routers, and these names would appear in log
5329 lines.
5330
5331 Comment lines may be present in the middle of driver specifications. The full
5332 list of option settings for any particular driver instance, including all the
5333 defaulted values, can be extracted by making use of the &%-bP%& command line
5334 option.
5335
5336
5337
5338
5339
5340
5341 . ////////////////////////////////////////////////////////////////////////////
5342 . ////////////////////////////////////////////////////////////////////////////
5343
5344 .chapter "The default configuration file" "CHAPdefconfil"
5345 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5346 .cindex "default" "configuration file &""walk through""&"
5347 The default configuration file supplied with Exim as &_src/configure.default_&
5348 is sufficient for a host with simple mail requirements. As an introduction to
5349 the way Exim is configured, this chapter &"walks through"& the default
5350 configuration, giving brief explanations of the settings. Detailed descriptions
5351 of the options are given in subsequent chapters. The default configuration file
5352 itself contains extensive comments about ways you might want to modify the
5353 initial settings. However, note that there are many options that are not
5354 mentioned at all in the default configuration.
5355
5356
5357
5358 .section "Main configuration settings" "SECTdefconfmain"
5359 The main (global) configuration option settings must always come first in the
5360 file. The first thing you'll see in the file, after some initial comments, is
5361 the line
5362 .code
5363 # primary_hostname =
5364 .endd
5365 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5366 to know the official, fully qualified name of your host, and this is where you
5367 can specify it. However, in most cases you do not need to set this option. When
5368 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5369
5370 The first three non-comment configuration lines are as follows:
5371 .code
5372 domainlist local_domains    = @
5373 domainlist relay_to_domains =
5374 hostlist   relay_from_hosts = 127.0.0.1
5375 .endd
5376 These are not, in fact, option settings. They are definitions of two named
5377 domain lists and one named host list. Exim allows you to give names to lists of
5378 domains, hosts, and email addresses, in order to make it easier to manage the
5379 configuration file (see section &<<SECTnamedlists>>&).
5380
5381 The first line defines a domain list called &'local_domains'&; this is used
5382 later in the configuration to identify domains that are to be delivered
5383 on the local host.
5384
5385 .cindex "@ in a domain list"
5386 There is just one item in this list, the string &"@"&. This is a special form
5387 of entry which means &"the name of the local host"&. Thus, if the local host is
5388 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5389 be delivered locally. Because the local host's name is referenced indirectly,
5390 the same configuration file can be used on different hosts.
5391
5392 The second line defines a domain list called &'relay_to_domains'&, but the
5393 list itself is empty. Later in the configuration we will come to the part that
5394 controls mail relaying through the local host; it allows relaying to any
5395 domains in this list. By default, therefore, no relaying on the basis of a mail
5396 domain is permitted.
5397
5398 The third line defines a host list called &'relay_from_hosts'&. This list is
5399 used later in the configuration to permit relaying from any host or IP address
5400 that matches the list. The default contains just the IP address of the IPv4
5401 loopback interface, which means that processes on the local host are able to
5402 submit mail for relaying by sending it over TCP/IP to that interface. No other
5403 hosts are permitted to submit messages for relaying.
5404
5405 Just to be sure there's no misunderstanding: at this point in the configuration
5406 we aren't actually setting up any controls. We are just defining some domains
5407 and hosts that will be used in the controls that are specified later.
5408
5409 The next two configuration lines are genuine option settings:
5410 .code
5411 acl_smtp_rcpt = acl_check_rcpt
5412 acl_smtp_data = acl_check_data
5413 .endd
5414 These options specify &'Access Control Lists'& (ACLs) that are to be used
5415 during an incoming SMTP session for every recipient of a message (every RCPT
5416 command), and after the contents of the message have been received,
5417 respectively. The names of the lists are &'acl_check_rcpt'& and
5418 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5419 section of the configuration. The RCPT ACL controls which recipients are
5420 accepted for an incoming message &-- if a configuration does not provide an ACL
5421 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5422 contents of a message to be checked.
5423
5424 Two commented-out option settings are next:
5425 .code
5426 # av_scanner = clamd:/tmp/clamd
5427 # spamd_address = 127.0.0.1 783
5428 .endd
5429 These are example settings that can be used when Exim is compiled with the
5430 content-scanning extension. The first specifies the interface to the virus
5431 scanner, and the second specifies the interface to SpamAssassin. Further
5432 details are given in chapter &<<CHAPexiscan>>&.
5433
5434 Three more commented-out option settings follow:
5435 .code
5436 # tls_advertise_hosts = *
5437 # tls_certificate = /etc/ssl/exim.crt
5438 # tls_privatekey = /etc/ssl/exim.pem
5439 .endd
5440 These are example settings that can be used when Exim is compiled with
5441 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5442 first one specifies the list of clients that are allowed to use TLS when
5443 connecting to this server; in this case the wildcard means all clients. The
5444 other options specify where Exim should find its TLS certificate and private
5445 key, which together prove the server's identity to any clients that connect.
5446 More details are given in chapter &<<CHAPTLS>>&.
5447
5448 Another two commented-out option settings follow:
5449 .code
5450 # daemon_smtp_ports = 25 : 465 : 587
5451 # tls_on_connect_ports = 465
5452 .endd
5453 .cindex "port" "465 and 587"
5454 .cindex "port" "for message submission"
5455 .cindex "message" "submission, ports for"
5456 .cindex "ssmtp protocol"
5457 .cindex "smtps protocol"
5458 .cindex "SMTP" "ssmtp protocol"
5459 .cindex "SMTP" "smtps protocol"
5460 These options provide better support for roaming users who wish to use this
5461 server for message submission. They are not much use unless you have turned on
5462 TLS (as described in the previous paragraph) and authentication (about which
5463 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5464 on end-user networks, so RFC 4409 specifies that message submission should use
5465 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5466 configured to use port 587 correctly, so these settings also enable the
5467 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5468 &<<SECTsupobssmt>>&).
5469
5470 Two more commented-out options settings follow:
5471 .code
5472 # qualify_domain =
5473 # qualify_recipient =
5474 .endd
5475 The first of these specifies a domain that Exim uses when it constructs a
5476 complete email address from a local login name. This is often needed when Exim
5477 receives a message from a local process. If you do not set &%qualify_domain%&,
5478 the value of &%primary_hostname%& is used. If you set both of these options,
5479 you can have different qualification domains for sender and recipient
5480 addresses. If you set only the first one, its value is used in both cases.
5481
5482 .cindex "domain literal" "recognizing format"
5483 The following line must be uncommented if you want Exim to recognize
5484 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5485 (an IP address within square brackets) instead of a named domain.
5486 .code
5487 # allow_domain_literals
5488 .endd
5489 The RFCs still require this form, but many people think that in the modern
5490 Internet it makes little sense to permit mail to be sent to specific hosts by
5491 quoting their IP addresses. This ancient format has been used by people who
5492 try to abuse hosts by using them for unwanted relaying. However, some
5493 people believe there are circumstances (for example, messages addressed to
5494 &'postmaster'&) where domain literals are still useful.
5495
5496 The next configuration line is a kind of trigger guard:
5497 .code
5498 never_users = root
5499 .endd
5500 It specifies that no delivery must ever be run as the root user. The normal
5501 convention is to set up &'root'& as an alias for the system administrator. This
5502 setting is a guard against slips in the configuration.
5503 The list of users specified by &%never_users%& is not, however, the complete
5504 list; the build-time configuration in &_Local/Makefile_& has an option called
5505 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5506 contents of &%never_users%& are added to this list. By default
5507 FIXED_NEVER_USERS also specifies root.
5508
5509 When a remote host connects to Exim in order to send mail, the only information
5510 Exim has about the host's identity is its IP address. The next configuration
5511 line,
5512 .code
5513 host_lookup = *
5514 .endd
5515 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5516 in order to get a host name. This improves the quality of the logging
5517 information, but if you feel it is too expensive, you can remove it entirely,
5518 or restrict the lookup to hosts on &"nearby"& networks.
5519 Note that it is not always possible to find a host name from an IP address,
5520 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5521 unreachable.
5522
5523 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5524 1413 (hence their names):
5525 .code
5526 rfc1413_hosts = *
5527 rfc1413_query_timeout = 5s
5528 .endd
5529 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5530 You can limit the hosts to which these calls are made, or change the timeout
5531 that is used. If you set the timeout to zero, all ident calls are disabled.
5532 Although they are cheap and can provide useful information for tracing problem
5533 messages, some hosts and firewalls have problems with ident calls. This can
5534 result in a timeout instead of an immediate refused connection, leading to
5535 delays on starting up an incoming SMTP session.
5536
5537 When Exim receives messages over SMTP connections, it expects all addresses to
5538 be fully qualified with a domain, as required by the SMTP definition. However,
5539 if you are running a server to which simple clients submit messages, you may
5540 find that they send unqualified addresses. The two commented-out options:
5541 .code
5542 # sender_unqualified_hosts =
5543 # recipient_unqualified_hosts =
5544 .endd
5545 show how you can specify hosts that are permitted to send unqualified sender
5546 and recipient addresses, respectively.
5547
5548 The &%percent_hack_domains%& option is also commented out:
5549 .code
5550 # percent_hack_domains =
5551 .endd
5552 It provides a list of domains for which the &"percent hack"& is to operate.
5553 This is an almost obsolete form of explicit email routing. If you do not know
5554 anything about it, you can safely ignore this topic.
5555
5556 The last two settings in the main part of the default configuration are
5557 concerned with messages that have been &"frozen"& on Exim's queue. When a
5558 message is frozen, Exim no longer continues to try to deliver it. Freezing
5559 occurs when a bounce message encounters a permanent failure because the sender
5560 address of the original message that caused the bounce is invalid, so the
5561 bounce cannot be delivered. This is probably the most common case, but there
5562 are also other conditions that cause freezing, and frozen messages are not
5563 always bounce messages.
5564 .code
5565 ignore_bounce_errors_after = 2d
5566 timeout_frozen_after = 7d
5567 .endd
5568 The first of these options specifies that failing bounce messages are to be
5569 discarded after 2 days on the queue. The second specifies that any frozen
5570 message (whether a bounce message or not) is to be timed out (and discarded)
5571 after a week. In this configuration, the first setting ensures that no failing
5572 bounce message ever lasts a week.
5573
5574
5575
5576 .section "ACL configuration" "SECID54"
5577 .cindex "default" "ACLs"
5578 .cindex "&ACL;" "default configuration"
5579 In the default configuration, the ACL section follows the main configuration.
5580 It starts with the line
5581 .code
5582 begin acl
5583 .endd
5584 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5585 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5586 and &%acl_smtp_data%& above.
5587
5588 .cindex "RCPT" "ACL for"
5589 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5590 RCPT command specifies one of the message's recipients. The ACL statements
5591 are considered in order, until the recipient address is either accepted or
5592 rejected. The RCPT command is then accepted or rejected, according to the
5593 result of the ACL processing.
5594 .code
5595 acl_check_rcpt:
5596 .endd
5597 This line, consisting of a name terminated by a colon, marks the start of the
5598 ACL, and names it.
5599 .code
5600 accept  hosts = :
5601 .endd
5602 This ACL statement accepts the recipient if the sending host matches the list.
5603 But what does that strange list mean? It doesn't actually contain any host
5604 names or IP addresses. The presence of the colon puts an empty item in the
5605 list; Exim matches this only if the incoming message did not come from a remote
5606 host, because in that case, the remote hostname is empty. The colon is
5607 important. Without it, the list itself is empty, and can never match anything.
5608
5609 What this statement is doing is to accept unconditionally all recipients in
5610 messages that are submitted by SMTP from local processes using the standard
5611 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5612 manner.
5613 .code
5614 deny    message       = Restricted characters in address
5615         domains       = +local_domains
5616         local_parts   = ^[.] : ^.*[@%!/|]
5617
5618 deny    message       = Restricted characters in address
5619         domains       = !+local_domains
5620         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5621 .endd
5622 These statements are concerned with local parts that contain any of the
5623 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5624 Although these characters are entirely legal in local parts (in the case of
5625 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5626 in Internet mail addresses.
5627
5628 The first three have in the past been associated with explicitly routed
5629 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5630 option). Addresses containing these characters are regularly tried by spammers
5631 in an attempt to bypass relaying restrictions, and also by open relay testing
5632 programs. Unless you really need them it is safest to reject these characters
5633 at this early stage. This configuration is heavy-handed in rejecting these
5634 characters for all messages it accepts from remote hosts. This is a deliberate
5635 policy of being as safe as possible.
5636
5637 The first rule above is stricter, and is applied to messages that are addressed
5638 to one of the local domains handled by this host. This is implemented by the
5639 first condition, which restricts it to domains that are listed in the
5640 &'local_domains'& domain list. The &"+"& character is used to indicate a
5641 reference to a named list. In this configuration, there is just one domain in
5642 &'local_domains'&, but in general there may be many.
5643
5644 The second condition on the first statement uses two regular expressions to
5645 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5646 or &"|"&. If you have local accounts that include these characters, you will
5647 have to modify this rule.
5648
5649 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5650 allows them because they have been encountered in practice. (Consider the
5651 common convention of local parts constructed as
5652 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5653 the author of Exim, who has no second initial.) However, a local part starting
5654 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5655 file name (for example, for a mailing list). This is also true for local parts
5656 that contain slashes. A pipe symbol can also be troublesome if the local part
5657 is incorporated unthinkingly into a shell command line.
5658
5659 The second rule above applies to all other domains, and is less strict. This
5660 allows your own users to send outgoing messages to sites that use slashes
5661 and vertical bars in their local parts. It blocks local parts that begin
5662 with a dot, slash, or vertical bar, but allows these characters within the
5663 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5664 and &"!"& is blocked, as before. The motivation here is to prevent your users
5665 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5666 .code
5667 accept  local_parts   = postmaster
5668         domains       = +local_domains
5669 .endd
5670 This statement, which has two conditions, accepts an incoming address if the
5671 local part is &'postmaster'& and the domain is one of those listed in the
5672 &'local_domains'& domain list. The &"+"& character is used to indicate a
5673 reference to a named list. In this configuration, there is just one domain in
5674 &'local_domains'&, but in general there may be many.
5675
5676 The presence of this statement means that mail to postmaster is never blocked
5677 by any of the subsequent tests. This can be helpful while sorting out problems
5678 in cases where the subsequent tests are incorrectly denying access.
5679 .code
5680 require verify        = sender
5681 .endd
5682 This statement requires the sender address to be verified before any subsequent
5683 ACL statement can be used. If verification fails, the incoming recipient
5684 address is refused. Verification consists of trying to route the address, to
5685 see if a bounce message could be delivered to it. In the case of remote
5686 addresses, basic verification checks only the domain, but &'callouts'& can be
5687 used for more verification if required. Section &<<SECTaddressverification>>&
5688 discusses the details of address verification.
5689 .code
5690 accept  hosts         = +relay_from_hosts
5691         control       = submission
5692 .endd
5693 This statement accepts the address if the message is coming from one of the
5694 hosts that are defined as being allowed to relay through this host. Recipient
5695 verification is omitted here, because in many cases the clients are dumb MUAs
5696 that do not cope well with SMTP error responses. For the same reason, the
5697 second line specifies &"submission mode"& for messages that are accepted. This
5698 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5699 messages that are deficient in some way, for example, because they lack a
5700 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5701 probably add recipient verification here, and disable submission mode.
5702 .code
5703 accept  authenticated = *
5704         control       = submission
5705 .endd
5706 This statement accepts the address if the client host has authenticated itself.
5707 Submission mode is again specified, on the grounds that such messages are most
5708 likely to come from MUAs. The default configuration does not define any
5709 authenticators, though it does include some nearly complete commented-out
5710 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5711 fact authenticate until you complete the authenticator definitions.
5712 .code
5713 require message = relay not permitted
5714         domains = +local_domains : +relay_to_domains
5715 .endd
5716 This statement rejects the address if its domain is neither a local domain nor
5717 one of the domains for which this host is a relay.
5718 .code
5719 require verify = recipient
5720 .endd
5721 This statement requires the recipient address to be verified; if verification
5722 fails, the address is rejected.
5723 .code
5724 # deny    message     = rejected because $sender_host_address \
5725 #                       is in a black list at $dnslist_domain\n\
5726 #                       $dnslist_text
5727 #         dnslists    = black.list.example
5728 #
5729 # warn    dnslists    = black.list.example
5730 #         add_header  = X-Warning: $sender_host_address is in \
5731 #                       a black list at $dnslist_domain
5732 #         log_message = found in $dnslist_domain
5733 .endd
5734 These commented-out lines are examples of how you could configure Exim to check
5735 sending hosts against a DNS black list. The first statement rejects messages
5736 from blacklisted hosts, whereas the second just inserts a warning header
5737 line.
5738 .code
5739 # require verify = csa
5740 .endd
5741 This commented-out line is an example of how you could turn on client SMTP
5742 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5743 records.
5744 .code
5745 accept
5746 .endd
5747 The final statement in the first ACL unconditionally accepts any recipient
5748 address that has successfully passed all the previous tests.
5749 .code
5750 acl_check_data:
5751 .endd
5752 This line marks the start of the second ACL, and names it. Most of the contents
5753 of this ACL are commented out:
5754 .code
5755 # deny    malware   = *
5756 #         message   = This message contains a virus \
5757 #                     ($malware_name).
5758 .endd
5759 These lines are examples of how to arrange for messages to be scanned for
5760 viruses when Exim has been compiled with the content-scanning extension, and a
5761 suitable virus scanner is installed. If the message is found to contain a
5762 virus, it is rejected with the given custom error message.
5763 .code
5764 # warn    spam      = nobody
5765 #         message   = X-Spam_score: $spam_score\n\
5766 #                     X-Spam_score_int: $spam_score_int\n\
5767 #                     X-Spam_bar: $spam_bar\n\
5768 #                     X-Spam_report: $spam_report
5769 .endd
5770 These lines are an example of how to arrange for messages to be scanned by
5771 SpamAssassin when Exim has been compiled with the content-scanning extension,
5772 and SpamAssassin has been installed. The SpamAssassin check is run with
5773 &`nobody`& as its user parameter, and the results are added to the message as a
5774 series of extra header line. In this case, the message is not rejected,
5775 whatever the spam score.
5776 .code
5777 accept
5778 .endd
5779 This final line in the DATA ACL accepts the message unconditionally.
5780
5781
5782 .section "Router configuration" "SECID55"
5783 .cindex "default" "routers"
5784 .cindex "routers" "default"
5785 The router configuration comes next in the default configuration, introduced
5786 by the line
5787 .code
5788 begin routers
5789 .endd
5790 Routers are the modules in Exim that make decisions about where to send
5791 messages. An address is passed to each router in turn, until it is either
5792 accepted, or failed. This means that the order in which you define the routers
5793 matters. Each router is fully described in its own chapter later in this
5794 manual. Here we give only brief overviews.
5795 .code
5796 # domain_literal:
5797 #   driver = ipliteral
5798 #   domains = !+local_domains
5799 #   transport = remote_smtp
5800 .endd
5801 .cindex "domain literal" "default router"
5802 This router is commented out because the majority of sites do not want to
5803 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5804 you uncomment this router, you also need to uncomment the setting of
5805 &%allow_domain_literals%& in the main part of the configuration.
5806 .code
5807 dnslookup:
5808   driver = dnslookup
5809   domains = ! +local_domains
5810   transport = remote_smtp
5811   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5812   no_more
5813 .endd
5814 The first uncommented router handles addresses that do not involve any local
5815 domains. This is specified by the line
5816 .code
5817 domains = ! +local_domains
5818 .endd
5819 The &%domains%& option lists the domains to which this router applies, but the
5820 exclamation mark is a negation sign, so the router is used only for domains
5821 that are not in the domain list called &'local_domains'& (which was defined at
5822 the start of the configuration). The plus sign before &'local_domains'&
5823 indicates that it is referring to a named list. Addresses in other domains are
5824 passed on to the following routers.
5825
5826 The name of the router driver is &(dnslookup)&,
5827 and is specified by the &%driver%& option. Do not be confused by the fact that
5828 the name of this router instance is the same as the name of the driver. The
5829 instance name is arbitrary, but the name set in the &%driver%& option must be
5830 one of the driver modules that is in the Exim binary.
5831
5832 The &(dnslookup)& router routes addresses by looking up their domains in the
5833 DNS in order to obtain a list of hosts to which the address is routed. If the
5834 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5835 specified by the &%transport%& option. If the router does not find the domain
5836 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5837 the address fails and is bounced.
5838
5839 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5840 be entirely ignored. This option is present because a number of cases have been
5841 encountered where MX records in the DNS point to host names
5842 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5843 Completely ignoring these IP addresses causes Exim to fail to route the
5844 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5845 continue to try to deliver the message periodically until the address timed
5846 out.
5847 .code
5848 system_aliases:
5849   driver = redirect
5850   allow_fail
5851   allow_defer
5852   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5853 # user = exim
5854   file_transport = address_file
5855   pipe_transport = address_pipe
5856 .endd
5857 Control reaches this and subsequent routers only for addresses in the local
5858 domains. This router checks to see whether the local part is defined as an
5859 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5860 data that it looks up from that file. If no data is found for the local part,
5861 the value of the &%data%& option is empty, causing the address to be passed to
5862 the next router.
5863
5864 &_/etc/aliases_& is a conventional name for the system aliases file that is
5865 often used. That is why it is referenced by from the default configuration
5866 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5867 &_Local/Makefile_& before building Exim.
5868 .code
5869 userforward:
5870   driver = redirect
5871   check_local_user
5872 # local_part_suffix = +* : -*
5873 # local_part_suffix_optional
5874   file = $home/.forward
5875 # allow_filter
5876   no_verify
5877   no_expn
5878   check_ancestor
5879   file_transport = address_file
5880   pipe_transport = address_pipe
5881   reply_transport = address_reply
5882 .endd
5883 This is the most complicated router in the default configuration. It is another
5884 redirection router, but this time it is looking for forwarding data set up by
5885 individual users. The &%check_local_user%& setting specifies a check that the
5886 local part of the address is the login name of a local user. If it is not, the
5887 router is skipped. The two commented options that follow &%check_local_user%&,
5888 namely:
5889 .code
5890 # local_part_suffix = +* : -*
5891 # local_part_suffix_optional
5892 .endd
5893 .vindex "&$local_part_suffix$&"
5894 show how you can specify the recognition of local part suffixes. If the first
5895 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5896 by any sequence of characters, is removed from the local part and placed in the
5897 variable &$local_part_suffix$&. The second suffix option specifies that the
5898 presence of a suffix in the local part is optional. When a suffix is present,
5899 the check for a local login uses the local part with the suffix removed.
5900
5901 When a local user account is found, the file called &_.forward_& in the user's
5902 home directory is consulted. If it does not exist, or is empty, the router
5903 declines. Otherwise, the contents of &_.forward_& are interpreted as
5904 redirection data (see chapter &<<CHAPredirect>>& for more details).
5905
5906 .cindex "Sieve filter" "enabling in default router"
5907 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5908 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5909 is commented out by default), the contents of the file are interpreted as a set
5910 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5911 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5912 separate document entitled &'Exim's interfaces to mail filtering'&.
5913
5914 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5915 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5916 There are two reasons for doing this:
5917
5918 .olist
5919 Whether or not a local user has a &_.forward_& file is not really relevant when
5920 checking an address for validity; it makes sense not to waste resources doing
5921 unnecessary work.
5922 .next
5923 More importantly, when Exim is verifying addresses or handling an EXPN
5924 command during an SMTP session, it is running as the Exim user, not as root.
5925 The group is the Exim group, and no additional groups are set up.
5926 It may therefore not be possible for Exim to read users' &_.forward_& files at
5927 this time.
5928 .endlist
5929
5930 The setting of &%check_ancestor%& prevents the router from generating a new
5931 address that is the same as any previous address that was redirected. (This
5932 works round a problem concerning a bad interaction between aliasing and
5933 forwarding &-- see section &<<SECTredlocmai>>&).
5934
5935 The final three option settings specify the transports that are to be used when
5936 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5937 auto-reply, respectively. For example, if a &_.forward_& file contains
5938 .code
5939 a.nother@elsewhere.example, /home/spqr/archive
5940 .endd
5941 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5942 transport.
5943 .code
5944 localuser:
5945   driver = accept
5946   check_local_user
5947 # local_part_suffix = +* : -*
5948 # local_part_suffix_optional
5949   transport = local_delivery
5950 .endd
5951 The final router sets up delivery into local mailboxes, provided that the local
5952 part is the name of a local login, by accepting the address and assigning it to
5953 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5954 routers, so the address is bounced. The commented suffix settings fulfil the
5955 same purpose as they do for the &(userforward)& router.
5956
5957
5958 .section "Transport configuration" "SECID56"
5959 .cindex "default" "transports"
5960 .cindex "transports" "default"
5961 Transports define mechanisms for actually delivering messages. They operate
5962 only when referenced from routers, so the order in which they are defined does
5963 not matter. The transports section of the configuration starts with
5964 .code
5965 begin transports
5966 .endd
5967 One remote transport and four local transports are defined.
5968 .code
5969 remote_smtp:
5970   driver = smtp
5971 .endd
5972 This transport is used for delivering messages over SMTP connections. All its
5973 options are defaulted. The list of remote hosts comes from the router.
5974 .code
5975 local_delivery:
5976   driver = appendfile
5977   file = /var/mail/$local_part
5978   delivery_date_add
5979   envelope_to_add
5980   return_path_add
5981 # group = mail
5982 # mode = 0660
5983 .endd
5984 This &(appendfile)& transport is used for local delivery to user mailboxes in
5985 traditional BSD mailbox format. By default it runs under the uid and gid of the
5986 local user, which requires the sticky bit to be set on the &_/var/mail_&
5987 directory. Some systems use the alternative approach of running mail deliveries
5988 under a particular group instead of using the sticky bit. The commented options
5989 show how this can be done.
5990
5991 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
5992 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
5993 similarly-named options above.
5994 .code
5995 address_pipe:
5996   driver = pipe
5997   return_output
5998 .endd
5999 This transport is used for handling deliveries to pipes that are generated by
6000 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6001 option specifies that any output generated by the pipe is to be returned to the
6002 sender.
6003 .code
6004 address_file:
6005   driver = appendfile
6006   delivery_date_add
6007   envelope_to_add
6008   return_path_add
6009 .endd
6010 This transport is used for handling deliveries to files that are generated by
6011 redirection. The name of the file is not specified in this instance of
6012 &(appendfile)&, because it comes from the &(redirect)& router.
6013 .code
6014 address_reply:
6015   driver = autoreply
6016 .endd
6017 This transport is used for handling automatic replies generated by users'
6018 filter files.
6019
6020
6021
6022 .section "Default retry rule" "SECID57"
6023 .cindex "retry" "default rule"
6024 .cindex "default" "retry rule"
6025 The retry section of the configuration file contains rules which affect the way
6026 Exim retries deliveries that cannot be completed at the first attempt. It is
6027 introduced by the line
6028 .code
6029 begin retry
6030 .endd
6031 In the default configuration, there is just one rule, which applies to all
6032 errors:
6033 .code
6034 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6035 .endd
6036 This causes any temporarily failing address to be retried every 15 minutes for
6037 2 hours, then at intervals starting at one hour and increasing by a factor of
6038 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6039 is not delivered after 4 days of temporary failure, it is bounced.
6040
6041 If the retry section is removed from the configuration, or is empty (that is,
6042 if no retry rules are defined), Exim will not retry deliveries. This turns
6043 temporary errors into permanent errors.
6044
6045
6046 .section "Rewriting configuration" "SECID58"
6047 The rewriting section of the configuration, introduced by
6048 .code
6049 begin rewrite
6050 .endd
6051 contains rules for rewriting addresses in messages as they arrive. There are no
6052 rewriting rules in the default configuration file.
6053
6054
6055
6056 .section "Authenticators configuration" "SECTdefconfauth"
6057 .cindex "AUTH" "configuration"
6058 The authenticators section of the configuration, introduced by
6059 .code
6060 begin authenticators
6061 .endd
6062 defines mechanisms for the use of the SMTP AUTH command. The default
6063 configuration file contains two commented-out example authenticators
6064 which support plaintext username/password authentication using the
6065 standard PLAIN mechanism and the traditional but non-standard LOGIN
6066 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6067 to support most MUA software.
6068
6069 The example PLAIN authenticator looks like this:
6070 .code
6071 #PLAIN:
6072 #  driver                  = plaintext
6073 #  server_set_id           = $auth2
6074 #  server_prompts          = :
6075 #  server_condition        = Authentication is not yet configured
6076 #  server_advertise_condition = ${if def:tls_in_cipher }
6077 .endd
6078 And the example LOGIN authenticator looks like this:
6079 .code
6080 #LOGIN:
6081 #  driver                  = plaintext
6082 #  server_set_id           = $auth1
6083 #  server_prompts          = <| Username: | Password:
6084 #  server_condition        = Authentication is not yet configured
6085 #  server_advertise_condition = ${if def:tls_in_cipher }
6086 .endd
6087
6088 The &%server_set_id%& option makes Exim remember the authenticated username
6089 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6090 &%server_prompts%& option configures the &(plaintext)& authenticator so
6091 that it implements the details of the specific authentication mechanism,
6092 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6093 when Exim offers authentication to clients; in the examples, this is only
6094 when TLS or SSL has been started, so to enable the authenticators you also
6095 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6096
6097 The &%server_condition%& setting defines how to verify that the username and
6098 password are correct. In the examples it just produces an error message.
6099 To make the authenticators work, you can use a string expansion
6100 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6101
6102 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6103 usercode and password are in different positions.
6104 Chapter &<<CHAPplaintext>>& covers both.
6105
6106 .ecindex IIDconfiwal
6107
6108
6109
6110 . ////////////////////////////////////////////////////////////////////////////
6111 . ////////////////////////////////////////////////////////////////////////////
6112
6113 .chapter "Regular expressions" "CHAPregexp"
6114
6115 .cindex "regular expressions" "library"
6116 .cindex "PCRE"
6117 Exim supports the use of regular expressions in many of its options. It
6118 uses the PCRE regular expression library; this provides regular expression
6119 matching that is compatible with Perl 5. The syntax and semantics of
6120 regular expressions is discussed in many Perl reference books, and also in
6121 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6122 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6123
6124 The documentation for the syntax and semantics of the regular expressions that
6125 are supported by PCRE is included in the PCRE distribution, and no further
6126 description is included here. The PCRE functions are called from Exim using
6127 the default option settings (that is, with no PCRE options set), except that
6128 the PCRE_CASELESS option is set when the matching is required to be
6129 case-insensitive.
6130
6131 In most cases, when a regular expression is required in an Exim configuration,
6132 it has to start with a circumflex, in order to distinguish it from plain text
6133 or an &"ends with"& wildcard. In this example of a configuration setting, the
6134 second item in the colon-separated list is a regular expression.
6135 .code
6136 domains = a.b.c : ^\\d{3} : *.y.z : ...
6137 .endd
6138 The doubling of the backslash is required because of string expansion that
6139 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6140 of this issue, and a way of avoiding the need for doubling backslashes. The
6141 regular expression that is eventually used in this example contains just one
6142 backslash. The circumflex is included in the regular expression, and has the
6143 normal effect of &"anchoring"& it to the start of the string that is being
6144 matched.
6145
6146 There are, however, two cases where a circumflex is not required for the
6147 recognition of a regular expression: these are the &%match%& condition in a
6148 string expansion, and the &%matches%& condition in an Exim filter file. In
6149 these cases, the relevant string is always treated as a regular expression; if
6150 it does not start with a circumflex, the expression is not anchored, and can
6151 match anywhere in the subject string.
6152
6153 In all cases, if you want a regular expression to match at the end of a string,
6154 you must code the $ metacharacter to indicate this. For example:
6155 .code
6156 domains = ^\\d{3}\\.example
6157 .endd
6158 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6159 You need to use:
6160 .code
6161 domains = ^\\d{3}\\.example\$
6162 .endd
6163 if you want &'example'& to be the top-level domain. The backslash before the
6164 $ is needed because string expansion also interprets dollar characters.
6165
6166
6167
6168 . ////////////////////////////////////////////////////////////////////////////
6169 . ////////////////////////////////////////////////////////////////////////////
6170
6171 .chapter "File and database lookups" "CHAPfdlookup"
6172 .scindex IIDfidalo1 "file" "lookups"
6173 .scindex IIDfidalo2 "database" "lookups"
6174 .cindex "lookup" "description of"
6175 Exim can be configured to look up data in files or databases as it processes
6176 messages. Two different kinds of syntax are used:
6177
6178 .olist
6179 A string that is to be expanded may contain explicit lookup requests. These
6180 cause parts of the string to be replaced by data that is obtained from the
6181 lookup. Lookups of this type are conditional expansion items. Different results
6182 can be defined for the cases of lookup success and failure. See chapter
6183 &<<CHAPexpand>>&, where string expansions are described in detail.
6184 .next
6185 Lists of domains, hosts, and email addresses can contain lookup requests as a
6186 way of avoiding excessively long linear lists. In this case, the data that is
6187 returned by the lookup is often (but not always) discarded; whether the lookup
6188 succeeds or fails is what really counts. These kinds of list are described in
6189 chapter &<<CHAPdomhosaddlists>>&.
6190 .endlist
6191
6192 String expansions, lists, and lookups interact with each other in such a way
6193 that there is no order in which to describe any one of them that does not
6194 involve references to the others. Each of these three chapters makes more sense
6195 if you have read the other two first. If you are reading this for the first
6196 time, be aware that some of it will make a lot more sense after you have read
6197 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6198
6199 .section "Examples of different lookup syntax" "SECID60"
6200 It is easy to confuse the two different kinds of lookup, especially as the
6201 lists that may contain the second kind are always expanded before being
6202 processed as lists. Therefore, they may also contain lookups of the first kind.
6203 Be careful to distinguish between the following two examples:
6204 .code
6205 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6206 domains = lsearch;/some/file
6207 .endd
6208 The first uses a string expansion, the result of which must be a domain list.
6209 No strings have been specified for a successful or a failing lookup; the
6210 defaults in this case are the looked-up data and an empty string, respectively.
6211 The expansion takes place before the string is processed as a list, and the
6212 file that is searched could contain lines like this:
6213 .code
6214 192.168.3.4: domain1:domain2:...
6215 192.168.1.9: domain3:domain4:...
6216 .endd
6217 When the lookup succeeds, the result of the expansion is a list of domains (and
6218 possibly other types of item that are allowed in domain lists).
6219
6220 In the second example, the lookup is a single item in a domain list. It causes
6221 Exim to use a lookup to see if the domain that is being processed can be found
6222 in the file. The file could contains lines like this:
6223 .code
6224 domain1:
6225 domain2:
6226 .endd
6227 Any data that follows the keys is not relevant when checking that the domain
6228 matches the list item.
6229
6230 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6231 Consider a file containing lines like this:
6232 .code
6233 192.168.5.6: lsearch;/another/file
6234 .endd
6235 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6236 first &%domains%& setting above generates the second setting, which therefore
6237 causes a second lookup to occur.
6238
6239 The rest of this chapter describes the different lookup types that are
6240 available. Any of them can be used in any part of the configuration where a
6241 lookup is permitted.
6242
6243
6244 .section "Lookup types" "SECID61"
6245 .cindex "lookup" "types of"
6246 .cindex "single-key lookup" "definition of"
6247 Two different types of data lookup are implemented:
6248
6249 .ilist
6250 The &'single-key'& type requires the specification of a file in which to look,
6251 and a single key to search for. The key must be a non-empty string for the
6252 lookup to succeed. The lookup type determines how the file is searched.
6253 .next
6254 .cindex "query-style lookup" "definition of"
6255 The &'query-style'& type accepts a generalized database query. No particular
6256 key value is assumed by Exim for query-style lookups. You can use whichever
6257 Exim variables you need to construct the database query.
6258 .endlist
6259
6260 The code for each lookup type is in a separate source file that is included in
6261 the binary of Exim only if the corresponding compile-time option is set. The
6262 default settings in &_src/EDITME_& are:
6263 .code
6264 LOOKUP_DBM=yes
6265 LOOKUP_LSEARCH=yes
6266 .endd
6267 which means that only linear searching and DBM lookups are included by default.
6268 For some types of lookup (e.g. SQL databases), you need to install appropriate
6269 libraries and header files before building Exim.
6270
6271
6272
6273
6274 .section "Single-key lookup types" "SECTsinglekeylookups"
6275 .cindex "lookup" "single-key types"
6276 .cindex "single-key lookup" "list of types"
6277 The following single-key lookup types are implemented:
6278
6279 .ilist
6280 .cindex "cdb" "description of"
6281 .cindex "lookup" "cdb"
6282 .cindex "binary zero" "in lookup key"
6283 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6284 string without a terminating binary zero. The cdb format is designed for
6285 indexed files that are read frequently and never updated, except by total
6286 re-creation. As such, it is particularly suitable for large files containing
6287 aliases or other indexed data referenced by an MTA. Information about cdb can
6288 be found in several places:
6289 .display
6290 &url(http://www.pobox.com/~djb/cdb.html)
6291 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6292 &url(http://packages.debian.org/stable/utils/freecdb.html)
6293 .endd
6294 A cdb distribution is not needed in order to build Exim with cdb support,
6295 because the code for reading cdb files is included directly in Exim itself.
6296 However, no means of building or testing cdb files is provided with Exim, so
6297 you need to obtain a cdb distribution in order to do this.
6298 .next
6299 .cindex "DBM" "lookup type"
6300 .cindex "lookup" "dbm"
6301 .cindex "binary zero" "in lookup key"
6302 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6303 DBM file by looking up the record with the given key. A terminating binary
6304 zero is included in the key that is passed to the DBM library. See section
6305 &<<SECTdb>>& for a discussion of DBM libraries.
6306
6307 .cindex "Berkeley DB library" "file format"
6308 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6309 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6310 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6311 the DB_UNKNOWN option. This enables it to handle any of the types of database
6312 that the library supports, and can be useful for accessing DBM files created by
6313 other applications. (For earlier DB versions, DB_HASH is always used.)
6314 .next
6315 .cindex "lookup" "dbmjz"
6316 .cindex "lookup" "dbm &-- embedded NULs"
6317 .cindex "sasldb2"
6318 .cindex "dbmjz lookup type"
6319 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6320 interpreted as an Exim list; the elements of the list are joined together with
6321 ASCII NUL characters to form the lookup key.  An example usage would be to
6322 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6323 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6324 &(cram_md5)& authenticator.
6325 .next
6326 .cindex "lookup" "dbmnz"
6327 .cindex "lookup" "dbm &-- terminating zero"
6328 .cindex "binary zero" "in lookup key"
6329 .cindex "Courier"
6330 .cindex "&_/etc/userdbshadow.dat_&"
6331 .cindex "dbmnz lookup type"
6332 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6333 is not included in the key that is passed to the DBM library. You may need this
6334 if you want to look up data in files that are created by or shared with some
6335 other application that does not use terminating zeros. For example, you need to
6336 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6337 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6338 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6339 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6340 .next
6341 .cindex "lookup" "dsearch"
6342 .cindex "dsearch lookup type"
6343 &(dsearch)&: The given file must be a directory; this is searched for an entry
6344 whose name is the key by calling the &[lstat()]& function. The key may not
6345 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6346 the lookup is the name of the entry, which may be a file, directory,
6347 symbolic link, or any other kind of directory entry. An example of how this
6348 lookup can be used to support virtual domains is given in section
6349 &<<SECTvirtualdomains>>&.
6350 .next
6351 .cindex "lookup" "iplsearch"
6352 .cindex "iplsearch lookup type"
6353 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6354 terminated by a colon or white space or the end of the line. The keys in the
6355 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6356 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6357 being interpreted as a key terminator. For example:
6358 .code
6359 1.2.3.4:           data for 1.2.3.4
6360 192.168.0.0/16:    data for 192.168.0.0/16
6361 "abcd::cdab":      data for abcd::cdab
6362 "abcd:abcd::/32"   data for abcd:abcd::/32
6363 .endd
6364 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6365 file is searched linearly, using the CIDR masks where present, until a matching
6366 key is found. The first key that matches is used; there is no attempt to find a
6367 &"best"& match. Apart from the way the keys are matched, the processing for
6368 &(iplsearch)& is the same as for &(lsearch)&.
6369
6370 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6371 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6372 lookup types support only literal keys.
6373
6374 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6375 the implicit key is the host's IP address rather than its name (see section
6376 &<<SECThoslispatsikey>>&).
6377 .next
6378 .cindex "linear search"
6379 .cindex "lookup" "lsearch"
6380 .cindex "lsearch lookup type"
6381 .cindex "case sensitivity" "in lsearch lookup"
6382 &(lsearch)&: The given file is a text file that is searched linearly for a
6383 line beginning with the search key, terminated by a colon or white space or the
6384 end of the line. The search is case-insensitive; that is, upper and lower case
6385 letters are treated as the same. The first occurrence of the key that is found
6386 in the file is used.
6387
6388 White space between the key and the colon is permitted. The remainder of the
6389 line, with leading and trailing white space removed, is the data. This can be
6390 continued onto subsequent lines by starting them with any amount of white
6391 space, but only a single space character is included in the data at such a
6392 junction. If the data begins with a colon, the key must be terminated by a
6393 colon, for example:
6394 .code
6395 baduser:  :fail:
6396 .endd
6397 Empty lines and lines beginning with # are ignored, even if they occur in the
6398 middle of an item. This is the traditional textual format of alias files. Note
6399 that the keys in an &(lsearch)& file are literal strings. There is no
6400 wildcarding of any kind.
6401
6402 .cindex "lookup" "lsearch &-- colons in keys"
6403 .cindex "white space" "in lsearch key"
6404 In most &(lsearch)& files, keys are not required to contain colons or #
6405 characters, or white space. However, if you need this feature, it is available.
6406 If a key begins with a doublequote character, it is terminated only by a
6407 matching quote (or end of line), and the normal escaping rules apply to its
6408 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6409 quoted keys (exactly as for unquoted keys). There is no special handling of
6410 quotes for the data part of an &(lsearch)& line.
6411
6412 .next
6413 .cindex "NIS lookup type"
6414 .cindex "lookup" "NIS"
6415 .cindex "binary zero" "in lookup key"
6416 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6417 the given key, without a terminating binary zero. There is a variant called
6418 &(nis0)& which does include the terminating binary zero in the key. This is
6419 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6420 aliases; the full map names must be used.
6421
6422 .next
6423 .cindex "wildlsearch lookup type"
6424 .cindex "lookup" "wildlsearch"
6425 .cindex "nwildlsearch lookup type"
6426 .cindex "lookup" "nwildlsearch"
6427 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6428 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6429 the file may be wildcarded. The difference between these two lookup types is
6430 that for &(wildlsearch)&, each key in the file is string-expanded before being
6431 used, whereas for &(nwildlsearch)&, no expansion takes place.
6432
6433 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6434 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6435 file that are regular expressions can be made case-sensitive by the use of
6436 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6437
6438 . ==== As this is a nested list, any displays it contains must be indented
6439 . ==== as otherwise they are too far to the left.
6440
6441 .olist
6442 The string may begin with an asterisk to mean &"ends with"&. For example:
6443 .code
6444     *.a.b.c       data for anything.a.b.c
6445     *fish         data for anythingfish
6446 .endd
6447 .next
6448 The string may begin with a circumflex to indicate a regular expression. For
6449 example, for &(wildlsearch)&:
6450 .code
6451     ^\N\d+\.a\.b\N    data for <digits>.a.b
6452 .endd
6453 Note the use of &`\N`& to disable expansion of the contents of the regular
6454 expression. If you are using &(nwildlsearch)&, where the keys are not
6455 string-expanded, the equivalent entry is:
6456 .code
6457     ^\d+\.a\.b        data for <digits>.a.b
6458 .endd
6459 The case-insensitive flag is set at the start of compiling the regular
6460 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6461 For example, to make the entire pattern case-sensitive:
6462 .code
6463     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6464 .endd
6465
6466 If the regular expression contains white space or colon characters, you must
6467 either quote it (see &(lsearch)& above), or represent these characters in other
6468 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6469 colon. This may be easier than quoting, because if you quote, you have to
6470 escape all the backslashes inside the quotes.
6471
6472 &*Note*&: It is not possible to capture substrings in a regular expression
6473 match for later use, because the results of all lookups are cached. If a lookup
6474 is repeated, the result is taken from the cache, and no actual pattern matching
6475 takes place. The values of all the numeric variables are unset after a
6476 &((n)wildlsearch)& match.
6477
6478 .next
6479 Although I cannot see it being of much use, the general matching function that
6480 is used to implement &((n)wildlsearch)& means that the string may begin with a
6481 lookup name terminated by a semicolon, and followed by lookup data. For
6482 example:
6483 .code
6484     cdb;/some/file  data for keys that match the file
6485 .endd
6486 The data that is obtained from the nested lookup is discarded.
6487 .endlist olist
6488
6489 Keys that do not match any of these patterns are interpreted literally. The
6490 continuation rules for the data are the same as for &(lsearch)&, and keys may
6491 be followed by optional colons.
6492
6493 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6494 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6495 lookup types support only literal keys.
6496 .endlist ilist
6497
6498
6499 .section "Query-style lookup types" "SECID62"
6500 .cindex "lookup" "query-style types"
6501 .cindex "query-style lookup" "list of types"
6502 The supported query-style lookup types are listed below. Further details about
6503 many of them are given in later sections.
6504
6505 .ilist
6506 .cindex "DNS" "as a lookup type"
6507 .cindex "lookup" "DNS"
6508 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6509 are given in the supplied query. The resulting data is the contents of the
6510 records. See section &<<SECTdnsdb>>&.
6511 .next
6512 .cindex "InterBase lookup type"
6513 .cindex "lookup" "InterBase"
6514 &(ibase)&: This does a lookup in an InterBase database.
6515 .next
6516 .cindex "LDAP" "lookup type"
6517 .cindex "lookup" "LDAP"
6518 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6519 returns attributes from a single entry. There is a variant called &(ldapm)&
6520 that permits values from multiple entries to be returned. A third variant
6521 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6522 any attribute values. See section &<<SECTldap>>&.
6523 .next
6524 .cindex "MySQL" "lookup type"
6525 .cindex "lookup" "MySQL"
6526 &(mysql)&: The format of the query is an SQL statement that is passed to a
6527 MySQL database. See section &<<SECTsql>>&.
6528 .next
6529 .cindex "NIS+ lookup type"
6530 .cindex "lookup" "NIS+"
6531 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6532 the field to be returned. See section &<<SECTnisplus>>&.
6533 .next
6534 .cindex "Oracle" "lookup type"
6535 .cindex "lookup" "Oracle"
6536 &(oracle)&: The format of the query is an SQL statement that is passed to an
6537 Oracle database. See section &<<SECTsql>>&.
6538 .next
6539 .cindex "lookup" "passwd"
6540 .cindex "passwd lookup type"
6541 .cindex "&_/etc/passwd_&"
6542 &(passwd)& is a query-style lookup with queries that are just user names. The
6543 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6544 success, the result string is the same as you would get from an &(lsearch)&
6545 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6546 password value. For example:
6547 .code
6548 *:42:42:King Rat:/home/kr:/bin/bash
6549 .endd
6550 .next
6551 .cindex "PostgreSQL lookup type"
6552 .cindex "lookup" "PostgreSQL"
6553 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6554 PostgreSQL database. See section &<<SECTsql>>&.
6555
6556 .next
6557 .cindex "sqlite lookup type"
6558 .cindex "lookup" "sqlite"
6559 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6560 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6561
6562 .next
6563 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6564 not likely to be useful in normal operation.
6565 .next
6566 .cindex "whoson lookup type"
6567 .cindex "lookup" "whoson"
6568 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6569 allows a server to check whether a particular (dynamically allocated) IP
6570 address is currently allocated to a known (trusted) user and, optionally, to
6571 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6572 at one time for &"POP before SMTP"& authentication, but that approach has been
6573 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6574 &"POP before SMTP"& checking using ACL statements such as
6575 .code
6576 require condition = \
6577   ${lookup whoson {$sender_host_address}{yes}{no}}
6578 .endd
6579 The query consists of a single IP address. The value returned is the name of
6580 the authenticated user, which is stored in the variable &$value$&. However, in
6581 this example, the data in &$value$& is not used; the result of the lookup is
6582 one of the fixed strings &"yes"& or &"no"&.
6583 .endlist
6584
6585
6586
6587 .section "Temporary errors in lookups" "SECID63"
6588 .cindex "lookup" "temporary error in"
6589 Lookup functions can return temporary error codes if the lookup cannot be
6590 completed. For example, an SQL or LDAP database might be unavailable. For this
6591 reason, it is not advisable to use a lookup that might do this for critical
6592 options such as a list of local domains.
6593
6594 When a lookup cannot be completed in a router or transport, delivery
6595 of the message (to the relevant address) is deferred, as for any other
6596 temporary error. In other circumstances Exim may assume the lookup has failed,
6597 or may give up altogether.
6598
6599
6600
6601 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6602 .cindex "wildcard lookups"
6603 .cindex "lookup" "default values"
6604 .cindex "lookup" "wildcard"
6605 .cindex "lookup" "* added to type"
6606 .cindex "default" "in single-key lookups"
6607 In this context, a &"default value"& is a value specified by the administrator
6608 that is to be used if a lookup fails.
6609
6610 &*Note:*& This section applies only to single-key lookups. For query-style
6611 lookups, the facilities of the query language must be used. An attempt to
6612 specify a default for a query-style lookup provokes an error.
6613
6614 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6615 and the initial lookup fails, the key &"*"& is looked up in the file to
6616 provide a default value. See also the section on partial matching below.
6617
6618 .cindex "*@ with single-key lookup"
6619 .cindex "lookup" "*@ added to type"
6620 .cindex "alias file" "per-domain default"
6621 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6622 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6623 character, a second lookup is done with everything before the last @ replaced
6624 by *. This makes it possible to provide per-domain defaults in alias files
6625 that include the domains in the keys. If the second lookup fails (or doesn't
6626 take place because there is no @ in the key), &"*"& is looked up.
6627 For example, a &(redirect)& router might contain:
6628 .code
6629 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6630 .endd
6631 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6632 looks up these keys, in this order:
6633 .code
6634 jane@eyre.example
6635 *@eyre.example
6636 *
6637 .endd
6638 The data is taken from whichever key it finds first. &*Note*&: In an
6639 &(lsearch)& file, this does not mean the first of these keys in the file. A
6640 complete scan is done for each key, and only if it is not found at all does
6641 Exim move on to try the next key.
6642
6643
6644
6645 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6646 .cindex "partial matching"
6647 .cindex "wildcard lookups"
6648 .cindex "lookup" "partial matching"
6649 .cindex "lookup" "wildcard"
6650 .cindex "asterisk" "in search type"
6651 The normal operation of a single-key lookup is to search the file for an exact
6652 match with the given key. However, in a number of situations where domains are
6653 being looked up, it is useful to be able to do partial matching. In this case,
6654 information in the file that has a key starting with &"*."& is matched by any
6655 domain that ends with the components that follow the full stop. For example, if
6656 a key in a DBM file is
6657 .code
6658 *.dates.fict.example
6659 .endd
6660 then when partial matching is enabled this is matched by (amongst others)
6661 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6662 by &'dates.fict.example'&, if that does not appear as a separate key in the
6663 file.
6664
6665 &*Note*&: Partial matching is not available for query-style lookups. It is
6666 also not available for any lookup items in address lists (see section
6667 &<<SECTaddresslist>>&).
6668
6669 Partial matching is implemented by doing a series of separate lookups using
6670 keys constructed by modifying the original subject key. This means that it can
6671 be used with any of the single-key lookup types, provided that
6672 partial matching keys
6673 beginning with a special prefix (default &"*."&) are included in the data file.
6674 Keys in the file that do not begin with the prefix are matched only by
6675 unmodified subject keys when partial matching is in use.
6676
6677 Partial matching is requested by adding the string &"partial-"& to the front of
6678 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6679 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6680 is added at the start of the subject key, and it is looked up again. If that
6681 fails, further lookups are tried with dot-separated components removed from the
6682 start of the subject key, one-by-one, and &"*."& added on the front of what
6683 remains.
6684
6685 A minimum number of two non-* components are required. This can be adjusted
6686 by including a number before the hyphen in the search type. For example,
6687 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6688 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6689 subject key is &'2250.dates.fict.example'& then the following keys are looked
6690 up when the minimum number of non-* components is two:
6691 .code
6692 2250.dates.fict.example
6693 *.2250.dates.fict.example
6694 *.dates.fict.example
6695 *.fict.example
6696 .endd
6697 As soon as one key in the sequence is successfully looked up, the lookup
6698 finishes.
6699
6700 .cindex "lookup" "partial matching &-- changing prefix"
6701 .cindex "prefix" "for partial matching"
6702 The use of &"*."& as the partial matching prefix is a default that can be
6703 changed. The motivation for this feature is to allow Exim to operate with file
6704 formats that are used by other MTAs. A different prefix can be supplied in
6705 parentheses instead of the hyphen after &"partial"&. For example:
6706 .code
6707 domains = partial(.)lsearch;/some/file
6708 .endd
6709 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6710 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6711 components is unchanged). The prefix may consist of any punctuation characters
6712 other than a closing parenthesis. It may be empty, for example:
6713 .code
6714 domains = partial1()cdb;/some/file
6715 .endd
6716 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6717 &`a.b.c`&, &`b.c`&, and &`c`&.
6718
6719 If &"partial0"& is specified, what happens at the end (when the lookup with
6720 just one non-wild component has failed, and the original key is shortened right
6721 down to the null string) depends on the prefix:
6722
6723 .ilist
6724 If the prefix has zero length, the whole lookup fails.
6725 .next
6726 If the prefix has length 1, a lookup for just the prefix is done. For
6727 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6728 .next
6729 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6730 remainder is looked up. With the default prefix, therefore, the final lookup is
6731 for &"*"& on its own.
6732 .next
6733 Otherwise, the whole prefix is looked up.
6734 .endlist
6735
6736
6737 If the search type ends in &"*"& or &"*@"& (see section
6738 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6739 this implies happens after all partial lookups have failed. If &"partial0"& is
6740 specified, adding &"*"& to the search type has no effect with the default
6741 prefix, because the &"*"& key is already included in the sequence of partial
6742 lookups. However, there might be a use for lookup types such as
6743 &"partial0(.)lsearch*"&.
6744
6745 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6746 in domain lists and the like. Partial matching works only in terms of
6747 dot-separated components; a key such as &`*fict.example`&
6748 in a database file is useless, because the asterisk in a partial matching
6749 subject key is always followed by a dot.
6750
6751
6752
6753
6754 .section "Lookup caching" "SECID64"
6755 .cindex "lookup" "caching"
6756 .cindex "caching" "lookup data"
6757 Exim caches all lookup results in order to avoid needless repetition of
6758 lookups. However, because (apart from the daemon) Exim operates as a collection
6759 of independent, short-lived processes, this caching applies only within a
6760 single Exim process. There is no inter-process lookup caching facility.
6761
6762 For single-key lookups, Exim keeps the relevant files open in case there is
6763 another lookup that needs them. In some types of configuration this can lead to
6764 many files being kept open for messages with many recipients. To avoid hitting
6765 the operating system limit on the number of simultaneously open files, Exim
6766 closes the least recently used file when it needs to open more files than its
6767 own internal limit, which can be changed via the &%lookup_open_max%& option.
6768
6769 The single-key lookup files are closed and the lookup caches are flushed at
6770 strategic points during delivery &-- for example, after all routing is
6771 complete.
6772
6773
6774
6775
6776 .section "Quoting lookup data" "SECID65"
6777 .cindex "lookup" "quoting"
6778 .cindex "quoting" "in lookups"
6779 When data from an incoming message is included in a query-style lookup, there
6780 is the possibility of special characters in the data messing up the syntax of
6781 the query. For example, a NIS+ query that contains
6782 .code
6783 [name=$local_part]
6784 .endd
6785 will be broken if the local part happens to contain a closing square bracket.
6786 For NIS+, data can be enclosed in double quotes like this:
6787 .code
6788 [name="$local_part"]
6789 .endd
6790 but this still leaves the problem of a double quote in the data. The rule for
6791 NIS+ is that double quotes must be doubled. Other lookup types have different
6792 rules, and to cope with the differing requirements, an expansion operator
6793 of the following form is provided:
6794 .code
6795 ${quote_<lookup-type>:<string>}
6796 .endd
6797 For example, the safest way to write the NIS+ query is
6798 .code
6799 [name="${quote_nisplus:$local_part}"]
6800 .endd
6801 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6802 operator can be used for all lookup types, but has no effect for single-key
6803 lookups, since no quoting is ever needed in their key strings.
6804
6805
6806
6807
6808 .section "More about dnsdb" "SECTdnsdb"
6809 .cindex "dnsdb lookup"
6810 .cindex "lookup" "dnsdb"
6811 .cindex "DNS" "as a lookup type"
6812 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6813 of a record type and a domain name, separated by an equals sign. For example,
6814 an expansion string could contain:
6815 .code
6816 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6817 .endd
6818 If the lookup succeeds, the result is placed in &$value$&, which in this case
6819 is used on its own as the result. If the lookup does not succeed, the
6820 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6821 &<<SECTforexpfai>>& for an explanation of what this means.
6822
6823 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, and TXT,
6824 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6825 configured). If no type is given, TXT is assumed. When the type is PTR,
6826 the data can be an IP address, written as normal; inversion and the addition of
6827 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6828 .code
6829 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6830 .endd
6831 If the data for a PTR record is not a syntactically valid IP address, it is not
6832 altered and nothing is added.
6833
6834 .cindex "MX record" "in &(dnsdb)& lookup"
6835 .cindex "SRV record" "in &(dnsdb)& lookup"
6836 For an MX lookup, both the preference value and the host name are returned for
6837 each record, separated by a space. For an SRV lookup, the priority, weight,
6838 port, and host name are returned for each record, separated by spaces.
6839
6840 For any record type, if multiple records are found (or, for A6 lookups, if a
6841 single record leads to multiple addresses), the data is returned as a
6842 concatenation, with newline as the default separator. The order, of course,
6843 depends on the DNS resolver. You can specify a different separator character
6844 between multiple records by putting a right angle-bracket followed immediately
6845 by the new separator at the start of the query. For example:
6846 .code
6847 ${lookup dnsdb{>: a=host1.example}}
6848 .endd
6849 It is permitted to specify a space as the separator character. Further
6850 white space is ignored.
6851
6852 .cindex "TXT record" "in &(dnsdb)& lookup"
6853 .cindex "SPF record" "in &(dnsdb)& lookup"
6854 For TXT records with multiple items of data, only the first item is returned,
6855 unless a separator for them is specified using a comma after the separator
6856 character followed immediately by the TXT record item separator. To concatenate
6857 items without a separator, use a semicolon instead. For SPF records the
6858 default behaviour is to concatenate multiple items without using a separator.
6859 .code
6860 ${lookup dnsdb{>\n,: txt=a.b.example}}
6861 ${lookup dnsdb{>\n; txt=a.b.example}}
6862 ${lookup dnsdb{spf=example.org}}
6863 .endd
6864 It is permitted to specify a space as the separator character. Further
6865 white space is ignored.
6866
6867 .section "Pseudo dnsdb record types" "SECID66"
6868 .cindex "MX record" "in &(dnsdb)& lookup"
6869 By default, both the preference value and the host name are returned for
6870 each MX record, separated by a space. If you want only host names, you can use
6871 the pseudo-type MXH:
6872 .code
6873 ${lookup dnsdb{mxh=a.b.example}}
6874 .endd
6875 In this case, the preference values are omitted, and just the host names are
6876 returned.
6877
6878 .cindex "name server for enclosing domain"
6879 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6880 records on the given domain, but if none are found, it removes the first
6881 component of the domain name, and tries again. This process continues until NS
6882 records are found or there are no more components left (or there is a DNS
6883 error). In other words, it may return the name servers for a top-level domain,
6884 but it never returns the root name servers. If there are no NS records for the
6885 top-level domain, the lookup fails. Consider these examples:
6886 .code
6887 ${lookup dnsdb{zns=xxx.quercite.com}}
6888 ${lookup dnsdb{zns=xxx.edu}}
6889 .endd
6890 Assuming that in each case there are no NS records for the full domain name,
6891 the first returns the name servers for &%quercite.com%&, and the second returns
6892 the name servers for &%edu%&.
6893
6894 You should be careful about how you use this lookup because, unless the
6895 top-level domain does not exist, the lookup always returns some host names. The
6896 sort of use to which this might be put is for seeing if the name servers for a
6897 given domain are on a blacklist. You can probably assume that the name servers
6898 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6899 such a list.
6900
6901 .cindex "CSA" "in &(dnsdb)& lookup"
6902 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6903 records according to the CSA rules, which are described in section
6904 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6905 not sufficient because of the extra parent domain search behaviour of CSA. The
6906 result of a successful lookup such as:
6907 .code
6908 ${lookup dnsdb {csa=$sender_helo_name}}
6909 .endd
6910 has two space-separated fields: an authorization code and a target host name.
6911 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6912 authorization required but absent, or &"?"& for unknown.
6913
6914 .cindex "A+" "in &(dnsdb)& lookup"
6915 The pseudo-type A+ performs an A6 lookup (if configured) followed by an AAAA
6916 and then an A lookup.  All results are returned; defer processing
6917 (see below) is handled separately for each lookup.  Example:
6918 .code
6919 ${lookup dnsdb {>; a+=$sender_helo_name}}
6920 .endd
6921
6922
6923 .section "Multiple dnsdb lookups" "SECID67"
6924 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6925 However, you can specify a list of domains or IP addresses in a single
6926 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6927 the default separator, but with the ability to change this. For example:
6928 .code
6929 ${lookup dnsdb{one.domain.com:two.domain.com}}
6930 ${lookup dnsdb{a=one.host.com:two.host.com}}
6931 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6932 .endd
6933 In order to retain backwards compatibility, there is one special case: if
6934 the lookup type is PTR and no change of separator is specified, Exim looks
6935 to see if the rest of the string is precisely one IPv6 address. In this
6936 case, it does not treat it as a list.
6937
6938 The data from each lookup is concatenated, with newline separators by default,
6939 in the same way that multiple DNS records for a single item are handled. A
6940 different separator can be specified, as described above.
6941
6942 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6943 temporary DNS error for any of them, the behaviour is controlled by
6944 an optional keyword followed by a comma that may appear before the record
6945 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6946 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6947 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6948 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6949 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6950 error causes the whole lookup to defer only if none of the other lookups
6951 succeed. The default is &"lax"&, so the following lookups are equivalent:
6952 .code
6953 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6954 ${lookup dnsdb{a=one.host.com:two.host.com}}
6955 .endd
6956 Thus, in the default case, as long as at least one of the DNS lookups
6957 yields some data, the lookup succeeds.
6958
6959
6960
6961
6962 .section "More about LDAP" "SECTldap"
6963 .cindex "LDAP" "lookup, more about"
6964 .cindex "lookup" "LDAP"
6965 .cindex "Solaris" "LDAP"
6966 The original LDAP implementation came from the University of Michigan; this has
6967 become &"Open LDAP"&, and there are now two different releases. Another
6968 implementation comes from Netscape, and Solaris 7 and subsequent releases
6969 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
6970 the lookup function level, their error handling is different. For this reason
6971 it is necessary to set a compile-time variable when building Exim with LDAP, to
6972 indicate which LDAP library is in use. One of the following should appear in
6973 your &_Local/Makefile_&:
6974 .code
6975 LDAP_LIB_TYPE=UMICHIGAN
6976 LDAP_LIB_TYPE=OPENLDAP1
6977 LDAP_LIB_TYPE=OPENLDAP2
6978 LDAP_LIB_TYPE=NETSCAPE
6979 LDAP_LIB_TYPE=SOLARIS
6980 .endd
6981 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
6982 same interface as the University of Michigan version.
6983
6984 There are three LDAP lookup types in Exim. These behave slightly differently in
6985 the way they handle the results of a query:
6986
6987 .ilist
6988 &(ldap)& requires the result to contain just one entry; if there are more, it
6989 gives an error.
6990 .next
6991 &(ldapdn)& also requires the result to contain just one entry, but it is the
6992 Distinguished Name that is returned rather than any attribute values.
6993 .next
6994 &(ldapm)& permits the result to contain more than one entry; the attributes
6995 from all of them are returned.
6996 .endlist
6997
6998
6999 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7000 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7001 the data returned by a successful lookup is described in the next section.
7002 First we explain how LDAP queries are coded.
7003
7004
7005 .section "Format of LDAP queries" "SECTforldaque"
7006 .cindex "LDAP" "query format"
7007 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7008 the configuration of a &(redirect)& router one might have this setting:
7009 .code
7010 data = ${lookup ldap \
7011   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7012   c=UK?mailbox?base?}}
7013 .endd
7014 .cindex "LDAP" "with TLS"
7015 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7016 secure (encrypted) LDAP connections. The second of these ensures that an
7017 encrypted TLS connection is used.
7018
7019 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7020 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7021 See the &%ldap_start_tls%& option.
7022
7023
7024 .section "LDAP quoting" "SECID68"
7025 .cindex "LDAP" "quoting"
7026 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7027 and the second because the LDAP query is represented as a URL. Furthermore,
7028 within an LDAP query, two different kinds of quoting are required. For this
7029 reason, there are two different LDAP-specific quoting operators.
7030
7031 The &%quote_ldap%& operator is designed for use on strings that are part of
7032 filter specifications. Conceptually, it first does the following conversions on
7033 the string:
7034 .code
7035 *   =>   \2A
7036 (   =>   \28
7037 )   =>   \29
7038 \   =>   \5C
7039 .endd
7040 in accordance with RFC 2254. The resulting string is then quoted according
7041 to the rules for URLs, that is, all non-alphanumeric characters except
7042 .code
7043 ! $ ' - . _ ( ) * +
7044 .endd
7045 are converted to their hex values, preceded by a percent sign. For example:
7046 .code
7047 ${quote_ldap: a(bc)*, a<yz>; }
7048 .endd
7049 yields
7050 .code
7051 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7052 .endd
7053 Removing the URL quoting, this is (with a leading and a trailing space):
7054 .code
7055 a\28bc\29\2A, a<yz>;
7056 .endd
7057 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7058 base DN specifications in queries. Conceptually, it first converts the string
7059 by inserting a backslash in front of any of the following characters:
7060 .code
7061 , + " \ < > ;
7062 .endd
7063 It also inserts a backslash before any leading spaces or # characters, and
7064 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7065 is then quoted according to the rules for URLs. For example:
7066 .code
7067 ${quote_ldap_dn: a(bc)*, a<yz>; }
7068 .endd
7069 yields
7070 .code
7071 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7072 .endd
7073 Removing the URL quoting, this is (with a trailing space):
7074 .code
7075 \ a(bc)*\, a\<yz\>\;\
7076 .endd
7077 There are some further comments about quoting in the section on LDAP
7078 authentication below.
7079
7080
7081 .section "LDAP connections" "SECID69"
7082 .cindex "LDAP" "connections"
7083 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7084 is in use, via a Unix domain socket. The example given above does not specify
7085 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7086 by starting it with
7087 .code
7088 ldap://<hostname>:<port>/...
7089 .endd
7090 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7091 used. When no server is specified in a query, a list of default servers is
7092 taken from the &%ldap_default_servers%& configuration option. This supplies a
7093 colon-separated list of servers which are tried in turn until one successfully
7094 handles a query, or there is a serious error. Successful handling either
7095 returns the requested data, or indicates that it does not exist. Serious errors
7096 are syntactical, or multiple values when only a single value is expected.
7097 Errors which cause the next server to be tried are connection failures, bind
7098 failures, and timeouts.
7099
7100 For each server name in the list, a port number can be given. The standard way
7101 of specifying a host and port is to use a colon separator (RFC 1738). Because
7102 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7103 doubled. For example
7104 .code
7105 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7106 .endd
7107 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7108 to the LDAP library with no server name, and the library's default (normally
7109 the local host) is used.
7110
7111 If you are using the OpenLDAP library, you can connect to an LDAP server using
7112 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7113 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7114 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7115 not available.
7116
7117 For this type of connection, instead of a host name for the server, a pathname
7118 for the socket is required, and the port number is not relevant. The pathname
7119 can be specified either as an item in &%ldap_default_servers%&, or inline in
7120 the query. In the former case, you can have settings such as
7121 .code
7122 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7123 .endd
7124 When the pathname is given in the query, you have to escape the slashes as
7125 &`%2F`& to fit in with the LDAP URL syntax. For example:
7126 .code
7127 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7128 .endd
7129 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7130 a pathname, it uses the Unix domain socket code, even if the query actually
7131 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7132 socket connection. This behaviour means that you can use a setting of
7133 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7134 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7135 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7136 backup host.
7137
7138 If an explicit &`ldapi`& type is given in a query when a host name is
7139 specified, an error is diagnosed. However, if there are more items in
7140 &%ldap_default_servers%&, they are tried. In other words:
7141
7142 .ilist
7143 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7144 interface.
7145 .next
7146 Using &`ldapi`& with a host name causes an error.
7147 .endlist
7148
7149
7150 Using &`ldapi`& with no host or path in the query, and no setting of
7151 &%ldap_default_servers%&, does whatever the library does by default.
7152
7153
7154
7155 .section "LDAP authentication and control information" "SECID70"
7156 .cindex "LDAP" "authentication"
7157 The LDAP URL syntax provides no way of passing authentication and other control
7158 information to the server. To make this possible, the URL in an LDAP query may
7159 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7160 spaces. If a value contains spaces it must be enclosed in double quotes, and
7161 when double quotes are used, backslash is interpreted in the usual way inside
7162 them. The following names are recognized:
7163 .display
7164 &`DEREFERENCE`&  set the dereferencing parameter
7165 &`NETTIME    `&  set a timeout for a network operation
7166 &`USER       `&  set the DN, for authenticating the LDAP bind
7167 &`PASS       `&  set the password, likewise
7168 &`REFERRALS  `&  set the referrals parameter
7169 &`SIZE       `&  set the limit for the number of entries returned
7170 &`TIME       `&  set the maximum waiting time for a query
7171 .endd
7172 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7173 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7174 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7175 library from trying to follow referrals issued by the LDAP server.
7176
7177 The name CONNECT is an obsolete name for NETTIME, retained for
7178 backwards compatibility. This timeout (specified as a number of seconds) is
7179 enforced from the client end for operations that can be carried out over a
7180 network. Specifically, it applies to network connections and calls to the
7181 &'ldap_result()'& function. If the value is greater than zero, it is used if
7182 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7183 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7184 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7185 Netscape SDK; for OpenLDAP no action is taken.
7186
7187 The TIME parameter (also a number of seconds) is passed to the server to
7188 set a server-side limit on the time taken to complete a search.
7189
7190
7191 Here is an example of an LDAP query in an Exim lookup that uses some of these
7192 values. This is a single line, folded to fit on the page:
7193 .code
7194 ${lookup ldap
7195   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7196   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7197   {$value}fail}
7198 .endd
7199 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7200 any of the auxiliary data. Exim configuration settings that include lookups
7201 which contain password information should be preceded by &"hide"& to prevent
7202 non-admin users from using the &%-bP%& option to see their values.
7203
7204 The auxiliary data items may be given in any order. The default is no
7205 connection timeout (the system timeout is used), no user or password, no limit
7206 on the number of entries returned, and no time limit on queries.
7207
7208 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7209 removes any URL quoting that it may contain before passing it LDAP. Apparently
7210 some libraries do this for themselves, but some do not. Removing the URL
7211 quoting has two advantages:
7212
7213 .ilist
7214 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7215 DNs as with DNs inside actual queries.
7216 .next
7217 It permits spaces inside USER= DNs.
7218 .endlist
7219
7220 For example, a setting such as
7221 .code
7222 USER=cn=${quote_ldap_dn:$1}
7223 .endd
7224 should work even if &$1$& contains spaces.
7225
7226 Expanded data for the PASS= value should be quoted using the &%quote%&
7227 expansion operator, rather than the LDAP quote operators. The only reason this
7228 field needs quoting is to ensure that it conforms to the Exim syntax, which
7229 does not allow unquoted spaces. For example:
7230 .code
7231 PASS=${quote:$3}
7232 .endd
7233 The LDAP authentication mechanism can be used to check passwords as part of
7234 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7235 &<<CHAPexpand>>&.
7236
7237
7238
7239 .section "Format of data returned by LDAP" "SECID71"
7240 .cindex "LDAP" "returned data formats"
7241 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7242 as a sequence of values, for example
7243 .code
7244 cn=manager, o=University of Cambridge, c=UK
7245 .endd
7246 The &(ldap)& lookup type generates an error if more than one entry matches the
7247 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7248 the result between the data from different entries. It is possible for multiple
7249 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7250 you know that whatever values are returned all came from a single entry in the
7251 directory.
7252
7253 In the common case where you specify a single attribute in your LDAP query, the
7254 result is not quoted, and does not contain the attribute name. If the attribute
7255 has multiple values, they are separated by commas.
7256
7257 If you specify multiple attributes, the result contains space-separated, quoted
7258 strings, each preceded by the attribute name and an equals sign. Within the
7259 quotes, the quote character, backslash, and newline are escaped with
7260 backslashes, and commas are used to separate multiple values for the attribute.
7261 Apart from the escaping, the string within quotes takes the same form as the
7262 output when a single attribute is requested. Specifying no attributes is the
7263 same as specifying all of an entry's attributes.
7264
7265 Here are some examples of the output format. The first line of each pair is an
7266 LDAP query, and the second is the data that is returned. The attribute called
7267 &%attr1%& has two values, whereas &%attr2%& has only one value:
7268 .code
7269 ldap:///o=base?attr1?sub?(uid=fred)
7270 value1.1, value1.2
7271
7272 ldap:///o=base?attr2?sub?(uid=fred)
7273 value two
7274
7275 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7276 attr1="value1.1, value1.2" attr2="value two"
7277
7278 ldap:///o=base??sub?(uid=fred)
7279 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7280 .endd
7281 The &%extract%& operator in string expansions can be used to pick out
7282 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7283 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7284 results of LDAP lookups.
7285
7286
7287
7288
7289 .section "More about NIS+" "SECTnisplus"
7290 .cindex "NIS+ lookup type"
7291 .cindex "lookup" "NIS+"
7292 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7293 and field name. If this is given, the result of a successful query is the
7294 contents of the named field; otherwise the result consists of a concatenation
7295 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7296 values containing spaces are quoted. For example, the query
7297 .code
7298 [name=mg1456],passwd.org_dir
7299 .endd
7300 might return the string
7301 .code
7302 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7303 home=/home/mg1456 shell=/bin/bash shadow=""
7304 .endd
7305 (split over two lines here to fit on the page), whereas
7306 .code
7307 [name=mg1456],passwd.org_dir:gcos
7308 .endd
7309 would just return
7310 .code
7311 Martin Guerre
7312 .endd
7313 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7314 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7315 operator is to double any quote characters within the text.
7316
7317
7318
7319 .section "SQL lookups" "SECTsql"
7320 .cindex "SQL lookup types"
7321 .cindex "MySQL" "lookup type"
7322 .cindex "PostgreSQL lookup type"
7323 .cindex "lookup" "MySQL"
7324 .cindex "lookup" "PostgreSQL"
7325 .cindex "Oracle" "lookup type"
7326 .cindex "lookup" "Oracle"
7327 .cindex "InterBase lookup type"
7328 .cindex "lookup" "InterBase"
7329 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7330 databases. Queries for these databases contain SQL statements, so an example
7331 might be
7332 .code
7333 ${lookup mysql{select mailbox from users where id='userx'}\
7334   {$value}fail}
7335 .endd
7336 If the result of the query contains more than one field, the data for each
7337 field in the row is returned, preceded by its name, so the result of
7338 .code
7339 ${lookup pgsql{select home,name from users where id='userx'}\
7340   {$value}}
7341 .endd
7342 might be
7343 .code
7344 home=/home/userx name="Mister X"
7345 .endd
7346 Empty values and values containing spaces are double quoted, with embedded
7347 quotes escaped by a backslash. If the result of the query contains just one
7348 field, the value is passed back verbatim, without a field name, for example:
7349 .code
7350 Mister X
7351 .endd
7352 If the result of the query yields more than one row, it is all concatenated,
7353 with a newline between the data for each row.
7354
7355
7356 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7357 .cindex "MySQL" "lookup type"
7358 .cindex "PostgreSQL lookup type"
7359 .cindex "lookup" "MySQL"
7360 .cindex "lookup" "PostgreSQL"
7361 .cindex "Oracle" "lookup type"
7362 .cindex "lookup" "Oracle"
7363 .cindex "InterBase lookup type"
7364 .cindex "lookup" "InterBase"
7365 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7366 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7367 option (as appropriate) must be set to a colon-separated list of server
7368 information.
7369 (For MySQL and PostgreSQL only, the global option need not be set if all
7370 queries contain their own server information &-- see section
7371 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7372 items: host name, database name, user name, and password. In the case of
7373 Oracle, the host name field is used for the &"service name"&, and the database
7374 name field is not used and should be empty. For example:
7375 .code
7376 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7377 .endd
7378 Because password data is sensitive, you should always precede the setting with
7379 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7380 option. Here is an example where two MySQL servers are listed:
7381 .code
7382 hide mysql_servers = localhost/users/root/secret:\
7383                      otherhost/users/root/othersecret
7384 .endd
7385 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7386 because this is a colon-separated list, the colon has to be doubled. For each
7387 query, these parameter groups are tried in order until a connection is made and
7388 a query is successfully processed. The result of a query may be that no data is
7389 found, but that is still a successful query. In other words, the list of
7390 servers provides a backup facility, not a list of different places to look.
7391
7392 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7393 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7394 respectively, and the characters single-quote, double-quote, and backslash
7395 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7396 addition, escapes the percent and underscore characters. This cannot be done
7397 for MySQL because these escapes are not recognized in contexts where these
7398 characters are not special.
7399
7400 .section "Specifying the server in the query" "SECTspeserque"
7401 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7402 it is possible to specify a list of servers with an individual query. This is
7403 done by starting the query with
7404 .display
7405 &`servers=`&&'server1:server2:server3:...'&&`;`&
7406 .endd
7407 Each item in the list may take one of two forms:
7408 .olist
7409 If it contains no slashes it is assumed to be just a host name. The appropriate
7410 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7411 of the same name, and the remaining parameters (database, user, password) are
7412 taken from there.
7413 .next
7414 If it contains any slashes, it is taken as a complete parameter set.
7415 .endlist
7416 The list of servers is used in exactly the same way as the global list.
7417 Once a connection to a server has happened and a query has been
7418 successfully executed, processing of the lookup ceases.
7419
7420 This feature is intended for use in master/slave situations where updates
7421 are occurring and you want to update the master rather than a slave. If the
7422 master is in the list as a backup for reading, you might have a global setting
7423 like this:
7424 .code
7425 mysql_servers = slave1/db/name/pw:\
7426                 slave2/db/name/pw:\
7427                 master/db/name/pw
7428 .endd
7429 In an updating lookup, you could then write:
7430 .code
7431 ${lookup mysql{servers=master; UPDATE ...} }
7432 .endd
7433 That query would then be sent only to the master server. If, on the other hand,
7434 the master is not to be used for reading, and so is not present in the global
7435 option, you can still update it by a query of this form:
7436 .code
7437 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7438 .endd
7439
7440
7441 .section "Special MySQL features" "SECID73"
7442 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7443 causes a connection to the server on the local host by means of a Unix domain
7444 socket. An alternate socket can be specified in parentheses. The full syntax of
7445 each item in &%mysql_servers%& is:
7446 .display
7447 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7448   <&'user'&>/<&'password'&>
7449 .endd
7450 Any of the three sub-parts of the first field can be omitted. For normal use on
7451 the local host it can be left blank or set to just &"localhost"&.
7452
7453 No database need be supplied &-- but if it is absent here, it must be given in
7454 the queries.
7455
7456 If a MySQL query is issued that does not request any data (an insert, update,
7457 or delete command), the result of the lookup is the number of rows affected.
7458
7459 &*Warning*&: This can be misleading. If an update does not actually change
7460 anything (for example, setting a field to the value it already has), the result
7461 is zero because no rows are affected.
7462
7463
7464 .section "Special PostgreSQL features" "SECID74"
7465 PostgreSQL lookups can also use Unix domain socket connections to the database.
7466 This is usually faster and costs less CPU time than a TCP/IP connection.
7467 However it can be used only if the mail server runs on the same machine as the
7468 database server. A configuration line for PostgreSQL via Unix domain sockets
7469 looks like this:
7470 .code
7471 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7472 .endd
7473 In other words, instead of supplying a host name, a path to the socket is
7474 given. The path name is enclosed in parentheses so that its slashes aren't
7475 visually confused with the delimiters for the other server parameters.
7476
7477 If a PostgreSQL query is issued that does not request any data (an insert,
7478 update, or delete command), the result of the lookup is the number of rows
7479 affected.
7480
7481 .section "More about SQLite" "SECTsqlite"
7482 .cindex "lookup" "SQLite"
7483 .cindex "sqlite lookup type"
7484 SQLite is different to the other SQL lookups because a file name is required in
7485 addition to the SQL query. An SQLite database is a single file, and there is no
7486 daemon as in the other SQL databases. The interface to Exim requires the name
7487 of the file, as an absolute path, to be given at the start of the query. It is
7488 separated from the query by white space. This means that the path name cannot
7489 contain white space. Here is a lookup expansion example:
7490 .code
7491 ${lookup sqlite {/some/thing/sqlitedb \
7492   select name from aliases where id='userx';}}
7493 .endd
7494 In a list, the syntax is similar. For example:
7495 .code
7496 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7497    select * from relays where ip='$sender_host_address';
7498 .endd
7499 The only character affected by the &%quote_sqlite%& operator is a single
7500 quote, which it doubles.
7501
7502 The SQLite library handles multiple simultaneous accesses to the database
7503 internally. Multiple readers are permitted, but only one process can
7504 update at once. Attempts to access the database while it is being updated
7505 are rejected after a timeout period, during which the SQLite library
7506 waits for the lock to be released. In Exim, the default timeout is set
7507 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7508 option.
7509 .ecindex IIDfidalo1
7510 .ecindex IIDfidalo2
7511
7512
7513 . ////////////////////////////////////////////////////////////////////////////
7514 . ////////////////////////////////////////////////////////////////////////////
7515
7516 .chapter "Domain, host, address, and local part lists" &&&
7517          "CHAPdomhosaddlists" &&&
7518          "Domain, host, and address lists"
7519 .scindex IIDdohoadli "lists of domains; hosts; etc."
7520 A number of Exim configuration options contain lists of domains, hosts,
7521 email addresses, or local parts. For example, the &%hold_domains%& option
7522 contains a list of domains whose delivery is currently suspended. These lists
7523 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7524 arguments to expansion conditions such as &%match_domain%&.
7525
7526 Each item in one of these lists is a pattern to be matched against a domain,
7527 host, email address, or local part, respectively. In the sections below, the
7528 different types of pattern for each case are described, but first we cover some
7529 general facilities that apply to all four kinds of list.
7530
7531
7532
7533 .section "Expansion of lists" "SECID75"
7534 .cindex "expansion" "of lists"
7535 Each list is expanded as a single string before it is used. The result of
7536 expansion must be a list, possibly containing empty items, which is split up
7537 into separate items for matching. By default, colon is the separator character,
7538 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7539 &<<SECTempitelis>>& for details of the list syntax; the second of these
7540 discusses the way to specify empty list items.
7541
7542
7543 If the string expansion is forced to fail, Exim behaves as if the item it is
7544 testing (domain, host, address, or local part) is not in the list. Other
7545 expansion failures cause temporary errors.
7546
7547 If an item in a list is a regular expression, backslashes, dollars and possibly
7548 other special characters in the expression must be protected against
7549 misinterpretation by the string expander. The easiest way to do this is to use
7550 the &`\N`& expansion feature to indicate that the contents of the regular
7551 expression should not be expanded. For example, in an ACL you might have:
7552 .code
7553 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7554                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7555 .endd
7556 The first item is a regular expression that is protected from expansion by
7557 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7558 senders based on the receiving domain.
7559
7560
7561
7562
7563 .section "Negated items in lists" "SECID76"
7564 .cindex "list" "negation"
7565 .cindex "negation" "in lists"
7566 Items in a list may be positive or negative. Negative items are indicated by a
7567 leading exclamation mark, which may be followed by optional white space. A list
7568 defines a set of items (domains, etc). When Exim processes one of these lists,
7569 it is trying to find out whether a domain, host, address, or local part
7570 (respectively) is in the set that is defined by the list. It works like this:
7571
7572 The list is scanned from left to right. If a positive item is matched, the
7573 subject that is being checked is in the set; if a negative item is matched, the
7574 subject is not in the set. If the end of the list is reached without the
7575 subject having matched any of the patterns, it is in the set if the last item
7576 was a negative one, but not if it was a positive one. For example, the list in
7577 .code
7578 domainlist relay_to_domains = !a.b.c : *.b.c
7579 .endd
7580 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7581 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7582 list is positive. However, if the setting were
7583 .code
7584 domainlist relay_to_domains = !a.b.c
7585 .endd
7586 then all domains other than &'a.b.c'& would match because the last item in the
7587 list is negative. In other words, a list that ends with a negative item behaves
7588 as if it had an extra item &`:*`& on the end.
7589
7590 Another way of thinking about positive and negative items in lists is to read
7591 the connector as &"or"& after a positive item and as &"and"& after a negative
7592 item.
7593
7594
7595
7596 .section "File names in lists" "SECTfilnamlis"
7597 .cindex "list" "file name in"
7598 If an item in a domain, host, address, or local part list is an absolute file
7599 name (beginning with a slash character), each line of the file is read and
7600 processed as if it were an independent item in the list, except that further
7601 file names are not allowed,
7602 and no expansion of the data from the file takes place.
7603 Empty lines in the file are ignored, and the file may also contain comment
7604 lines:
7605
7606 .ilist
7607 For domain and host lists, if a # character appears anywhere in a line of the
7608 file, it and all following characters are ignored.
7609 .next
7610 Because local parts may legitimately contain # characters, a comment in an
7611 address list or local part list file is recognized only if # is preceded by
7612 white space or the start of the line. For example:
7613 .code
7614 not#comment@x.y.z   # but this is a comment
7615 .endd
7616 .endlist
7617
7618 Putting a file name in a list has the same effect as inserting each line of the
7619 file as an item in the list (blank lines and comments excepted). However, there
7620 is one important difference: the file is read each time the list is processed,
7621 so if its contents vary over time, Exim's behaviour changes.
7622
7623 If a file name is preceded by an exclamation mark, the sense of any match
7624 within the file is inverted. For example, if
7625 .code
7626 hold_domains = !/etc/nohold-domains
7627 .endd
7628 and the file contains the lines
7629 .code
7630 !a.b.c
7631 *.b.c
7632 .endd
7633 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7634 any domain matching &`*.b.c`& is not.
7635
7636
7637
7638 .section "An lsearch file is not an out-of-line list" "SECID77"
7639 As will be described in the sections that follow, lookups can be used in lists
7640 to provide indexed methods of checking list membership. There has been some
7641 confusion about the way &(lsearch)& lookups work in lists. Because
7642 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7643 sometimes thought that it is allowed to contain wild cards and other kinds of
7644 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7645 always fixed strings, just as for any other single-key lookup type.
7646
7647 If you want to use a file to contain wild-card patterns that form part of a
7648 list, just give the file name on its own, without a search type, as described
7649 in the previous section. You could also use the &(wildlsearch)& or
7650 &(nwildlsearch)&, but there is no advantage in doing this.
7651
7652
7653
7654
7655 .section "Named lists" "SECTnamedlists"
7656 .cindex "named lists"
7657 .cindex "list" "named"
7658 A list of domains, hosts, email addresses, or local parts can be given a name
7659 which is then used to refer to the list elsewhere in the configuration. This is
7660 particularly convenient if the same list is required in several different
7661 places. It also allows lists to be given meaningful names, which can improve
7662 the readability of the configuration. For example, it is conventional to define
7663 a domain list called &'local_domains'& for all the domains that are handled
7664 locally on a host, using a configuration line such as
7665 .code
7666 domainlist local_domains = localhost:my.dom.example
7667 .endd
7668 Named lists are referenced by giving their name preceded by a plus sign, so,
7669 for example, a router that is intended to handle local domains would be
7670 configured with the line
7671 .code
7672 domains = +local_domains
7673 .endd
7674 The first router in a configuration is often one that handles all domains
7675 except the local ones, using a configuration with a negated item like this:
7676 .code
7677 dnslookup:
7678   driver = dnslookup
7679   domains = ! +local_domains
7680   transport = remote_smtp
7681   no_more
7682 .endd
7683 The four kinds of named list are created by configuration lines starting with
7684 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7685 respectively. Then there follows the name that you are defining, followed by an
7686 equals sign and the list itself. For example:
7687 .code
7688 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7689 addresslist bad_senders = cdb;/etc/badsenders
7690 .endd
7691 A named list may refer to other named lists:
7692 .code
7693 domainlist  dom1 = first.example : second.example
7694 domainlist  dom2 = +dom1 : third.example
7695 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7696 .endd
7697 &*Warning*&: If the last item in a referenced list is a negative one, the
7698 effect may not be what you intended, because the negation does not propagate
7699 out to the higher level. For example, consider:
7700 .code
7701 domainlist  dom1 = !a.b
7702 domainlist  dom2 = +dom1 : *.b
7703 .endd
7704 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7705 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7706 means it matches the second list as well. The effect is not the same as
7707 .code
7708 domainlist  dom2 = !a.b : *.b
7709 .endd
7710 where &'x.y'& does not match. It's best to avoid negation altogether in
7711 referenced lists if you can.
7712
7713 Named lists may have a performance advantage. When Exim is routing an
7714 address or checking an incoming message, it caches the result of tests on named
7715 lists. So, if you have a setting such as
7716 .code
7717 domains = +local_domains
7718 .endd
7719 on several of your routers
7720 or in several ACL statements,
7721 the actual test is done only for the first one. However, the caching works only
7722 if there are no expansions within the list itself or any sublists that it
7723 references. In other words, caching happens only for lists that are known to be
7724 the same each time they are referenced.
7725
7726 By default, there may be up to 16 named lists of each type. This limit can be
7727 extended by changing a compile-time variable. The use of domain and host lists
7728 is recommended for concepts such as local domains, relay domains, and relay
7729 hosts. The default configuration is set up like this.
7730
7731
7732
7733 .section "Named lists compared with macros" "SECID78"
7734 .cindex "list" "named compared with macro"
7735 .cindex "macro" "compared with named list"
7736 At first sight, named lists might seem to be no different from macros in the
7737 configuration file. However, macros are just textual substitutions. If you
7738 write
7739 .code
7740 ALIST = host1 : host2
7741 auth_advertise_hosts = !ALIST
7742 .endd
7743 it probably won't do what you want, because that is exactly the same as
7744 .code
7745 auth_advertise_hosts = !host1 : host2
7746 .endd
7747 Notice that the second host name is not negated. However, if you use a host
7748 list, and write
7749 .code
7750 hostlist alist = host1 : host2
7751 auth_advertise_hosts = ! +alist
7752 .endd
7753 the negation applies to the whole list, and so that is equivalent to
7754 .code
7755 auth_advertise_hosts = !host1 : !host2
7756 .endd
7757
7758
7759 .section "Named list caching" "SECID79"
7760 .cindex "list" "caching of named"
7761 .cindex "caching" "named lists"
7762 While processing a message, Exim caches the result of checking a named list if
7763 it is sure that the list is the same each time. In practice, this means that
7764 the cache operates only if the list contains no $ characters, which guarantees
7765 that it will not change when it is expanded. Sometimes, however, you may have
7766 an expanded list that you know will be the same each time within a given
7767 message. For example:
7768 .code
7769 domainlist special_domains = \
7770            ${lookup{$sender_host_address}cdb{/some/file}}
7771 .endd
7772 This provides a list of domains that depends only on the sending host's IP
7773 address. If this domain list is referenced a number of times (for example,
7774 in several ACL lines, or in several routers) the result of the check is not
7775 cached by default, because Exim does not know that it is going to be the
7776 same list each time.
7777
7778 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7779 cache the result anyway. For example:
7780 .code
7781 domainlist_cache special_domains = ${lookup{...
7782 .endd
7783 If you do this, you should be absolutely sure that caching is going to do
7784 the right thing in all cases. When in doubt, leave it out.
7785
7786
7787
7788 .section "Domain lists" "SECTdomainlist"
7789 .cindex "domain list" "patterns for"
7790 .cindex "list" "domain list"
7791 Domain lists contain patterns that are to be matched against a mail domain.
7792 The following types of item may appear in domain lists:
7793
7794 .ilist
7795 .cindex "primary host name"
7796 .cindex "host name" "matched in domain list"
7797 .oindex "&%primary_hostname%&"
7798 .cindex "domain list" "matching primary host name"
7799 .cindex "@ in a domain list"
7800 If a pattern consists of a single @ character, it matches the local host name,
7801 as set by the &%primary_hostname%& option (or defaulted). This makes it
7802 possible to use the same configuration file on several different hosts that
7803 differ only in their names.
7804 .next
7805 .cindex "@[] in a domain list"
7806 .cindex "domain list" "matching local IP interfaces"
7807 .cindex "domain literal"
7808 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7809 in square brackets (as in an email address that contains a domain literal), but
7810 only if that IP address is recognized as local for email routing purposes. The
7811 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7812 control which of a host's several IP addresses are treated as local.
7813 In today's Internet, the use of domain literals is controversial.
7814 .next
7815 .cindex "@mx_any"
7816 .cindex "@mx_primary"
7817 .cindex "@mx_secondary"
7818 .cindex "domain list" "matching MX pointers to local host"
7819 If a pattern consists of the string &`@mx_any`& it matches any domain that
7820 has an MX record pointing to the local host or to any host that is listed in
7821 .oindex "&%hosts_treat_as_local%&"
7822 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7823 are similar, except that the first matches only when a primary MX target is the
7824 local host, and the second only when no primary MX target is the local host,
7825 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7826 preference value &-- there may of course be more than one of them.
7827
7828 The MX lookup that takes place when matching a pattern of this type is
7829 performed with the resolver options for widening names turned off. Thus, for
7830 example, a single-component domain will &'not'& be expanded by adding the
7831 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7832 options of the &(dnslookup)& router for a discussion of domain widening.
7833
7834 Sometimes you may want to ignore certain IP addresses when using one of these
7835 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7836 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7837 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7838 on a router). For example:
7839 .code
7840 domains = @mx_any/ignore=127.0.0.1
7841 .endd
7842 This example matches any domain that has an MX record pointing to one of
7843 the local host's IP addresses other than 127.0.0.1.
7844
7845 The list of IP addresses is in fact processed by the same code that processes
7846 host lists, so it may contain CIDR-coded network specifications and it may also
7847 contain negative items.
7848
7849 Because the list of IP addresses is a sublist within a domain list, you have to
7850 be careful about delimiters if there is more than one address. Like any other
7851 list, the default delimiter can be changed. Thus, you might have:
7852 .code
7853 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7854           an.other.domain : ...
7855 .endd
7856 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7857 involved, it is easiest to change the delimiter for the main list as well:
7858 .code
7859 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7860           an.other.domain ? ...
7861 .endd
7862 .next
7863 .cindex "asterisk" "in domain list"
7864 .cindex "domain list" "asterisk in"
7865 .cindex "domain list" "matching &""ends with""&"
7866 If a pattern starts with an asterisk, the remaining characters of the pattern
7867 are compared with the terminating characters of the domain. The use of &"*"& in
7868 domain lists differs from its use in partial matching lookups. In a domain
7869 list, the character following the asterisk need not be a dot, whereas partial
7870 matching works only in terms of dot-separated components. For example, a domain
7871 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7872 &'cipher.key.ex'&.
7873
7874 .next
7875 .cindex "regular expressions" "in domain list"
7876 .cindex "domain list" "matching regular expression"
7877 If a pattern starts with a circumflex character, it is treated as a regular
7878 expression, and matched against the domain using a regular expression matching
7879 function. The circumflex is treated as part of the regular expression.
7880 Email domains are case-independent, so this regular expression match is by
7881 default case-independent, but you can make it case-dependent by starting it
7882 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7883 are given in chapter &<<CHAPregexp>>&.
7884
7885 &*Warning*&: Because domain lists are expanded before being processed, you
7886 must escape any backslash and dollar characters in the regular expression, or
7887 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7888 it is not to be expanded (unless you really do want to build a regular
7889 expression by expansion, of course).
7890 .next
7891 .cindex "lookup" "in domain list"
7892 .cindex "domain list" "matching by lookup"
7893 If a pattern starts with the name of a single-key lookup type followed by a
7894 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7895 must be a file name in a suitable format for the lookup type. For example, for
7896 &"cdb;"& it must be an absolute path:
7897 .code
7898 domains = cdb;/etc/mail/local_domains.cdb
7899 .endd
7900 The appropriate type of lookup is done on the file using the domain name as the
7901 key. In most cases, the data that is looked up is not used; Exim is interested
7902 only in whether or not the key is present in the file. However, when a lookup
7903 is used for the &%domains%& option on a router
7904 or a &%domains%& condition in an ACL statement, the data is preserved in the
7905 &$domain_data$& variable and can be referred to in other router options or
7906 other statements in the same ACL.
7907
7908 .next
7909 Any of the single-key lookup type names may be preceded by
7910 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7911 .code
7912 domains = partial-dbm;/partial/domains
7913 .endd
7914 This causes partial matching logic to be invoked; a description of how this
7915 works is given in section &<<SECTpartiallookup>>&.
7916
7917 .next
7918 .cindex "asterisk" "in lookup type"
7919 Any of the single-key lookup types may be followed by an asterisk. This causes
7920 a default lookup for a key consisting of a single asterisk to be done if the
7921 original lookup fails. This is not a useful feature when using a domain list to
7922 select particular domains (because any domain would match), but it might have
7923 value if the result of the lookup is being used via the &$domain_data$&
7924 expansion variable.
7925 .next
7926 If the pattern starts with the name of a query-style lookup type followed by a
7927 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7928 pattern must be an appropriate query for the lookup type, as described in
7929 chapter &<<CHAPfdlookup>>&. For example:
7930 .code
7931 hold_domains = mysql;select domain from holdlist \
7932   where domain = '${quote_mysql:$domain}';
7933 .endd
7934 In most cases, the data that is looked up is not used (so for an SQL query, for
7935 example, it doesn't matter what field you select). Exim is interested only in
7936 whether or not the query succeeds. However, when a lookup is used for the
7937 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7938 variable and can be referred to in other options.
7939 .next
7940 .cindex "domain list" "matching literal domain name"
7941 If none of the above cases apply, a caseless textual comparison is made
7942 between the pattern and the domain.
7943 .endlist
7944
7945 Here is an example that uses several different kinds of pattern:
7946 .code
7947 domainlist funny_domains = \
7948   @ : \
7949   lib.unseen.edu : \
7950   *.foundation.fict.example : \
7951   \N^[1-2]\d{3}\.fict\.example$\N : \
7952   partial-dbm;/opt/data/penguin/book : \
7953   nis;domains.byname : \
7954   nisplus;[name=$domain,status=local],domains.org_dir
7955 .endd
7956 There are obvious processing trade-offs among the various matching modes. Using
7957 an asterisk is faster than a regular expression, and listing a few names
7958 explicitly probably is too. The use of a file or database lookup is expensive,
7959 but may be the only option if hundreds of names are required. Because the
7960 patterns are tested in order, it makes sense to put the most commonly matched
7961 patterns earlier.
7962
7963
7964
7965 .section "Host lists" "SECThostlist"
7966 .cindex "host list" "patterns in"
7967 .cindex "list" "host list"
7968 Host lists are used to control what remote hosts are allowed to do. For
7969 example, some hosts may be allowed to use the local host as a relay, and some
7970 may be permitted to use the SMTP ETRN command. Hosts can be identified in
7971 two different ways, by name or by IP address. In a host list, some types of
7972 pattern are matched to a host name, and some are matched to an IP address.
7973 You need to be particularly careful with this when single-key lookups are
7974 involved, to ensure that the right value is being used as the key.
7975
7976
7977 .section "Special host list patterns" "SECID80"
7978 .cindex "empty item in hosts list"
7979 .cindex "host list" "empty string in"
7980 If a host list item is the empty string, it matches only when no remote host is
7981 involved. This is the case when a message is being received from a local
7982 process using SMTP on the standard input, that is, when a TCP/IP connection is
7983 not used.
7984
7985 .cindex "asterisk" "in host list"
7986 The special pattern &"*"& in a host list matches any host or no host. Neither
7987 the IP address nor the name is actually inspected.
7988
7989
7990
7991 .section "Host list patterns that match by IP address" "SECThoslispatip"
7992 .cindex "host list" "matching IP addresses"
7993 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
7994 the incoming address actually appears in the IPv6 host as
7995 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
7996 list, it is converted into a traditional IPv4 address first. (Not all operating
7997 systems accept IPv4 calls on IPv6 sockets, as there have been some security
7998 concerns.)
7999
8000 The following types of pattern in a host list check the remote host by
8001 inspecting its IP address:
8002
8003 .ilist
8004 If the pattern is a plain domain name (not a regular expression, not starting
8005 with *, not a lookup of any kind), Exim calls the operating system function
8006 to find the associated IP address(es). Exim uses the newer
8007 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8008 This typically causes a forward DNS lookup of the name. The result is compared
8009 with the IP address of the subject host.
8010
8011 If there is a temporary problem (such as a DNS timeout) with the host name
8012 lookup, a temporary error occurs. For example, if the list is being used in an
8013 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8014 temporary SMTP error code. If no IP address can be found for the host name,
8015 what happens is described in section &<<SECTbehipnot>>& below.
8016
8017 .next
8018 .cindex "@ in a host list"
8019 If the pattern is &"@"&, the primary host name is substituted and used as a
8020 domain name, as just described.
8021
8022 .next
8023 If the pattern is an IP address, it is matched against the IP address of the
8024 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8025 IPv6 addresses can be given in colon-separated format, but the colons have to
8026 be doubled so as not to be taken as item separators when the default list
8027 separator is used. IPv6 addresses are recognized even when Exim is compiled
8028 without IPv6 support. This means that if they appear in a host list on an
8029 IPv4-only host, Exim will not treat them as host names. They are just addresses
8030 that can never match a client host.
8031
8032 .next
8033 .cindex "@[] in a host list"
8034 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8035 the local host. For example, if the local host is an IPv4 host with one
8036 interface address 10.45.23.56, these two ACL statements have the same effect:
8037 .code
8038 accept hosts = 127.0.0.1 : 10.45.23.56
8039 accept hosts = @[]
8040 .endd
8041 .next
8042 .cindex "CIDR notation"
8043 If the pattern is an IP address followed by a slash and a mask length (for
8044 example 10.11.42.0/24), it is matched against the IP address of the subject
8045 host under the given mask. This allows, an entire network of hosts to be
8046 included (or excluded) by a single item. The mask uses CIDR notation; it
8047 specifies the number of address bits that must match, starting from the most
8048 significant end of the address.
8049
8050 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8051 of a range of addresses. It is the number of bits in the network portion of the
8052 address. The above example specifies a 24-bit netmask, so it matches all 256
8053 addresses in the 10.11.42.0 network. An item such as
8054 .code
8055 192.168.23.236/31
8056 .endd
8057 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8058 32 for an IPv4 address is the same as no mask at all; just a single address
8059 matches.
8060
8061 Here is another example which shows an IPv4 and an IPv6 network:
8062 .code
8063 recipient_unqualified_hosts = 192.168.0.0/16: \
8064                               3ffe::ffff::836f::::/48
8065 .endd
8066 The doubling of list separator characters applies only when these items
8067 appear inline in a host list. It is not required when indirecting via a file.
8068 For example:
8069 .code
8070 recipient_unqualified_hosts = /opt/exim/unqualnets
8071 .endd
8072 could make use of a file containing
8073 .code
8074 172.16.0.0/12
8075 3ffe:ffff:836f::/48
8076 .endd
8077 to have exactly the same effect as the previous example. When listing IPv6
8078 addresses inline, it is usually more convenient to use the facility for
8079 changing separator characters. This list contains the same two networks:
8080 .code
8081 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8082                                  3ffe:ffff:836f::/48
8083 .endd
8084 The separator is changed to semicolon by the leading &"<;"& at the start of the
8085 list.
8086 .endlist
8087
8088
8089
8090 .section "Host list patterns for single-key lookups by host address" &&&
8091          "SECThoslispatsikey"
8092 .cindex "host list" "lookup of IP address"
8093 When a host is to be identified by a single-key lookup of its complete IP
8094 address, the pattern takes this form:
8095 .display
8096 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8097 .endd
8098 For example:
8099 .code
8100 hosts_lookup = net-cdb;/hosts-by-ip.db
8101 .endd
8102 The text form of the IP address of the subject host is used as the lookup key.
8103 IPv6 addresses are converted to an unabbreviated form, using lower case
8104 letters, with dots as separators because colon is the key terminator in
8105 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8106 quoting the keys, but this is a facility that was added later.] The data
8107 returned by the lookup is not used.
8108
8109 .cindex "IP address" "masking"
8110 .cindex "host list" "masked IP address"
8111 Single-key lookups can also be performed using masked IP addresses, using
8112 patterns of this form:
8113 .display
8114 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8115 .endd
8116 For example:
8117 .code
8118 net24-dbm;/networks.db
8119 .endd
8120 The IP address of the subject host is masked using <&'number'&> as the mask
8121 length. A textual string is constructed from the masked value, followed by the
8122 mask, and this is used as the lookup key. For example, if the host's IP address
8123 is 192.168.34.6, the key that is looked up for the above example is
8124 &"192.168.34.0/24"&.
8125
8126 When an IPv6 address is converted to a string, dots are normally used instead
8127 of colons, so that keys in &(lsearch)& files need not contain colons (which
8128 terminate &(lsearch)& keys). This was implemented some time before the ability
8129 to quote keys was made available in &(lsearch)& files. However, the more
8130 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8131 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8132 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8133 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8134 addresses are always used.
8135
8136 Ideally, it would be nice to tidy up this anomalous situation by changing to
8137 colons in all cases, given that quoting is now available for &(lsearch)&.
8138 However, this would be an incompatible change that might break some existing
8139 configurations.
8140
8141 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8142 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8143 the former case the key strings include the mask value, whereas in the latter
8144 case the IP address is used on its own.
8145
8146
8147
8148 .section "Host list patterns that match by host name" "SECThoslispatnam"
8149 .cindex "host" "lookup failures"
8150 .cindex "unknown host name"
8151 .cindex "host list" "matching host name"
8152 There are several types of pattern that require Exim to know the name of the
8153 remote host. These are either wildcard patterns or lookups by name. (If a
8154 complete hostname is given without any wildcarding, it is used to find an IP
8155 address to match against, as described in section &<<SECThoslispatip>>&
8156 above.)
8157
8158 If the remote host name is not already known when Exim encounters one of these
8159 patterns, it has to be found from the IP address.
8160 Although many sites on the Internet are conscientious about maintaining reverse
8161 DNS data for their hosts, there are also many that do not do this.
8162 Consequently, a name cannot always be found, and this may lead to unwanted
8163 effects. Take care when configuring host lists with wildcarded name patterns.
8164 Consider what will happen if a name cannot be found.
8165
8166 Because of the problems of determining host names from IP addresses, matching
8167 against host names is not as common as matching against IP addresses.
8168
8169 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8170 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8171 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8172 are done can be changed by setting the &%host_lookup_order%& option. For
8173 security, once Exim has found one or more names, it looks up the IP addresses
8174 for these names and compares them with the IP address that it started with.
8175 Only those names whose IP addresses match are accepted. Any other names are
8176 discarded. If no names are left, Exim behaves as if the host name cannot be
8177 found. In the most common case there is only one name and one IP address.
8178
8179 There are some options that control what happens if a host name cannot be
8180 found. These are described in section &<<SECTbehipnot>>& below.
8181
8182 .cindex "host" "alias for"
8183 .cindex "alias for host"
8184 As a result of aliasing, hosts may have more than one name. When processing any
8185 of the following types of pattern, all the host's names are checked:
8186
8187 .ilist
8188 .cindex "asterisk" "in host list"
8189 If a pattern starts with &"*"& the remainder of the item must match the end of
8190 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8191 &'.b.c'&. This special simple form is provided because this is a very common
8192 requirement. Other kinds of wildcarding require the use of a regular
8193 expression.
8194 .next
8195 .cindex "regular expressions" "in host list"
8196 .cindex "host list" "regular expression in"
8197 If the item starts with &"^"& it is taken to be a regular expression which is
8198 matched against the host name. Host names are case-independent, so this regular
8199 expression match is by default case-independent, but you can make it
8200 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8201 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8202 example,
8203 .code
8204 ^(a|b)\.c\.d$
8205 .endd
8206 is a regular expression that matches either of the two hosts &'a.c.d'& or
8207 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8208 that backslash and dollar characters are not misinterpreted as part of the
8209 string expansion. The simplest way to do this is to use &`\N`& to mark that
8210 part of the string as non-expandable. For example:
8211 .code
8212 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8213 .endd
8214 &*Warning*&: If you want to match a complete host name, you must include the
8215 &`$`& terminating metacharacter in the regular expression, as in the above
8216 example. Without it, a match at the start of the host name is all that is
8217 required.
8218 .endlist
8219
8220
8221
8222
8223 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8224 .cindex "host" "lookup failures, permanent"
8225 While processing a host list, Exim may need to look up an IP address from a
8226 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8227 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8228 behaviour when it fails to find the information it is seeking is the same.
8229
8230 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8231 apply to temporary DNS errors, whose handling is described in the next section.
8232
8233 .cindex "&`+include_unknown`&"
8234 .cindex "&`+ignore_unknown`&"
8235 By default, Exim behaves as if the host does not match the list. This may not
8236 always be what you want to happen. To change Exim's behaviour, the special
8237 items &`+include_unknown`& or &`+ignore_unknown`& may appear in the list (at
8238 top level &-- they are not recognized in an indirected file).
8239
8240 .ilist
8241 If any item that follows &`+include_unknown`& requires information that
8242 cannot found, Exim behaves as if the host does match the list. For example,
8243 .code
8244 host_reject_connection = +include_unknown:*.enemy.ex
8245 .endd
8246 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8247 any hosts whose name it cannot find.
8248
8249 .next
8250 If any item that follows &`+ignore_unknown`& requires information that cannot
8251 be found, Exim ignores that item and proceeds to the rest of the list. For
8252 example:
8253 .code
8254 accept hosts = +ignore_unknown : friend.example : \
8255                192.168.4.5
8256 .endd
8257 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8258 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8259 name can be found for 192.168.4.5, it is rejected.
8260 .endlist
8261
8262 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8263 list. The effect of each one lasts until the next, or until the end of the
8264 list.
8265
8266
8267 .section "Temporary DNS errors when looking up host information" &&&
8268          "SECTtemdnserr"
8269 .cindex "host" "lookup failures, temporary"
8270 .cindex "&`+include_defer`&"
8271 .cindex "&`+ignore_defer`&"
8272 A temporary DNS lookup failure normally causes a defer action (except when
8273 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8274 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8275 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8276 section. These options should be used with care, probably only in non-critical
8277 host lists such as whitelists.
8278
8279
8280
8281 .section "Host list patterns for single-key lookups by host name" &&&
8282          "SECThoslispatnamsk"
8283 .cindex "unknown host name"
8284 .cindex "host list" "matching host name"
8285 If a pattern is of the form
8286 .display
8287 <&'single-key-search-type'&>;<&'search-data'&>
8288 .endd
8289 for example
8290 .code
8291 dbm;/host/accept/list
8292 .endd
8293 a single-key lookup is performed, using the host name as its key. If the
8294 lookup succeeds, the host matches the item. The actual data that is looked up
8295 is not used.
8296
8297 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8298 keys in the file, not IP addresses. If you want to do lookups based on IP
8299 addresses, you must precede the search type with &"net-"& (see section
8300 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8301 two items in the same list, one doing an address lookup and one doing a name
8302 lookup, both using the same file.
8303
8304
8305
8306 .section "Host list patterns for query-style lookups" "SECID81"
8307 If a pattern is of the form
8308 .display
8309 <&'query-style-search-type'&>;<&'query'&>
8310 .endd
8311 the query is obeyed, and if it succeeds, the host matches the item. The actual
8312 data that is looked up is not used. The variables &$sender_host_address$& and
8313 &$sender_host_name$& can be used in the query. For example:
8314 .code
8315 hosts_lookup = pgsql;\
8316   select ip from hostlist where ip='$sender_host_address'
8317 .endd
8318 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8319 can use the &%sg%& expansion item to change this if you need to. If you want to
8320 use masked IP addresses in database queries, you can use the &%mask%& expansion
8321 operator.
8322
8323 If the query contains a reference to &$sender_host_name$&, Exim automatically
8324 looks up the host name if it has not already done so. (See section
8325 &<<SECThoslispatnam>>& for comments on finding host names.)
8326
8327 Historical note: prior to release 4.30, Exim would always attempt to find a
8328 host name before running the query, unless the search type was preceded by
8329 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8330 still recognized for query-style lookups, but its presence or absence has no
8331 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8332 See section &<<SECThoslispatsikey>>&.)
8333
8334
8335
8336 .section "Mixing wildcarded host names and addresses in host lists" &&&
8337          "SECTmixwilhos"
8338 .cindex "host list" "mixing names and addresses in"
8339 If you have name lookups or wildcarded host names and IP addresses in the same
8340 host list, you should normally put the IP addresses first. For example, in an
8341 ACL you could have:
8342 .code
8343 accept hosts = 10.9.8.7 : *.friend.example
8344 .endd
8345 The reason for this lies in the left-to-right way that Exim processes lists.
8346 It can test IP addresses without doing any DNS lookups, but when it reaches an
8347 item that requires a host name, it fails if it cannot find a host name to
8348 compare with the pattern. If the above list is given in the opposite order, the
8349 &%accept%& statement fails for a host whose name cannot be found, even if its
8350 IP address is 10.9.8.7.
8351
8352 If you really do want to do the name check first, and still recognize the IP
8353 address, you can rewrite the ACL like this:
8354 .code
8355 accept hosts = *.friend.example
8356 accept hosts = 10.9.8.7
8357 .endd
8358 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8359 &<<CHAPACL>>& for details of ACLs.
8360
8361
8362
8363
8364
8365 .section "Address lists" "SECTaddresslist"
8366 .cindex "list" "address list"
8367 .cindex "address list" "empty item"
8368 .cindex "address list" "patterns"
8369 Address lists contain patterns that are matched against mail addresses. There
8370 is one special case to be considered: the sender address of a bounce message is
8371 always empty. You can test for this by providing an empty item in an address
8372 list. For example, you can set up a router to process bounce messages by
8373 using this option setting:
8374 .code
8375 senders = :
8376 .endd
8377 The presence of the colon creates an empty item. If you do not provide any
8378 data, the list is empty and matches nothing. The empty sender can also be
8379 detected by a regular expression that matches an empty string,
8380 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8381
8382 Non-empty items in an address list can be straightforward email addresses. For
8383 example:
8384 .code
8385 senders = jbc@askone.example : hs@anacreon.example
8386 .endd
8387 A certain amount of wildcarding is permitted. If a pattern contains an @
8388 character, but is not a regular expression and does not begin with a
8389 semicolon-terminated lookup type (described below), the local part of the
8390 subject address is compared with the local part of the pattern, which may start
8391 with an asterisk. If the local parts match, the domain is checked in exactly
8392 the same way as for a pattern in a domain list. For example, the domain can be
8393 wildcarded, refer to a named list, or be a lookup:
8394 .code
8395 deny senders = *@*.spamming.site:\
8396                *@+hostile_domains:\
8397                bozo@partial-lsearch;/list/of/dodgy/sites:\
8398                *@dbm;/bad/domains.db
8399 .endd
8400 .cindex "local part" "starting with !"
8401 .cindex "address list" "local part starting with !"
8402 If a local part that begins with an exclamation mark is required, it has to be
8403 specified using a regular expression, because otherwise the exclamation mark is
8404 treated as a sign of negation, as is standard in lists.
8405
8406 If a non-empty pattern that is not a regular expression or a lookup does not
8407 contain an @ character, it is matched against the domain part of the subject
8408 address. The only two formats that are recognized this way are a literal
8409 domain, or a domain pattern that starts with *. In both these cases, the effect
8410 is the same as if &`*@`& preceded the pattern. For example:
8411 .code
8412 deny senders = enemy.domain : *.enemy.domain
8413 .endd
8414
8415 The following kinds of more complicated address list pattern can match any
8416 address, including the empty address that is characteristic of bounce message
8417 senders:
8418
8419 .ilist
8420 .cindex "regular expressions" "in address list"
8421 .cindex "address list" "regular expression in"
8422 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8423 done against the complete address, with the pattern as the regular expression.
8424 You must take care that backslash and dollar characters are not misinterpreted
8425 as part of the string expansion. The simplest way to do this is to use &`\N`&
8426 to mark that part of the string as non-expandable. For example:
8427 .code
8428 deny senders = \N^.*this.*@example\.com$\N : \
8429                \N^\d{8}.+@spamhaus.example$\N : ...
8430 .endd
8431 The &`\N`& sequences are removed by the expansion, so these items do indeed
8432 start with &"^"& by the time they are being interpreted as address patterns.
8433
8434 .next
8435 .cindex "address list" "lookup for complete address"
8436 Complete addresses can be looked up by using a pattern that starts with a
8437 lookup type terminated by a semicolon, followed by the data for the lookup. For
8438 example:
8439 .code
8440 deny senders = cdb;/etc/blocked.senders : \
8441   mysql;select address from blocked where \
8442   address='${quote_mysql:$sender_address}'
8443 .endd
8444 Both query-style and single-key lookup types can be used. For a single-key
8445 lookup type, Exim uses the complete address as the key. However, empty keys are
8446 not supported for single-key lookups, so a match against the empty address
8447 always fails. This restriction does not apply to query-style lookups.
8448
8449 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8450 cannot be used, and is ignored if specified, with an entry being written to the
8451 panic log.
8452 .cindex "*@ with single-key lookup"
8453 However, you can configure lookup defaults, as described in section
8454 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8455 default. For example, with this lookup:
8456 .code
8457 accept senders = lsearch*@;/some/file
8458 .endd
8459 the file could contains lines like this:
8460 .code
8461 user1@domain1.example
8462 *@domain2.example
8463 .endd
8464 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8465 that are tried is:
8466 .code
8467 nimrod@jaeger.example
8468 *@jaeger.example
8469 *
8470 .endd
8471 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8472 would mean that every address matches, thus rendering the test useless.
8473
8474 &*Warning 2*&: Do not confuse these two kinds of item:
8475 .code
8476 deny recipients = dbm*@;/some/file
8477 deny recipients = *@dbm;/some/file
8478 .endd
8479 The first does a whole address lookup, with defaulting, as just described,
8480 because it starts with a lookup type. The second matches the local part and
8481 domain independently, as described in a bullet point below.
8482 .endlist
8483
8484
8485 The following kinds of address list pattern can match only non-empty addresses.
8486 If the subject address is empty, a match against any of these pattern types
8487 always fails.
8488
8489
8490 .ilist
8491 .cindex "@@ with single-key lookup"
8492 .cindex "address list" "@@ lookup type"
8493 .cindex "address list" "split local part and domain"
8494 If a pattern starts with &"@@"& followed by a single-key lookup item
8495 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8496 split into a local part and a domain. The domain is looked up in the file. If
8497 it is not found, there is no match. If it is found, the data that is looked up
8498 from the file is treated as a colon-separated list of local part patterns, each
8499 of which is matched against the subject local part in turn.
8500
8501 .cindex "asterisk" "in address list"
8502 The lookup may be a partial one, and/or one involving a search for a default
8503 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8504 patterns that are looked up can be regular expressions or begin with &"*"&, or
8505 even be further lookups. They may also be independently negated. For example,
8506 with
8507 .code
8508 deny senders = @@dbm;/etc/reject-by-domain
8509 .endd
8510 the data from which the DBM file is built could contain lines like
8511 .code
8512 baddomain.com:  !postmaster : *
8513 .endd
8514 to reject all senders except &%postmaster%& from that domain.
8515
8516 .cindex "local part" "starting with !"
8517 If a local part that actually begins with an exclamation mark is required, it
8518 has to be specified using a regular expression. In &(lsearch)& files, an entry
8519 may be split over several lines by indenting the second and subsequent lines,
8520 but the separating colon must still be included at line breaks. White space
8521 surrounding the colons is ignored. For example:
8522 .code
8523 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8524   spammer3 : spammer4
8525 .endd
8526 As in all colon-separated lists in Exim, a colon can be included in an item by
8527 doubling.
8528
8529 If the last item in the list starts with a right angle-bracket, the remainder
8530 of the item is taken as a new key to look up in order to obtain a continuation
8531 list of local parts. The new key can be any sequence of characters. Thus one
8532 might have entries like
8533 .code
8534 aol.com: spammer1 : spammer 2 : >*
8535 xyz.com: spammer3 : >*
8536 *:       ^\d{8}$
8537 .endd
8538 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8539 local parts for all domains, in addition to the specific local parts listed for
8540 each domain. Of course, using this feature costs another lookup each time a
8541 chain is followed, but the effort needed to maintain the data is reduced.
8542
8543 .cindex "loop" "in lookups"
8544 It is possible to construct loops using this facility, and in order to catch
8545 them, the chains may be no more than fifty items long.
8546
8547 .next
8548 The @@<&'lookup'&> style of item can also be used with a query-style
8549 lookup, but in this case, the chaining facility is not available. The lookup
8550 can only return a single list of local parts.
8551 .endlist
8552
8553 &*Warning*&: There is an important difference between the address list items
8554 in these two examples:
8555 .code
8556 senders = +my_list
8557 senders = *@+my_list
8558 .endd
8559 In the first one, &`my_list`& is a named address list, whereas in the second
8560 example it is a named domain list.
8561
8562
8563
8564
8565 .section "Case of letters in address lists" "SECTcasletadd"
8566 .cindex "case of local parts"
8567 .cindex "address list" "case forcing"
8568 .cindex "case forcing in address lists"
8569 Domains in email addresses are always handled caselessly, but for local parts
8570 case may be significant on some systems (see &%caseful_local_part%& for how
8571 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8572 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8573 blocking lists should be done in a case-independent manner. Since most address
8574 lists in Exim are used for this kind of control, Exim attempts to do this by
8575 default.
8576
8577 The domain portion of an address is always lowercased before matching it to an
8578 address list. The local part is lowercased by default, and any string
8579 comparisons that take place are done caselessly. This means that the data in
8580 the address list itself, in files included as plain file names, and in any file
8581 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8582 keys in files that are looked up by a search type other than &(lsearch)& (which
8583 works caselessly) must be in lower case, because these lookups are not
8584 case-independent.
8585
8586 .cindex "&`+caseful`&"
8587 To allow for the possibility of caseful address list matching, if an item in
8588 an address list is the string &"+caseful"&, the original case of the local
8589 part is restored for any comparisons that follow, and string comparisons are no
8590 longer case-independent. This does not affect the domain, which remains in
8591 lower case. However, although independent matches on the domain alone are still
8592 performed caselessly, regular expressions that match against an entire address
8593 become case-sensitive after &"+caseful"& has been seen.
8594
8595
8596
8597 .section "Local part lists" "SECTlocparlis"
8598 .cindex "list" "local part list"
8599 .cindex "local part" "list"
8600 Case-sensitivity in local part lists is handled in the same way as for address
8601 lists, as just described. The &"+caseful"& item can be used if required. In a
8602 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8603 set false, the subject is lowercased and the matching is initially
8604 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8605 matching in the local part list, but not elsewhere in the router. If
8606 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8607 option is case-sensitive from the start.
8608
8609 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8610 comments are handled in the same way as address lists &-- they are recognized
8611 only if the # is preceded by white space or the start of the line.
8612 Otherwise, local part lists are matched in the same way as domain lists, except
8613 that the special items that refer to the local host (&`@`&, &`@[]`&,
8614 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8615 Refer to section &<<SECTdomainlist>>& for details of the other available item
8616 types.
8617 .ecindex IIDdohoadli
8618
8619
8620
8621
8622 . ////////////////////////////////////////////////////////////////////////////
8623 . ////////////////////////////////////////////////////////////////////////////
8624
8625 .chapter "String expansions" "CHAPexpand"
8626 .scindex IIDstrexp "expansion" "of strings"
8627 Many strings in Exim's run time configuration are expanded before use. Some of
8628 them are expanded every time they are used; others are expanded only once.
8629
8630 When a string is being expanded it is copied verbatim from left to right except
8631 when a dollar or backslash character is encountered. A dollar specifies the
8632 start of a portion of the string that is interpreted and replaced as described
8633 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8634 escape character, as described in the following section.
8635
8636 Whether a string is expanded depends upon the context.  Usually this is solely
8637 dependent upon the option for which a value is sought; in this documentation,
8638 options for which string expansion is performed are marked with &dagger; after
8639 the data type.  ACL rules always expand strings.  A couple of expansion
8640 conditions do not expand some of the brace-delimited branches, for security
8641 reasons.
8642
8643
8644
8645 .section "Literal text in expanded strings" "SECTlittext"
8646 .cindex "expansion" "including literal text"
8647 An uninterpreted dollar can be included in an expanded string by putting a
8648 backslash in front of it. A backslash can be used to prevent any special
8649 character being treated specially in an expansion, including backslash itself.
8650 If the string appears in quotes in the configuration file, two backslashes are
8651 required because the quotes themselves cause interpretation of backslashes when
8652 the string is read in (see section &<<SECTstrings>>&).
8653
8654 .cindex "expansion" "non-expandable substrings"
8655 A portion of the string can specified as non-expandable by placing it between
8656 two occurrences of &`\N`&. This is particularly useful for protecting regular
8657 expressions, which often contain backslashes and dollar signs. For example:
8658 .code
8659 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8660 .endd
8661 On encountering the first &`\N`&, the expander copies subsequent characters
8662 without interpretation until it reaches the next &`\N`& or the end of the
8663 string.
8664
8665
8666
8667 .section "Character escape sequences in expanded strings" "SECID82"
8668 .cindex "expansion" "escape sequences"
8669 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8670 expanded string is recognized as an escape sequence for the character newline,
8671 carriage return, or tab, respectively. A backslash followed by up to three
8672 octal digits is recognized as an octal encoding for a single character, and a
8673 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8674 encoding.
8675
8676 These escape sequences are also recognized in quoted strings when they are read
8677 in. Their interpretation in expansions as well is useful for unquoted strings,
8678 and for other cases such as looked-up strings that are then expanded.
8679
8680
8681 .section "Testing string expansions" "SECID83"
8682 .cindex "expansion" "testing"
8683 .cindex "testing" "string expansion"
8684 .oindex "&%-be%&"
8685 Many expansions can be tested by calling Exim with the &%-be%& option. This
8686 takes the command arguments, or lines from the standard input if there are no
8687 arguments, runs them through the string expansion code, and writes the results
8688 to the standard output. Variables based on configuration values are set up, but
8689 since no message is being processed, variables such as &$local_part$& have no
8690 value. Nevertheless the &%-be%& option can be useful for checking out file and
8691 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8692 and &%nhash%&.
8693
8694 Exim gives up its root privilege when it is called with the &%-be%& option, and
8695 instead runs under the uid and gid it was called with, to prevent users from
8696 using &%-be%& for reading files to which they do not have access.
8697
8698 .oindex "&%-bem%&"
8699 If you want to test expansions that include variables whose values are taken
8700 from a message, there are two other options that can be used. The &%-bem%&
8701 option is like &%-be%& except that it is followed by a file name. The file is
8702 read as a message before doing the test expansions. For example:
8703 .code
8704 exim -bem /tmp/test.message '$h_subject:'
8705 .endd
8706 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8707 Exim message identifier. For example:
8708 .code
8709 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8710 .endd
8711 This loads the message from Exim's spool before doing the test expansions, and
8712 is therefore restricted to admin users.
8713
8714
8715 .section "Forced expansion failure" "SECTforexpfai"
8716 .cindex "expansion" "forced failure"
8717 A number of expansions that are described in the following section have
8718 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8719 (which are sometimes called &"curly brackets"&). Which of the two strings is
8720 used depends on some condition that is evaluated as part of the expansion. If,
8721 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8722 the entire string expansion fails in a way that can be detected by the code
8723 that requested the expansion. This is called &"forced expansion failure"&, and
8724 its consequences depend on the circumstances. In some cases it is no different
8725 from any other expansion failure, but in others a different action may be
8726 taken. Such variations are mentioned in the documentation of the option that is
8727 being expanded.
8728
8729
8730
8731
8732 .section "Expansion items" "SECTexpansionitems"
8733 The following items are recognized in expanded strings. White space may be used
8734 between sub-items that are keywords or substrings enclosed in braces inside an
8735 outer set of braces, to improve readability. &*Warning*&: Within braces,
8736 white space is significant.
8737
8738 .vlist
8739 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8740 .cindex "expansion" "variables"
8741 Substitute the contents of the named variable, for example:
8742 .code
8743 $local_part
8744 ${domain}
8745 .endd
8746 The second form can be used to separate the name from subsequent alphanumeric
8747 characters. This form (using braces) is available only for variables; it does
8748 &'not'& apply to message headers. The names of the variables are given in
8749 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8750 given, the expansion fails.
8751
8752 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8753 .cindex "expansion" "operators"
8754 The string is first itself expanded, and then the operation specified by
8755 <&'op'&> is applied to it. For example:
8756 .code
8757 ${lc:$local_part}
8758 .endd
8759 The string starts with the first character after the colon, which may be
8760 leading white space. A list of operators is given in section &<<SECTexpop>>&
8761 below. The operator notation is used for simple expansion items that have just
8762 one argument, because it reduces the number of braces and therefore makes the
8763 string easier to understand.
8764
8765 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8766 This item inserts &"basic"& header lines. It is described with the &%header%&
8767 expansion item below.
8768
8769
8770 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8771 .cindex "expansion" "calling an acl"
8772 .cindex "&%acl%&" "call from expansion"
8773 The name and zero to nine argument strings are first expanded separately.  The expanded
8774 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8775 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8776 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8777 and may use the variables; if another acl expansion is used the values
8778 are overwritten.  If the ACL sets
8779 a value using a "message =" modifier and returns accept or deny, the value becomes
8780 the result of the expansion.
8781 If no message was set and the ACL returned accept or deny
8782 the value is an empty string.
8783 If the ACL returned defer the result is a forced-fail.  Otherwise the expansion fails.
8784
8785
8786 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8787        {*&<&'arg'&>&*}...}*&"
8788 .cindex &%dlfunc%&
8789 This expansion dynamically loads and then calls a locally-written C function.
8790 This functionality is available only if Exim is compiled with
8791 .code
8792 EXPAND_DLFUNC=yes
8793 .endd
8794 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8795 object so that it doesn't reload the same object file in the same Exim process
8796 (but of course Exim does start new processes frequently).
8797
8798 There may be from zero to eight arguments to the function. When compiling
8799 a local function that is to be called in this way, &_local_scan.h_& should be
8800 included. The Exim variables and functions that are defined by that API
8801 are also available for dynamically loaded functions. The function itself
8802 must have the following type:
8803 .code
8804 int dlfunction(uschar **yield, int argc, uschar *argv[])
8805 .endd
8806 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8807 function should return one of the following values:
8808
8809 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8810 into the expanded string that is being built.
8811
8812 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8813 from &'yield'&, if it is set.
8814
8815 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8816 taken from &'yield'& if it is set.
8817
8818 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8819
8820 When compiling a function that is to be used in this way with gcc,
8821 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8822 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8823
8824 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8825        {*&<&'string3'&>&*}}*&"
8826 .cindex "expansion" "extracting substrings by key"
8827 .cindex "&%extract%&" "substrings by key"
8828 The key and <&'string1'&> are first expanded separately. Leading and trailing
8829 white space is removed from the key (but not from any of the strings). The key
8830 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8831 form:
8832 .display
8833 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8834 .endd
8835 .vindex "&$value$&"
8836 where the equals signs and spaces (but not both) are optional. If any of the
8837 values contain white space, they must be enclosed in double quotes, and any
8838 values that are enclosed in double quotes are subject to escape processing as
8839 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8840 for the value that corresponds to the key. The search is case-insensitive. If
8841 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8842 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8843 variable &$value$& contains the value that has been extracted. Afterwards, it
8844 is restored to any previous value it might have had.
8845
8846 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8847 key is not found. If {<&'string2'&>} is also omitted, the value that was
8848 extracted is used. Thus, for example, these two expansions are identical, and
8849 yield &"2001"&:
8850 .code
8851 ${extract{gid}{uid=1984 gid=2001}}
8852 ${extract{gid}{uid=1984 gid=2001}{$value}}
8853 .endd
8854 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8855 appear, for example:
8856 .code
8857 ${extract{Z}{A=... B=...}{$value} fail }
8858 .endd
8859 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8860 {<&'string2'&>} must be present for &"fail"& to be recognized.
8861
8862
8863 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8864         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8865 .cindex "expansion" "extracting substrings by number"
8866 .cindex "&%extract%&" "substrings by number"
8867 The <&'number'&> argument must consist entirely of decimal digits,
8868 apart from leading and trailing white space, which is ignored.
8869 This is what distinguishes this form of &%extract%& from the previous kind. It
8870 behaves in the same way, except that, instead of extracting a named field, it
8871 extracts from <&'string1'&> the field whose number is given as the first
8872 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8873 <&'string3'&> as before.
8874
8875 The fields in the string are separated by any one of the characters in the
8876 separator string. These may include space or tab characters.
8877 The first field is numbered one. If the number is negative, the fields are
8878 counted from the end of the string, with the rightmost one numbered -1. If the
8879 number given is zero, the entire string is returned. If the modulus of the
8880 number is greater than the number of fields in the string, the result is the
8881 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8882 provided. For example:
8883 .code
8884 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8885 .endd
8886 yields &"42"&, and
8887 .code
8888 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8889 .endd
8890 yields &"99"&. Two successive separators mean that the field between them is
8891 empty (for example, the fifth field above).
8892
8893
8894 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8895 .cindex "list" "selecting by condition"
8896 .cindex "expansion" "selecting from list by condition"
8897 .vindex "&$item$&"
8898 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8899 default, but the separator can be changed in the usual way. For each item
8900 in this list, its value is place in &$item$&, and then the condition is
8901 evaluated. If the condition is true, &$item$& is added to the output as an
8902 item in a new list; if the condition is false, the item is discarded. The
8903 separator used for the output list is the same as the one used for the
8904 input, but a separator setting is not included in the output. For example:
8905 .code
8906 ${filter{a:b:c}{!eq{$item}{b}}
8907 .endd
8908 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8909 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8910
8911
8912 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8913 .cindex "hash function" "textual"
8914 .cindex "expansion" "textual hash"
8915 This is a textual hashing function, and was the first to be implemented in
8916 early versions of Exim. In current releases, there are other hashing functions
8917 (numeric, MD5, and SHA-1), which are described below.
8918
8919 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
8920 <&'n'&>. If you are using fixed values for these numbers, that is, if
8921 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
8922 use the simpler operator notation that avoids some of the braces:
8923 .code
8924 ${hash_<n>_<m>:<string>}
8925 .endd
8926 The second number is optional (in both notations). If <&'n'&> is greater than
8927 or equal to the length of the string, the expansion item returns the string.
8928 Otherwise it computes a new string of length <&'n'&> by applying a hashing
8929 function to the string. The new string consists of characters taken from the
8930 first <&'m'&> characters of the string
8931 .code
8932 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
8933 .endd
8934 If <&'m'&> is not present the value 26 is used, so that only lower case
8935 letters appear. For example:
8936 .display
8937 &`$hash{3}{monty}}           `&   yields  &`jmg`&
8938 &`$hash{5}{monty}}           `&   yields  &`monty`&
8939 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
8940 .endd
8941
8942 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
8943         &*$h_*&<&'header&~name'&>&*:*&" &&&
8944        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8945         &*$bh_*&<&'header&~name'&>&*:*&" &&&
8946        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8947         &*$rh_*&<&'header&~name'&>&*:*&"
8948 .cindex "expansion" "header insertion"
8949 .vindex "&$header_$&"
8950 .vindex "&$bheader_$&"
8951 .vindex "&$rheader_$&"
8952 .cindex "header lines" "in expansion strings"
8953 .cindex "header lines" "character sets"
8954 .cindex "header lines" "decoding"
8955 Substitute the contents of the named message header line, for example
8956 .code
8957 $header_reply-to:
8958 .endd
8959 The newline that terminates a header line is not included in the expansion, but
8960 internal newlines (caused by splitting the header line over several physical
8961 lines) may be present.
8962
8963 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
8964 the data in the header line is interpreted.
8965
8966 .ilist
8967 .cindex "white space" "in header lines"
8968 &%rheader%& gives the original &"raw"& content of the header line, with no
8969 processing at all, and without the removal of leading and trailing white space.
8970
8971 .next
8972 .cindex "base64 encoding" "in header lines"
8973 &%bheader%& removes leading and trailing white space, and then decodes base64
8974 or quoted-printable MIME &"words"& within the header text, but does no
8975 character set translation. If decoding of what looks superficially like a MIME
8976 &"word"& fails, the raw string is returned. If decoding
8977 .cindex "binary zero" "in header line"
8978 produces a binary zero character, it is replaced by a question mark &-- this is
8979 what Exim does for binary zeros that are actually received in header lines.
8980
8981 .next
8982 &%header%& tries to translate the string as decoded by &%bheader%& to a
8983 standard character set. This is an attempt to produce the same string as would
8984 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
8985 returned. Translation is attempted only on operating systems that support the
8986 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
8987 a system Makefile or in &_Local/Makefile_&.
8988 .endlist ilist
8989
8990 In a filter file, the target character set for &%header%& can be specified by a
8991 command of the following form:
8992 .code
8993 headers charset "UTF-8"
8994 .endd
8995 This command affects all references to &$h_$& (or &$header_$&) expansions in
8996 subsequently obeyed filter commands. In the absence of this command, the target
8997 character set in a filter is taken from the setting of the &%headers_charset%&
8998 option in the runtime configuration. The value of this option defaults to the
8999 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9000 ISO-8859-1.
9001
9002 Header names follow the syntax of RFC 2822, which states that they may contain
9003 any printing characters except space and colon. Consequently, curly brackets
9004 &'do not'& terminate header names, and should not be used to enclose them as
9005 if they were variables. Attempting to do so causes a syntax error.
9006
9007 Only header lines that are common to all copies of a message are visible to
9008 this mechanism. These are the original header lines that are received with the
9009 message, and any that are added by an ACL statement or by a system
9010 filter. Header lines that are added to a particular copy of a message by a
9011 router or transport are not accessible.
9012
9013 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9014 before the DATA ACL, because the header structure is not set up until the
9015 message is received. Header lines that are added in a RCPT ACL (for example)
9016 are saved until the message's incoming header lines are available, at which
9017 point they are added. When a DATA ACL is running, however, header lines added
9018 by earlier ACLs are visible.
9019
9020 Upper case and lower case letters are synonymous in header names. If the
9021 following character is white space, the terminating colon may be omitted, but
9022 this is not recommended, because you may then forget it when it is needed. When
9023 white space terminates the header name, it is included in the expanded string.
9024 If the message does not contain the given header, the expansion item is
9025 replaced by an empty string. (See the &%def%& condition in section
9026 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9027
9028 If there is more than one header with the same name, they are all concatenated
9029 to form the substitution string, up to a maximum length of 64K. Unless
9030 &%rheader%& is being used, leading and trailing white space is removed from
9031 each header before concatenation, and a completely empty header is ignored. A
9032 newline character is then inserted between non-empty headers, but there is no
9033 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9034 those headers that contain lists of addresses, a comma is also inserted at the
9035 junctions between headers. This does not happen for the &%rheader%& expansion.
9036
9037
9038 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9039 .cindex "expansion" "hmac hashing"
9040 .cindex &%hmac%&
9041 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9042 shared secret and some text into a message authentication code, as specified in
9043 RFC 2104. This differs from &`${md5:secret_text...}`& or
9044 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9045 cryptographic hash, allowing for authentication that is not possible with MD5
9046 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9047 present. For example:
9048 .code
9049 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9050 .endd
9051 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9052 produces:
9053 .code
9054 dd97e3ba5d1a61b5006108f8c8252953
9055 .endd
9056 As an example of how this might be used, you might put in the main part of
9057 an Exim configuration:
9058 .code
9059 SPAMSCAN_SECRET=cohgheeLei2thahw
9060 .endd
9061 In a router or a transport you could then have:
9062 .code
9063 headers_add = \
9064   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9065   ${hmac{md5}{SPAMSCAN_SECRET}\
9066   {${primary_hostname},${message_exim_id},$h_message-id:}}
9067 .endd
9068 Then given a message, you can check where it was scanned by looking at the
9069 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9070 this header line is authentic by recomputing the authentication code from the
9071 host name, message ID and the &'Message-id:'& header line. This can be done
9072 using Exim's &%-be%& option, or by other means, for example by using the
9073 &'hmac_md5_hex()'& function in Perl.
9074
9075
9076 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9077 .cindex "expansion" "conditional"
9078 .cindex "&%if%&, expansion item"
9079 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9080 item; otherwise <&'string2'&> is used. The available conditions are described
9081 in section &<<SECTexpcond>>& below. For example:
9082 .code
9083 ${if eq {$local_part}{postmaster} {yes}{no} }
9084 .endd
9085 The second string need not be present; if it is not and the condition is not
9086 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9087 be present instead of the second string (without any curly brackets). In this
9088 case, the expansion is forced to fail if the condition is not true (see section
9089 &<<SECTforexpfai>>&).
9090
9091 If both strings are omitted, the result is the string &`true`& if the condition
9092 is true, and the empty string if the condition is false. This makes it less
9093 cumbersome to write custom ACL and router conditions. For example, instead of
9094 .code
9095 condition = ${if >{$acl_m4}{3}{true}{false}}
9096 .endd
9097 you can use
9098 .code
9099 condition = ${if >{$acl_m4}{3}}
9100 .endd
9101
9102 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9103 .cindex "expansion" "string truncation"
9104 .cindex "&%length%& expansion item"
9105 The &%length%& item is used to extract the initial portion of a string. Both
9106 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9107 you are using a fixed value for the number, that is, if <&'string1'&> does not
9108 change when expanded, you can use the simpler operator notation that avoids
9109 some of the braces:
9110 .code
9111 ${length_<n>:<string>}
9112 .endd
9113 The result of this item is either the first <&'n'&> characters or the whole
9114 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9115 &%strlen%&, which gives the length of a string.
9116
9117
9118 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9119         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9120 This is the first of one of two different types of lookup item, which are both
9121 described in the next item.
9122
9123 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9124         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9125 .cindex "expansion" "lookup in"
9126 .cindex "file" "lookups"
9127 .cindex "lookup" "in expanded string"
9128 The two forms of lookup item specify data lookups in files and databases, as
9129 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9130 lookups, and the second is used for query-style lookups. The <&'key'&>,
9131 <&'file'&>, and <&'query'&> strings are expanded before use.
9132
9133 If there is any white space in a lookup item which is part of a filter command,
9134 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9135 other place where white space is significant, the lookup item must be enclosed
9136 in double quotes. The use of data lookups in users' filter files may be locked
9137 out by the system administrator.
9138
9139 .vindex "&$value$&"
9140 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9141 During its expansion, the variable &$value$& contains the data returned by the
9142 lookup. Afterwards it reverts to the value it had previously (at the outer
9143 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9144 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9145 string on failure. If <&'string2'&> is provided, it can itself be a nested
9146 lookup, thus providing a mechanism for looking up a default value when the
9147 original lookup fails.
9148
9149 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9150 data for the outer lookup while the parameters of the second lookup are
9151 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9152 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9153 appear, and in this case, if the lookup fails, the entire expansion is forced
9154 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9155 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9156 successful lookup, and nothing in the case of failure.
9157
9158 For single-key lookups, the string &"partial"& is permitted to precede the
9159 search type in order to do partial matching, and * or *@ may follow a search
9160 type to request default lookups if the key does not match (see sections
9161 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9162
9163 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9164 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9165 and non-wild parts of the key during the expansion of the replacement text.
9166 They return to their previous values at the end of the lookup item.
9167
9168 This example looks up the postmaster alias in the conventional alias file:
9169 .code
9170 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9171 .endd
9172 This example uses NIS+ to look up the full name of the user corresponding to
9173 the local part of an address, forcing the expansion to fail if it is not found:
9174 .code
9175 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9176   {$value}fail}
9177 .endd
9178
9179
9180 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9181 .cindex "expansion" "list creation"
9182 .vindex "&$item$&"
9183 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9184 default, but the separator can be changed in the usual way. For each item
9185 in this list, its value is place in &$item$&, and then <&'string2'&> is
9186 expanded and added to the output as an item in a new list. The separator used
9187 for the output list is the same as the one used for the input, but a separator
9188 setting is not included in the output. For example:
9189 .code
9190 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9191 .endd
9192 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9193 value of &$item$& is restored to what it was before. See also the &*filter*&
9194 and &*reduce*& expansion items.
9195
9196 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9197 .cindex "expansion" "numeric hash"
9198 .cindex "hash function" "numeric"
9199 The three strings are expanded; the first two must yield numbers. Call them
9200 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9201 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9202 can use the simpler operator notation that avoids some of the braces:
9203 .code
9204 ${nhash_<n>_<m>:<string>}
9205 .endd
9206 The second number is optional (in both notations). If there is only one number,
9207 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9208 processed by a div/mod hash function that returns two numbers, separated by a
9209 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9210 example,
9211 .code
9212 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9213 .endd
9214 returns the string &"6/33"&.
9215
9216
9217
9218 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9219 .cindex "Perl" "use in expanded string"
9220 .cindex "expansion" "calling Perl from"
9221 This item is available only if Exim has been built to include an embedded Perl
9222 interpreter. The subroutine name and the arguments are first separately
9223 expanded, and then the Perl subroutine is called with those arguments. No
9224 additional arguments need be given; the maximum number permitted, including the
9225 name of the subroutine, is nine.
9226
9227 The return value of the subroutine is inserted into the expanded string, unless
9228 the return value is &%undef%&. In that case, the expansion fails in the same
9229 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9230 Whatever you return is evaluated in a scalar context. For example, if you
9231 return the name of a Perl vector, the return value is the size of the vector,
9232 not its contents.
9233
9234 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9235 with the error message that was passed to &%die%&. More details of the embedded
9236 Perl facility are given in chapter &<<CHAPperl>>&.
9237
9238 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9239 out the use of this expansion item in filter files.
9240
9241
9242 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9243 .cindex "&%prvs%& expansion item"
9244 The first argument is a complete email address and the second is secret
9245 keystring. The third argument, specifying a key number, is optional. If absent,
9246 it defaults to 0. The result of the expansion is a prvs-signed email address,
9247 to be typically used with the &%return_path%& option on an &(smtp)& transport
9248 as part of a bounce address tag validation (BATV) scheme. For more discussion
9249 and an example, see section &<<SECTverifyPRVS>>&.
9250
9251 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9252         {*&<&'string'&>&*}}*&"
9253 .cindex "&%prvscheck%& expansion item"
9254 This expansion item is the complement of the &%prvs%& item. It is used for
9255 checking prvs-signed addresses. If the expansion of the first argument does not
9256 yield a syntactically valid prvs-signed address, the whole item expands to the
9257 empty string. When the first argument does expand to a syntactically valid
9258 prvs-signed address, the second argument is expanded, with the prvs-decoded
9259 version of the address and the key number extracted from the address in the
9260 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9261
9262 These two variables can be used in the expansion of the second argument to
9263 retrieve the secret. The validity of the prvs-signed address is then checked
9264 against the secret. The result is stored in the variable &$prvscheck_result$&,
9265 which is empty for failure or &"1"& for success.
9266
9267 The third argument is optional; if it is missing, it defaults to an empty
9268 string. This argument is now expanded. If the result is an empty string, the
9269 result of the expansion is the decoded version of the address. This is the case
9270 whether or not the signature was valid. Otherwise, the result of the expansion
9271 is the expansion of the third argument.
9272
9273 All three variables can be used in the expansion of the third argument.
9274 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9275 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9276
9277 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9278 .cindex "expansion" "inserting an entire file"
9279 .cindex "file" "inserting into expansion"
9280 .cindex "&%readfile%& expansion item"
9281 The file name and end-of-line string are first expanded separately. The file is
9282 then read, and its contents replace the entire item. All newline characters in
9283 the file are replaced by the end-of-line string if it is present. Otherwise,
9284 newlines are left in the string.
9285 String expansion is not applied to the contents of the file. If you want this,
9286 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9287 the string expansion fails.
9288
9289 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9290 locks out the use of this expansion item in filter files.
9291
9292
9293
9294 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9295         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9296 .cindex "expansion" "inserting from a socket"
9297 .cindex "socket, use of in expansion"
9298 .cindex "&%readsocket%& expansion item"
9299 This item inserts data from a Unix domain or Internet socket into the expanded
9300 string. The minimal way of using it uses just two arguments, as in these
9301 examples:
9302 .code
9303 ${readsocket{/socket/name}{request string}}
9304 ${readsocket{inet:some.host:1234}{request string}}
9305 .endd
9306 For a Unix domain socket, the first substring must be the path to the socket.
9307 For an Internet socket, the first substring must contain &`inet:`& followed by
9308 a host name or IP address, followed by a colon and a port, which can be a
9309 number or the name of a TCP port in &_/etc/services_&. An IP address may
9310 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9311 example:
9312 .code
9313 ${readsocket{inet:[::1]:1234}{request string}}
9314 .endd
9315 Only a single host name may be given, but if looking it up yields more than
9316 one IP address, they are each tried in turn until a connection is made. For
9317 both kinds of socket, Exim makes a connection, writes the request string
9318 (unless it is an empty string) and reads from the socket until an end-of-file
9319 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9320 extend what can be done. Firstly, you can vary the timeout. For example:
9321 .code
9322 ${readsocket{/socket/name}{request string}{3s}}
9323 .endd
9324 A fourth argument allows you to change any newlines that are in the data
9325 that is read, in the same way as for &%readfile%& (see above). This example
9326 turns them into spaces:
9327 .code
9328 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9329 .endd
9330 As with all expansions, the substrings are expanded before the processing
9331 happens. Errors in these sub-expansions cause the expansion to fail. In
9332 addition, the following errors can occur:
9333
9334 .ilist
9335 Failure to create a socket file descriptor;
9336 .next
9337 Failure to connect the socket;
9338 .next
9339 Failure to write the request string;
9340 .next
9341 Timeout on reading from the socket.
9342 .endlist
9343
9344 By default, any of these errors causes the expansion to fail. However, if
9345 you supply a fifth substring, it is expanded and used when any of the above
9346 errors occurs. For example:
9347 .code
9348 ${readsocket{/socket/name}{request string}{3s}{\n}\
9349   {socket failure}}
9350 .endd
9351 You can test for the existence of a Unix domain socket by wrapping this
9352 expansion in &`${if exists`&, but there is a race condition between that test
9353 and the actual opening of the socket, so it is safer to use the fifth argument
9354 if you want to be absolutely sure of avoiding an expansion error for a
9355 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9356
9357 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9358 locks out the use of this expansion item in filter files.
9359
9360
9361 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9362 .cindex "expansion" "reducing a list to a scalar"
9363 .cindex "list" "reducing to a scalar"
9364 .vindex "&$value$&"
9365 .vindex "&$item$&"
9366 This operation reduces a list to a single, scalar string. After expansion,
9367 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9368 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9369 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9370 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9371 them. The result of that expansion is assigned to &$value$& before the next
9372 iteration. When the end of the list is reached, the final value of &$value$& is
9373 added to the expansion output. The &*reduce*& expansion item can be used in a
9374 number of ways. For example, to add up a list of numbers:
9375 .code
9376 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9377 .endd
9378 The result of that expansion would be &`6`&. The maximum of a list of numbers
9379 can be found:
9380 .code
9381 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9382 .endd
9383 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9384 restored to what they were before. See also the &*filter*& and &*map*&
9385 expansion items.
9386
9387 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9388 This item inserts &"raw"& header lines. It is described with the &%header%&
9389 expansion item above.
9390
9391 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9392         {*&<&'string2'&>&*}}*&"
9393 .cindex "expansion" "running a command"
9394 .cindex "&%run%& expansion item"
9395 The command and its arguments are first expanded separately, and then the
9396 command is run in a separate process, but under the same uid and gid. As in
9397 other command executions from Exim, a shell is not used by default. If you want
9398 a shell, you must explicitly code it.
9399
9400 The standard input for the command exists, but is empty. The standard output
9401 and standard error are set to the same file descriptor.
9402 .cindex "return code" "from &%run%& expansion"
9403 .vindex "&$value$&"
9404 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9405 and replaces the entire item; during this expansion, the standard output/error
9406 from the command is in the variable &$value$&. If the command fails,
9407 <&'string2'&>, if present, is expanded and used. Once again, during the
9408 expansion, the standard output/error from the command is in the variable
9409 &$value$&.
9410
9411 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9412 can be the word &"fail"& (not in braces) to force expansion failure if the
9413 command does not succeed. If both strings are omitted, the result is contents
9414 of the standard output/error on success, and nothing on failure.
9415
9416 .vindex "&$run_in_acl$&"
9417 The standard output/error of the command is put in the variable &$value$&.
9418 In this ACL example, the output of a command is logged for the admin to
9419 troubleshoot:
9420 .code
9421 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9422       log_message  = Output of id: $value
9423 .endd
9424 If the command requires shell idioms, such as the > redirect operator, the
9425 shell must be invoked directly, such as with:
9426 .code
9427 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9428 .endd
9429
9430 .vindex "&$runrc$&"
9431 The return code from the command is put in the variable &$runrc$&, and this
9432 remains set afterwards, so in a filter file you can do things like this:
9433 .code
9434 if "${run{x y z}{}}$runrc" is 1 then ...
9435   elif $runrc is 2 then ...
9436   ...
9437 endif
9438 .endd
9439 If execution of the command fails (for example, the command does not exist),
9440 the return code is 127 &-- the same code that shells use for non-existent
9441 commands.
9442
9443 &*Warning*&: In a router or transport, you cannot assume the order in which
9444 option values are expanded, except for those preconditions whose order of
9445 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9446 by the expansion of one option, and use it in another.
9447
9448 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9449 out the use of this expansion item in filter files.
9450
9451
9452 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9453 .cindex "expansion" "string substitution"
9454 .cindex "&%sg%& expansion item"
9455 This item works like Perl's substitution operator (s) with the global (/g)
9456 option; hence its name. However, unlike the Perl equivalent, Exim does not
9457 modify the subject string; instead it returns the modified string for insertion
9458 into the overall expansion. The item takes three arguments: the subject string,
9459 a regular expression, and a substitution string. For example:
9460 .code
9461 ${sg{abcdefabcdef}{abc}{xyz}}
9462 .endd
9463 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9464 if any $ or \ characters are required in the regular expression or in the
9465 substitution string, they have to be escaped. For example:
9466 .code
9467 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9468 .endd
9469 yields &"defabc"&, and
9470 .code
9471 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9472 .endd
9473 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9474 the regular expression from string expansion.
9475
9476
9477
9478 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9479 .cindex "&%substr%& expansion item"
9480 .cindex "substring extraction"
9481 .cindex "expansion" "substring extraction"
9482 The three strings are expanded; the first two must yield numbers. Call them
9483 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9484 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9485 can use the simpler operator notation that avoids some of the braces:
9486 .code
9487 ${substr_<n>_<m>:<string>}
9488 .endd
9489 The second number is optional (in both notations).
9490 If it is absent in the simpler format, the preceding underscore must also be
9491 omitted.
9492
9493 The &%substr%& item can be used to extract more general substrings than
9494 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9495 length required. For example
9496 .code
9497 ${substr{3}{2}{$local_part}}
9498 .endd
9499 If the starting offset is greater than the string length the result is the
9500 null string; if the length plus starting offset is greater than the string
9501 length, the result is the right-hand part of the string, starting from the
9502 given offset. The first character in the string has offset zero.
9503
9504 The &%substr%& expansion item can take negative offset values to count
9505 from the right-hand end of its operand. The last character is offset -1, the
9506 second-last is offset -2, and so on. Thus, for example,
9507 .code
9508 ${substr{-5}{2}{1234567}}
9509 .endd
9510 yields &"34"&. If the absolute value of a negative offset is greater than the
9511 length of the string, the substring starts at the beginning of the string, and
9512 the length is reduced by the amount of overshoot. Thus, for example,
9513 .code
9514 ${substr{-5}{2}{12}}
9515 .endd
9516 yields an empty string, but
9517 .code
9518 ${substr{-3}{2}{12}}
9519 .endd
9520 yields &"1"&.
9521
9522 When the second number is omitted from &%substr%&, the remainder of the string
9523 is taken if the offset is positive. If it is negative, all characters in the
9524 string preceding the offset point are taken. For example, an offset of -1 and
9525 no length, as in these semantically identical examples:
9526 .code
9527 ${substr_-1:abcde}
9528 ${substr{-1}{abcde}}
9529 .endd
9530 yields all but the last character of the string, that is, &"abcd"&.
9531
9532
9533
9534 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9535         {*&<&'replacements'&>&*}}*&"
9536 .cindex "expansion" "character translation"
9537 .cindex "&%tr%& expansion item"
9538 This item does single-character translation on its subject string. The second
9539 argument is a list of characters to be translated in the subject string. Each
9540 matching character is replaced by the corresponding character from the
9541 replacement list. For example
9542 .code
9543 ${tr{abcdea}{ac}{13}}
9544 .endd
9545 yields &`1b3de1`&. If there are duplicates in the second character string, the
9546 last occurrence is used. If the third string is shorter than the second, its
9547 last character is replicated. However, if it is empty, no translation takes
9548 place.
9549 .endlist
9550
9551
9552
9553 .section "Expansion operators" "SECTexpop"
9554 .cindex "expansion" "operators"
9555 For expansion items that perform transformations on a single argument string,
9556 the &"operator"& notation is used because it is simpler and uses fewer braces.
9557 The substring is first expanded before the operation is applied to it. The
9558 following operations can be performed:
9559
9560 .vlist
9561 .vitem &*${address:*&<&'string'&>&*}*&
9562 .cindex "expansion" "RFC 2822 address handling"
9563 .cindex "&%address%& expansion item"
9564 The string is interpreted as an RFC 2822 address, as it might appear in a
9565 header line, and the effective address is extracted from it. If the string does
9566 not parse successfully, the result is empty.
9567
9568
9569 .vitem &*${addresses:*&<&'string'&>&*}*&
9570 .cindex "expansion" "RFC 2822 address handling"
9571 .cindex "&%addresses%& expansion item"
9572 The string (after expansion) is interpreted as a list of addresses in RFC
9573 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9574 operative address (&'local-part@domain'&) is extracted from each item, and the
9575 result of the expansion is a colon-separated list, with appropriate
9576 doubling of colons should any happen to be present in the email addresses.
9577 Syntactically invalid RFC2822 address items are omitted from the output.
9578
9579 It is possible to specify a character other than colon for the output
9580 separator by starting the string with > followed by the new separator
9581 character. For example:
9582 .code
9583 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9584 .endd
9585 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9586 expansion item, which extracts the working address from a single RFC2822
9587 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9588 processing lists.
9589
9590
9591 .vitem &*${base62:*&<&'digits'&>&*}*&
9592 .cindex "&%base62%& expansion item"
9593 .cindex "expansion" "conversion to base 62"
9594 The string must consist entirely of decimal digits. The number is converted to
9595 base 62 and output as a string of six characters, including leading zeros. In
9596 the few operating environments where Exim uses base 36 instead of base 62 for
9597 its message identifiers (because those systems do not have case-sensitive file
9598 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9599 be absolutely clear: this is &'not'& base64 encoding.
9600
9601 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9602 .cindex "&%base62d%& expansion item"
9603 .cindex "expansion" "conversion to base 62"
9604 The string must consist entirely of base-62 digits, or, in operating
9605 environments where Exim uses base 36 instead of base 62 for its message
9606 identifiers, base-36 digits. The number is converted to decimal and output as a
9607 string.
9608
9609
9610 .vitem &*${domain:*&<&'string'&>&*}*&
9611 .cindex "domain" "extraction"
9612 .cindex "expansion" "domain extraction"
9613 The string is interpreted as an RFC 2822 address and the domain is extracted
9614 from it. If the string does not parse successfully, the result is empty.
9615
9616
9617 .vitem &*${escape:*&<&'string'&>&*}*&
9618 .cindex "expansion" "escaping non-printing characters"
9619 .cindex "&%escape%& expansion item"
9620 If the string contains any non-printing characters, they are converted to
9621 escape sequences starting with a backslash. Whether characters with the most
9622 significant bit set (so-called &"8-bit characters"&) count as printing or not
9623 is controlled by the &%print_topbitchars%& option.
9624
9625
9626 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9627 .cindex "expansion" "expression evaluation"
9628 .cindex "expansion" "arithmetic expression"
9629 .cindex "&%eval%& expansion item"
9630 These items supports simple arithmetic and bitwise logical operations in
9631 expansion strings. The string (after expansion) must be a conventional
9632 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9633 logical operators, and parentheses. All operations are carried out using
9634 integer arithmetic. The operator priorities are as follows (the same as in the
9635 C programming language):
9636 .table2 70pt 300pt
9637 .irow &'highest:'& "not (~), negate (-)"
9638 .irow ""   "multiply (*), divide (/), remainder (%)"
9639 .irow ""   "plus (+), minus (-)"
9640 .irow ""   "shift-left (<<), shift-right (>>)"
9641 .irow ""   "and (&&)"
9642 .irow ""   "xor (^)"
9643 .irow &'lowest:'&  "or (|)"
9644 .endtable
9645 Binary operators with the same priority are evaluated from left to right. White
9646 space is permitted before or after operators.
9647
9648 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9649 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9650 decimal, even if they start with a leading zero; hexadecimal numbers are not
9651 permitted. This can be useful when processing numbers extracted from dates or
9652 times, which often do have leading zeros.
9653
9654 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9655 or 1024*1024*1024,
9656 respectively. Negative numbers are supported. The result of the computation is
9657 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9658
9659 .display
9660 &`${eval:1+1}            `&  yields 2
9661 &`${eval:1+2*3}          `&  yields 7
9662 &`${eval:(1+2)*3}        `&  yields 9
9663 &`${eval:2+42%5}         `&  yields 4
9664 &`${eval:0xc&amp;5}          `&  yields 4
9665 &`${eval:0xc|5}          `&  yields 13
9666 &`${eval:0xc^5}          `&  yields 9
9667 &`${eval:0xc>>1}         `&  yields 6
9668 &`${eval:0xc<<1}         `&  yields 24
9669 &`${eval:~255&amp;0x1234}    `&  yields 4608
9670 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9671 .endd
9672
9673 As a more realistic example, in an ACL you might have
9674 .code
9675 deny   message = Too many bad recipients
9676        condition =                    \
9677          ${if and {                   \
9678            {>{$rcpt_count}{10}}       \
9679            {                          \
9680            <                          \
9681              {$recipients_count}      \
9682              {${eval:$rcpt_count/2}}  \
9683            }                          \
9684          }{yes}{no}}
9685 .endd
9686 The condition is true if there have been more than 10 RCPT commands and
9687 fewer than half of them have resulted in a valid recipient.
9688
9689
9690 .vitem &*${expand:*&<&'string'&>&*}*&
9691 .cindex "expansion" "re-expansion of substring"
9692 The &%expand%& operator causes a string to be expanded for a second time. For
9693 example,
9694 .code
9695 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9696 .endd
9697 first looks up a string in a file while expanding the operand for &%expand%&,
9698 and then re-expands what it has found.
9699
9700
9701 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9702 .cindex "Unicode"
9703 .cindex "UTF-8" "conversion from"
9704 .cindex "expansion" "UTF-8 conversion"
9705 .cindex "&%from_utf8%& expansion item"
9706 The world is slowly moving towards Unicode, although there are no standards for
9707 email yet. However, other applications (including some databases) are starting
9708 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9709 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9710 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9711 the result is an undefined sequence of bytes.
9712
9713 Unicode code points with values less than 256 are compatible with ASCII and
9714 ISO-8859-1 (also known as Latin-1).
9715 For example, character 169 is the copyright symbol in both cases, though the
9716 way it is encoded is different. In UTF-8, more than one byte is needed for
9717 characters with code values greater than 127, whereas ISO-8859-1 is a
9718 single-byte encoding (but thereby limited to 256 characters). This makes
9719 translation from UTF-8 to ISO-8859-1 straightforward.
9720
9721
9722 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9723 .cindex "hash function" "textual"
9724 .cindex "expansion" "textual hash"
9725 The &%hash%& operator is a simpler interface to the hashing function that can
9726 be used when the two parameters are fixed numbers (as opposed to strings that
9727 change when expanded). The effect is the same as
9728 .code
9729 ${hash{<n>}{<m>}{<string>}}
9730 .endd
9731 See the description of the general &%hash%& item above for details. The
9732 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9733
9734
9735
9736 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9737 .cindex "base64 encoding" "conversion from hex"
9738 .cindex "expansion" "hex to base64"
9739 .cindex "&%hex2b64%& expansion item"
9740 This operator converts a hex string into one that is base64 encoded. This can
9741 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9742
9743
9744 .vitem &*${lc:*&<&'string'&>&*}*&
9745 .cindex "case forcing in strings"
9746 .cindex "string" "case forcing"
9747 .cindex "lower casing"
9748 .cindex "expansion" "case forcing"
9749 .cindex "&%lc%& expansion item"
9750 This forces the letters in the string into lower-case, for example:
9751 .code
9752 ${lc:$local_part}
9753 .endd
9754
9755 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9756 .cindex "expansion" "string truncation"
9757 .cindex "&%length%& expansion item"
9758 The &%length%& operator is a simpler interface to the &%length%& function that
9759 can be used when the parameter is a fixed number (as opposed to a string that
9760 changes when expanded). The effect is the same as
9761 .code
9762 ${length{<number>}{<string>}}
9763 .endd
9764 See the description of the general &%length%& item above for details. Note that
9765 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9766 when &%length%& is used as an operator.
9767
9768
9769 .vitem &*${listcount:*&<&'string'&>&*}*&
9770 .cindex "expansion" "list item count"
9771 .cindex "list" "item count"
9772 .cindex "list" "count of items"
9773 .cindex "&%listcount%& expansion item"
9774 The string is interpreted as a list and the number of items is returned.
9775
9776
9777 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${list_*&<&'type'&>&*name*&>&*}*&
9778 .cindex "expansion" "named list"
9779 .cindex "&%listnamed%& expansion item"
9780 The name is interpreted as a named list and the content of the list is returned,
9781 expanding any referenced lists, re-quoting as needed for colon-separation.
9782 If the optional type if given it must be one of "a", "d", "h" or "l"
9783 and selects address-, domain-, host- or localpart- lists to search among respectively.
9784 Otherwise all types are searched in an undefined order and the first
9785 matching list is returned.
9786
9787
9788 .vitem &*${local_part:*&<&'string'&>&*}*&
9789 .cindex "expansion" "local part extraction"
9790 .cindex "&%local_part%& expansion item"
9791 The string is interpreted as an RFC 2822 address and the local part is
9792 extracted from it. If the string does not parse successfully, the result is
9793 empty.
9794
9795
9796 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9797 .cindex "masked IP address"
9798 .cindex "IP address" "masking"
9799 .cindex "CIDR notation"
9800 .cindex "expansion" "IP address masking"
9801 .cindex "&%mask%& expansion item"
9802 If the form of the string to be operated on is not an IP address followed by a
9803 slash and an integer (that is, a network address in CIDR notation), the
9804 expansion fails. Otherwise, this operator converts the IP address to binary,
9805 masks off the least significant bits according to the bit count, and converts
9806 the result back to text, with mask appended. For example,
9807 .code
9808 ${mask:10.111.131.206/28}
9809 .endd
9810 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9811 be mostly used for looking up masked addresses in files, the result for an IPv6
9812 address uses dots to separate components instead of colons, because colon
9813 terminates a key string in lsearch files. So, for example,
9814 .code
9815 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9816 .endd
9817 returns the string
9818 .code
9819 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9820 .endd
9821 Letters in IPv6 addresses are always output in lower case.
9822
9823
9824 .vitem &*${md5:*&<&'string'&>&*}*&
9825 .cindex "MD5 hash"
9826 .cindex "expansion" "MD5 hash"
9827 .cindex "&%md5%& expansion item"
9828 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9829 as a 32-digit hexadecimal number, in which any letters are in lower case.
9830
9831
9832 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9833 .cindex "expansion" "numeric hash"
9834 .cindex "hash function" "numeric"
9835 The &%nhash%& operator is a simpler interface to the numeric hashing function
9836 that can be used when the two parameters are fixed numbers (as opposed to
9837 strings that change when expanded). The effect is the same as
9838 .code
9839 ${nhash{<n>}{<m>}{<string>}}
9840 .endd
9841 See the description of the general &%nhash%& item above for details.
9842
9843
9844 .vitem &*${quote:*&<&'string'&>&*}*&
9845 .cindex "quoting" "in string expansions"
9846 .cindex "expansion" "quoting"
9847 .cindex "&%quote%& expansion item"
9848 The &%quote%& operator puts its argument into double quotes if it
9849 is an empty string or
9850 contains anything other than letters, digits, underscores, dots, and hyphens.
9851 Any occurrences of double quotes and backslashes are escaped with a backslash.
9852 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9853 respectively For example,
9854 .code
9855 ${quote:ab"*"cd}
9856 .endd
9857 becomes
9858 .code
9859 "ab\"*\"cd"
9860 .endd
9861 The place where this is useful is when the argument is a substitution from a
9862 variable or a message header.
9863
9864 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9865 .cindex "&%quote_local_part%& expansion item"
9866 This operator is like &%quote%&, except that it quotes the string only if
9867 required to do so by the rules of RFC 2822 for quoting local parts. For
9868 example, a plus sign would not cause quoting (but it would for &%quote%&).
9869 If you are creating a new email address from the contents of &$local_part$&
9870 (or any other unknown data), you should always use this operator.
9871
9872
9873 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9874 .cindex "quoting" "lookup-specific"
9875 This operator applies lookup-specific quoting rules to the string. Each
9876 query-style lookup type has its own quoting rules which are described with
9877 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9878 .code
9879 ${quote_ldap:two * two}
9880 .endd
9881 returns
9882 .code
9883 two%20%5C2A%20two
9884 .endd
9885 For single-key lookup types, no quoting is ever necessary and this operator
9886 yields an unchanged string.
9887
9888
9889 .vitem &*${randint:*&<&'n'&>&*}*&
9890 .cindex "random number"
9891 This operator returns a somewhat random number which is less than the
9892 supplied number and is at least 0.  The quality of this randomness depends
9893 on how Exim was built; the values are not suitable for keying material.
9894 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
9895 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
9896 for versions of GnuTLS with that function.
9897 Otherwise, the implementation may be arc4random(), random() seeded by
9898 srandomdev() or srandom(), or a custom implementation even weaker than
9899 random().
9900
9901
9902 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
9903 .cindex "expansion" "IP address"
9904 This operator reverses an IP address; for IPv4 addresses, the result is in
9905 dotted-quad decimal form, while for IPv6 addreses the result is in
9906 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
9907 for DNS.  For example,
9908 .code
9909 ${reverse_ip:192.0.2.4}
9910 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.3}
9911 .endd
9912 returns
9913 .code
9914 4.2.0.192
9915 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
9916 .endd
9917
9918
9919 .vitem &*${rfc2047:*&<&'string'&>&*}*&
9920 .cindex "expansion" "RFC 2047"
9921 .cindex "RFC 2047" "expansion operator"
9922 .cindex "&%rfc2047%& expansion item"
9923 This operator encodes text according to the rules of RFC 2047. This is an
9924 encoding that is used in header lines to encode non-ASCII characters. It is
9925 assumed that the input string is in the encoding specified by the
9926 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
9927 contains only characters in the range 33&--126, and no instances of the
9928 characters
9929 .code
9930 ? = ( ) < > @ , ; : \ " . [ ] _
9931 .endd
9932 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
9933 string, using as many &"encoded words"& as necessary to encode all the
9934 characters.
9935
9936
9937 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
9938 .cindex "expansion" "RFC 2047"
9939 .cindex "RFC 2047" "decoding"
9940 .cindex "&%rfc2047d%& expansion item"
9941 This operator decodes strings that are encoded as per RFC 2047. Binary zero
9942 bytes are replaced by question marks. Characters are converted into the
9943 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
9944 not recognized unless &%check_rfc2047_length%& is set false.
9945
9946 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
9947 access a header line, RFC 2047 decoding is done automatically. You do not need
9948 to use this operator as well.
9949
9950
9951
9952 .vitem &*${rxquote:*&<&'string'&>&*}*&
9953 .cindex "quoting" "in regular expressions"
9954 .cindex "regular expressions" "quoting"
9955 .cindex "&%rxquote%& expansion item"
9956 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
9957 characters in its argument. This is useful when substituting the values of
9958 variables or headers inside regular expressions.
9959
9960
9961 .vitem &*${sha1:*&<&'string'&>&*}*&
9962 .cindex "SHA-1 hash"
9963 .cindex "expansion" "SHA-1 hashing"
9964 .cindex "&%sha2%& expansion item"
9965 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
9966 it as a 40-digit hexadecimal number, in which any letters are in upper case.
9967
9968
9969 .vitem &*${stat:*&<&'string'&>&*}*&
9970 .cindex "expansion" "statting a file"
9971 .cindex "file" "extracting characteristics"
9972 .cindex "&%stat%& expansion item"
9973 The string, after expansion, must be a file path. A call to the &[stat()]&
9974 function is made for this path. If &[stat()]& fails, an error occurs and the
9975 expansion fails. If it succeeds, the data from the stat replaces the item, as a
9976 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
9977 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
9978 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
9979 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
9980 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
9981 can extract individual fields using the &%extract%& expansion item.
9982
9983 The use of the &%stat%& expansion in users' filter files can be locked out by
9984 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
9985 systems for files larger than 2GB.
9986
9987 .vitem &*${str2b64:*&<&'string'&>&*}*&
9988 .cindex "expansion" "base64 encoding"
9989 .cindex "base64 encoding" "in string expansion"
9990 .cindex "&%str2b64%& expansion item"
9991 This operator converts a string into one that is base64 encoded.
9992
9993
9994
9995 .vitem &*${strlen:*&<&'string'&>&*}*&
9996 .cindex "expansion" "string length"
9997 .cindex "string" "length in expansion"
9998 .cindex "&%strlen%& expansion item"
9999 The item is replace by the length of the expanded string, expressed as a
10000 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10001
10002
10003 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10004 .cindex "&%substr%& expansion item"
10005 .cindex "substring extraction"
10006 .cindex "expansion" "substring expansion"
10007 The &%substr%& operator is a simpler interface to the &%substr%& function that
10008 can be used when the two parameters are fixed numbers (as opposed to strings
10009 that change when expanded). The effect is the same as
10010 .code
10011 ${substr{<start>}{<length>}{<string>}}
10012 .endd
10013 See the description of the general &%substr%& item above for details. The
10014 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10015
10016 .vitem &*${time_eval:*&<&'string'&>&*}*&
10017 .cindex "&%time_eval%& expansion item"
10018 .cindex "time interval" "decoding"
10019 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10020 seconds.
10021
10022 .vitem &*${time_interval:*&<&'string'&>&*}*&
10023 .cindex "&%time_interval%& expansion item"
10024 .cindex "time interval" "formatting"
10025 The argument (after sub-expansion) must be a sequence of decimal digits that
10026 represents an interval of time as a number of seconds. It is converted into a
10027 number of larger units and output in Exim's normal time format, for example,
10028 &`1w3d4h2m6s`&.
10029
10030 .vitem &*${uc:*&<&'string'&>&*}*&
10031 .cindex "case forcing in strings"
10032 .cindex "string" "case forcing"
10033 .cindex "upper casing"
10034 .cindex "expansion" "case forcing"
10035 .cindex "&%uc%& expansion item"
10036 This forces the letters in the string into upper-case.
10037 .endlist
10038
10039
10040
10041
10042
10043
10044 .section "Expansion conditions" "SECTexpcond"
10045 .scindex IIDexpcond "expansion" "conditions"
10046 The following conditions are available for testing by the &%${if%& construct
10047 while expanding strings:
10048
10049 .vlist
10050 .vitem &*!*&<&'condition'&>
10051 .cindex "expansion" "negating a condition"
10052 .cindex "negation" "in expansion condition"
10053 Preceding any condition with an exclamation mark negates the result of the
10054 condition.
10055
10056 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10057 .cindex "numeric comparison"
10058 .cindex "expansion" "numeric comparison"
10059 There are a number of symbolic operators for doing numeric comparisons. They
10060 are:
10061 .display
10062 &`=   `&   equal
10063 &`==  `&   equal
10064 &`>   `&   greater
10065 &`>=  `&   greater or equal
10066 &`<   `&   less
10067 &`<=  `&   less or equal
10068 .endd
10069 For example:
10070 .code
10071 ${if >{$message_size}{10M} ...
10072 .endd
10073 Note that the general negation operator provides for inequality testing. The
10074 two strings must take the form of optionally signed decimal integers,
10075 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10076 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10077 As a special case, the numerical value of an empty string is taken as
10078 zero.
10079
10080 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10081 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10082 10M, not if 10M is larger than &$message_size$&.
10083
10084
10085 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10086         {*&<&'arg2'&>&*}...}*&
10087 .cindex "expansion" "calling an acl"
10088 .cindex "&%acl%&" "expansion condition"
10089 The name and zero to nine argument strings are first expanded separately.  The expanded
10090 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10091 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10092 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10093 and may use the variables; if another acl expansion is used the values
10094 are overwritten.  If the ACL sets
10095 a value using a "message =" modifier the variable $value becomes
10096 the result of the expansion, otherwise it is empty.
10097 If the ACL returns accept the condition is true; if deny, false.
10098 If the ACL returns defer the result is a forced-fail.
10099
10100 .vitem &*bool&~{*&<&'string'&>&*}*&
10101 .cindex "expansion" "boolean parsing"
10102 .cindex "&%bool%& expansion condition"
10103 This condition turns a string holding a true or false representation into
10104 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10105 (case-insensitively); also positive integer numbers map to true if non-zero,
10106 false if zero.
10107 An empty string is treated as false.
10108 Leading and trailing whitespace is ignored;
10109 thus a string consisting only of whitespace is false.
10110 All other string values will result in expansion failure.
10111
10112 When combined with ACL variables, this expansion condition will let you
10113 make decisions in one place and act on those decisions in another place.
10114 For example:
10115 .code
10116 ${if bool{$acl_m_privileged_sender} ...
10117 .endd
10118
10119
10120 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10121 .cindex "expansion" "boolean parsing"
10122 .cindex "&%bool_lax%& expansion condition"
10123 Like &%bool%&, this condition turns a string into a boolean state.  But
10124 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10125 loose definition that the Router &%condition%& option uses.  The empty string
10126 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10127 true.  Leading and trailing whitespace is ignored.
10128
10129 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10130
10131 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10132 .cindex "expansion" "encrypted comparison"
10133 .cindex "encrypted strings, comparing"
10134 .cindex "&%crypteq%& expansion condition"
10135 This condition is included in the Exim binary if it is built to support any
10136 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10137 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10138 included in the binary.
10139
10140 The &%crypteq%& condition has two arguments. The first is encrypted and
10141 compared against the second, which is already encrypted. The second string may
10142 be in the LDAP form for storing encrypted strings, which starts with the
10143 encryption type in curly brackets, followed by the data. If the second string
10144 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10145 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10146 Typically this will be a field from a password file. An example of an encrypted
10147 string in LDAP form is:
10148 .code
10149 {md5}CY9rzUYh03PK3k6DJie09g==
10150 .endd
10151 If such a string appears directly in an expansion, the curly brackets have to
10152 be quoted, because they are part of the expansion syntax. For example:
10153 .code
10154 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10155 .endd
10156 The following encryption types (whose names are matched case-independently) are
10157 supported:
10158
10159 .ilist
10160 .cindex "MD5 hash"
10161 .cindex "base64 encoding" "in encrypted password"
10162 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10163 printable characters to compare with the remainder of the second string. If the
10164 length of the comparison string is 24, Exim assumes that it is base64 encoded
10165 (as in the above example). If the length is 32, Exim assumes that it is a
10166 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10167 comparison fails.
10168
10169 .next
10170 .cindex "SHA-1 hash"
10171 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10172 printable characters to compare with the remainder of the second string. If the
10173 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10174 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10175 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10176
10177 .next
10178 .cindex "&[crypt()]&"
10179 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10180 only the first eight characters of the password. However, in modern operating
10181 systems this is no longer true, and in many cases the entire password is used,
10182 whatever its length.
10183
10184 .next
10185 .cindex "&[crypt16()]&"
10186 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10187 use up to 16 characters of the password in some operating systems. Again, in
10188 modern operating systems, more characters may be used.
10189 .endlist
10190 Exim has its own version of &[crypt16()]&, which is just a double call to
10191 &[crypt()]&. For operating systems that have their own version, setting
10192 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10193 operating system version instead of its own. This option is set by default in
10194 the OS-dependent &_Makefile_& for those operating systems that are known to
10195 support &[crypt16()]&.
10196
10197 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10198 it was not using the same algorithm as some operating systems' versions. It
10199 turns out that as well as &[crypt16()]& there is a function called
10200 &[bigcrypt()]& in some operating systems. This may or may not use the same
10201 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10202
10203 However, since there is now a move away from the traditional &[crypt()]&
10204 functions towards using SHA1 and other algorithms, tidying up this area of
10205 Exim is seen as very low priority.
10206
10207 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10208 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10209 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10210 default is &`{crypt}`&. Whatever the default, you can always use either
10211 function by specifying it explicitly in curly brackets.
10212
10213 .vitem &*def:*&<&'variable&~name'&>
10214 .cindex "expansion" "checking for empty variable"
10215 .cindex "&%def%& expansion condition"
10216 The &%def%& condition must be followed by the name of one of the expansion
10217 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10218 variable does not contain the empty string. For example:
10219 .code
10220 ${if def:sender_ident {from $sender_ident}}
10221 .endd
10222 Note that the variable name is given without a leading &%$%& character. If the
10223 variable does not exist, the expansion fails.
10224
10225 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10226         &~&*def:h_*&<&'header&~name'&>&*:*&"
10227 .cindex "expansion" "checking header line existence"
10228 This condition is true if a message is being processed and the named header
10229 exists in the message. For example,
10230 .code
10231 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10232 .endd
10233 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10234 the header name must be terminated by a colon if white space does not follow.
10235
10236 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10237        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10238 .cindex "string" "comparison"
10239 .cindex "expansion" "string comparison"
10240 .cindex "&%eq%& expansion condition"
10241 .cindex "&%eqi%& expansion condition"
10242 The two substrings are first expanded. The condition is true if the two
10243 resulting strings are identical. For &%eq%& the comparison includes the case of
10244 letters, whereas for &%eqi%& the comparison is case-independent.
10245
10246 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10247 .cindex "expansion" "file existence test"
10248 .cindex "file" "existence test"
10249 .cindex "&%exists%&, expansion condition"
10250 The substring is first expanded and then interpreted as an absolute path. The
10251 condition is true if the named file (or directory) exists. The existence test
10252 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10253 users' filter files may be locked out by the system administrator.
10254
10255 .vitem &*first_delivery*&
10256 .cindex "delivery" "first"
10257 .cindex "first delivery"
10258 .cindex "expansion" "first delivery test"
10259 .cindex "&%first_delivery%& expansion condition"
10260 This condition, which has no data, is true during a message's first delivery
10261 attempt. It is false during any subsequent delivery attempts.
10262
10263
10264 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10265        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10266 .cindex "list" "iterative conditions"
10267 .cindex "expansion" "&*forall*& condition"
10268 .cindex "expansion" "&*forany*& condition"
10269 .vindex "&$item$&"
10270 These conditions iterate over a list. The first argument is expanded to form
10271 the list. By default, the list separator is a colon, but it can be changed by
10272 the normal method. The second argument is interpreted as a condition that is to
10273 be applied to each item in the list in turn. During the interpretation of the
10274 condition, the current list item is placed in a variable called &$item$&.
10275 .ilist
10276 For &*forany*&, interpretation stops if the condition is true for any item, and
10277 the result of the whole condition is true. If the condition is false for all
10278 items in the list, the overall condition is false.
10279 .next
10280 For &*forall*&, interpretation stops if the condition is false for any item,
10281 and the result of the whole condition is false. If the condition is true for
10282 all items in the list, the overall condition is true.
10283 .endlist
10284 Note that negation of &*forany*& means that the condition must be false for all
10285 items for the overall condition to succeed, and negation of &*forall*& means
10286 that the condition must be false for at least one item. In this example, the
10287 list separator is changed to a comma:
10288 .code
10289 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10290 .endd
10291 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10292 being processed, to enable these expansion items to be nested.
10293
10294
10295 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10296        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10297 .cindex "string" "comparison"
10298 .cindex "expansion" "string comparison"
10299 .cindex "&%ge%& expansion condition"
10300 .cindex "&%gei%& expansion condition"
10301 The two substrings are first expanded. The condition is true if the first
10302 string is lexically greater than or equal to the second string. For &%ge%& the
10303 comparison includes the case of letters, whereas for &%gei%& the comparison is
10304 case-independent.
10305
10306 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10307        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10308 .cindex "string" "comparison"
10309 .cindex "expansion" "string comparison"
10310 .cindex "&%gt%& expansion condition"
10311 .cindex "&%gti%& expansion condition"
10312 The two substrings are first expanded. The condition is true if the first
10313 string is lexically greater than the second string. For &%gt%& the comparison
10314 includes the case of letters, whereas for &%gti%& the comparison is
10315 case-independent.
10316
10317 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10318        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10319 .cindex "string" "comparison"
10320 .cindex "list" "iterative conditions"
10321 Both strings are expanded; the second string is treated as a list of simple
10322 strings; if the first string is a member of the second, then the condition
10323 is true.
10324
10325 These are simpler to use versions of the more powerful &*forany*& condition.
10326 Examples, and the &*forany*& equivalents:
10327 .code
10328 ${if inlist{needle}{foo:needle:bar}}
10329   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10330 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10331   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10332 .endd
10333
10334 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10335        &*isip4&~{*&<&'string'&>&*}*& &&&
10336        &*isip6&~{*&<&'string'&>&*}*&
10337 .cindex "IP address" "testing string format"
10338 .cindex "string" "testing for IP address"
10339 .cindex "&%isip%& expansion condition"
10340 .cindex "&%isip4%& expansion condition"
10341 .cindex "&%isip6%& expansion condition"
10342 The substring is first expanded, and then tested to see if it has the form of
10343 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10344 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10345
10346 For an IPv4 address, the test is for four dot-separated components, each of
10347 which consists of from one to three digits. For an IPv6 address, up to eight
10348 colon-separated components are permitted, each containing from one to four
10349 hexadecimal digits. There may be fewer than eight components if an empty
10350 component (adjacent colons) is present. Only one empty component is permitted.
10351
10352 &*Note*&: The checks are just on the form of the address; actual numerical
10353 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10354 check. The main use of these tests is to distinguish between IP addresses and
10355 host names, or between IPv4 and IPv6 addresses. For example, you could use
10356 .code
10357 ${if isip4{$sender_host_address}...
10358 .endd
10359 to test which IP version an incoming SMTP connection is using.
10360
10361 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10362 .cindex "LDAP" "use for authentication"
10363 .cindex "expansion" "LDAP authentication test"
10364 .cindex "&%ldapauth%& expansion condition"
10365 This condition supports user authentication using LDAP. See section
10366 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10367 queries. For this use, the query must contain a user name and password. The
10368 query itself is not used, and can be empty. The condition is true if the
10369 password is not empty, and the user name and password are accepted by the LDAP
10370 server. An empty password is rejected without calling LDAP because LDAP binds
10371 with an empty password are considered anonymous regardless of the username, and
10372 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10373 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10374 this can be used.
10375
10376
10377 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10378        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10379 .cindex "string" "comparison"
10380 .cindex "expansion" "string comparison"
10381 .cindex "&%le%& expansion condition"
10382 .cindex "&%lei%& expansion condition"
10383 The two substrings are first expanded. The condition is true if the first
10384 string is lexically less than or equal to the second string. For &%le%& the
10385 comparison includes the case of letters, whereas for &%lei%& the comparison is
10386 case-independent.
10387
10388 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10389        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10390 .cindex "string" "comparison"
10391 .cindex "expansion" "string comparison"
10392 .cindex "&%lt%& expansion condition"
10393 .cindex "&%lti%& expansion condition"
10394 The two substrings are first expanded. The condition is true if the first
10395 string is lexically less than the second string. For &%lt%& the comparison
10396 includes the case of letters, whereas for &%lti%& the comparison is
10397 case-independent.
10398
10399
10400 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10401 .cindex "expansion" "regular expression comparison"
10402 .cindex "regular expressions" "match in expanded string"
10403 .cindex "&%match%& expansion condition"
10404 The two substrings are first expanded. The second is then treated as a regular
10405 expression and applied to the first. Because of the pre-expansion, if the
10406 regular expression contains dollar, or backslash characters, they must be
10407 escaped. Care must also be taken if the regular expression contains braces
10408 (curly brackets). A closing brace must be escaped so that it is not taken as a
10409 premature termination of <&'string2'&>. The easiest approach is to use the
10410 &`\N`& feature to disable expansion of the regular expression.
10411 For example,
10412 .code
10413 ${if match {$local_part}{\N^\d{3}\N} ...
10414 .endd
10415 If the whole expansion string is in double quotes, further escaping of
10416 backslashes is also required.
10417
10418 The condition is true if the regular expression match succeeds.
10419 The regular expression is not required to begin with a circumflex
10420 metacharacter, but if there is no circumflex, the expression is not anchored,
10421 and it may match anywhere in the subject, not just at the start. If you want
10422 the pattern to match at the end of the subject, you must include the &`$`&
10423 metacharacter at an appropriate point.
10424
10425 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10426 At the start of an &%if%& expansion the values of the numeric variable
10427 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10428 succeeds causes them to be reset to the substrings of that condition and they
10429 will have these values during the expansion of the success string. At the end
10430 of the &%if%& expansion, the previous values are restored. After testing a
10431 combination of conditions using &%or%&, the subsequent values of the numeric
10432 variables are those of the condition that succeeded.
10433
10434 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10435 .cindex "&%match_address%& expansion condition"
10436 See &*match_local_part*&.
10437
10438 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10439 .cindex "&%match_domain%& expansion condition"
10440 See &*match_local_part*&.
10441
10442 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10443 .cindex "&%match_ip%& expansion condition"
10444 This condition matches an IP address to a list of IP address patterns. It must
10445 be followed by two argument strings. The first (after expansion) must be an IP
10446 address or an empty string. The second (not expanded) is a restricted host
10447 list that can match only an IP address, not a host name. For example:
10448 .code
10449 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10450 .endd
10451 The specific types of host list item that are permitted in the list are:
10452
10453 .ilist
10454 An IP address, optionally with a CIDR mask.
10455 .next
10456 A single asterisk, which matches any IP address.
10457 .next
10458 An empty item, which matches only if the IP address is empty. This could be
10459 useful for testing for a locally submitted message or one from specific hosts
10460 in a single test such as
10461 . ==== As this is a nested list, any displays it contains must be indented
10462 . ==== as otherwise they are too far to the left. This comment applies to
10463 . ==== the use of xmlto plus fop. There's no problem when formatting with
10464 . ==== sdop, with or without the extra indent.
10465 .code
10466   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10467 .endd
10468 where the first item in the list is the empty string.
10469 .next
10470 The item @[] matches any of the local host's interface addresses.
10471 .next
10472 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10473 even if &`net-`& is not specified. There is never any attempt to turn the IP
10474 address into a host name. The most common type of linear search for
10475 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10476 masks. For example:
10477 .code
10478   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10479 .endd
10480 It is of course possible to use other kinds of lookup, and in such a case, you
10481 do need to specify the &`net-`& prefix if you want to specify a specific
10482 address mask, for example:
10483 .code
10484   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10485 .endd
10486 However, unless you are combining a &%match_ip%& condition with others, it is
10487 just as easy to use the fact that a lookup is itself a condition, and write:
10488 .code
10489   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10490 .endd
10491 .endlist ilist
10492
10493 Note that <&'string2'&> is not itself subject to string expansion, unless
10494 Exim was built with the EXPAND_LISTMATCH_RHS option.
10495
10496 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10497
10498 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10499 .cindex "domain list" "in expansion condition"
10500 .cindex "address list" "in expansion condition"
10501 .cindex "local part" "list, in expansion condition"
10502 .cindex "&%match_local_part%& expansion condition"
10503 This condition, together with &%match_address%& and &%match_domain%&, make it
10504 possible to test domain, address, and local part lists within expansions. Each
10505 condition requires two arguments: an item and a list to match. A trivial
10506 example is:
10507 .code
10508 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10509 .endd
10510 In each case, the second argument may contain any of the allowable items for a
10511 list of the appropriate type. Also, because the second argument (after
10512 expansion) is a standard form of list, it is possible to refer to a named list.
10513 Thus, you can use conditions like this:
10514 .code
10515 ${if match_domain{$domain}{+local_domains}{...
10516 .endd
10517 .cindex "&`+caseful`&"
10518 For address lists, the matching starts off caselessly, but the &`+caseful`&
10519 item can be used, as in all address lists, to cause subsequent items to
10520 have their local parts matched casefully. Domains are always matched
10521 caselessly.
10522
10523 Note that <&'string2'&> is not itself subject to string expansion, unless
10524 Exim was built with the EXPAND_LISTMATCH_RHS option.
10525
10526 &*Note*&: Host lists are &'not'& supported in this way. This is because
10527 hosts have two identities: a name and an IP address, and it is not clear
10528 how to specify cleanly how such a test would work. However, IP addresses can be
10529 matched using &%match_ip%&.
10530
10531 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10532 .cindex "PAM authentication"
10533 .cindex "AUTH" "with PAM"
10534 .cindex "Solaris" "PAM support"
10535 .cindex "expansion" "PAM authentication test"
10536 .cindex "&%pam%& expansion condition"
10537 &'Pluggable Authentication Modules'&
10538 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10539 available in the latest releases of Solaris and in some GNU/Linux
10540 distributions. The Exim support, which is intended for use in conjunction with
10541 the SMTP AUTH command, is available only if Exim is compiled with
10542 .code
10543 SUPPORT_PAM=yes
10544 .endd
10545 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10546 in some releases of GNU/Linux &%-ldl%& is also needed.
10547
10548 The argument string is first expanded, and the result must be a
10549 colon-separated list of strings. Leading and trailing white space is ignored.
10550 The PAM module is initialized with the service name &"exim"& and the user name
10551 taken from the first item in the colon-separated data string (<&'string1'&>).
10552 The remaining items in the data string are passed over in response to requests
10553 from the authentication function. In the simple case there will only be one
10554 request, for a password, so the data consists of just two strings.
10555
10556 There can be problems if any of the strings are permitted to contain colon
10557 characters. In the usual way, these have to be doubled to avoid being taken as
10558 separators. If the data is being inserted from a variable, the &%sg%& expansion
10559 item can be used to double any existing colons. For example, the configuration
10560 of a LOGIN authenticator might contain this setting:
10561 .code
10562 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10563 .endd
10564 For a PLAIN authenticator you could use:
10565 .code
10566 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10567 .endd
10568 In some operating systems, PAM authentication can be done only from a process
10569 running as root. Since Exim is running as the Exim user when receiving
10570 messages, this means that PAM cannot be used directly in those systems.
10571 A patched version of the &'pam_unix'& module that comes with the
10572 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10573 The patched module allows one special uid/gid combination, in addition to root,
10574 to authenticate. If you build the patched module to allow the Exim user and
10575 group, PAM can then be used from an Exim authenticator.
10576
10577
10578 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10579 .cindex "&'pwcheck'& daemon"
10580 .cindex "Cyrus"
10581 .cindex "expansion" "&'pwcheck'& authentication test"
10582 .cindex "&%pwcheck%& expansion condition"
10583 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10584 This is one way of making it possible for passwords to be checked by a process
10585 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10586 deprecated. Its replacement is &'saslauthd'& (see below).
10587
10588 The pwcheck support is not included in Exim by default. You need to specify
10589 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10590 building Exim. For example:
10591 .code
10592 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10593 .endd
10594 You do not need to install the full Cyrus software suite in order to use
10595 the pwcheck daemon. You can compile and install just the daemon alone
10596 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10597 access to the &_/var/pwcheck_& directory.
10598
10599 The &%pwcheck%& condition takes one argument, which must be the user name and
10600 password, separated by a colon. For example, in a LOGIN authenticator
10601 configuration, you might have this:
10602 .code
10603 server_condition = ${if pwcheck{$auth1:$auth2}}
10604 .endd
10605 Again, for a PLAIN authenticator configuration, this would be:
10606 .code
10607 server_condition = ${if pwcheck{$auth2:$auth3}}
10608 .endd
10609 .vitem &*queue_running*&
10610 .cindex "queue runner" "detecting when delivering from"
10611 .cindex "expansion" "queue runner test"
10612 .cindex "&%queue_running%& expansion condition"
10613 This condition, which has no data, is true during delivery attempts that are
10614 initiated by queue runner processes, and false otherwise.
10615
10616
10617 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10618 .cindex "Radius"
10619 .cindex "expansion" "Radius authentication"
10620 .cindex "&%radius%& expansion condition"
10621 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10622 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10623 the Radius client configuration file in order to build Exim with Radius
10624 support.
10625
10626 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10627 library, using the original API. If you are using release 0.4.0 or later of
10628 this library, you need to set
10629 .code
10630 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10631 .endd
10632 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10633 &%libradius%& library that comes with FreeBSD. To do this, set
10634 .code
10635 RADIUS_LIB_TYPE=RADLIB
10636 .endd
10637 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10638 You may also have to supply a suitable setting in EXTRALIBS so that the
10639 Radius library can be found when Exim is linked.
10640
10641 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10642 Radius client library, which calls the Radius server. The condition is true if
10643 the authentication is successful. For example:
10644 .code
10645 server_condition = ${if radius{<arguments>}}
10646 .endd
10647
10648
10649 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10650         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10651 .cindex "&'saslauthd'& daemon"
10652 .cindex "Cyrus"
10653 .cindex "expansion" "&'saslauthd'& authentication test"
10654 .cindex "&%saslauthd%& expansion condition"
10655 This condition supports user authentication using the Cyrus &'saslauthd'&
10656 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10657 Using this daemon is one way of making it possible for passwords to be checked
10658 by a process that is not running as root.
10659
10660 The saslauthd support is not included in Exim by default. You need to specify
10661 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10662 building Exim. For example:
10663 .code
10664 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10665 .endd
10666 You do not need to install the full Cyrus software suite in order to use
10667 the saslauthd daemon. You can compile and install just the daemon alone
10668 from the Cyrus SASL library.
10669
10670 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10671 two are mandatory. For example:
10672 .code
10673 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10674 .endd
10675 The service and the realm are optional (which is why the arguments are enclosed
10676 in their own set of braces). For details of the meaning of the service and
10677 realm, and how to run the daemon, consult the Cyrus documentation.
10678 .endlist vlist
10679
10680
10681
10682 .section "Combining expansion conditions" "SECID84"
10683 .cindex "expansion" "combining conditions"
10684 Several conditions can be tested at once by combining them using the &%and%&
10685 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10686 conditions on their own, and precede their lists of sub-conditions. Each
10687 sub-condition must be enclosed in braces within the overall braces that contain
10688 the list. No repetition of &%if%& is used.
10689
10690
10691 .vlist
10692 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10693 .cindex "&""or""& expansion condition"
10694 .cindex "expansion" "&""or""& of conditions"
10695 The sub-conditions are evaluated from left to right. The condition is true if
10696 any one of the sub-conditions is true.
10697 For example,
10698 .code
10699 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10700 .endd
10701 When a true sub-condition is found, the following ones are parsed but not
10702 evaluated. If there are several &"match"& sub-conditions the values of the
10703 numeric variables afterwards are taken from the first one that succeeds.
10704
10705 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10706 .cindex "&""and""& expansion condition"
10707 .cindex "expansion" "&""and""& of conditions"
10708 The sub-conditions are evaluated from left to right. The condition is true if
10709 all of the sub-conditions are true. If there are several &"match"&
10710 sub-conditions, the values of the numeric variables afterwards are taken from
10711 the last one. When a false sub-condition is found, the following ones are
10712 parsed but not evaluated.
10713 .endlist
10714 .ecindex IIDexpcond
10715
10716
10717
10718
10719 .section "Expansion variables" "SECTexpvar"
10720 .cindex "expansion" "variables, list of"
10721 This section contains an alphabetical list of all the expansion variables. Some
10722 of them are available only when Exim is compiled with specific options such as
10723 support for TLS or the content scanning extension.
10724
10725 .vlist
10726 .vitem "&$0$&, &$1$&, etc"
10727 .cindex "numerical variables (&$1$& &$2$& etc)"
10728 When a &%match%& expansion condition succeeds, these variables contain the
10729 captured substrings identified by the regular expression during subsequent
10730 processing of the success string of the containing &%if%& expansion item.
10731 However, they do not retain their values afterwards; in fact, their previous
10732 values are restored at the end of processing an &%if%& item. The numerical
10733 variables may also be set externally by some other matching process which
10734 precedes the expansion of the string. For example, the commands available in
10735 Exim filter files include an &%if%& command with its own regular expression
10736 matching condition.
10737
10738 .vitem "&$acl_c...$&"
10739 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10740 can be given any name that starts with &$acl_c$& and is at least six characters
10741 long, but the sixth character must be either a digit or an underscore. For
10742 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10743 variables persist throughout the lifetime of an SMTP connection. They can be
10744 used to pass information between ACLs and between different invocations of the
10745 same ACL. When a message is received, the values of these variables are saved
10746 with the message, and can be accessed by filters, routers, and transports
10747 during subsequent delivery.
10748
10749 .vitem "&$acl_m...$&"
10750 These variables are like the &$acl_c...$& variables, except that their values
10751 are reset after a message has been received. Thus, if several messages are
10752 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10753 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10754 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10755 message is received, the values of these variables are saved with the message,
10756 and can be accessed by filters, routers, and transports during subsequent
10757 delivery.
10758
10759 .vitem &$acl_verify_message$&
10760 .vindex "&$acl_verify_message$&"
10761 After an address verification has failed, this variable contains the failure
10762 message. It retains its value for use in subsequent modifiers. The message can
10763 be preserved by coding like this:
10764 .code
10765 warn !verify = sender
10766      set acl_m0 = $acl_verify_message
10767 .endd
10768 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10769 &%log_message%& modifiers, to include information about the verification
10770 failure.
10771
10772 .vitem &$address_data$&
10773 .vindex "&$address_data$&"
10774 This variable is set by means of the &%address_data%& option in routers. The
10775 value then remains with the address while it is processed by subsequent routers
10776 and eventually a transport. If the transport is handling multiple addresses,
10777 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10778 for more details. &*Note*&: The contents of &$address_data$& are visible in
10779 user filter files.
10780
10781 If &$address_data$& is set when the routers are called from an ACL to verify
10782 a recipient address, the final value is still in the variable for subsequent
10783 conditions and modifiers of the ACL statement. If routing the address caused it
10784 to be redirected to just one address, the child address is also routed as part
10785 of the verification, and in this case the final value of &$address_data$& is
10786 from the child's routing.
10787
10788 If &$address_data$& is set when the routers are called from an ACL to verify a
10789 sender address, the final value is also preserved, but this time in
10790 &$sender_address_data$&, to distinguish it from data from a recipient
10791 address.
10792
10793 In both cases (recipient and sender verification), the value does not persist
10794 after the end of the current ACL statement. If you want to preserve
10795 these values for longer, you can save them in ACL variables.
10796
10797 .vitem &$address_file$&
10798 .vindex "&$address_file$&"
10799 When, as a result of aliasing, forwarding, or filtering, a message is directed
10800 to a specific file, this variable holds the name of the file when the transport
10801 is running. At other times, the variable is empty. For example, using the
10802 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10803 .code
10804 /home/r2d2/savemail
10805 .endd
10806 then when the &(address_file)& transport is running, &$address_file$&
10807 contains the text string &`/home/r2d2/savemail`&.
10808 .cindex "Sieve filter" "value of &$address_file$&"
10809 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10810 then up to the transport configuration to generate an appropriate absolute path
10811 to the relevant file.
10812
10813 .vitem &$address_pipe$&
10814 .vindex "&$address_pipe$&"
10815 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10816 this variable holds the pipe command when the transport is running.
10817
10818 .vitem "&$auth1$& &-- &$auth3$&"
10819 .vindex "&$auth1$&, &$auth2$&, etc"
10820 These variables are used in SMTP authenticators (see chapters
10821 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10822
10823 .vitem &$authenticated_id$&
10824 .cindex "authentication" "id"
10825 .vindex "&$authenticated_id$&"
10826 When a server successfully authenticates a client it may be configured to
10827 preserve some of the authentication information in the variable
10828 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10829 user/password authenticator configuration might preserve the user name for use
10830 in the routers. Note that this is not the same information that is saved in
10831 &$sender_host_authenticated$&.
10832 When a message is submitted locally (that is, not over a TCP connection)
10833 the value of &$authenticated_id$& is normally the login name of the calling
10834 process. However, a trusted user can override this by means of the &%-oMai%&
10835 command line option.
10836
10837
10838
10839
10840 .vitem &$authenticated_sender$&
10841 .cindex "sender" "authenticated"
10842 .cindex "authentication" "sender"
10843 .cindex "AUTH" "on MAIL command"
10844 .vindex "&$authenticated_sender$&"
10845 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10846 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10847 described in section &<<SECTauthparamail>>&. Unless the data is the string
10848 &"<>"&, it is set as the authenticated sender of the message, and the value is
10849 available during delivery in the &$authenticated_sender$& variable. If the
10850 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10851
10852 .vindex "&$qualify_domain$&"
10853 When a message is submitted locally (that is, not over a TCP connection), the
10854 value of &$authenticated_sender$& is an address constructed from the login
10855 name of the calling process and &$qualify_domain$&, except that a trusted user
10856 can override this by means of the &%-oMas%& command line option.
10857
10858
10859 .vitem &$authentication_failed$&
10860 .cindex "authentication" "failure"
10861 .vindex "&$authentication_failed$&"
10862 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10863 command that does not succeed. Otherwise it is set to &"0"&. This makes it
10864 possible to distinguish between &"did not try to authenticate"&
10865 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
10866 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
10867 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
10868 negative response to an AUTH command, including (for example) an attempt to use
10869 an undefined mechanism.
10870
10871 .vitem &$av_failed$&
10872 .cindex "content scanning" "AV scanner failure"
10873 This variable is available when Exim is compiled with the content-scanning
10874 extension. It is set to &"0"& by default, but will be set to &"1"& if any
10875 problem occurs with the virus scanner (specified by &%av_scanner%&) during
10876 the ACL malware condition.
10877
10878 .vitem &$body_linecount$&
10879 .cindex "message body" "line count"
10880 .cindex "body of message" "line count"
10881 .vindex "&$body_linecount$&"
10882 When a message is being received or delivered, this variable contains the
10883 number of lines in the message's body. See also &$message_linecount$&.
10884
10885 .vitem &$body_zerocount$&
10886 .cindex "message body" "binary zero count"
10887 .cindex "body of message" "binary zero count"
10888 .cindex "binary zero" "in message body"
10889 .vindex "&$body_zerocount$&"
10890 When a message is being received or delivered, this variable contains the
10891 number of binary zero bytes (ASCII NULs) in the message's body.
10892
10893 .vitem &$bounce_recipient$&
10894 .vindex "&$bounce_recipient$&"
10895 This is set to the recipient address of a bounce message while Exim is creating
10896 it. It is useful if a customized bounce message text file is in use (see
10897 chapter &<<CHAPemsgcust>>&).
10898
10899 .vitem &$bounce_return_size_limit$&
10900 .vindex "&$bounce_return_size_limit$&"
10901 This contains the value set in the &%bounce_return_size_limit%& option, rounded
10902 up to a multiple of 1000. It is useful when a customized error message text
10903 file is in use (see chapter &<<CHAPemsgcust>>&).
10904
10905 .vitem &$caller_gid$&
10906 .cindex "gid (group id)" "caller"
10907 .vindex "&$caller_gid$&"
10908 The real group id under which the process that called Exim was running. This is
10909 not the same as the group id of the originator of a message (see
10910 &$originator_gid$&). If Exim re-execs itself, this variable in the new
10911 incarnation normally contains the Exim gid.
10912
10913 .vitem &$caller_uid$&
10914 .cindex "uid (user id)" "caller"
10915 .vindex "&$caller_uid$&"
10916 The real user id under which the process that called Exim was running. This is
10917 not the same as the user id of the originator of a message (see
10918 &$originator_uid$&). If Exim re-execs itself, this variable in the new
10919 incarnation normally contains the Exim uid.
10920
10921 .vitem &$compile_date$&
10922 .vindex "&$compile_date$&"
10923 The date on which the Exim binary was compiled.
10924
10925 .vitem &$compile_number$&
10926 .vindex "&$compile_number$&"
10927 The building process for Exim keeps a count of the number
10928 of times it has been compiled. This serves to distinguish different
10929 compilations of the same version of the program.
10930
10931 .vitem &$demime_errorlevel$&
10932 .vindex "&$demime_errorlevel$&"
10933 This variable is available when Exim is compiled with
10934 the content-scanning extension and the obsolete &%demime%& condition. For
10935 details, see section &<<SECTdemimecond>>&.
10936
10937 .vitem &$demime_reason$&
10938 .vindex "&$demime_reason$&"
10939 This variable is available when Exim is compiled with the
10940 content-scanning extension and the obsolete &%demime%& condition. For details,
10941 see section &<<SECTdemimecond>>&.
10942
10943 .vitem &$dnslist_domain$& &&&
10944        &$dnslist_matched$& &&&
10945        &$dnslist_text$& &&&
10946        &$dnslist_value$&
10947 .vindex "&$dnslist_domain$&"
10948 .vindex "&$dnslist_matched$&"
10949 .vindex "&$dnslist_text$&"
10950 .vindex "&$dnslist_value$&"
10951 .cindex "black list (DNS)"
10952 When a DNS (black) list lookup succeeds, these variables are set to contain
10953 the following data from the lookup: the list's domain name, the key that was
10954 looked up, the contents of any associated TXT record, and the value from the
10955 main A record. See section &<<SECID204>>& for more details.
10956
10957 .vitem &$domain$&
10958 .vindex "&$domain$&"
10959 When an address is being routed, or delivered on its own, this variable
10960 contains the domain. Uppercase letters in the domain are converted into lower
10961 case for &$domain$&.
10962
10963 Global address rewriting happens when a message is received, so the value of
10964 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
10965 is set during user filtering, but not during system filtering, because a
10966 message may have many recipients and the system filter is called just once.
10967
10968 When more than one address is being delivered at once (for example, several
10969 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
10970 have the same domain. Transports can be restricted to handling only one domain
10971 at a time if the value of &$domain$& is required at transport time &-- this is
10972 the default for local transports. For further details of the environment in
10973 which local transports are run, see chapter &<<CHAPenvironment>>&.
10974
10975 .oindex "&%delay_warning_condition%&"
10976 At the end of a delivery, if all deferred addresses have the same domain, it is
10977 set in &$domain$& during the expansion of &%delay_warning_condition%&.
10978
10979 The &$domain$& variable is also used in some other circumstances:
10980
10981 .ilist
10982 When an ACL is running for a RCPT command, &$domain$& contains the domain of
10983 the recipient address. The domain of the &'sender'& address is in
10984 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
10985 normally set during the running of the MAIL ACL. However, if the sender address
10986 is verified with a callout during the MAIL ACL, the sender domain is placed in
10987 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
10988 the &(smtp)& transport.
10989
10990 .next
10991 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10992 &$domain$& contains the domain portion of the address that is being rewritten;
10993 it can be used in the expansion of the replacement address, for example, to
10994 rewrite domains by file lookup.
10995
10996 .next
10997 With one important exception, whenever a domain list is being scanned,
10998 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
10999 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11000 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11001 that, in a RCPT ACL, the sender domain list can be dependent on the
11002 recipient domain (which is what is in &$domain$& at this time).
11003
11004 .next
11005 .cindex "ETRN" "value of &$domain$&"
11006 .oindex "&%smtp_etrn_command%&"
11007 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11008 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11009 .endlist
11010
11011
11012 .vitem &$domain_data$&
11013 .vindex "&$domain_data$&"
11014 When the &%domains%& option on a router matches a domain by
11015 means of a lookup, the data read by the lookup is available during the running
11016 of the router as &$domain_data$&. In addition, if the driver routes the
11017 address to a transport, the value is available in that transport. If the
11018 transport is handling multiple addresses, the value from the first address is
11019 used.
11020
11021 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11022 domain by means of a lookup. The data read by the lookup is available during
11023 the rest of the ACL statement. In all other situations, this variable expands
11024 to nothing.
11025
11026 .vitem &$exim_gid$&
11027 .vindex "&$exim_gid$&"
11028 This variable contains the numerical value of the Exim group id.
11029
11030 .vitem &$exim_path$&
11031 .vindex "&$exim_path$&"
11032 This variable contains the path to the Exim binary.
11033
11034 .vitem &$exim_uid$&
11035 .vindex "&$exim_uid$&"
11036 This variable contains the numerical value of the Exim user id.
11037
11038 .vitem &$found_extension$&
11039 .vindex "&$found_extension$&"
11040 This variable is available when Exim is compiled with the
11041 content-scanning extension and the obsolete &%demime%& condition. For details,
11042 see section &<<SECTdemimecond>>&.
11043
11044 .vitem &$header_$&<&'name'&>
11045 This is not strictly an expansion variable. It is expansion syntax for
11046 inserting the message header line with the given name. Note that the name must
11047 be terminated by colon or white space, because it may contain a wide variety of
11048 characters. Note also that braces must &'not'& be used.
11049
11050 .vitem &$home$&
11051 .vindex "&$home$&"
11052 When the &%check_local_user%& option is set for a router, the user's home
11053 directory is placed in &$home$& when the check succeeds. In particular, this
11054 means it is set during the running of users' filter files. A router may also
11055 explicitly set a home directory for use by a transport; this can be overridden
11056 by a setting on the transport itself.
11057
11058 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11059 of the environment variable HOME.
11060
11061 .vitem &$host$&
11062 .vindex "&$host$&"
11063 If a router assigns an address to a transport (any transport), and passes a
11064 list of hosts with the address, the value of &$host$& when the transport starts
11065 to run is the name of the first host on the list. Note that this applies both
11066 to local and remote transports.
11067
11068 .cindex "transport" "filter"
11069 .cindex "filter" "transport filter"
11070 For the &(smtp)& transport, if there is more than one host, the value of
11071 &$host$& changes as the transport works its way through the list. In
11072 particular, when the &(smtp)& transport is expanding its options for encryption
11073 using TLS, or for specifying a transport filter (see chapter
11074 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11075 is connected.
11076
11077 When used in the client part of an authenticator configuration (see chapter
11078 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11079 client is connected.
11080
11081
11082 .vitem &$host_address$&
11083 .vindex "&$host_address$&"
11084 This variable is set to the remote host's IP address whenever &$host$& is set
11085 for a remote connection. It is also set to the IP address that is being checked
11086 when the &%ignore_target_hosts%& option is being processed.
11087
11088 .vitem &$host_data$&
11089 .vindex "&$host_data$&"
11090 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11091 result of the lookup is made available in the &$host_data$& variable. This
11092 allows you, for example, to do things like this:
11093 .code
11094 deny  hosts = net-lsearch;/some/file
11095 message = $host_data
11096 .endd
11097 .vitem &$host_lookup_deferred$&
11098 .cindex "host name" "lookup, failure of"
11099 .vindex "&$host_lookup_deferred$&"
11100 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11101 message comes from a remote host and there is an attempt to look up the host's
11102 name from its IP address, and the attempt is not successful, one of these
11103 variables is set to &"1"&.
11104
11105 .ilist
11106 If the lookup receives a definite negative response (for example, a DNS lookup
11107 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11108
11109 .next
11110 If there is any kind of problem during the lookup, such that Exim cannot
11111 tell whether or not the host name is defined (for example, a timeout for a DNS
11112 lookup), &$host_lookup_deferred$& is set to &"1"&.
11113 .endlist ilist
11114
11115 Looking up a host's name from its IP address consists of more than just a
11116 single reverse lookup. Exim checks that a forward lookup of at least one of the
11117 names it receives from a reverse lookup yields the original IP address. If this
11118 is not the case, Exim does not accept the looked up name(s), and
11119 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11120 IP address (for example, the existence of a PTR record in the DNS) is not
11121 sufficient on its own for the success of a host name lookup. If the reverse
11122 lookup succeeds, but there is a lookup problem such as a timeout when checking
11123 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11124 &"1"&. See also &$sender_host_name$&.
11125
11126 .vitem &$host_lookup_failed$&
11127 .vindex "&$host_lookup_failed$&"
11128 See &$host_lookup_deferred$&.
11129
11130
11131 .vitem &$inode$&
11132 .vindex "&$inode$&"
11133 The only time this variable is set is while expanding the &%directory_file%&
11134 option in the &(appendfile)& transport. The variable contains the inode number
11135 of the temporary file which is about to be renamed. It can be used to construct
11136 a unique name for the file.
11137
11138 .vitem &$interface_address$&
11139 .vindex "&$interface_address$&"
11140 This is an obsolete name for &$received_ip_address$&.
11141
11142 .vitem &$interface_port$&
11143 .vindex "&$interface_port$&"
11144 This is an obsolete name for &$received_port$&.
11145
11146 .vitem &$item$&
11147 .vindex "&$item$&"
11148 This variable is used during the expansion of &*forall*& and &*forany*&
11149 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11150 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11151 empty.
11152
11153 .vitem &$ldap_dn$&
11154 .vindex "&$ldap_dn$&"
11155 This variable, which is available only when Exim is compiled with LDAP support,
11156 contains the DN from the last entry in the most recently successful LDAP
11157 lookup.
11158
11159 .vitem &$load_average$&
11160 .vindex "&$load_average$&"
11161 This variable contains the system load average, multiplied by 1000 so that it
11162 is an integer. For example, if the load average is 0.21, the value of the
11163 variable is 210. The value is recomputed every time the variable is referenced.
11164
11165 .vitem &$local_part$&
11166 .vindex "&$local_part$&"
11167 When an address is being routed, or delivered on its own, this
11168 variable contains the local part. When a number of addresses are being
11169 delivered together (for example, multiple RCPT commands in an SMTP
11170 session), &$local_part$& is not set.
11171
11172 Global address rewriting happens when a message is received, so the value of
11173 &$local_part$& during routing and delivery is the value after rewriting.
11174 &$local_part$& is set during user filtering, but not during system filtering,
11175 because a message may have many recipients and the system filter is called just
11176 once.
11177
11178 .vindex "&$local_part_prefix$&"
11179 .vindex "&$local_part_suffix$&"
11180 If a local part prefix or suffix has been recognized, it is not included in the
11181 value of &$local_part$& during routing and subsequent delivery. The values of
11182 any prefix or suffix are in &$local_part_prefix$& and
11183 &$local_part_suffix$&, respectively.
11184
11185 When a message is being delivered to a file, pipe, or autoreply transport as a
11186 result of aliasing or forwarding, &$local_part$& is set to the local part of
11187 the parent address, not to the file name or command (see &$address_file$& and
11188 &$address_pipe$&).
11189
11190 When an ACL is running for a RCPT command, &$local_part$& contains the
11191 local part of the recipient address.
11192
11193 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11194 &$local_part$& contains the local part of the address that is being rewritten;
11195 it can be used in the expansion of the replacement address, for example.
11196
11197 In all cases, all quoting is removed from the local part. For example, for both
11198 the addresses
11199 .code
11200 "abc:xyz"@test.example
11201 abc\:xyz@test.example
11202 .endd
11203 the value of &$local_part$& is
11204 .code
11205 abc:xyz
11206 .endd
11207 If you use &$local_part$& to create another address, you should always wrap it
11208 inside a quoting operator. For example, in a &(redirect)& router you could
11209 have:
11210 .code
11211 data = ${quote_local_part:$local_part}@new.domain.example
11212 .endd
11213 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11214 to process local parts in a case-dependent manner in a router, you can set the
11215 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11216
11217 .vitem &$local_part_data$&
11218 .vindex "&$local_part_data$&"
11219 When the &%local_parts%& option on a router matches a local part by means of a
11220 lookup, the data read by the lookup is available during the running of the
11221 router as &$local_part_data$&. In addition, if the driver routes the address
11222 to a transport, the value is available in that transport. If the transport is
11223 handling multiple addresses, the value from the first address is used.
11224
11225 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11226 matches a local part by means of a lookup. The data read by the lookup is
11227 available during the rest of the ACL statement. In all other situations, this
11228 variable expands to nothing.
11229
11230 .vitem &$local_part_prefix$&
11231 .vindex "&$local_part_prefix$&"
11232 When an address is being routed or delivered, and a
11233 specific prefix for the local part was recognized, it is available in this
11234 variable, having been removed from &$local_part$&.
11235
11236 .vitem &$local_part_suffix$&
11237 .vindex "&$local_part_suffix$&"
11238 When an address is being routed or delivered, and a
11239 specific suffix for the local part was recognized, it is available in this
11240 variable, having been removed from &$local_part$&.
11241
11242 .vitem &$local_scan_data$&
11243 .vindex "&$local_scan_data$&"
11244 This variable contains the text returned by the &[local_scan()]& function when
11245 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11246
11247 .vitem &$local_user_gid$&
11248 .vindex "&$local_user_gid$&"
11249 See &$local_user_uid$&.
11250
11251 .vitem &$local_user_uid$&
11252 .vindex "&$local_user_uid$&"
11253 This variable and &$local_user_gid$& are set to the uid and gid after the
11254 &%check_local_user%& router precondition succeeds. This means that their values
11255 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11256 and &%condition%&), for the &%address_data%& expansion, and for any
11257 router-specific expansions. At all other times, the values in these variables
11258 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11259
11260 .vitem &$localhost_number$&
11261 .vindex "&$localhost_number$&"
11262 This contains the expanded value of the
11263 &%localhost_number%& option. The expansion happens after the main options have
11264 been read.
11265
11266 .vitem &$log_inodes$&
11267 .vindex "&$log_inodes$&"
11268 The number of free inodes in the disk partition where Exim's
11269 log files are being written. The value is recalculated whenever the variable is
11270 referenced. If the relevant file system does not have the concept of inodes,
11271 the value of is -1. See also the &%check_log_inodes%& option.
11272
11273 .vitem &$log_space$&
11274 .vindex "&$log_space$&"
11275 The amount of free space (as a number of kilobytes) in the disk
11276 partition where Exim's log files are being written. The value is recalculated
11277 whenever the variable is referenced. If the operating system does not have the
11278 ability to find the amount of free space (only true for experimental systems),
11279 the space value is -1. See also the &%check_log_space%& option.
11280
11281
11282 .vitem &$mailstore_basename$&
11283 .vindex "&$mailstore_basename$&"
11284 This variable is set only when doing deliveries in &"mailstore"& format in the
11285 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11286 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11287 contains the basename of the files that are being written, that is, the name
11288 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11289 variable is empty.
11290
11291 .vitem &$malware_name$&
11292 .vindex "&$malware_name$&"
11293 This variable is available when Exim is compiled with the
11294 content-scanning extension. It is set to the name of the virus that was found
11295 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11296
11297 .vitem &$max_received_linelength$&
11298 .vindex "&$max_received_linelength$&"
11299 .cindex "maximum" "line length"
11300 .cindex "line length" "maximum"
11301 This variable contains the number of bytes in the longest line that was
11302 received as part of the message, not counting the line termination
11303 character(s).
11304
11305 .vitem &$message_age$&
11306 .cindex "message" "age of"
11307 .vindex "&$message_age$&"
11308 This variable is set at the start of a delivery attempt to contain the number
11309 of seconds since the message was received. It does not change during a single
11310 delivery attempt.
11311
11312 .vitem &$message_body$&
11313 .cindex "body of message" "expansion variable"
11314 .cindex "message body" "in expansion"
11315 .cindex "binary zero" "in message body"
11316 .vindex "&$message_body$&"
11317 .oindex "&%message_body_visible%&"
11318 This variable contains the initial portion of a message's body while it is
11319 being delivered, and is intended mainly for use in filter files. The maximum
11320 number of characters of the body that are put into the variable is set by the
11321 &%message_body_visible%& configuration option; the default is 500.
11322
11323 .oindex "&%message_body_newlines%&"
11324 By default, newlines are converted into spaces in &$message_body$&, to make it
11325 easier to search for phrases that might be split over a line break. However,
11326 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11327 zeros are always converted into spaces.
11328
11329 .vitem &$message_body_end$&
11330 .cindex "body of message" "expansion variable"
11331 .cindex "message body" "in expansion"
11332 .vindex "&$message_body_end$&"
11333 This variable contains the final portion of a message's
11334 body while it is being delivered. The format and maximum size are as for
11335 &$message_body$&.
11336
11337 .vitem &$message_body_size$&
11338 .cindex "body of message" "size"
11339 .cindex "message body" "size"
11340 .vindex "&$message_body_size$&"
11341 When a message is being delivered, this variable contains the size of the body
11342 in bytes. The count starts from the character after the blank line that
11343 separates the body from the header. Newlines are included in the count. See
11344 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11345
11346 .vitem &$message_exim_id$&
11347 .vindex "&$message_exim_id$&"
11348 When a message is being received or delivered, this variable contains the
11349 unique message id that is generated and used by Exim to identify the message.
11350 An id is not created for a message until after its header has been successfully
11351 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11352 line; it is the local id that Exim assigns to the message, for example:
11353 &`1BXTIK-0001yO-VA`&.
11354
11355 .vitem &$message_headers$&
11356 .vindex &$message_headers$&
11357 This variable contains a concatenation of all the header lines when a message
11358 is being processed, except for lines added by routers or transports. The header
11359 lines are separated by newline characters. Their contents are decoded in the
11360 same way as a header line that is inserted by &%bheader%&.
11361
11362 .vitem &$message_headers_raw$&
11363 .vindex &$message_headers_raw$&
11364 This variable is like &$message_headers$& except that no processing of the
11365 contents of header lines is done.
11366
11367 .vitem &$message_id$&
11368 This is an old name for &$message_exim_id$&, which is now deprecated.
11369
11370 .vitem &$message_linecount$&
11371 .vindex "&$message_linecount$&"
11372 This variable contains the total number of lines in the header and body of the
11373 message. Compare &$body_linecount$&, which is the count for the body only.
11374 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11375 number of lines received. Before delivery happens (that is, before filters,
11376 routers, and transports run) the count is increased to include the
11377 &'Received:'& header line that Exim standardly adds, and also any other header
11378 lines that are added by ACLs. The blank line that separates the message header
11379 from the body is not counted.
11380
11381 As with the special case of &$message_size$&, during the expansion of the
11382 appendfile transport's maildir_tag option in maildir format, the value of
11383 &$message_linecount$& is the precise size of the number of newlines in the
11384 file that has been written (minus one for the blank line between the
11385 header and the body).
11386
11387 Here is an example of the use of this variable in a DATA ACL:
11388 .code
11389 deny message   = Too many lines in message header
11390      condition = \
11391       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11392 .endd
11393 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11394 message has not yet been received.
11395
11396 .vitem &$message_size$&
11397 .cindex "size" "of message"
11398 .cindex "message" "size"
11399 .vindex "&$message_size$&"
11400 When a message is being processed, this variable contains its size in bytes. In
11401 most cases, the size includes those headers that were received with the
11402 message, but not those (such as &'Envelope-to:'&) that are added to individual
11403 deliveries as they are written. However, there is one special case: during the
11404 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11405 doing a delivery in maildir format, the value of &$message_size$& is the
11406 precise size of the file that has been written. See also
11407 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11408
11409 .cindex "RCPT" "value of &$message_size$&"
11410 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11411 contains the size supplied on the MAIL command, or -1 if no size was given. The
11412 value may not, of course, be truthful.
11413
11414 .vitem &$mime_$&&'xxx'&
11415 A number of variables whose names start with &$mime$& are
11416 available when Exim is compiled with the content-scanning extension. For
11417 details, see section &<<SECTscanmimepart>>&.
11418
11419 .vitem "&$n0$& &-- &$n9$&"
11420 These variables are counters that can be incremented by means
11421 of the &%add%& command in filter files.
11422
11423 .vitem &$original_domain$&
11424 .vindex "&$domain$&"
11425 .vindex "&$original_domain$&"
11426 When a top-level address is being processed for delivery, this contains the
11427 same value as &$domain$&. However, if a &"child"& address (for example,
11428 generated by an alias, forward, or filter file) is being processed, this
11429 variable contains the domain of the original address (lower cased). This
11430 differs from &$parent_domain$& only when there is more than one level of
11431 aliasing or forwarding. When more than one address is being delivered in a
11432 single transport run, &$original_domain$& is not set.
11433
11434 If a new address is created by means of a &%deliver%& command in a system
11435 filter, it is set up with an artificial &"parent"& address. This has the local
11436 part &'system-filter'& and the default qualify domain.
11437
11438 .vitem &$original_local_part$&
11439 .vindex "&$local_part$&"
11440 .vindex "&$original_local_part$&"
11441 When a top-level address is being processed for delivery, this contains the
11442 same value as &$local_part$&, unless a prefix or suffix was removed from the
11443 local part, because &$original_local_part$& always contains the full local
11444 part. When a &"child"& address (for example, generated by an alias, forward, or
11445 filter file) is being processed, this variable contains the full local part of
11446 the original address.
11447
11448 If the router that did the redirection processed the local part
11449 case-insensitively, the value in &$original_local_part$& is in lower case.
11450 This variable differs from &$parent_local_part$& only when there is more than
11451 one level of aliasing or forwarding. When more than one address is being
11452 delivered in a single transport run, &$original_local_part$& is not set.
11453
11454 If a new address is created by means of a &%deliver%& command in a system
11455 filter, it is set up with an artificial &"parent"& address. This has the local
11456 part &'system-filter'& and the default qualify domain.
11457
11458 .vitem &$originator_gid$&
11459 .cindex "gid (group id)" "of originating user"
11460 .cindex "sender" "gid"
11461 .vindex "&$caller_gid$&"
11462 .vindex "&$originator_gid$&"
11463 This variable contains the value of &$caller_gid$& that was set when the
11464 message was received. For messages received via the command line, this is the
11465 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11466 normally the gid of the Exim user.
11467
11468 .vitem &$originator_uid$&
11469 .cindex "uid (user id)" "of originating user"
11470 .cindex "sender" "uid"
11471 .vindex "&$caller_uid$&"
11472 .vindex "&$originaltor_uid$&"
11473 The value of &$caller_uid$& that was set when the message was received. For
11474 messages received via the command line, this is the uid of the sending user.
11475 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11476 user.
11477
11478 .vitem &$parent_domain$&
11479 .vindex "&$parent_domain$&"
11480 This variable is similar to &$original_domain$& (see
11481 above), except that it refers to the immediately preceding parent address.
11482
11483 .vitem &$parent_local_part$&
11484 .vindex "&$parent_local_part$&"
11485 This variable is similar to &$original_local_part$&
11486 (see above), except that it refers to the immediately preceding parent address.
11487
11488 .vitem &$pid$&
11489 .cindex "pid (process id)" "of current process"
11490 .vindex "&$pid$&"
11491 This variable contains the current process id.
11492
11493 .vitem &$pipe_addresses$&
11494 .cindex "filter" "transport filter"
11495 .cindex "transport" "filter"
11496 .vindex "&$pipe_addresses$&"
11497 This is not an expansion variable, but is mentioned here because the string
11498 &`$pipe_addresses`& is handled specially in the command specification for the
11499 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11500 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11501 It cannot be used in general expansion strings, and provokes an &"unknown
11502 variable"& error if encountered.
11503
11504 .vitem &$primary_hostname$&
11505 .vindex "&$primary_hostname$&"
11506 This variable contains the value set by &%primary_hostname%& in the
11507 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11508 a single-component name, Exim calls &[gethostbyname()]& (or
11509 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11510 qualified host name. See also &$smtp_active_hostname$&.
11511
11512
11513 .vitem &$prvscheck_address$&
11514 This variable is used in conjunction with the &%prvscheck%& expansion item,
11515 which is described in sections &<<SECTexpansionitems>>& and
11516 &<<SECTverifyPRVS>>&.
11517
11518 .vitem &$prvscheck_keynum$&
11519 This variable is used in conjunction with the &%prvscheck%& expansion item,
11520 which is described in sections &<<SECTexpansionitems>>& and
11521 &<<SECTverifyPRVS>>&.
11522
11523 .vitem &$prvscheck_result$&
11524 This variable is used in conjunction with the &%prvscheck%& expansion item,
11525 which is described in sections &<<SECTexpansionitems>>& and
11526 &<<SECTverifyPRVS>>&.
11527
11528 .vitem &$qualify_domain$&
11529 .vindex "&$qualify_domain$&"
11530 The value set for the &%qualify_domain%& option in the configuration file.
11531
11532 .vitem &$qualify_recipient$&
11533 .vindex "&$qualify_recipient$&"
11534 The value set for the &%qualify_recipient%& option in the configuration file,
11535 or if not set, the value of &$qualify_domain$&.
11536
11537 .vitem &$rcpt_count$&
11538 .vindex "&$rcpt_count$&"
11539 When a message is being received by SMTP, this variable contains the number of
11540 RCPT commands received for the current message. If this variable is used in a
11541 RCPT ACL, its value includes the current command.
11542
11543 .vitem &$rcpt_defer_count$&
11544 .vindex "&$rcpt_defer_count$&"
11545 .cindex "4&'xx'& responses" "count of"
11546 When a message is being received by SMTP, this variable contains the number of
11547 RCPT commands in the current message that have previously been rejected with a
11548 temporary (4&'xx'&) response.
11549
11550 .vitem &$rcpt_fail_count$&
11551 .vindex "&$rcpt_fail_count$&"
11552 When a message is being received by SMTP, this variable contains the number of
11553 RCPT commands in the current message that have previously been rejected with a
11554 permanent (5&'xx'&) response.
11555
11556 .vitem &$received_count$&
11557 .vindex "&$received_count$&"
11558 This variable contains the number of &'Received:'& header lines in the message,
11559 including the one added by Exim (so its value is always greater than zero). It
11560 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11561 delivering.
11562
11563 .vitem &$received_for$&
11564 .vindex "&$received_for$&"
11565 If there is only a single recipient address in an incoming message, this
11566 variable contains that address when the &'Received:'& header line is being
11567 built. The value is copied after recipient rewriting has happened, but before
11568 the &[local_scan()]& function is run.
11569
11570 .vitem &$received_ip_address$&
11571 .vindex "&$received_ip_address$&"
11572 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11573 variable is set to the address of the local IP interface, and &$received_port$&
11574 is set to the local port number. (The remote IP address and port are in
11575 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11576 the port value is -1 unless it has been set using the &%-oMi%& command line
11577 option.
11578
11579 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11580 could be used, for example, to make the file name for a TLS certificate depend
11581 on which interface and/or port is being used for the incoming connection. The
11582 values of &$received_ip_address$& and &$received_port$& are saved with any
11583 messages that are received, thus making these variables available at delivery
11584 time.
11585
11586 &*Note:*& There are no equivalent variables for outgoing connections, because
11587 the values are unknown (unless they are explicitly set by options of the
11588 &(smtp)& transport).
11589
11590 .vitem &$received_port$&
11591 .vindex "&$received_port$&"
11592 See &$received_ip_address$&.
11593
11594 .vitem &$received_protocol$&
11595 .vindex "&$received_protocol$&"
11596 When a message is being processed, this variable contains the name of the
11597 protocol by which it was received. Most of the names used by Exim are defined
11598 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11599 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11600 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11601 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11602 connection and the client was successfully authenticated.
11603
11604 Exim uses the protocol name &"smtps"& for the case when encryption is
11605 automatically set up on connection without the use of STARTTLS (see
11606 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11607 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11608 where the client initially uses EHLO, sets up an encrypted connection using
11609 STARTTLS, and then uses HELO afterwards.
11610
11611 The &%-oMr%& option provides a way of specifying a custom protocol name for
11612 messages that are injected locally by trusted callers. This is commonly used to
11613 identify messages that are being re-injected after some kind of scanning.
11614
11615 .vitem &$received_time$&
11616 .vindex "&$received_time$&"
11617 This variable contains the date and time when the current message was received,
11618 as a number of seconds since the start of the Unix epoch.
11619
11620 .vitem &$recipient_data$&
11621 .vindex "&$recipient_data$&"
11622 This variable is set after an indexing lookup success in an ACL &%recipients%&
11623 condition. It contains the data from the lookup, and the value remains set
11624 until the next &%recipients%& test. Thus, you can do things like this:
11625 .display
11626 &`require recipients  = cdb*@;/some/file`&
11627 &`deny    `&&'some further test involving'& &`$recipient_data`&
11628 .endd
11629 &*Warning*&: This variable is set only when a lookup is used as an indexing
11630 method in the address list, using the semicolon syntax as in the example above.
11631 The variable is not set for a lookup that is used as part of the string
11632 expansion that all such lists undergo before being interpreted.
11633
11634 .vitem &$recipient_verify_failure$&
11635 .vindex "&$recipient_verify_failure$&"
11636 In an ACL, when a recipient verification fails, this variable contains
11637 information about the failure. It is set to one of the following words:
11638
11639 .ilist
11640 &"qualify"&: The address was unqualified (no domain), and the message
11641 was neither local nor came from an exempted host.
11642
11643 .next
11644 &"route"&: Routing failed.
11645
11646 .next
11647 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11648 or before the MAIL command (that is, on initial connection, HELO, or
11649 MAIL).
11650
11651 .next
11652 &"recipient"&: The RCPT command in a callout was rejected.
11653 .next
11654
11655 &"postmaster"&: The postmaster check in a callout was rejected.
11656 .endlist
11657
11658 The main use of this variable is expected to be to distinguish between
11659 rejections of MAIL and rejections of RCPT.
11660
11661 .vitem &$recipients$&
11662 .vindex "&$recipients$&"
11663 This variable contains a list of envelope recipients for a message. A comma and
11664 a space separate the addresses in the replacement text. However, the variable
11665 is not generally available, to prevent exposure of Bcc recipients in
11666 unprivileged users' filter files. You can use &$recipients$& only in these
11667 cases:
11668
11669 .olist
11670 In a system filter file.
11671 .next
11672 In the ACLs associated with the DATA command and with non-SMTP messages, that
11673 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11674 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11675 &%acl_not_smtp_mime%&.
11676 .next
11677 From within a &[local_scan()]& function.
11678 .endlist
11679
11680
11681 .vitem &$recipients_count$&
11682 .vindex "&$recipients_count$&"
11683 When a message is being processed, this variable contains the number of
11684 envelope recipients that came with the message. Duplicates are not excluded
11685 from the count. While a message is being received over SMTP, the number
11686 increases for each accepted recipient. It can be referenced in an ACL.
11687
11688
11689 .vitem &$regex_match_string$&
11690 .vindex "&$regex_match_string$&"
11691 This variable is set to contain the matching regular expression after a
11692 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11693
11694
11695 .vitem &$reply_address$&
11696 .vindex "&$reply_address$&"
11697 When a message is being processed, this variable contains the contents of the
11698 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11699 contents of the &'From:'& header line. Apart from the removal of leading
11700 white space, the value is not processed in any way. In particular, no RFC 2047
11701 decoding or character code translation takes place.
11702
11703 .vitem &$return_path$&
11704 .vindex "&$return_path$&"
11705 When a message is being delivered, this variable contains the return path &--
11706 the sender field that will be sent as part of the envelope. It is not enclosed
11707 in <> characters. At the start of routing an address, &$return_path$& has the
11708 same value as &$sender_address$&, but if, for example, an incoming message to a
11709 mailing list has been expanded by a router which specifies a different address
11710 for bounce messages, &$return_path$& subsequently contains the new bounce
11711 address, whereas &$sender_address$& always contains the original sender address
11712 that was received with the message. In other words, &$sender_address$& contains
11713 the incoming envelope sender, and &$return_path$& contains the outgoing
11714 envelope sender.
11715
11716 .vitem &$return_size_limit$&
11717 .vindex "&$return_size_limit$&"
11718 This is an obsolete name for &$bounce_return_size_limit$&.
11719
11720 .vitem &$runrc$&
11721 .cindex "return code" "from &%run%& expansion"
11722 .vindex "&$runrc$&"
11723 This variable contains the return code from a command that is run by the
11724 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11725 assume the order in which option values are expanded, except for those
11726 preconditions whose order of testing is documented. Therefore, you cannot
11727 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11728 another.
11729
11730 .vitem &$self_hostname$&
11731 .oindex "&%self%&" "value of host name"
11732 .vindex "&$self_hostname$&"
11733 When an address is routed to a supposedly remote host that turns out to be the
11734 local host, what happens is controlled by the &%self%& generic router option.
11735 One of its values causes the address to be passed to another router. When this
11736 happens, &$self_hostname$& is set to the name of the local host that the
11737 original router encountered. In other circumstances its contents are null.
11738
11739 .vitem &$sender_address$&
11740 .vindex "&$sender_address$&"
11741 When a message is being processed, this variable contains the sender's address
11742 that was received in the message's envelope. The case of letters in the address
11743 is retained, in both the local part and the domain. For bounce messages, the
11744 value of this variable is the empty string. See also &$return_path$&.
11745
11746 .vitem &$sender_address_data$&
11747 .vindex "&$address_data$&"
11748 .vindex "&$sender_address_data$&"
11749 If &$address_data$& is set when the routers are called from an ACL to verify a
11750 sender address, the final value is preserved in &$sender_address_data$&, to
11751 distinguish it from data from a recipient address. The value does not persist
11752 after the end of the current ACL statement. If you want to preserve it for
11753 longer, you can save it in an ACL variable.
11754
11755 .vitem &$sender_address_domain$&
11756 .vindex "&$sender_address_domain$&"
11757 The domain portion of &$sender_address$&.
11758
11759 .vitem &$sender_address_local_part$&
11760 .vindex "&$sender_address_local_part$&"
11761 The local part portion of &$sender_address$&.
11762
11763 .vitem &$sender_data$&
11764 .vindex "&$sender_data$&"
11765 This variable is set after a lookup success in an ACL &%senders%& condition or
11766 in a router &%senders%& option. It contains the data from the lookup, and the
11767 value remains set until the next &%senders%& test. Thus, you can do things like
11768 this:
11769 .display
11770 &`require senders      = cdb*@;/some/file`&
11771 &`deny    `&&'some further test involving'& &`$sender_data`&
11772 .endd
11773 &*Warning*&: This variable is set only when a lookup is used as an indexing
11774 method in the address list, using the semicolon syntax as in the example above.
11775 The variable is not set for a lookup that is used as part of the string
11776 expansion that all such lists undergo before being interpreted.
11777
11778 .vitem &$sender_fullhost$&
11779 .vindex "&$sender_fullhost$&"
11780 When a message is received from a remote host, this variable contains the host
11781 name and IP address in a single string. It ends with the IP address in square
11782 brackets, followed by a colon and a port number if the logging of ports is
11783 enabled. The format of the rest of the string depends on whether the host
11784 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11785 looking up its IP address. (Looking up the IP address can be forced by the
11786 &%host_lookup%& option, independent of verification.) A plain host name at the
11787 start of the string is a verified host name; if this is not present,
11788 verification either failed or was not requested. A host name in parentheses is
11789 the argument of a HELO or EHLO command. This is omitted if it is identical to
11790 the verified host name or to the host's IP address in square brackets.
11791
11792 .vitem &$sender_helo_name$&
11793 .vindex "&$sender_helo_name$&"
11794 When a message is received from a remote host that has issued a HELO or EHLO
11795 command, the argument of that command is placed in this variable. It is also
11796 set if HELO or EHLO is used when a message is received using SMTP locally via
11797 the &%-bs%& or &%-bS%& options.
11798
11799 .vitem &$sender_host_address$&
11800 .vindex "&$sender_host_address$&"
11801 When a message is received from a remote host, this variable contains that
11802 host's IP address. For locally submitted messages, it is empty.
11803
11804 .vitem &$sender_host_authenticated$&
11805 .vindex "&$sender_host_authenticated$&"
11806 This variable contains the name (not the public name) of the authenticator
11807 driver that successfully authenticated the client from which the message was
11808 received. It is empty if there was no successful authentication. See also
11809 &$authenticated_id$&.
11810
11811 .new
11812 .vitem &$sender_host_dnssec$&
11813 .vindex "&$sender_host_dnssec$&"
11814 If &$sender_host_name$& has been populated (by reference, &%hosts_lookup%& or
11815 otherwise) then this boolean will have been set true if, and only if, the
11816 resolver library states that the reverse DNS was authenticated data.  At all
11817 other times, this variable is false.
11818
11819 It is likely that you will need to coerce DNSSEC support on in the resolver
11820 library, by setting:
11821 .code
11822 dns_use_dnssec = 1
11823 .endd
11824
11825 Exim does not perform DNSSEC validation itself, instead leaving that to a
11826 validating resolver (eg, unbound, or bind with suitable configuration).
11827
11828 Exim does not (currently) check to see if the forward DNS was also secured
11829 with DNSSEC, only the reverse DNS.
11830
11831 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
11832 mechanism in the list, then this variable will be false.
11833 .wen
11834
11835
11836 .vitem &$sender_host_name$&
11837 .vindex "&$sender_host_name$&"
11838 When a message is received from a remote host, this variable contains the
11839 host's name as obtained by looking up its IP address. For messages received by
11840 other means, this variable is empty.
11841
11842 .vindex "&$host_lookup_failed$&"
11843 If the host name has not previously been looked up, a reference to
11844 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11845 A looked up name is accepted only if it leads back to the original IP address
11846 via a forward lookup. If either the reverse or the forward lookup fails to find
11847 any data, or if the forward lookup does not yield the original IP address,
11848 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11849
11850 .vindex "&$host_lookup_deferred$&"
11851 However, if either of the lookups cannot be completed (for example, there is a
11852 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11853 &$host_lookup_failed$& remains set to &"0"&.
11854
11855 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
11856 host name again if there is a subsequent reference to &$sender_host_name$&
11857 in the same Exim process, but it does try again if &$host_lookup_deferred$&
11858 is set to &"1"&.
11859
11860 Exim does not automatically look up every calling host's name. If you want
11861 maximum efficiency, you should arrange your configuration so that it avoids
11862 these lookups altogether. The lookup happens only if one or more of the
11863 following are true:
11864
11865 .ilist
11866 A string containing &$sender_host_name$& is expanded.
11867 .next
11868 The calling host matches the list in &%host_lookup%&. In the default
11869 configuration, this option is set to *, so it must be changed if lookups are
11870 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
11871 .next
11872 Exim needs the host name in order to test an item in a host list. The items
11873 that require this are described in sections &<<SECThoslispatnam>>& and
11874 &<<SECThoslispatnamsk>>&.
11875 .next
11876 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
11877 In this case, the host name is required to compare with the name quoted in any
11878 EHLO or HELO commands that the client issues.
11879 .next
11880 The remote host issues a EHLO or HELO command that quotes one of the
11881 domains in &%helo_lookup_domains%&. The default value of this option is
11882 . ==== As this is a nested list, any displays it contains must be indented
11883 . ==== as otherwise they are too far to the left.
11884 .code
11885   helo_lookup_domains = @ : @[]
11886 .endd
11887 which causes a lookup if a remote host (incorrectly) gives the server's name or
11888 IP address in an EHLO or HELO command.
11889 .endlist
11890
11891
11892 .vitem &$sender_host_port$&
11893 .vindex "&$sender_host_port$&"
11894 When a message is received from a remote host, this variable contains the port
11895 number that was used on the remote host.
11896
11897 .vitem &$sender_ident$&
11898 .vindex "&$sender_ident$&"
11899 When a message is received from a remote host, this variable contains the
11900 identification received in response to an RFC 1413 request. When a message has
11901 been received locally, this variable contains the login name of the user that
11902 called Exim.
11903
11904 .vitem &$sender_rate_$&&'xxx'&
11905 A number of variables whose names begin &$sender_rate_$& are set as part of the
11906 &%ratelimit%& ACL condition. Details are given in section
11907 &<<SECTratelimiting>>&.
11908
11909 .vitem &$sender_rcvhost$&
11910 .cindex "DNS" "reverse lookup"
11911 .cindex "reverse DNS lookup"
11912 .vindex "&$sender_rcvhost$&"
11913 This is provided specifically for use in &'Received:'& headers. It starts with
11914 either the verified host name (as obtained from a reverse DNS lookup) or, if
11915 there is no verified host name, the IP address in square brackets. After that
11916 there may be text in parentheses. When the first item is a verified host name,
11917 the first thing in the parentheses is the IP address in square brackets,
11918 followed by a colon and a port number if port logging is enabled. When the
11919 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
11920 the parentheses.
11921
11922 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
11923 was used and its argument was not identical to the real host name or IP
11924 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
11925 all three items are present in the parentheses, a newline and tab are inserted
11926 into the string, to improve the formatting of the &'Received:'& header.
11927
11928 .vitem &$sender_verify_failure$&
11929 .vindex "&$sender_verify_failure$&"
11930 In an ACL, when a sender verification fails, this variable contains information
11931 about the failure. The details are the same as for
11932 &$recipient_verify_failure$&.
11933
11934 .vitem &$sending_ip_address$&
11935 .vindex "&$sending_ip_address$&"
11936 This variable is set whenever an outgoing SMTP connection to another host has
11937 been set up. It contains the IP address of the local interface that is being
11938 used. This is useful if a host that has more than one IP address wants to take
11939 on different personalities depending on which one is being used. For incoming
11940 connections, see &$received_ip_address$&.
11941
11942 .vitem &$sending_port$&
11943 .vindex "&$sending_port$&"
11944 This variable is set whenever an outgoing SMTP connection to another host has
11945 been set up. It contains the local port that is being used. For incoming
11946 connections, see &$received_port$&.
11947
11948 .vitem &$smtp_active_hostname$&
11949 .vindex "&$smtp_active_hostname$&"
11950 During an incoming SMTP session, this variable contains the value of the active
11951 host name, as specified by the &%smtp_active_hostname%& option. The value of
11952 &$smtp_active_hostname$& is saved with any message that is received, so its
11953 value can be consulted during routing and delivery.
11954
11955 .vitem &$smtp_command$&
11956 .vindex "&$smtp_command$&"
11957 During the processing of an incoming SMTP command, this variable contains the
11958 entire command. This makes it possible to distinguish between HELO and EHLO in
11959 the HELO ACL, and also to distinguish between commands such as these:
11960 .code
11961 MAIL FROM:<>
11962 MAIL FROM: <>
11963 .endd
11964 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
11965 command, the address in &$smtp_command$& is the original address before any
11966 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
11967 the address after SMTP-time rewriting.
11968
11969 .vitem &$smtp_command_argument$&
11970 .cindex "SMTP" "command, argument for"
11971 .vindex "&$smtp_command_argument$&"
11972 While an ACL is running to check an SMTP command, this variable contains the
11973 argument, that is, the text that follows the command name, with leading white
11974 space removed. Following the introduction of &$smtp_command$&, this variable is
11975 somewhat redundant, but is retained for backwards compatibility.
11976
11977 .vitem &$smtp_count_at_connection_start$&
11978 .vindex "&$smtp_count_at_connection_start$&"
11979 This variable is set greater than zero only in processes spawned by the Exim
11980 daemon for handling incoming SMTP connections. The name is deliberately long,
11981 in order to emphasize what the contents are. When the daemon accepts a new
11982 connection, it increments this variable. A copy of the variable is passed to
11983 the child process that handles the connection, but its value is fixed, and
11984 never changes. It is only an approximation of how many incoming connections
11985 there actually are, because many other connections may come and go while a
11986 single connection is being processed. When a child process terminates, the
11987 daemon decrements its copy of the variable.
11988
11989 .vitem "&$sn0$& &-- &$sn9$&"
11990 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
11991 that were current at the end of the system filter file. This allows a system
11992 filter file to set values that can be tested in users' filter files. For
11993 example, a system filter could set a value indicating how likely it is that a
11994 message is junk mail.
11995
11996 .vitem &$spam_$&&'xxx'&
11997 A number of variables whose names start with &$spam$& are available when Exim
11998 is compiled with the content-scanning extension. For details, see section
11999 &<<SECTscanspamass>>&.
12000
12001
12002 .vitem &$spool_directory$&
12003 .vindex "&$spool_directory$&"
12004 The name of Exim's spool directory.
12005
12006 .vitem &$spool_inodes$&
12007 .vindex "&$spool_inodes$&"
12008 The number of free inodes in the disk partition where Exim's spool files are
12009 being written. The value is recalculated whenever the variable is referenced.
12010 If the relevant file system does not have the concept of inodes, the value of
12011 is -1. See also the &%check_spool_inodes%& option.
12012
12013 .vitem &$spool_space$&
12014 .vindex "&$spool_space$&"
12015 The amount of free space (as a number of kilobytes) in the disk partition where
12016 Exim's spool files are being written. The value is recalculated whenever the
12017 variable is referenced. If the operating system does not have the ability to
12018 find the amount of free space (only true for experimental systems), the space
12019 value is -1. For example, to check in an ACL that there is at least 50
12020 megabytes free on the spool, you could write:
12021 .code
12022 condition = ${if > {$spool_space}{50000}}
12023 .endd
12024 See also the &%check_spool_space%& option.
12025
12026
12027 .vitem &$thisaddress$&
12028 .vindex "&$thisaddress$&"
12029 This variable is set only during the processing of the &%foranyaddress%&
12030 command in a filter file. Its use is explained in the description of that
12031 command, which can be found in the separate document entitled &'Exim's
12032 interfaces to mail filtering'&.
12033
12034 .vitem &$tls_in_bits$&
12035 .vindex "&$tls_in_bits$&"
12036 Contains an approximation of the TLS cipher's bit-strength
12037 on the inbound connection; the meaning of
12038 this depends upon the TLS implementation used.
12039 If TLS has not been negotiated, the value will be 0.
12040 The value of this is automatically fed into the Cyrus SASL authenticator
12041 when acting as a server, to specify the "external SSF" (a SASL term).
12042
12043 The deprecated &$tls_bits$& variable refers to the inbound side
12044 except when used in the context of an outbound SMTP delivery, when it refers to
12045 the outbound.
12046
12047 .vitem &$tls_out_bits$&
12048 .vindex "&$tls_out_bits$&"
12049 Contains an approximation of the TLS cipher's bit-strength
12050 on an outbound SMTP connection; the meaning of
12051 this depends upon the TLS implementation used.
12052 If TLS has not been negotiated, the value will be 0.
12053
12054 .vitem &$tls_in_certificate_verified$&
12055 .vindex "&$tls_in_certificate_verified$&"
12056 This variable is set to &"1"& if a TLS certificate was verified when the
12057 message was received, and &"0"& otherwise.
12058
12059 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12060 except when used in the context of an outbound SMTP delivery, when it refers to
12061 the outbound.
12062
12063 .vitem &$tls_out_certificate_verified$&
12064 .vindex "&$tls_out_certificate_verified$&"
12065 This variable is set to &"1"& if a TLS certificate was verified when an
12066 outbound SMTP connection was made,
12067 and &"0"& otherwise.
12068
12069 .vitem &$tls_in_cipher$&
12070 .vindex "&$tls_in_cipher$&"
12071 .vindex "&$tls_cipher$&"
12072 When a message is received from a remote host over an encrypted SMTP
12073 connection, this variable is set to the cipher suite that was negotiated, for
12074 example DES-CBC3-SHA. In other circumstances, in particular, for message
12075 received over unencrypted connections, the variable is empty. Testing
12076 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12077 non-encrypted connections during ACL processing.
12078
12079 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12080 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12081 becomes the same as &$tls_out_cipher$&.
12082
12083 .vitem &$tls_out_cipher$&
12084 .vindex "&$tls_out_cipher$&"
12085 This variable is
12086 cleared before any outgoing SMTP connection is made,
12087 and then set to the outgoing cipher suite if one is negotiated. See chapter
12088 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12089 details of the &(smtp)& transport.
12090
12091 .vitem &$tls_in_peerdn$&
12092 .vindex "&$tls_in_peerdn$&"
12093 .vindex "&$tls_peerdn$&"
12094 When a message is received from a remote host over an encrypted SMTP
12095 connection, and Exim is configured to request a certificate from the client,
12096 the value of the Distinguished Name of the certificate is made available in the
12097 &$tls_in_peerdn$& during subsequent processing.
12098
12099 The deprecated &$tls_peerdn$& variable refers to the inbound side
12100 except when used in the context of an outbound SMTP delivery, when it refers to
12101 the outbound.
12102
12103 .vitem &$tls_out_peerdn$&
12104 .vindex "&$tls_out_peerdn$&"
12105 When a message is being delivered to a remote host over an encrypted SMTP
12106 connection, and Exim is configured to request a certificate from the server,
12107 the value of the Distinguished Name of the certificate is made available in the
12108 &$tls_out_peerdn$& during subsequent processing.
12109
12110 .vitem &$tls_in_sni$&
12111 .vindex "&$tls_in_sni$&"
12112 .vindex "&$tls_sni$&"
12113 .cindex "TLS" "Server Name Indication"
12114 When a TLS session is being established, if the client sends the Server
12115 Name Indication extension, the value will be placed in this variable.
12116 If the variable appears in &%tls_certificate%& then this option and
12117 some others, described in &<<SECTtlssni>>&,
12118 will be re-expanded early in the TLS session, to permit
12119 a different certificate to be presented (and optionally a different key to be
12120 used) to the client, based upon the value of the SNI extension.
12121
12122 The deprecated &$tls_sni$& variable refers to the inbound side
12123 except when used in the context of an outbound SMTP delivery, when it refers to
12124 the outbound.
12125
12126 .vitem &$tls_out_sni$&
12127 .vindex "&$tls_out_sni$&"
12128 .cindex "TLS" "Server Name Indication"
12129 During outbound
12130 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12131 the transport.
12132
12133 .vitem &$tod_bsdinbox$&
12134 .vindex "&$tod_bsdinbox$&"
12135 The time of day and the date, in the format required for BSD-style mailbox
12136 files, for example: Thu Oct 17 17:14:09 1995.
12137
12138 .vitem &$tod_epoch$&
12139 .vindex "&$tod_epoch$&"
12140 The time and date as a number of seconds since the start of the Unix epoch.
12141
12142 .vitem &$tod_epoch_l$&
12143 .vindex "&$tod_epoch_l$&"
12144 The time and date as a number of microseconds since the start of the Unix epoch.
12145
12146 .vitem &$tod_full$&
12147 .vindex "&$tod_full$&"
12148 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12149 +0100. The timezone is always given as a numerical offset from UTC, with
12150 positive values used for timezones that are ahead (east) of UTC, and negative
12151 values for those that are behind (west).
12152
12153 .vitem &$tod_log$&
12154 .vindex "&$tod_log$&"
12155 The time and date in the format used for writing Exim's log files, for example:
12156 1995-10-12 15:32:29, but without a timezone.
12157
12158 .vitem &$tod_logfile$&
12159 .vindex "&$tod_logfile$&"
12160 This variable contains the date in the format yyyymmdd. This is the format that
12161 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12162 flag.
12163
12164 .vitem &$tod_zone$&
12165 .vindex "&$tod_zone$&"
12166 This variable contains the numerical value of the local timezone, for example:
12167 -0500.
12168
12169 .vitem &$tod_zulu$&
12170 .vindex "&$tod_zulu$&"
12171 This variable contains the UTC date and time in &"Zulu"& format, as specified
12172 by ISO 8601, for example: 20030221154023Z.
12173
12174 .vitem &$value$&
12175 .vindex "&$value$&"
12176 This variable contains the result of an expansion lookup, extraction operation,
12177 or external command, as described above. It is also used during a
12178 &*reduce*& expansion.
12179
12180 .vitem &$version_number$&
12181 .vindex "&$version_number$&"
12182 The version number of Exim.
12183
12184 .vitem &$warn_message_delay$&
12185 .vindex "&$warn_message_delay$&"
12186 This variable is set only during the creation of a message warning about a
12187 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12188
12189 .vitem &$warn_message_recipients$&
12190 .vindex "&$warn_message_recipients$&"
12191 This variable is set only during the creation of a message warning about a
12192 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12193 .endlist
12194 .ecindex IIDstrexp
12195
12196
12197
12198 . ////////////////////////////////////////////////////////////////////////////
12199 . ////////////////////////////////////////////////////////////////////////////
12200
12201 .chapter "Embedded Perl" "CHAPperl"
12202 .scindex IIDperl "Perl" "calling from Exim"
12203 Exim can be built to include an embedded Perl interpreter. When this is done,
12204 Perl subroutines can be called as part of the string expansion process. To make
12205 use of the Perl support, you need version 5.004 or later of Perl installed on
12206 your system. To include the embedded interpreter in the Exim binary, include
12207 the line
12208 .code
12209 EXIM_PERL = perl.o
12210 .endd
12211 in your &_Local/Makefile_& and then build Exim in the normal way.
12212
12213
12214 .section "Setting up so Perl can be used" "SECID85"
12215 .oindex "&%perl_startup%&"
12216 Access to Perl subroutines is via a global configuration option called
12217 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12218 no &%perl_startup%& option in the Exim configuration file then no Perl
12219 interpreter is started and there is almost no overhead for Exim (since none of
12220 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12221 option then the associated value is taken to be Perl code which is executed in
12222 a newly created Perl interpreter.
12223
12224 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12225 need backslashes before any characters to escape special meanings. The option
12226 should usually be something like
12227 .code
12228 perl_startup = do '/etc/exim.pl'
12229 .endd
12230 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12231 use from Exim. Exim can be configured either to start up a Perl interpreter as
12232 soon as it is entered, or to wait until the first time it is needed. Starting
12233 the interpreter at the beginning ensures that it is done while Exim still has
12234 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12235 fact used in a particular run. Also, note that this does not mean that Exim is
12236 necessarily running as root when Perl is called at a later time. By default,
12237 the interpreter is started only when it is needed, but this can be changed in
12238 two ways:
12239
12240 .ilist
12241 .oindex "&%perl_at_start%&"
12242 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12243 a startup when Exim is entered.
12244 .next
12245 The command line option &%-ps%& also requests a startup when Exim is entered,
12246 overriding the setting of &%perl_at_start%&.
12247 .endlist
12248
12249 There is also a command line option &%-pd%& (for delay) which suppresses the
12250 initial startup, even if &%perl_at_start%& is set.
12251
12252
12253 .section "Calling Perl subroutines" "SECID86"
12254 When the configuration file includes a &%perl_startup%& option you can make use
12255 of the string expansion item to call the Perl subroutines that are defined
12256 by the &%perl_startup%& code. The operator is used in any of the following
12257 forms:
12258 .code
12259 ${perl{foo}}
12260 ${perl{foo}{argument}}
12261 ${perl{foo}{argument1}{argument2} ... }
12262 .endd
12263 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12264 arguments may be passed. Passing more than this results in an expansion failure
12265 with an error message of the form
12266 .code
12267 Too many arguments passed to Perl subroutine "foo" (max is 8)
12268 .endd
12269 The return value of the Perl subroutine is evaluated in a scalar context before
12270 it is passed back to Exim to be inserted into the expanded string. If the
12271 return value is &'undef'&, the expansion is forced to fail in the same way as
12272 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12273 by obeying Perl's &%die%& function, the expansion fails with the error message
12274 that was passed to &%die%&.
12275
12276
12277 .section "Calling Exim functions from Perl" "SECID87"
12278 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12279 is available to call back into Exim's string expansion function. For example,
12280 the Perl code
12281 .code
12282 my $lp = Exim::expand_string('$local_part');
12283 .endd
12284 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12285 Note those are single quotes and not double quotes to protect against
12286 &$local_part$& being interpolated as a Perl variable.
12287
12288 If the string expansion is forced to fail by a &"fail"& item, the result of
12289 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12290 expansion string, the Perl call from the original expansion string fails with
12291 an appropriate error message, in the same way as if &%die%& were used.
12292
12293 .cindex "debugging" "from embedded Perl"
12294 .cindex "log" "writing from embedded Perl"
12295 Two other Exim functions are available for use from within Perl code.
12296 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12297 debugging is enabled. If you want a newline at the end, you must supply it.
12298 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12299 timestamp. In this case, you should not supply a terminating newline.
12300
12301
12302 .section "Use of standard output and error by Perl" "SECID88"
12303 .cindex "Perl" "standard output and error"
12304 You should not write to the standard error or output streams from within your
12305 Perl code, as it is not defined how these are set up. In versions of Exim
12306 before 4.50, it is possible for the standard output or error to refer to the
12307 SMTP connection during message reception via the daemon. Writing to this stream
12308 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12309 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12310 avoided, but the output is lost.
12311
12312 .cindex "Perl" "use of &%warn%&"
12313 The Perl &%warn%& statement writes to the standard error stream by default.
12314 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12315 you have no control. When Exim starts up the Perl interpreter, it arranges for
12316 output from the &%warn%& statement to be written to the Exim main log. You can
12317 change this by including appropriate Perl magic somewhere in your Perl code.
12318 For example, to discard &%warn%& output completely, you need this:
12319 .code
12320 $SIG{__WARN__} = sub { };
12321 .endd
12322 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12323 example, the code for the subroutine is empty, so it does nothing, but you can
12324 include any Perl code that you like. The text of the &%warn%& message is passed
12325 as the first subroutine argument.
12326 .ecindex IIDperl
12327
12328
12329 . ////////////////////////////////////////////////////////////////////////////
12330 . ////////////////////////////////////////////////////////////////////////////
12331
12332 .chapter "Starting the daemon and the use of network interfaces" &&&
12333          "CHAPinterfaces" &&&
12334          "Starting the daemon"
12335 .cindex "daemon" "starting"
12336 .cindex "interface" "listening"
12337 .cindex "network interface"
12338 .cindex "interface" "network"
12339 .cindex "IP address" "for listening"
12340 .cindex "daemon" "listening IP addresses"
12341 .cindex "TCP/IP" "setting listening interfaces"
12342 .cindex "TCP/IP" "setting listening ports"
12343 A host that is connected to a TCP/IP network may have one or more physical
12344 hardware network interfaces. Each of these interfaces may be configured as one
12345 or more &"logical"& interfaces, which are the entities that a program actually
12346 works with. Each of these logical interfaces is associated with an IP address.
12347 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12348 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12349 knowledge about the host's interfaces for use in three different circumstances:
12350
12351 .olist
12352 When a listening daemon is started, Exim needs to know which interfaces
12353 and ports to listen on.
12354 .next
12355 When Exim is routing an address, it needs to know which IP addresses
12356 are associated with local interfaces. This is required for the correct
12357 processing of MX lists by removing the local host and others with the
12358 same or higher priority values. Also, Exim needs to detect cases
12359 when an address is routed to an IP address that in fact belongs to the
12360 local host. Unless the &%self%& router option or the &%allow_localhost%&
12361 option of the smtp transport is set (as appropriate), this is treated
12362 as an error situation.
12363 .next
12364 When Exim connects to a remote host, it may need to know which interface to use
12365 for the outgoing connection.
12366 .endlist
12367
12368
12369 Exim's default behaviour is likely to be appropriate in the vast majority
12370 of cases. If your host has only one interface, and you want all its IP
12371 addresses to be treated in the same way, and you are using only the
12372 standard SMTP port, you should not need to take any special action. The
12373 rest of this chapter does not apply to you.
12374
12375 In a more complicated situation you may want to listen only on certain
12376 interfaces, or on different ports, and for this reason there are a number of
12377 options that can be used to influence Exim's behaviour. The rest of this
12378 chapter describes how they operate.
12379
12380 When a message is received over TCP/IP, the interface and port that were
12381 actually used are set in &$received_ip_address$& and &$received_port$&.
12382
12383
12384
12385 .section "Starting a listening daemon" "SECID89"
12386 When a listening daemon is started (by means of the &%-bd%& command line
12387 option), the interfaces and ports on which it listens are controlled by the
12388 following options:
12389
12390 .ilist
12391 &%daemon_smtp_ports%& contains a list of default ports. (For backward
12392 compatibility, this option can also be specified in the singular.)
12393 .next
12394 &%local_interfaces%& contains list of interface IP addresses on which to
12395 listen. Each item may optionally also specify a port.
12396 .endlist
12397
12398 The default list separator in both cases is a colon, but this can be changed as
12399 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12400 it is usually best to change the separator to avoid having to double all the
12401 colons. For example:
12402 .code
12403 local_interfaces = <; 127.0.0.1 ; \
12404                       192.168.23.65 ; \
12405                       ::1 ; \
12406                       3ffe:ffff:836f::fe86:a061
12407 .endd
12408 There are two different formats for specifying a port along with an IP address
12409 in &%local_interfaces%&:
12410
12411 .olist
12412 The port is added onto the address with a dot separator. For example, to listen
12413 on port 1234 on two different IP addresses:
12414 .code
12415 local_interfaces = <; 192.168.23.65.1234 ; \
12416                       3ffe:ffff:836f::fe86:a061.1234
12417 .endd
12418 .next
12419 The IP address is enclosed in square brackets, and the port is added
12420 with a colon separator, for example:
12421 .code
12422 local_interfaces = <; [192.168.23.65]:1234 ; \
12423                       [3ffe:ffff:836f::fe86:a061]:1234
12424 .endd
12425 .endlist
12426
12427 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12428 default setting contains just one port:
12429 .code
12430 daemon_smtp_ports = smtp
12431 .endd
12432 If more than one port is listed, each interface that does not have its own port
12433 specified listens on all of them. Ports that are listed in
12434 &%daemon_smtp_ports%& can be identified either by name (defined in
12435 &_/etc/services_&) or by number. However, when ports are given with individual
12436 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12437
12438
12439
12440 .section "Special IP listening addresses" "SECID90"
12441 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12442 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12443 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12444 instead of setting up separate listening sockets for each interface. The
12445 default value of &%local_interfaces%& is
12446 .code
12447 local_interfaces = 0.0.0.0
12448 .endd
12449 when Exim is built without IPv6 support; otherwise it is:
12450 .code
12451 local_interfaces = <; ::0 ; 0.0.0.0
12452 .endd
12453 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12454
12455
12456
12457 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12458 The &%-oX%& command line option can be used to override the values of
12459 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12460 instance. Another way of doing this would be to use macros and the &%-D%&
12461 option. However, &%-oX%& can be used by any admin user, whereas modification of
12462 the runtime configuration by &%-D%& is allowed only when the caller is root or
12463 exim.
12464
12465 The value of &%-oX%& is a list of items. The default colon separator can be
12466 changed in the usual way if required. If there are any items that do not
12467 contain dots or colons (that is, are not IP addresses), the value of
12468 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12469 items that do contain dots or colons, the value of &%local_interfaces%& is
12470 replaced by those items. Thus, for example,
12471 .code
12472 -oX 1225
12473 .endd
12474 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12475 whereas
12476 .code
12477 -oX 192.168.34.5.1125
12478 .endd
12479 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12480 (However, since &%local_interfaces%& now contains no items without ports, the
12481 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12482
12483
12484
12485 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12486 .cindex "ssmtp protocol"
12487 .cindex "smtps protocol"
12488 .cindex "SMTP" "ssmtp protocol"
12489 .cindex "SMTP" "smtps protocol"
12490 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12491 before the STARTTLS command was standardized for SMTP. Some legacy clients
12492 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12493 list of port numbers, connections to those ports must use SSMTP. The most
12494 common use of this option is expected to be
12495 .code
12496 tls_on_connect_ports = 465
12497 .endd
12498 because 465 is the usual port number used by the legacy clients. There is also
12499 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12500 this way when a daemon is started.
12501
12502 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12503 daemon to listen on those ports. You must still specify them in
12504 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12505 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12506 connections via the daemon.)
12507
12508
12509
12510
12511 .section "IPv6 address scopes" "SECID92"
12512 .cindex "IPv6" "address scopes"
12513 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12514 can, in principle, have the same link-local IPv6 address on different
12515 interfaces. Thus, additional information is needed, over and above the IP
12516 address, to distinguish individual interfaces. A convention of using a
12517 percent sign followed by something (often the interface name) has been
12518 adopted in some cases, leading to addresses like this:
12519 .code
12520 fe80::202:b3ff:fe03:45c1%eth0
12521 .endd
12522 To accommodate this usage, a percent sign followed by an arbitrary string is
12523 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12524 to convert a textual IPv6 address for actual use. This function recognizes the
12525 percent convention in operating systems that support it, and it processes the
12526 address appropriately. Unfortunately, some older libraries have problems with
12527 &[getaddrinfo()]&. If
12528 .code
12529 IPV6_USE_INET_PTON=yes
12530 .endd
12531 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12532 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12533 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12534 function.) Of course, this means that the additional functionality of
12535 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12536
12537 .section "Disabling IPv6" "SECID93"
12538 .cindex "IPv6" "disabling"
12539 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12540 run on a host whose kernel does not support IPv6. The binary will fall back to
12541 using IPv4, but it may waste resources looking up AAAA records, and trying to
12542 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12543 .oindex "&%disable_ipv6%&"
12544 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12545 activities take place. AAAA records are never looked up, and any IPv6 addresses
12546 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12547 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12548 to handle IPv6 literal addresses.
12549
12550 On the other hand, when IPv6 is in use, there may be times when you want to
12551 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12552 option to globally suppress the lookup of AAAA records for specified domains,
12553 and you can use the &%ignore_target_hosts%& generic router option to ignore
12554 IPv6 addresses in an individual router.
12555
12556
12557
12558 .section "Examples of starting a listening daemon" "SECID94"
12559 The default case in an IPv6 environment is
12560 .code
12561 daemon_smtp_ports = smtp
12562 local_interfaces = <; ::0 ; 0.0.0.0
12563 .endd
12564 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12565 Either one or two sockets may be used, depending on the characteristics of
12566 the TCP/IP stack. (This is complicated and messy; for more information,
12567 read the comments in the &_daemon.c_& source file.)
12568
12569 To specify listening on ports 25 and 26 on all interfaces:
12570 .code
12571 daemon_smtp_ports = 25 : 26
12572 .endd
12573 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12574 .code
12575 local_interfaces = <; ::0.25     ; ::0.26 \
12576                       0.0.0.0.25 ; 0.0.0.0.26
12577 .endd
12578 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12579 IPv4 loopback address only:
12580 .code
12581 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12582 .endd
12583 To specify listening on the default port on specific interfaces only:
12584 .code
12585 local_interfaces = 10.0.0.67 : 192.168.34.67
12586 .endd
12587 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12588
12589
12590
12591 .section "Recognizing the local host" "SECTreclocipadd"
12592 The &%local_interfaces%& option is also used when Exim needs to determine
12593 whether or not an IP address refers to the local host. That is, the IP
12594 addresses of all the interfaces on which a daemon is listening are always
12595 treated as local.
12596
12597 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12598 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12599 available interfaces from the operating system, and extracts the relevant
12600 (that is, IPv4 or IPv6) addresses to use for checking.
12601
12602 Some systems set up large numbers of virtual interfaces in order to provide
12603 many virtual web servers. In this situation, you may want to listen for
12604 email on only a few of the available interfaces, but nevertheless treat all
12605 interfaces as local when routing. You can do this by setting
12606 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12607 &"all"& wildcard values. These addresses are recognized as local, but are not
12608 used for listening. Consider this example:
12609 .code
12610 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12611                       192.168.53.235 ; \
12612                       3ffe:2101:12:1:a00:20ff:fe86:a061
12613
12614 extra_local_interfaces = <; ::0 ; 0.0.0.0
12615 .endd
12616 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12617 address, but all available interface addresses are treated as local when
12618 Exim is routing.
12619
12620 In some environments the local host name may be in an MX list, but with an IP
12621 address that is not assigned to any local interface. In other cases it may be
12622 desirable to treat other host names as if they referred to the local host. Both
12623 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12624 This contains host names rather than IP addresses. When a host is referenced
12625 during routing, either via an MX record or directly, it is treated as the local
12626 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12627 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12628
12629
12630
12631 .section "Delivering to a remote host" "SECID95"
12632 Delivery to a remote host is handled by the smtp transport. By default, it
12633 allows the system's TCP/IP functions to choose which interface to use (if
12634 there is more than one) when connecting to a remote host. However, the
12635 &%interface%& option can be set to specify which interface is used. See the
12636 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12637 details.
12638
12639
12640
12641
12642 . ////////////////////////////////////////////////////////////////////////////
12643 . ////////////////////////////////////////////////////////////////////////////
12644
12645 .chapter "Main configuration" "CHAPmainconfig"
12646 .scindex IIDconfima "configuration file" "main section"
12647 .scindex IIDmaiconf "main configuration"
12648 The first part of the run time configuration file contains three types of item:
12649
12650 .ilist
12651 Macro definitions: These lines start with an upper case letter. See section
12652 &<<SECTmacrodefs>>& for details of macro processing.
12653 .next
12654 Named list definitions: These lines start with one of the words &"domainlist"&,
12655 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12656 section &<<SECTnamedlists>>&.
12657 .next
12658 Main configuration settings: Each setting occupies one line of the file
12659 (with possible continuations). If any setting is preceded by the word
12660 &"hide"&, the &%-bP%& command line option displays its value to admin users
12661 only. See section &<<SECTcos>>& for a description of the syntax of these option
12662 settings.
12663 .endlist
12664
12665 This chapter specifies all the main configuration options, along with their
12666 types and default values. For ease of finding a particular option, they appear
12667 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12668 are now so many options, they are first listed briefly in functional groups, as
12669 an aid to finding the name of the option you are looking for. Some options are
12670 listed in more than one group.
12671
12672 .section "Miscellaneous" "SECID96"
12673 .table2
12674 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12675 .row &%disable_ipv6%&                "do no IPv6 processing"
12676 .row &%keep_malformed%&              "for broken files &-- should not happen"
12677 .row &%localhost_number%&            "for unique message ids in clusters"
12678 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12679 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12680 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12681 .row &%print_topbitchars%&           "top-bit characters are printing"
12682 .row &%timezone%&                    "force time zone"
12683 .endtable
12684
12685
12686 .section "Exim parameters" "SECID97"
12687 .table2
12688 .row &%exim_group%&                  "override compiled-in value"
12689 .row &%exim_path%&                   "override compiled-in value"
12690 .row &%exim_user%&                   "override compiled-in value"
12691 .row &%primary_hostname%&            "default from &[uname()]&"
12692 .row &%split_spool_directory%&       "use multiple directories"
12693 .row &%spool_directory%&             "override compiled-in value"
12694 .endtable
12695
12696
12697
12698 .section "Privilege controls" "SECID98"
12699 .table2
12700 .row &%admin_groups%&                "groups that are Exim admin users"
12701 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12702 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12703 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12704 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12705 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12706 .row &%never_users%&                 "do not run deliveries as these"
12707 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12708 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12709 .row &%trusted_groups%&              "groups that are trusted"
12710 .row &%trusted_users%&               "users that are trusted"
12711 .endtable
12712
12713
12714
12715 .section "Logging" "SECID99"
12716 .table2
12717 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12718 .row &%log_file_path%&               "override compiled-in value"
12719 .row &%log_selector%&                "set/unset optional logging"
12720 .row &%log_timezone%&                "add timezone to log lines"
12721 .row &%message_logs%&                "create per-message logs"
12722 .row &%preserve_message_logs%&       "after message completion"
12723 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12724 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12725 .row &%syslog_facility%&             "set syslog &""facility""& field"
12726 .row &%syslog_processname%&          "set syslog &""ident""& field"
12727 .row &%syslog_timestamp%&            "timestamp syslog lines"
12728 .row &%write_rejectlog%&             "control use of message log"
12729 .endtable
12730
12731
12732
12733 .section "Frozen messages" "SECID100"
12734 .table2
12735 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12736 .row &%freeze_tell%&                 "send message when freezing"
12737 .row &%move_frozen_messages%&        "to another directory"
12738 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12739 .endtable
12740
12741
12742
12743 .section "Data lookups" "SECID101"
12744 .table2
12745 .row &%ibase_servers%&               "InterBase servers"
12746 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
12747 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
12748 .row &%ldap_cert_file%&              "client cert file for LDAP"
12749 .row &%ldap_cert_key%&               "client key file for LDAP"
12750 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
12751 .row &%ldap_default_servers%&        "used if no server in query"
12752 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
12753 .row &%ldap_start_tls%&              "require TLS within LDAP"
12754 .row &%ldap_version%&                "set protocol version"
12755 .row &%lookup_open_max%&             "lookup files held open"
12756 .row &%mysql_servers%&               "default MySQL servers"
12757 .row &%oracle_servers%&              "Oracle servers"
12758 .row &%pgsql_servers%&               "default PostgreSQL servers"
12759 .row &%sqlite_lock_timeout%&         "as it says"
12760 .endtable
12761
12762
12763
12764 .section "Message ids" "SECID102"
12765 .table2
12766 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12767 .row &%message_id_header_text%&      "ditto"
12768 .endtable
12769
12770
12771
12772 .section "Embedded Perl Startup" "SECID103"
12773 .table2
12774 .row &%perl_at_start%&               "always start the interpreter"
12775 .row &%perl_startup%&                "code to obey when starting Perl"
12776 .endtable
12777
12778
12779
12780 .section "Daemon" "SECID104"
12781 .table2
12782 .row &%daemon_smtp_ports%&           "default ports"
12783 .row &%daemon_startup_retries%&      "number of times to retry"
12784 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12785 .row &%extra_local_interfaces%&      "not necessarily listened on"
12786 .row &%local_interfaces%&            "on which to listen, with optional ports"
12787 .row &%pid_file_path%&               "override compiled-in value"
12788 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12789 .endtable
12790
12791
12792
12793 .section "Resource control" "SECID105"
12794 .table2
12795 .row &%check_log_inodes%&            "before accepting a message"
12796 .row &%check_log_space%&             "before accepting a message"
12797 .row &%check_spool_inodes%&          "before accepting a message"
12798 .row &%check_spool_space%&           "before accepting a message"
12799 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12800 .row &%queue_only_load%&             "queue incoming if load high"
12801 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12802 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12803 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12804 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12805 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12806 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12807 .row &%smtp_accept_max_per_connection%& "messages per connection"
12808 .row &%smtp_accept_max_per_host%&    "connections from one host"
12809 .row &%smtp_accept_queue%&           "queue mail if more connections"
12810 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12811                                            connection"
12812 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12813 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12814 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12815 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12816 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12817 .endtable
12818
12819
12820
12821 .section "Policy controls" "SECID106"
12822 .table2
12823 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12824 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12825 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12826 .row &%acl_smtp_auth%&               "ACL for AUTH"
12827 .row &%acl_smtp_connect%&            "ACL for connection"
12828 .row &%acl_smtp_data%&               "ACL for DATA"
12829 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12830 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12831 .row &%acl_smtp_expn%&               "ACL for EXPN"
12832 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12833 .row &%acl_smtp_mail%&               "ACL for MAIL"
12834 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12835 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12836 .row &%acl_smtp_predata%&            "ACL for start of data"
12837 .row &%acl_smtp_quit%&               "ACL for QUIT"
12838 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12839 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
12840 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
12841 .row &%av_scanner%&                  "specify virus scanner"
12842 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12843                                       words""&"
12844 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
12845 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
12846 .row &%header_maxsize%&              "total size of message header"
12847 .row &%header_line_maxsize%&         "individual header line limit"
12848 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
12849 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
12850 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
12851 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
12852 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
12853 .row &%host_lookup%&                 "host name looked up for these hosts"
12854 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12855 .row &%host_reject_connection%&      "reject connection from these hosts"
12856 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
12857 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
12858 .row &%message_size_limit%&          "for all messages"
12859 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12860 .row &%spamd_address%&               "set interface to SpamAssassin"
12861 .row &%strict_acl_vars%&             "object to unset ACL variables"
12862 .endtable
12863
12864
12865
12866 .section "Callout cache" "SECID107"
12867 .table2
12868 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
12869                                          item"
12870 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
12871                                          item"
12872 .row &%callout_negative_expire%&     "timeout for negative address cache item"
12873 .row &%callout_positive_expire%&     "timeout for positive address cache item"
12874 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
12875 .endtable
12876
12877
12878
12879 .section "TLS" "SECID108"
12880 .table2
12881 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
12882 .row &%gnutls_enable_pkcs11%&        "allow GnuTLS to autoload PKCS11 modules"
12883 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
12884 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12885 .row &%tls_certificate%&             "location of server certificate"
12886 .row &%tls_crl%&                     "certificate revocation list"
12887 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
12888 .row &%tls_dhparam%&                 "DH parameters for server"
12889 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
12890 .row &%tls_privatekey%&              "location of server private key"
12891 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
12892 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
12893 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
12894 .row &%tls_verify_certificates%&     "expected client certificates"
12895 .row &%tls_verify_hosts%&            "insist on client certificate verify"
12896 .endtable
12897
12898
12899
12900 .section "Local user handling" "SECID109"
12901 .table2
12902 .row &%finduser_retries%&            "useful in NIS environments"
12903 .row &%gecos_name%&                  "used when creating &'Sender:'&"
12904 .row &%gecos_pattern%&               "ditto"
12905 .row &%max_username_length%&         "for systems that truncate"
12906 .row &%unknown_login%&               "used when no login name found"
12907 .row &%unknown_username%&            "ditto"
12908 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
12909 .row &%uucp_from_sender%&            "ditto"
12910 .endtable
12911
12912
12913
12914 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
12915 .table2
12916 .row &%header_maxsize%&              "total size of message header"
12917 .row &%header_line_maxsize%&         "individual header line limit"
12918 .row &%message_size_limit%&          "applies to all messages"
12919 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12920 .row &%received_header_text%&        "expanded to make &'Received:'&"
12921 .row &%received_headers_max%&        "for mail loop detection"
12922 .row &%recipients_max%&              "limit per message"
12923 .row &%recipients_max_reject%&       "permanently reject excess recipients"
12924 .endtable
12925
12926
12927
12928
12929 .section "Non-SMTP incoming messages" "SECID111"
12930 .table2
12931 .row &%receive_timeout%&             "for non-SMTP messages"
12932 .endtable
12933
12934
12935
12936
12937
12938 .section "Incoming SMTP messages" "SECID112"
12939 See also the &'Policy controls'& section above.
12940
12941 .table2
12942 .row &%host_lookup%&                 "host name looked up for these hosts"
12943 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12944 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
12945 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
12946 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
12947 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
12948 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
12949 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12950 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12951 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12952 .row &%smtp_accept_max_per_connection%& "messages per connection"
12953 .row &%smtp_accept_max_per_host%&    "connections from one host"
12954 .row &%smtp_accept_queue%&           "queue mail if more connections"
12955 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12956                                            connection"
12957 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12958 .row &%smtp_active_hostname%&        "host name to use in messages"
12959 .row &%smtp_banner%&                 "text for welcome banner"
12960 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12961 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12962 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
12963 .row &%smtp_etrn_command%&           "what to run for ETRN"
12964 .row &%smtp_etrn_serialize%&         "only one at once"
12965 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
12966 .row &%smtp_max_unknown_commands%&   "before dropping connection"
12967 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
12968 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
12969 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
12970 .row &%smtp_receive_timeout%&        "per command or data line"
12971 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12972 .row &%smtp_return_error_details%&   "give detail on rejections"
12973 .endtable
12974
12975
12976
12977 .section "SMTP extensions" "SECID113"
12978 .table2
12979 .row &%accept_8bitmime%&             "advertise 8BITMIME"
12980 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
12981 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
12982 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
12983 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
12984 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12985 .endtable
12986
12987
12988
12989 .section "Processing messages" "SECID114"
12990 .table2
12991 .row &%allow_domain_literals%&       "recognize domain literal syntax"
12992 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
12993 .row &%allow_utf8_domains%&          "in addresses"
12994 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12995                                       words""&"
12996 .row &%delivery_date_remove%&        "from incoming messages"
12997 .row &%envelope_to_remove%&          "from incoming messages"
12998 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
12999 .row &%headers_charset%&             "default for translations"
13000 .row &%qualify_domain%&              "default for senders"
13001 .row &%qualify_recipient%&           "default for recipients"
13002 .row &%return_path_remove%&          "from incoming messages"
13003 .row &%strip_excess_angle_brackets%& "in addresses"
13004 .row &%strip_trailing_dot%&          "at end of addresses"
13005 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13006 .endtable
13007
13008
13009
13010 .section "System filter" "SECID115"
13011 .table2
13012 .row &%system_filter%&               "locate system filter"
13013 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13014                                             directory"
13015 .row &%system_filter_file_transport%& "transport for delivery to a file"
13016 .row &%system_filter_group%&         "group for filter running"
13017 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13018 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13019 .row &%system_filter_user%&          "user for filter running"
13020 .endtable
13021
13022
13023
13024 .section "Routing and delivery" "SECID116"
13025 .table2
13026 .row &%disable_ipv6%&                "do no IPv6 processing"
13027 .row &%dns_again_means_nonexist%&    "for broken domains"
13028 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13029 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13030 .row &%dns_retrans%&                 "parameter for resolver"
13031 .row &%dns_retry%&                   "parameter for resolver"
13032 .row &%dns_use_dnssec%&              "parameter for resolver"
13033 .row &%dns_use_edns0%&               "parameter for resolver"
13034 .row &%hold_domains%&                "hold delivery for these domains"
13035 .row &%local_interfaces%&            "for routing checks"
13036 .row &%queue_domains%&               "no immediate delivery for these"
13037 .row &%queue_only%&                  "no immediate delivery at all"
13038 .row &%queue_only_file%&             "no immediate delivery if file exists"
13039 .row &%queue_only_load%&             "no immediate delivery if load is high"
13040 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13041 .row &%queue_only_override%&         "allow command line to override"
13042 .row &%queue_run_in_order%&          "order of arrival"
13043 .row &%queue_run_max%&               "of simultaneous queue runners"
13044 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13045 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13046 .row &%remote_sort_domains%&         "order of remote deliveries"
13047 .row &%retry_data_expire%&           "timeout for retry data"
13048 .row &%retry_interval_max%&          "safety net for retry rules"
13049 .endtable
13050
13051
13052
13053 .section "Bounce and warning messages" "SECID117"
13054 .table2
13055 .row &%bounce_message_file%&         "content of bounce"
13056 .row &%bounce_message_text%&         "content of bounce"
13057 .row &%bounce_return_body%&          "include body if returning message"
13058 .row &%bounce_return_message%&       "include original message in bounce"
13059 .row &%bounce_return_size_limit%&    "limit on returned message"
13060 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13061 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13062 .row &%errors_copy%&                 "copy bounce messages"
13063 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13064 .row &%delay_warning%&               "time schedule"
13065 .row &%delay_warning_condition%&     "condition for warning messages"
13066 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13067 .row &%smtp_return_error_details%&   "give detail on rejections"
13068 .row &%warn_message_file%&           "content of warning message"
13069 .endtable
13070
13071
13072
13073 .section "Alphabetical list of main options" "SECTalomo"
13074 Those options that undergo string expansion before use are marked with
13075 &dagger;.
13076
13077 .option accept_8bitmime main boolean true
13078 .cindex "8BITMIME"
13079 .cindex "8-bit characters"
13080 This option causes Exim to send 8BITMIME in its response to an SMTP
13081 EHLO command, and to accept the BODY= parameter on MAIL commands.
13082 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13083 takes no steps to do anything special with messages received by this route.
13084
13085 Historically Exim kept this option off by default, but the maintainers
13086 feel that in today's Internet, this causes more problems than it solves.
13087 It now defaults to true.
13088 A more detailed analysis of the issues is provided by Dan Bernstein:
13089 .display
13090 &url(http://cr.yp.to/smtp/8bitmime.html)
13091 .endd
13092
13093 .option acl_not_smtp main string&!! unset
13094 .cindex "&ACL;" "for non-SMTP messages"
13095 .cindex "non-SMTP messages" "ACLs for"
13096 This option defines the ACL that is run when a non-SMTP message has been
13097 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13098 further details.
13099
13100 .option acl_not_smtp_mime main string&!! unset
13101 This option defines the ACL that is run for individual MIME parts of non-SMTP
13102 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13103 SMTP messages.
13104
13105 .option acl_not_smtp_start main string&!! unset
13106 .cindex "&ACL;" "at start of non-SMTP message"
13107 .cindex "non-SMTP messages" "ACLs for"
13108 This option defines the ACL that is run before Exim starts reading a
13109 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13110
13111 .option acl_smtp_auth main string&!! unset
13112 .cindex "&ACL;" "setting up for SMTP commands"
13113 .cindex "AUTH" "ACL for"
13114 This option defines the ACL that is run when an SMTP AUTH command is
13115 received. See chapter &<<CHAPACL>>& for further details.
13116
13117 .option acl_smtp_connect main string&!! unset
13118 .cindex "&ACL;" "on SMTP connection"
13119 This option defines the ACL that is run when an SMTP connection is received.
13120 See chapter &<<CHAPACL>>& for further details.
13121
13122 .option acl_smtp_data main string&!! unset
13123 .cindex "DATA" "ACL for"
13124 This option defines the ACL that is run after an SMTP DATA command has been
13125 processed and the message itself has been received, but before the final
13126 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13127
13128 .option acl_smtp_etrn main string&!! unset
13129 .cindex "ETRN" "ACL for"
13130 This option defines the ACL that is run when an SMTP ETRN command is
13131 received. See chapter &<<CHAPACL>>& for further details.
13132
13133 .option acl_smtp_expn main string&!! unset
13134 .cindex "EXPN" "ACL for"
13135 This option defines the ACL that is run when an SMTP EXPN command is
13136 received. See chapter &<<CHAPACL>>& for further details.
13137
13138 .option acl_smtp_helo main string&!! unset
13139 .cindex "EHLO" "ACL for"
13140 .cindex "HELO" "ACL for"
13141 This option defines the ACL that is run when an SMTP EHLO or HELO
13142 command is received. See chapter &<<CHAPACL>>& for further details.
13143
13144
13145 .option acl_smtp_mail main string&!! unset
13146 .cindex "MAIL" "ACL for"
13147 This option defines the ACL that is run when an SMTP MAIL command is
13148 received. See chapter &<<CHAPACL>>& for further details.
13149
13150 .option acl_smtp_mailauth main string&!! unset
13151 .cindex "AUTH" "on MAIL command"
13152 This option defines the ACL that is run when there is an AUTH parameter on
13153 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13154 &<<CHAPSMTPAUTH>>& for details of authentication.
13155
13156 .option acl_smtp_mime main string&!! unset
13157 .cindex "MIME content scanning" "ACL for"
13158 This option is available when Exim is built with the content-scanning
13159 extension. It defines the ACL that is run for each MIME part in a message. See
13160 section &<<SECTscanmimepart>>& for details.
13161
13162 .option acl_smtp_predata main string&!! unset
13163 This option defines the ACL that is run when an SMTP DATA command is
13164 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13165 further details.
13166
13167 .option acl_smtp_quit main string&!! unset
13168 .cindex "QUIT, ACL for"
13169 This option defines the ACL that is run when an SMTP QUIT command is
13170 received. See chapter &<<CHAPACL>>& for further details.
13171
13172 .option acl_smtp_rcpt main string&!! unset
13173 .cindex "RCPT" "ACL for"
13174 This option defines the ACL that is run when an SMTP RCPT command is
13175 received. See chapter &<<CHAPACL>>& for further details.
13176
13177 .option acl_smtp_starttls main string&!! unset
13178 .cindex "STARTTLS, ACL for"
13179 This option defines the ACL that is run when an SMTP STARTTLS command is
13180 received. See chapter &<<CHAPACL>>& for further details.
13181
13182 .option acl_smtp_vrfy main string&!! unset
13183 .cindex "VRFY" "ACL for"
13184 This option defines the ACL that is run when an SMTP VRFY command is
13185 received. See chapter &<<CHAPACL>>& for further details.
13186
13187 .option admin_groups main "string list&!!" unset
13188 .cindex "admin user"
13189 This option is expanded just once, at the start of Exim's processing. If the
13190 current group or any of the supplementary groups of an Exim caller is in this
13191 colon-separated list, the caller has admin privileges. If all your system
13192 programmers are in a specific group, for example, you can give them all Exim
13193 admin privileges by putting that group in &%admin_groups%&. However, this does
13194 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13195 To permit this, you have to add individuals to the Exim group.
13196
13197 .option allow_domain_literals main boolean false
13198 .cindex "domain literal"
13199 If this option is set, the RFC 2822 domain literal format is permitted in
13200 email addresses. The option is not set by default, because the domain literal
13201 format is not normally required these days, and few people know about it. It
13202 has, however, been exploited by mail abusers.
13203
13204 Unfortunately, it seems that some DNS black list maintainers are using this
13205 format to report black listing to postmasters. If you want to accept messages
13206 addressed to your hosts by IP address, you need to set
13207 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13208 domains (defined in the named domain list &%local_domains%& in the default
13209 configuration). This &"magic string"& matches the domain literal form of all
13210 the local host's IP addresses.
13211
13212
13213 .option allow_mx_to_ip main boolean false
13214 .cindex "MX record" "pointing to IP address"
13215 It appears that more and more DNS zone administrators are breaking the rules
13216 and putting domain names that look like IP addresses on the right hand side of
13217 MX records. Exim follows the rules and rejects this, giving an error message
13218 that explains the mis-configuration. However, some other MTAs support this
13219 practice, so to avoid &"Why can't Exim do this?"& complaints,
13220 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13221 recommended, except when you have no other choice.
13222
13223 .option allow_utf8_domains main boolean false
13224 .cindex "domain" "UTF-8 characters in"
13225 .cindex "UTF-8" "in domain name"
13226 Lots of discussion is going on about internationalized domain names. One
13227 camp is strongly in favour of just using UTF-8 characters, and it seems
13228 that at least two other MTAs permit this. This option allows Exim users to
13229 experiment if they wish.
13230
13231 If it is set true, Exim's domain parsing function allows valid
13232 UTF-8 multicharacters to appear in domain name components, in addition to
13233 letters, digits, and hyphens. However, just setting this option is not
13234 enough; if you want to look up these domain names in the DNS, you must also
13235 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13236 suitable setting is:
13237 .code
13238 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13239   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13240 .endd
13241 Alternatively, you can just disable this feature by setting
13242 .code
13243 dns_check_names_pattern =
13244 .endd
13245 That is, set the option to an empty string so that no check is done.
13246
13247
13248 .option auth_advertise_hosts main "host list&!!" *
13249 .cindex "authentication" "advertising"
13250 .cindex "AUTH" "advertising"
13251 If any server authentication mechanisms are configured, Exim advertises them in
13252 response to an EHLO command only if the calling host matches this list.
13253 Otherwise, Exim does not advertise AUTH.
13254 Exim does not accept AUTH commands from clients to which it has not
13255 advertised the availability of AUTH. The advertising of individual
13256 authentication mechanisms can be controlled by the use of the
13257 &%server_advertise_condition%& generic authenticator option on the individual
13258 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13259
13260 Certain mail clients (for example, Netscape) require the user to provide a name
13261 and password for authentication if AUTH is advertised, even though it may
13262 not be needed (the host may accept messages from hosts on its local LAN without
13263 authentication, for example). The &%auth_advertise_hosts%& option can be used
13264 to make these clients more friendly by excluding them from the set of hosts to
13265 which Exim advertises AUTH.
13266
13267 .cindex "AUTH" "advertising when encrypted"
13268 If you want to advertise the availability of AUTH only when the connection
13269 is encrypted using TLS, you can make use of the fact that the value of this
13270 option is expanded, with a setting like this:
13271 .code
13272 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13273 .endd
13274 .vindex "&$tls_in_cipher$&"
13275 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13276 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13277 expansion is *, which matches all hosts.
13278
13279
13280 .option auto_thaw main time 0s
13281 .cindex "thawing messages"
13282 .cindex "unfreezing messages"
13283 If this option is set to a time greater than zero, a queue runner will try a
13284 new delivery attempt on any frozen message, other than a bounce message, if
13285 this much time has passed since it was frozen. This may result in the message
13286 being re-frozen if nothing has changed since the last attempt. It is a way of
13287 saying &"keep on trying, even though there are big problems"&.
13288
13289 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13290 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13291 thought to be very useful any more, and its use should probably be avoided.
13292
13293
13294 .option av_scanner main string "see below"
13295 This option is available if Exim is built with the content-scanning extension.
13296 It specifies which anti-virus scanner to use. The default value is:
13297 .code
13298 sophie:/var/run/sophie
13299 .endd
13300 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13301 before use. See section &<<SECTscanvirus>>& for further details.
13302
13303
13304 .option bi_command main string unset
13305 .oindex "&%-bi%&"
13306 This option supplies the name of a command that is run when Exim is called with
13307 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13308 just the command name, it is not a complete command line. If an argument is
13309 required, it must come from the &%-oA%& command line option.
13310
13311
13312 .option bounce_message_file main string unset
13313 .cindex "bounce message" "customizing"
13314 .cindex "customizing" "bounce message"
13315 This option defines a template file containing paragraphs of text to be used
13316 for constructing bounce messages.  Details of the file's contents are given in
13317 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13318
13319
13320 .option bounce_message_text main string unset
13321 When this option is set, its contents are included in the default bounce
13322 message immediately after &"This message was created automatically by mail
13323 delivery software."& It is not used if &%bounce_message_file%& is set.
13324
13325 .option bounce_return_body main boolean true
13326 .cindex "bounce message" "including body"
13327 This option controls whether the body of an incoming message is included in a
13328 bounce message when &%bounce_return_message%& is true. The default setting
13329 causes the entire message, both header and body, to be returned (subject to the
13330 value of &%bounce_return_size_limit%&). If this option is false, only the
13331 message header is included. In the case of a non-SMTP message containing an
13332 error that is detected during reception, only those header lines preceding the
13333 point at which the error was detected are returned.
13334 .cindex "bounce message" "including original"
13335
13336 .option bounce_return_message main boolean true
13337 If this option is set false, none of the original message is included in
13338 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13339 &%bounce_return_body%&.
13340
13341
13342 .option bounce_return_size_limit main integer 100K
13343 .cindex "size" "of bounce, limit"
13344 .cindex "bounce message" "size limit"
13345 .cindex "limit" "bounce message size"
13346 This option sets a limit in bytes on the size of messages that are returned to
13347 senders as part of bounce messages when &%bounce_return_message%& is true. The
13348 limit should be less than the value of the global &%message_size_limit%& and of
13349 any &%message_size_limit%& settings on transports, to allow for the bounce text
13350 that Exim generates. If this option is set to zero there is no limit.
13351
13352 When the body of any message that is to be included in a bounce message is
13353 greater than the limit, it is truncated, and a comment pointing this out is
13354 added at the top. The actual cutoff may be greater than the value given, owing
13355 to the use of buffering for transferring the message in chunks (typically 8K in
13356 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13357 messages.
13358
13359 .option bounce_sender_authentication main string unset
13360 .cindex "bounce message" "sender authentication"
13361 .cindex "authentication" "bounce message"
13362 .cindex "AUTH" "on bounce message"
13363 This option provides an authenticated sender address that is sent with any
13364 bounce messages generated by Exim that are sent over an authenticated SMTP
13365 connection. A typical setting might be:
13366 .code
13367 bounce_sender_authentication = mailer-daemon@my.domain.example
13368 .endd
13369 which would cause bounce messages to be sent using the SMTP command:
13370 .code
13371 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13372 .endd
13373 The value of &%bounce_sender_authentication%& must always be a complete email
13374 address.
13375
13376 .option callout_domain_negative_expire main time 3h
13377 .cindex "caching" "callout timeouts"
13378 .cindex "callout" "caching timeouts"
13379 This option specifies the expiry time for negative callout cache data for a
13380 domain. See section &<<SECTcallver>>& for details of callout verification, and
13381 section &<<SECTcallvercache>>& for details of the caching.
13382
13383
13384 .option callout_domain_positive_expire main time 7d
13385 This option specifies the expiry time for positive callout cache data for a
13386 domain. See section &<<SECTcallver>>& for details of callout verification, and
13387 section &<<SECTcallvercache>>& for details of the caching.
13388
13389
13390 .option callout_negative_expire main time 2h
13391 This option specifies the expiry time for negative callout cache data for an
13392 address. See section &<<SECTcallver>>& for details of callout verification, and
13393 section &<<SECTcallvercache>>& for details of the caching.
13394
13395
13396 .option callout_positive_expire main time 24h
13397 This option specifies the expiry time for positive callout cache data for an
13398 address. See section &<<SECTcallver>>& for details of callout verification, and
13399 section &<<SECTcallvercache>>& for details of the caching.
13400
13401
13402 .option callout_random_local_part main string&!! "see below"
13403 This option defines the &"random"& local part that can be used as part of
13404 callout verification. The default value is
13405 .code
13406 $primary_hostname-$tod_epoch-testing
13407 .endd
13408 See section &<<CALLaddparcall>>& for details of how this value is used.
13409
13410
13411 .option check_log_inodes main integer 0
13412 See &%check_spool_space%& below.
13413
13414
13415 .option check_log_space main integer 0
13416 See &%check_spool_space%& below.
13417
13418 .oindex "&%check_rfc2047_length%&"
13419 .cindex "RFC 2047" "disabling length check"
13420 .option check_rfc2047_length main boolean true
13421 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13422 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13423 word; strings to be encoded that exceed this length are supposed to use
13424 multiple encoded words. By default, Exim does not recognize encoded words that
13425 exceed the maximum length. However, it seems that some software, in violation
13426 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13427 set false, Exim recognizes encoded words of any length.
13428
13429
13430 .option check_spool_inodes main integer 0
13431 See &%check_spool_space%& below.
13432
13433
13434 .option check_spool_space main integer 0
13435 .cindex "checking disk space"
13436 .cindex "disk space, checking"
13437 .cindex "spool directory" "checking space"
13438 The four &%check_...%& options allow for checking of disk resources before a
13439 message is accepted.
13440
13441 .vindex "&$log_inodes$&"
13442 .vindex "&$log_space$&"
13443 .vindex "&$spool_inodes$&"
13444 .vindex "&$spool_space$&"
13445 When any of these options are set, they apply to all incoming messages. If you
13446 want to apply different checks to different kinds of message, you can do so by
13447 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13448 &$spool_space$& in an ACL with appropriate additional conditions.
13449
13450
13451 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13452 either value is greater than zero, for example:
13453 .code
13454 check_spool_space = 10M
13455 check_spool_inodes = 100
13456 .endd
13457 The spool partition is the one that contains the directory defined by
13458 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13459 transit.
13460
13461 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13462 files are written if either is greater than zero. These should be set only if
13463 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13464
13465 If there is less space or fewer inodes than requested, Exim refuses to accept
13466 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13467 error response to the MAIL command. If ESMTP is in use and there was a
13468 SIZE parameter on the MAIL command, its value is added to the
13469 &%check_spool_space%& value, and the check is performed even if
13470 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13471
13472 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13473 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13474
13475 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13476 failure a message is written to stderr and Exim exits with a non-zero code, as
13477 it obviously cannot send an error message of any kind.
13478
13479 .option daemon_smtp_ports main string &`smtp`&
13480 .cindex "port" "for daemon"
13481 .cindex "TCP/IP" "setting listening ports"
13482 This option specifies one or more default SMTP ports on which the Exim daemon
13483 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13484 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13485
13486 .option daemon_startup_retries main integer 9
13487 .cindex "daemon startup, retrying"
13488 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13489 the daemon at startup when it cannot immediately bind a listening socket
13490 (typically because the socket is already in use): &%daemon_startup_retries%&
13491 defines the number of retries after the first failure, and
13492 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13493
13494 .option daemon_startup_sleep main time 30s
13495 See &%daemon_startup_retries%&.
13496
13497 .option delay_warning main "time list" 24h
13498 .cindex "warning of delay"
13499 .cindex "delay warning, specifying"
13500 When a message is delayed, Exim sends a warning message to the sender at
13501 intervals specified by this option. The data is a colon-separated list of times
13502 after which to send warning messages. If the value of the option is an empty
13503 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13504 message has been on the queue for longer than the last time, the last interval
13505 between the times is used to compute subsequent warning times. For example,
13506 with
13507 .code
13508 delay_warning = 4h:8h:24h
13509 .endd
13510 the first message is sent after 4 hours, the second after 8 hours, and
13511 the third one after 24 hours. After that, messages are sent every 16 hours,
13512 because that is the interval between the last two times on the list. If you set
13513 just one time, it specifies the repeat interval. For example, with:
13514 .code
13515 delay_warning = 6h
13516 .endd
13517 messages are repeated every six hours. To stop warnings after a given time, set
13518 a very large time at the end of the list. For example:
13519 .code
13520 delay_warning = 2h:12h:99d
13521 .endd
13522
13523 .option delay_warning_condition main string&!! "see below"
13524 .vindex "&$domain$&"
13525 The string is expanded at the time a warning message might be sent. If all the
13526 deferred addresses have the same domain, it is set in &$domain$& during the
13527 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13528 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13529 &"false"& (the comparison being done caselessly) then the warning message is
13530 not sent. The default is:
13531 .code
13532 delay_warning_condition = ${if or {\
13533   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13534   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13535   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13536   } {no}{yes}}
13537 .endd
13538 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13539 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13540 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13541 &"auto-replied"& in an &'Auto-Submitted:'& header.
13542
13543 .option deliver_drop_privilege main boolean false
13544 .cindex "unprivileged delivery"
13545 .cindex "delivery" "unprivileged"
13546 If this option is set true, Exim drops its root privilege at the start of a
13547 delivery process, and runs as the Exim user throughout. This severely restricts
13548 the kinds of local delivery that are possible, but is viable in certain types
13549 of configuration. There is a discussion about the use of root privilege in
13550 chapter &<<CHAPsecurity>>&.
13551
13552 .option deliver_queue_load_max main fixed-point unset
13553 .cindex "load average"
13554 .cindex "queue runner" "abandoning"
13555 When this option is set, a queue run is abandoned if the system load average
13556 becomes greater than the value of the option. The option has no effect on
13557 ancient operating systems on which Exim cannot determine the load average.
13558 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13559
13560
13561 .option delivery_date_remove main boolean true
13562 .cindex "&'Delivery-date:'& header line"
13563 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13564 message when it is delivered, in exactly the same way as &'Return-path:'& is
13565 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13566 should not be present in incoming messages, and this option causes them to be
13567 removed at the time the message is received, to avoid any problems that might
13568 occur when a delivered message is subsequently sent on to some other recipient.
13569
13570 .option disable_fsync main boolean false
13571 .cindex "&[fsync()]&, disabling"
13572 This option is available only if Exim was built with the compile-time option
13573 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13574 a runtime configuration generates an &"unknown option"& error. You should not
13575 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13576 really, really, really understand what you are doing. &'No pre-compiled
13577 distributions of Exim should ever make this option available.'&
13578
13579 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13580 updated files' data to be written to disc before continuing. Unexpected events
13581 such as crashes and power outages may cause data to be lost or scrambled.
13582 Here be Dragons. &*Beware.*&
13583
13584
13585 .option disable_ipv6 main boolean false
13586 .cindex "IPv6" "disabling"
13587 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13588 activities take place. AAAA records are never looked up, and any IPv6 addresses
13589 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13590 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13591 to handle IPv6 literal addresses.
13592
13593
13594 .option dns_again_means_nonexist main "domain list&!!" unset
13595 .cindex "DNS" "&""try again""& response; overriding"
13596 DNS lookups give a &"try again"& response for the DNS errors
13597 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13598 keep trying to deliver a message, or to give repeated temporary errors to
13599 incoming mail. Sometimes the effect is caused by a badly set up name server and
13600 may persist for a long time. If a domain which exhibits this problem matches
13601 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13602 This option should be used with care. You can make it apply to reverse lookups
13603 by a setting such as this:
13604 .code
13605 dns_again_means_nonexist = *.in-addr.arpa
13606 .endd
13607 This option applies to all DNS lookups that Exim does. It also applies when the
13608 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13609 since these are most likely to be caused by DNS lookup problems. The
13610 &(dnslookup)& router has some options of its own for controlling what happens
13611 when lookups for MX or SRV records give temporary errors. These more specific
13612 options are applied after this global option.
13613
13614 .option dns_check_names_pattern main string "see below"
13615 .cindex "DNS" "pre-check of name syntax"
13616 When this option is set to a non-empty string, it causes Exim to check domain
13617 names for characters that are not allowed in host names before handing them to
13618 the DNS resolver, because some resolvers give temporary errors for names that
13619 contain unusual characters. If a domain name contains any unwanted characters,
13620 a &"not found"& result is forced, and the resolver is not called. The check is
13621 done by matching the domain name against a regular expression, which is the
13622 value of this option. The default pattern is
13623 .code
13624 dns_check_names_pattern = \
13625   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13626 .endd
13627 which permits only letters, digits, slashes, and hyphens in components, but
13628 they must start and end with a letter or digit. Slashes are not, in fact,
13629 permitted in host names, but they are found in certain NS records (which can be
13630 accessed in Exim by using a &%dnsdb%& lookup). If you set
13631 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13632 empty string.
13633
13634 .option dns_csa_search_limit main integer 5
13635 This option controls the depth of parental searching for CSA SRV records in the
13636 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13637
13638 .option dns_csa_use_reverse main boolean true
13639 This option controls whether or not an IP address, given as a CSA domain, is
13640 reversed and looked up in the reverse DNS, as described in more detail in
13641 section &<<SECTverifyCSA>>&.
13642
13643 .option dns_ipv4_lookup main "domain list&!!" unset
13644 .cindex "IPv6" "DNS lookup for AAAA records"
13645 .cindex "DNS" "IPv6 lookup for AAAA records"
13646 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13647 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13648 (A records) when trying to find IP addresses for hosts, unless the host's
13649 domain matches this list.
13650
13651 This is a fudge to help with name servers that give big delays or otherwise do
13652 not work for the AAAA record type. In due course, when the world's name
13653 servers have all been upgraded, there should be no need for this option.
13654
13655
13656 .option dns_retrans main time 0s
13657 .cindex "DNS" "resolver options"
13658 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13659 retransmission and retry parameters for DNS lookups. Values of zero (the
13660 defaults) leave the system default settings unchanged. The first value is the
13661 time between retries, and the second is the number of retries. It isn't
13662 totally clear exactly how these settings affect the total time a DNS lookup may
13663 take. I haven't found any documentation about timeouts on DNS lookups; these
13664 parameter values are available in the external resolver interface structure,
13665 but nowhere does it seem to describe how they are used or what you might want
13666 to set in them.
13667
13668
13669 .option dns_retry main integer 0
13670 See &%dns_retrans%& above.
13671
13672
13673 .new
13674 .option dns_use_dnssec main integer -1
13675 .cindex "DNS" "resolver options"
13676 .cindex "DNS" "DNSSEC"
13677 If this option is set to a non-negative number then Exim will initialise the
13678 DNS resolver library to either use or not use DNSSEC, overriding the system
13679 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
13680
13681 If the resolver library does not support DNSSEC then this option has no effect.
13682 .wen
13683
13684
13685 .option dns_use_edns0 main integer -1
13686 .cindex "DNS" "resolver options"
13687 .cindex "DNS" "EDNS0"
13688 If this option is set to a non-negative number then Exim will initialise the
13689 DNS resolver library to either use or not use EDNS0 extensions, overriding
13690 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
13691 on.
13692
13693 If the resolver library does not support EDNS0 then this option has no effect.
13694
13695
13696 .option drop_cr main boolean false
13697 This is an obsolete option that is now a no-op. It used to affect the way Exim
13698 handled CR and LF characters in incoming messages. What happens now is
13699 described in section &<<SECTlineendings>>&.
13700
13701 .option dsn_from main "string&!!" "see below"
13702 .cindex "&'From:'& header line" "in bounces"
13703 .cindex "bounce messages" "&'From:'& line, specifying"
13704 This option can be used to vary the contents of &'From:'& header lines in
13705 bounces and other automatically generated messages (&"Delivery Status
13706 Notifications"& &-- hence the name of the option). The default setting is:
13707 .code
13708 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13709 .endd
13710 The value is expanded every time it is needed. If the expansion fails, a
13711 panic is logged, and the default value is used.
13712
13713 .option envelope_to_remove main boolean true
13714 .cindex "&'Envelope-to:'& header line"
13715 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13716 message when it is delivered, in exactly the same way as &'Return-path:'& is
13717 handled. &'Envelope-to:'& records the original recipient address from the
13718 messages's envelope that caused the delivery to happen. Such headers should not
13719 be present in incoming messages, and this option causes them to be removed at
13720 the time the message is received, to avoid any problems that might occur when a
13721 delivered message is subsequently sent on to some other recipient.
13722
13723
13724 .option errors_copy main "string list&!!" unset
13725 .cindex "bounce message" "copy to other address"
13726 .cindex "copy of bounce message"
13727 Setting this option causes Exim to send bcc copies of bounce messages that it
13728 generates to other addresses. &*Note*&: This does not apply to bounce messages
13729 coming from elsewhere. The value of the option is a colon-separated list of
13730 items. Each item consists of a pattern, terminated by white space, followed by
13731 a comma-separated list of email addresses. If a pattern contains spaces, it
13732 must be enclosed in double quotes.
13733
13734 Each pattern is processed in the same way as a single item in an address list
13735 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13736 the bounce message, the message is copied to the addresses on the list. The
13737 items are scanned in order, and once a matching one is found, no further items
13738 are examined. For example:
13739 .code
13740 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13741               rqps@mydomain   hostmaster@mydomain.example,\
13742                               postmaster@mydomain.example
13743 .endd
13744 .vindex "&$domain$&"
13745 .vindex "&$local_part$&"
13746 The address list is expanded before use. The expansion variables &$local_part$&
13747 and &$domain$& are set from the original recipient of the error message, and if
13748 there was any wildcard matching in the pattern, the expansion
13749 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13750 variables &$0$&, &$1$&, etc. are set in the normal way.
13751
13752
13753 .option errors_reply_to main string unset
13754 .cindex "bounce message" "&'Reply-to:'& in"
13755 By default, Exim's bounce and delivery warning messages contain the header line
13756 .display
13757 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13758 .endd
13759 .oindex &%quota_warn_message%&
13760 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13761 A warning message that is generated by the &%quota_warn_message%& option in an
13762 &(appendfile)& transport may contain its own &'From:'& header line that
13763 overrides the default.
13764
13765 Experience shows that people reply to bounce messages. If the
13766 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13767 and warning messages. For example:
13768 .code
13769 errors_reply_to = postmaster@my.domain.example
13770 .endd
13771 The value of the option is not expanded. It must specify a valid RFC 2822
13772 address. However, if a warning message that is generated by the
13773 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13774 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13775 not used.
13776
13777
13778 .option exim_group main string "compile-time configured"
13779 .cindex "gid (group id)" "Exim's own"
13780 .cindex "Exim group"
13781 This option changes the gid under which Exim runs when it gives up root
13782 privilege. The default value is compiled into the binary. The value of this
13783 option is used only when &%exim_user%& is also set. Unless it consists entirely
13784 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13785 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13786 security issues.
13787
13788
13789 .option exim_path main string "see below"
13790 .cindex "Exim binary, path name"
13791 This option specifies the path name of the Exim binary, which is used when Exim
13792 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13793 the directory configured at compile time by the BIN_DIRECTORY setting. It
13794 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13795 other place.
13796 &*Warning*&: Do not use a macro to define the value of this option, because
13797 you will break those Exim utilities that scan the configuration file to find
13798 where the binary is. (They then use the &%-bP%& option to extract option
13799 settings such as the value of &%spool_directory%&.)
13800
13801
13802 .option exim_user main string "compile-time configured"
13803 .cindex "uid (user id)" "Exim's own"
13804 .cindex "Exim user"
13805 This option changes the uid under which Exim runs when it gives up root
13806 privilege. The default value is compiled into the binary. Ownership of the run
13807 time configuration file and the use of the &%-C%& and &%-D%& command line
13808 options is checked against the values in the binary, not what is set here.
13809
13810 Unless it consists entirely of digits, the string is looked up using
13811 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13812 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13813 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13814
13815
13816 .option extra_local_interfaces main "string list" unset
13817 This option defines network interfaces that are to be considered local when
13818 routing, but which are not used for listening by the daemon. See section
13819 &<<SECTreclocipadd>>& for details.
13820
13821
13822 . Allow this long option name to split; give it unsplit as a fifth argument
13823 . for the automatic .oindex that is generated by .option.
13824
13825 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13826          extract_addresses_remove_arguments
13827 .oindex "&%-t%&"
13828 .cindex "command line" "addresses with &%-t%&"
13829 .cindex "Sendmail compatibility" "&%-t%& option"
13830 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13831 are present on the command line when the &%-t%& option is used to build an
13832 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13833 line addresses are removed from the recipients list. This is also how Smail
13834 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13835 command line addresses are added to those obtained from the header lines. When
13836 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13837 argument headers. If it is set false, Exim adds rather than removes argument
13838 addresses.
13839
13840
13841 .option finduser_retries main integer 0
13842 .cindex "NIS, retrying user lookups"
13843 On systems running NIS or other schemes in which user and group information is
13844 distributed from a remote system, there can be times when &[getpwnam()]& and
13845 related functions fail, even when given valid data, because things time out.
13846 Unfortunately these failures cannot be distinguished from genuine &"not found"&
13847 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
13848 many extra times to find a user or a group, waiting for one second between
13849 retries.
13850
13851 .cindex "&_/etc/passwd_&" "multiple reading of"
13852 You should not set this option greater than zero if your user information is in
13853 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
13854 search the file multiple times for non-existent users, and also cause delay.
13855
13856
13857
13858 .option freeze_tell main "string list, comma separated" unset
13859 .cindex "freezing messages" "sending a message when freezing"
13860 On encountering certain errors, or when configured to do so in a system filter,
13861 ACL, or special router, Exim freezes a message. This means that no further
13862 delivery attempts take place until an administrator thaws the message, or the
13863 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
13864 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
13865 warning message whenever it freezes something, unless the message it is
13866 freezing is a locally-generated bounce message. (Without this exception there
13867 is the possibility of looping.) The warning message is sent to the addresses
13868 supplied as the comma-separated value of this option. If several of the
13869 message's addresses cause freezing, only a single message is sent. If the
13870 freezing was automatic, the reason(s) for freezing can be found in the message
13871 log. If you configure freezing in a filter or ACL, you must arrange for any
13872 logging that you require.
13873
13874
13875 .option gecos_name main string&!! unset
13876 .cindex "HP-UX"
13877 .cindex "&""gecos""& field, parsing"
13878 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
13879 password file to hold other information in addition to users' real names. Exim
13880 looks up this field for use when it is creating &'Sender:'& or &'From:'&
13881 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
13882 of the field are used unchanged, except that, if an ampersand is encountered,
13883 it is replaced by the user's login name with the first character forced to
13884 upper case, since this is a convention that is observed on many systems.
13885
13886 When these options are set, &%gecos_pattern%& is treated as a regular
13887 expression that is to be applied to the field (again with && replaced by the
13888 login name), and if it matches, &%gecos_name%& is expanded and used as the
13889 user's name.
13890
13891 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
13892 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
13893 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
13894 name terminates at the first comma, the following can be used:
13895 .code
13896 gecos_pattern = ([^,]*)
13897 gecos_name = $1
13898 .endd
13899
13900 .option gecos_pattern main string unset
13901 See &%gecos_name%& above.
13902
13903
13904 .option gnutls_compat_mode main boolean unset
13905 This option controls whether GnuTLS is used in compatibility mode in an Exim
13906 server. This reduces security slightly, but improves interworking with older
13907 implementations of TLS.
13908
13909
13910 .new
13911 option gnutls_enable_pkcs11 main boolean unset
13912 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
13913 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
13914
13915 See
13916 &url(http://www.gnu.org/software/gnutls/manual/gnutls.html#Smart-cards-and-HSMs)
13917 for documentation.
13918 .wen
13919
13920
13921
13922 .option headers_charset main string "see below"
13923 This option sets a default character set for translating from encoded MIME
13924 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
13925 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
13926 ultimate default is ISO-8859-1. For more details see the description of header
13927 insertions in section &<<SECTexpansionitems>>&.
13928
13929
13930
13931 .option header_maxsize main integer "see below"
13932 .cindex "header section" "maximum size of"
13933 .cindex "limit" "size of message header section"
13934 This option controls the overall maximum size of a message's header
13935 section. The default is the value of HEADER_MAXSIZE in
13936 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
13937 sections are rejected.
13938
13939
13940 .option header_line_maxsize main integer 0
13941 .cindex "header lines" "maximum size of"
13942 .cindex "limit" "size of one header line"
13943 This option limits the length of any individual header line in a message, after
13944 all the continuations have been joined together. Messages with individual
13945 header lines that are longer than the limit are rejected. The default value of
13946 zero means &"no limit"&.
13947
13948
13949
13950
13951 .option helo_accept_junk_hosts main "host list&!!" unset
13952 .cindex "HELO" "accepting junk data"
13953 .cindex "EHLO" "accepting junk data"
13954 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
13955 mail, and gives an error response for invalid data. Unfortunately, there are
13956 some SMTP clients that send syntactic junk. They can be accommodated by setting
13957 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
13958 if you want to do semantic checking.
13959 See also &%helo_allow_chars%& for a way of extending the permitted character
13960 set.
13961
13962
13963 .option helo_allow_chars main string unset
13964 .cindex "HELO" "underscores in"
13965 .cindex "EHLO" "underscores in"
13966 .cindex "underscore in EHLO/HELO"
13967 This option can be set to a string of rogue characters that are permitted in
13968 all EHLO and HELO names in addition to the standard letters, digits,
13969 hyphens, and dots. If you really must allow underscores, you can set
13970 .code
13971 helo_allow_chars = _
13972 .endd
13973 Note that the value is one string, not a list.
13974
13975
13976 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
13977 .cindex "HELO" "forcing reverse lookup"
13978 .cindex "EHLO" "forcing reverse lookup"
13979 If the domain given by a client in a HELO or EHLO command matches this
13980 list, a reverse lookup is done in order to establish the host's true name. The
13981 default forces a lookup if the client host gives the server's name or any of
13982 its IP addresses (in brackets), something that broken clients have been seen to
13983 do.
13984
13985
13986 .option helo_try_verify_hosts main "host list&!!" unset
13987 .cindex "HELO verifying" "optional"
13988 .cindex "EHLO" "verifying, optional"
13989 By default, Exim just checks the syntax of HELO and EHLO commands (see
13990 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
13991 to do more extensive checking of the data supplied by these commands. The ACL
13992 condition &`verify = helo`& is provided to make this possible.
13993 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
13994 to force the check to occur. From release 4.53 onwards, this is no longer
13995 necessary. If the check has not been done before &`verify = helo`& is
13996 encountered, it is done at that time. Consequently, this option is obsolete.
13997 Its specification is retained here for backwards compatibility.
13998
13999 When an EHLO or HELO command is received, if the calling host matches
14000 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14001 EHLO command either:
14002
14003 .ilist
14004 is an IP literal matching the calling address of the host, or
14005 .next
14006 .cindex "DNS" "reverse lookup"
14007 .cindex "reverse DNS lookup"
14008 matches the host name that Exim obtains by doing a reverse lookup of the
14009 calling host address, or
14010 .next
14011 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
14012 available) yields the calling host address.
14013 .endlist
14014
14015 However, the EHLO or HELO command is not rejected if any of the checks
14016 fail. Processing continues, but the result of the check is remembered, and can
14017 be detected later in an ACL by the &`verify = helo`& condition.
14018
14019 .option helo_verify_hosts main "host list&!!" unset
14020 .cindex "HELO verifying" "mandatory"
14021 .cindex "EHLO" "verifying, mandatory"
14022 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14023 backwards compatibility. For hosts that match this option, Exim checks the host
14024 name given in the HELO or EHLO in the same way as for
14025 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14026 rejected with a 550 error, and entries are written to the main and reject logs.
14027 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14028 error.
14029
14030 .option hold_domains main "domain list&!!" unset
14031 .cindex "domain" "delaying delivery"
14032 .cindex "delivery" "delaying certain domains"
14033 This option allows mail for particular domains to be held on the queue
14034 manually. The option is overridden if a message delivery is forced with the
14035 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14036 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14037 item in &%hold_domains%&, no routing or delivery for that address is done, and
14038 it is deferred every time the message is looked at.
14039
14040 This option is intended as a temporary operational measure for delaying the
14041 delivery of mail while some problem is being sorted out, or some new
14042 configuration tested. If you just want to delay the processing of some
14043 domains until a queue run occurs, you should use &%queue_domains%& or
14044 &%queue_smtp_domains%&, not &%hold_domains%&.
14045
14046 A setting of &%hold_domains%& does not override Exim's code for removing
14047 messages from the queue if they have been there longer than the longest retry
14048 time in any retry rule. If you want to hold messages for longer than the normal
14049 retry times, insert a dummy retry rule with a long retry time.
14050
14051
14052 .option host_lookup main "host list&!!" unset
14053 .cindex "host name" "lookup, forcing"
14054 Exim does not look up the name of a calling host from its IP address unless it
14055 is required to compare against some host list, or the host matches
14056 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14057 option (which normally contains IP addresses rather than host names). The
14058 default configuration file contains
14059 .code
14060 host_lookup = *
14061 .endd
14062 which causes a lookup to happen for all hosts. If the expense of these lookups
14063 is felt to be too great, the setting can be changed or removed.
14064
14065 After a successful reverse lookup, Exim does a forward lookup on the name it
14066 has obtained, to verify that it yields the IP address that it started with. If
14067 this check fails, Exim behaves as if the name lookup failed.
14068
14069 .vindex "&$host_lookup_failed$&"
14070 .vindex "&$sender_host_name$&"
14071 After any kind of failure, the host name (in &$sender_host_name$&) remains
14072 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14073 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14074 &`verify = reverse_host_lookup`& in ACLs.
14075
14076
14077 .option host_lookup_order main "string list" &`bydns:byaddr`&
14078 This option specifies the order of different lookup methods when Exim is trying
14079 to find a host name from an IP address. The default is to do a DNS lookup
14080 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14081 if that fails. You can change the order of these lookups, or omit one entirely,
14082 if you want.
14083
14084 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14085 multiple PTR records in the DNS and the IP address is not listed in
14086 &_/etc/hosts_&. Different operating systems give different results in this
14087 case. That is why the default tries a DNS lookup first.
14088
14089
14090
14091 .option host_reject_connection main "host list&!!" unset
14092 .cindex "host" "rejecting connections from"
14093 If this option is set, incoming SMTP calls from the hosts listed are rejected
14094 as soon as the connection is made.
14095 This option is obsolete, and retained only for backward compatibility, because
14096 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14097 connections immediately.
14098
14099 The ability to give an immediate rejection (either by this option or using an
14100 ACL) is provided for use in unusual cases. Many hosts will just try again,
14101 sometimes without much delay. Normally, it is better to use an ACL to reject
14102 incoming messages at a later stage, such as after RCPT commands. See
14103 chapter &<<CHAPACL>>&.
14104
14105
14106 .option hosts_connection_nolog main "host list&!!" unset
14107 .cindex "host" "not logging connections from"
14108 This option defines a list of hosts for which connection logging does not
14109 happen, even though the &%smtp_connection%& log selector is set. For example,
14110 you might want not to log SMTP connections from local processes, or from
14111 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14112 the daemon; you should therefore strive to restrict its value to a short inline
14113 list of IP addresses and networks. To disable logging SMTP connections from
14114 local processes, you must create a host list with an empty item. For example:
14115 .code
14116 hosts_connection_nolog = :
14117 .endd
14118 If the &%smtp_connection%& log selector is not set, this option has no effect.
14119
14120
14121
14122 .option hosts_treat_as_local main "domain list&!!" unset
14123 .cindex "local host" "domains treated as"
14124 .cindex "host" "treated as local"
14125 If this option is set, any host names that match the domain list are treated as
14126 if they were the local host when Exim is scanning host lists obtained from MX
14127 records
14128 or other sources. Note that the value of this option is a domain list, not a
14129 host list, because it is always used to check host names, not IP addresses.
14130
14131 This option also applies when Exim is matching the special items
14132 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14133 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14134 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14135 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14136 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14137 interfaces and recognizing the local host.
14138
14139
14140 .option ibase_servers main "string list" unset
14141 .cindex "InterBase" "server list"
14142 This option provides a list of InterBase servers and associated connection data,
14143 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14144 The option is available only if Exim has been built with InterBase support.
14145
14146
14147
14148 .option ignore_bounce_errors_after main time 10w
14149 .cindex "bounce message" "discarding"
14150 .cindex "discarding bounce message"
14151 This option affects the processing of bounce messages that cannot be delivered,
14152 that is, those that suffer a permanent delivery failure. (Bounce messages that
14153 suffer temporary delivery failures are of course retried in the usual way.)
14154
14155 After a permanent delivery failure, bounce messages are frozen,
14156 because there is no sender to whom they can be returned. When a frozen bounce
14157 message has been on the queue for more than the given time, it is unfrozen at
14158 the next queue run, and a further delivery is attempted. If delivery fails
14159 again, the bounce message is discarded. This makes it possible to keep failed
14160 bounce messages around for a shorter time than the normal maximum retry time
14161 for frozen messages. For example,
14162 .code
14163 ignore_bounce_errors_after = 12h
14164 .endd
14165 retries failed bounce message deliveries after 12 hours, discarding any further
14166 failures. If the value of this option is set to a zero time period, bounce
14167 failures are discarded immediately. Setting a very long time (as in the default
14168 value) has the effect of disabling this option. For ways of automatically
14169 dealing with other kinds of frozen message, see &%auto_thaw%& and
14170 &%timeout_frozen_after%&.
14171
14172
14173 .option ignore_fromline_hosts main "host list&!!" unset
14174 .cindex "&""From""& line"
14175 .cindex "UUCP" "&""From""& line"
14176 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14177 the headers of a message. By default this is treated as the start of the
14178 message's body, which means that any following headers are not recognized as
14179 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14180 match those hosts that insist on sending it. If the sender is actually a local
14181 process rather than a remote host, and is using &%-bs%& to inject the messages,
14182 &%ignore_fromline_local%& must be set to achieve this effect.
14183
14184
14185 .option ignore_fromline_local main boolean false
14186 See &%ignore_fromline_hosts%& above.
14187
14188
14189 .option keep_malformed main time 4d
14190 This option specifies the length of time to keep messages whose spool files
14191 have been corrupted in some way. This should, of course, never happen. At the
14192 next attempt to deliver such a message, it gets removed. The incident is
14193 logged.
14194
14195
14196 .option ldap_ca_cert_dir main string unset
14197 .cindex "LDAP", "TLS CA certificate directory"
14198 This option indicates which directory contains CA certificates for verifying
14199 a TLS certificate presented by an LDAP server.
14200 While Exim does not provide a default value, your SSL library may.
14201 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14202 and constrained to be a directory.
14203
14204
14205 .option ldap_ca_cert_file main string unset
14206 .cindex "LDAP", "TLS CA certificate file"
14207 This option indicates which file contains CA certificates for verifying
14208 a TLS certificate presented by an LDAP server.
14209 While Exim does not provide a default value, your SSL library may.
14210 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14211 and constrained to be a file.
14212
14213
14214 .option ldap_cert_file main string unset
14215 .cindex "LDAP" "TLS client certificate file"
14216 This option indicates which file contains an TLS client certificate which
14217 Exim should present to the LDAP server during TLS negotiation.
14218 Should be used together with &%ldap_cert_key%&.
14219
14220
14221 .option ldap_cert_key main string unset
14222 .cindex "LDAP" "TLS client key file"
14223 This option indicates which file contains the secret/private key to use
14224 to prove identity to the LDAP server during TLS negotiation.
14225 Should be used together with &%ldap_cert_file%&, which contains the
14226 identity to be proven.
14227
14228
14229 .option ldap_cipher_suite main string unset
14230 .cindex "LDAP" "TLS cipher suite"
14231 This controls the TLS cipher-suite negotiation during TLS negotiation with
14232 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14233 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14234
14235
14236 .option ldap_default_servers main "string list" unset
14237 .cindex "LDAP" "default servers"
14238 This option provides a list of LDAP servers which are tried in turn when an
14239 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14240 details of LDAP queries. This option is available only when Exim has been built
14241 with LDAP support.
14242
14243
14244 .option ldap_require_cert main string unset.
14245 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14246 This should be one of the values "hard", "demand", "allow", "try" or "never".
14247 A value other than one of these is interpreted as "never".
14248 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14249 Although Exim does not set a default, the LDAP library probably defaults
14250 to hard/demand.
14251
14252
14253 .option ldap_start_tls main boolean false
14254 .cindex "LDAP" "whether or not to negotiate TLS"
14255 If set, Exim will attempt to negotiate TLS with the LDAP server when
14256 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14257 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14258 of SSL-on-connect.
14259 In the event of failure to negotiate TLS, the action taken is controlled
14260 by &%ldap_require_cert%&.
14261
14262
14263 .option ldap_version main integer unset
14264 .cindex "LDAP" "protocol version, forcing"
14265 This option can be used to force Exim to set a specific protocol version for
14266 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14267 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14268 the LDAP headers; otherwise it is 2. This option is available only when Exim
14269 has been built with LDAP support.
14270
14271
14272
14273 .option local_from_check main boolean true
14274 .cindex "&'Sender:'& header line" "disabling addition of"
14275 .cindex "&'From:'& header line" "disabling checking of"
14276 When a message is submitted locally (that is, not over a TCP/IP connection) by
14277 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14278 checks that the &'From:'& header line matches the login of the calling user and
14279 the domain specified by &%qualify_domain%&.
14280
14281 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14282 locally submitted message is automatically qualified by Exim, unless the
14283 &%-bnq%& command line option is used.
14284
14285 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14286 on the local part. If the &'From:'& header line does not match, Exim adds a
14287 &'Sender:'& header with an address constructed from the calling user's login
14288 and the default qualify domain.
14289
14290 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14291 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14292 &'Sender:'& header lines supplied by untrusted users, you must also set
14293 &%local_sender_retain%& to be true.
14294
14295 .cindex "envelope sender"
14296 These options affect only the header lines in the message. The envelope sender
14297 is still forced to be the login id at the qualify domain unless
14298 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14299
14300 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14301 request similar header line checking. See section &<<SECTthesenhea>>&, which
14302 has more details about &'Sender:'& processing.
14303
14304
14305
14306
14307 .option local_from_prefix main string unset
14308 When Exim checks the &'From:'& header line of locally submitted messages for
14309 matching the login id (see &%local_from_check%& above), it can be configured to
14310 ignore certain prefixes and suffixes in the local part of the address. This is
14311 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14312 appropriate lists, in the same form as the &%local_part_prefix%& and
14313 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14314 example, if
14315 .code
14316 local_from_prefix = *-
14317 .endd
14318 is set, a &'From:'& line containing
14319 .code
14320 From: anything-user@your.domain.example
14321 .endd
14322 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14323 matches the actual sender address that is constructed from the login name and
14324 qualify domain.
14325
14326
14327 .option local_from_suffix main string unset
14328 See &%local_from_prefix%& above.
14329
14330
14331 .option local_interfaces main "string list" "see below"
14332 This option controls which network interfaces are used by the daemon for
14333 listening; they are also used to identify the local host when routing. Chapter
14334 &<<CHAPinterfaces>>& contains a full description of this option and the related
14335 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14336 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14337 &%local_interfaces%& is
14338 .code
14339 local_interfaces = 0.0.0.0
14340 .endd
14341 when Exim is built without IPv6 support; otherwise it is
14342 .code
14343 local_interfaces = <; ::0 ; 0.0.0.0
14344 .endd
14345
14346 .option local_scan_timeout main time 5m
14347 .cindex "timeout" "for &[local_scan()]& function"
14348 .cindex "&[local_scan()]& function" "timeout"
14349 This timeout applies to the &[local_scan()]& function (see chapter
14350 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14351 the incoming message is rejected with a temporary error if it is an SMTP
14352 message. For a non-SMTP message, the message is dropped and Exim ends with a
14353 non-zero code. The incident is logged on the main and reject logs.
14354
14355
14356
14357 .option local_sender_retain main boolean false
14358 .cindex "&'Sender:'& header line" "retaining from local submission"
14359 When a message is submitted locally (that is, not over a TCP/IP connection) by
14360 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14361 do not want this to happen, you must set &%local_sender_retain%&, and you must
14362 also set &%local_from_check%& to be false (Exim will complain if you do not).
14363 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14364 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14365
14366
14367
14368
14369 .option localhost_number main string&!! unset
14370 .cindex "host" "locally unique number for"
14371 .cindex "message ids" "with multiple hosts"
14372 .vindex "&$localhost_number$&"
14373 Exim's message ids are normally unique only within the local host. If
14374 uniqueness among a set of hosts is required, each host must set a different
14375 value for the &%localhost_number%& option. The string is expanded immediately
14376 after reading the configuration file (so that a number can be computed from the
14377 host name, for example) and the result of the expansion must be a number in the
14378 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14379 systems). This is available in subsequent string expansions via the variable
14380 &$localhost_number$&. When &%localhost_number is set%&, the final two
14381 characters of the message id, instead of just being a fractional part of the
14382 time, are computed from the time and the local host number as described in
14383 section &<<SECTmessiden>>&.
14384
14385
14386
14387 .option log_file_path main "string list&!!" "set at compile time"
14388 .cindex "log" "file path for"
14389 This option sets the path which is used to determine the names of Exim's log
14390 files, or indicates that logging is to be to syslog, or both. It is expanded
14391 when Exim is entered, so it can, for example, contain a reference to the host
14392 name. If no specific path is set for the log files at compile or run time, they
14393 are written in a sub-directory called &_log_& in Exim's spool directory.
14394 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14395 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14396 used. If this string is fixed at your installation (contains no expansion
14397 variables) it is recommended that you do not set this option in the
14398 configuration file, but instead supply the path using LOG_FILE_PATH in
14399 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14400 early on &-- in particular, failure to read the configuration file.
14401
14402
14403 .option log_selector main string unset
14404 .cindex "log" "selectors"
14405 This option can be used to reduce or increase the number of things that Exim
14406 writes to its log files. Its argument is made up of names preceded by plus or
14407 minus characters. For example:
14408 .code
14409 log_selector = +arguments -retry_defer
14410 .endd
14411 A list of possible names and what they control is given in the chapter on
14412 logging, in section &<<SECTlogselector>>&.
14413
14414
14415 .option log_timezone main boolean false
14416 .cindex "log" "timezone for entries"
14417 .vindex "&$tod_log$&"
14418 .vindex "&$tod_zone$&"
14419 By default, the timestamps on log lines are in local time without the
14420 timezone. This means that if your timezone changes twice a year, the timestamps
14421 in log lines are ambiguous for an hour when the clocks go back. One way of
14422 avoiding this problem is to set the timezone to UTC. An alternative is to set
14423 &%log_timezone%& true. This turns on the addition of the timezone offset to
14424 timestamps in log lines. Turning on this option can add quite a lot to the size
14425 of log files because each line is extended by 6 characters. Note that the
14426 &$tod_log$& variable contains the log timestamp without the zone, but there is
14427 another variable called &$tod_zone$& that contains just the timezone offset.
14428
14429
14430 .option lookup_open_max main integer 25
14431 .cindex "too many open files"
14432 .cindex "open files, too many"
14433 .cindex "file" "too many open"
14434 .cindex "lookup" "maximum open files"
14435 .cindex "limit" "open files for lookups"
14436 This option limits the number of simultaneously open files for single-key
14437 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14438 Exim normally keeps these files open during routing, because often the same
14439 file is required several times. If the limit is reached, Exim closes the least
14440 recently used file. Note that if you are using the &'ndbm'& library, it
14441 actually opens two files for each logical DBM database, though it still counts
14442 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14443 open files"& errors with NDBM, you need to reduce the value of
14444 &%lookup_open_max%&.
14445
14446
14447 .option max_username_length main integer 0
14448 .cindex "length of login name"
14449 .cindex "user name" "maximum length"
14450 .cindex "limit" "user name length"
14451 Some operating systems are broken in that they truncate long arguments to
14452 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14453 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14454 an argument that is longer behaves as if &[getpwnam()]& failed.
14455
14456
14457 .option message_body_newlines main bool false
14458 .cindex "message body" "newlines in variables"
14459 .cindex "newline" "in message body variables"
14460 .vindex "&$message_body$&"
14461 .vindex "&$message_body_end$&"
14462 By default, newlines in the message body are replaced by spaces when setting
14463 the &$message_body$& and &$message_body_end$& expansion variables. If this
14464 option is set true, this no longer happens.
14465
14466
14467 .option message_body_visible main integer 500
14468 .cindex "body of message" "visible size"
14469 .cindex "message body" "visible size"
14470 .vindex "&$message_body$&"
14471 .vindex "&$message_body_end$&"
14472 This option specifies how much of a message's body is to be included in the
14473 &$message_body$& and &$message_body_end$& expansion variables.
14474
14475
14476 .option message_id_header_domain main string&!! unset
14477 .cindex "&'Message-ID:'& header line"
14478 If this option is set, the string is expanded and used as the right hand side
14479 (domain) of the &'Message-ID:'& header that Exim creates if a
14480 locally-originated incoming message does not have one. &"Locally-originated"&
14481 means &"not received over TCP/IP."&
14482 Otherwise, the primary host name is used.
14483 Only letters, digits, dot and hyphen are accepted; any other characters are
14484 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14485 empty string, the option is ignored.
14486
14487
14488 .option message_id_header_text main string&!! unset
14489 If this variable is set, the string is expanded and used to augment the text of
14490 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14491 message does not have one. The text of this header is required by RFC 2822 to
14492 take the form of an address. By default, Exim uses its internal message id as
14493 the local part, and the primary host name as the domain. If this option is set,
14494 it is expanded, and provided the expansion is not forced to fail, and does not
14495 yield an empty string, the result is inserted into the header immediately
14496 before the @, separated from the internal message id by a dot. Any characters
14497 that are illegal in an address are automatically converted into hyphens. This
14498 means that variables such as &$tod_log$& can be used, because the spaces and
14499 colons will become hyphens.
14500
14501
14502 .option message_logs main boolean true
14503 .cindex "message logs" "disabling"
14504 .cindex "log" "message log; disabling"
14505 If this option is turned off, per-message log files are not created in the
14506 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14507 Exim, by reducing the number of files involved in handling a message from a
14508 minimum of four (header spool file, body spool file, delivery journal, and
14509 per-message log) to three. The other major I/O activity is Exim's main log,
14510 which is not affected by this option.
14511
14512
14513 .option message_size_limit main string&!! 50M
14514 .cindex "message" "size limit"
14515 .cindex "limit" "message size"
14516 .cindex "size" "of message, limit"
14517 This option limits the maximum size of message that Exim will process. The
14518 value is expanded for each incoming connection so, for example, it can be made
14519 to depend on the IP address of the remote host for messages arriving via
14520 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14521 optionally followed by K or M.
14522
14523 &*Note*&: This limit cannot be made to depend on a message's sender or any
14524 other properties of an individual message, because it has to be advertised in
14525 the server's response to EHLO. String expansion failure causes a temporary
14526 error. A value of zero means no limit, but its use is not recommended. See also
14527 &%bounce_return_size_limit%&.
14528
14529 Incoming SMTP messages are failed with a 552 error if the limit is
14530 exceeded; locally-generated messages either get a stderr message or a delivery
14531 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14532 an oversized message is logged in both the main and the reject logs. See also
14533 the generic transport option &%message_size_limit%&, which limits the size of
14534 message that an individual transport can process.
14535
14536 If you use a virus-scanner and set this option to to a value larger than the
14537 maximum size that your virus-scanner is configured to support, you may get
14538 failures triggered by large mails.  The right size to configure for the
14539 virus-scanner depends upon what data is passed and the options in use but it's
14540 probably safest to just set it to a little larger than this value.  Eg, with a
14541 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14542 some problems may result.
14543
14544 A value of 0 will disable size limit checking; Exim will still advertise the
14545 SIZE extension in an EHLO response, but without a limit, so as to permit
14546 SMTP clients to still indicate the message size along with the MAIL verb.
14547
14548
14549 .option move_frozen_messages main boolean false
14550 .cindex "frozen messages" "moving"
14551 This option, which is available only if Exim has been built with the setting
14552 .code
14553 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14554 .endd
14555 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14556 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14557 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14558 standard utilities for handling such moved messages, and they do not show up in
14559 lists generated by &%-bp%& or by the Exim monitor.
14560
14561
14562 .option mua_wrapper main boolean false
14563 Setting this option true causes Exim to run in a very restrictive mode in which
14564 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14565 contains a full description of this facility.
14566
14567
14568
14569 .option mysql_servers main "string list" unset
14570 .cindex "MySQL" "server list"
14571 This option provides a list of MySQL servers and associated connection data, to
14572 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14573 option is available only if Exim has been built with MySQL support.
14574
14575
14576 .option never_users main "string list&!!" unset
14577 This option is expanded just once, at the start of Exim's processing. Local
14578 message deliveries are normally run in processes that are setuid to the
14579 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14580 It is usually desirable to prevent any deliveries from running as root, as a
14581 safety precaution.
14582
14583 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14584 list of users that must not be used for local deliveries. This list is fixed in
14585 the binary and cannot be overridden by the configuration file. By default, it
14586 contains just the single user name &"root"&. The &%never_users%& runtime option
14587 can be used to add more users to the fixed list.
14588
14589 If a message is to be delivered as one of the users on the fixed list or the
14590 &%never_users%& list, an error occurs, and delivery is deferred. A common
14591 example is
14592 .code
14593 never_users = root:daemon:bin
14594 .endd
14595 Including root is redundant if it is also on the fixed list, but it does no
14596 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14597 transport driver.
14598
14599
14600 .option openssl_options main "string list" "+no_sslv2"
14601 .cindex "OpenSSL "compatibility options"
14602 This option allows an administrator to adjust the SSL options applied
14603 by OpenSSL to connections.  It is given as a space-separated list of items,
14604 each one to be +added or -subtracted from the current value.
14605
14606 This option is only available if Exim is built against OpenSSL.  The values
14607 available for this option vary according to the age of your OpenSSL install.
14608 The &"all"& value controls a subset of flags which are available, typically
14609 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14610 list the values known on your system and Exim should support all the
14611 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14612 names lose the leading &"SSL_OP_"& and are lower-cased.
14613
14614 Note that adjusting the options can have severe impact upon the security of
14615 SSL as used by Exim.  It is possible to disable safety checks and shoot
14616 yourself in the foot in various unpleasant ways.  This option should not be
14617 adjusted lightly.  An unrecognised item will be detected at startup, by
14618 invoking Exim with the &%-bV%& flag.
14619
14620 Historical note: prior to release 4.80, Exim defaulted this value to
14621 "+dont_insert_empty_fragments", which may still be needed for compatibility
14622 with some clients, but which lowers security by increasing exposure to
14623 some now infamous attacks.
14624
14625 An example:
14626 .code
14627 # Make both old MS and old Eudora happy:
14628 openssl_options = -all +microsoft_big_sslv3_buffer \
14629                        +dont_insert_empty_fragments
14630 .endd
14631
14632 Possible options may include:
14633 .ilist
14634 &`all`&
14635 .next
14636 &`allow_unsafe_legacy_renegotiation`&
14637 .next
14638 &`cipher_server_preference`&
14639 .next
14640 &`dont_insert_empty_fragments`&
14641 .next
14642 &`ephemeral_rsa`&
14643 .next
14644 &`legacy_server_connect`&
14645 .next
14646 &`microsoft_big_sslv3_buffer`&
14647 .next
14648 &`microsoft_sess_id_bug`&
14649 .next
14650 &`msie_sslv2_rsa_padding`&
14651 .next
14652 &`netscape_challenge_bug`&
14653 .next
14654 &`netscape_reuse_cipher_change_bug`&
14655 .next
14656 &`no_compression`&
14657 .next
14658 &`no_session_resumption_on_renegotiation`&
14659 .next
14660 &`no_sslv2`&
14661 .next
14662 &`no_sslv3`&
14663 .next
14664 &`no_ticket`&
14665 .next
14666 &`no_tlsv1`&
14667 .next
14668 &`no_tlsv1_1`&
14669 .next
14670 &`no_tlsv1_2`&
14671 .next
14672 &`single_dh_use`&
14673 .next
14674 &`single_ecdh_use`&
14675 .next
14676 &`ssleay_080_client_dh_bug`&
14677 .next
14678 &`sslref2_reuse_cert_type_bug`&
14679 .next
14680 &`tls_block_padding_bug`&
14681 .next
14682 &`tls_d5_bug`&
14683 .next
14684 &`tls_rollback_bug`&
14685 .endlist
14686
14687
14688 .option oracle_servers main "string list" unset
14689 .cindex "Oracle" "server list"
14690 This option provides a list of Oracle servers and associated connection data,
14691 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14692 The option is available only if Exim has been built with Oracle support.
14693
14694
14695 .option percent_hack_domains main "domain list&!!" unset
14696 .cindex "&""percent hack""&"
14697 .cindex "source routing" "in email address"
14698 .cindex "address" "source-routed"
14699 The &"percent hack"& is the convention whereby a local part containing a
14700 percent sign is re-interpreted as a new email address, with the percent
14701 replaced by @. This is sometimes called &"source routing"&, though that term is
14702 also applied to RFC 2822 addresses that begin with an @ character. If this
14703 option is set, Exim implements the percent facility for those domains listed,
14704 but no others. This happens before an incoming SMTP address is tested against
14705 an ACL.
14706
14707 &*Warning*&: The &"percent hack"& has often been abused by people who are
14708 trying to get round relaying restrictions. For this reason, it is best avoided
14709 if at all possible. Unfortunately, a number of less security-conscious MTAs
14710 implement it unconditionally. If you are running Exim on a gateway host, and
14711 routing mail through to internal MTAs without processing the local parts, it is
14712 a good idea to reject recipient addresses with percent characters in their
14713 local parts. Exim's default configuration does this.
14714
14715
14716 .option perl_at_start main boolean false
14717 This option is available only when Exim is built with an embedded Perl
14718 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14719
14720
14721 .option perl_startup main string unset
14722 This option is available only when Exim is built with an embedded Perl
14723 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14724
14725
14726 .option pgsql_servers main "string list" unset
14727 .cindex "PostgreSQL lookup type" "server list"
14728 This option provides a list of PostgreSQL servers and associated connection
14729 data, to be used in conjunction with &(pgsql)& lookups (see section
14730 &<<SECID72>>&). The option is available only if Exim has been built with
14731 PostgreSQL support.
14732
14733
14734 .option pid_file_path main string&!! "set at compile time"
14735 .cindex "daemon" "pid file path"
14736 .cindex "pid file, path for"
14737 This option sets the name of the file to which the Exim daemon writes its
14738 process id. The string is expanded, so it can contain, for example, references
14739 to the host name:
14740 .code
14741 pid_file_path = /var/log/$primary_hostname/exim.pid
14742 .endd
14743 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14744 spool directory.
14745 The value set by the option can be overridden by the &%-oP%& command line
14746 option. A pid file is not written if a &"non-standard"& daemon is run by means
14747 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14748
14749
14750 .option pipelining_advertise_hosts main "host list&!!" *
14751 .cindex "PIPELINING" "suppressing advertising"
14752 This option can be used to suppress the advertisement of the SMTP
14753 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14754 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14755 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14756 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14757 that clients will use it; &"out of order"& commands that are &"expected"& do
14758 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14759
14760
14761 .option preserve_message_logs main boolean false
14762 .cindex "message logs" "preserving"
14763 If this option is set, message log files are not deleted when messages are
14764 completed. Instead, they are moved to a sub-directory of the spool directory
14765 called &_msglog.OLD_&, where they remain available for statistical or debugging
14766 purposes. This is a dangerous option to set on systems with any appreciable
14767 volume of mail. Use with care!
14768
14769
14770 .option primary_hostname main string "see below"
14771 .cindex "name" "of local host"
14772 .cindex "host" "name of local"
14773 .cindex "local host" "name of"
14774 .vindex "&$primary_hostname$&"
14775 This specifies the name of the current host. It is used in the default EHLO or
14776 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14777 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14778 The value is also used by default in some SMTP response messages from an Exim
14779 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14780
14781 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14782 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14783 contains only one component, Exim passes it to &[gethostbyname()]& (or
14784 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14785 version. The variable &$primary_hostname$& contains the host name, whether set
14786 explicitly by this option, or defaulted.
14787
14788
14789 .option print_topbitchars main boolean false
14790 .cindex "printing characters"
14791 .cindex "8-bit characters"
14792 By default, Exim considers only those characters whose codes lie in the range
14793 32&--126 to be printing characters. In a number of circumstances (for example,
14794 when writing log entries) non-printing characters are converted into escape
14795 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14796 is set, code values of 128 and above are also considered to be printing
14797 characters.
14798
14799 This option also affects the header syntax checks performed by the
14800 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14801 the user's full name when constructing From: and Sender: addresses (as
14802 described in section &<<SECTconstr>>&). Setting this option can cause
14803 Exim to generate eight bit message headers that do not conform to the
14804 standards.
14805
14806
14807 .option process_log_path main string unset
14808 .cindex "process log path"
14809 .cindex "log" "process log"
14810 .cindex "&'exiwhat'&"
14811 This option sets the name of the file to which an Exim process writes its
14812 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14813 utility script. If this option is unset, the file called &_exim-process.info_&
14814 in Exim's spool directory is used. The ability to specify the name explicitly
14815 can be useful in environments where two different Exims are running, using
14816 different spool directories.
14817
14818
14819 .option prod_requires_admin main boolean true
14820 .oindex "&%-M%&"
14821 .oindex "&%-R%&"
14822 .oindex "&%-q%&"
14823 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14824 admin user unless &%prod_requires_admin%& is set false. See also
14825 &%queue_list_requires_admin%&.
14826
14827
14828 .option qualify_domain main string "see below"
14829 .cindex "domain" "for qualifying addresses"
14830 .cindex "address" "qualification"
14831 This option specifies the domain name that is added to any envelope sender
14832 addresses that do not have a domain qualification. It also applies to
14833 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
14834 are accepted by default only for locally-generated messages. Qualification is
14835 also applied to addresses in header lines such as &'From:'& and &'To:'& for
14836 locally-generated messages, unless the &%-bnq%& command line option is used.
14837
14838 Messages from external sources must always contain fully qualified addresses,
14839 unless the sending host matches &%sender_unqualified_hosts%& or
14840 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
14841 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
14842 necessary. Internally, Exim always works with fully qualified envelope
14843 addresses. If &%qualify_domain%& is not set, it defaults to the
14844 &%primary_hostname%& value.
14845
14846
14847 .option qualify_recipient main string "see below"
14848 This option allows you to specify a different domain for qualifying recipient
14849 addresses to the one that is used for senders. See &%qualify_domain%& above.
14850
14851
14852
14853 .option queue_domains main "domain list&!!" unset
14854 .cindex "domain" "specifying non-immediate delivery"
14855 .cindex "queueing incoming messages"
14856 .cindex "message" "queueing certain domains"
14857 This option lists domains for which immediate delivery is not required.
14858 A delivery process is started whenever a message is received, but only those
14859 domains that do not match are processed. All other deliveries wait until the
14860 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
14861
14862
14863 .option queue_list_requires_admin main boolean true
14864 .oindex "&%-bp%&"
14865 The &%-bp%& command-line option, which lists the messages that are on the
14866 queue, requires the caller to be an admin user unless
14867 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
14868
14869
14870 .option queue_only main boolean false
14871 .cindex "queueing incoming messages"
14872 .cindex "message" "queueing unconditionally"
14873 If &%queue_only%& is set, a delivery process is not automatically started
14874 whenever a message is received. Instead, the message waits on the queue for the
14875 next queue run. Even if &%queue_only%& is false, incoming messages may not get
14876 delivered immediately when certain conditions (such as heavy load) occur.
14877
14878 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
14879 and &%-odi%& command line options override &%queue_only%& unless
14880 &%queue_only_override%& is set false. See also &%queue_only_file%&,
14881 &%queue_only_load%&, and &%smtp_accept_queue%&.
14882
14883
14884 .option queue_only_file main string unset
14885 .cindex "queueing incoming messages"
14886 .cindex "message" "queueing by file existence"
14887 This option can be set to a colon-separated list of absolute path names, each
14888 one optionally preceded by &"smtp"&. When Exim is receiving a message,
14889 it tests for the existence of each listed path using a call to &[stat()]&. For
14890 each path that exists, the corresponding queueing option is set.
14891 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
14892 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
14893 .code
14894 queue_only_file = smtp/some/file
14895 .endd
14896 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
14897 &_/some/file_& exists.
14898
14899
14900 .option queue_only_load main fixed-point unset
14901 .cindex "load average"
14902 .cindex "queueing incoming messages"
14903 .cindex "message" "queueing by load"
14904 If the system load average is higher than this value, incoming messages from
14905 all sources are queued, and no automatic deliveries are started. If this
14906 happens during local or remote SMTP input, all subsequent messages received on
14907 the same SMTP connection are queued by default, whatever happens to the load in
14908 the meantime, but this can be changed by setting &%queue_only_load_latch%&
14909 false.
14910
14911 Deliveries will subsequently be performed by queue runner processes. This
14912 option has no effect on ancient operating systems on which Exim cannot
14913 determine the load average. See also &%deliver_queue_load_max%& and
14914 &%smtp_load_reserve%&.
14915
14916
14917 .option queue_only_load_latch main boolean true
14918 .cindex "load average" "re-evaluating per message"
14919 When this option is true (the default), once one message has been queued
14920 because the load average is higher than the value set by &%queue_only_load%&,
14921 all subsequent messages received on the same SMTP connection are also queued.
14922 This is a deliberate choice; even though the load average may fall below the
14923 threshold, it doesn't seem right to deliver later messages on the same
14924 connection when not delivering earlier ones. However, there are special
14925 circumstances such as very long-lived connections from scanning appliances
14926 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
14927 should be set false. This causes the value of the load average to be
14928 re-evaluated for each message.
14929
14930
14931 .option queue_only_override main boolean true
14932 .cindex "queueing incoming messages"
14933 When this option is true, the &%-od%&&'x'& command line options override the
14934 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
14935 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
14936 to override; they are accepted, but ignored.
14937
14938
14939 .option queue_run_in_order main boolean false
14940 .cindex "queue runner" "processing messages in order"
14941 If this option is set, queue runs happen in order of message arrival instead of
14942 in an arbitrary order. For this to happen, a complete list of the entire queue
14943 must be set up before the deliveries start. When the queue is all held in a
14944 single directory (the default), a single list is created for both the ordered
14945 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
14946 single list is not created when &%queue_run_in_order%& is false. In this case,
14947 the sub-directories are processed one at a time (in a random order), and this
14948 avoids setting up one huge list for the whole queue. Thus, setting
14949 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
14950 when the queue is large, because of the extra work in setting up the single,
14951 large list. In most situations, &%queue_run_in_order%& should not be set.
14952
14953
14954
14955 .option queue_run_max main integer 5
14956 .cindex "queue runner" "maximum number of"
14957 This controls the maximum number of queue runner processes that an Exim daemon
14958 can run simultaneously. This does not mean that it starts them all at once,
14959 but rather that if the maximum number are still running when the time comes to
14960 start another one, it refrains from starting another one. This can happen with
14961 very large queues and/or very sluggish deliveries. This option does not,
14962 however, interlock with other processes, so additional queue runners can be
14963 started by other means, or by killing and restarting the daemon.
14964
14965 Setting this option to zero does not suppress queue runs; rather, it disables
14966 the limit, allowing any number of simultaneous queue runner processes to be
14967 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
14968 the daemon's command line.
14969
14970 .option queue_smtp_domains main "domain list&!!" unset
14971 .cindex "queueing incoming messages"
14972 .cindex "message" "queueing remote deliveries"
14973 When this option is set, a delivery process is started whenever a message is
14974 received, routing is performed, and local deliveries take place.
14975 However, if any SMTP deliveries are required for domains that match
14976 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
14977 message waits on the queue for the next queue run. Since routing of the message
14978 has taken place, Exim knows to which remote hosts it must be delivered, and so
14979 when the queue run happens, multiple messages for the same host are delivered
14980 over a single SMTP connection. The &%-odqs%& command line option causes all
14981 SMTP deliveries to be queued in this way, and is equivalent to setting
14982 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
14983 &%queue_domains%&.
14984
14985
14986 .option receive_timeout main time 0s
14987 .cindex "timeout" "for non-SMTP input"
14988 This option sets the timeout for accepting a non-SMTP message, that is, the
14989 maximum time that Exim waits when reading a message on the standard input. If
14990 the value is zero, it will wait for ever. This setting is overridden by the
14991 &%-or%& command line option. The timeout for incoming SMTP messages is
14992 controlled by &%smtp_receive_timeout%&.
14993
14994 .option received_header_text main string&!! "see below"
14995 .cindex "customizing" "&'Received:'& header"
14996 .cindex "&'Received:'& header line" "customizing"
14997 This string defines the contents of the &'Received:'& message header that is
14998 added to each message, except for the timestamp, which is automatically added
14999 on at the end (preceded by a semicolon). The string is expanded each time it is
15000 used. If the expansion yields an empty string, no &'Received:'& header line is
15001 added to the message. Otherwise, the string should start with the text
15002 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15003 header lines. The default setting is:
15004
15005 .code
15006 received_header_text = Received: \
15007   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15008   {${if def:sender_ident \
15009   {from ${quote_local_part:$sender_ident} }}\
15010   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15011   by $primary_hostname \
15012   ${if def:received_protocol {with $received_protocol}} \
15013   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15014   (Exim $version_number)\n\t\
15015   ${if def:sender_address \
15016   {(envelope-from <$sender_address>)\n\t}}\
15017   id $message_exim_id\
15018   ${if def:received_for {\n\tfor $received_for}}
15019 .endd
15020
15021 The reference to the TLS cipher is omitted when Exim is built without TLS
15022 support. The use of conditional expansions ensures that this works for both
15023 locally generated messages and messages received from remote hosts, giving
15024 header lines such as the following:
15025 .code
15026 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15027 by marley.carol.example with esmtp (Exim 4.00)
15028 (envelope-from <bob@carol.example>)
15029 id 16IOWa-00019l-00
15030 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15031 Received: by scrooge.carol.example with local (Exim 4.00)
15032 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15033 .endd
15034 Until the body of the message has been received, the timestamp is the time when
15035 the message started to be received. Once the body has arrived, and all policy
15036 checks have taken place, the timestamp is updated to the time at which the
15037 message was accepted.
15038
15039
15040 .option received_headers_max main integer 30
15041 .cindex "loop" "prevention"
15042 .cindex "mail loop prevention"
15043 .cindex "&'Received:'& header line" "counting"
15044 When a message is to be delivered, the number of &'Received:'& headers is
15045 counted, and if it is greater than this parameter, a mail loop is assumed to
15046 have occurred, the delivery is abandoned, and an error message is generated.
15047 This applies to both local and remote deliveries.
15048
15049
15050 .option recipient_unqualified_hosts main "host list&!!" unset
15051 .cindex "unqualified addresses"
15052 .cindex "host" "unqualified addresses from"
15053 This option lists those hosts from which Exim is prepared to accept unqualified
15054 recipient addresses in message envelopes. The addresses are made fully
15055 qualified by the addition of the &%qualify_recipient%& value. This option also
15056 affects message header lines. Exim does not reject unqualified recipient
15057 addresses in headers, but it qualifies them only if the message came from a
15058 host that matches &%recipient_unqualified_hosts%&,
15059 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15060 option was not set.
15061
15062
15063 .option recipients_max main integer 0
15064 .cindex "limit" "number of recipients"
15065 .cindex "recipient" "maximum number"
15066 If this option is set greater than zero, it specifies the maximum number of
15067 original recipients for any message. Additional recipients that are generated
15068 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15069 all recipients over the limit; earlier recipients are delivered as normal.
15070 Non-SMTP messages with too many recipients are failed, and no deliveries are
15071 done.
15072
15073 .cindex "RCPT" "maximum number of incoming"
15074 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15075 RCPT commands in a single message.
15076
15077
15078 .option recipients_max_reject main boolean false
15079 If this option is set true, Exim rejects SMTP messages containing too many
15080 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15081 error to the eventual DATA command. Otherwise (the default) it gives a 452
15082 error to the surplus RCPT commands and accepts the message on behalf of the
15083 initial set of recipients. The remote server should then re-send the message
15084 for the remaining recipients at a later time.
15085
15086
15087 .option remote_max_parallel main integer 2
15088 .cindex "delivery" "parallelism for remote"
15089 This option controls parallel delivery of one message to a number of remote
15090 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15091 does all the remote deliveries for a message one by one. Otherwise, if a single
15092 message has to be delivered to more than one remote host, or if several copies
15093 have to be sent to the same remote host, up to &%remote_max_parallel%&
15094 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15095 deliveries are required, the maximum number of processes are started, and as
15096 each one finishes, another is begun. The order of starting processes is the
15097 same as if sequential delivery were being done, and can be controlled by the
15098 &%remote_sort_domains%& option. If parallel delivery takes place while running
15099 with debugging turned on, the debugging output from each delivery process is
15100 tagged with its process id.
15101
15102 This option controls only the maximum number of parallel deliveries for one
15103 message in one Exim delivery process. Because Exim has no central queue
15104 manager, there is no way of controlling the total number of simultaneous
15105 deliveries if the configuration allows a delivery attempt as soon as a message
15106 is received.
15107
15108 .cindex "number of deliveries"
15109 .cindex "delivery" "maximum number of"
15110 If you want to control the total number of deliveries on the system, you
15111 need to set the &%queue_only%& option. This ensures that all incoming messages
15112 are added to the queue without starting a delivery process. Then set up an Exim
15113 daemon to start queue runner processes at appropriate intervals (probably
15114 fairly often, for example, every minute), and limit the total number of queue
15115 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15116 delivers only one message at a time, the maximum number of deliveries that can
15117 then take place at once is &%queue_run_max%& multiplied by
15118 &%remote_max_parallel%&.
15119
15120 If it is purely remote deliveries you want to control, use
15121 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15122 doing the SMTP routing before queueing, so that several messages for the same
15123 host will eventually get delivered down the same connection.
15124
15125
15126 .option remote_sort_domains main "domain list&!!" unset
15127 .cindex "sorting remote deliveries"
15128 .cindex "delivery" "sorting remote"
15129 When there are a number of remote deliveries for a message, they are sorted by
15130 domain into the order given by this list. For example,
15131 .code
15132 remote_sort_domains = *.cam.ac.uk:*.uk
15133 .endd
15134 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15135 then to those in the &%uk%& domain, then to any others.
15136
15137
15138 .option retry_data_expire main time 7d
15139 .cindex "hints database" "data expiry"
15140 This option sets a &"use before"& time on retry information in Exim's hints
15141 database. Any older retry data is ignored. This means that, for example, once a
15142 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15143 past failures.
15144
15145
15146 .option retry_interval_max main time 24h
15147 .cindex "retry" "limit on interval"
15148 .cindex "limit" "on retry interval"
15149 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15150 intervals between delivery attempts for messages that cannot be delivered
15151 straight away. This option sets an overall limit to the length of time between
15152 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15153 the default value.
15154
15155
15156 .option return_path_remove main boolean true
15157 .cindex "&'Return-path:'& header line" "removing"
15158 RFC 2821, section 4.4, states that an SMTP server must insert a
15159 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15160 The &'Return-path:'& header preserves the sender address as received in the
15161 MAIL command. This description implies that this header should not be present
15162 in an incoming message. If &%return_path_remove%& is true, any existing
15163 &'Return-path:'& headers are removed from messages at the time they are
15164 received. Exim's transports have options for adding &'Return-path:'& headers at
15165 the time of delivery. They are normally used only for final local deliveries.
15166
15167
15168 .option return_size_limit main integer 100K
15169 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15170
15171
15172 .option rfc1413_hosts main "host list&!!" *
15173 .cindex "RFC 1413"
15174 .cindex "host" "for RFC 1413 calls"
15175 RFC 1413 identification calls are made to any client host which matches an item
15176 in the list.
15177
15178 .option rfc1413_query_timeout main time 5s
15179 .cindex "RFC 1413" "query timeout"
15180 .cindex "timeout" "for RFC 1413 call"
15181 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15182 no RFC 1413 calls are ever made.
15183
15184
15185 .option sender_unqualified_hosts main "host list&!!" unset
15186 .cindex "unqualified addresses"
15187 .cindex "host" "unqualified addresses from"
15188 This option lists those hosts from which Exim is prepared to accept unqualified
15189 sender addresses. The addresses are made fully qualified by the addition of
15190 &%qualify_domain%&. This option also affects message header lines. Exim does
15191 not reject unqualified addresses in headers that contain sender addresses, but
15192 it qualifies them only if the message came from a host that matches
15193 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15194 using TCP/IP), and the &%-bnq%& option was not set.
15195
15196
15197 .option smtp_accept_keepalive main boolean true
15198 .cindex "keepalive" "on incoming connection"
15199 This option controls the setting of the SO_KEEPALIVE option on incoming
15200 TCP/IP socket connections. When set, it causes the kernel to probe idle
15201 connections periodically, by sending packets with &"old"& sequence numbers. The
15202 other end of the connection should send an acknowledgment if the connection is
15203 still okay or a reset if the connection has been aborted. The reason for doing
15204 this is that it has the beneficial effect of freeing up certain types of
15205 connection that can get stuck when the remote host is disconnected without
15206 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15207 hours to detect unreachable hosts.
15208
15209
15210
15211 .option smtp_accept_max main integer 20
15212 .cindex "limit" "incoming SMTP connections"
15213 .cindex "SMTP" "incoming connection count"
15214 .cindex "inetd"
15215 This option specifies the maximum number of simultaneous incoming SMTP calls
15216 that Exim will accept. It applies only to the listening daemon; there is no
15217 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15218 value is set to zero, no limit is applied. However, it is required to be
15219 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15220 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15221
15222 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15223 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15224 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15225 and &%smtp_load_reserve%& are then checked before accepting the connection.
15226
15227
15228 .option smtp_accept_max_nonmail main integer 10
15229 .cindex "limit" "non-mail SMTP commands"
15230 .cindex "SMTP" "limiting non-mail commands"
15231 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15232 the connection if there are too many. This option defines &"too many"&. The
15233 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15234 client looping sending EHLO, for example. The check is applied only if the
15235 client host matches &%smtp_accept_max_nonmail_hosts%&.
15236
15237 When a new message is expected, one occurrence of RSET is not counted. This
15238 allows a client to send one RSET between messages (this is not necessary,
15239 but some clients do it). Exim also allows one uncounted occurrence of HELO
15240 or EHLO, and one occurrence of STARTTLS between messages. After
15241 starting up a TLS session, another EHLO is expected, and so it too is not
15242 counted. The first occurrence of AUTH in a connection, or immediately
15243 following STARTTLS is not counted. Otherwise, all commands other than
15244 MAIL, RCPT, DATA, and QUIT are counted.
15245
15246
15247 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15248 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15249 check by setting this option. The default value makes it apply to all hosts. By
15250 changing the value, you can exclude any badly-behaved hosts that you have to
15251 live with.
15252
15253
15254 . Allow this long option name to split; give it unsplit as a fifth argument
15255 . for the automatic .oindex that is generated by .option.
15256
15257 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15258          smtp_accept_max_per_connection
15259 .cindex "SMTP" "limiting incoming message count"
15260 .cindex "limit" "messages per SMTP connection"
15261 The value of this option limits the number of MAIL commands that Exim is
15262 prepared to accept over a single SMTP connection, whether or not each command
15263 results in the transfer of a message. After the limit is reached, a 421
15264 response is given to subsequent MAIL commands. This limit is a safety
15265 precaution against a client that goes mad (incidents of this type have been
15266 seen).
15267
15268
15269 .option smtp_accept_max_per_host main string&!! unset
15270 .cindex "limit" "SMTP connections from one host"
15271 .cindex "host" "limiting SMTP connections from"
15272 This option restricts the number of simultaneous IP connections from a single
15273 host (strictly, from a single IP address) to the Exim daemon. The option is
15274 expanded, to enable different limits to be applied to different hosts by
15275 reference to &$sender_host_address$&. Once the limit is reached, additional
15276 connection attempts from the same host are rejected with error code 421. This
15277 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15278 of zero imposes no limit. If this option is set greater than zero, it is
15279 required that &%smtp_accept_max%& be non-zero.
15280
15281 &*Warning*&: When setting this option you should not use any expansion
15282 constructions that take an appreciable amount of time. The expansion and test
15283 happen in the main daemon loop, in order to reject additional connections
15284 without forking additional processes (otherwise a denial-of-service attack
15285 could cause a vast number or processes to be created). While the daemon is
15286 doing this processing, it cannot accept any other incoming connections.
15287
15288
15289
15290 .option smtp_accept_queue main integer 0
15291 .cindex "SMTP" "incoming connection count"
15292 .cindex "queueing incoming messages"
15293 .cindex "message" "queueing by SMTP connection count"
15294 If the number of simultaneous incoming SMTP connections being handled via the
15295 listening daemon exceeds this value, messages received by SMTP are just placed
15296 on the queue; no delivery processes are started automatically. The count is
15297 fixed at the start of an SMTP connection. It cannot be updated in the
15298 subprocess that receives messages, and so the queueing or not queueing applies
15299 to all messages received in the same connection.
15300
15301 A value of zero implies no limit, and clearly any non-zero value is useful only
15302 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15303 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15304 various &%-od%&&'x'& command line options.
15305
15306
15307 . Allow this long option name to split; give it unsplit as a fifth argument
15308 . for the automatic .oindex that is generated by .option.
15309
15310 .option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&&
15311          smtp_accept_queue_per_connection
15312 .cindex "queueing incoming messages"
15313 .cindex "message" "queueing by message count"
15314 This option limits the number of delivery processes that Exim starts
15315 automatically when receiving messages via SMTP, whether via the daemon or by
15316 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15317 and the number of messages received in a single SMTP session exceeds this
15318 number, subsequent messages are placed on the queue, but no delivery processes
15319 are started. This helps to limit the number of Exim processes when a server
15320 restarts after downtime and there is a lot of mail waiting for it on other
15321 systems. On large systems, the default should probably be increased, and on
15322 dial-in client systems it should probably be set to zero (that is, disabled).
15323
15324
15325 .option smtp_accept_reserve main integer 0
15326 .cindex "SMTP" "incoming call count"
15327 .cindex "host" "reserved"
15328 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15329 number of SMTP connections that are reserved for connections from the hosts
15330 that are specified in &%smtp_reserve_hosts%&. The value set in
15331 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15332 restricted to this number of connections; the option specifies a minimum number
15333 of connection slots for them, not a maximum. It is a guarantee that this group
15334 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15335 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15336 individual host.
15337
15338 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15339 set to 5, once there are 45 active connections (from any hosts), new
15340 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15341 provided the other criteria for acceptance are met.
15342
15343
15344 .option smtp_active_hostname main string&!! unset
15345 .cindex "host" "name in SMTP responses"
15346 .cindex "SMTP" "host name in responses"
15347 .vindex "&$primary_hostname$&"
15348 This option is provided for multi-homed servers that want to masquerade as
15349 several different hosts. At the start of an incoming SMTP connection, its value
15350 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15351 responses. For example, it is used as domain name in the response to an
15352 incoming HELO or EHLO command.
15353
15354 .vindex "&$smtp_active_hostname$&"
15355 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15356 is saved with any messages that are received. It is therefore available for use
15357 in routers and transports when the message is later delivered.
15358
15359 If this option is unset, or if its expansion is forced to fail, or if the
15360 expansion results in an empty string, the value of &$primary_hostname$& is
15361 used. Other expansion failures cause a message to be written to the main and
15362 panic logs, and the SMTP command receives a temporary error. Typically, the
15363 value of &%smtp_active_hostname%& depends on the incoming interface address.
15364 For example:
15365 .code
15366 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15367   {cox.mydomain}{box.mydomain}}
15368 .endd
15369
15370 Although &$smtp_active_hostname$& is primarily concerned with incoming
15371 messages, it is also used as the default for HELO commands in callout
15372 verification if there is no remote transport from which to obtain a
15373 &%helo_data%& value.
15374
15375 .option smtp_banner main string&!! "see below"
15376 .cindex "SMTP" "welcome banner"
15377 .cindex "banner for SMTP"
15378 .cindex "welcome banner for SMTP"
15379 .cindex "customizing" "SMTP banner"
15380 This string, which is expanded every time it is used, is output as the initial
15381 positive response to an SMTP connection. The default setting is:
15382 .code
15383 smtp_banner = $smtp_active_hostname ESMTP Exim \
15384   $version_number $tod_full
15385 .endd
15386 Failure to expand the string causes a panic error. If you want to create a
15387 multiline response to the initial SMTP connection, use &"\n"& in the string at
15388 appropriate points, but not at the end. Note that the 220 code is not included
15389 in this string. Exim adds it automatically (several times in the case of a
15390 multiline response).
15391
15392
15393 .option smtp_check_spool_space main boolean true
15394 .cindex "checking disk space"
15395 .cindex "disk space, checking"
15396 .cindex "spool directory" "checking space"
15397 When this option is set, if an incoming SMTP session encounters the SIZE
15398 option on a MAIL command, it checks that there is enough space in the
15399 spool directory's partition to accept a message of that size, while still
15400 leaving free the amount specified by &%check_spool_space%& (even if that value
15401 is zero). If there isn't enough space, a temporary error code is returned.
15402
15403
15404 .option smtp_connect_backlog main integer 20
15405 .cindex "connection backlog"
15406 .cindex "SMTP" "connection backlog"
15407 .cindex "backlog of connections"
15408 This option specifies a maximum number of waiting SMTP connections. Exim passes
15409 this value to the TCP/IP system when it sets up its listener. Once this number
15410 of connections are waiting for the daemon's attention, subsequent connection
15411 attempts are refused at the TCP/IP level. At least, that is what the manuals
15412 say; in some circumstances such connection attempts have been observed to time
15413 out instead. For large systems it is probably a good idea to increase the
15414 value (to 50, say). It also gives some protection against denial-of-service
15415 attacks by SYN flooding.
15416
15417
15418 .option smtp_enforce_sync main boolean true
15419 .cindex "SMTP" "synchronization checking"
15420 .cindex "synchronization checking in SMTP"
15421 The SMTP protocol specification requires the client to wait for a response from
15422 the server at certain points in the dialogue. Without PIPELINING these
15423 synchronization points are after every command; with PIPELINING they are
15424 fewer, but they still exist.
15425
15426 Some spamming sites send out a complete set of SMTP commands without waiting
15427 for any response. Exim protects against this by rejecting a message if the
15428 client has sent further input when it should not have. The error response &"554
15429 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15430 for this error cannot be perfect because of transmission delays (unexpected
15431 input may be on its way but not yet received when Exim checks). However, it
15432 does detect many instances.
15433
15434 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15435 If you want to disable the check selectively (for example, only for certain
15436 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15437 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15438
15439
15440
15441 .option smtp_etrn_command main string&!! unset
15442 .cindex "ETRN" "command to be run"
15443 .vindex "&$domain$&"
15444 If this option is set, the given command is run whenever an SMTP ETRN
15445 command is received from a host that is permitted to issue such commands (see
15446 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15447 are independently expanded. The expansion variable &$domain$& is set to the
15448 argument of the ETRN command, and no syntax checking is done on it. For
15449 example:
15450 .code
15451 smtp_etrn_command = /etc/etrn_command $domain \
15452                     $sender_host_address
15453 .endd
15454 A new process is created to run the command, but Exim does not wait for it to
15455 complete. Consequently, its status cannot be checked. If the command cannot be
15456 run, a line is written to the panic log, but the ETRN caller still receives
15457 a 250 success response. Exim is normally running under its own uid when
15458 receiving SMTP, so it is not possible for it to change the uid before running
15459 the command.
15460
15461
15462 .option smtp_etrn_serialize main boolean true
15463 .cindex "ETRN" "serializing"
15464 When this option is set, it prevents the simultaneous execution of more than
15465 one identical command as a result of ETRN in an SMTP connection. See
15466 section &<<SECTETRN>>& for details.
15467
15468
15469 .option smtp_load_reserve main fixed-point unset
15470 .cindex "load average"
15471 If the system load average ever gets higher than this, incoming SMTP calls are
15472 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15473 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15474 the load is over the limit. The option has no effect on ancient operating
15475 systems on which Exim cannot determine the load average. See also
15476 &%deliver_queue_load_max%& and &%queue_only_load%&.
15477
15478
15479
15480 .option smtp_max_synprot_errors main integer 3
15481 .cindex "SMTP" "limiting syntax and protocol errors"
15482 .cindex "limit" "SMTP syntax and protocol errors"
15483 Exim rejects SMTP commands that contain syntax or protocol errors. In
15484 particular, a syntactically invalid email address, as in this command:
15485 .code
15486 RCPT TO:<abc xyz@a.b.c>
15487 .endd
15488 causes immediate rejection of the command, before any other tests are done.
15489 (The ACL cannot be run if there is no valid address to set up for it.) An
15490 example of a protocol error is receiving RCPT before MAIL. If there are
15491 too many syntax or protocol errors in one SMTP session, the connection is
15492 dropped. The limit is set by this option.
15493
15494 .cindex "PIPELINING" "expected errors"
15495 When the PIPELINING extension to SMTP is in use, some protocol errors are
15496 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15497 Exim assumes that PIPELINING will be used if it advertises it (see
15498 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15499 not count towards the limit.
15500
15501
15502
15503 .option smtp_max_unknown_commands main integer 3
15504 .cindex "SMTP" "limiting unknown commands"
15505 .cindex "limit" "unknown SMTP commands"
15506 If there are too many unrecognized commands in an incoming SMTP session, an
15507 Exim server drops the connection. This is a defence against some kinds of abuse
15508 that subvert web
15509 clients
15510 into making connections to SMTP ports; in these circumstances, a number of
15511 non-SMTP command lines are sent first.
15512
15513
15514
15515 .option smtp_ratelimit_hosts main "host list&!!" unset
15516 .cindex "SMTP" "rate limiting"
15517 .cindex "limit" "rate of message arrival"
15518 .cindex "RCPT" "rate limiting"
15519 Some sites find it helpful to be able to limit the rate at which certain hosts
15520 can send them messages, and the rate at which an individual message can specify
15521 recipients.
15522
15523 Exim has two rate-limiting facilities. This section describes the older
15524 facility, which can limit rates within a single connection. The newer
15525 &%ratelimit%& ACL condition can limit rates across all connections. See section
15526 &<<SECTratelimiting>>& for details of the newer facility.
15527
15528 When a host matches &%smtp_ratelimit_hosts%&, the values of
15529 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15530 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15531 respectively. Each option, if set, must contain a set of four comma-separated
15532 values:
15533
15534 .ilist
15535 A threshold, before which there is no rate limiting.
15536 .next
15537 An initial time delay. Unlike other times in Exim, numbers with decimal
15538 fractional parts are allowed here.
15539 .next
15540 A factor by which to increase the delay each time.
15541 .next
15542 A maximum value for the delay. This should normally be less than 5 minutes,
15543 because after that time, the client is liable to timeout the SMTP command.
15544 .endlist
15545
15546 For example, these settings have been used successfully at the site which
15547 first suggested this feature, for controlling mail from their customers:
15548 .code
15549 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15550 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15551 .endd
15552 The first setting specifies delays that are applied to MAIL commands after
15553 two have been received over a single connection. The initial delay is 0.5
15554 seconds, increasing by a factor of 1.05 each time. The second setting applies
15555 delays to RCPT commands when more than four occur in a single message.
15556
15557
15558 .option smtp_ratelimit_mail main string unset
15559 See &%smtp_ratelimit_hosts%& above.
15560
15561
15562 .option smtp_ratelimit_rcpt main string unset
15563 See &%smtp_ratelimit_hosts%& above.
15564
15565
15566 .option smtp_receive_timeout main time 5m
15567 .cindex "timeout" "for SMTP input"
15568 .cindex "SMTP" "input timeout"
15569 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15570 input, including batch SMTP. If a line of input (either an SMTP command or a
15571 data line) is not received within this time, the SMTP connection is dropped and
15572 the message is abandoned.
15573 A line is written to the log containing one of the following messages:
15574 .code
15575 SMTP command timeout on connection from...
15576 SMTP data timeout on connection from...
15577 .endd
15578 The former means that Exim was expecting to read an SMTP command; the latter
15579 means that it was in the DATA phase, reading the contents of a message.
15580
15581
15582 .oindex "&%-os%&"
15583 The value set by this option can be overridden by the
15584 &%-os%& command-line option. A setting of zero time disables the timeout, but
15585 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15586 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15587 timeout is controlled by &%receive_timeout%& and &%-or%&.
15588
15589
15590 .option smtp_reserve_hosts main "host list&!!" unset
15591 This option defines hosts for which SMTP connections are reserved; see
15592 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15593
15594
15595 .option smtp_return_error_details main boolean false
15596 .cindex "SMTP" "details policy failures"
15597 .cindex "policy control" "rejection, returning details"
15598 In the default state, Exim uses bland messages such as
15599 &"Administrative prohibition"& when it rejects SMTP commands for policy
15600 reasons. Many sysadmins like this because it gives away little information
15601 to spammers. However, some other sysadmins who are applying strict checking
15602 policies want to give out much fuller information about failures. Setting
15603 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15604 example, instead of &"Administrative prohibition"&, it might give:
15605 .code
15606 550-Rejected after DATA: '>' missing at end of address:
15607 550 failing address in "From" header is: <user@dom.ain
15608 .endd
15609
15610 .option spamd_address main string "see below"
15611 This option is available when Exim is compiled with the content-scanning
15612 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15613 The default value is
15614 .code
15615 127.0.0.1 783
15616 .endd
15617 See section &<<SECTscanspamass>>& for more details.
15618
15619
15620
15621 .option split_spool_directory main boolean false
15622 .cindex "multiple spool directories"
15623 .cindex "spool directory" "split"
15624 .cindex "directories, multiple"
15625 If this option is set, it causes Exim to split its input directory into 62
15626 subdirectories, each with a single alphanumeric character as its name. The
15627 sixth character of the message id is used to allocate messages to
15628 subdirectories; this is the least significant base-62 digit of the time of
15629 arrival of the message.
15630
15631 Splitting up the spool in this way may provide better performance on systems
15632 where there are long mail queues, by reducing the number of files in any one
15633 directory. The msglog directory is also split up in a similar way to the input
15634 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15635 are still placed in the single directory &_msglog.OLD_&.
15636
15637 It is not necessary to take any special action for existing messages when
15638 changing &%split_spool_directory%&. Exim notices messages that are in the
15639 &"wrong"& place, and continues to process them. If the option is turned off
15640 after a period of being on, the subdirectories will eventually empty and be
15641 automatically deleted.
15642
15643 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15644 changes. Instead of creating a list of all messages in the queue, and then
15645 trying to deliver each one in turn, it constructs a list of those in one
15646 sub-directory and tries to deliver them, before moving on to the next
15647 sub-directory. The sub-directories are processed in a random order. This
15648 spreads out the scanning of the input directories, and uses less memory. It is
15649 particularly beneficial when there are lots of messages on the queue. However,
15650 if &%queue_run_in_order%& is set, none of this new processing happens. The
15651 entire queue has to be scanned and sorted before any deliveries can start.
15652
15653
15654 .option spool_directory main string&!! "set at compile time"
15655 .cindex "spool directory" "path to"
15656 This defines the directory in which Exim keeps its spool, that is, the messages
15657 it is waiting to deliver. The default value is taken from the compile-time
15658 configuration setting, if there is one. If not, this option must be set. The
15659 string is expanded, so it can contain, for example, a reference to
15660 &$primary_hostname$&.
15661
15662 If the spool directory name is fixed on your installation, it is recommended
15663 that you set it at build time rather than from this option, particularly if the
15664 log files are being written to the spool directory (see &%log_file_path%&).
15665 Otherwise log files cannot be used for errors that are detected early on, such
15666 as failures in the configuration file.
15667
15668 By using this option to override the compiled-in path, it is possible to run
15669 tests of Exim without using the standard spool.
15670
15671 .option sqlite_lock_timeout main time 5s
15672 .cindex "sqlite lookup type" "lock timeout"
15673 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15674 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15675
15676 .option strict_acl_vars main boolean false
15677 .cindex "&ACL;" "variables, handling unset"
15678 This option controls what happens if a syntactically valid but undefined ACL
15679 variable is referenced. If it is false (the default), an empty string
15680 is substituted; if it is true, an error is generated. See section
15681 &<<SECTaclvariables>>& for details of ACL variables.
15682
15683 .option strip_excess_angle_brackets main boolean false
15684 .cindex "angle brackets, excess"
15685 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15686 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15687 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15688 passed on to another MTA, the excess angle brackets are not passed on. If this
15689 option is not set, multiple pairs of angle brackets cause a syntax error.
15690
15691
15692 .option strip_trailing_dot main boolean false
15693 .cindex "trailing dot on domain"
15694 .cindex "dot" "trailing on domain"
15695 If this option is set, a trailing dot at the end of a domain in an address is
15696 ignored. If this is in the envelope and the message is passed on to another
15697 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15698 domain causes a syntax error.
15699 However, addresses in header lines are checked only when an ACL requests header
15700 syntax checking.
15701
15702
15703 .option syslog_duplication main boolean true
15704 .cindex "syslog" "duplicate log lines; suppressing"
15705 When Exim is logging to syslog, it writes the log lines for its three
15706 separate logs at different syslog priorities so that they can in principle
15707 be separated on the logging hosts. Some installations do not require this
15708 separation, and in those cases, the duplication of certain log lines is a
15709 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15710 particular log line is written to syslog. For lines that normally go to
15711 both the main log and the reject log, the reject log version (possibly
15712 containing message header lines) is written, at LOG_NOTICE priority.
15713 Lines that normally go to both the main and the panic log are written at
15714 the LOG_ALERT priority.
15715
15716
15717 .option syslog_facility main string unset
15718 .cindex "syslog" "facility; setting"
15719 This option sets the syslog &"facility"& name, used when Exim is logging to
15720 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15721 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15722 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15723 details of Exim's logging.
15724
15725
15726
15727 .option syslog_processname main string &`exim`&
15728 .cindex "syslog" "process name; setting"
15729 This option sets the syslog &"ident"& name, used when Exim is logging to
15730 syslog. The value must be no longer than 32 characters. See chapter
15731 &<<CHAPlog>>& for details of Exim's logging.
15732
15733
15734
15735 .option syslog_timestamp main boolean true
15736 .cindex "syslog" "timestamps"
15737 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15738 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15739 details of Exim's logging.
15740
15741
15742 .option system_filter main string&!! unset
15743 .cindex "filter" "system filter"
15744 .cindex "system filter" "specifying"
15745 .cindex "Sieve filter" "not available for system filter"
15746 This option specifies an Exim filter file that is applied to all messages at
15747 the start of each delivery attempt, before any routing is done. System filters
15748 must be Exim filters; they cannot be Sieve filters. If the system filter
15749 generates any deliveries to files or pipes, or any new mail messages, the
15750 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15751 which transports are to be used. Details of this facility are given in chapter
15752 &<<CHAPsystemfilter>>&.
15753
15754
15755 .option system_filter_directory_transport main string&!! unset
15756 .vindex "&$address_file$&"
15757 This sets the name of the transport driver that is to be used when the
15758 &%save%& command in a system message filter specifies a path ending in &"/"&,
15759 implying delivery of each message into a separate file in some directory.
15760 During the delivery, the variable &$address_file$& contains the path name.
15761
15762
15763 .option system_filter_file_transport main string&!! unset
15764 .cindex "file" "transport for system filter"
15765 This sets the name of the transport driver that is to be used when the &%save%&
15766 command in a system message filter specifies a path not ending in &"/"&. During
15767 the delivery, the variable &$address_file$& contains the path name.
15768
15769 .option system_filter_group main string unset
15770 .cindex "gid (group id)" "system filter"
15771 This option is used only when &%system_filter_user%& is also set. It sets the
15772 gid under which the system filter is run, overriding any gid that is associated
15773 with the user. The value may be numerical or symbolic.
15774
15775 .option system_filter_pipe_transport main string&!! unset
15776 .cindex "&(pipe)& transport" "for system filter"
15777 .vindex "&$address_pipe$&"
15778 This specifies the transport driver that is to be used when a &%pipe%& command
15779 is used in a system filter. During the delivery, the variable &$address_pipe$&
15780 contains the pipe command.
15781
15782
15783 .option system_filter_reply_transport main string&!! unset
15784 .cindex "&(autoreply)& transport" "for system filter"
15785 This specifies the transport driver that is to be used when a &%mail%& command
15786 is used in a system filter.
15787
15788
15789 .option system_filter_user main string unset
15790 .cindex "uid (user id)" "system filter"
15791 If this option is set to root, the system filter is run in the main Exim
15792 delivery process, as root.  Otherwise, the system filter runs in a separate
15793 process, as the given user, defaulting to the Exim run-time user.
15794 Unless the string consists entirely of digits, it
15795 is looked up in the password data. Failure to find the named user causes a
15796 configuration error. The gid is either taken from the password data, or
15797 specified by &%system_filter_group%&. When the uid is specified numerically,
15798 &%system_filter_group%& is required to be set.
15799
15800 If the system filter generates any pipe, file, or reply deliveries, the uid
15801 under which the filter is run is used when transporting them, unless a
15802 transport option overrides.
15803
15804
15805 .option tcp_nodelay main boolean true
15806 .cindex "daemon" "TCP_NODELAY on sockets"
15807 .cindex "Nagle algorithm"
15808 .cindex "TCP_NODELAY on listening sockets"
15809 If this option is set false, it stops the Exim daemon setting the
15810 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15811 turns off the &"Nagle algorithm"&, which is a way of improving network
15812 performance in interactive (character-by-character) situations. Turning it off
15813 should improve Exim's performance a bit, so that is what happens by default.
15814 However, it appears that some broken clients cannot cope, and time out. Hence
15815 this option. It affects only those sockets that are set up for listening by the
15816 daemon. Sockets created by the smtp transport for delivering mail always set
15817 TCP_NODELAY.
15818
15819
15820 .option timeout_frozen_after main time 0s
15821 .cindex "frozen messages" "timing out"
15822 .cindex "timeout" "frozen messages"
15823 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15824 message of any kind that has been on the queue for longer than the given time
15825 is automatically cancelled at the next queue run. If the frozen message is a
15826 bounce message, it is just discarded; otherwise, a bounce is sent to the
15827 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
15828 If you want to timeout frozen bounce messages earlier than other kinds of
15829 frozen message, see &%ignore_bounce_errors_after%&.
15830
15831 &*Note:*& the default value of zero means no timeouts; with this setting,
15832 frozen messages remain on the queue forever (except for any frozen bounce
15833 messages that are released by &%ignore_bounce_errors_after%&).
15834
15835
15836 .option timezone main string unset
15837 .cindex "timezone, setting"
15838 The value of &%timezone%& is used to set the environment variable TZ while
15839 running Exim (if it is different on entry). This ensures that all timestamps
15840 created by Exim are in the required timezone. If you want all your timestamps
15841 to be in UTC (aka GMT) you should set
15842 .code
15843 timezone = UTC
15844 .endd
15845 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
15846 or, if that is not set, from the value of the TZ environment variable when Exim
15847 is built. If &%timezone%& is set to the empty string, either at build or run
15848 time, any existing TZ variable is removed from the environment when Exim
15849 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
15850 unfortunately not all, operating systems.
15851
15852
15853 .option tls_advertise_hosts main "host list&!!" unset
15854 .cindex "TLS" "advertising"
15855 .cindex "encryption" "on SMTP connection"
15856 .cindex "SMTP" "encrypted connection"
15857 When Exim is built with support for TLS encrypted connections, the availability
15858 of the STARTTLS command to set up an encrypted session is advertised in
15859 response to EHLO only to those client hosts that match this option. See
15860 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
15861
15862
15863 .option tls_certificate main string&!! unset
15864 .cindex "TLS" "server certificate; location of"
15865 .cindex "certificate" "server, location of"
15866 The value of this option is expanded, and must then be the absolute path to a
15867 file which contains the server's certificates. The server's private key is also
15868 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
15869 &<<CHAPTLS>>& for further details.
15870
15871 &*Note*&: The certificates defined by this option are used only when Exim is
15872 receiving incoming messages as a server. If you want to supply certificates for
15873 use when sending messages as a client, you must set the &%tls_certificate%&
15874 option in the relevant &(smtp)& transport.
15875
15876 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
15877 if the OpenSSL build supports TLS extensions and the TLS client sends the
15878 Server Name Indication extension, then this option and others documented in
15879 &<<SECTtlssni>>& will be re-expanded.
15880
15881 .option tls_crl main string&!! unset
15882 .cindex "TLS" "server certificate revocation list"
15883 .cindex "certificate" "revocation list for server"
15884 This option specifies a certificate revocation list. The expanded value must
15885 be the name of a file that contains a CRL in PEM format.
15886
15887 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15888
15889
15890 .option tls_dh_max_bits main integer 2236
15891 .cindex "TLS" "D-H bit count"
15892 The number of bits used for Diffie-Hellman key-exchange may be suggested by
15893 the chosen TLS library.  That value might prove to be too high for
15894 interoperability.  This option provides a maximum clamp on the value
15895 suggested, trading off security for interoperability.
15896
15897 The value must be at least 1024.
15898
15899 The value 2236 was chosen because, at time of adding the option, it was the
15900 hard-coded maximum value supported by the NSS cryptographic library, as used
15901 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
15902
15903 If you prefer more security and are willing to break some clients, raise this
15904 number.
15905
15906 Note that the value passed to GnuTLS for *generating* a new prime may be a
15907 little less than this figure, because GnuTLS is inexact and may produce a
15908 larger prime than requested.
15909
15910
15911 .option tls_dhparam main string&!! unset
15912 .cindex "TLS" "D-H parameters for server"
15913 The value of this option is expanded and indicates the source of DH parameters
15914 to be used by Exim.
15915
15916 If it is a filename starting with a &`/`&, then it names a file from which DH
15917 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
15918 PKCS#3 representation of the DH prime.  If the file does not exist, for
15919 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
15920 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
15921 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
15922 and treated as though the &%tls_dhparam%& were set to "none".
15923
15924 If this option expands to the string "none", then no DH parameters will be
15925 loaded by Exim.
15926
15927 If this option expands to the string "historic" and Exim is using GnuTLS, then
15928 Exim will attempt to load a file from inside the spool directory.  If the file
15929 does not exist, Exim will attempt to create it.
15930 See section &<<SECTgnutlsparam>>& for further details.
15931
15932 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
15933 a default DH prime; the default is the 2048 bit prime described in section
15934 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
15935 in IKE is assigned number 23.
15936
15937 Otherwise, the option must expand to the name used by Exim for any of a number
15938 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
15939 "ike" followed by the number used by IKE, of "default" which corresponds to
15940 "ike23".
15941
15942 The available primes are:
15943 &`ike1`&, &`ike2`&, &`ike5`&,
15944 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
15945 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
15946
15947 Some of these will be too small to be accepted by clients.
15948 Some may be too large to be accepted by clients.
15949
15950
15951 .option tls_on_connect_ports main "string list" unset
15952 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
15953 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
15954 set up without waiting for the client to issue a STARTTLS command. For
15955 further details, see section &<<SECTsupobssmt>>&.
15956
15957
15958
15959 .option tls_privatekey main string&!! unset
15960 .cindex "TLS" "server private key; location of"
15961 The value of this option is expanded, and must then be the absolute path to a
15962 file which contains the server's private key. If this option is unset, or if
15963 the expansion is forced to fail, or the result is an empty string, the private
15964 key is assumed to be in the same file as the server's certificates. See chapter
15965 &<<CHAPTLS>>& for further details.
15966
15967 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15968
15969
15970 .option tls_remember_esmtp main boolean false
15971 .cindex "TLS" "esmtp state; remembering"
15972 .cindex "TLS" "broken clients"
15973 If this option is set true, Exim violates the RFCs by remembering that it is in
15974 &"esmtp"& state after successfully negotiating a TLS session. This provides
15975 support for broken clients that fail to send a new EHLO after starting a
15976 TLS session.
15977
15978
15979 .option tls_require_ciphers main string&!! unset
15980 .cindex "TLS" "requiring specific ciphers"
15981 .cindex "cipher" "requiring specific"
15982 This option controls which ciphers can be used for incoming TLS connections.
15983 The &(smtp)& transport has an option of the same name for controlling outgoing
15984 connections. This option is expanded for each connection, so can be varied for
15985 different clients if required. The value of this option must be a list of
15986 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
15987 in somewhat different ways. If GnuTLS is being used, the client controls the
15988 preference order of the available ciphers. Details are given in sections
15989 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
15990
15991
15992 .option tls_try_verify_hosts main "host list&!!" unset
15993 .cindex "TLS" "client certificate verification"
15994 .cindex "certificate" "verification of client"
15995 See &%tls_verify_hosts%& below.
15996
15997
15998 .option tls_verify_certificates main string&!! unset
15999 .cindex "TLS" "client certificate verification"
16000 .cindex "certificate" "verification of client"
16001 The value of this option is expanded, and must then be the absolute path to
16002 a file containing permitted certificates for clients that
16003 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
16004 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
16005 directory containing certificate files. This does not work with GnuTLS; the
16006 option must be set to the name of a single file if you are using GnuTLS.
16007
16008 These certificates should be for the certificate authorities trusted, rather
16009 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16010 the value is a file then the certificates are sent by Exim as a server to
16011 connecting clients, defining the list of accepted certificate authorities.
16012 Thus the values defined should be considered public data.  To avoid this,
16013 use OpenSSL with a directory.
16014
16015 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16016
16017
16018 .option tls_verify_hosts main "host list&!!" unset
16019 .cindex "TLS" "client certificate verification"
16020 .cindex "certificate" "verification of client"
16021 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16022 certificates from clients. The expected certificates are defined by
16023 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16024 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16025 &%tls_verify_certificates%& is not set.
16026
16027 Any client that matches &%tls_verify_hosts%& is constrained by
16028 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16029 present one of the listed certificates. If it does not, the connection is
16030 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16031 the host to use TLS. It can still send SMTP commands through unencrypted
16032 connections. Forcing a client to use TLS has to be done separately using an
16033 ACL to reject inappropriate commands when the connection is not encrypted.
16034
16035 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16036 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16037 certificate and checks it against &%tls_verify_certificates%&, but does not
16038 abort the connection if there is no certificate or if it does not match. This
16039 state can be detected in an ACL, which makes it possible to implement policies
16040 such as &"accept for relay only if a verified certificate has been received,
16041 but accept for local delivery if encrypted, even without a verified
16042 certificate"&.
16043
16044 Client hosts that match neither of these lists are not asked to present
16045 certificates.
16046
16047
16048 .option trusted_groups main "string list&!!" unset
16049 .cindex "trusted groups"
16050 .cindex "groups" "trusted"
16051 This option is expanded just once, at the start of Exim's processing. If this
16052 option is set, any process that is running in one of the listed groups, or
16053 which has one of them as a supplementary group, is trusted. The groups can be
16054 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16055 details of what trusted callers are permitted to do. If neither
16056 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16057 are trusted.
16058
16059 .option trusted_users main "string list&!!" unset
16060 .cindex "trusted users"
16061 .cindex "user" "trusted"
16062 This option is expanded just once, at the start of Exim's processing. If this
16063 option is set, any process that is running as one of the listed users is
16064 trusted. The users can be specified numerically or by name. See section
16065 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16066 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16067 Exim user are trusted.
16068
16069 .option unknown_login main string&!! unset
16070 .cindex "uid (user id)" "unknown caller"
16071 .vindex "&$caller_uid$&"
16072 This is a specialized feature for use in unusual configurations. By default, if
16073 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16074 gives up. The &%unknown_login%& option can be used to set a login name to be
16075 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16076 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16077 is used for the user's real name (gecos field), unless this has been set by the
16078 &%-F%& option.
16079
16080 .option unknown_username main string unset
16081 See &%unknown_login%&.
16082
16083 .option untrusted_set_sender main "address list&!!" unset
16084 .cindex "trusted users"
16085 .cindex "sender" "setting by untrusted user"
16086 .cindex "untrusted user setting sender"
16087 .cindex "user" "untrusted setting sender"
16088 .cindex "envelope sender"
16089 When an untrusted user submits a message to Exim using the standard input, Exim
16090 normally creates an envelope sender address from the user's login and the
16091 default qualification domain. Data from the &%-f%& option (for setting envelope
16092 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16093 is used) is ignored.
16094
16095 However, untrusted users are permitted to set an empty envelope sender address,
16096 to declare that a message should never generate any bounces. For example:
16097 .code
16098 exim -f '<>' user@domain.example
16099 .endd
16100 .vindex "&$sender_ident$&"
16101 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16102 other envelope sender addresses in a controlled way. When it is set, untrusted
16103 users are allowed to set envelope sender addresses that match any of the
16104 patterns in the list. Like all address lists, the string is expanded. The
16105 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16106 users to setting senders that start with their login ids
16107 followed by a hyphen
16108 by a setting like this:
16109 .code
16110 untrusted_set_sender = ^$sender_ident-
16111 .endd
16112 If you want to allow untrusted users to set envelope sender addresses without
16113 restriction, you can use
16114 .code
16115 untrusted_set_sender = *
16116 .endd
16117 The &%untrusted_set_sender%& option applies to all forms of local input, but
16118 only to the setting of the envelope sender. It does not permit untrusted users
16119 to use the other options which trusted user can use to override message
16120 parameters. Furthermore, it does not stop Exim from removing an existing
16121 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16122 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16123 overriding these actions. The handling of the &'Sender:'& header is also
16124 described in section &<<SECTthesenhea>>&.
16125
16126 The log line for a message's arrival shows the envelope sender following
16127 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16128 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16129 envelope sender address, the user's login is shown in parentheses after the
16130 sender address.
16131
16132
16133 .option uucp_from_pattern main string "see below"
16134 .cindex "&""From""& line"
16135 .cindex "UUCP" "&""From""& line"
16136 Some applications that pass messages to an MTA via a command line interface use
16137 an initial line starting with &"From&~"& to pass the envelope sender. In
16138 particular, this is used by UUCP software. Exim recognizes such a line by means
16139 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16140 matches, the sender address is constructed by expanding the contents of
16141 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16142 default pattern recognizes lines in the following two forms:
16143 .code
16144 From ph10 Fri Jan  5 12:35 GMT 1996
16145 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16146 .endd
16147 The pattern can be seen by running
16148 .code
16149 exim -bP uucp_from_pattern
16150 .endd
16151 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16152 year in the second case. The first word after &"From&~"& is matched in the
16153 regular expression by a parenthesized subpattern. The default value for
16154 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16155 (&"ph10"& in the example above) as the message's sender. See also
16156 &%ignore_fromline_hosts%&.
16157
16158
16159 .option uucp_from_sender main string&!! &`$1`&
16160 See &%uucp_from_pattern%& above.
16161
16162
16163 .option warn_message_file main string unset
16164 .cindex "warning of delay" "customizing the message"
16165 .cindex "customizing" "warning message"
16166 This option defines a template file containing paragraphs of text to be used
16167 for constructing the warning message which is sent by Exim when a message has
16168 been on the queue for a specified amount of time, as specified by
16169 &%delay_warning%&. Details of the file's contents are given in chapter
16170 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16171
16172
16173 .option write_rejectlog main boolean true
16174 .cindex "reject log" "disabling"
16175 If this option is set false, Exim no longer writes anything to the reject log.
16176 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16177 .ecindex IIDconfima
16178 .ecindex IIDmaiconf
16179
16180
16181
16182
16183 . ////////////////////////////////////////////////////////////////////////////
16184 . ////////////////////////////////////////////////////////////////////////////
16185
16186 .chapter "Generic options for routers" "CHAProutergeneric"
16187 .scindex IIDgenoprou1 "options" "generic; for routers"
16188 .scindex IIDgenoprou2 "generic options" "router"
16189 This chapter describes the generic options that apply to all routers.
16190 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16191
16192 For a general description of how a router operates, see sections
16193 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16194 which the preconditions are tested. The order of expansion of the options that
16195 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16196 &%headers_remove%&, &%transport%&.
16197
16198
16199
16200 .option address_data routers string&!! unset
16201 .cindex "router" "data attached to address"
16202 The string is expanded just before the router is run, that is, after all the
16203 precondition tests have succeeded. If the expansion is forced to fail, the
16204 router declines, the value of &%address_data%& remains unchanged, and the
16205 &%more%& option controls what happens next. Other expansion failures cause
16206 delivery of the address to be deferred.
16207
16208 .vindex "&$address_data$&"
16209 When the expansion succeeds, the value is retained with the address, and can be
16210 accessed using the variable &$address_data$& in the current router, subsequent
16211 routers, and the eventual transport.
16212
16213 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16214 that runs a user's filter file, the contents of &$address_data$& are accessible
16215 in the filter. This is not normally a problem, because such data is usually
16216 either not confidential or it &"belongs"& to the current user, but if you do
16217 put confidential data into &$address_data$& you need to remember this point.
16218
16219 Even if the router declines or passes, the value of &$address_data$& remains
16220 with the address, though it can be changed by another &%address_data%& setting
16221 on a subsequent router. If a router generates child addresses, the value of
16222 &$address_data$& propagates to them. This also applies to the special kind of
16223 &"child"& that is generated by a router with the &%unseen%& option.
16224
16225 The idea of &%address_data%& is that you can use it to look up a lot of data
16226 for the address once, and then pick out parts of the data later. For example,
16227 you could use a single LDAP lookup to return a string of the form
16228 .code
16229 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16230 .endd
16231 In the transport you could pick out the mailbox by a setting such as
16232 .code
16233 file = ${extract{mailbox}{$address_data}}
16234 .endd
16235 This makes the configuration file less messy, and also reduces the number of
16236 lookups (though Exim does cache lookups).
16237
16238 .vindex "&$sender_address_data$&"
16239 .vindex "&$address_data$&"
16240 The &%address_data%& facility is also useful as a means of passing information
16241 from one router to another, and from a router to a transport. In addition, if
16242 &$address_data$& is set by a router when verifying a recipient address from an
16243 ACL, it remains available for use in the rest of the ACL statement. After
16244 verifying a sender, the value is transferred to &$sender_address_data$&.
16245
16246
16247
16248 .option address_test routers&!? boolean true
16249 .oindex "&%-bt%&"
16250 .cindex "router" "skipping when address testing"
16251 If this option is set false, the router is skipped when routing is being tested
16252 by means of the &%-bt%& command line option. This can be a convenience when
16253 your first router sends messages to an external scanner, because it saves you
16254 having to set the &"already scanned"& indicator when testing real address
16255 routing.
16256
16257
16258
16259 .option cannot_route_message routers string&!! unset
16260 .cindex "router" "customizing &""cannot route""& message"
16261 .cindex "customizing" "&""cannot route""& message"
16262 This option specifies a text message that is used when an address cannot be
16263 routed because Exim has run out of routers. The default message is
16264 &"Unrouteable address"&. This option is useful only on routers that have
16265 &%more%& set false, or on the very last router in a configuration, because the
16266 value that is used is taken from the last router that is considered. This
16267 includes a router that is skipped because its preconditions are not met, as
16268 well as a router that declines. For example, using the default configuration,
16269 you could put:
16270 .code
16271 cannot_route_message = Remote domain not found in DNS
16272 .endd
16273 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16274 and
16275 .code
16276 cannot_route_message = Unknown local user
16277 .endd
16278 on the final router that checks for local users. If string expansion fails for
16279 this option, the default message is used. Unless the expansion failure was
16280 explicitly forced, a message about the failure is written to the main and panic
16281 logs, in addition to the normal message about the routing failure.
16282
16283
16284 .option caseful_local_part routers boolean false
16285 .cindex "case of local parts"
16286 .cindex "router" "case of local parts"
16287 By default, routers handle the local parts of addresses in a case-insensitive
16288 manner, though the actual case is preserved for transmission with the message.
16289 If you want the case of letters to be significant in a router, you must set
16290 this option true. For individual router options that contain address or local
16291 part lists (for example, &%local_parts%&), case-sensitive matching can be
16292 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16293 more details.
16294
16295 .vindex "&$local_part$&"
16296 .vindex "&$original_local_part$&"
16297 .vindex "&$parent_local_part$&"
16298 The value of the &$local_part$& variable is forced to lower case while a
16299 router is running unless &%caseful_local_part%& is set. When a router assigns
16300 an address to a transport, the value of &$local_part$& when the transport runs
16301 is the same as it was in the router. Similarly, when a router generates child
16302 addresses by aliasing or forwarding, the values of &$original_local_part$&
16303 and &$parent_local_part$& are those that were used by the redirecting router.
16304
16305 This option applies to the processing of an address by a router. When a
16306 recipient address is being processed in an ACL, there is a separate &%control%&
16307 modifier that can be used to specify case-sensitive processing within the ACL
16308 (see section &<<SECTcontrols>>&).
16309
16310
16311
16312 .option check_local_user routers&!? boolean false
16313 .cindex "local user, checking in router"
16314 .cindex "router" "checking for local user"
16315 .cindex "&_/etc/passwd_&"
16316 .vindex "&$home$&"
16317 When this option is true, Exim checks that the local part of the recipient
16318 address (with affixes removed if relevant) is the name of an account on the
16319 local system. The check is done by calling the &[getpwnam()]& function rather
16320 than trying to read &_/etc/passwd_& directly. This means that other methods of
16321 holding password data (such as NIS) are supported. If the local part is a local
16322 user, &$home$& is set from the password data, and can be tested in other
16323 preconditions that are evaluated after this one (the order of evaluation is
16324 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16325 overridden by &%router_home_directory%&. If the local part is not a local user,
16326 the router is skipped.
16327
16328 If you want to check that the local part is either the name of a local user
16329 or matches something else, you cannot combine &%check_local_user%& with a
16330 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16331 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16332 setting to achieve this. For example:
16333 .code
16334 local_parts = passwd;$local_part : lsearch;/etc/other/users
16335 .endd
16336 Note, however, that the side effects of &%check_local_user%& (such as setting
16337 up a home directory) do not occur when a &(passwd)& lookup is used in a
16338 &%local_parts%& (or any other) precondition.
16339
16340
16341
16342 .option condition routers&!? string&!! unset
16343 .cindex "router" "customized precondition"
16344 This option specifies a general precondition test that has to succeed for the
16345 router to be called. The &%condition%& option is the last precondition to be
16346 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16347 result is a forced failure, or an empty string, or one of the strings &"0"& or
16348 &"no"& or &"false"& (checked without regard to the case of the letters), the
16349 router is skipped, and the address is offered to the next one.
16350
16351 If the result is any other value, the router is run (as this is the last
16352 precondition to be evaluated, all the other preconditions must be true).
16353
16354 This option is unusual in that multiple &%condition%& options may be present.
16355 All &%condition%& options must succeed.
16356
16357 The &%condition%& option provides a means of applying custom conditions to the
16358 running of routers. Note that in the case of a simple conditional expansion,
16359 the default expansion values are exactly what is wanted. For example:
16360 .code
16361 condition = ${if >{$message_age}{600}}
16362 .endd
16363 Because of the default behaviour of the string expansion, this is equivalent to
16364 .code
16365 condition = ${if >{$message_age}{600}{true}{}}
16366 .endd
16367
16368 A multiple condition example, which succeeds:
16369 .code
16370 condition = ${if >{$message_age}{600}}
16371 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16372 condition = foobar
16373 .endd
16374
16375 If the expansion fails (other than forced failure) delivery is deferred. Some
16376 of the other precondition options are common special cases that could in fact
16377 be specified using &%condition%&.
16378
16379
16380 .option debug_print routers string&!! unset
16381 .cindex "testing" "variables in drivers"
16382 If this option is set and debugging is enabled (see the &%-d%& command line
16383 option), the string is expanded and included in the debugging output.
16384 If expansion of the string fails, the error message is written to the debugging
16385 output, and Exim carries on processing.
16386 This option is provided to help with checking out the values of variables and
16387 so on when debugging router configurations. For example, if a &%condition%&
16388 option appears not to be working, &%debug_print%& can be used to output the
16389 variables it references. The output happens after checks for &%domains%&,
16390 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16391 are tested. A newline is added to the text if it does not end with one.
16392
16393
16394
16395 .option disable_logging routers boolean false
16396 If this option is set true, nothing is logged for any routing errors
16397 or for any deliveries caused by this router. You should not set this option
16398 unless you really, really know what you are doing. See also the generic
16399 transport option of the same name.
16400
16401
16402 .option domains routers&!? "domain list&!!" unset
16403 .cindex "router" "restricting to specific domains"
16404 .vindex "&$domain_data$&"
16405 If this option is set, the router is skipped unless the current domain matches
16406 the list. If the match is achieved by means of a file lookup, the data that the
16407 lookup returned for the domain is placed in &$domain_data$& for use in string
16408 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
16409 a list of the order in which preconditions are evaluated.
16410
16411
16412
16413 .option driver routers string unset
16414 This option must always be set. It specifies which of the available routers is
16415 to be used.
16416
16417
16418
16419 .option errors_to routers string&!! unset
16420 .cindex "envelope sender"
16421 .cindex "router" "changing address for errors"
16422 If a router successfully handles an address, it may assign the address to a
16423 transport for delivery or it may generate child addresses. In both cases, if
16424 there is a delivery problem during later processing, the resulting bounce
16425 message is sent to the address that results from expanding this string,
16426 provided that the address verifies successfully. The &%errors_to%& option is
16427 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
16428
16429 The &%errors_to%& setting associated with an address can be overridden if it
16430 subsequently passes through other routers that have their own &%errors_to%&
16431 settings, or if the message is delivered by a transport with a &%return_path%&
16432 setting.
16433
16434 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
16435 the expansion fails to verify, the errors address associated with the incoming
16436 address is used. At top level, this is the envelope sender. A non-forced
16437 expansion failure causes delivery to be deferred.
16438
16439 If an address for which &%errors_to%& has been set ends up being delivered over
16440 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
16441 any bounces that are generated by other MTAs on the delivery route are also
16442 sent there. You can set &%errors_to%& to the empty string by either of these
16443 settings:
16444 .code
16445 errors_to =
16446 errors_to = ""
16447 .endd
16448 An expansion item that yields an empty string has the same effect. If you do
16449 this, a locally detected delivery error for addresses processed by this router
16450 no longer gives rise to a bounce message; the error is discarded. If the
16451 address is delivered to a remote host, the return path is set to &`<>`&, unless
16452 overridden by the &%return_path%& option on the transport.
16453
16454 .vindex "&$address_data$&"
16455 If for some reason you want to discard local errors, but use a non-empty
16456 MAIL command for remote delivery, you can preserve the original return
16457 path in &$address_data$& in the router, and reinstate it in the transport by
16458 setting &%return_path%&.
16459
16460 The most common use of &%errors_to%& is to direct mailing list bounces to the
16461 manager of the list, as described in section &<<SECTmailinglists>>&, or to
16462 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
16463
16464
16465
16466 .option expn routers&!? boolean true
16467 .cindex "address" "testing"
16468 .cindex "testing" "addresses"
16469 .cindex "EXPN" "router skipping"
16470 .cindex "router" "skipping for EXPN"
16471 If this option is turned off, the router is skipped when testing an address
16472 as a result of processing an SMTP EXPN command. You might, for example,
16473 want to turn it off on a router for users' &_.forward_& files, while leaving it
16474 on for the system alias file.
16475 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16476 are evaluated.
16477
16478 The use of the SMTP EXPN command is controlled by an ACL (see chapter
16479 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
16480 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
16481
16482
16483
16484 .option fail_verify routers boolean false
16485 .cindex "router" "forcing verification failure"
16486 Setting this option has the effect of setting both &%fail_verify_sender%& and
16487 &%fail_verify_recipient%& to the same value.
16488
16489
16490
16491 .option fail_verify_recipient routers boolean false
16492 If this option is true and an address is accepted by this router when
16493 verifying a recipient, verification fails.
16494
16495
16496
16497 .option fail_verify_sender routers boolean false
16498 If this option is true and an address is accepted by this router when
16499 verifying a sender, verification fails.
16500
16501
16502
16503 .option fallback_hosts routers "string list" unset
16504 .cindex "router" "fallback hosts"
16505 .cindex "fallback" "hosts specified on router"
16506 String expansion is not applied to this option. The argument must be a
16507 colon-separated list of host names or IP addresses. The list separator can be
16508 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
16509 each name or address. In fact, the format of each item is exactly the same as
16510 defined for the list of hosts in a &(manualroute)& router (see section
16511 &<<SECTformatonehostitem>>&).
16512
16513 If a router queues an address for a remote transport, this host list is
16514 associated with the address, and used instead of the transport's fallback host
16515 list. If &%hosts_randomize%& is set on the transport, the order of the list is
16516 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
16517 transport for further details.
16518
16519
16520 .option group routers string&!! "see below"
16521 .cindex "gid (group id)" "local delivery"
16522 .cindex "local transports" "uid and gid"
16523 .cindex "transport" "local"
16524 .cindex "router" "setting group"
16525 When a router queues an address for a transport, and the transport does not
16526 specify a group, the group given here is used when running the delivery
16527 process.
16528 The group may be specified numerically or by name. If expansion fails, the
16529 error is logged and delivery is deferred.
16530 The default is unset, unless &%check_local_user%& is set, when the default
16531 is taken from the password information. See also &%initgroups%& and &%user%&
16532 and the discussion in chapter &<<CHAPenvironment>>&.
16533
16534
16535
16536 .option headers_add routers string&!! unset
16537 .cindex "header lines" "adding"
16538 .cindex "router" "adding header lines"
16539 This option specifies a string of text that is expanded at routing time, and
16540 associated with any addresses that are accepted by the router. However, this
16541 option has no effect when an address is just being verified. The way in which
16542 the text is used to add header lines at transport time is described in section
16543 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
16544 message is in the process of being transported. This means that references to
16545 header lines in string expansions in the transport's configuration do not
16546 &"see"& the added header lines.
16547
16548 The &%headers_add%& option is expanded after &%errors_to%&, but before
16549 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
16550 the expansion is forced to fail, the option has no effect. Other expansion
16551 failures are treated as configuration errors.
16552
16553 Unlike most options, &%headers_add%& can be specified multiple times
16554 for a router; all listed headers are added.
16555
16556 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
16557 router that has the &%one_time%& option set.
16558
16559 .cindex "duplicate addresses"
16560 .oindex "&%unseen%&"
16561 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16562 additions are deleted when the address is passed on to subsequent routers.
16563 For a &%redirect%& router, if a generated address is the same as the incoming
16564 address, this can lead to duplicate addresses with different header
16565 modifications. Exim does not do duplicate deliveries (except, in certain
16566 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
16567 which of the duplicates is discarded, so this ambiguous situation should be
16568 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
16569
16570
16571
16572 .option headers_remove routers string&!! unset
16573 .cindex "header lines" "removing"
16574 .cindex "router" "removing header lines"
16575 This option specifies a string of text that is expanded at routing time, and
16576 associated with any addresses that are accepted by the router. However, this
16577 option has no effect when an address is just being verified. The way in which
16578 the text is used to remove header lines at transport time is described in
16579 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
16580 the message is in the process of being transported. This means that references
16581 to header lines in string expansions in the transport's configuration still
16582 &"see"& the original header lines.
16583
16584 The &%headers_remove%& option is expanded after &%errors_to%& and
16585 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
16586 the option has no effect. Other expansion failures are treated as configuration
16587 errors.
16588
16589 Unlike most options, &%headers_remove%& can be specified multiple times
16590 for a router; all listed headers are removed.
16591
16592 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
16593 router that has the &%one_time%& option set.
16594
16595 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16596 removal requests are deleted when the address is passed on to subsequent
16597 routers, and this can lead to problems with duplicates -- see the similar
16598 warning for &%headers_add%& above.
16599
16600
16601 .option ignore_target_hosts routers "host list&!!" unset
16602 .cindex "IP address" "discarding"
16603 .cindex "router" "discarding IP addresses"
16604 Although this option is a host list, it should normally contain IP address
16605 entries rather than names. If any host that is looked up by the router has an
16606 IP address that matches an item in this list, Exim behaves as if that IP
16607 address did not exist. This option allows you to cope with rogue DNS entries
16608 like
16609 .code
16610 remote.domain.example.  A  127.0.0.1
16611 .endd
16612 by setting
16613 .code
16614 ignore_target_hosts = 127.0.0.1
16615 .endd
16616 on the relevant router. If all the hosts found by a &(dnslookup)& router are
16617 discarded in this way, the router declines. In a conventional configuration, an
16618 attempt to mail to such a domain would normally provoke the &"unrouteable
16619 domain"& error, and an attempt to verify an address in the domain would fail.
16620 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
16621 router declines if presented with one of the listed addresses.
16622
16623 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
16624 means of the first or the second of the following settings, respectively:
16625 .code
16626 ignore_target_hosts = 0.0.0.0/0
16627 ignore_target_hosts = <; 0::0/0
16628 .endd
16629 The pattern in the first line matches all IPv4 addresses, whereas the pattern
16630 in the second line matches all IPv6 addresses.
16631
16632 This option may also be useful for ignoring link-local and site-local IPv6
16633 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
16634 is expanded before use as a list, it is possible to make it dependent on the
16635 domain that is being routed.
16636
16637 .vindex "&$host_address$&"
16638 During its expansion, &$host_address$& is set to the IP address that is being
16639 checked.
16640
16641 .option initgroups routers boolean false
16642 .cindex "additional groups"
16643 .cindex "groups" "additional"
16644 .cindex "local transports" "uid and gid"
16645 .cindex "transport" "local"
16646 If the router queues an address for a transport, and this option is true, and
16647 the uid supplied by the router is not overridden by the transport, the
16648 &[initgroups()]& function is called when running the transport to ensure that
16649 any additional groups associated with the uid are set up. See also &%group%&
16650 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16651
16652
16653
16654 .option local_part_prefix routers&!? "string list" unset
16655 .cindex "router" "prefix for local part"
16656 .cindex "prefix" "for local part, used in router"
16657 If this option is set, the router is skipped unless the local part starts with
16658 one of the given strings, or &%local_part_prefix_optional%& is true. See
16659 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16660 evaluated.
16661
16662 The list is scanned from left to right, and the first prefix that matches is
16663 used. A limited form of wildcard is available; if the prefix begins with an
16664 asterisk, it matches the longest possible sequence of arbitrary characters at
16665 the start of the local part. An asterisk should therefore always be followed by
16666 some character that does not occur in normal local parts.
16667 .cindex "multiple mailboxes"
16668 .cindex "mailbox" "multiple"
16669 Wildcarding can be used to set up multiple user mailboxes, as described in
16670 section &<<SECTmulbox>>&.
16671
16672 .vindex "&$local_part$&"
16673 .vindex "&$local_part_prefix$&"
16674 During the testing of the &%local_parts%& option, and while the router is
16675 running, the prefix is removed from the local part, and is available in the
16676 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16677 the router accepts the address, this remains true during subsequent delivery by
16678 a transport. In particular, the local part that is transmitted in the RCPT
16679 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16680 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16681 the relevant transport.
16682
16683 When an address is being verified, &%local_part_prefix%& affects only the
16684 behaviour of the router. If the callout feature of verification is in use, this
16685 means that the full address, including the prefix, will be used during the
16686 callout.
16687
16688 The prefix facility is commonly used to handle local parts of the form
16689 &%owner-something%&. Another common use is to support local parts of the form
16690 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16691 to tell a user their forwarding is broken &-- by placing a router like this one
16692 immediately before the router that handles &_.forward_& files:
16693 .code
16694 real_localuser:
16695   driver = accept
16696   local_part_prefix = real-
16697   check_local_user
16698   transport = local_delivery
16699 .endd
16700 For security, it would probably be a good idea to restrict the use of this
16701 router to locally-generated messages, using a condition such as this:
16702 .code
16703   condition = ${if match {$sender_host_address}\
16704                          {\N^(|127\.0\.0\.1)$\N}}
16705 .endd
16706
16707 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16708 both conditions must be met if not optional. Care must be taken if wildcards
16709 are used in both a prefix and a suffix on the same router. Different
16710 separator characters must be used to avoid ambiguity.
16711
16712
16713 .option local_part_prefix_optional routers boolean false
16714 See &%local_part_prefix%& above.
16715
16716
16717
16718 .option local_part_suffix routers&!? "string list" unset
16719 .cindex "router" "suffix for local part"
16720 .cindex "suffix for local part" "used in router"
16721 This option operates in the same way as &%local_part_prefix%&, except that the
16722 local part must end (rather than start) with the given string, the
16723 &%local_part_suffix_optional%& option determines whether the suffix is
16724 mandatory, and the wildcard * character, if present, must be the last
16725 character of the suffix. This option facility is commonly used to handle local
16726 parts of the form &%something-request%& and multiple user mailboxes of the form
16727 &%username-foo%&.
16728
16729
16730 .option local_part_suffix_optional routers boolean false
16731 See &%local_part_suffix%& above.
16732
16733
16734
16735 .option local_parts routers&!? "local part list&!!" unset
16736 .cindex "router" "restricting to specific local parts"
16737 .cindex "local part" "checking in router"
16738 The router is run only if the local part of the address matches the list.
16739 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16740 are evaluated, and
16741 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16742 string is expanded, it is possible to make it depend on the domain, for
16743 example:
16744 .code
16745 local_parts = dbm;/usr/local/specials/$domain
16746 .endd
16747 .vindex "&$local_part_data$&"
16748 If the match is achieved by a lookup, the data that the lookup returned
16749 for the local part is placed in the variable &$local_part_data$& for use in
16750 expansions of the router's private options. You might use this option, for
16751 example, if you have a large number of local virtual domains, and you want to
16752 send all postmaster mail to the same place without having to set up an alias in
16753 each virtual domain:
16754 .code
16755 postmaster:
16756   driver = redirect
16757   local_parts = postmaster
16758   data = postmaster@real.domain.example
16759 .endd
16760
16761
16762 .option log_as_local routers boolean "see below"
16763 .cindex "log" "delivery line"
16764 .cindex "delivery" "log line format"
16765 Exim has two logging styles for delivery, the idea being to make local
16766 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16767 recipient address is given just as the local part, without a domain. The use of
16768 this style is controlled by this option. It defaults to true for the &(accept)&
16769 router, and false for all the others. This option applies only when a
16770 router assigns an address to a transport. It has no effect on routers that
16771 redirect addresses.
16772
16773
16774
16775 .option more routers boolean&!! true
16776 The result of string expansion for this option must be a valid boolean value,
16777 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16778 result causes an error, and delivery is deferred. If the expansion is forced to
16779 fail, the default value for the option (true) is used. Other failures cause
16780 delivery to be deferred.
16781
16782 If this option is set false, and the router declines to handle the address, no
16783 further routers are tried, routing fails, and the address is bounced.
16784 .oindex "&%self%&"
16785 However, if the router explicitly passes an address to the following router by
16786 means of the setting
16787 .code
16788 self = pass
16789 .endd
16790 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16791 does not affect the behaviour if one of the precondition tests fails. In that
16792 case, the address is always passed to the next router.
16793
16794 Note that &%address_data%& is not considered to be a precondition. If its
16795 expansion is forced to fail, the router declines, and the value of &%more%&
16796 controls what happens next.
16797
16798
16799 .option pass_on_timeout routers boolean false
16800 .cindex "timeout" "of router"
16801 .cindex "router" "timeout"
16802 If a router times out during a host lookup, it normally causes deferral of the
16803 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16804 router, overriding &%no_more%&. This may be helpful for systems that are
16805 intermittently connected to the Internet, or those that want to pass to a smart
16806 host any messages that cannot immediately be delivered.
16807
16808 There are occasional other temporary errors that can occur while doing DNS
16809 lookups. They are treated in the same way as a timeout, and this option
16810 applies to all of them.
16811
16812
16813
16814 .option pass_router routers string unset
16815 .cindex "router" "go to after &""pass""&"
16816 Routers that recognize the generic &%self%& option (&(dnslookup)&,
16817 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
16818 routing to continue, and overriding a false setting of &%more%&. When one of
16819 these routers returns &"pass"&, the address is normally handed on to the next
16820 router in sequence. This can be changed by setting &%pass_router%& to the name
16821 of another router. However (unlike &%redirect_router%&) the named router must
16822 be below the current router, to avoid loops. Note that this option applies only
16823 to the special case of &"pass"&. It does not apply when a router returns
16824 &"decline"& because it cannot handle an address.
16825
16826
16827
16828 .option redirect_router routers string unset
16829 .cindex "router" "start at after redirection"
16830 Sometimes an administrator knows that it is pointless to reprocess addresses
16831 generated from alias or forward files with the same router again. For
16832 example, if an alias file translates real names into login ids there is no
16833 point searching the alias file a second time, especially if it is a large file.
16834
16835 The &%redirect_router%& option can be set to the name of any router instance.
16836 It causes the routing of any generated addresses to start at the named router
16837 instead of at the first router. This option has no effect if the router in
16838 which it is set does not generate new addresses.
16839
16840
16841
16842 .option require_files routers&!? "string list&!!" unset
16843 .cindex "file" "requiring for router"
16844 .cindex "router" "requiring file existence"
16845 This option provides a general mechanism for predicating the running of a
16846 router on the existence or non-existence of certain files or directories.
16847 Before running a router, as one of its precondition tests, Exim works its way
16848 through the &%require_files%& list, expanding each item separately.
16849
16850 Because the list is split before expansion, any colons in expansion items must
16851 be doubled, or the facility for using a different list separator must be used.
16852 If any expansion is forced to fail, the item is ignored. Other expansion
16853 failures cause routing of the address to be deferred.
16854
16855 If any expanded string is empty, it is ignored. Otherwise, except as described
16856 below, each string must be a fully qualified file path, optionally preceded by
16857 &"!"&. The paths are passed to the &[stat()]& function to test for the
16858 existence of the files or directories. The router is skipped if any paths not
16859 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
16860
16861 .cindex "NFS"
16862 If &[stat()]& cannot determine whether a file exists or not, delivery of
16863 the message is deferred. This can happen when NFS-mounted filesystems are
16864 unavailable.
16865
16866 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
16867 options, so you cannot use it to check for the existence of a file in which to
16868 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
16869 full list of the order in which preconditions are evaluated.) However, as
16870 these options are all expanded, you can use the &%exists%& expansion condition
16871 to make such tests. The &%require_files%& option is intended for checking files
16872 that the router may be going to use internally, or which are needed by a
16873 transport (for example &_.procmailrc_&).
16874
16875 During delivery, the &[stat()]& function is run as root, but there is a
16876 facility for some checking of the accessibility of a file by another user.
16877 This is not a proper permissions check, but just a &"rough"& check that
16878 operates as follows:
16879
16880 If an item in a &%require_files%& list does not contain any forward slash
16881 characters, it is taken to be the user (and optional group, separated by a
16882 comma) to be checked for subsequent files in the list. If no group is specified
16883 but the user is specified symbolically, the gid associated with the uid is
16884 used. For example:
16885 .code
16886 require_files = mail:/some/file
16887 require_files = $local_part:$home/.procmailrc
16888 .endd
16889 If a user or group name in a &%require_files%& list does not exist, the
16890 &%require_files%& condition fails.
16891
16892 Exim performs the check by scanning along the components of the file path, and
16893 checking the access for the given uid and gid. It checks for &"x"& access on
16894 directories, and &"r"& access on the final file. Note that this means that file
16895 access control lists, if the operating system has them, are ignored.
16896
16897 &*Warning 1*&: When the router is being run to verify addresses for an
16898 incoming SMTP message, Exim is not running as root, but under its own uid. This
16899 may affect the result of a &%require_files%& check. In particular, &[stat()]&
16900 may yield the error EACCES (&"Permission denied"&). This means that the Exim
16901 user is not permitted to read one of the directories on the file's path.
16902
16903 &*Warning 2*&: Even when Exim is running as root while delivering a message,
16904 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
16905 without root access. In this case, if a check for access by a particular user
16906 is requested, Exim creates a subprocess that runs as that user, and tries the
16907 check again in that process.
16908
16909 The default action for handling an unresolved EACCES is to consider it to
16910 be caused by a configuration error, and routing is deferred because the
16911 existence or non-existence of the file cannot be determined. However, in some
16912 circumstances it may be desirable to treat this condition as if the file did
16913 not exist. If the file name (or the exclamation mark that precedes the file
16914 name for non-existence) is preceded by a plus sign, the EACCES error is treated
16915 as if the file did not exist. For example:
16916 .code
16917 require_files = +/some/file
16918 .endd
16919 If the router is not an essential part of verification (for example, it
16920 handles users' &_.forward_& files), another solution is to set the &%verify%&
16921 option false so that the router is skipped when verifying.
16922
16923
16924
16925 .option retry_use_local_part routers boolean "see below"
16926 .cindex "hints database" "retry keys"
16927 .cindex "local part" "in retry keys"
16928 When a delivery suffers a temporary routing failure, a retry record is created
16929 in Exim's hints database. For addresses whose routing depends only on the
16930 domain, the key for the retry record should not involve the local part, but for
16931 other addresses, both the domain and the local part should be included.
16932 Usually, remote routing is of the former kind, and local routing is of the
16933 latter kind.
16934
16935 This option controls whether the local part is used to form the key for retry
16936 hints for addresses that suffer temporary errors while being handled by this
16937 router. The default value is true for any router that has &%check_local_user%&
16938 set, and false otherwise. Note that this option does not apply to hints keys
16939 for transport delays; they are controlled by a generic transport option of the
16940 same name.
16941
16942 The setting of &%retry_use_local_part%& applies only to the router on which it
16943 appears. If the router generates child addresses, they are routed
16944 independently; this setting does not become attached to them.
16945
16946
16947
16948 .option router_home_directory routers string&!! unset
16949 .cindex "router" "home directory for"
16950 .cindex "home directory" "for router"
16951 .vindex "&$home$&"
16952 This option sets a home directory for use while the router is running. (Compare
16953 &%transport_home_directory%&, which sets a home directory for later
16954 transporting.) In particular, if used on a &(redirect)& router, this option
16955 sets a value for &$home$& while a filter is running. The value is expanded;
16956 forced expansion failure causes the option to be ignored &-- other failures
16957 cause the router to defer.
16958
16959 Expansion of &%router_home_directory%& happens immediately after the
16960 &%check_local_user%& test (if configured), before any further expansions take
16961 place.
16962 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16963 are evaluated.)
16964 While the router is running, &%router_home_directory%& overrides the value of
16965 &$home$& that came from &%check_local_user%&.
16966
16967 When a router accepts an address and assigns it to a local transport (including
16968 the cases when a &(redirect)& router generates a pipe, file, or autoreply
16969 delivery), the home directory setting for the transport is taken from the first
16970 of these values that is set:
16971
16972 .ilist
16973 The &%home_directory%& option on the transport;
16974 .next
16975 The &%transport_home_directory%& option on the router;
16976 .next
16977 The password data if &%check_local_user%& is set on the router;
16978 .next
16979 The &%router_home_directory%& option on the router.
16980 .endlist
16981
16982 In other words, &%router_home_directory%& overrides the password data for the
16983 router, but not for the transport.
16984
16985
16986
16987 .option self routers string freeze
16988 .cindex "MX record" "pointing to local host"
16989 .cindex "local host" "MX pointing to"
16990 This option applies to those routers that use a recipient address to find a
16991 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
16992 and &(manualroute)& routers.
16993 Certain configurations of the &(queryprogram)& router can also specify a list
16994 of remote hosts.
16995 Usually such routers are configured to send the message to a remote host via an
16996 &(smtp)& transport. The &%self%& option specifies what happens when the first
16997 host on the list turns out to be the local host.
16998 The way in which Exim checks for the local host is described in section
16999 &<<SECTreclocipadd>>&.
17000
17001 Normally this situation indicates either an error in Exim's configuration (for
17002 example, the router should be configured not to process this domain), or an
17003 error in the DNS (for example, the MX should not point to this host). For this
17004 reason, the default action is to log the incident, defer the address, and
17005 freeze the message. The following alternatives are provided for use in special
17006 cases:
17007
17008 .vlist
17009 .vitem &%defer%&
17010 Delivery of the message is tried again later, but the message is not frozen.
17011
17012 .vitem "&%reroute%&: <&'domain'&>"
17013 The domain is changed to the given domain, and the address is passed back to
17014 be reprocessed by the routers. No rewriting of headers takes place. This
17015 behaviour is essentially a redirection.
17016
17017 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17018 The domain is changed to the given domain, and the address is passed back to be
17019 reprocessed by the routers. Any headers that contain the original domain are
17020 rewritten.
17021
17022 .vitem &%pass%&
17023 .oindex "&%more%&"
17024 .vindex "&$self_hostname$&"
17025 The router passes the address to the next router, or to the router named in the
17026 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17027 subsequent routing and delivery, the variable &$self_hostname$& contains the
17028 name of the local host that the router encountered. This can be used to
17029 distinguish between different cases for hosts with multiple names. The
17030 combination
17031 .code
17032 self = pass
17033 no_more
17034 .endd
17035 ensures that only those addresses that routed to the local host are passed on.
17036 Without &%no_more%&, addresses that were declined for other reasons would also
17037 be passed to the next router.
17038
17039 .vitem &%fail%&
17040 Delivery fails and an error report is generated.
17041
17042 .vitem &%send%&
17043 .cindex "local host" "sending to"
17044 The anomaly is ignored and the address is queued for the transport. This
17045 setting should be used with extreme caution. For an &(smtp)& transport, it
17046 makes sense only in cases where the program that is listening on the SMTP port
17047 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17048 different configuration file that handles the domain in another way.
17049 .endlist
17050
17051
17052
17053 .option senders routers&!? "address list&!!" unset
17054 .cindex "router" "checking senders"
17055 If this option is set, the router is skipped unless the message's sender
17056 address matches something on the list.
17057 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17058 are evaluated.
17059
17060 There are issues concerning verification when the running of routers is
17061 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17062 setting, it sets the sender to the null string. When using the &%-bt%& option
17063 to check a configuration file, it is necessary also to use the &%-f%& option to
17064 set an appropriate sender. For incoming mail, the sender is unset when
17065 verifying the sender, but is available when verifying any recipients. If the
17066 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17067 matters.
17068
17069
17070 .option translate_ip_address routers string&!! unset
17071 .cindex "IP address" "translating"
17072 .cindex "packet radio"
17073 .cindex "router" "IP address translation"
17074 There exist some rare networking situations (for example, packet radio) where
17075 it is helpful to be able to translate IP addresses generated by normal routing
17076 mechanisms into other IP addresses, thus performing a kind of manual IP
17077 routing. This should be done only if the normal IP routing of the TCP/IP stack
17078 is inadequate or broken. Because this is an extremely uncommon requirement, the
17079 code to support this option is not included in the Exim binary unless
17080 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17081
17082 .vindex "&$host_address$&"
17083 The &%translate_ip_address%& string is expanded for every IP address generated
17084 by the router, with the generated address set in &$host_address$&. If the
17085 expansion is forced to fail, no action is taken.
17086 For any other expansion error, delivery of the message is deferred.
17087 If the result of the expansion is an IP address, that replaces the original
17088 address; otherwise the result is assumed to be a host name &-- this is looked
17089 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17090 produce one or more replacement IP addresses. For example, to subvert all IP
17091 addresses in some specific networks, this could be added to a router:
17092 .code
17093 translate_ip_address = \
17094   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17095     {$value}fail}}
17096 .endd
17097 The file would contain lines like
17098 .code
17099 10.2.3.128/26    some.host
17100 10.8.4.34/26     10.44.8.15
17101 .endd
17102 You should not make use of this facility unless you really understand what you
17103 are doing.
17104
17105
17106
17107 .option transport routers string&!! unset
17108 This option specifies the transport to be used when a router accepts an address
17109 and sets it up for delivery. A transport is never needed if a router is used
17110 only for verification. The value of the option is expanded at routing time,
17111 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17112 and result must be the name of one of the configured transports. If it is not,
17113 delivery is deferred.
17114
17115 The &%transport%& option is not used by the &(redirect)& router, but it does
17116 have some private options that set up transports for pipe and file deliveries
17117 (see chapter &<<CHAPredirect>>&).
17118
17119
17120
17121 .option transport_current_directory routers string&!! unset
17122 .cindex "current directory for local transport"
17123 This option associates a current directory with any address that is routed
17124 to a local transport. This can happen either because a transport is
17125 explicitly configured for the router, or because it generates a delivery to a
17126 file or a pipe. During the delivery process (that is, at transport time), this
17127 option string is expanded and is set as the current directory, unless
17128 overridden by a setting on the transport.
17129 If the expansion fails for any reason, including forced failure, an error is
17130 logged, and delivery is deferred.
17131 See chapter &<<CHAPenvironment>>& for details of the local delivery
17132 environment.
17133
17134
17135
17136
17137 .option transport_home_directory routers string&!! "see below"
17138 .cindex "home directory" "for local transport"
17139 This option associates a home directory with any address that is routed to a
17140 local transport. This can happen either because a transport is explicitly
17141 configured for the router, or because it generates a delivery to a file or a
17142 pipe. During the delivery process (that is, at transport time), the option
17143 string is expanded and is set as the home directory, unless overridden by a
17144 setting of &%home_directory%& on the transport.
17145 If the expansion fails for any reason, including forced failure, an error is
17146 logged, and delivery is deferred.
17147
17148 If the transport does not specify a home directory, and
17149 &%transport_home_directory%& is not set for the router, the home directory for
17150 the transport is taken from the password data if &%check_local_user%& is set for
17151 the router. Otherwise it is taken from &%router_home_directory%& if that option
17152 is set; if not, no home directory is set for the transport.
17153
17154 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17155 environment.
17156
17157
17158
17159
17160 .option unseen routers boolean&!! false
17161 .cindex "router" "carrying on after success"
17162 The result of string expansion for this option must be a valid boolean value,
17163 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17164 result causes an error, and delivery is deferred. If the expansion is forced to
17165 fail, the default value for the option (false) is used. Other failures cause
17166 delivery to be deferred.
17167
17168 When this option is set true, routing does not cease if the router accepts the
17169 address. Instead, a copy of the incoming address is passed to the next router,
17170 overriding a false setting of &%more%&. There is little point in setting
17171 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17172 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17173 sometimes true and sometimes false).
17174
17175 .cindex "copy of message (&%unseen%& option)"
17176 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17177 qualifier in filter files. It can be used to cause copies of messages to be
17178 delivered to some other destination, while also carrying out a normal delivery.
17179 In effect, the current address is made into a &"parent"& that has two children
17180 &-- one that is delivered as specified by this router, and a clone that goes on
17181 to be routed further. For this reason, &%unseen%& may not be combined with the
17182 &%one_time%& option in a &(redirect)& router.
17183
17184 &*Warning*&: Header lines added to the address (or specified for removal) by
17185 this router or by previous routers affect the &"unseen"& copy of the message
17186 only. The clone that continues to be processed by further routers starts with
17187 no added headers and none specified for removal. For a &%redirect%& router, if
17188 a generated address is the same as the incoming address, this can lead to
17189 duplicate addresses with different header modifications. Exim does not do
17190 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17191 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17192 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17193 &%redirect%& router may be of help.
17194
17195 Unlike the handling of header modifications, any data that was set by the
17196 &%address_data%& option in the current or previous routers &'is'& passed on to
17197 subsequent routers.
17198
17199
17200 .option user routers string&!! "see below"
17201 .cindex "uid (user id)" "local delivery"
17202 .cindex "local transports" "uid and gid"
17203 .cindex "transport" "local"
17204 .cindex "router" "user for filter processing"
17205 .cindex "filter" "user for processing"
17206 When a router queues an address for a transport, and the transport does not
17207 specify a user, the user given here is used when running the delivery process.
17208 The user may be specified numerically or by name. If expansion fails, the
17209 error is logged and delivery is deferred.
17210 This user is also used by the &(redirect)& router when running a filter file.
17211 The default is unset, except when &%check_local_user%& is set. In this case,
17212 the default is taken from the password information. If the user is specified as
17213 a name, and &%group%& is not set, the group associated with the user is used.
17214 See also &%initgroups%& and &%group%& and the discussion in chapter
17215 &<<CHAPenvironment>>&.
17216
17217
17218
17219 .option verify routers&!? boolean true
17220 Setting this option has the effect of setting &%verify_sender%& and
17221 &%verify_recipient%& to the same value.
17222
17223
17224 .option verify_only routers&!? boolean false
17225 .cindex "EXPN" "with &%verify_only%&"
17226 .oindex "&%-bv%&"
17227 .cindex "router" "used only when verifying"
17228 If this option is set, the router is used only when verifying an address or
17229 testing with the &%-bv%& option, not when actually doing a delivery, testing
17230 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17231 restricted to verifying only senders or recipients by means of
17232 &%verify_sender%& and &%verify_recipient%&.
17233
17234 &*Warning*&: When the router is being run to verify addresses for an incoming
17235 SMTP message, Exim is not running as root, but under its own uid. If the router
17236 accesses any files, you need to make sure that they are accessible to the Exim
17237 user or group.
17238
17239
17240 .option verify_recipient routers&!? boolean true
17241 If this option is false, the router is skipped when verifying recipient
17242 addresses
17243 or testing recipient verification using &%-bv%&.
17244 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17245 are evaluated.
17246
17247
17248 .option verify_sender routers&!? boolean true
17249 If this option is false, the router is skipped when verifying sender addresses
17250 or testing sender verification using &%-bvs%&.
17251 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17252 are evaluated.
17253 .ecindex IIDgenoprou1
17254 .ecindex IIDgenoprou2
17255
17256
17257
17258
17259
17260
17261 . ////////////////////////////////////////////////////////////////////////////
17262 . ////////////////////////////////////////////////////////////////////////////
17263
17264 .chapter "The accept router" "CHID4"
17265 .cindex "&(accept)& router"
17266 .cindex "routers" "&(accept)&"
17267 The &(accept)& router has no private options of its own. Unless it is being
17268 used purely for verification (see &%verify_only%&) a transport is required to
17269 be defined by the generic &%transport%& option. If the preconditions that are
17270 specified by generic options are met, the router accepts the address and queues
17271 it for the given transport. The most common use of this router is for setting
17272 up deliveries to local mailboxes. For example:
17273 .code
17274 localusers:
17275   driver = accept
17276   domains = mydomain.example
17277   check_local_user
17278   transport = local_delivery
17279 .endd
17280 The &%domains%& condition in this example checks the domain of the address, and
17281 &%check_local_user%& checks that the local part is the login of a local user.
17282 When both preconditions are met, the &(accept)& router runs, and queues the
17283 address for the &(local_delivery)& transport.
17284
17285
17286
17287
17288
17289
17290 . ////////////////////////////////////////////////////////////////////////////
17291 . ////////////////////////////////////////////////////////////////////////////
17292
17293 .chapter "The dnslookup router" "CHAPdnslookup"
17294 .scindex IIDdnsrou1 "&(dnslookup)& router"
17295 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17296 The &(dnslookup)& router looks up the hosts that handle mail for the
17297 recipient's domain in the DNS. A transport must always be set for this router,
17298 unless &%verify_only%& is set.
17299
17300 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17301 SRV records. If none are found, or if SRV support is not configured,
17302 MX records are looked up. If no MX records exist, address records are sought.
17303 However, &%mx_domains%& can be set to disable the direct use of address
17304 records.
17305
17306 MX records of equal priority are sorted by Exim into a random order. Exim then
17307 looks for address records for the host names obtained from MX or SRV records.
17308 When a host has more than one IP address, they are sorted into a random order,
17309 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17310 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17311 generic option, the router declines.
17312
17313 Unless they have the highest priority (lowest MX value), MX records that point
17314 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17315 are discarded, together with any other MX records of equal or lower priority.
17316
17317 .cindex "MX record" "pointing to local host"
17318 .cindex "local host" "MX pointing to"
17319 .oindex "&%self%&" "in &(dnslookup)& router"
17320 If the host pointed to by the highest priority MX record, or looked up as an
17321 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17322 happens is controlled by the generic &%self%& option.
17323
17324
17325 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17326 There have been problems with DNS servers when SRV records are looked up.
17327 Some mis-behaving servers return a DNS error or timeout when a non-existent
17328 SRV record is sought. Similar problems have in the past been reported for
17329 MX records. The global &%dns_again_means_nonexist%& option can help with this
17330 problem, but it is heavy-handed because it is a global option.
17331
17332 For this reason, there are two options, &%srv_fail_domains%& and
17333 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17334 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17335 an attempt to look up an SRV or MX record causes one of these results, and the
17336 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17337 such record"&. In the case of an SRV lookup, this means that the router
17338 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17339 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17340 case routing fails.
17341
17342
17343 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17344 .cindex "&(dnslookup)& router" "declines"
17345 There are a few cases where a &(dnslookup)& router will decline to accept
17346 an address; if such a router is expected to handle "all remaining non-local
17347 domains", then it is important to set &%no_more%&.
17348
17349 Reasons for a &(dnslookup)& router to decline currently include:
17350 .ilist
17351 The domain does not exist in DNS
17352 .next
17353 The domain exists but the MX record's host part is just "."; this is a common
17354 convention (borrowed from SRV) used to indicate that there is no such service
17355 for this domain and to not fall back to trying A/AAAA records.
17356 .next
17357 Ditto, but for SRV records, when &%check_srv%& is set on this router.
17358 .next
17359 MX record points to a non-existent host.
17360 .next
17361 MX record points to an IP address and the main section option
17362 &%allow_mx_to_ip%& is not set.
17363 .next
17364 MX records exist and point to valid hosts, but all hosts resolve only to
17365 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
17366 .next
17367 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
17368 &%dns_check_names_pattern%& for handling one variant of this)
17369 .next
17370 &%check_secondary_mx%& is set on this router but the local host can
17371 not be found in the MX records (see below)
17372 .endlist
17373
17374
17375
17376
17377 .section "Private options for dnslookup" "SECID118"
17378 .cindex "options" "&(dnslookup)& router"
17379 The private options for the &(dnslookup)& router are as follows:
17380
17381 .option check_secondary_mx dnslookup boolean false
17382 .cindex "MX record" "checking for secondary"
17383 If this option is set, the router declines unless the local host is found in
17384 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17385 process domains for which the local host is a secondary mail exchanger
17386 differently to other domains. The way in which Exim decides whether a host is
17387 the local host is described in section &<<SECTreclocipadd>>&.
17388
17389
17390 .option check_srv dnslookup string&!! unset
17391 .cindex "SRV record" "enabling use of"
17392 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
17393 addition to MX and address records. The support is disabled by default. To
17394 enable SRV support, set the &%check_srv%& option to the name of the service
17395 required. For example,
17396 .code
17397 check_srv = smtp
17398 .endd
17399 looks for SRV records that refer to the normal smtp service. The option is
17400 expanded, so the service name can vary from message to message or address
17401 to address. This might be helpful if SRV records are being used for a
17402 submission service. If the expansion is forced to fail, the &%check_srv%&
17403 option is ignored, and the router proceeds to look for MX records in the
17404 normal way.
17405
17406 When the expansion succeeds, the router searches first for SRV records for
17407 the given service (it assumes TCP protocol). A single SRV record with a
17408 host name that consists of just a single dot indicates &"no such service for
17409 this domain"&; if this is encountered, the router declines. If other kinds of
17410 SRV record are found, they are used to construct a host list for delivery
17411 according to the rules of RFC 2782. MX records are not sought in this case.
17412
17413 When no SRV records are found, MX records (and address records) are sought in
17414 the traditional way. In other words, SRV records take precedence over MX
17415 records, just as MX records take precedence over address records. Note that
17416 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
17417 defined it. It is apparently believed that MX records are sufficient for email
17418 and that SRV records should not be used for this purpose. However, SRV records
17419 have an additional &"weight"& feature which some people might find useful when
17420 trying to split an SMTP load between hosts of different power.
17421
17422 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
17423 when there is a DNS lookup error.
17424
17425
17426
17427 .option mx_domains dnslookup "domain list&!!" unset
17428 .cindex "MX record" "required to exist"
17429 .cindex "SRV record" "required to exist"
17430 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
17431 record in order to be recognized. (The name of this option could be improved.)
17432 For example, if all the mail hosts in &'fict.example'& are known to have MX
17433 records, except for those in &'discworld.fict.example'&, you could use this
17434 setting:
17435 .code
17436 mx_domains = ! *.discworld.fict.example : *.fict.example
17437 .endd
17438 This specifies that messages addressed to a domain that matches the list but
17439 has no MX record should be bounced immediately instead of being routed using
17440 the address record.
17441
17442
17443 .option mx_fail_domains dnslookup "domain list&!!" unset
17444 If the DNS lookup for MX records for one of the domains in this list causes a
17445 DNS lookup error, Exim behaves as if no MX records were found. See section
17446 &<<SECTprowitdnsloo>>& for more discussion.
17447
17448
17449
17450
17451 .option qualify_single dnslookup boolean true
17452 .cindex "DNS" "resolver options"
17453 .cindex "DNS" "qualifying single-component names"
17454 When this option is true, the resolver option RES_DEFNAMES is set for DNS
17455 lookups. Typically, but not standardly, this causes the resolver to qualify
17456 single-component names with the default domain. For example, on a machine
17457 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
17458 &'thesaurus.ref.example'& inside the resolver. For details of what your
17459 resolver actually does, consult your man pages for &'resolver'& and
17460 &'resolv.conf'&.
17461
17462
17463
17464 .option rewrite_headers dnslookup boolean true
17465 .cindex "rewriting" "header lines"
17466 .cindex "header lines" "rewriting"
17467 If the domain name in the address that is being processed is not fully
17468 qualified, it may be expanded to its full form by a DNS lookup. For example, if
17469 an address is specified as &'dormouse@teaparty'&, the domain might be
17470 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
17471 occur as a result of setting the &%widen_domains%& option. If
17472 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
17473 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
17474 header lines of the message are rewritten with the full domain name.
17475
17476 This option should be turned off only when it is known that no message is
17477 ever going to be sent outside an environment where the abbreviation makes
17478 sense.
17479
17480 When an MX record is looked up in the DNS and matches a wildcard record, name
17481 servers normally return a record containing the name that has been looked up,
17482 making it impossible to detect whether a wildcard was present or not. However,
17483 some name servers have recently been seen to return the wildcard entry. If the
17484 name returned by a DNS lookup begins with an asterisk, it is not used for
17485 header rewriting.
17486
17487
17488 .option same_domain_copy_routing dnslookup boolean false
17489 .cindex "address" "copying routing"
17490 Addresses with the same domain are normally routed by the &(dnslookup)& router
17491 to the same list of hosts. However, this cannot be presumed, because the router
17492 options and preconditions may refer to the local part of the address. By
17493 default, therefore, Exim routes each address in a message independently. DNS
17494 servers run caches, so repeated DNS lookups are not normally expensive, and in
17495 any case, personal messages rarely have more than a few recipients.
17496
17497 If you are running mailing lists with large numbers of subscribers at the same
17498 domain, and you are using a &(dnslookup)& router which is independent of the
17499 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17500 lookups for identical domains in one message. In this case, when &(dnslookup)&
17501 routes an address to a remote transport, any other unrouted addresses in the
17502 message that have the same domain are automatically given the same routing
17503 without processing them independently,
17504 provided the following conditions are met:
17505
17506 .ilist
17507 No router that processed the address specified &%headers_add%& or
17508 &%headers_remove%&.
17509 .next
17510 The router did not change the address in any way, for example, by &"widening"&
17511 the domain.
17512 .endlist
17513
17514
17515
17516
17517 .option search_parents dnslookup boolean false
17518 .cindex "DNS" "resolver options"
17519 When this option is true, the resolver option RES_DNSRCH is set for DNS
17520 lookups. This is different from the &%qualify_single%& option in that it
17521 applies to domains containing dots. Typically, but not standardly, it causes
17522 the resolver to search for the name in the current domain and in parent
17523 domains. For example, on a machine in the &'fict.example'& domain, if looking
17524 up &'teaparty.wonderland'& failed, the resolver would try
17525 &'teaparty.wonderland.fict.example'&. For details of what your resolver
17526 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
17527
17528 Setting this option true can cause problems in domains that have a wildcard MX
17529 record, because any domain that does not have its own MX record matches the
17530 local wildcard.
17531
17532
17533
17534 .option srv_fail_domains dnslookup "domain list&!!" unset
17535 If the DNS lookup for SRV records for one of the domains in this list causes a
17536 DNS lookup error, Exim behaves as if no SRV records were found. See section
17537 &<<SECTprowitdnsloo>>& for more discussion.
17538
17539
17540
17541
17542 .option widen_domains dnslookup "string list" unset
17543 .cindex "domain" "partial; widening"
17544 If a DNS lookup fails and this option is set, each of its strings in turn is
17545 added onto the end of the domain, and the lookup is tried again. For example,
17546 if
17547 .code
17548 widen_domains = fict.example:ref.example
17549 .endd
17550 is set and a lookup of &'klingon.dictionary'& fails,
17551 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
17552 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
17553 and &%search_parents%& options can cause some widening to be undertaken inside
17554 the DNS resolver. &%widen_domains%& is not applied to sender addresses
17555 when verifying, unless &%rewrite_headers%& is false (not the default).
17556
17557
17558 .section "Effect of qualify_single and search_parents" "SECID119"
17559 When a domain from an envelope recipient is changed by the resolver as a result
17560 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
17561 corresponding address in the message's header lines unless &%rewrite_headers%&
17562 is set false. Exim then re-routes the address, using the full domain.
17563
17564 These two options affect only the DNS lookup that takes place inside the router
17565 for the domain of the address that is being routed. They do not affect lookups
17566 such as that implied by
17567 .code
17568 domains = @mx_any
17569 .endd
17570 that may happen while processing a router precondition before the router is
17571 entered. No widening ever takes place for these lookups.
17572 .ecindex IIDdnsrou1
17573 .ecindex IIDdnsrou2
17574
17575
17576
17577
17578
17579
17580
17581
17582
17583 . ////////////////////////////////////////////////////////////////////////////
17584 . ////////////////////////////////////////////////////////////////////////////
17585
17586 .chapter "The ipliteral router" "CHID5"
17587 .cindex "&(ipliteral)& router"
17588 .cindex "domain literal" "routing"
17589 .cindex "routers" "&(ipliteral)&"
17590 This router has no private options. Unless it is being used purely for
17591 verification (see &%verify_only%&) a transport is required to be defined by the
17592 generic &%transport%& option. The router accepts the address if its domain part
17593 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
17594 router handles the address
17595 .code
17596 root@[192.168.1.1]
17597 .endd
17598 by setting up delivery to the host with that IP address. IPv4 domain literals
17599 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
17600 are similar, but the address is preceded by &`ipv6:`&. For example:
17601 .code
17602 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
17603 .endd
17604 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
17605 grounds that sooner or later somebody will try it.
17606
17607 .oindex "&%self%&" "in &(ipliteral)& router"
17608 If the IP address matches something in &%ignore_target_hosts%&, the router
17609 declines. If an IP literal turns out to refer to the local host, the generic
17610 &%self%& option determines what happens.
17611
17612 The RFCs require support for domain literals; however, their use is
17613 controversial in today's Internet. If you want to use this router, you must
17614 also set the main configuration option &%allow_domain_literals%&. Otherwise,
17615 Exim will not recognize the domain literal syntax in addresses.
17616
17617
17618
17619 . ////////////////////////////////////////////////////////////////////////////
17620 . ////////////////////////////////////////////////////////////////////////////
17621
17622 .chapter "The iplookup router" "CHID6"
17623 .cindex "&(iplookup)& router"
17624 .cindex "routers" "&(iplookup)&"
17625 The &(iplookup)& router was written to fulfil a specific requirement in
17626 Cambridge University (which in fact no longer exists). For this reason, it is
17627 not included in the binary of Exim by default. If you want to include it, you
17628 must set
17629 .code
17630 ROUTER_IPLOOKUP=yes
17631 .endd
17632 in your &_Local/Makefile_& configuration file.
17633
17634 The &(iplookup)& router routes an address by sending it over a TCP or UDP
17635 connection to one or more specific hosts. The host can then return the same or
17636 a different address &-- in effect rewriting the recipient address in the
17637 message's envelope. The new address is then passed on to subsequent routers. If
17638 this process fails, the address can be passed on to other routers, or delivery
17639 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
17640 must not be specified for it.
17641
17642 .cindex "options" "&(iplookup)& router"
17643 .option hosts iplookup string unset
17644 This option must be supplied. Its value is a colon-separated list of host
17645 names. The hosts are looked up using &[gethostbyname()]&
17646 (or &[getipnodebyname()]& when available)
17647 and are tried in order until one responds to the query. If none respond, what
17648 happens is controlled by &%optional%&.
17649
17650
17651 .option optional iplookup boolean false
17652 If &%optional%& is true, if no response is obtained from any host, the address
17653 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
17654 delivery to the address is deferred.
17655
17656
17657 .option port iplookup integer 0
17658 .cindex "port" "&(iplookup)& router"
17659 This option must be supplied. It specifies the port number for the TCP or UDP
17660 call.
17661
17662
17663 .option protocol iplookup string udp
17664 This option can be set to &"udp"& or &"tcp"& to specify which of the two
17665 protocols is to be used.
17666
17667
17668 .option query iplookup string&!! "see below"
17669 This defines the content of the query that is sent to the remote hosts. The
17670 default value is:
17671 .code
17672 $local_part@$domain $local_part@$domain
17673 .endd
17674 The repetition serves as a way of checking that a response is to the correct
17675 query in the default case (see &%response_pattern%& below).
17676
17677
17678 .option reroute iplookup string&!! unset
17679 If this option is not set, the rerouted address is precisely the byte string
17680 returned by the remote host, up to the first white space, if any. If set, the
17681 string is expanded to form the rerouted address. It can include parts matched
17682 in the response by &%response_pattern%& by means of numeric variables such as
17683 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17684 whether or not a pattern is in use. In all cases, the rerouted address must end
17685 up in the form &'local_part@domain'&.
17686
17687
17688 .option response_pattern iplookup string unset
17689 This option can be set to a regular expression that is applied to the string
17690 returned from the remote host. If the pattern does not match the response, the
17691 router declines. If &%response_pattern%& is not set, no checking of the
17692 response is done, unless the query was defaulted, in which case there is a
17693 check that the text returned after the first white space is the original
17694 address. This checks that the answer that has been received is in response to
17695 the correct question. For example, if the response is just a new domain, the
17696 following could be used:
17697 .code
17698 response_pattern = ^([^@]+)$
17699 reroute = $local_part@$1
17700 .endd
17701
17702 .option timeout iplookup time 5s
17703 This specifies the amount of time to wait for a response from the remote
17704 machine. The same timeout is used for the &[connect()]& function for a TCP
17705 call. It does not apply to UDP.
17706
17707
17708
17709
17710 . ////////////////////////////////////////////////////////////////////////////
17711 . ////////////////////////////////////////////////////////////////////////////
17712
17713 .chapter "The manualroute router" "CHID7"
17714 .scindex IIDmanrou1 "&(manualroute)& router"
17715 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17716 .cindex "domain" "manually routing"
17717 The &(manualroute)& router is so-called because it provides a way of manually
17718 routing an address according to its domain. It is mainly used when you want to
17719 route addresses to remote hosts according to your own rules, bypassing the
17720 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17721 route to local transports, a facility that may be useful if you want to save
17722 messages for dial-in hosts in local files.
17723
17724 The &(manualroute)& router compares a list of domain patterns with the domain
17725 it is trying to route. If there is no match, the router declines. Each pattern
17726 has associated with it a list of hosts and some other optional data, which may
17727 include a transport. The combination of a pattern and its data is called a
17728 &"routing rule"&. For patterns that do not have an associated transport, the
17729 generic &%transport%& option must specify a transport, unless the router is
17730 being used purely for verification (see &%verify_only%&).
17731
17732 .vindex "&$host$&"
17733 In the case of verification, matching the domain pattern is sufficient for the
17734 router to accept the address. When actually routing an address for delivery,
17735 an address that matches a domain pattern is queued for the associated
17736 transport. If the transport is not a local one, a host list must be associated
17737 with the pattern; IP addresses are looked up for the hosts, and these are
17738 passed to the transport along with the mail address. For local transports, a
17739 host list is optional. If it is present, it is passed in &$host$& as a single
17740 text string.
17741
17742 The list of routing rules can be provided as an inline string in
17743 &%route_list%&, or the data can be obtained by looking up the domain in a file
17744 or database by setting &%route_data%&. Only one of these settings may appear in
17745 any one instance of &(manualroute)&. The format of routing rules is described
17746 below, following the list of private options.
17747
17748
17749 .section "Private options for manualroute" "SECTprioptman"
17750
17751 .cindex "options" "&(manualroute)& router"
17752 The private options for the &(manualroute)& router are as follows:
17753
17754 .option host_all_ignored manualroute string defer
17755 See &%host_find_failed%&.
17756
17757 .option host_find_failed manualroute string freeze
17758 This option controls what happens when &(manualroute)& tries to find an IP
17759 address for a host, and the host does not exist. The option can be set to one
17760 of the following values:
17761 .code
17762 decline
17763 defer
17764 fail
17765 freeze
17766 ignore
17767 pass
17768 .endd
17769 The default (&"freeze"&) assumes that this state is a serious configuration
17770 error. The difference between &"pass"& and &"decline"& is that the former
17771 forces the address to be passed to the next router (or the router defined by
17772 &%pass_router%&),
17773 .oindex "&%more%&"
17774 overriding &%no_more%&, whereas the latter passes the address to the next
17775 router only if &%more%& is true.
17776
17777 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17778 cannot be found. If all the hosts in the list are ignored, the behaviour is
17779 controlled by the &%host_all_ignored%& option. This takes the same values
17780 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17781
17782 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17783 state; if a host lookup gets a temporary error, delivery is deferred unless the
17784 generic &%pass_on_timeout%& option is set.
17785
17786
17787 .option hosts_randomize manualroute boolean false
17788 .cindex "randomized host list"
17789 .cindex "host" "list of; randomized"
17790 If this option is set, the order of the items in a host list in a routing rule
17791 is randomized each time the list is used, unless an option in the routing rule
17792 overrides (see below). Randomizing the order of a host list can be used to do
17793 crude load sharing. However, if more than one mail address is routed by the
17794 same router to the same host list, the host lists are considered to be the same
17795 (even though they may be randomized into different orders) for the purpose of
17796 deciding whether to batch the deliveries into a single SMTP transaction.
17797
17798 When &%hosts_randomize%& is true, a host list may be split
17799 into groups whose order is separately randomized. This makes it possible to
17800 set up MX-like behaviour. The boundaries between groups are indicated by an
17801 item that is just &`+`& in the host list. For example:
17802 .code
17803 route_list = * host1:host2:host3:+:host4:host5
17804 .endd
17805 The order of the first three hosts and the order of the last two hosts is
17806 randomized for each use, but the first three always end up before the last two.
17807 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
17808 randomized host list is passed to an &(smtp)& transport that also has
17809 &%hosts_randomize set%&, the list is not re-randomized.
17810
17811
17812 .option route_data manualroute string&!! unset
17813 If this option is set, it must expand to yield the data part of a routing rule.
17814 Typically, the expansion string includes a lookup based on the domain. For
17815 example:
17816 .code
17817 route_data = ${lookup{$domain}dbm{/etc/routes}}
17818 .endd
17819 If the expansion is forced to fail, or the result is an empty string, the
17820 router declines. Other kinds of expansion failure cause delivery to be
17821 deferred.
17822
17823
17824 .option route_list manualroute "string list" unset
17825 This string is a list of routing rules, in the form defined below. Note that,
17826 unlike most string lists, the items are separated by semicolons. This is so
17827 that they may contain colon-separated host lists.
17828
17829
17830 .option same_domain_copy_routing manualroute boolean false
17831 .cindex "address" "copying routing"
17832 Addresses with the same domain are normally routed by the &(manualroute)&
17833 router to the same list of hosts. However, this cannot be presumed, because the
17834 router options and preconditions may refer to the local part of the address. By
17835 default, therefore, Exim routes each address in a message independently. DNS
17836 servers run caches, so repeated DNS lookups are not normally expensive, and in
17837 any case, personal messages rarely have more than a few recipients.
17838
17839 If you are running mailing lists with large numbers of subscribers at the same
17840 domain, and you are using a &(manualroute)& router which is independent of the
17841 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17842 lookups for identical domains in one message. In this case, when
17843 &(manualroute)& routes an address to a remote transport, any other unrouted
17844 addresses in the message that have the same domain are automatically given the
17845 same routing without processing them independently. However, this is only done
17846 if &%headers_add%& and &%headers_remove%& are unset.
17847
17848
17849
17850
17851 .section "Routing rules in route_list" "SECID120"
17852 The value of &%route_list%& is a string consisting of a sequence of routing
17853 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
17854 entered as two semicolons. Alternatively, the list separator can be changed as
17855 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
17856 Empty rules are ignored. The format of each rule is
17857 .display
17858 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
17859 .endd
17860 The following example contains two rules, each with a simple domain pattern and
17861 no options:
17862 .code
17863 route_list = \
17864   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
17865   thes.ref.example  mail-3.ref.example:mail-4.ref.example
17866 .endd
17867 The three parts of a rule are separated by white space. The pattern and the
17868 list of hosts can be enclosed in quotes if necessary, and if they are, the
17869 usual quoting rules apply. Each rule in a &%route_list%& must start with a
17870 single domain pattern, which is the only mandatory item in the rule. The
17871 pattern is in the same format as one item in a domain list (see section
17872 &<<SECTdomainlist>>&),
17873 except that it may not be the name of an interpolated file.
17874 That is, it may be wildcarded, or a regular expression, or a file or database
17875 lookup (with semicolons doubled, because of the use of semicolon as a separator
17876 in a &%route_list%&).
17877
17878 The rules in &%route_list%& are searched in order until one of the patterns
17879 matches the domain that is being routed. The list of hosts and then options are
17880 then used as described below. If there is no match, the router declines. When
17881 &%route_list%& is set, &%route_data%& must not be set.
17882
17883
17884
17885 .section "Routing rules in route_data" "SECID121"
17886 The use of &%route_list%& is convenient when there are only a small number of
17887 routing rules. For larger numbers, it is easier to use a file or database to
17888 hold the routing information, and use the &%route_data%& option instead.
17889 The value of &%route_data%& is a list of hosts, followed by (optional) options.
17890 Most commonly, &%route_data%& is set as a string that contains an
17891 expansion lookup. For example, suppose we place two routing rules in a file
17892 like this:
17893 .code
17894 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
17895 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
17896 .endd
17897 This data can be accessed by setting
17898 .code
17899 route_data = ${lookup{$domain}lsearch{/the/file/name}}
17900 .endd
17901 Failure of the lookup results in an empty string, causing the router to
17902 decline. However, you do not have to use a lookup in &%route_data%&. The only
17903 requirement is that the result of expanding the string is a list of hosts,
17904 possibly followed by options, separated by white space. The list of hosts must
17905 be enclosed in quotes if it contains white space.
17906
17907
17908
17909
17910 .section "Format of the list of hosts" "SECID122"
17911 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
17912 always separately expanded before use. If the expansion fails, the router
17913 declines. The result of the expansion must be a colon-separated list of names
17914 and/or IP addresses, optionally also including ports. The format of each item
17915 in the list is described in the next section. The list separator can be changed
17916 as described in section &<<SECTlistconstruct>>&.
17917
17918 If the list of hosts was obtained from a &%route_list%& item, the following
17919 variables are set during its expansion:
17920
17921 .ilist
17922 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
17923 If the domain was matched against a regular expression, the numeric variables
17924 &$1$&, &$2$&, etc. may be set. For example:
17925 .code
17926 route_list = ^domain(\d+)   host-$1.text.example
17927 .endd
17928 .next
17929 &$0$& is always set to the entire domain.
17930 .next
17931 &$1$& is also set when partial matching is done in a file lookup.
17932
17933 .next
17934 .vindex "&$value$&"
17935 If the pattern that matched the domain was a lookup item, the data that was
17936 looked up is available in the expansion variable &$value$&. For example:
17937 .code
17938 route_list = lsearch;;/some/file.routes  $value
17939 .endd
17940 .endlist
17941
17942 Note the doubling of the semicolon in the pattern that is necessary because
17943 semicolon is the default route list separator.
17944
17945
17946
17947 .section "Format of one host item" "SECTformatonehostitem"
17948 Each item in the list of hosts is either a host name or an IP address,
17949 optionally with an attached port number. When no port is given, an IP address
17950 is not enclosed in brackets. When a port is specified, it overrides the port
17951 specification on the transport. The port is separated from the name or address
17952 by a colon. This leads to some complications:
17953
17954 .ilist
17955 Because colon is the default separator for the list of hosts, either
17956 the colon that specifies a port must be doubled, or the list separator must
17957 be changed. The following two examples have the same effect:
17958 .code
17959 route_list = * "host1.tld::1225 : host2.tld::1226"
17960 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
17961 .endd
17962 .next
17963 When IPv6 addresses are involved, it gets worse, because they contain
17964 colons of their own. To make this case easier, it is permitted to
17965 enclose an IP address (either v4 or v6) in square brackets if a port
17966 number follows. For example:
17967 .code
17968 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
17969 .endd
17970 .endlist
17971
17972 .section "How the list of hosts is used" "SECThostshowused"
17973 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
17974 the hosts is tried, in the order specified, when carrying out the SMTP
17975 delivery. However, the order can be changed by setting the &%hosts_randomize%&
17976 option, either on the router (see section &<<SECTprioptman>>& above), or on the
17977 transport.
17978
17979 Hosts may be listed by name or by IP address. An unadorned name in the list of
17980 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
17981 interpreted as an indirection to a sublist of hosts obtained by looking up MX
17982 records in the DNS. For example:
17983 .code
17984 route_list = *  x.y.z:p.q.r/MX:e.f.g
17985 .endd
17986 If this feature is used with a port specifier, the port must come last. For
17987 example:
17988 .code
17989 route_list = *  dom1.tld/mx::1225
17990 .endd
17991 If the &%hosts_randomize%& option is set, the order of the items in the list is
17992 randomized before any lookups are done. Exim then scans the list; for any name
17993 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
17994 be an interface on the local host and the item is not the first in the list,
17995 Exim discards it and any subsequent items. If it is the first item, what
17996 happens is controlled by the
17997 .oindex "&%self%&" "in &(manualroute)& router"
17998 &%self%& option of the router.
17999
18000 A name on the list that is followed by &`/MX`& is replaced with the list of
18001 hosts obtained by looking up MX records for the name. This is always a DNS
18002 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18003 below) are not relevant here. The order of these hosts is determined by the
18004 preference values in the MX records, according to the usual rules. Because
18005 randomizing happens before the MX lookup, it does not affect the order that is
18006 defined by MX preferences.
18007
18008 If the local host is present in the sublist obtained from MX records, but is
18009 not the most preferred host in that list, it and any equally or less
18010 preferred hosts are removed before the sublist is inserted into the main list.
18011
18012 If the local host is the most preferred host in the MX list, what happens
18013 depends on where in the original list of hosts the &`/MX`& item appears. If it
18014 is not the first item (that is, there are previous hosts in the main list),
18015 Exim discards this name and any subsequent items in the main list.
18016
18017 If the MX item is first in the list of hosts, and the local host is the
18018 most preferred host, what happens is controlled by the &%self%& option of the
18019 router.
18020
18021 DNS failures when lookup up the MX records are treated in the same way as DNS
18022 failures when looking up IP addresses: &%pass_on_timeout%& and
18023 &%host_find_failed%& are used when relevant.
18024
18025 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18026 whether obtained from an MX lookup or not.
18027
18028
18029
18030 .section "How the options are used" "SECThowoptused"
18031 The options are a sequence of words; in practice no more than three are ever
18032 present. One of the words can be the name of a transport; this overrides the
18033 &%transport%& option on the router for this particular routing rule only. The
18034 other words (if present) control randomization of the list of hosts on a
18035 per-rule basis, and how the IP addresses of the hosts are to be found when
18036 routing to a remote transport. These options are as follows:
18037
18038 .ilist
18039 &%randomize%&: randomize the order of the hosts in this list, overriding the
18040 setting of &%hosts_randomize%& for this routing rule only.
18041 .next
18042 &%no_randomize%&: do not randomize the order of the hosts in this list,
18043 overriding the setting of &%hosts_randomize%& for this routing rule only.
18044 .next
18045 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18046 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18047 also look in &_/etc/hosts_& or other sources of information.
18048 .next
18049 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18050 no address records are found. If there is a temporary DNS error (such as a
18051 timeout), delivery is deferred.
18052 .endlist
18053
18054 For example:
18055 .code
18056 route_list = domain1  host1:host2:host3  randomize bydns;\
18057              domain2  host4:host5
18058 .endd
18059 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18060 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18061 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18062 or &[gethostbyname()]&, and the result of the lookup is the result of that
18063 call.
18064
18065 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18066 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18067 instead of TRY_AGAIN. That is why the default action is to try a DNS
18068 lookup first. Only if that gives a definite &"no such host"& is the local
18069 function called.
18070
18071
18072
18073 If no IP address for a host can be found, what happens is controlled by the
18074 &%host_find_failed%& option.
18075
18076 .vindex "&$host$&"
18077 When an address is routed to a local transport, IP addresses are not looked up.
18078 The host list is passed to the transport in the &$host$& variable.
18079
18080
18081
18082 .section "Manualroute examples" "SECID123"
18083 In some of the examples that follow, the presence of the &%remote_smtp%&
18084 transport, as defined in the default configuration file, is assumed:
18085
18086 .ilist
18087 .cindex "smart host" "example router"
18088 The &(manualroute)& router can be used to forward all external mail to a
18089 &'smart host'&. If you have set up, in the main part of the configuration, a
18090 named domain list that contains your local domains, for example:
18091 .code
18092 domainlist local_domains = my.domain.example
18093 .endd
18094 You can arrange for all other domains to be routed to a smart host by making
18095 your first router something like this:
18096 .code
18097 smart_route:
18098   driver = manualroute
18099   domains = !+local_domains
18100   transport = remote_smtp
18101   route_list = * smarthost.ref.example
18102 .endd
18103 This causes all non-local addresses to be sent to the single host
18104 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18105 they are tried in order
18106 (but you can use &%hosts_randomize%& to vary the order each time).
18107 Another way of configuring the same thing is this:
18108 .code
18109 smart_route:
18110   driver = manualroute
18111   transport = remote_smtp
18112   route_list = !+local_domains  smarthost.ref.example
18113 .endd
18114 There is no difference in behaviour between these two routers as they stand.
18115 However, they behave differently if &%no_more%& is added to them. In the first
18116 example, the router is skipped if the domain does not match the &%domains%&
18117 precondition; the following router is always tried. If the router runs, it
18118 always matches the domain and so can never decline. Therefore, &%no_more%&
18119 would have no effect. In the second case, the router is never skipped; it
18120 always runs. However, if it doesn't match the domain, it declines. In this case
18121 &%no_more%& would prevent subsequent routers from running.
18122
18123 .next
18124 .cindex "mail hub example"
18125 A &'mail hub'& is a host which receives mail for a number of domains via MX
18126 records in the DNS and delivers it via its own private routing mechanism. Often
18127 the final destinations are behind a firewall, with the mail hub being the one
18128 machine that can connect to machines both inside and outside the firewall. The
18129 &(manualroute)& router is usually used on a mail hub to route incoming messages
18130 to the correct hosts. For a small number of domains, the routing can be inline,
18131 using the &%route_list%& option, but for a larger number a file or database
18132 lookup is easier to manage.
18133
18134 If the domain names are in fact the names of the machines to which the mail is
18135 to be sent by the mail hub, the configuration can be quite simple. For
18136 example:
18137 .code
18138 hub_route:
18139   driver = manualroute
18140   transport = remote_smtp
18141   route_list = *.rhodes.tvs.example  $domain
18142 .endd
18143 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18144 whose names are the same as the mail domains. A similar approach can be taken
18145 if the host name can be obtained from the domain name by a string manipulation
18146 that the expansion facilities can handle. Otherwise, a lookup based on the
18147 domain can be used to find the host:
18148 .code
18149 through_firewall:
18150   driver = manualroute
18151   transport = remote_smtp
18152   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18153 .endd
18154 The result of the lookup must be the name or IP address of the host (or
18155 hosts) to which the address is to be routed. If the lookup fails, the route
18156 data is empty, causing the router to decline. The address then passes to the
18157 next router.
18158
18159 .next
18160 .cindex "batched SMTP output example"
18161 .cindex "SMTP" "batched outgoing; example"
18162 You can use &(manualroute)& to deliver messages to pipes or files in batched
18163 SMTP format for onward transportation by some other means. This is one way of
18164 storing mail for a dial-up host when it is not connected. The route list entry
18165 can be as simple as a single domain name in a configuration like this:
18166 .code
18167 save_in_file:
18168   driver = manualroute
18169   transport = batchsmtp_appendfile
18170   route_list = saved.domain.example
18171 .endd
18172 though often a pattern is used to pick up more than one domain. If there are
18173 several domains or groups of domains with different transport requirements,
18174 different transports can be listed in the routing information:
18175 .code
18176 save_in_file:
18177   driver = manualroute
18178   route_list = \
18179     *.saved.domain1.example  $domain  batch_appendfile; \
18180     *.saved.domain2.example  \
18181       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18182       batch_pipe
18183 .endd
18184 .vindex "&$domain$&"
18185 .vindex "&$host$&"
18186 The first of these just passes the domain in the &$host$& variable, which
18187 doesn't achieve much (since it is also in &$domain$&), but the second does a
18188 file lookup to find a value to pass, causing the router to decline to handle
18189 the address if the lookup fails.
18190
18191 .next
18192 .cindex "UUCP" "example of router for"
18193 Routing mail directly to UUCP software is a specific case of the use of
18194 &(manualroute)& in a gateway to another mail environment. This is an example of
18195 one way it can be done:
18196 .code
18197 # Transport
18198 uucp:
18199   driver = pipe
18200   user = nobody
18201   command = /usr/local/bin/uux -r - \
18202     ${substr_-5:$host}!rmail ${local_part}
18203   return_fail_output = true
18204
18205 # Router
18206 uucphost:
18207   transport = uucp
18208   driver = manualroute
18209   route_data = \
18210     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18211 .endd
18212 The file &_/usr/local/exim/uucphosts_& contains entries like
18213 .code
18214 darksite.ethereal.example:           darksite.UUCP
18215 .endd
18216 It can be set up more simply without adding and removing &".UUCP"& but this way
18217 makes clear the distinction between the domain name
18218 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18219 .endlist
18220 .ecindex IIDmanrou1
18221 .ecindex IIDmanrou2
18222
18223
18224
18225
18226
18227
18228
18229
18230 . ////////////////////////////////////////////////////////////////////////////
18231 . ////////////////////////////////////////////////////////////////////////////
18232
18233 .chapter "The queryprogram router" "CHAPdriverlast"
18234 .scindex IIDquerou1 "&(queryprogram)& router"
18235 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18236 .cindex "routing" "by external program"
18237 The &(queryprogram)& router routes an address by running an external command
18238 and acting on its output. This is an expensive way to route, and is intended
18239 mainly for use in lightly-loaded systems, or for performing experiments.
18240 However, if it is possible to use the precondition options (&%domains%&,
18241 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18242 be used in special cases, even on a busy host. There are the following private
18243 options:
18244 .cindex "options" "&(queryprogram)& router"
18245
18246 .option command queryprogram string&!! unset
18247 This option must be set. It specifies the command that is to be run. The
18248 command is split up into a command name and arguments, and then each is
18249 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18250 &<<CHAPpipetransport>>&).
18251
18252
18253 .option command_group queryprogram string unset
18254 .cindex "gid (group id)" "in &(queryprogram)& router"
18255 This option specifies a gid to be set when running the command while routing an
18256 address for deliver. It must be set if &%command_user%& specifies a numerical
18257 uid. If it begins with a digit, it is interpreted as the numerical value of the
18258 gid. Otherwise it is looked up using &[getgrnam()]&.
18259
18260
18261 .option command_user queryprogram string unset
18262 .cindex "uid (user id)" "for &(queryprogram)&"
18263 This option must be set. It specifies the uid which is set when running the
18264 command while routing an address for delivery. If the value begins with a digit,
18265 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18266 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18267 not set, a value for the gid also.
18268
18269 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18270 root, which it does during a normal delivery in a conventional configuration.
18271 However, when an address is being verified during message reception, Exim is
18272 usually running as the Exim user, not as root. If the &(queryprogram)& router
18273 is called from a non-root process, Exim cannot change uid or gid before running
18274 the command. In this circumstance the command runs under the current uid and
18275 gid.
18276
18277
18278 .option current_directory queryprogram string /
18279 This option specifies an absolute path which is made the current directory
18280 before running the command.
18281
18282
18283 .option timeout queryprogram time 1h
18284 If the command does not complete within the timeout period, its process group
18285 is killed and the message is frozen. A value of zero time specifies no
18286 timeout.
18287
18288
18289 The standard output of the command is connected to a pipe, which is read when
18290 the command terminates. It should consist of a single line of output,
18291 containing up to five fields, separated by white space. The maximum length of
18292 the line is 1023 characters. Longer lines are silently truncated. The first
18293 field is one of the following words (case-insensitive):
18294
18295 .ilist
18296 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18297 below).
18298 .next
18299 &'Decline'&: the router declines; pass the address to the next router, unless
18300 &%no_more%& is set.
18301 .next
18302 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18303 subsequent text on the line is an error message. If the router is run as part
18304 of address verification during an incoming SMTP message, the message is
18305 included in the SMTP response.
18306 .next
18307 &'Defer'&: routing could not be completed at this time; try again later. Any
18308 subsequent text on the line is an error message which is logged. It is not
18309 included in any SMTP response.
18310 .next
18311 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18312 .next
18313 &'Pass'&: pass the address to the next router (or the router specified by
18314 &%pass_router%&), overriding &%no_more%&.
18315 .next
18316 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18317 new addresses, which are routed independently, starting with the first router,
18318 or the router specified by &%redirect_router%&, if set.
18319 .endlist
18320
18321 When the first word is &'accept'&, the remainder of the line consists of a
18322 number of keyed data values, as follows (split into two lines here, to fit on
18323 the page):
18324 .code
18325 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18326 LOOKUP=byname|bydns DATA=<text>
18327 .endd
18328 The data items can be given in any order, and all are optional. If no transport
18329 is included, the transport specified by the generic &%transport%& option is
18330 used. The list of hosts and the lookup type are needed only if the transport is
18331 an &(smtp)& transport that does not itself supply a list of hosts.
18332
18333 The format of the list of hosts is the same as for the &(manualroute)& router.
18334 As well as host names and IP addresses with optional port numbers, as described
18335 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18336 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18337 (see section &<<SECThostshowused>>&).
18338
18339 If the lookup type is not specified, Exim behaves as follows when trying to
18340 find an IP address for each host: First, a DNS lookup is done. If this yields
18341 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18342 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18343 result of the lookup is the result of that call.
18344
18345 .vindex "&$address_data$&"
18346 If the DATA field is set, its value is placed in the &$address_data$&
18347 variable. For example, this return line
18348 .code
18349 accept hosts=x1.y.example:x2.y.example data="rule1"
18350 .endd
18351 routes the address to the default transport, passing a list of two hosts. When
18352 the transport runs, the string &"rule1"& is in &$address_data$&.
18353 .ecindex IIDquerou1
18354 .ecindex IIDquerou2
18355
18356
18357
18358
18359 . ////////////////////////////////////////////////////////////////////////////
18360 . ////////////////////////////////////////////////////////////////////////////
18361
18362 .chapter "The redirect router" "CHAPredirect"
18363 .scindex IIDredrou1 "&(redirect)& router"
18364 .scindex IIDredrou2 "routers" "&(redirect)&"
18365 .cindex "alias file" "in a &(redirect)& router"
18366 .cindex "address redirection" "&(redirect)& router"
18367 The &(redirect)& router handles several kinds of address redirection. Its most
18368 common uses are for resolving local part aliases from a central alias file
18369 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
18370 files, but it has many other potential uses. The incoming address can be
18371 redirected in several different ways:
18372
18373 .ilist
18374 It can be replaced by one or more new addresses which are themselves routed
18375 independently.
18376 .next
18377 It can be routed to be delivered to a given file or directory.
18378 .next
18379 It can be routed to be delivered to a specified pipe command.
18380 .next
18381 It can cause an automatic reply to be generated.
18382 .next
18383 It can be forced to fail, optionally with a custom error message.
18384 .next
18385 It can be temporarily deferred, optionally with a custom message.
18386 .next
18387 It can be discarded.
18388 .endlist
18389
18390 The generic &%transport%& option must not be set for &(redirect)& routers.
18391 However, there are some private options which define transports for delivery to
18392 files and pipes, and for generating autoreplies. See the &%file_transport%&,
18393 &%pipe_transport%& and &%reply_transport%& descriptions below.
18394
18395
18396
18397 .section "Redirection data" "SECID124"
18398 The router operates by interpreting a text string which it obtains either by
18399 expanding the contents of the &%data%& option, or by reading the entire
18400 contents of a file whose name is given in the &%file%& option. These two
18401 options are mutually exclusive. The first is commonly used for handling system
18402 aliases, in a configuration like this:
18403 .code
18404 system_aliases:
18405   driver = redirect
18406   data = ${lookup{$local_part}lsearch{/etc/aliases}}
18407 .endd
18408 If the lookup fails, the expanded string in this example is empty. When the
18409 expansion of &%data%& results in an empty string, the router declines. A forced
18410 expansion failure also causes the router to decline; other expansion failures
18411 cause delivery to be deferred.
18412
18413 A configuration using &%file%& is commonly used for handling users'
18414 &_.forward_& files, like this:
18415 .code
18416 userforward:
18417   driver = redirect
18418   check_local_user
18419   file = $home/.forward
18420   no_verify
18421 .endd
18422 If the file does not exist, or causes no action to be taken (for example, it is
18423 empty or consists only of comments), the router declines. &*Warning*&: This
18424 is not the case when the file contains syntactically valid items that happen to
18425 yield empty addresses, for example, items containing only RFC 2822 address
18426 comments.
18427
18428
18429
18430 .section "Forward files and address verification" "SECID125"
18431 .cindex "address redirection" "while verifying"
18432 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
18433 &_.forward_& files, as in the example above. There are two reasons for this:
18434
18435 .ilist
18436 When Exim is receiving an incoming SMTP message from a remote host, it is
18437 running under the Exim uid, not as root. Exim is unable to change uid to read
18438 the file as the user, and it may not be able to read it as the Exim user. So in
18439 practice the router may not be able to operate.
18440 .next
18441 However, even when the router can operate, the existence of a &_.forward_& file
18442 is unimportant when verifying an address. What should be checked is whether the
18443 local part is a valid user name or not. Cutting out the redirection processing
18444 saves some resources.
18445 .endlist
18446
18447
18448
18449
18450
18451
18452 .section "Interpreting redirection data" "SECID126"
18453 .cindex "Sieve filter" "specifying in redirection data"
18454 .cindex "filter" "specifying in redirection data"
18455 The contents of the data string, whether obtained from &%data%& or &%file%&,
18456 can be interpreted in two different ways:
18457
18458 .ilist
18459 If the &%allow_filter%& option is set true, and the data begins with the text
18460 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
18461 &'filtering'& instructions in the form of an Exim or Sieve filter file,
18462 respectively. Details of the syntax and semantics of filter files are described
18463 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
18464 document is intended for use by end users.
18465 .next
18466 Otherwise, the data must be a comma-separated list of redirection items, as
18467 described in the next section.
18468 .endlist
18469
18470 When a message is redirected to a file (a &"mail folder"&), the file name given
18471 in a non-filter redirection list must always be an absolute path. A filter may
18472 generate a relative path &-- how this is handled depends on the transport's
18473 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
18474 for the &(appendfile)& transport.
18475
18476
18477
18478 .section "Items in a non-filter redirection list" "SECTitenonfilred"
18479 .cindex "address redirection" "non-filter list items"
18480 When the redirection data is not an Exim or Sieve filter, for example, if it
18481 comes from a conventional alias or forward file, it consists of a list of
18482 addresses, file names, pipe commands, or certain special items (see section
18483 &<<SECTspecitredli>>& below). The special items can be individually enabled or
18484 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
18485 depending on their default values. The items in the list are separated by
18486 commas or newlines.
18487 If a comma is required in an item, the entire item must be enclosed in double
18488 quotes.
18489
18490 Lines starting with a # character are comments, and are ignored, and # may
18491 also appear following a comma, in which case everything between the # and the
18492 next newline character is ignored.
18493
18494 If an item is entirely enclosed in double quotes, these are removed. Otherwise
18495 double quotes are retained because some forms of mail address require their use
18496 (but never to enclose the entire address). In the following description,
18497 &"item"& refers to what remains after any surrounding double quotes have been
18498 removed.
18499
18500 .vindex "&$local_part$&"
18501 &*Warning*&: If you use an Exim expansion to construct a redirection address,
18502 and the expansion contains a reference to &$local_part$&, you should make use
18503 of the &%quote_local_part%& expansion operator, in case the local part contains
18504 special characters. For example, to redirect all mail for the domain
18505 &'obsolete.example'&, retaining the existing local part, you could use this
18506 setting:
18507 .code
18508 data = ${quote_local_part:$local_part}@newdomain.example
18509 .endd
18510
18511
18512 .section "Redirecting to a local mailbox" "SECTredlocmai"
18513 .cindex "routing" "loops in"
18514 .cindex "loop" "while routing, avoidance of"
18515 .cindex "address redirection" "to local mailbox"
18516 A redirection item may safely be the same as the address currently under
18517 consideration. This does not cause a routing loop, because a router is
18518 automatically skipped if any ancestor of the address that is being processed
18519 is the same as the current address and was processed by the current router.
18520 Such an address is therefore passed to the following routers, so it is handled
18521 as if there were no redirection. When making this loop-avoidance test, the
18522 complete local part, including any prefix or suffix, is used.
18523
18524 .cindex "address redirection" "local part without domain"
18525 Specifying the same local part without a domain is a common usage in personal
18526 filter files when the user wants to have messages delivered to the local
18527 mailbox and also forwarded elsewhere. For example, the user whose login is
18528 &'cleo'& might have a &_.forward_& file containing this:
18529 .code
18530 cleo, cleopatra@egypt.example
18531 .endd
18532 .cindex "backslash in alias file"
18533 .cindex "alias file" "backslash in"
18534 For compatibility with other MTAs, such unqualified local parts may be
18535 preceded by &"\"&, but this is not a requirement for loop prevention. However,
18536 it does make a difference if more than one domain is being handled
18537 synonymously.
18538
18539 If an item begins with &"\"& and the rest of the item parses as a valid RFC
18540 2822 address that does not include a domain, the item is qualified using the
18541 domain of the incoming address. In the absence of a leading &"\"&, unqualified
18542 addresses are qualified using the value in &%qualify_recipient%&, but you can
18543 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
18544
18545 Care must be taken if there are alias names for local users.
18546 Consider an MTA handling a single local domain where the system alias file
18547 contains:
18548 .code
18549 Sam.Reman: spqr
18550 .endd
18551 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
18552 messages in the local mailbox, and also forward copies elsewhere. He creates
18553 this forward file:
18554 .code
18555 Sam.Reman, spqr@reme.elsewhere.example
18556 .endd
18557 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
18558 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
18559 second time round, because it has previously routed it,
18560 and the following routers presumably cannot handle the alias. The forward file
18561 should really contain
18562 .code
18563 spqr, spqr@reme.elsewhere.example
18564 .endd
18565 but because this is such a common error, the &%check_ancestor%& option (see
18566 below) exists to provide a way to get round it. This is normally set on a
18567 &(redirect)& router that is handling users' &_.forward_& files.
18568
18569
18570
18571 .section "Special items in redirection lists" "SECTspecitredli"
18572 In addition to addresses, the following types of item may appear in redirection
18573 lists (that is, in non-filter redirection data):
18574
18575 .ilist
18576 .cindex "pipe" "in redirection list"
18577 .cindex "address redirection" "to pipe"
18578 An item is treated as a pipe command if it begins with &"|"& and does not parse
18579 as a valid RFC 2822 address that includes a domain. A transport for running the
18580 command must be specified by the &%pipe_transport%& option.
18581 Normally, either the router or the transport specifies a user and a group under
18582 which to run the delivery. The default is to use the Exim user and group.
18583
18584 Single or double quotes can be used for enclosing the individual arguments of
18585 the pipe command; no interpretation of escapes is done for single quotes. If
18586 the command contains a comma character, it is necessary to put the whole item
18587 in double quotes, for example:
18588 .code
18589 "|/some/command ready,steady,go"
18590 .endd
18591 since items in redirection lists are terminated by commas. Do not, however,
18592 quote just the command. An item such as
18593 .code
18594 |"/some/command ready,steady,go"
18595 .endd
18596 is interpreted as a pipe with a rather strange command name, and no arguments.
18597
18598 .new
18599 Note that the above example assumes that the text comes from a lookup source
18600 of some sort, so that the quotes are part of the data.  If composing a
18601 redirect router with a &%data%& option directly specifying this command, the
18602 quotes will be used by the configuration parser to define the extent of one
18603 string, but will not be passed down into the redirect router itself.  There
18604 are two main approaches to get around this: escape quotes to be part of the
18605 data itself, or avoid using this mechanism and instead create a custom
18606 transport with the &%command%& option set and reference that transport from
18607 an &%accept%& router.
18608 .wen
18609
18610 .next
18611 .cindex "file" "in redirection list"
18612 .cindex "address redirection" "to file"
18613 An item is interpreted as a path name if it begins with &"/"& and does not
18614 parse as a valid RFC 2822 address that includes a domain. For example,
18615 .code
18616 /home/world/minbari
18617 .endd
18618 is treated as a file name, but
18619 .code
18620 /s=molari/o=babylon/@x400gate.way
18621 .endd
18622 is treated as an address. For a file name, a transport must be specified using
18623 the &%file_transport%& option. However, if the generated path name ends with a
18624 forward slash character, it is interpreted as a directory name rather than a
18625 file name, and &%directory_transport%& is used instead.
18626
18627 Normally, either the router or the transport specifies a user and a group under
18628 which to run the delivery. The default is to use the Exim user and group.
18629
18630 .cindex "&_/dev/null_&"
18631 However, if a redirection item is the path &_/dev/null_&, delivery to it is
18632 bypassed at a high level, and the log entry shows &"**bypassed**"&
18633 instead of a transport name. In this case the user and group are not used.
18634
18635 .next
18636 .cindex "included address list"
18637 .cindex "address redirection" "included external list"
18638 If an item is of the form
18639 .code
18640 :include:<path name>
18641 .endd
18642 a list of further items is taken from the given file and included at that
18643 point. &*Note*&: Such a file can not be a filter file; it is just an
18644 out-of-line addition to the list. The items in the included list are separated
18645 by commas or newlines and are not subject to expansion. If this is the first
18646 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
18647 the alias name. This example is incorrect:
18648 .code
18649 list1    :include:/opt/lists/list1
18650 .endd
18651 It must be given as
18652 .code
18653 list1:   :include:/opt/lists/list1
18654 .endd
18655 .next
18656 .cindex "address redirection" "to black hole"
18657 Sometimes you want to throw away mail to a particular local part. Making the
18658 &%data%& option expand to an empty string does not work, because that causes
18659 the router to decline. Instead, the alias item
18660 .cindex "black hole"
18661 .cindex "abandoning mail"
18662 &':blackhole:'& can be used. It does what its name implies. No delivery is
18663 done, and no error message is generated. This has the same effect as specifing
18664 &_/dev/null_& as a destination, but it can be independently disabled.
18665
18666 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
18667 delivery is done for the original local part, even if other redirection items
18668 are present. If you are generating a multi-item list (for example, by reading a
18669 database) and need the ability to provide a no-op item, you must use
18670 &_/dev/null_&.
18671
18672 .next
18673 .cindex "delivery" "forcing failure"
18674 .cindex "delivery" "forcing deferral"
18675 .cindex "failing delivery" "forcing"
18676 .cindex "deferred delivery, forcing"
18677 .cindex "customizing" "failure message"
18678 An attempt to deliver a particular address can be deferred or forced to fail by
18679 redirection items of the form
18680 .code
18681 :defer:
18682 :fail:
18683 .endd
18684 respectively. When a redirection list contains such an item, it applies
18685 to the entire redirection; any other items in the list are ignored. Any
18686 text following &':fail:'& or &':defer:'& is placed in the error text
18687 associated with the failure. For example, an alias file might contain:
18688 .code
18689 X.Employee:  :fail: Gone away, no forwarding address
18690 .endd
18691 In the case of an address that is being verified from an ACL or as the subject
18692 of a
18693 .cindex "VRFY" "error text, display of"
18694 VRFY command, the text is included in the SMTP error response by
18695 default.
18696 .cindex "EXPN" "error text, display of"
18697 The text is not included in the response to an EXPN command. In non-SMTP cases
18698 the text is included in the error message that Exim generates.
18699
18700 .cindex "SMTP" "error codes"
18701 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18702 &':fail:'&. However, if the message starts with three digits followed by a
18703 space, optionally followed by an extended code of the form &'n.n.n'&, also
18704 followed by a space, and the very first digit is the same as the default error
18705 code, the code from the message is used instead. If the very first digit is
18706 incorrect, a panic error is logged, and the default code is used. You can
18707 suppress the use of the supplied code in a redirect router by setting the
18708 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18709 ignored.
18710
18711 .vindex "&$acl_verify_message$&"
18712 In an ACL, an explicitly provided message overrides the default, but the
18713 default message is available in the variable &$acl_verify_message$& and can
18714 therefore be included in a custom message if this is desired.
18715
18716 Normally the error text is the rest of the redirection list &-- a comma does
18717 not terminate it &-- but a newline does act as a terminator. Newlines are not
18718 normally present in alias expansions. In &(lsearch)& lookups they are removed
18719 as part of the continuation process, but they may exist in other kinds of
18720 lookup and in &':include:'& files.
18721
18722 During routing for message delivery (as opposed to verification), a redirection
18723 containing &':fail:'& causes an immediate failure of the incoming address,
18724 whereas &':defer:'& causes the message to remain on the queue so that a
18725 subsequent delivery attempt can happen at a later time. If an address is
18726 deferred for too long, it will ultimately fail, because the normal retry
18727 rules still apply.
18728
18729 .next
18730 .cindex "alias file" "exception to default"
18731 Sometimes it is useful to use a single-key search type with a default (see
18732 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18733 for exceptions to the default. These can be handled by aliasing them to
18734 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18735 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18736 results in an empty redirection list has the same effect.
18737 .endlist
18738
18739
18740 .section "Duplicate addresses" "SECTdupaddr"
18741 .cindex "duplicate addresses"
18742 .cindex "address duplicate, discarding"
18743 .cindex "pipe" "duplicated"
18744 Exim removes duplicate addresses from the list to which it is delivering, so as
18745 to deliver just one copy to each address. This does not apply to deliveries
18746 routed to pipes by different immediate parent addresses, but an indirect
18747 aliasing scheme of the type
18748 .code
18749 pipe:       |/some/command $local_part
18750 localpart1: pipe
18751 localpart2: pipe
18752 .endd
18753 does not work with a message that is addressed to both local parts, because
18754 when the second is aliased to the intermediate local part &"pipe"& it gets
18755 discarded as being the same as a previously handled address. However, a scheme
18756 such as
18757 .code
18758 localpart1: |/some/command $local_part
18759 localpart2: |/some/command $local_part
18760 .endd
18761 does result in two different pipe deliveries, because the immediate parents of
18762 the pipes are distinct.
18763
18764
18765
18766 .section "Repeated redirection expansion" "SECID128"
18767 .cindex "repeated redirection expansion"
18768 .cindex "address redirection" "repeated for each delivery attempt"
18769 When a message cannot be delivered to all of its recipients immediately,
18770 leading to two or more delivery attempts, redirection expansion is carried out
18771 afresh each time for those addresses whose children were not all previously
18772 delivered. If redirection is being used as a mailing list, this can lead to new
18773 members of the list receiving copies of old messages. The &%one_time%& option
18774 can be used to avoid this.
18775
18776
18777 .section "Errors in redirection lists" "SECID129"
18778 .cindex "address redirection" "errors"
18779 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18780 error is skipped, and an entry is written to the main log. This may be useful
18781 for mailing lists that are automatically managed. Otherwise, if an error is
18782 detected while generating the list of new addresses, the original address is
18783 deferred. See also &%syntax_errors_to%&.
18784
18785
18786
18787 .section "Private options for the redirect router" "SECID130"
18788
18789 .cindex "options" "&(redirect)& router"
18790 The private options for the &(redirect)& router are as follows:
18791
18792
18793 .option allow_defer redirect boolean false
18794 Setting this option allows the use of &':defer:'& in non-filter redirection
18795 data, or the &%defer%& command in an Exim filter file.
18796
18797
18798 .option allow_fail redirect boolean false
18799 .cindex "failing delivery" "from filter"
18800 If this option is true, the &':fail:'& item can be used in a redirection list,
18801 and the &%fail%& command may be used in an Exim filter file.
18802
18803
18804 .option allow_filter redirect boolean false
18805 .cindex "filter" "enabling use of"
18806 .cindex "Sieve filter" "enabling use of"
18807 Setting this option allows Exim to interpret redirection data that starts with
18808 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
18809 are some features of Exim filter files that some administrators may wish to
18810 lock out; see the &%forbid_filter_%&&'xxx'& options below.
18811
18812 It is also possible to lock out Exim filters or Sieve filters while allowing
18813 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
18814
18815
18816 The filter is run using the uid and gid set by the generic &%user%& and
18817 &%group%& options. These take their defaults from the password data if
18818 &%check_local_user%& is set, so in the normal case of users' personal filter
18819 files, the filter is run as the relevant user. When &%allow_filter%& is set
18820 true, Exim insists that either &%check_local_user%& or &%user%& is set.
18821
18822
18823
18824 .option allow_freeze redirect boolean false
18825 .cindex "freezing messages" "allowing in filter"
18826 Setting this option allows the use of the &%freeze%& command in an Exim filter.
18827 This command is more normally encountered in system filters, and is disabled by
18828 default for redirection filters because it isn't something you usually want to
18829 let ordinary users do.
18830
18831
18832
18833 .option check_ancestor redirect boolean false
18834 This option is concerned with handling generated addresses that are the same
18835 as some address in the list of redirection ancestors of the current address.
18836 Although it is turned off by default in the code, it is set in the default
18837 configuration file for handling users' &_.forward_& files. It is recommended
18838 for this use of the &(redirect)& router.
18839
18840 When &%check_ancestor%& is set, if a generated address (including the domain)
18841 is the same as any ancestor of the current address, it is replaced by a copy of
18842 the current address. This helps in the case where local part A is aliased to B,
18843 and B has a &_.forward_& file pointing back to A. For example, within a single
18844 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
18845 &_&~jb/.forward_& contains:
18846 .code
18847 \Joe.Bloggs, <other item(s)>
18848 .endd
18849 Without the &%check_ancestor%& setting, either local part (&"jb"& or
18850 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
18851 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
18852 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
18853 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
18854 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
18855 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
18856 original address. See also the &%repeat_use%& option below.
18857
18858
18859 .option check_group redirect boolean "see below"
18860 When the &%file%& option is used, the group owner of the file is checked only
18861 when this option is set. The permitted groups are those listed in the
18862 &%owngroups%& option, together with the user's default group if
18863 &%check_local_user%& is set. If the file has the wrong group, routing is
18864 deferred. The default setting for this option is true if &%check_local_user%&
18865 is set and the &%modemask%& option permits the group write bit, or if the
18866 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
18867
18868
18869
18870 .option check_owner redirect boolean "see below"
18871 When the &%file%& option is used, the owner of the file is checked only when
18872 this option is set. If &%check_local_user%& is set, the local user is
18873 permitted; otherwise the owner must be one of those listed in the &%owners%&
18874 option. The default value for this option is true if &%check_local_user%& or
18875 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
18876
18877
18878 .option data redirect string&!! unset
18879 This option is mutually exclusive with &%file%&. One or other of them must be
18880 set, but not both. The contents of &%data%& are expanded, and then used as the
18881 list of forwarding items, or as a set of filtering instructions. If the
18882 expansion is forced to fail, or the result is an empty string or a string that
18883 has no effect (consists entirely of comments), the router declines.
18884
18885 When filtering instructions are used, the string must begin with &"#Exim
18886 filter"&, and all comments in the string, including this initial one, must be
18887 terminated with newline characters. For example:
18888 .code
18889 data = #Exim filter\n\
18890        if $h_to: contains Exim then save $home/mail/exim endif
18891 .endd
18892 If you are reading the data from a database where newlines cannot be included,
18893 you can use the &${sg}$& expansion item to turn the escape string of your
18894 choice into a newline.
18895
18896
18897 .option directory_transport redirect string&!! unset
18898 A &(redirect)& router sets up a direct delivery to a directory when a path name
18899 ending with a slash is specified as a new &"address"&. The transport used is
18900 specified by this option, which, after expansion, must be the name of a
18901 configured transport. This should normally be an &(appendfile)& transport.
18902
18903
18904 .option file redirect string&!! unset
18905 This option specifies the name of a file that contains the redirection data. It
18906 is mutually exclusive with the &%data%& option. The string is expanded before
18907 use; if the expansion is forced to fail, the router declines. Other expansion
18908 failures cause delivery to be deferred. The result of a successful expansion
18909 must be an absolute path. The entire file is read and used as the redirection
18910 data. If the data is an empty string or a string that has no effect (consists
18911 entirely of comments), the router declines.
18912
18913 .cindex "NFS" "checking for file existence"
18914 If the attempt to open the file fails with a &"does not exist"& error, Exim
18915 runs a check on the containing directory,
18916 unless &%ignore_enotdir%& is true (see below).
18917 If the directory does not appear to exist, delivery is deferred. This can
18918 happen when users' &_.forward_& files are in NFS-mounted directories, and there
18919 is a mount problem. If the containing directory does exist, but the file does
18920 not, the router declines.
18921
18922
18923 .option file_transport redirect string&!! unset
18924 .vindex "&$address_file$&"
18925 A &(redirect)& router sets up a direct delivery to a file when a path name not
18926 ending in a slash is specified as a new &"address"&. The transport used is
18927 specified by this option, which, after expansion, must be the name of a
18928 configured transport. This should normally be an &(appendfile)& transport. When
18929 it is running, the file name is in &$address_file$&.
18930
18931
18932 .option filter_prepend_home redirect boolean true
18933 When this option is true, if a &(save)& command in an Exim filter specifies a
18934 relative path, and &$home$& is defined, it is automatically prepended to the
18935 relative path. If this option is set false, this action does not happen. The
18936 relative path is then passed to the transport unmodified.
18937
18938
18939 .option forbid_blackhole redirect boolean false
18940 If this option is true, the &':blackhole:'& item may not appear in a
18941 redirection list.
18942
18943
18944 .option forbid_exim_filter redirect boolean false
18945 If this option is set true, only Sieve filters are permitted when
18946 &%allow_filter%& is true.
18947
18948
18949
18950
18951 .option forbid_file redirect boolean false
18952 .cindex "delivery" "to file; forbidding"
18953 .cindex "Sieve filter" "forbidding delivery to a file"
18954 .cindex "Sieve filter" "&""keep""& facility; disabling"
18955 If this option is true, this router may not generate a new address that
18956 specifies delivery to a local file or directory, either from a filter or from a
18957 conventional forward file. This option is forced to be true if &%one_time%& is
18958 set. It applies to Sieve filters as well as to Exim filters, but if true, it
18959 locks out the Sieve's &"keep"& facility.
18960
18961
18962 .option forbid_filter_dlfunc redirect boolean false
18963 .cindex "filter" "locking out certain features"
18964 If this option is true, string expansions in Exim filters are not allowed to
18965 make use of the &%dlfunc%& expansion facility to run dynamically loaded
18966 functions.
18967
18968 .option forbid_filter_existstest redirect boolean false
18969 .cindex "expansion" "statting a file"
18970 If this option is true, string expansions in Exim filters are not allowed to
18971 make use of the &%exists%& condition or the &%stat%& expansion item.
18972
18973 .option forbid_filter_logwrite redirect boolean false
18974 If this option is true, use of the logging facility in Exim filters is not
18975 permitted. Logging is in any case available only if the filter is being run
18976 under some unprivileged uid (which is normally the case for ordinary users'
18977 &_.forward_& files).
18978
18979
18980 .option forbid_filter_lookup redirect boolean false
18981 If this option is true, string expansions in Exim filter files are not allowed
18982 to make use of &%lookup%& items.
18983
18984
18985 .option forbid_filter_perl redirect boolean false
18986 This option has an effect only if Exim is built with embedded Perl support. If
18987 it is true, string expansions in Exim filter files are not allowed to make use
18988 of the embedded Perl support.
18989
18990
18991 .option forbid_filter_readfile redirect boolean false
18992 If this option is true, string expansions in Exim filter files are not allowed
18993 to make use of &%readfile%& items.
18994
18995
18996 .option forbid_filter_readsocket redirect boolean false
18997 If this option is true, string expansions in Exim filter files are not allowed
18998 to make use of &%readsocket%& items.
18999
19000
19001 .option forbid_filter_reply redirect boolean false
19002 If this option is true, this router may not generate an automatic reply
19003 message. Automatic replies can be generated only from Exim or Sieve filter
19004 files, not from traditional forward files. This option is forced to be true if
19005 &%one_time%& is set.
19006
19007
19008 .option forbid_filter_run redirect boolean false
19009 If this option is true, string expansions in Exim filter files are not allowed
19010 to make use of &%run%& items.
19011
19012
19013 .option forbid_include redirect boolean false
19014 If this option is true, items of the form
19015 .code
19016 :include:<path name>
19017 .endd
19018 are not permitted in non-filter redirection lists.
19019
19020
19021 .option forbid_pipe redirect boolean false
19022 .cindex "delivery" "to pipe; forbidding"
19023 If this option is true, this router may not generate a new address which
19024 specifies delivery to a pipe, either from an Exim filter or from a conventional
19025 forward file. This option is forced to be true if &%one_time%& is set.
19026
19027
19028 .option forbid_sieve_filter redirect boolean false
19029 If this option is set true, only Exim filters are permitted when
19030 &%allow_filter%& is true.
19031
19032
19033 .cindex "SMTP" "error codes"
19034 .option forbid_smtp_code redirect boolean false
19035 If this option is set true, any SMTP error codes that are present at the start
19036 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19037 the default codes (451 and 550, respectively) are always used.
19038
19039
19040
19041
19042 .option hide_child_in_errmsg redirect boolean false
19043 .cindex "bounce message" "redirection details; suppressing"
19044 If this option is true, it prevents Exim from quoting a child address if it
19045 generates a bounce or delay message for it. Instead it says &"an address
19046 generated from <&'the top level address'&>"&. Of course, this applies only to
19047 bounces generated locally. If a message is forwarded to another host, &'its'&
19048 bounce may well quote the generated address.
19049
19050
19051 .option ignore_eacces redirect boolean false
19052 .cindex "EACCES"
19053 If this option is set and an attempt to open a redirection file yields the
19054 EACCES error (permission denied), the &(redirect)& router behaves as if the
19055 file did not exist.
19056
19057
19058 .option ignore_enotdir redirect boolean false
19059 .cindex "ENOTDIR"
19060 If this option is set and an attempt to open a redirection file yields the
19061 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19062 router behaves as if the file did not exist.
19063
19064 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19065 router that has the &%file%& option set discovers that the file does not exist
19066 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19067 against unmounted NFS directories. If the parent can not be statted, delivery
19068 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19069 is set, because that option tells Exim to ignore &"something on the path is not
19070 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19071 that some operating systems give ENOENT where others give ENOTDIR.
19072
19073
19074
19075 .option include_directory redirect string unset
19076 If this option is set, the path names of any &':include:'& items in a
19077 redirection list must start with this directory.
19078
19079
19080 .option modemask redirect "octal integer" 022
19081 This specifies mode bits which must not be set for a file specified by the
19082 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19083
19084
19085 .option one_time redirect boolean false
19086 .cindex "one-time aliasing/forwarding expansion"
19087 .cindex "alias file" "one-time expansion"
19088 .cindex "forward file" "one-time expansion"
19089 .cindex "mailing lists" "one-time expansion"
19090 .cindex "address redirection" "one-time expansion"
19091 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19092 files each time it tries to deliver a message causes a problem when one or more
19093 of the generated addresses fails be delivered at the first attempt. The problem
19094 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19095 but of what happens when the redirection list changes during the time that the
19096 message is on Exim's queue. This is particularly true in the case of mailing
19097 lists, where new subscribers might receive copies of messages that were posted
19098 before they subscribed.
19099
19100 If &%one_time%& is set and any addresses generated by the router fail to
19101 deliver at the first attempt, the failing addresses are added to the message as
19102 &"top level"& addresses, and the parent address that generated them is marked
19103 &"delivered"&. Thus, redirection does not happen again at the next delivery
19104 attempt.
19105
19106 &*Warning 1*&: Any header line addition or removal that is specified by this
19107 router would be lost if delivery did not succeed at the first attempt. For this
19108 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19109 permitted when &%one_time%& is set.
19110
19111 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19112 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19113 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19114
19115 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19116 &%one_time%&.
19117
19118 The original top-level address is remembered with each of the generated
19119 addresses, and is output in any log messages. However, any intermediate parent
19120 addresses are not recorded. This makes a difference to the log only if
19121 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19122 typically be used for mailing lists, where there is normally just one level of
19123 expansion.
19124
19125
19126 .option owners redirect "string list" unset
19127 .cindex "ownership" "alias file"
19128 .cindex "ownership" "forward file"
19129 .cindex "alias file" "ownership"
19130 .cindex "forward file" "ownership"
19131 This specifies a list of permitted owners for the file specified by &%file%&.
19132 This list is in addition to the local user when &%check_local_user%& is set.
19133 See &%check_owner%& above.
19134
19135
19136 .option owngroups redirect "string list" unset
19137 This specifies a list of permitted groups for the file specified by &%file%&.
19138 The list is in addition to the local user's primary group when
19139 &%check_local_user%& is set. See &%check_group%& above.
19140
19141
19142 .option pipe_transport redirect string&!! unset
19143 .vindex "&$address_pipe$&"
19144 A &(redirect)& router sets up a direct delivery to a pipe when a string
19145 starting with a vertical bar character is specified as a new &"address"&. The
19146 transport used is specified by this option, which, after expansion, must be the
19147 name of a configured transport. This should normally be a &(pipe)& transport.
19148 When the transport is run, the pipe command is in &$address_pipe$&.
19149
19150
19151 .option qualify_domain redirect string&!! unset
19152 .vindex "&$qualify_recipient$&"
19153 If this option is set, and an unqualified address (one without a domain) is
19154 generated, and that address would normally be qualified by the global setting
19155 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19156 expanding this string. If the expansion fails, the router declines. If you want
19157 to revert to the default, you can have the expansion generate
19158 &$qualify_recipient$&.
19159
19160 This option applies to all unqualified addresses generated by Exim filters,
19161 but for traditional &_.forward_& files, it applies only to addresses that are
19162 not preceded by a backslash. Sieve filters cannot generate unqualified
19163 addresses.
19164
19165 .option qualify_preserve_domain redirect boolean false
19166 .cindex "domain" "in redirection; preserving"
19167 .cindex "preserving domain in redirection"
19168 .cindex "address redirection" "domain; preserving"
19169 If this option is set, the router's local &%qualify_domain%& option must not be
19170 set (a configuration error occurs if it is). If an unqualified address (one
19171 without a domain) is generated, it is qualified with the domain of the parent
19172 address (the immediately preceding ancestor) instead of the global
19173 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19174 this applies whether or not the address is preceded by a backslash.
19175
19176
19177 .option repeat_use redirect boolean true
19178 If this option is set false, the router is skipped for a child address that has
19179 any ancestor that was routed by this router. This test happens before any of
19180 the other preconditions are tested. Exim's default anti-looping rules skip
19181 only when the ancestor is the same as the current address. See also
19182 &%check_ancestor%& above and the generic &%redirect_router%& option.
19183
19184
19185 .option reply_transport redirect string&!! unset
19186 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19187 &%vacation%& command is used in a filter file. The transport used is specified
19188 by this option, which, after expansion, must be the name of a configured
19189 transport. This should normally be an &(autoreply)& transport. Other transports
19190 are unlikely to do anything sensible or useful.
19191
19192
19193 .option rewrite redirect boolean true
19194 .cindex "address redirection" "disabling rewriting"
19195 If this option is set false, addresses generated by the router are not
19196 subject to address rewriting. Otherwise, they are treated like new addresses
19197 and are rewritten according to the global rewriting rules.
19198
19199
19200 .option sieve_subaddress redirect string&!! unset
19201 The value of this option is passed to a Sieve filter to specify the
19202 :subaddress part of an address.
19203
19204 .option sieve_useraddress redirect string&!! unset
19205 The value of this option is passed to a Sieve filter to specify the :user part
19206 of an address. However, if it is unset, the entire original local part
19207 (including any prefix or suffix) is used for :user.
19208
19209
19210 .option sieve_vacation_directory redirect string&!! unset
19211 .cindex "Sieve filter" "vacation directory"
19212 To enable the &"vacation"& extension for Sieve filters, you must set
19213 &%sieve_vacation_directory%& to the directory where vacation databases are held
19214 (do not put anything else in that directory), and ensure that the
19215 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19216 needs their own directory; Exim will create it if necessary.
19217
19218
19219
19220 .option skip_syntax_errors redirect boolean false
19221 .cindex "forward file" "broken"
19222 .cindex "address redirection" "broken files"
19223 .cindex "alias file" "broken"
19224 .cindex "broken alias or forward files"
19225 .cindex "ignoring faulty addresses"
19226 .cindex "skipping faulty addresses"
19227 .cindex "error" "skipping bad syntax"
19228 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19229 non-filter redirection data are skipped, and each failing address is logged. If
19230 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19231 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19232 are expanded and placed at the head of the error message generated by
19233 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19234 be the same address as the generic &%errors_to%& option. The
19235 &%skip_syntax_errors%& option is often used when handling mailing lists.
19236
19237 If all the addresses in a redirection list are skipped because of syntax
19238 errors, the router declines to handle the original address, and it is passed to
19239 the following routers.
19240
19241 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
19242 error in the filter causes filtering to be abandoned without any action being
19243 taken. The incident is logged, and the router declines to handle the address,
19244 so it is passed to the following routers.
19245
19246 .cindex "Sieve filter" "syntax errors in"
19247 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19248 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19249 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19250
19251 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19252 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19253 option, used with an address that does not get redirected, can be used to
19254 notify users of these errors, by means of a router like this:
19255 .code
19256 userforward:
19257   driver = redirect
19258   allow_filter
19259   check_local_user
19260   file = $home/.forward
19261   file_transport = address_file
19262   pipe_transport = address_pipe
19263   reply_transport = address_reply
19264   no_verify
19265   skip_syntax_errors
19266   syntax_errors_to = real-$local_part@$domain
19267   syntax_errors_text = \
19268    This is an automatically generated message. An error has\n\
19269    been found in your .forward file. Details of the error are\n\
19270    reported below. While this error persists, you will receive\n\
19271    a copy of this message for every message that is addressed\n\
19272    to you. If your .forward file is a filter file, or if it is\n\
19273    a non-filter file containing no valid forwarding addresses,\n\
19274    a copy of each incoming message will be put in your normal\n\
19275    mailbox. If a non-filter file contains at least one valid\n\
19276    forwarding address, forwarding to the valid addresses will\n\
19277    happen, and those will be the only deliveries that occur.
19278 .endd
19279 You also need a router to ensure that local addresses that are prefixed by
19280 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19281 put this immediately before the &(userforward)& router:
19282 .code
19283 real_localuser:
19284   driver = accept
19285   check_local_user
19286   local_part_prefix = real-
19287   transport = local_delivery
19288 .endd
19289 For security, it would probably be a good idea to restrict the use of this
19290 router to locally-generated messages, using a condition such as this:
19291 .code
19292   condition = ${if match {$sender_host_address}\
19293                          {\N^(|127\.0\.0\.1)$\N}}
19294 .endd
19295
19296
19297 .option syntax_errors_text redirect string&!! unset
19298 See &%skip_syntax_errors%& above.
19299
19300
19301 .option syntax_errors_to redirect string unset
19302 See &%skip_syntax_errors%& above.
19303 .ecindex IIDredrou1
19304 .ecindex IIDredrou2
19305
19306
19307
19308
19309
19310
19311 . ////////////////////////////////////////////////////////////////////////////
19312 . ////////////////////////////////////////////////////////////////////////////
19313
19314 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19315          "Environment for local transports"
19316 .scindex IIDenvlotra1 "local transports" "environment for"
19317 .scindex IIDenvlotra2 "environment for local transports"
19318 .scindex IIDenvlotra3 "transport" "local; environment for"
19319 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19320 transport can be thought of as similar to a pipe.) Exim always runs transports
19321 in subprocesses, under specified uids and gids. Typical deliveries to local
19322 mailboxes run under the uid and gid of the local user.
19323
19324 Exim also sets a specific current directory while running the transport; for
19325 some transports a home directory setting is also relevant. The &(pipe)&
19326 transport is the only one that sets up environment variables; see section
19327 &<<SECTpipeenv>>& for details.
19328
19329 The values used for the uid, gid, and the directories may come from several
19330 different places. In many cases, the router that handles the address associates
19331 settings with that address as a result of its &%check_local_user%&, &%group%&,
19332 or &%user%& options. However, values may also be given in the transport's own
19333 configuration, and these override anything that comes from the router.
19334
19335
19336
19337 .section "Concurrent deliveries" "SECID131"
19338 .cindex "concurrent deliveries"
19339 .cindex "simultaneous deliveries"
19340 If two different messages for the same local recipient arrive more or less
19341 simultaneously, the two delivery processes are likely to run concurrently. When
19342 the &(appendfile)& transport is used to write to a file, Exim applies locking
19343 rules to stop concurrent processes from writing to the same file at the same
19344 time.
19345
19346 However, when you use a &(pipe)& transport, it is up to you to arrange any
19347 locking that is needed. Here is a silly example:
19348 .code
19349 my_transport:
19350   driver = pipe
19351   command = /bin/sh -c 'cat >>/some/file'
19352 .endd
19353 This is supposed to write the message at the end of the file. However, if two
19354 messages arrive at the same time, the file will be scrambled. You can use the
19355 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19356 file using the same algorithm that Exim itself uses.
19357
19358
19359
19360
19361 .section "Uids and gids" "SECTenvuidgid"
19362 .cindex "local transports" "uid and gid"
19363 .cindex "transport" "local; uid and gid"
19364 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
19365 overrides any group that the router set in the address, even if &%user%& is not
19366 set for the transport. This makes it possible, for example, to run local mail
19367 delivery under the uid of the recipient (set by the router), but in a special
19368 group (set by the transport). For example:
19369 .code
19370 # Routers ...
19371 # User/group are set by check_local_user in this router
19372 local_users:
19373   driver = accept
19374   check_local_user
19375   transport = group_delivery
19376
19377 # Transports ...
19378 # This transport overrides the group
19379 group_delivery:
19380   driver = appendfile
19381   file = /var/spool/mail/$local_part
19382   group = mail
19383 .endd
19384 If &%user%& is set for a transport, its value overrides what is set in the
19385 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
19386 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
19387 set.
19388
19389 .oindex "&%initgroups%&"
19390 When the uid is taken from the transport's configuration, the &[initgroups()]&
19391 function is called for the groups associated with that uid if the
19392 &%initgroups%& option is set for the transport. When the uid is not specified
19393 by the transport, but is associated with the address by a router, the option
19394 for calling &[initgroups()]& is taken from the router configuration.
19395
19396 .cindex "&(pipe)& transport" "uid for"
19397 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
19398 is set and &%user%& is not set, the uid of the process that called Exim to
19399 receive the message is used, and if &%group%& is not set, the corresponding
19400 original gid is also used.
19401
19402 This is the detailed preference order for obtaining a gid; the first of the
19403 following that is set is used:
19404
19405 .ilist
19406 A &%group%& setting of the transport;
19407 .next
19408 A &%group%& setting of the router;
19409 .next
19410 A gid associated with a user setting of the router, either as a result of
19411 &%check_local_user%& or an explicit non-numeric &%user%& setting;
19412 .next
19413 The group associated with a non-numeric &%user%& setting of the transport;
19414 .next
19415 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
19416 the uid is the creator's uid;
19417 .next
19418 The Exim gid if the Exim uid is being used as a default.
19419 .endlist
19420
19421 If, for example, the user is specified numerically on the router and there are
19422 no group settings, no gid is available. In this situation, an error occurs.
19423 This is different for the uid, for which there always is an ultimate default.
19424 The first of the following that is set is used:
19425
19426 .ilist
19427 A &%user%& setting of the transport;
19428 .next
19429 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
19430 .next
19431 A &%user%& setting of the router;
19432 .next
19433 A &%check_local_user%& setting of the router;
19434 .next
19435 The Exim uid.
19436 .endlist
19437
19438 Of course, an error will still occur if the uid that is chosen is on the
19439 &%never_users%& list.
19440
19441
19442
19443
19444
19445 .section "Current and home directories" "SECID132"
19446 .cindex "current directory for local transport"
19447 .cindex "home directory" "for local transport"
19448 .cindex "transport" "local; home directory for"
19449 .cindex "transport" "local; current directory for"
19450 Routers may set current and home directories for local transports by means of
19451 the &%transport_current_directory%& and &%transport_home_directory%& options.
19452 However, if the transport's &%current_directory%& or &%home_directory%& options
19453 are set, they override the router's values. In detail, the home directory
19454 for a local transport is taken from the first of these values that is set:
19455
19456 .ilist
19457 The &%home_directory%& option on the transport;
19458 .next
19459 The &%transport_home_directory%& option on the router;
19460 .next
19461 The password data if &%check_local_user%& is set on the router;
19462 .next
19463 The &%router_home_directory%& option on the router.
19464 .endlist
19465
19466 The current directory is taken from the first of these values that is set:
19467
19468 .ilist
19469 The &%current_directory%& option on the transport;
19470 .next
19471 The &%transport_current_directory%& option on the router.
19472 .endlist
19473
19474
19475 If neither the router nor the transport sets a current directory, Exim uses the
19476 value of the home directory, if it is set. Otherwise it sets the current
19477 directory to &_/_& before running a local transport.
19478
19479
19480
19481 .section "Expansion variables derived from the address" "SECID133"
19482 .vindex "&$domain$&"
19483 .vindex "&$local_part$&"
19484 .vindex "&$original_domain$&"
19485 Normally a local delivery is handling a single address, and in that case the
19486 variables such as &$domain$& and &$local_part$& are set during local
19487 deliveries. However, in some circumstances more than one address may be handled
19488 at once (for example, while writing batch SMTP for onward transmission by some
19489 other means). In this case, the variables associated with the local part are
19490 never set, &$domain$& is set only if all the addresses have the same domain,
19491 and &$original_domain$& is never set.
19492 .ecindex IIDenvlotra1
19493 .ecindex IIDenvlotra2
19494 .ecindex IIDenvlotra3
19495
19496
19497
19498
19499
19500
19501
19502 . ////////////////////////////////////////////////////////////////////////////
19503 . ////////////////////////////////////////////////////////////////////////////
19504
19505 .chapter "Generic options for transports" "CHAPtransportgeneric"
19506 .scindex IIDgenoptra1 "generic options" "transport"
19507 .scindex IIDgenoptra2 "options" "generic; for transports"
19508 .scindex IIDgenoptra3 "transport" "generic options for"
19509 The following generic options apply to all transports:
19510
19511
19512 .option body_only transports boolean false
19513 .cindex "transport" "body only"
19514 .cindex "message" "transporting body only"
19515 .cindex "body of message" "transporting"
19516 If this option is set, the message's headers are not transported. It is
19517 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
19518 or &(pipe)& transports, the settings of &%message_prefix%& and
19519 &%message_suffix%& should be checked, because this option does not
19520 automatically suppress them.
19521
19522
19523 .option current_directory transports string&!! unset
19524 .cindex "transport" "current directory for"
19525 This specifies the current directory that is to be set while running the
19526 transport, overriding any value that may have been set by the router.
19527 If the expansion fails for any reason, including forced failure, an error is
19528 logged, and delivery is deferred.
19529
19530
19531 .option disable_logging transports boolean false
19532 If this option is set true, nothing is logged for any
19533 deliveries by the transport or for any
19534 transport errors. You should not set this option unless you really, really know
19535 what you are doing.
19536
19537
19538 .option debug_print transports string&!! unset
19539 .cindex "testing" "variables in drivers"
19540 If this option is set and debugging is enabled (see the &%-d%& command line
19541 option), the string is expanded and included in the debugging output when the
19542 transport is run.
19543 If expansion of the string fails, the error message is written to the debugging
19544 output, and Exim carries on processing.
19545 This facility is provided to help with checking out the values of variables and
19546 so on when debugging driver configurations. For example, if a &%headers_add%&
19547 option is not working properly, &%debug_print%& could be used to output the
19548 variables it references. A newline is added to the text if it does not end with
19549 one.
19550
19551
19552 .option delivery_date_add transports boolean false
19553 .cindex "&'Delivery-date:'& header line"
19554 If this option is true, a &'Delivery-date:'& header is added to the message.
19555 This gives the actual time the delivery was made. As this is not a standard
19556 header, Exim has a configuration option (&%delivery_date_remove%&) which
19557 requests its removal from incoming messages, so that delivered messages can
19558 safely be resent to other recipients.
19559
19560
19561 .option driver transports string unset
19562 This specifies which of the available transport drivers is to be used.
19563 There is no default, and this option must be set for every transport.
19564
19565
19566 .option envelope_to_add transports boolean false
19567 .cindex "&'Envelope-to:'& header line"
19568 If this option is true, an &'Envelope-to:'& header is added to the message.
19569 This gives the original address(es) in the incoming envelope that caused this
19570 delivery to happen. More than one address may be present if the transport is
19571 configured to handle several addresses at once, or if more than one original
19572 address was redirected to the same final address. As this is not a standard
19573 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
19574 its removal from incoming messages, so that delivered messages can safely be
19575 resent to other recipients.
19576
19577
19578 .option group transports string&!! "Exim group"
19579 .cindex "transport" "group; specifying"
19580 This option specifies a gid for running the transport process, overriding any
19581 value that the router supplies, and also overriding any value associated with
19582 &%user%& (see below).
19583
19584
19585 .option headers_add transports string&!! unset
19586 .cindex "header lines" "adding in transport"
19587 .cindex "transport" "header lines; adding"
19588 This option specifies a string of text that is expanded and added to the header
19589 portion of a message as it is transported, as described in section
19590 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
19591 routers. If the result of the expansion is an empty string, or if the expansion
19592 is forced to fail, no action is taken. Other expansion failures are treated as
19593 errors and cause the delivery to be deferred.
19594
19595 Unlike most options, &%headers_add%& can be specified multiple times
19596 for a transport; all listed headers are added.
19597
19598
19599
19600 .option headers_only transports boolean false
19601 .cindex "transport" "header lines only"
19602 .cindex "message" "transporting headers only"
19603 .cindex "header lines" "transporting"
19604 If this option is set, the message's body is not transported. It is mutually
19605 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
19606 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
19607 checked, since this option does not automatically suppress them.
19608
19609
19610 .option headers_remove transports string&!! unset
19611 .cindex "header lines" "removing"
19612 .cindex "transport" "header lines; removing"
19613 This option specifies a string that is expanded into a list of header names;
19614 these headers are omitted from the message as it is transported, as described
19615 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
19616 routers. If the result of the expansion is an empty string, or if the expansion
19617 is forced to fail, no action is taken. Other expansion failures are treated as
19618 errors and cause the delivery to be deferred.
19619
19620 Unlike most options, &%headers_remove%& can be specified multiple times
19621 for a router; all listed headers are added.
19622
19623
19624
19625 .option headers_rewrite transports string unset
19626 .cindex "transport" "header lines; rewriting"
19627 .cindex "rewriting" "at transport time"
19628 This option allows addresses in header lines to be rewritten at transport time,
19629 that is, as the message is being copied to its destination. The contents of the
19630 option are a colon-separated list of rewriting rules. Each rule is in exactly
19631 the same form as one of the general rewriting rules that are applied when a
19632 message is received. These are described in chapter &<<CHAPrewrite>>&. For
19633 example,
19634 .code
19635 headers_rewrite = a@b c@d f : \
19636                   x@y w@z
19637 .endd
19638 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
19639 &'w@z'& in all address-bearing header lines. The rules are applied to the
19640 header lines just before they are written out at transport time, so they affect
19641 only those copies of the message that pass through the transport. However, only
19642 the message's original header lines, and any that were added by a system
19643 filter, are rewritten. If a router or transport adds header lines, they are not
19644 affected by this option. These rewriting rules are &'not'& applied to the
19645 envelope. You can change the return path using &%return_path%&, but you cannot
19646 change envelope recipients at this time.
19647
19648
19649 .option home_directory transports string&!! unset
19650 .cindex "transport" "home directory for"
19651 .vindex "&$home$&"
19652 This option specifies a home directory setting for a local transport,
19653 overriding any value that may be set by the router. The home directory is
19654 placed in &$home$& while expanding the transport's private options. It is also
19655 used as the current directory if no current directory is set by the
19656 &%current_directory%& option on the transport or the
19657 &%transport_current_directory%& option on the router. If the expansion fails
19658 for any reason, including forced failure, an error is logged, and delivery is
19659 deferred.
19660
19661
19662 .option initgroups transports boolean false
19663 .cindex "additional groups"
19664 .cindex "groups" "additional"
19665 .cindex "transport" "group; additional"
19666 If this option is true and the uid for the delivery process is provided by the
19667 transport, the &[initgroups()]& function is called when running the transport
19668 to ensure that any additional groups associated with the uid are set up.
19669
19670
19671 .option message_size_limit transports string&!! 0
19672 .cindex "limit" "message size per transport"
19673 .cindex "size" "of message, limit"
19674 .cindex "transport" "message size; limiting"
19675 This option controls the size of messages passed through the transport. It is
19676 expanded before use; the result of the expansion must be a sequence of decimal
19677 digits, optionally followed by K or M. If the expansion fails for any reason,
19678 including forced failure, or if the result is not of the required form,
19679 delivery is deferred. If the value is greater than zero and the size of a
19680 message exceeds this limit, the address is failed. If there is any chance that
19681 the resulting bounce message could be routed to the same transport, you should
19682 ensure that &%return_size_limit%& is less than the transport's
19683 &%message_size_limit%&, as otherwise the bounce message will fail to get
19684 delivered.
19685
19686
19687
19688 .option rcpt_include_affixes transports boolean false
19689 .cindex "prefix" "for local part, including in envelope"
19690 .cindex "suffix for local part" "including in envelope"
19691 .cindex "local part" "prefix"
19692 .cindex "local part" "suffix"
19693 When this option is false (the default), and an address that has had any
19694 affixes (prefixes or suffixes) removed from the local part is delivered by any
19695 form of SMTP or LMTP, the affixes are not included. For example, if a router
19696 that contains
19697 .code
19698 local_part_prefix = *-
19699 .endd
19700 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19701 is delivered with
19702 .code
19703 RCPT TO:<xyz@some.domain>
19704 .endd
19705 This is also the case when an ACL-time callout is being used to verify a
19706 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19707 whole local part is included in the RCPT command. This option applies to BSMTP
19708 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19709 &(lmtp)& and &(smtp)& transports.
19710
19711
19712 .option retry_use_local_part transports boolean "see below"
19713 .cindex "hints database" "retry keys"
19714 When a delivery suffers a temporary failure, a retry record is created
19715 in Exim's hints database. For remote deliveries, the key for the retry record
19716 is based on the name and/or IP address of the failing remote host. For local
19717 deliveries, the key is normally the entire address, including both the local
19718 part and the domain. This is suitable for most common cases of local delivery
19719 temporary failure &-- for example, exceeding a mailbox quota should delay only
19720 deliveries to that mailbox, not to the whole domain.
19721
19722 However, in some special cases you may want to treat a temporary local delivery
19723 as a failure associated with the domain, and not with a particular local part.
19724 (For example, if you are storing all mail for some domain in files.) You can do
19725 this by setting &%retry_use_local_part%& false.
19726
19727 For all the local transports, its default value is true. For remote transports,
19728 the default value is false for tidiness, but changing the value has no effect
19729 on a remote transport in the current implementation.
19730
19731
19732 .option return_path transports string&!! unset
19733 .cindex "envelope sender"
19734 .cindex "transport" "return path; changing"
19735 .cindex "return path" "changing in transport"
19736 If this option is set, the string is expanded at transport time and replaces
19737 the existing return path (envelope sender) value in the copy of the message
19738 that is being delivered. An empty return path is permitted. This feature is
19739 designed for remote deliveries, where the value of this option is used in the
19740 SMTP MAIL command. If you set &%return_path%& for a local transport, the
19741 only effect is to change the address that is placed in the &'Return-path:'&
19742 header line, if one is added to the message (see the next option).
19743
19744 &*Note:*& A changed return path is not logged unless you add
19745 &%return_path_on_delivery%& to the log selector.
19746
19747 .vindex "&$return_path$&"
19748 The expansion can refer to the existing value via &$return_path$&. This is
19749 either the message's envelope sender, or an address set by the
19750 &%errors_to%& option on a router. If the expansion is forced to fail, no
19751 replacement occurs; if it fails for another reason, delivery is deferred. This
19752 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19753 section &<<SECTverp>>&.
19754
19755 &*Note*&: If a delivery error is detected locally, including the case when a
19756 remote server rejects a message at SMTP time, the bounce message is not sent to
19757 the value of this option. It is sent to the previously set errors address.
19758 This defaults to the incoming sender address, but can be changed by setting
19759 &%errors_to%& in a router.
19760
19761
19762
19763 .option return_path_add transports boolean false
19764 .cindex "&'Return-path:'& header line"
19765 If this option is true, a &'Return-path:'& header is added to the message.
19766 Although the return path is normally available in the prefix line of BSD
19767 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19768 have easy access to it.
19769
19770 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19771 the delivery SMTP server makes the final delivery"&. This implies that this
19772 header should not be present in incoming messages. Exim has a configuration
19773 option, &%return_path_remove%&, which requests removal of this header from
19774 incoming messages, so that delivered messages can safely be resent to other
19775 recipients.
19776
19777
19778 .option shadow_condition transports string&!! unset
19779 See &%shadow_transport%& below.
19780
19781
19782 .option shadow_transport transports string unset
19783 .cindex "shadow transport"
19784 .cindex "transport" "shadow"
19785 A local transport may set the &%shadow_transport%& option to the name of
19786 another local transport. Shadow remote transports are not supported.
19787
19788 Whenever a delivery to the main transport succeeds, and either
19789 &%shadow_condition%& is unset, or its expansion does not result in the empty
19790 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
19791 passed to the shadow transport, with the same delivery address or addresses. If
19792 expansion fails, no action is taken except that non-forced expansion failures
19793 cause a log line to be written.
19794
19795 The result of the shadow transport is discarded and does not affect the
19796 subsequent processing of the message. Only a single level of shadowing is
19797 provided; the &%shadow_transport%& option is ignored on any transport when it
19798 is running as a shadow. Options concerned with output from pipes are also
19799 ignored. The log line for the successful delivery has an item added on the end,
19800 of the form
19801 .code
19802 ST=<shadow transport name>
19803 .endd
19804 If the shadow transport did not succeed, the error message is put in
19805 parentheses afterwards. Shadow transports can be used for a number of different
19806 purposes, including keeping more detailed log information than Exim normally
19807 provides, and implementing automatic acknowledgment policies based on message
19808 headers that some sites insist on.
19809
19810
19811 .option transport_filter transports string&!! unset
19812 .cindex "transport" "filter"
19813 .cindex "filter" "transport filter"
19814 This option sets up a filtering (in the Unix shell sense) process for messages
19815 at transport time. It should not be confused with mail filtering as set up by
19816 individual users or via a system filter.
19817
19818 When the message is about to be written out, the command specified by
19819 &%transport_filter%& is started up in a separate, parallel process, and
19820 the entire message, including the header lines, is passed to it on its standard
19821 input (this in fact is done from a third process, to avoid deadlock). The
19822 command must be specified as an absolute path.
19823
19824 The lines of the message that are written to the transport filter are
19825 terminated by newline (&"\n"&). The message is passed to the filter before any
19826 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
19827 lines beginning with a dot, and also before any processing implied by the
19828 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
19829 &(pipe)& transports.
19830
19831 The standard error for the filter process is set to the same destination as its
19832 standard output; this is read and written to the message's ultimate
19833 destination. The process that writes the message to the filter, the
19834 filter itself, and the original process that reads the result and delivers it
19835 are all run in parallel, like a shell pipeline.
19836
19837 The filter can perform any transformations it likes, but of course should take
19838 care not to break RFC 2822 syntax. Exim does not check the result, except to
19839 test for a final newline when SMTP is in use. All messages transmitted over
19840 SMTP must end with a newline, so Exim supplies one if it is missing.
19841
19842 .cindex "content scanning" "per user"
19843 A transport filter can be used to provide content-scanning on a per-user basis
19844 at delivery time if the only required effect of the scan is to modify the
19845 message. For example, a content scan could insert a new header line containing
19846 a spam score. This could be interpreted by a filter in the user's MUA. It is
19847 not possible to discard a message at this stage.
19848
19849 .cindex "SMTP" "SIZE"
19850 A problem might arise if the filter increases the size of a message that is
19851 being sent down an SMTP connection. If the receiving SMTP server has indicated
19852 support for the SIZE parameter, Exim will have sent the size of the message
19853 at the start of the SMTP session. If what is actually sent is substantially
19854 more, the server might reject the message. This can be worked round by setting
19855 the &%size_addition%& option on the &(smtp)& transport, either to allow for
19856 additions to the message, or to disable the use of SIZE altogether.
19857
19858 .vindex "&$pipe_addresses$&"
19859 The value of the &%transport_filter%& option is the command string for starting
19860 the filter, which is run directly from Exim, not under a shell. The string is
19861 parsed by Exim in the same way as a command string for the &(pipe)& transport:
19862 Exim breaks it up into arguments and then expands each argument separately (see
19863 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
19864 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
19865 of arguments, one for each address that applies to this delivery. (This isn't
19866 an ideal name for this feature here, but as it was already implemented for the
19867 &(pipe)& transport, it seemed sensible not to change it.)
19868
19869 .vindex "&$host$&"
19870 .vindex "&$host_address$&"
19871 The expansion variables &$host$& and &$host_address$& are available when the
19872 transport is a remote one. They contain the name and IP address of the host to
19873 which the message is being sent. For example:
19874 .code
19875 transport_filter = /some/directory/transport-filter.pl \
19876   $host $host_address $sender_address $pipe_addresses
19877 .endd
19878
19879 Two problems arise if you want to use more complicated expansion items to
19880 generate transport filter commands, both of which due to the fact that the
19881 command is split up &'before'& expansion.
19882 .ilist
19883 If an expansion item contains white space, you must quote it, so that it is all
19884 part of the same command item. If the entire option setting is one such
19885 expansion item, you have to take care what kind of quoting you use. For
19886 example:
19887 .code
19888 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
19889 .endd
19890 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
19891 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
19892 stripped by Exim when it read the option's value. When the value is used, if
19893 the single quotes were missing, the line would be split into two items,
19894 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
19895 Exim tried to expand the first one.
19896 .next
19897 Except for the special case of &$pipe_addresses$& that is mentioned above, an
19898 expansion cannot generate multiple arguments, or a command name followed by
19899 arguments. Consider this example:
19900 .code
19901 transport_filter = ${lookup{$host}lsearch{/a/file}\
19902                     {$value}{/bin/cat}}
19903 .endd
19904 The result of the lookup is interpreted as the name of the command, even
19905 if it contains white space. The simplest way round this is to use a shell:
19906 .code
19907 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
19908                                {$value}{/bin/cat}}
19909 .endd
19910 .endlist
19911
19912 The filter process is run under the same uid and gid as the normal delivery.
19913 For remote deliveries this is the Exim uid/gid by default. The command should
19914 normally yield a zero return code. Transport filters are not supposed to fail.
19915 A non-zero code is taken to mean that the transport filter encountered some
19916 serious problem. Delivery of the message is deferred; the message remains on
19917 the queue and is tried again later. It is not possible to cause a message to be
19918 bounced from a transport filter.
19919
19920 If a transport filter is set on an autoreply transport, the original message is
19921 passed through the filter as it is being copied into the newly generated
19922 message, which happens if the &%return_message%& option is set.
19923
19924
19925 .option transport_filter_timeout transports time 5m
19926 .cindex "transport" "filter, timeout"
19927 When Exim is reading the output of a transport filter, it applies a timeout
19928 that can be set by this option. Exceeding the timeout is normally treated as a
19929 temporary delivery failure. However, if a transport filter is used with a
19930 &(pipe)& transport, a timeout in the transport filter is treated in the same
19931 way as a timeout in the pipe command itself. By default, a timeout is a hard
19932 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
19933 becomes a temporary error.
19934
19935
19936 .option user transports string&!! "Exim user"
19937 .cindex "uid (user id)" "local delivery"
19938 .cindex "transport" "user, specifying"
19939 This option specifies the user under whose uid the delivery process is to be
19940 run, overriding any uid that may have been set by the router. If the user is
19941 given as a name, the uid is looked up from the password data, and the
19942 associated group is taken as the value of the gid to be used if the &%group%&
19943 option is not set.
19944
19945 For deliveries that use local transports, a user and group are normally
19946 specified explicitly or implicitly (for example, as a result of
19947 &%check_local_user%&) by the router or transport.
19948
19949 .cindex "hints database" "access by remote transport"
19950 For remote transports, you should leave this option unset unless you really are
19951 sure you know what you are doing. When a remote transport is running, it needs
19952 to be able to access Exim's hints databases, because each host may have its own
19953 retry data.
19954 .ecindex IIDgenoptra1
19955 .ecindex IIDgenoptra2
19956 .ecindex IIDgenoptra3
19957
19958
19959
19960
19961
19962
19963 . ////////////////////////////////////////////////////////////////////////////
19964 . ////////////////////////////////////////////////////////////////////////////
19965
19966 .chapter "Address batching in local transports" "CHAPbatching" &&&
19967          "Address batching"
19968 .cindex "transport" "local; address batching in"
19969 The only remote transport (&(smtp)&) is normally configured to handle more than
19970 one address at a time, so that when several addresses are routed to the same
19971 remote host, just one copy of the message is sent. Local transports, however,
19972 normally handle one address at a time. That is, a separate instance of the
19973 transport is run for each address that is routed to the transport. A separate
19974 copy of the message is delivered each time.
19975
19976 .cindex "batched local delivery"
19977 .oindex "&%batch_max%&"
19978 .oindex "&%batch_id%&"
19979 In special cases, it may be desirable to handle several addresses at once in a
19980 local transport, for example:
19981
19982 .ilist
19983 In an &(appendfile)& transport, when storing messages in files for later
19984 delivery by some other means, a single copy of the message with multiple
19985 recipients saves space.
19986 .next
19987 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
19988 a single copy saves time, and is the normal way LMTP is expected to work.
19989 .next
19990 In a &(pipe)& transport, when passing the message
19991 to a scanner program or
19992 to some other delivery mechanism such as UUCP, multiple recipients may be
19993 acceptable.
19994 .endlist
19995
19996 These three local transports all have the same options for controlling multiple
19997 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
19998 repeating the information for each transport, these options are described here.
19999
20000 The &%batch_max%& option specifies the maximum number of addresses that can be
20001 delivered together in a single run of the transport. Its default value is one
20002 (no batching). When more than one address is routed to a transport that has a
20003 &%batch_max%& value greater than one, the addresses are delivered in a batch
20004 (that is, in a single run of the transport with multiple recipients), subject
20005 to certain conditions:
20006
20007 .ilist
20008 .vindex "&$local_part$&"
20009 If any of the transport's options contain a reference to &$local_part$&, no
20010 batching is possible.
20011 .next
20012 .vindex "&$domain$&"
20013 If any of the transport's options contain a reference to &$domain$&, only
20014 addresses with the same domain are batched.
20015 .next
20016 .cindex "customizing" "batching condition"
20017 If &%batch_id%& is set, it is expanded for each address, and only those
20018 addresses with the same expanded value are batched. This allows you to specify
20019 customized batching conditions. Failure of the expansion for any reason,
20020 including forced failure, disables batching, but it does not stop the delivery
20021 from taking place.
20022 .next
20023 Batched addresses must also have the same errors address (where to send
20024 delivery errors), the same header additions and removals, the same user and
20025 group for the transport, and if a host list is present, the first host must
20026 be the same.
20027 .endlist
20028
20029 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20030 both when the file or pipe command is specified in the transport, and when it
20031 is specified by a &(redirect)& router, but all the batched addresses must of
20032 course be routed to the same file or pipe command. These two transports have an
20033 option called &%use_bsmtp%&, which causes them to deliver the message in
20034 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20035 &%check_string%& and &%escape_string%& options are forced to the values
20036 .code
20037 check_string = "."
20038 escape_string = ".."
20039 .endd
20040 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20041 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20042 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20043
20044 .cindex "&'Envelope-to:'& header line"
20045 If the generic &%envelope_to_add%& option is set for a batching transport, the
20046 &'Envelope-to:'& header that is added to the message contains all the addresses
20047 that are being processed together. If you are using a batching &(appendfile)&
20048 transport without &%use_bsmtp%&, the only way to preserve the recipient
20049 addresses is to set the &%envelope_to_add%& option.
20050
20051 .cindex "&(pipe)& transport" "with multiple addresses"
20052 .vindex "&$pipe_addresses$&"
20053 If you are using a &(pipe)& transport without BSMTP, and setting the
20054 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20055 the command. This is not a true variable; it is a bit of magic that causes each
20056 of the recipient addresses to be inserted into the command as a separate
20057 argument. This provides a way of accessing all the addresses that are being
20058 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20059 are specified by a &(redirect)& router.
20060
20061
20062
20063
20064 . ////////////////////////////////////////////////////////////////////////////
20065 . ////////////////////////////////////////////////////////////////////////////
20066
20067 .chapter "The appendfile transport" "CHAPappendfile"
20068 .scindex IIDapptra1 "&(appendfile)& transport"
20069 .scindex IIDapptra2 "transports" "&(appendfile)&"
20070 .cindex "directory creation"
20071 .cindex "creating directories"
20072 The &(appendfile)& transport delivers a message by appending it to an existing
20073 file, or by creating an entirely new file in a specified directory. Single
20074 files to which messages are appended can be in the traditional Unix mailbox
20075 format, or optionally in the MBX format supported by the Pine MUA and
20076 University of Washington IMAP daemon, &'inter alia'&. When each message is
20077 being delivered as a separate file, &"maildir"& format can optionally be used
20078 to give added protection against failures that happen part-way through the
20079 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20080 supported. For all file formats, Exim attempts to create as many levels of
20081 directory as necessary, provided that &%create_directory%& is set.
20082
20083 The code for the optional formats is not included in the Exim binary by
20084 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20085 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20086 included.
20087
20088 .cindex "quota" "system"
20089 Exim recognizes system quota errors, and generates an appropriate message. Exim
20090 also supports its own quota control within the transport, for use when the
20091 system facility is unavailable or cannot be used for some reason.
20092
20093 If there is an error while appending to a file (for example, quota exceeded or
20094 partition filled), Exim attempts to reset the file's length and last
20095 modification time back to what they were before. If there is an error while
20096 creating an entirely new file, the new file is removed.
20097
20098 Before appending to a file, a number of security checks are made, and the
20099 file is locked. A detailed description is given below, after the list of
20100 private options.
20101
20102 The &(appendfile)& transport is most commonly used for local deliveries to
20103 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20104 putting messages into files for remote delivery by some means other than Exim.
20105 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20106 option).
20107
20108
20109
20110 .section "The file and directory options" "SECTfildiropt"
20111 The &%file%& option specifies a single file, to which the message is appended;
20112 the &%directory%& option specifies a directory, in which a new file containing
20113 the message is created. Only one of these two options can be set, and for
20114 normal deliveries to mailboxes, one of them &'must'& be set.
20115
20116 .vindex "&$address_file$&"
20117 .vindex "&$local_part$&"
20118 However, &(appendfile)& is also used for delivering messages to files or
20119 directories whose names (or parts of names) are obtained from alias,
20120 forwarding, or filtering operations (for example, a &%save%& command in a
20121 user's Exim filter). When such a transport is running, &$local_part$& contains
20122 the local part that was aliased or forwarded, and &$address_file$& contains the
20123 name (or partial name) of the file or directory generated by the redirection
20124 operation. There are two cases:
20125
20126 .ilist
20127 If neither &%file%& nor &%directory%& is set, the redirection operation
20128 must specify an absolute path (one that begins with &`/`&). This is the most
20129 common case when users with local accounts use filtering to sort mail into
20130 different folders. See for example, the &(address_file)& transport in the
20131 default configuration. If the path ends with a slash, it is assumed to be the
20132 name of a directory. A delivery to a directory can also be forced by setting
20133 &%maildir_format%& or &%mailstore_format%&.
20134 .next
20135 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20136 used to determine the file or directory name for the delivery. Normally, the
20137 contents of &$address_file$& are used in some way in the string expansion.
20138 .endlist
20139
20140
20141 .cindex "Sieve filter" "configuring &(appendfile)&"
20142 .cindex "Sieve filter" "relative mailbox path handling"
20143 As an example of the second case, consider an environment where users do not
20144 have home directories. They may be permitted to use Exim filter commands of the
20145 form:
20146 .code
20147 save folder23
20148 .endd
20149 or Sieve filter commands of the form:
20150 .code
20151 require "fileinto";
20152 fileinto "folder23";
20153 .endd
20154 In this situation, the expansion of &%file%& or &%directory%& in the transport
20155 must transform the relative path into an appropriate absolute file name. In the
20156 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20157 is used as a result of a &"keep"& action in the filter. This example shows one
20158 way of handling this requirement:
20159 .code
20160 file = ${if eq{$address_file}{inbox} \
20161             {/var/mail/$local_part} \
20162             {${if eq{${substr_0_1:$address_file}}{/} \
20163                   {$address_file} \
20164                   {$home/mail/$address_file} \
20165             }} \
20166        }
20167 .endd
20168 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20169 location, absolute paths are used without change, and other folders are in the
20170 &_mail_& directory within the home directory.
20171
20172 &*Note 1*&: While processing an Exim filter, a relative path such as
20173 &_folder23_& is turned into an absolute path if a home directory is known to
20174 the router. In particular, this is the case if &%check_local_user%& is set. If
20175 you want to prevent this happening at routing time, you can set
20176 &%router_home_directory%& empty. This forces the router to pass the relative
20177 path to the transport.
20178
20179 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20180 the &%file%& or &%directory%& option is still used if it is set.
20181
20182
20183
20184
20185 .section "Private options for appendfile" "SECID134"
20186 .cindex "options" "&(appendfile)& transport"
20187
20188
20189
20190 .option allow_fifo appendfile boolean false
20191 .cindex "fifo (named pipe)"
20192 .cindex "named pipe (fifo)"
20193 .cindex "pipe" "named (fifo)"
20194 Setting this option permits delivery to named pipes (FIFOs) as well as to
20195 regular files. If no process is reading the named pipe at delivery time, the
20196 delivery is deferred.
20197
20198
20199 .option allow_symlink appendfile boolean false
20200 .cindex "symbolic link" "to mailbox"
20201 .cindex "mailbox" "symbolic link"
20202 By default, &(appendfile)& will not deliver if the path name for the file is
20203 that of a symbolic link. Setting this option relaxes that constraint, but there
20204 are security issues involved in the use of symbolic links. Be sure you know
20205 what you are doing if you set this. Details of exactly what this option affects
20206 are included in the discussion which follows this list of options.
20207
20208
20209 .option batch_id appendfile string&!! unset
20210 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20211 However, batching is automatically disabled for &(appendfile)& deliveries that
20212 happen as a result of forwarding or aliasing or other redirection directly to a
20213 file.
20214
20215
20216 .option batch_max appendfile integer 1
20217 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20218
20219
20220 .option check_group appendfile boolean false
20221 When this option is set, the group owner of the file defined by the &%file%&
20222 option is checked to see that it is the same as the group under which the
20223 delivery process is running. The default setting is false because the default
20224 file mode is 0600, which means that the group is irrelevant.
20225
20226
20227 .option check_owner appendfile boolean true
20228 When this option is set, the owner of the file defined by the &%file%& option
20229 is checked to ensure that it is the same as the user under which the delivery
20230 process is running.
20231
20232
20233 .option check_string appendfile string "see below"
20234 .cindex "&""From""& line"
20235 As &(appendfile)& writes the message, the start of each line is tested for
20236 matching &%check_string%&, and if it does, the initial matching characters are
20237 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
20238 a literal string, not a regular expression, and the case of any letters it
20239 contains is significant.
20240
20241 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
20242 are forced to &"."& and &".."& respectively, and any settings in the
20243 configuration are ignored. Otherwise, they default to &"From&~"& and
20244 &">From&~"& when the &%file%& option is set, and unset when any of the
20245 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
20246
20247 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
20248 suitable for traditional &"BSD"& mailboxes, where a line beginning with
20249 &"From&~"& indicates the start of a new message. All four options need changing
20250 if another format is used. For example, to deliver to mailboxes in MMDF format:
20251 .cindex "MMDF format mailbox"
20252 .cindex "mailbox" "MMDF format"
20253 .code
20254 check_string = "\1\1\1\1\n"
20255 escape_string = "\1\1\1\1 \n"
20256 message_prefix = "\1\1\1\1\n"
20257 message_suffix = "\1\1\1\1\n"
20258 .endd
20259 .option create_directory appendfile boolean true
20260 .cindex "directory creation"
20261 When this option is true, Exim attempts to create any missing superior
20262 directories for the file that it is about to write. A created directory's mode
20263 is given by the &%directory_mode%& option.
20264
20265 The group ownership of a newly created directory is highly dependent on the
20266 operating system (and possibly the file system) that is being used. For
20267 example, in Solaris, if the parent directory has the setgid bit set, its group
20268 is propagated to the child; if not, the currently set group is used. However,
20269 in FreeBSD, the parent's group is always used.
20270
20271
20272
20273 .option create_file appendfile string anywhere
20274 This option constrains the location of files and directories that are created
20275 by this transport. It applies to files defined by the &%file%& option and
20276 directories defined by the &%directory%& option. In the case of maildir
20277 delivery, it applies to the top level directory, not the maildir directories
20278 beneath.
20279
20280 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20281 &"belowhome"&. In the second and third cases, a home directory must have been
20282 set for the transport. This option is not useful when an explicit file name is
20283 given for normal mailbox deliveries. It is intended for the case when file
20284 names are generated from users' &_.forward_& files. These are usually handled
20285 by an &(appendfile)& transport called &%address_file%&. See also
20286 &%file_must_exist%&.
20287
20288
20289 .option directory appendfile string&!! unset
20290 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20291 or &%directory%& must be set, unless the delivery is the direct result of a
20292 redirection (see section &<<SECTfildiropt>>&).
20293
20294 When &%directory%& is set, the string is expanded, and the message is delivered
20295 into a new file or files in or below the given directory, instead of being
20296 appended to a single mailbox file. A number of different formats are provided
20297 (see &%maildir_format%& and &%mailstore_format%&), and see section
20298 &<<SECTopdir>>& for further details of this form of delivery.
20299
20300
20301 .option directory_file appendfile string&!! "see below"
20302 .cindex "base62"
20303 .vindex "&$inode$&"
20304 When &%directory%& is set, but neither &%maildir_format%& nor
20305 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20306 whose name is obtained by expanding this string. The default value is:
20307 .code
20308 q${base62:$tod_epoch}-$inode
20309 .endd
20310 This generates a unique name from the current time, in base 62 form, and the
20311 inode of the file. The variable &$inode$& is available only when expanding this
20312 option.
20313
20314
20315 .option directory_mode appendfile "octal integer" 0700
20316 If &(appendfile)& creates any directories as a result of the
20317 &%create_directory%& option, their mode is specified by this option.
20318
20319
20320 .option escape_string appendfile string "see description"
20321 See &%check_string%& above.
20322
20323
20324 .option file appendfile string&!! unset
20325 This option is mutually exclusive with the &%directory%& option, but one of
20326 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20327 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20328 specifies a single file, to which the message is appended. One or more of
20329 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20330 &%file%&.
20331
20332 .cindex "NFS" "lock file"
20333 .cindex "locking files"
20334 .cindex "lock files"
20335 If you are using more than one host to deliver over NFS into the same
20336 mailboxes, you should always use lock files.
20337
20338 The string value is expanded for each delivery, and must yield an absolute
20339 path. The most common settings of this option are variations on one of these
20340 examples:
20341 .code
20342 file = /var/spool/mail/$local_part
20343 file = /home/$local_part/inbox
20344 file = $home/inbox
20345 .endd
20346 .cindex "&""sticky""& bit"
20347 In the first example, all deliveries are done into the same directory. If Exim
20348 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20349 create a file in the directory, so the &"sticky"& bit must be turned on for
20350 deliveries to be possible, or alternatively the &%group%& option can be used to
20351 run the delivery under a group id which has write access to the directory.
20352
20353
20354
20355 .option file_format appendfile string unset
20356 .cindex "file" "mailbox; checking existing format"
20357 This option requests the transport to check the format of an existing file
20358 before adding to it. The check consists of matching a specific string at the
20359 start of the file. The value of the option consists of an even number of
20360 colon-separated strings. The first of each pair is the test string, and the
20361 second is the name of a transport. If the transport associated with a matched
20362 string is not the current transport, control is passed over to the other
20363 transport. For example, suppose the standard &(local_delivery)& transport has
20364 this added to it:
20365 .code
20366 file_format = "From       : local_delivery :\
20367                \1\1\1\1\n : local_mmdf_delivery"
20368 .endd
20369 Mailboxes that begin with &"From"& are still handled by this transport, but if
20370 a mailbox begins with four binary ones followed by a newline, control is passed
20371 to a transport called &%local_mmdf_delivery%&, which presumably is configured
20372 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
20373 is assumed to match the current transport. If the start of a mailbox doesn't
20374 match any string, or if the transport named for a given string is not defined,
20375 delivery is deferred.
20376
20377
20378 .option file_must_exist appendfile boolean false
20379 If this option is true, the file specified by the &%file%& option must exist.
20380 A temporary error occurs if it does not, causing delivery to be deferred.
20381 If this option is false, the file is created if it does not exist.
20382
20383
20384 .option lock_fcntl_timeout appendfile time 0s
20385 .cindex "timeout" "mailbox locking"
20386 .cindex "mailbox" "locking, blocking and non-blocking"
20387 .cindex "locking files"
20388 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
20389 when locking an open mailbox file. If the call fails, the delivery process
20390 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
20391 Non-blocking calls are used so that the file is not kept open during the wait
20392 for the lock; the reason for this is to make it as safe as possible for
20393 deliveries over NFS in the case when processes might be accessing an NFS
20394 mailbox without using a lock file. This should not be done, but
20395 misunderstandings and hence misconfigurations are not unknown.
20396
20397 On a busy system, however, the performance of a non-blocking lock approach is
20398 not as good as using a blocking lock with a timeout. In this case, the waiting
20399 is done inside the system call, and Exim's delivery process acquires the lock
20400 and can proceed as soon as the previous lock holder releases it.
20401
20402 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
20403 timeout, are used. There may still be some retrying: the maximum number of
20404 retries is
20405 .code
20406 (lock_retries * lock_interval) / lock_fcntl_timeout
20407 .endd
20408 rounded up to the next whole number. In other words, the total time during
20409 which &(appendfile)& is trying to get a lock is roughly the same, unless
20410 &%lock_fcntl_timeout%& is set very large.
20411
20412 You should consider setting this option if you are getting a lot of delayed
20413 local deliveries because of errors of the form
20414 .code
20415 failed to lock mailbox /some/file (fcntl)
20416 .endd
20417
20418 .option lock_flock_timeout appendfile time 0s
20419 This timeout applies to file locking when using &[flock()]& (see
20420 &%use_flock%&); the timeout operates in a similar manner to
20421 &%lock_fcntl_timeout%&.
20422
20423
20424 .option lock_interval appendfile time 3s
20425 This specifies the time to wait between attempts to lock the file. See below
20426 for details of locking.
20427
20428
20429 .option lock_retries appendfile integer 10
20430 This specifies the maximum number of attempts to lock the file. A value of zero
20431 is treated as 1. See below for details of locking.
20432
20433
20434 .option lockfile_mode appendfile "octal integer" 0600
20435 This specifies the mode of the created lock file, when a lock file is being
20436 used (see &%use_lockfile%& and &%use_mbx_lock%&).
20437
20438
20439 .option lockfile_timeout appendfile time 30m
20440 .cindex "timeout" "mailbox locking"
20441 When a lock file is being used (see &%use_lockfile%&), if a lock file already
20442 exists and is older than this value, it is assumed to have been left behind by
20443 accident, and Exim attempts to remove it.
20444
20445
20446 .option mailbox_filecount appendfile string&!! unset
20447 .cindex "mailbox" "specifying size of"
20448 .cindex "size" "of mailbox"
20449 If this option is set, it is expanded, and the result is taken as the current
20450 number of files in the mailbox. It must be a decimal number, optionally
20451 followed by K or M. This provides a way of obtaining this information from an
20452 external source that maintains the data.
20453
20454
20455 .option mailbox_size appendfile string&!! unset
20456 .cindex "mailbox" "specifying size of"
20457 .cindex "size" "of mailbox"
20458 If this option is set, it is expanded, and the result is taken as the current
20459 size the mailbox. It must be a decimal number, optionally followed by K or M.
20460 This provides a way of obtaining this information from an external source that
20461 maintains the data. This is likely to be helpful for maildir deliveries where
20462 it is computationally expensive to compute the size of a mailbox.
20463
20464
20465
20466 .option maildir_format appendfile boolean false
20467 .cindex "maildir format" "specifying"
20468 If this option is set with the &%directory%& option, the delivery is into a new
20469 file, in the &"maildir"& format that is used by other mail software. When the
20470 transport is activated directly from a &(redirect)& router (for example, the
20471 &(address_file)& transport in the default configuration), setting
20472 &%maildir_format%& causes the path received from the router to be treated as a
20473 directory, whether or not it ends with &`/`&. This option is available only if
20474 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
20475 &<<SECTmaildirdelivery>>& below for further details.
20476
20477
20478 .option maildir_quota_directory_regex appendfile string "See below"
20479 .cindex "maildir format" "quota; directories included in"
20480 .cindex "quota" "maildir; directories included in"
20481 This option is relevant only when &%maildir_use_size_file%& is set. It defines
20482 a regular expression for specifying directories, relative to the quota
20483 directory (see &%quota_directory%&), that should be included in the quota
20484 calculation. The default value is:
20485 .code
20486 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
20487 .endd
20488 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
20489 (directories whose names begin with a dot). If you want to exclude the
20490 &_Trash_&
20491 folder from the count (as some sites do), you need to change this setting to
20492 .code
20493 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
20494 .endd
20495 This uses a negative lookahead in the regular expression to exclude the
20496 directory whose name is &_.Trash_&. When a directory is excluded from quota
20497 calculations, quota processing is bypassed for any messages that are delivered
20498 directly into that directory.
20499
20500
20501 .option maildir_retries appendfile integer 10
20502 This option specifies the number of times to retry when writing a file in
20503 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
20504
20505
20506 .option maildir_tag appendfile string&!! unset
20507 This option applies only to deliveries in maildir format, and is described in
20508 section &<<SECTmaildirdelivery>>& below.
20509
20510
20511 .option maildir_use_size_file appendfile&!! boolean false
20512 .cindex "maildir format" "&_maildirsize_& file"
20513 The result of string expansion for this option must be a valid boolean value.
20514 If it is true, it enables support for &_maildirsize_& files. Exim
20515 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
20516 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
20517 value is zero. See &%maildir_quota_directory_regex%& above and section
20518 &<<SECTmaildirdelivery>>& below for further details.
20519
20520 .option maildirfolder_create_regex appendfile string unset
20521 .cindex "maildir format" "&_maildirfolder_& file"
20522 .cindex "&_maildirfolder_&, creating"
20523 The value of this option is a regular expression. If it is unset, it has no
20524 effect. Otherwise, before a maildir delivery takes place, the pattern is
20525 matched against the name of the maildir directory, that is, the directory
20526 containing the &_new_& and &_tmp_& subdirectories that will be used for the
20527 delivery. If there is a match, Exim checks for the existence of a file called
20528 &_maildirfolder_& in the directory, and creates it if it does not exist.
20529 See section &<<SECTmaildirdelivery>>& for more details.
20530
20531
20532 .option mailstore_format appendfile boolean false
20533 .cindex "mailstore format" "specifying"
20534 If this option is set with the &%directory%& option, the delivery is into two
20535 new files in  &"mailstore"& format. The option is available only if
20536 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
20537 below for further details.
20538
20539
20540 .option mailstore_prefix appendfile string&!! unset
20541 This option applies only to deliveries in mailstore format, and is described in
20542 section &<<SECTopdir>>& below.
20543
20544
20545 .option mailstore_suffix appendfile string&!! unset
20546 This option applies only to deliveries in mailstore format, and is described in
20547 section &<<SECTopdir>>& below.
20548
20549
20550 .option mbx_format appendfile boolean false
20551 .cindex "locking files"
20552 .cindex "file" "locking"
20553 .cindex "file" "MBX format"
20554 .cindex "MBX format, specifying"
20555 This option is available only if Exim has been compiled with SUPPORT_MBX
20556 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
20557 the message is appended to the mailbox file in MBX format instead of
20558 traditional Unix format. This format is supported by Pine4 and its associated
20559 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
20560
20561 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
20562 automatically changed by the use of &%mbx_format%&. They should normally be set
20563 empty when using MBX format, so this option almost always appears in this
20564 combination:
20565 .code
20566 mbx_format = true
20567 message_prefix =
20568 message_suffix =
20569 .endd
20570 If none of the locking options are mentioned in the configuration,
20571 &%use_mbx_lock%& is assumed and the other locking options default to false. It
20572 is possible to specify the other kinds of locking with &%mbx_format%&, but
20573 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
20574 interworks with &'c-client'&, providing for shared access to the mailbox. It
20575 should not be used if any program that does not use this form of locking is
20576 going to access the mailbox, nor should it be used if the mailbox file is NFS
20577 mounted, because it works only when the mailbox is accessed from a single host.
20578
20579 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
20580 the standard version of &'c-client'&, because as long as it has a mailbox open
20581 (this means for the whole of a Pine or IMAP session), Exim will not be able to
20582 append messages to it.
20583
20584
20585 .option message_prefix appendfile string&!! "see below"
20586 .cindex "&""From""& line"
20587 The string specified here is expanded and output at the start of every message.
20588 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20589 in which case it is:
20590 .code
20591 message_prefix = "From ${if def:return_path{$return_path}\
20592   {MAILER-DAEMON}} $tod_bsdinbox\n"
20593 .endd
20594 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20595 &`\n`& to &`\r\n`& in &%message_prefix%&.
20596
20597 .option message_suffix appendfile string&!! "see below"
20598 The string specified here is expanded and output at the end of every message.
20599 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20600 in which case it is a single newline character. The suffix can be suppressed by
20601 setting
20602 .code
20603 message_suffix =
20604 .endd
20605 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20606 &`\n`& to &`\r\n`& in &%message_suffix%&.
20607
20608 .option mode appendfile "octal integer" 0600
20609 If the output file is created, it is given this mode. If it already exists and
20610 has wider permissions, they are reduced to this mode. If it has narrower
20611 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
20612 if the delivery is the result of a &%save%& command in a filter file specifying
20613 a particular mode, the mode of the output file is always forced to take that
20614 value, and this option is ignored.
20615
20616
20617 .option mode_fail_narrower appendfile boolean true
20618 This option applies in the case when an existing mailbox file has a narrower
20619 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
20620 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
20621 continues with the delivery attempt, using the existing mode of the file.
20622
20623
20624 .option notify_comsat appendfile boolean false
20625 If this option is true, the &'comsat'& daemon is notified after every
20626 successful delivery to a user mailbox. This is the daemon that notifies logged
20627 on users about incoming mail.
20628
20629
20630 .option quota appendfile string&!! unset
20631 .cindex "quota" "imposed by Exim"
20632 This option imposes a limit on the size of the file to which Exim is appending,
20633 or to the total space used in the directory tree when the &%directory%& option
20634 is set. In the latter case, computation of the space used is expensive, because
20635 all the files in the directory (and any sub-directories) have to be
20636 individually inspected and their sizes summed. (See &%quota_size_regex%& and
20637 &%maildir_use_size_file%& for ways to avoid this in environments where users
20638 have no shell access to their mailboxes).
20639
20640 As there is no interlock against two simultaneous deliveries into a
20641 multi-file mailbox, it is possible for the quota to be overrun in this case.
20642 For single-file mailboxes, of course, an interlock is a necessity.
20643
20644 A file's size is taken as its &'used'& value. Because of blocking effects, this
20645 may be a lot less than the actual amount of disk space allocated to the file.
20646 If the sizes of a number of files are being added up, the rounding effect can
20647 become quite noticeable, especially on systems that have large block sizes.
20648 Nevertheless, it seems best to stick to the &'used'& figure, because this is
20649 the obvious value which users understand most easily.
20650
20651 The value of the option is expanded, and must then be a numerical value
20652 (decimal point allowed), optionally followed by one of the letters K, M, or G,
20653 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
20654 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
20655 be handled.
20656
20657 &*Note*&: A value of zero is interpreted as &"no quota"&.
20658
20659 The expansion happens while Exim is running as root, before it changes uid for
20660 the delivery. This means that files that are inaccessible to the end user can
20661 be used to hold quota values that are looked up in the expansion. When delivery
20662 fails because this quota is exceeded, the handling of the error is as for
20663 system quota failures.
20664
20665 By default, Exim's quota checking mimics system quotas, and restricts the
20666 mailbox to the specified maximum size, though the value is not accurate to the
20667 last byte, owing to separator lines and additional headers that may get added
20668 during message delivery. When a mailbox is nearly full, large messages may get
20669 refused even though small ones are accepted, because the size of the current
20670 message is added to the quota when the check is made. This behaviour can be
20671 changed by setting &%quota_is_inclusive%& false. When this is done, the check
20672 for exceeding the quota does not include the current message. Thus, deliveries
20673 continue until the quota has been exceeded; thereafter, no further messages are
20674 delivered. See also &%quota_warn_threshold%&.
20675
20676
20677 .option quota_directory appendfile string&!! unset
20678 This option defines the directory to check for quota purposes when delivering
20679 into individual files. The default is the delivery directory, or, if a file
20680 called &_maildirfolder_& exists in a maildir directory, the parent of the
20681 delivery directory.
20682
20683
20684 .option quota_filecount appendfile string&!! 0
20685 This option applies when the &%directory%& option is set. It limits the total
20686 number of files in the directory (compare the inode limit in system quotas). It
20687 can only be used if &%quota%& is also set. The value is expanded; an expansion
20688 failure causes delivery to be deferred. A value of zero is interpreted as
20689 &"no quota"&.
20690
20691
20692 .option quota_is_inclusive appendfile boolean true
20693 See &%quota%& above.
20694
20695
20696 .option quota_size_regex appendfile string unset
20697 This option applies when one of the delivery modes that writes a separate file
20698 for each message is being used. When Exim wants to find the size of one of
20699 these files in order to test the quota, it first checks &%quota_size_regex%&.
20700 If this is set to a regular expression that matches the file name, and it
20701 captures one string, that string is interpreted as a representation of the
20702 file's size. The value of &%quota_size_regex%& is not expanded.
20703
20704 This feature is useful only when users have no shell access to their mailboxes
20705 &-- otherwise they could defeat the quota simply by renaming the files. This
20706 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20707 the file length to the file name. For example:
20708 .code
20709 maildir_tag = ,S=$message_size
20710 quota_size_regex = ,S=(\d+)
20711 .endd
20712 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20713 number of lines in the message.
20714
20715 The regular expression should not assume that the length is at the end of the
20716 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20717 sometimes add other information onto the ends of message file names.
20718
20719 Section &<<SECID136>>& contains further information.
20720
20721
20722 .option quota_warn_message appendfile string&!! "see below"
20723 See below for the use of this option. If it is not set when
20724 &%quota_warn_threshold%& is set, it defaults to
20725 .code
20726 quota_warn_message = "\
20727   To: $local_part@$domain\n\
20728   Subject: Your mailbox\n\n\
20729   This message is automatically created \
20730   by mail delivery software.\n\n\
20731   The size of your mailbox has exceeded \
20732   a warning threshold that is\n\
20733   set by the system administrator.\n"
20734 .endd
20735
20736
20737 .option quota_warn_threshold appendfile string&!! 0
20738 .cindex "quota" "warning threshold"
20739 .cindex "mailbox" "size warning"
20740 .cindex "size" "of mailbox"
20741 This option is expanded in the same way as &%quota%& (see above). If the
20742 resulting value is greater than zero, and delivery of the message causes the
20743 size of the file or total space in the directory tree to cross the given
20744 threshold, a warning message is sent. If &%quota%& is also set, the threshold
20745 may be specified as a percentage of it by following the value with a percent
20746 sign. For example:
20747 .code
20748 quota = 10M
20749 quota_warn_threshold = 75%
20750 .endd
20751 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20752 percent sign is ignored.
20753
20754 The warning message itself is specified by the &%quota_warn_message%& option,
20755 and it must start with a &'To:'& header line containing the recipient(s) of the
20756 warning message. These do not necessarily have to include the recipient(s) of
20757 the original message. A &'Subject:'& line should also normally be supplied. You
20758 can include any other header lines that you want. If you do not include a
20759 &'From:'& line, the default is:
20760 .code
20761 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20762 .endd
20763 .oindex &%errors_reply_to%&
20764 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20765 option.
20766
20767 The &%quota%& option does not have to be set in order to use this option; they
20768 are independent of one another except when the threshold is specified as a
20769 percentage.
20770
20771
20772 .option use_bsmtp appendfile boolean false
20773 .cindex "envelope sender"
20774 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20775 format, with the envelope sender and recipient(s) included as SMTP commands. If
20776 you want to include a leading HELO command with such messages, you can do
20777 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20778 for details of batch SMTP.
20779
20780
20781 .option use_crlf appendfile boolean false
20782 .cindex "carriage return"
20783 .cindex "linefeed"
20784 This option causes lines to be terminated with the two-character CRLF sequence
20785 (carriage return, linefeed) instead of just a linefeed character. In the case
20786 of batched SMTP, the byte sequence written to the file is then an exact image
20787 of what would be sent down a real SMTP connection.
20788
20789 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
20790 (which are used to supply the traditional &"From&~"& and blank line separators
20791 in Berkeley-style mailboxes) are written verbatim, so must contain their own
20792 carriage return characters if these are needed. In cases where these options
20793 have non-empty defaults, the values end with a single linefeed, so they must be
20794 changed to end with &`\r\n`& if &%use_crlf%& is set.
20795
20796
20797 .option use_fcntl_lock appendfile boolean "see below"
20798 This option controls the use of the &[fcntl()]& function to lock a file for
20799 exclusive use when a message is being appended. It is set by default unless
20800 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
20801 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
20802 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
20803
20804
20805 .option use_flock_lock appendfile boolean false
20806 This option is provided to support the use of &[flock()]& for file locking, for
20807 the few situations where it is needed. Most modern operating systems support
20808 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
20809 each other. Exim uses &[fcntl()]& locking by default.
20810
20811 This option is required only if you are using an operating system where
20812 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
20813 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
20814 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
20815
20816 .cindex "Solaris" "&[flock()]& support"
20817 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
20818 have it (and some, I think, provide a not quite right version built on top of
20819 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
20820 the ability to use it, and any attempt to do so will cause a configuration
20821 error.
20822
20823 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
20824 is just being mapped onto &[fcntl()]& by the OS).
20825
20826
20827 .option use_lockfile appendfile boolean "see below"
20828 If this option is turned off, Exim does not attempt to create a lock file when
20829 appending to a mailbox file. In this situation, the only locking is by
20830 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
20831 sure that every MUA that is ever going to look at your users' mailboxes uses
20832 &[fcntl()]& rather than a lock file, and even then only when you are not
20833 delivering over NFS from more than one host.
20834
20835 .cindex "NFS" "lock file"
20836 In order to append to an NFS file safely from more than one host, it is
20837 necessary to take out a lock &'before'& opening the file, and the lock file
20838 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
20839 file corruption.
20840
20841 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
20842 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
20843 except when &%mbx_format%& is set.
20844
20845
20846 .option use_mbx_lock appendfile boolean "see below"
20847 This option is available only if Exim has been compiled with SUPPORT_MBX
20848 set in &_Local/Makefile_&. Setting the option specifies that special MBX
20849 locking rules be used. It is set by default if &%mbx_format%& is set and none
20850 of the locking options are mentioned in the configuration. The locking rules
20851 are the same as are used by the &'c-client'& library that underlies Pine and
20852 the IMAP4 and POP daemons that come with it (see the discussion below). The
20853 rules allow for shared access to the mailbox. However, this kind of locking
20854 does not work when the mailbox is NFS mounted.
20855
20856 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
20857 &%use_flock_lock%& to control what kind of locking is used in implementing the
20858 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
20859 without &%use_fcntl_lock%& or &%use_flock_lock%&.
20860
20861
20862
20863
20864 .section "Operational details for appending" "SECTopappend"
20865 .cindex "appending to a file"
20866 .cindex "file" "appending"
20867 Before appending to a file, the following preparations are made:
20868
20869 .ilist
20870 If the name of the file is &_/dev/null_&, no action is taken, and a success
20871 return is given.
20872
20873 .next
20874 .cindex "directory creation"
20875 If any directories on the file's path are missing, Exim creates them if the
20876 &%create_directory%& option is set. A created directory's mode is given by the
20877 &%directory_mode%& option.
20878
20879 .next
20880 If &%file_format%& is set, the format of an existing file is checked. If this
20881 indicates that a different transport should be used, control is passed to that
20882 transport.
20883
20884 .next
20885 .cindex "file" "locking"
20886 .cindex "locking files"
20887 .cindex "NFS" "lock file"
20888 If &%use_lockfile%& is set, a lock file is built in a way that will work
20889 reliably over NFS, as follows:
20890
20891 .olist
20892 Create a &"hitching post"& file whose name is that of the lock file with the
20893 current time, primary host name, and process id added, by opening for writing
20894 as a new file. If this fails with an access error, delivery is deferred.
20895 .next
20896 Close the hitching post file, and hard link it to the lock file name.
20897 .next
20898 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
20899 Unlink the hitching post name.
20900 .next
20901 Otherwise, use &[stat()]& to get information about the hitching post file, and
20902 then unlink hitching post name. If the number of links is exactly two, creation
20903 of the lock file succeeded but something (for example, an NFS server crash and
20904 restart) caused this fact not to be communicated to the &[link()]& call.
20905 .next
20906 If creation of the lock file failed, wait for &%lock_interval%& and try again,
20907 up to &%lock_retries%& times. However, since any program that writes to a
20908 mailbox should complete its task very quickly, it is reasonable to time out old
20909 lock files that are normally the result of user agent and system crashes. If an
20910 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
20911 it before trying again.
20912 .endlist olist
20913
20914 .next
20915 A call is made to &[lstat()]& to discover whether the main file exists, and if
20916 so, what its characteristics are. If &[lstat()]& fails for any reason other
20917 than non-existence, delivery is deferred.
20918
20919 .next
20920 .cindex "symbolic link" "to mailbox"
20921 .cindex "mailbox" "symbolic link"
20922 If the file does exist and is a symbolic link, delivery is deferred, unless the
20923 &%allow_symlink%& option is set, in which case the ownership of the link is
20924 checked, and then &[stat()]& is called to find out about the real file, which
20925 is then subjected to the checks below. The check on the top-level link
20926 ownership prevents one user creating a link for another's mailbox in a sticky
20927 directory, though allowing symbolic links in this case is definitely not a good
20928 idea. If there is a chain of symbolic links, the intermediate ones are not
20929 checked.
20930
20931 .next
20932 If the file already exists but is not a regular file, or if the file's owner
20933 and group (if the group is being checked &-- see &%check_group%& above) are
20934 different from the user and group under which the delivery is running,
20935 delivery is deferred.
20936
20937 .next
20938 If the file's permissions are more generous than specified, they are reduced.
20939 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
20940 is set false, in which case the delivery is tried using the existing
20941 permissions.
20942
20943 .next
20944 The file's inode number is saved, and the file is then opened for appending.
20945 If this fails because the file has vanished, &(appendfile)& behaves as if it
20946 hadn't existed (see below). For any other failures, delivery is deferred.
20947
20948 .next
20949 If the file is opened successfully, check that the inode number hasn't
20950 changed, that it is still a regular file, and that the owner and permissions
20951 have not changed. If anything is wrong, defer delivery and freeze the message.
20952
20953 .next
20954 If the file did not exist originally, defer delivery if the &%file_must_exist%&
20955 option is set. Otherwise, check that the file is being created in a permitted
20956 directory if the &%create_file%& option is set (deferring on failure), and then
20957 open for writing as a new file, with the O_EXCL and O_CREAT options,
20958 except when dealing with a symbolic link (the &%allow_symlink%& option must be
20959 set). In this case, which can happen if the link points to a non-existent file,
20960 the file is opened for writing using O_CREAT but not O_EXCL, because
20961 that prevents link following.
20962
20963 .next
20964 .cindex "loop" "while file testing"
20965 If opening fails because the file exists, obey the tests given above for
20966 existing files. However, to avoid looping in a situation where the file is
20967 being continuously created and destroyed, the exists/not-exists loop is broken
20968 after 10 repetitions, and the message is then frozen.
20969
20970 .next
20971 If opening fails with any other error, defer delivery.
20972
20973 .next
20974 .cindex "file" "locking"
20975 .cindex "locking files"
20976 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
20977 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
20978 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
20979 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
20980 file, and an exclusive lock on the file whose name is
20981 .code
20982 /tmp/.<device-number>.<inode-number>
20983 .endd
20984 using the device and inode numbers of the open mailbox file, in accordance with
20985 the MBX locking rules. This file is created with a mode that is specified by
20986 the &%lockfile_mode%& option.
20987
20988 If Exim fails to lock the file, there are two possible courses of action,
20989 depending on the value of the locking timeout. This is obtained from
20990 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
20991
20992 If the timeout value is zero, the file is closed, Exim waits for
20993 &%lock_interval%&, and then goes back and re-opens the file as above and tries
20994 to lock it again. This happens up to &%lock_retries%& times, after which the
20995 delivery is deferred.
20996
20997 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
20998 &[flock()]& are used (with the given timeout), so there has already been some
20999 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21000 immediately. It retries up to
21001 .code
21002 (lock_retries * lock_interval) / <timeout>
21003 .endd
21004 times (rounded up).
21005 .endlist
21006
21007 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21008 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21009
21010
21011 .section "Operational details for delivery to a new file" "SECTopdir"
21012 .cindex "delivery" "to single file"
21013 .cindex "&""From""& line"
21014 When the &%directory%& option is set instead of &%file%&, each message is
21015 delivered into a newly-created file or set of files. When &(appendfile)& is
21016 activated directly from a &(redirect)& router, neither &%file%& nor
21017 &%directory%& is normally set, because the path for delivery is supplied by the
21018 router. (See for example, the &(address_file)& transport in the default
21019 configuration.) In this case, delivery is to a new file if either the path name
21020 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21021
21022 No locking is required while writing the message to a new file, so the various
21023 locking options of the transport are ignored. The &"From"& line that by default
21024 separates messages in a single file is not normally needed, nor is the escaping
21025 of message lines that start with &"From"&, and there is no need to ensure a
21026 newline at the end of each message. Consequently, the default values for
21027 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21028 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21029
21030 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21031 the files in the delivery directory by default. However, you can specify a
21032 different directory by setting &%quota_directory%&. Also, for maildir
21033 deliveries (see below) the &_maildirfolder_& convention is honoured.
21034
21035
21036 .cindex "maildir format"
21037 .cindex "mailstore format"
21038 There are three different ways in which delivery to individual files can be
21039 done, controlled by the settings of the &%maildir_format%& and
21040 &%mailstore_format%& options. Note that code to support maildir or mailstore
21041 formats is not included in the binary unless SUPPORT_MAILDIR or
21042 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21043
21044 .cindex "directory creation"
21045 In all three cases an attempt is made to create the directory and any necessary
21046 sub-directories if they do not exist, provided that the &%create_directory%&
21047 option is set (the default). The location of a created directory can be
21048 constrained by setting &%create_file%&. A created directory's mode is given by
21049 the &%directory_mode%& option. If creation fails, or if the
21050 &%create_directory%& option is not set when creation is required, delivery is
21051 deferred.
21052
21053
21054
21055 .section "Maildir delivery" "SECTmaildirdelivery"
21056 .cindex "maildir format" "description of"
21057 If the &%maildir_format%& option is true, Exim delivers each message by writing
21058 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21059 directory that is defined by the &%directory%& option (the &"delivery
21060 directory"&). If the delivery is successful, the file is renamed into the
21061 &_new_& subdirectory.
21062
21063 In the file name, <&'stime'&> is the current time of day in seconds, and
21064 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21065 Exim checks that the time-of-day clock has moved on by at least one microsecond
21066 before terminating the delivery process. This guarantees uniqueness for the
21067 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21068 opening it. If any response other than ENOENT (does not exist) is given,
21069 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21070
21071 Before Exim carries out a maildir delivery, it ensures that subdirectories
21072 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21073 do not exist, Exim tries to create them and any superior directories in their
21074 path, subject to the &%create_directory%& and &%create_file%& options. If the
21075 &%maildirfolder_create_regex%& option is set, and the regular expression it
21076 contains matches the delivery directory, Exim also ensures that a file called
21077 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21078 &_maildirfolder_& file cannot be created, delivery is deferred.
21079
21080 These features make it possible to use Exim to create all the necessary files
21081 and directories in a maildir mailbox, including subdirectories for maildir++
21082 folders. Consider this example:
21083 .code
21084 maildir_format = true
21085 directory = /var/mail/$local_part\
21086            ${if eq{$local_part_suffix}{}{}\
21087            {/.${substr_1:$local_part_suffix}}}
21088 maildirfolder_create_regex = /\.[^/]+$
21089 .endd
21090 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21091 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21092 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21093 not match this name, so Exim will not look for or create the file
21094 &_/var/mail/pimbo/maildirfolder_&, though it will create
21095 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21096
21097 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21098 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21099 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21100 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21101 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21102
21103 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21104 not inadvertently match the toplevel maildir directory, because a
21105 &_maildirfolder_& file at top level would completely break quota calculations.
21106
21107 .cindex "quota" "in maildir delivery"
21108 .cindex "maildir++"
21109 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21110 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21111 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21112 Exim assumes the directory is a maildir++ folder directory, which is one level
21113 down from the user's top level mailbox directory. This causes it to start at
21114 the parent directory instead of the current directory when calculating the
21115 amount of space used.
21116
21117 One problem with delivering into a multi-file mailbox is that it is
21118 computationally expensive to compute the size of the mailbox for quota
21119 checking. Various approaches have been taken to reduce the amount of work
21120 needed. The next two sections describe two of them. A third alternative is to
21121 use some external process for maintaining the size data, and use the expansion
21122 of the &%mailbox_size%& option as a way of importing it into Exim.
21123
21124
21125
21126
21127 .section "Using tags to record message sizes" "SECID135"
21128 If &%maildir_tag%& is set, the string is expanded for each delivery.
21129 When the maildir file is renamed into the &_new_& sub-directory, the
21130 tag is added to its name. However, if adding the tag takes the length of the
21131 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21132 the tag is dropped and the maildir file is created with no tag.
21133
21134
21135 .vindex "&$message_size$&"
21136 Tags can be used to encode the size of files in their names; see
21137 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21138 happens after the message has been written. The value of the &$message_size$&
21139 variable is set to the number of bytes actually written. If the expansion is
21140 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21141 be deferred. The expanded tag may contain any printing characters except &"/"&.
21142 Non-printing characters in the string are ignored; if the resulting string is
21143 empty, it is ignored. If it starts with an alphanumeric character, a leading
21144 colon is inserted; this default has not proven to be the path that popular
21145 maildir implementations have chosen (but changing it in Exim would break
21146 backwards compatibility).
21147
21148 For one common implementation, you might set:
21149 .code
21150 maildir_tag = ,S=${message_size}
21151 .endd
21152 but you should check the documentation of the other software to be sure.
21153
21154 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21155 as this allows Exim to extract the size from your tag, instead of having to
21156 &[stat()]& each message file.
21157
21158
21159 .section "Using a maildirsize file" "SECID136"
21160 .cindex "quota" "in maildir delivery"
21161 .cindex "maildir format" "&_maildirsize_& file"
21162 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21163 storing quota and message size information in a file called &_maildirsize_&
21164 within the toplevel maildir directory. If this file does not exist, Exim
21165 creates it, setting the quota from the &%quota%& option of the transport. If
21166 the maildir directory itself does not exist, it is created before any attempt
21167 to write a &_maildirsize_& file.
21168
21169 The &_maildirsize_& file is used to hold information about the sizes of
21170 messages in the maildir, thus speeding up quota calculations. The quota value
21171 in the file is just a cache; if the quota is changed in the transport, the new
21172 value overrides the cached value when the next message is delivered. The cache
21173 is maintained for the benefit of other programs that access the maildir and
21174 need to know the quota.
21175
21176 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21177 file is maintained (with a zero quota setting), but no quota is imposed.
21178
21179 A regular expression is available for controlling which directories in the
21180 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21181 See the description of the &%maildir_quota_directory_regex%& option above for
21182 details.
21183
21184
21185 .section "Mailstore delivery" "SECID137"
21186 .cindex "mailstore format" "description of"
21187 If the &%mailstore_format%& option is true, each message is written as two
21188 files in the given directory. A unique base name is constructed from the
21189 message id and the current delivery process, and the files that are written use
21190 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21191 contains the message's envelope, and the &_.msg_& file contains the message
21192 itself. The base name is placed in the variable &$mailstore_basename$&.
21193
21194 During delivery, the envelope is first written to a file with the suffix
21195 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21196 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21197 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21198 file before accessing either of them. An alternative approach is to wait for
21199 the absence of a &_.tmp_& file.
21200
21201 The envelope file starts with any text defined by the &%mailstore_prefix%&
21202 option, expanded and terminated by a newline if there isn't one. Then follows
21203 the sender address on one line, then all the recipient addresses, one per line.
21204 There can be more than one recipient only if the &%batch_max%& option is set
21205 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21206 appended to the file, followed by a newline if it does not end with one.
21207
21208 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21209 failure, it is ignored. Other expansion errors are treated as serious
21210 configuration errors, and delivery is deferred. The variable
21211 &$mailstore_basename$& is available for use during these expansions.
21212
21213
21214 .section "Non-special new file delivery" "SECID138"
21215 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21216 file is created directly in the named directory. For example, when delivering
21217 messages into files in batched SMTP format for later delivery to some host (see
21218 section &<<SECTbatchSMTP>>&), a setting such as
21219 .code
21220 directory = /var/bsmtp/$host
21221 .endd
21222 might be used. A message is written to a file with a temporary name, which is
21223 then renamed when the delivery is complete. The final name is obtained by
21224 expanding the contents of the &%directory_file%& option.
21225 .ecindex IIDapptra1
21226 .ecindex IIDapptra2
21227
21228
21229
21230
21231
21232
21233 . ////////////////////////////////////////////////////////////////////////////
21234 . ////////////////////////////////////////////////////////////////////////////
21235
21236 .chapter "The autoreply transport" "CHID8"
21237 .scindex IIDauttra1 "transports" "&(autoreply)&"
21238 .scindex IIDauttra2 "&(autoreply)& transport"
21239 The &(autoreply)& transport is not a true transport in that it does not cause
21240 the message to be transmitted. Instead, it generates a new mail message as an
21241 automatic reply to the incoming message. &'References:'& and
21242 &'Auto-Submitted:'& header lines are included. These are constructed according
21243 to the rules in RFCs 2822 and 3834, respectively.
21244
21245 If the router that passes the message to this transport does not have the
21246 &%unseen%& option set, the original message (for the current recipient) is not
21247 delivered anywhere. However, when the &%unseen%& option is set on the router
21248 that passes the message to this transport, routing of the address continues, so
21249 another router can set up a normal message delivery.
21250
21251
21252 The &(autoreply)& transport is usually run as the result of mail filtering, a
21253 &"vacation"& message being the standard example. However, it can also be run
21254 directly from a router like any other transport. To reduce the possibility of
21255 message cascades, messages created by the &(autoreply)& transport always have
21256 empty envelope sender addresses, like bounce messages.
21257
21258 The parameters of the message to be sent can be specified in the configuration
21259 by options described below. However, these are used only when the address
21260 passed to the transport does not contain its own reply information. When the
21261 transport is run as a consequence of a
21262 &%mail%&
21263 or &%vacation%& command in a filter file, the parameters of the message are
21264 supplied by the filter, and passed with the address. The transport's options
21265 that define the message are then ignored (so they are not usually set in this
21266 case). The message is specified entirely by the filter or by the transport; it
21267 is never built from a mixture of options. However, the &%file_optional%&,
21268 &%mode%&, and &%return_message%& options apply in all cases.
21269
21270 &(Autoreply)& is implemented as a local transport. When used as a result of a
21271 command in a user's filter file, &(autoreply)& normally runs under the uid and
21272 gid of the user, and with appropriate current and home directories (see chapter
21273 &<<CHAPenvironment>>&).
21274
21275 There is a subtle difference between routing a message to a &(pipe)& transport
21276 that generates some text to be returned to the sender, and routing it to an
21277 &(autoreply)& transport. This difference is noticeable only if more than one
21278 address from the same message is so handled. In the case of a pipe, the
21279 separate outputs from the different addresses are gathered up and returned to
21280 the sender in a single message, whereas if &(autoreply)& is used, a separate
21281 message is generated for each address that is passed to it.
21282
21283 Non-printing characters are not permitted in the header lines generated for the
21284 message that &(autoreply)& creates, with the exception of newlines that are
21285 immediately followed by white space. If any non-printing characters are found,
21286 the transport defers.
21287 Whether characters with the top bit set count as printing characters or not is
21288 controlled by the &%print_topbitchars%& global option.
21289
21290 If any of the generic options for manipulating headers (for example,
21291 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21292 of the original message that is included in the generated message when
21293 &%return_message%& is set. They do not apply to the generated message itself.
21294
21295 .vindex "&$sender_address$&"
21296 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21297 the message, indicating that there were no recipients, it does not treat this
21298 as an error. This means that autoreplies sent to &$sender_address$& when this
21299 is empty (because the incoming message is a bounce message) do not cause
21300 problems. They are just discarded.
21301
21302
21303
21304 .section "Private options for autoreply" "SECID139"
21305 .cindex "options" "&(autoreply)& transport"
21306
21307 .option bcc autoreply string&!! unset
21308 This specifies the addresses that are to receive &"blind carbon copies"& of the
21309 message when the message is specified by the transport.
21310
21311
21312 .option cc autoreply string&!! unset
21313 This specifies recipients of the message and the contents of the &'Cc:'& header
21314 when the message is specified by the transport.
21315
21316
21317 .option file autoreply string&!! unset
21318 The contents of the file are sent as the body of the message when the message
21319 is specified by the transport. If both &%file%& and &%text%& are set, the text
21320 string comes first.
21321
21322
21323 .option file_expand autoreply boolean false
21324 If this is set, the contents of the file named by the &%file%& option are
21325 subjected to string expansion as they are added to the message.
21326
21327
21328 .option file_optional autoreply boolean false
21329 If this option is true, no error is generated if the file named by the &%file%&
21330 option or passed with the address does not exist or cannot be read.
21331
21332
21333 .option from autoreply string&!! unset
21334 This specifies the contents of the &'From:'& header when the message is
21335 specified by the transport.
21336
21337
21338 .option headers autoreply string&!! unset
21339 This specifies additional RFC 2822 headers that are to be added to the message
21340 when the message is specified by the transport. Several can be given by using
21341 &"\n"& to separate them. There is no check on the format.
21342
21343
21344 .option log autoreply string&!! unset
21345 This option names a file in which a record of every message sent is logged when
21346 the message is specified by the transport.
21347
21348
21349 .option mode autoreply "octal integer" 0600
21350 If either the log file or the &"once"& file has to be created, this mode is
21351 used.
21352
21353
21354 .option never_mail autoreply "address list&!!" unset
21355 If any run of the transport creates a message with a recipient that matches any
21356 item in the list, that recipient is quietly discarded. If all recipients are
21357 discarded, no message is created. This applies both when the recipients are
21358 generated by a filter and when they are specified in the transport.
21359
21360
21361
21362 .option once autoreply string&!! unset
21363 This option names a file or DBM database in which a record of each &'To:'&
21364 recipient is kept when the message is specified by the transport. &*Note*&:
21365 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
21366
21367 If &%once%& is unset, or is set to an empty string, the message is always sent.
21368 By default, if &%once%& is set to a non-empty file name, the message
21369 is not sent if a potential recipient is already listed in the database.
21370 However, if the &%once_repeat%& option specifies a time greater than zero, the
21371 message is sent if that much time has elapsed since a message was last sent to
21372 this recipient. A setting of zero time for &%once_repeat%& (the default)
21373 prevents a message from being sent a second time &-- in this case, zero means
21374 infinity.
21375
21376 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
21377 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
21378 greater than zero, it changes the way Exim implements the &%once%& option.
21379 Instead of using a DBM file to record every recipient it sends to, it uses a
21380 regular file, whose size will never get larger than the given value.
21381
21382 In the file, Exim keeps a linear list of recipient addresses and the times at
21383 which they were sent messages. If the file is full when a new address needs to
21384 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
21385 means that a given recipient may receive multiple messages, but at
21386 unpredictable intervals that depend on the rate of turnover of addresses in the
21387 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
21388
21389
21390 .option once_file_size autoreply integer 0
21391 See &%once%& above.
21392
21393
21394 .option once_repeat autoreply time&!! 0s
21395 See &%once%& above.
21396 After expansion, the value of this option must be a valid time value.
21397
21398
21399 .option reply_to autoreply string&!! unset
21400 This specifies the contents of the &'Reply-To:'& header when the message is
21401 specified by the transport.
21402
21403
21404 .option return_message autoreply boolean false
21405 If this is set, a copy of the original message is returned with the new
21406 message, subject to the maximum size set in the &%return_size_limit%& global
21407 configuration option.
21408
21409
21410 .option subject autoreply string&!! unset
21411 This specifies the contents of the &'Subject:'& header when the message is
21412 specified by the transport. It is tempting to quote the original subject in
21413 automatic responses. For example:
21414 .code
21415 subject = Re: $h_subject:
21416 .endd
21417 There is a danger in doing this, however. It may allow a third party to
21418 subscribe your users to an opt-in mailing list, provided that the list accepts
21419 bounce messages as subscription confirmations. Well-managed lists require a
21420 non-bounce message to confirm a subscription, so the danger is relatively
21421 small.
21422
21423
21424
21425 .option text autoreply string&!! unset
21426 This specifies a single string to be used as the body of the message when the
21427 message is specified by the transport. If both &%text%& and &%file%& are set,
21428 the text comes first.
21429
21430
21431 .option to autoreply string&!! unset
21432 This specifies recipients of the message and the contents of the &'To:'& header
21433 when the message is specified by the transport.
21434 .ecindex IIDauttra1
21435 .ecindex IIDauttra2
21436
21437
21438
21439
21440 . ////////////////////////////////////////////////////////////////////////////
21441 . ////////////////////////////////////////////////////////////////////////////
21442
21443 .chapter "The lmtp transport" "CHAPLMTP"
21444 .cindex "transports" "&(lmtp)&"
21445 .cindex "&(lmtp)& transport"
21446 .cindex "LMTP" "over a pipe"
21447 .cindex "LMTP" "over a socket"
21448 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
21449 specified command
21450 or by interacting with a Unix domain socket.
21451 This transport is something of a cross between the &(pipe)& and &(smtp)&
21452 transports. Exim also has support for using LMTP over TCP/IP; this is
21453 implemented as an option for the &(smtp)& transport. Because LMTP is expected
21454 to be of minority interest, the default build-time configure in &_src/EDITME_&
21455 has it commented out. You need to ensure that
21456 .code
21457 TRANSPORT_LMTP=yes
21458 .endd
21459 .cindex "options" "&(lmtp)& transport"
21460 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
21461 included in the Exim binary. The private options of the &(lmtp)& transport are
21462 as follows:
21463
21464 .option batch_id lmtp string&!! unset
21465 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21466
21467
21468 .option batch_max lmtp integer 1
21469 This limits the number of addresses that can be handled in a single delivery.
21470 Most LMTP servers can handle several addresses at once, so it is normally a
21471 good idea to increase this value. See the description of local delivery
21472 batching in chapter &<<CHAPbatching>>&.
21473
21474
21475 .option command lmtp string&!! unset
21476 This option must be set if &%socket%& is not set. The string is a command which
21477 is run in a separate process. It is split up into a command name and list of
21478 arguments, each of which is separately expanded (so expansion cannot change the
21479 number of arguments). The command is run directly, not via a shell. The message
21480 is passed to the new process using the standard input and output to operate the
21481 LMTP protocol.
21482
21483 .option ignore_quota lmtp boolean false
21484 .cindex "LMTP" "ignoring quota errors"
21485 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
21486 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
21487 in its response to the LHLO command.
21488
21489 .option socket lmtp string&!! unset
21490 This option must be set if &%command%& is not set. The result of expansion must
21491 be the name of a Unix domain socket. The transport connects to the socket and
21492 delivers the message to it using the LMTP protocol.
21493
21494
21495 .option timeout lmtp time 5m
21496 The transport is aborted if the created process or Unix domain socket does not
21497 respond to LMTP commands or message input within this timeout. Delivery
21498 is deferred, and will be tried again later. Here is an example of a typical
21499 LMTP transport:
21500 .code
21501 lmtp:
21502   driver = lmtp
21503   command = /some/local/lmtp/delivery/program
21504   batch_max = 20
21505   user = exim
21506 .endd
21507 This delivers up to 20 addresses at a time, in a mixture of domains if
21508 necessary, running as the user &'exim'&.
21509
21510
21511
21512 . ////////////////////////////////////////////////////////////////////////////
21513 . ////////////////////////////////////////////////////////////////////////////
21514
21515 .chapter "The pipe transport" "CHAPpipetransport"
21516 .scindex IIDpiptra1 "transports" "&(pipe)&"
21517 .scindex IIDpiptra2 "&(pipe)& transport"
21518 The &(pipe)& transport is used to deliver messages via a pipe to a command
21519 running in another process. One example is the use of &(pipe)& as a
21520 pseudo-remote transport for passing messages to some other delivery mechanism
21521 (such as UUCP). Another is the use by individual users to automatically process
21522 their incoming messages. The &(pipe)& transport can be used in one of the
21523 following ways:
21524
21525 .ilist
21526 .vindex "&$local_part$&"
21527 A router routes one address to a transport in the normal way, and the
21528 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
21529 contains the local part of the address (as usual), and the command that is run
21530 is specified by the &%command%& option on the transport.
21531 .next
21532 .vindex "&$pipe_addresses$&"
21533 If the &%batch_max%& option is set greater than 1 (the default is 1), the
21534 transport can handle more than one address in a single run. In this case, when
21535 more than one address is routed to the transport, &$local_part$& is not set
21536 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
21537 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
21538 that are routed to the transport.
21539 .next
21540 .vindex "&$address_pipe$&"
21541 A router redirects an address directly to a pipe command (for example, from an
21542 alias or forward file). In this case, &$address_pipe$& contains the text of the
21543 pipe command, and the &%command%& option on the transport is ignored. If only
21544 one address is being transported (&%batch_max%& is not greater than one, or
21545 only one address was redirected to this pipe command), &$local_part$& contains
21546 the local part that was redirected.
21547 .endlist
21548
21549
21550 The &(pipe)& transport is a non-interactive delivery method. Exim can also
21551 deliver messages over pipes using the LMTP interactive protocol. This is
21552 implemented by the &(lmtp)& transport.
21553
21554 In the case when &(pipe)& is run as a consequence of an entry in a local user's
21555 &_.forward_& file, the command runs under the uid and gid of that user. In
21556 other cases, the uid and gid have to be specified explicitly, either on the
21557 transport or on the router that handles the address. Current and &"home"&
21558 directories are also controllable. See chapter &<<CHAPenvironment>>& for
21559 details of the local delivery environment and chapter &<<CHAPbatching>>&
21560 for a discussion of local delivery batching.
21561
21562
21563 .section "Concurrent delivery" "SECID140"
21564 If two messages arrive at almost the same time, and both are routed to a pipe
21565 delivery, the two pipe transports may be run concurrently. You must ensure that
21566 any pipe commands you set up are robust against this happening. If the commands
21567 write to a file, the &%exim_lock%& utility might be of use.
21568
21569
21570
21571
21572 .section "Returned status and data" "SECID141"
21573 .cindex "&(pipe)& transport" "returned data"
21574 If the command exits with a non-zero return code, the delivery is deemed to
21575 have failed, unless either the &%ignore_status%& option is set (in which case
21576 the return code is treated as zero), or the return code is one of those listed
21577 in the &%temp_errors%& option, which are interpreted as meaning &"try again
21578 later"&. In this case, delivery is deferred. Details of a permanent failure are
21579 logged, but are not included in the bounce message, which merely contains
21580 &"local delivery failed"&.
21581
21582 If the command exits on a signal and the &%freeze_signal%& option is set then
21583 the message will be frozen in the queue. If that option is not set, a bounce
21584 will be sent as normal.
21585
21586 If the return code is greater than 128 and the command being run is a shell
21587 script, it normally means that the script was terminated by a signal whose
21588 value is the return code minus 128. The &%freeze_signal%& option does not
21589 apply in this case.
21590
21591 If Exim is unable to run the command (that is, if &[execve()]& fails), the
21592 return code is set to 127. This is the value that a shell returns if it is
21593 asked to run a non-existent command. The wording for the log line suggests that
21594 a non-existent command may be the problem.
21595
21596 The &%return_output%& option can affect the result of a pipe delivery. If it is
21597 set and the command produces any output on its standard output or standard
21598 error streams, the command is considered to have failed, even if it gave a zero
21599 return code or if &%ignore_status%& is set. The output from the command is
21600 included as part of the bounce message. The &%return_fail_output%& option is
21601 similar, except that output is returned only when the command exits with a
21602 failure return code, that is, a value other than zero or a code that matches
21603 &%temp_errors%&.
21604
21605
21606
21607 .section "How the command is run" "SECThowcommandrun"
21608 .cindex "&(pipe)& transport" "path for command"
21609 The command line is (by default) broken down into a command name and arguments
21610 by the &(pipe)& transport itself. The &%allow_commands%& and
21611 &%restrict_to_path%& options can be used to restrict the commands that may be
21612 run.
21613
21614 .cindex "quoting" "in pipe command"
21615 Unquoted arguments are delimited by white space. If an argument appears in
21616 double quotes, backslash is interpreted as an escape character in the usual
21617 way. If an argument appears in single quotes, no escaping is done.
21618
21619 String expansion is applied to the command line except when it comes from a
21620 traditional &_.forward_& file (commands from a filter file are expanded). The
21621 expansion is applied to each argument in turn rather than to the whole line.
21622 For this reason, any string expansion item that contains white space must be
21623 quoted so as to be contained within a single argument. A setting such as
21624 .code
21625 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
21626 .endd
21627 will not work, because the expansion item gets split between several
21628 arguments. You have to write
21629 .code
21630 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
21631 .endd
21632 to ensure that it is all in one argument. The expansion is done in this way,
21633 argument by argument, so that the number of arguments cannot be changed as a
21634 result of expansion, and quotes or backslashes in inserted variables do not
21635 interact with external quoting. However, this leads to problems if you want to
21636 generate multiple arguments (or the command name plus arguments) from a single
21637 expansion. In this situation, the simplest solution is to use a shell. For
21638 example:
21639 .code
21640 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
21641 .endd
21642
21643 .cindex "transport" "filter"
21644 .cindex "filter" "transport filter"
21645 .vindex "&$pipe_addresses$&"
21646 Special handling takes place when an argument consists of precisely the text
21647 &`$pipe_addresses`&. This is not a general expansion variable; the only
21648 place this string is recognized is when it appears as an argument for a pipe or
21649 transport filter command. It causes each address that is being handled to be
21650 inserted in the argument list at that point &'as a separate argument'&. This
21651 avoids any problems with spaces or shell metacharacters, and is of use when a
21652 &(pipe)& transport is handling groups of addresses in a batch.
21653
21654 After splitting up into arguments and expansion, the resulting command is run
21655 in a subprocess directly from the transport, &'not'& under a shell. The
21656 message that is being delivered is supplied on the standard input, and the
21657 standard output and standard error are both connected to a single pipe that is
21658 read by Exim. The &%max_output%& option controls how much output the command
21659 may produce, and the &%return_output%& and &%return_fail_output%& options
21660 control what is done with it.
21661
21662 Not running the command under a shell (by default) lessens the security risks
21663 in cases when a command from a user's filter file is built out of data that was
21664 taken from an incoming message. If a shell is required, it can of course be
21665 explicitly specified as the command to be run. However, there are circumstances
21666 where existing commands (for example, in &_.forward_& files) expect to be run
21667 under a shell and cannot easily be modified. To allow for these cases, there is
21668 an option called &%use_shell%&, which changes the way the &(pipe)& transport
21669 works. Instead of breaking up the command line as just described, it expands it
21670 as a single string and passes the result to &_/bin/sh_&. The
21671 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
21672 with &%use_shell%&, and the whole mechanism is inherently less secure.
21673
21674
21675
21676 .section "Environment variables" "SECTpipeenv"
21677 .cindex "&(pipe)& transport" "environment for command"
21678 .cindex "environment for pipe transport"
21679 The environment variables listed below are set up when the command is invoked.
21680 This list is a compromise for maximum compatibility with other MTAs. Note that
21681 the &%environment%& option can be used to add additional variables to this
21682 environment.
21683 .display
21684 &`DOMAIN            `&   the domain of the address
21685 &`HOME              `&   the home directory, if set
21686 &`HOST              `&   the host name when called from a router (see below)
21687 &`LOCAL_PART        `&   see below
21688 &`LOCAL_PART_PREFIX `&   see below
21689 &`LOCAL_PART_SUFFIX `&   see below
21690 &`LOGNAME           `&   see below
21691 &`MESSAGE_ID        `&   Exim's local ID for the message
21692 &`PATH              `&   as specified by the &%path%& option below
21693 &`QUALIFY_DOMAIN    `&   the sender qualification domain
21694 &`RECIPIENT         `&   the complete recipient address
21695 &`SENDER            `&   the sender of the message (empty if a bounce)
21696 &`SHELL             `&   &`/bin/sh`&
21697 &`TZ                `&   the value of the &%timezone%& option, if set
21698 &`USER              `&   see below
21699 .endd
21700 When a &(pipe)& transport is called directly from (for example) an &(accept)&
21701 router, LOCAL_PART is set to the local part of the address. When it is
21702 called as a result of a forward or alias expansion, LOCAL_PART is set to
21703 the local part of the address that was expanded. In both cases, any affixes are
21704 removed from the local part, and made available in LOCAL_PART_PREFIX and
21705 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
21706 same value as LOCAL_PART for compatibility with other MTAs.
21707
21708 .cindex "HOST"
21709 HOST is set only when a &(pipe)& transport is called from a router that
21710 associates hosts with an address, typically when using &(pipe)& as a
21711 pseudo-remote transport. HOST is set to the first host name specified by
21712 the router.
21713
21714 .cindex "HOME"
21715 If the transport's generic &%home_directory%& option is set, its value is used
21716 for the HOME environment variable. Otherwise, a home directory may be set
21717 by the router's &%transport_home_directory%& option, which defaults to the
21718 user's home directory if &%check_local_user%& is set.
21719
21720
21721 .section "Private options for pipe" "SECID142"
21722 .cindex "options" "&(pipe)& transport"
21723
21724
21725
21726 .option allow_commands pipe "string list&!!" unset
21727 .cindex "&(pipe)& transport" "permitted commands"
21728 The string is expanded, and is then interpreted as a colon-separated list of
21729 permitted commands. If &%restrict_to_path%& is not set, the only commands
21730 permitted are those in the &%allow_commands%& list. They need not be absolute
21731 paths; the &%path%& option is still used for relative paths. If
21732 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
21733 in the &%allow_commands%& list, or a name without any slashes that is found on
21734 the path. In other words, if neither &%allow_commands%& nor
21735 &%restrict_to_path%& is set, there is no restriction on the command, but
21736 otherwise only commands that are permitted by one or the other are allowed. For
21737 example, if
21738 .code
21739 allow_commands = /usr/bin/vacation
21740 .endd
21741 and &%restrict_to_path%& is not set, the only permitted command is
21742 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
21743 &%use_shell%& is set.
21744
21745
21746 .option batch_id pipe string&!! unset
21747 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21748
21749
21750 .option batch_max pipe integer 1
21751 This limits the number of addresses that can be handled in a single delivery.
21752 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21753
21754
21755 .option check_string pipe string unset
21756 As &(pipe)& writes the message, the start of each line is tested for matching
21757 &%check_string%&, and if it does, the initial matching characters are replaced
21758 by the contents of &%escape_string%&, provided both are set. The value of
21759 &%check_string%& is a literal string, not a regular expression, and the case of
21760 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
21761 of &%check_string%& and &%escape_string%& are forced to values that implement
21762 the SMTP escaping protocol. Any settings made in the configuration file are
21763 ignored.
21764
21765
21766 .option command pipe string&!! unset
21767 This option need not be set when &(pipe)& is being used to deliver to pipes
21768 obtained directly from address redirections. In other cases, the option must be
21769 set, to provide a command to be run. It need not yield an absolute path (see
21770 the &%path%& option below). The command is split up into separate arguments by
21771 Exim, and each argument is separately expanded, as described in section
21772 &<<SECThowcommandrun>>& above.
21773
21774
21775 .option environment pipe string&!! unset
21776 .cindex "&(pipe)& transport" "environment for command"
21777 .cindex "environment for &(pipe)& transport"
21778 This option is used to add additional variables to the environment in which the
21779 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
21780 a string which is expanded, and then interpreted as a colon-separated list of
21781 environment settings of the form <&'name'&>=<&'value'&>.
21782
21783
21784 .option escape_string pipe string unset
21785 See &%check_string%& above.
21786
21787
21788 .option freeze_exec_fail pipe boolean false
21789 .cindex "exec failure"
21790 .cindex "failure of exec"
21791 .cindex "&(pipe)& transport" "failure of exec"
21792 Failure to exec the command in a pipe transport is by default treated like
21793 any other failure while running the command. However, if &%freeze_exec_fail%&
21794 is set, failure to exec is treated specially, and causes the message to be
21795 frozen, whatever the setting of &%ignore_status%&.
21796
21797
21798 .option freeze_signal pipe boolean false
21799 .cindex "signal exit"
21800 .cindex "&(pipe)& transport", "signal exit"
21801 Normally if the process run by a command in a pipe transport exits on a signal,
21802 a bounce message is sent. If &%freeze_signal%& is set, the message will be
21803 frozen in Exim's queue instead.
21804
21805
21806 .option ignore_status pipe boolean false
21807 If this option is true, the status returned by the subprocess that is set up to
21808 run the command is ignored, and Exim behaves as if zero had been returned.
21809 Otherwise, a non-zero status or termination by signal causes an error return
21810 from the transport unless the status value is one of those listed in
21811 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
21812
21813 &*Note*&: This option does not apply to timeouts, which do not return a status.
21814 See the &%timeout_defer%& option for how timeouts are handled.
21815
21816 .option log_defer_output pipe boolean false
21817 .cindex "&(pipe)& transport" "logging output"
21818 If this option is set, and the status returned by the command is
21819 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
21820 and any output was produced, the first line of it is written to the main log.
21821
21822
21823 .option log_fail_output pipe boolean false
21824 If this option is set, and the command returns any output, and also ends with a
21825 return code that is neither zero nor one of the return codes listed in
21826 &%temp_errors%& (that is, the delivery failed), the first line of output is
21827 written to the main log. This option and &%log_output%& are mutually exclusive.
21828 Only one of them may be set.
21829
21830
21831
21832 .option log_output pipe boolean false
21833 If this option is set and the command returns any output, the first line of
21834 output is written to the main log, whatever the return code. This option and
21835 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
21836
21837
21838
21839 .option max_output pipe integer 20K
21840 This specifies the maximum amount of output that the command may produce on its
21841 standard output and standard error file combined. If the limit is exceeded, the
21842 process running the command is killed. This is intended as a safety measure to
21843 catch runaway processes. The limit is applied independently of the settings of
21844 the options that control what is done with such output (for example,
21845 &%return_output%&). Because of buffering effects, the amount of output may
21846 exceed the limit by a small amount before Exim notices.
21847
21848
21849 .option message_prefix pipe string&!! "see below"
21850 The string specified here is expanded and output at the start of every message.
21851 The default is unset if &%use_bsmtp%& is set. Otherwise it is
21852 .code
21853 message_prefix = \
21854   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
21855   ${tod_bsdinbox}\n
21856 .endd
21857 .cindex "Cyrus"
21858 .cindex "&%tmail%&"
21859 .cindex "&""From""& line"
21860 This is required by the commonly used &_/usr/bin/vacation_& program.
21861 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
21862 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
21863 setting
21864 .code
21865 message_prefix =
21866 .endd
21867 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21868 &`\n`& to &`\r\n`& in &%message_prefix%&.
21869
21870
21871 .option message_suffix pipe string&!! "see below"
21872 The string specified here is expanded and output at the end of every message.
21873 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
21874 The suffix can be suppressed by setting
21875 .code
21876 message_suffix =
21877 .endd
21878 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21879 &`\n`& to &`\r\n`& in &%message_suffix%&.
21880
21881
21882 .option path pipe string "see below"
21883 This option specifies the string that is set up in the PATH environment
21884 variable of the subprocess. The default is:
21885 .code
21886 /bin:/usr/bin
21887 .endd
21888 If the &%command%& option does not yield an absolute path name, the command is
21889 sought in the PATH directories, in the usual way. &*Warning*&: This does not
21890 apply to a command specified as a transport filter.
21891
21892
21893 .option permit_coredump pipe boolean false
21894 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
21895 a core-dump of a pipe command, enable this command.  This enables core-dumps
21896 during delivery and affects both the Exim binary and the pipe command run.
21897 It is recommended that this option remain off unless and until you have a need
21898 for it and that this only be enabled when needed, as the risk of excessive
21899 resource consumption can be quite high.  Note also that Exim is typically
21900 installed as a setuid binary and most operating systems will inhibit coredumps
21901 of these by default, so further OS-specific action may be required.
21902
21903
21904 .option pipe_as_creator pipe boolean false
21905 .cindex "uid (user id)" "local delivery"
21906 If the generic &%user%& option is not set and this option is true, the delivery
21907 process is run under the uid that was in force when Exim was originally called
21908 to accept the message. If the group id is not otherwise set (via the generic
21909 &%group%& option), the gid that was in force when Exim was originally called to
21910 accept the message is used.
21911
21912
21913 .option restrict_to_path pipe boolean false
21914 When this option is set, any command name not listed in &%allow_commands%& must
21915 contain no slashes. The command is searched for only in the directories listed
21916 in the &%path%& option. This option is intended for use in the case when a pipe
21917 command has been generated from a user's &_.forward_& file. This is usually
21918 handled by a &(pipe)& transport called &%address_pipe%&.
21919
21920
21921 .option return_fail_output pipe boolean false
21922 If this option is true, and the command produced any output and ended with a
21923 return code other than zero or one of the codes listed in &%temp_errors%& (that
21924 is, the delivery failed), the output is returned in the bounce message.
21925 However, if the message has a null sender (that is, it is itself a bounce
21926 message), output from the command is discarded. This option and
21927 &%return_output%& are mutually exclusive. Only one of them may be set.
21928
21929
21930
21931 .option return_output pipe boolean false
21932 If this option is true, and the command produced any output, the delivery is
21933 deemed to have failed whatever the return code from the command, and the output
21934 is returned in the bounce message. Otherwise, the output is just discarded.
21935 However, if the message has a null sender (that is, it is a bounce message),
21936 output from the command is always discarded, whatever the setting of this
21937 option. This option and &%return_fail_output%& are mutually exclusive. Only one
21938 of them may be set.
21939
21940
21941
21942 .option temp_errors pipe "string list" "see below"
21943 .cindex "&(pipe)& transport" "temporary failure"
21944 This option contains either a colon-separated list of numbers, or a single
21945 asterisk. If &%ignore_status%& is false
21946 and &%return_output%& is not set,
21947 and the command exits with a non-zero return code, the failure is treated as
21948 temporary and the delivery is deferred if the return code matches one of the
21949 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
21950 codes are treated as permanent errors. The default setting contains the codes
21951 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
21952 compiled on a system that does not define these macros, it assumes values of 75
21953 and 73, respectively.
21954
21955
21956 .option timeout pipe time 1h
21957 If the command fails to complete within this time, it is killed. This normally
21958 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
21959 specifies no timeout. In order to ensure that any subprocesses created by the
21960 command are also killed, Exim makes the initial process a process group leader,
21961 and kills the whole process group on a timeout. However, this can be defeated
21962 if one of the processes starts a new process group.
21963
21964 .option timeout_defer pipe boolean false
21965 A timeout in a &(pipe)& transport, either in the command that the transport
21966 runs, or in a transport filter that is associated with it, is by default
21967 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
21968 is set true, both kinds of timeout become temporary errors, causing the
21969 delivery to be deferred.
21970
21971 .option umask pipe "octal integer" 022
21972 This specifies the umask setting for the subprocess that runs the command.
21973
21974
21975 .option use_bsmtp pipe boolean false
21976 .cindex "envelope sender"
21977 If this option is set true, the &(pipe)& transport writes messages in &"batch
21978 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
21979 commands. If you want to include a leading HELO command with such messages,
21980 you can do so by setting the &%message_prefix%& option. See section
21981 &<<SECTbatchSMTP>>& for details of batch SMTP.
21982
21983 .option use_classresources pipe boolean false
21984 .cindex "class resources (BSD)"
21985 This option is available only when Exim is running on FreeBSD, NetBSD, or
21986 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
21987 resource limits when a &(pipe)& transport is run to perform a delivery. The
21988 limits for the uid under which the pipe is to run are obtained from the login
21989 class database.
21990
21991
21992 .option use_crlf pipe boolean false
21993 .cindex "carriage return"
21994 .cindex "linefeed"
21995 This option causes lines to be terminated with the two-character CRLF sequence
21996 (carriage return, linefeed) instead of just a linefeed character. In the case
21997 of batched SMTP, the byte sequence written to the pipe is then an exact image
21998 of what would be sent down a real SMTP connection.
21999
22000 The contents of the &%message_prefix%& and &%message_suffix%& options are
22001 written verbatim, so must contain their own carriage return characters if these
22002 are needed. When &%use_bsmtp%& is not set, the default values for both
22003 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22004 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22005
22006
22007 .option use_shell pipe boolean false
22008 .vindex "&$pipe_addresses$&"
22009 If this option is set, it causes the command to be passed to &_/bin/sh_&
22010 instead of being run directly from the transport, as described in section
22011 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22012 where the command is expected to be run under a shell and cannot easily be
22013 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22014 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22015 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22016 its &%-c%& option.
22017
22018
22019
22020 .section "Using an external local delivery agent" "SECID143"
22021 .cindex "local delivery" "using an external agent"
22022 .cindex "&'procmail'&"
22023 .cindex "external local delivery"
22024 .cindex "delivery" "&'procmail'&"
22025 .cindex "delivery" "by external agent"
22026 The &(pipe)& transport can be used to pass all messages that require local
22027 delivery to a separate local delivery agent such as &%procmail%&. When doing
22028 this, care must be taken to ensure that the pipe is run under an appropriate
22029 uid and gid. In some configurations one wants this to be a uid that is trusted
22030 by the delivery agent to supply the correct sender of the message. It may be
22031 necessary to recompile or reconfigure the delivery agent so that it trusts an
22032 appropriate user. The following is an example transport and router
22033 configuration for &%procmail%&:
22034 .code
22035 # transport
22036 procmail_pipe:
22037   driver = pipe
22038   command = /usr/local/bin/procmail -d $local_part
22039   return_path_add
22040   delivery_date_add
22041   envelope_to_add
22042   check_string = "From "
22043   escape_string = ">From "
22044   umask = 077
22045   user = $local_part
22046   group = mail
22047
22048 # router
22049 procmail:
22050   driver = accept
22051   check_local_user
22052   transport = procmail_pipe
22053 .endd
22054 In this example, the pipe is run as the local user, but with the group set to
22055 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22056 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22057 user to supply a correct sender address. If you do not specify either a
22058 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22059 home directory is the user's home directory by default.
22060
22061 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22062 .code
22063 IFS=" "
22064 .endd
22065 as shown in some &%procmail%& documentation, because Exim does not by default
22066 use a shell to run pipe commands.
22067
22068 .cindex "Cyrus"
22069 The next example shows a transport and a router for a system where local
22070 deliveries are handled by the Cyrus IMAP server.
22071 .code
22072 # transport
22073 local_delivery_cyrus:
22074   driver = pipe
22075   command = /usr/cyrus/bin/deliver \
22076             -m ${substr_1:$local_part_suffix} -- $local_part
22077   user = cyrus
22078   group = mail
22079   return_output
22080   log_output
22081   message_prefix =
22082   message_suffix =
22083
22084 # router
22085 local_user_cyrus:
22086   driver = accept
22087   check_local_user
22088   local_part_suffix = .*
22089   transport = local_delivery_cyrus
22090 .endd
22091 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22092 &%return_output%& to cause any text written by Cyrus to be returned to the
22093 sender.
22094 .ecindex IIDpiptra1
22095 .ecindex IIDpiptra2
22096
22097
22098 . ////////////////////////////////////////////////////////////////////////////
22099 . ////////////////////////////////////////////////////////////////////////////
22100
22101 .chapter "The smtp transport" "CHAPsmtptrans"
22102 .scindex IIDsmttra1 "transports" "&(smtp)&"
22103 .scindex IIDsmttra2 "&(smtp)& transport"
22104 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22105 or LMTP protocol. The list of hosts to try can either be taken from the address
22106 that is being processed (having been set up by the router), or specified
22107 explicitly for the transport. Timeout and retry processing (see chapter
22108 &<<CHAPretry>>&) is applied to each IP address independently.
22109
22110
22111 .section "Multiple messages on a single connection" "SECID144"
22112 The sending of multiple messages over a single TCP/IP connection can arise in
22113 two ways:
22114
22115 .ilist
22116 If a message contains more than &%max_rcpt%& (see below) addresses that are
22117 routed to the same host, more than one copy of the message has to be sent to
22118 that host. In this situation, multiple copies may be sent in a single run of
22119 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22120 does when it has too many addresses to send in one message also depends on the
22121 value of the global &%remote_max_parallel%& option. Details are given in
22122 section &<<SECToutSMTPTCP>>&.)
22123 .next
22124 .cindex "hints database" "remembering routing"
22125 When a message has been successfully delivered over a TCP/IP connection, Exim
22126 looks in its hints database to see if there are any other messages awaiting a
22127 connection to the same host. If there are, a new delivery process is started
22128 for one of them, and the current TCP/IP connection is passed on to it. The new
22129 process may in turn send multiple copies and possibly create yet another
22130 process.
22131 .endlist
22132
22133
22134 For each copy sent over the same TCP/IP connection, a sequence counter is
22135 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22136 no further messages are sent over that connection.
22137
22138
22139
22140 .section "Use of the $host and $host_address variables" "SECID145"
22141 .vindex "&$host$&"
22142 .vindex "&$host_address$&"
22143 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22144 &$host_address$& are the name and IP address of the first host on the host list
22145 passed by the router. However, when the transport is about to connect to a
22146 specific host, and while it is connected to that host, &$host$& and
22147 &$host_address$& are set to the values for that host. These are the values
22148 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22149 &%serialize_hosts%&, and the various TLS options are expanded.
22150
22151
22152 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22153 .vindex &$tls_bits$&
22154 .vindex &$tls_cipher$&
22155 .vindex &$tls_peerdn$&
22156 .vindex &$tls_sni$&
22157 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22158 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22159 are the values that were set when the message was received.
22160 These are the values that are used for options that are expanded before any
22161 SMTP connections are made. Just before each connection is made, these four
22162 variables are emptied. If TLS is subsequently started, they are set to the
22163 appropriate values for the outgoing connection, and these are the values that
22164 are in force when any authenticators are run and when the
22165 &%authenticated_sender%& option is expanded.
22166
22167 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22168 and will be removed in a future release.
22169
22170
22171 .section "Private options for smtp" "SECID146"
22172 .cindex "options" "&(smtp)& transport"
22173 The private options of the &(smtp)& transport are as follows:
22174
22175
22176 .option address_retry_include_sender smtp boolean true
22177 .cindex "4&'xx'& responses" "retrying after"
22178 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22179 is the combination of sender and recipient that is delayed in subsequent queue
22180 runs until the retry time is reached. You can delay the recipient without
22181 reference to the sender (which is what earlier versions of Exim did), by
22182 setting &%address_retry_include_sender%& false. However, this can lead to
22183 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22184
22185 .option allow_localhost smtp boolean false
22186 .cindex "local host" "sending to"
22187 .cindex "fallback" "hosts specified on transport"
22188 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22189 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22190 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22191 the delivery anyway. This should be used only in special cases when the
22192 configuration ensures that no looping will result (for example, a differently
22193 configured Exim is listening on the port to which the message is sent).
22194
22195
22196 .option authenticated_sender smtp string&!! unset
22197 .cindex "Cyrus"
22198 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22199 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22200 overriding any existing authenticated sender value. If the string expansion is
22201 forced to fail, the option is ignored. Other expansion failures cause delivery
22202 to be deferred. If the result of expansion is an empty string, that is also
22203 ignored.
22204
22205 The expansion happens after the outgoing connection has been made and TLS
22206 started, if required. This means that the &$host$&, &$host_address$&,
22207 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
22208 particular connection.
22209
22210 If the SMTP session is not authenticated, the expansion of
22211 &%authenticated_sender%& still happens (and can cause the delivery to be
22212 deferred if it fails), but no AUTH= item is added to MAIL commands
22213 unless &%authenticated_sender_force%& is true.
22214
22215 This option allows you to use the &(smtp)& transport in LMTP mode to
22216 deliver mail to Cyrus IMAP and provide the proper local part as the
22217 &"authenticated sender"&, via a setting such as:
22218 .code
22219 authenticated_sender = $local_part
22220 .endd
22221 This removes the need for IMAP subfolders to be assigned special ACLs to
22222 allow direct delivery to those subfolders.
22223
22224 Because of expected uses such as that just described for Cyrus (when no
22225 domain is involved), there is no checking on the syntax of the provided
22226 value.
22227
22228
22229 .option authenticated_sender_force smtp boolean false
22230 If this option is set true, the &%authenticated_sender%& option's value
22231 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
22232 authenticated as a client.
22233
22234
22235 .option command_timeout smtp time 5m
22236 This sets a timeout for receiving a response to an SMTP command that has been
22237 sent out. It is also used when waiting for the initial banner line from the
22238 remote host. Its value must not be zero.
22239
22240
22241 .option connect_timeout smtp time 5m
22242 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
22243 to a remote host. A setting of zero allows the system timeout (typically
22244 several minutes) to act. To have any effect, the value of this option must be
22245 less than the system timeout. However, it has been observed that on some
22246 systems there is no system timeout, which is why the default value for this
22247 option is 5 minutes, a value recommended by RFC 1123.
22248
22249
22250 .option connection_max_messages smtp integer 500
22251 .cindex "SMTP" "passed connection"
22252 .cindex "SMTP" "multiple deliveries"
22253 .cindex "multiple SMTP deliveries"
22254 This controls the maximum number of separate message deliveries that are sent
22255 over a single TCP/IP connection. If the value is zero, there is no limit.
22256 For testing purposes, this value can be overridden by the &%-oB%& command line
22257 option.
22258
22259
22260 .option data_timeout smtp time 5m
22261 This sets a timeout for the transmission of each block in the data portion of
22262 the message. As a result, the overall timeout for a message depends on the size
22263 of the message. Its value must not be zero. See also &%final_timeout%&.
22264
22265
22266 .option delay_after_cutoff smtp boolean true
22267 This option controls what happens when all remote IP addresses for a given
22268 domain have been inaccessible for so long that they have passed their retry
22269 cutoff times.
22270
22271 In the default state, if the next retry time has not been reached for any of
22272 them, the address is bounced without trying any deliveries. In other words,
22273 Exim delays retrying an IP address after the final cutoff time until a new
22274 retry time is reached, and can therefore bounce an address without ever trying
22275 a delivery, when machines have been down for a long time. Some people are
22276 unhappy at this prospect, so...
22277
22278 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22279 addresses are past their final cutoff time, Exim tries to deliver to those
22280 IP addresses that have not been tried since the message arrived. If there are
22281 none, of if they all fail, the address is bounced. In other words, it does not
22282 delay when a new message arrives, but immediately tries those expired IP
22283 addresses that haven't been tried since the message arrived. If there is a
22284 continuous stream of messages for the dead hosts, unsetting
22285 &%delay_after_cutoff%& means that there will be many more attempts to deliver
22286 to them.
22287
22288
22289 .option dns_qualify_single smtp boolean true
22290 If the &%hosts%& or &%fallback_hosts%& option is being used,
22291 and the &%gethostbyname%& option is false,
22292 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22293 in chapter &<<CHAPdnslookup>>& for more details.
22294
22295
22296 .option dns_search_parents smtp boolean false
22297 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22298 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22299 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22300 details.
22301
22302
22303 .new
22304 .option dscp smtp string&!! unset
22305 .cindex "DCSP" "outbound"
22306 This option causes the DSCP value associated with a socket to be set to one
22307 of a number of fixed strings or to numeric value.
22308 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
22309 Common values include &`throughput`&, &`mincost`&, and on newer systems
22310 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
22311
22312 The outbound packets from Exim will be marked with this value in the header
22313 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
22314 that these values will have any effect, not be stripped by networking
22315 equipment, or do much of anything without cooperation with your Network
22316 Engineer and those of all network operators between the source and destination.
22317 .wen
22318
22319
22320 .option fallback_hosts smtp "string list" unset
22321 .cindex "fallback" "hosts specified on transport"
22322 String expansion is not applied to this option. The argument must be a
22323 colon-separated list of host names or IP addresses, optionally also including
22324 port numbers, though the separator can be changed, as described in section
22325 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22326 item in a &%route_list%& setting for the &(manualroute)& router, as described
22327 in section &<<SECTformatonehostitem>>&.
22328
22329 Fallback hosts can also be specified on routers, which associate them with the
22330 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
22331 &%fallback_hosts%& specified on the transport is used only if the address does
22332 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
22333 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
22334 However, &%hosts_randomize%& does apply to fallback host lists.
22335
22336 If Exim is unable to deliver to any of the hosts for a particular address, and
22337 the errors are not permanent rejections, the address is put on a separate
22338 transport queue with its host list replaced by the fallback hosts, unless the
22339 address was routed via MX records and the current host was in the original MX
22340 list. In that situation, the fallback host list is not used.
22341
22342 Once normal deliveries are complete, the fallback queue is delivered by
22343 re-running the same transports with the new host lists. If several failing
22344 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
22345 copy of the message is sent.
22346
22347 The resolution of the host names on the fallback list is controlled by the
22348 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
22349 both to cases when the host list comes with the address and when it is taken
22350 from &%hosts%&. This option provides a &"use a smart host only if delivery
22351 fails"& facility.
22352
22353
22354 .option final_timeout smtp time 10m
22355 This is the timeout that applies while waiting for the response to the final
22356 line containing just &"."& that terminates a message. Its value must not be
22357 zero.
22358
22359 .option gethostbyname smtp boolean false
22360 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
22361 being used, names are looked up using &[gethostbyname()]&
22362 (or &[getipnodebyname()]& when available)
22363 instead of using the DNS. Of course, that function may in fact use the DNS, but
22364 it may also consult other sources of information such as &_/etc/hosts_&.
22365
22366 .option gnutls_compat_mode smtp boolean unset
22367 This option controls whether GnuTLS is used in compatibility mode in an Exim
22368 server. This reduces security slightly, but improves interworking with older
22369 implementations of TLS.
22370
22371 .option helo_data smtp string&!! "see below"
22372 .cindex "HELO" "argument, setting"
22373 .cindex "EHLO" "argument, setting"
22374 .cindex "LHLO argument setting"
22375 The value of this option is expanded after a connection to a another host has
22376 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
22377 command that starts the outgoing SMTP or LMTP session. The default value of the
22378 option is:
22379 .code
22380 $primary_hostname
22381 .endd
22382 During the expansion, the variables &$host$& and &$host_address$& are set to
22383 the identity of the remote host, and the variables &$sending_ip_address$& and
22384 &$sending_port$& are set to the local IP address and port number that are being
22385 used. These variables can be used to generate different values for different
22386 servers or different local IP addresses. For example, if you want the string
22387 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
22388 interface address, you could use this:
22389 .code
22390 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
22391   {$primary_hostname}}
22392 .endd
22393 The use of &%helo_data%& applies both to sending messages and when doing
22394 callouts.
22395
22396 .option hosts smtp "string list&!!" unset
22397 Hosts are associated with an address by a router such as &(dnslookup)&, which
22398 finds the hosts by looking up the address domain in the DNS, or by
22399 &(manualroute)&, which has lists of hosts in its configuration. However,
22400 email addresses can be passed to the &(smtp)& transport by any router, and not
22401 all of them can provide an associated list of hosts.
22402
22403 The &%hosts%& option specifies a list of hosts to be used if the address being
22404 processed does not have any hosts associated with it. The hosts specified by
22405 &%hosts%& are also used, whether or not the address has its own hosts, if
22406 &%hosts_override%& is set.
22407
22408 The string is first expanded, before being interpreted as a colon-separated
22409 list of host names or IP addresses, possibly including port numbers. The
22410 separator may be changed to something other than colon, as described in section
22411 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22412 item in a &%route_list%& setting for the &(manualroute)& router, as described
22413 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
22414 of the &(manualroute)& router is not available here.
22415
22416 If the expansion fails, delivery is deferred. Unless the failure was caused by
22417 the inability to complete a lookup, the error is logged to the panic log as
22418 well as the main log. Host names are looked up either by searching directly for
22419 address records in the DNS or by calling &[gethostbyname()]& (or
22420 &[getipnodebyname()]& when available), depending on the setting of the
22421 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
22422 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
22423 address are used.
22424
22425 During delivery, the hosts are tried in order, subject to their retry status,
22426 unless &%hosts_randomize%& is set.
22427
22428
22429 .option hosts_avoid_esmtp smtp "host list&!!" unset
22430 .cindex "ESMTP, avoiding use of"
22431 .cindex "HELO" "forcing use of"
22432 .cindex "EHLO" "avoiding use of"
22433 .cindex "PIPELINING" "avoiding the use of"
22434 This option is for use with broken hosts that announce ESMTP facilities (for
22435 example, PIPELINING) and then fail to implement them properly. When a host
22436 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
22437 start of the SMTP session. This means that it cannot use any of the ESMTP
22438 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
22439
22440
22441 .option hosts_avoid_pipelining smtp "host list&!!" unset
22442 .cindex "PIPELINING" "avoiding the use of"
22443 Exim will not use the SMTP PIPELINING extension when delivering to any host
22444 that matches this list, even if the server host advertises PIPELINING support.
22445
22446
22447 .option hosts_avoid_tls smtp "host list&!!" unset
22448 .cindex "TLS" "avoiding for certain hosts"
22449 Exim will not try to start a TLS session when delivering to any host that
22450 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22451
22452 .option hosts_verify_avoid_tls smtp "host list&!!" *
22453 .cindex "TLS" "avoiding for certain hosts"
22454 Exim will not try to start a TLS session for a verify callout,
22455 or when delivering in cutthrough mode,
22456 to any host that matches this list.
22457 Note that the default is to not use TLS.
22458
22459
22460 .option hosts_max_try smtp integer 5
22461 .cindex "host" "maximum number to try"
22462 .cindex "limit" "number of hosts tried"
22463 .cindex "limit" "number of MX tried"
22464 .cindex "MX record" "maximum tried"
22465 This option limits the number of IP addresses that are tried for any one
22466 delivery in cases where there are temporary delivery errors. Section
22467 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
22468
22469
22470 .option hosts_max_try_hardlimit smtp integer 50
22471 This is an additional check on the maximum number of IP addresses that Exim
22472 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
22473 why it exists.
22474
22475
22476
22477 .option hosts_nopass_tls smtp "host list&!!" unset
22478 .cindex "TLS" "passing connection"
22479 .cindex "multiple SMTP deliveries"
22480 .cindex "TLS" "multiple message deliveries"
22481 For any host that matches this list, a connection on which a TLS session has
22482 been started will not be passed to a new delivery process for sending another
22483 message on the same connection. See section &<<SECTmulmessam>>& for an
22484 explanation of when this might be needed.
22485
22486
22487 .option hosts_override smtp boolean false
22488 If this option is set and the &%hosts%& option is also set, any hosts that are
22489 attached to the address are ignored, and instead the hosts specified by the
22490 &%hosts%& option are always used. This option does not apply to
22491 &%fallback_hosts%&.
22492
22493
22494 .option hosts_randomize smtp boolean false
22495 .cindex "randomized host list"
22496 .cindex "host" "list of; randomized"
22497 .cindex "fallback" "randomized hosts"
22498 If this option is set, and either the list of hosts is taken from the
22499 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
22500 were not obtained from MX records (this includes fallback hosts from the
22501 router), and were not randomized by the router, the order of trying the hosts
22502 is randomized each time the transport runs. Randomizing the order of a host
22503 list can be used to do crude load sharing.
22504
22505 When &%hosts_randomize%& is true, a host list may be split into groups whose
22506 order is separately randomized. This makes it possible to set up MX-like
22507 behaviour. The boundaries between groups are indicated by an item that is just
22508 &`+`& in the host list. For example:
22509 .code
22510 hosts = host1:host2:host3:+:host4:host5
22511 .endd
22512 The order of the first three hosts and the order of the last two hosts is
22513 randomized for each use, but the first three always end up before the last two.
22514 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
22515
22516 .option hosts_require_auth smtp "host list&!!" unset
22517 .cindex "authentication" "required by client"
22518 This option provides a list of servers for which authentication must succeed
22519 before Exim will try to transfer a message. If authentication fails for
22520 servers which are not in this list, Exim tries to send unauthenticated. If
22521 authentication fails for one of these servers, delivery is deferred. This
22522 temporary error is detectable in the retry rules, so it can be turned into a
22523 hard failure if required. See also &%hosts_try_auth%&, and chapter
22524 &<<CHAPSMTPAUTH>>& for details of authentication.
22525
22526
22527 .option hosts_require_tls smtp "host list&!!" unset
22528 .cindex "TLS" "requiring for certain servers"
22529 Exim will insist on using a TLS session when delivering to any host that
22530 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22531 &*Note*&: This option affects outgoing mail only. To insist on TLS for
22532 incoming messages, use an appropriate ACL.
22533
22534 .option hosts_try_auth smtp "host list&!!" unset
22535 .cindex "authentication" "optional in client"
22536 This option provides a list of servers to which, provided they announce
22537 authentication support, Exim will attempt to authenticate as a client when it
22538 connects. If authentication fails, Exim will try to transfer the message
22539 unauthenticated. See also &%hosts_require_auth%&, and chapter
22540 &<<CHAPSMTPAUTH>>& for details of authentication.
22541
22542 .option interface smtp "string list&!!" unset
22543 .cindex "bind IP address"
22544 .cindex "IP address" "binding"
22545 .vindex "&$host$&"
22546 .vindex "&$host_address$&"
22547 This option specifies which interface to bind to when making an outgoing SMTP
22548 call. The value is an IP address, not an interface name such as
22549 &`eth0`&. Do not confuse this with the interface address that was used when a
22550 message was received, which is in &$received_ip_address$&, formerly known as
22551 &$interface_address$&. The name was changed to minimize confusion with the
22552 outgoing interface address. There is no variable that contains an outgoing
22553 interface address because, unless it is set by this option, its value is
22554 unknown.
22555
22556 During the expansion of the &%interface%& option the variables &$host$& and
22557 &$host_address$& refer to the host to which a connection is about to be made
22558 during the expansion of the string. Forced expansion failure, or an empty
22559 string result causes the option to be ignored. Otherwise, after expansion, the
22560 string must be a list of IP addresses, colon-separated by default, but the
22561 separator can be changed in the usual way. For example:
22562 .code
22563 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
22564 .endd
22565 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
22566 connection. If none of them are the correct type, the option is ignored. If
22567 &%interface%& is not set, or is ignored, the system's IP functions choose which
22568 interface to use if the host has more than one.
22569
22570
22571 .option keepalive smtp boolean true
22572 .cindex "keepalive" "on outgoing connection"
22573 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
22574 connections. When set, it causes the kernel to probe idle connections
22575 periodically, by sending packets with &"old"& sequence numbers. The other end
22576 of the connection should send a acknowledgment if the connection is still okay
22577 or a reset if the connection has been aborted. The reason for doing this is
22578 that it has the beneficial effect of freeing up certain types of connection
22579 that can get stuck when the remote host is disconnected without tidying up the
22580 TCP/IP call properly. The keepalive mechanism takes several hours to detect
22581 unreachable hosts.
22582
22583
22584 .option lmtp_ignore_quota smtp boolean false
22585 .cindex "LMTP" "ignoring quota errors"
22586 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
22587 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
22588 has advertised support for IGNOREQUOTA in its response to the LHLO command.
22589
22590 .option max_rcpt smtp integer 100
22591 .cindex "RCPT" "maximum number of outgoing"
22592 This option limits the number of RCPT commands that are sent in a single
22593 SMTP message transaction. Each set of addresses is treated independently, and
22594 so can cause parallel connections to the same host if &%remote_max_parallel%&
22595 permits this.
22596
22597
22598 .option multi_domain smtp boolean true
22599 .vindex "&$domain$&"
22600 When this option is set, the &(smtp)& transport can handle a number of
22601 addresses containing a mixture of different domains provided they all resolve
22602 to the same list of hosts. Turning the option off restricts the transport to
22603 handling only one domain at a time. This is useful if you want to use
22604 &$domain$& in an expansion for the transport, because it is set only when there
22605 is a single domain involved in a remote delivery.
22606
22607
22608 .option port smtp string&!! "see below"
22609 .cindex "port" "sending TCP/IP"
22610 .cindex "TCP/IP" "setting outgoing port"
22611 This option specifies the TCP/IP port on the server to which Exim connects.
22612 &*Note:*& Do not confuse this with the port that was used when a message was
22613 received, which is in &$received_port$&, formerly known as &$interface_port$&.
22614 The name was changed to minimize confusion with the outgoing port. There is no
22615 variable that contains an outgoing port.
22616
22617 If the value of this option begins with a digit it is taken as a port number;
22618 otherwise it is looked up using &[getservbyname()]&. The default value is
22619 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
22620 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
22621 is deferred.
22622
22623
22624
22625 .option protocol smtp string smtp
22626 .cindex "LMTP" "over TCP/IP"
22627 .cindex "ssmtp protocol" "outbound"
22628 .cindex "TLS" "SSL-on-connect outbound"
22629 .vindex "&$port$&"
22630 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
22631 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
22632 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
22633 deliveries into closed message stores. Exim also has support for running LMTP
22634 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
22635
22636 If this option is set to &"smtps"&, the default vaule for the &%port%& option
22637 changes to &"smtps"&, and the transport initiates TLS immediately after
22638 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
22639 The Internet standards bodies strongly discourage use of this mode.
22640
22641
22642 .option retry_include_ip_address smtp boolean true
22643 Exim normally includes both the host name and the IP address in the key it
22644 constructs for indexing retry data after a temporary delivery failure. This
22645 means that when one of several IP addresses for a host is failing, it gets
22646 tried periodically (controlled by the retry rules), but use of the other IP
22647 addresses is not affected.
22648
22649 However, in some dialup environments hosts are assigned a different IP address
22650 each time they connect. In this situation the use of the IP address as part of
22651 the retry key leads to undesirable behaviour. Setting this option false causes
22652 Exim to use only the host name. This should normally be done on a separate
22653 instance of the &(smtp)& transport, set up specially to handle the dialup
22654 hosts.
22655
22656
22657 .option serialize_hosts smtp "host list&!!" unset
22658 .cindex "serializing connections"
22659 .cindex "host" "serializing connections"
22660 Because Exim operates in a distributed manner, if several messages for the same
22661 host arrive at around the same time, more than one simultaneous connection to
22662 the remote host can occur. This is not usually a problem except when there is a
22663 slow link between the hosts. In that situation it may be helpful to restrict
22664 Exim to one connection at a time. This can be done by setting
22665 &%serialize_hosts%& to match the relevant hosts.
22666
22667 .cindex "hints database" "serializing deliveries to a host"
22668 Exim implements serialization by means of a hints database in which a record is
22669 written whenever a process connects to one of the restricted hosts. The record
22670 is deleted when the connection is completed. Obviously there is scope for
22671 records to get left lying around if there is a system or program crash. To
22672 guard against this, Exim ignores any records that are more than six hours old.
22673
22674 If you set up this kind of serialization, you should also arrange to delete the
22675 relevant hints database whenever your system reboots. The names of the files
22676 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22677 may be one or two files, depending on the type of DBM in use. The same files
22678 are used for ETRN serialization.
22679
22680
22681 .option size_addition smtp integer 1024
22682 .cindex "SMTP" "SIZE"
22683 .cindex "message" "size issue for transport filter"
22684 .cindex "size" "of message"
22685 .cindex "transport" "filter"
22686 .cindex "filter" "transport filter"
22687 If a remote SMTP server indicates that it supports the SIZE option of the
22688 MAIL command, Exim uses this to pass over the message size at the start of
22689 an SMTP transaction. It adds the value of &%size_addition%& to the value it
22690 sends, to allow for headers and other text that may be added during delivery by
22691 configuration options or in a transport filter. It may be necessary to increase
22692 this if a lot of text is added to messages.
22693
22694 Alternatively, if the value of &%size_addition%& is set negative, it disables
22695 the use of the SIZE option altogether.
22696
22697
22698 .option tls_certificate smtp string&!! unset
22699 .cindex "TLS" "client certificate, location of"
22700 .cindex "certificate" "client, location of"
22701 .vindex "&$host$&"
22702 .vindex "&$host_address$&"
22703 The value of this option must be the absolute path to a file which contains the
22704 client's certificate, for possible use when sending a message over an encrypted
22705 connection. The values of &$host$& and &$host_address$& are set to the name and
22706 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
22707 details of TLS.
22708
22709 &*Note*&: This option must be set if you want Exim to be able to use a TLS
22710 certificate when sending messages as a client. The global option of the same
22711 name specifies the certificate for Exim as a server; it is not automatically
22712 assumed that the same certificate should be used when Exim is operating as a
22713 client.
22714
22715
22716 .option tls_crl smtp string&!! unset
22717 .cindex "TLS" "client certificate revocation list"
22718 .cindex "certificate" "revocation list for client"
22719 This option specifies a certificate revocation list. The expanded value must
22720 be the name of a file that contains a CRL in PEM format.
22721
22722
22723 .new
22724 .option tls_dh_min_bits smtp integer 1024
22725 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
22726 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
22727 key agreement is negotiated, the server will provide a large prime number
22728 for use.  This option establishes the minimum acceptable size of that number.
22729 If the parameter offered by the server is too small, then the TLS handshake
22730 will fail.
22731
22732 Only supported when using GnuTLS.
22733 .wen
22734
22735
22736 .option tls_privatekey smtp string&!! unset
22737 .cindex "TLS" "client private key, location of"
22738 .vindex "&$host$&"
22739 .vindex "&$host_address$&"
22740 The value of this option must be the absolute path to a file which contains the
22741 client's private key. This is used when sending a message over an encrypted
22742 connection using a client certificate. The values of &$host$& and
22743 &$host_address$& are set to the name and address of the server during the
22744 expansion. If this option is unset, or the expansion is forced to fail, or the
22745 result is an empty string, the private key is assumed to be in the same file as
22746 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
22747
22748
22749 .option tls_require_ciphers smtp string&!! unset
22750 .cindex "TLS" "requiring specific ciphers"
22751 .cindex "cipher" "requiring specific"
22752 .vindex "&$host$&"
22753 .vindex "&$host_address$&"
22754 The value of this option must be a list of permitted cipher suites, for use
22755 when setting up an outgoing encrypted connection. (There is a global option of
22756 the same name for controlling incoming connections.) The values of &$host$& and
22757 &$host_address$& are set to the name and address of the server during the
22758 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
22759 is used in different ways by OpenSSL and GnuTLS (see sections
22760 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
22761 ciphers is a preference order.
22762
22763
22764
22765 .option tls_sni smtp string&!! unset
22766 .cindex "TLS" "Server Name Indication"
22767 .vindex "&$tls_sni$&"
22768 If this option is set then it sets the $tls_out_sni variable and causes any
22769 TLS session to pass this value as the Server Name Indication extension to
22770 the remote side, which can be used by the remote side to select an appropriate
22771 certificate and private key for the session.
22772
22773 See &<<SECTtlssni>>& for more information.
22774
22775 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
22776 TLS extensions.
22777
22778
22779
22780
22781 .option tls_tempfail_tryclear smtp boolean true
22782 .cindex "4&'xx'& responses" "to STARTTLS"
22783 When the server host is not in &%hosts_require_tls%&, and there is a problem in
22784 setting up a TLS session, this option determines whether or not Exim should try
22785 to deliver the message unencrypted. If it is set false, delivery to the
22786 current host is deferred; if there are other hosts, they are tried. If this
22787 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
22788 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
22789 TLS negotiation fails, Exim closes the current connection (because it is in an
22790 unknown state), opens a new one to the same host, and then tries the delivery
22791 in clear.
22792
22793
22794 .option tls_verify_certificates smtp string&!! unset
22795 .cindex "TLS" "server certificate verification"
22796 .cindex "certificate" "verification of server"
22797 .vindex "&$host$&"
22798 .vindex "&$host_address$&"
22799 The value of this option must be the absolute path to a file containing
22800 permitted server certificates, for use when setting up an encrypted connection.
22801 Alternatively, if you are using OpenSSL, you can set
22802 &%tls_verify_certificates%& to the name of a directory containing certificate
22803 files. This does not work with GnuTLS; the option must be set to the name of a
22804 single file if you are using GnuTLS. The values of &$host$& and
22805 &$host_address$& are set to the name and address of the server during the
22806 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
22807
22808
22809
22810
22811 .section "How the limits for the number of hosts to try are used" &&&
22812          "SECTvalhosmax"
22813 .cindex "host" "maximum number to try"
22814 .cindex "limit" "hosts; maximum number tried"
22815 There are two options that are concerned with the number of hosts that are
22816 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
22817 &%hosts_max_try_hardlimit%&.
22818
22819
22820 The &%hosts_max_try%& option limits the number of hosts that are tried
22821 for a single delivery. However, despite the term &"host"& in its name, the
22822 option actually applies to each IP address independently. In other words, a
22823 multihomed host is treated as several independent hosts, just as it is for
22824 retrying.
22825
22826 Many of the larger ISPs have multiple MX records which often point to
22827 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
22828 created as a result of routing one of these domains.
22829
22830 Trying every single IP address on such a long list does not seem sensible; if
22831 several at the top of the list fail, it is reasonable to assume there is some
22832 problem that is likely to affect all of them. Roughly speaking, the value of
22833 &%hosts_max_try%& is the maximum number that are tried before deferring the
22834 delivery. However, the logic cannot be quite that simple.
22835
22836 Firstly, IP addresses that are skipped because their retry times have not
22837 arrived do not count, and in addition, addresses that are past their retry
22838 limits are also not counted, even when they are tried. This means that when
22839 some IP addresses are past their retry limits, more than the value of
22840 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
22841 that all IP addresses are considered before timing out an email address (but
22842 see below for an exception).
22843
22844 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
22845 list to see if there is a subsequent host with a different (higher valued) MX.
22846 If there is, that host is considered next, and the current IP address is used
22847 but not counted. This behaviour helps in the case of a domain with a retry rule
22848 that hardly ever delays any hosts, as is now explained:
22849
22850 Consider the case of a long list of hosts with one MX value, and a few with a
22851 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
22852 hosts at the top of the list are tried at first. With the default retry rule,
22853 which specifies increasing retry times, the higher MX hosts are eventually
22854 tried when those at the top of the list are skipped because they have not
22855 reached their retry times.
22856
22857 However, it is common practice to put a fixed short retry time on domains for
22858 large ISPs, on the grounds that their servers are rarely down for very long.
22859 Unfortunately, these are exactly the domains that tend to resolve to long lists
22860 of hosts. The short retry time means that the lowest MX hosts are tried every
22861 time. The attempts may be in a different order because of random sorting, but
22862 without the special MX check, the higher MX hosts would never be tried until
22863 all the lower MX hosts had timed out (which might be several days), because
22864 there are always some lower MX hosts that have reached their retry times. With
22865 the special check, Exim considers at least one IP address from each MX value at
22866 every delivery attempt, even if the &%hosts_max_try%& limit has already been
22867 reached.
22868
22869 The above logic means that &%hosts_max_try%& is not a hard limit, and in
22870 particular, Exim normally eventually tries all the IP addresses before timing
22871 out an email address. When &%hosts_max_try%& was implemented, this seemed a
22872 reasonable thing to do. Recently, however, some lunatic DNS configurations have
22873 been set up with hundreds of IP addresses for some domains. It can
22874 take a very long time indeed for an address to time out in these cases.
22875
22876 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
22877 Exim never tries more than this number of IP addresses; if it hits this limit
22878 and they are all timed out, the email address is bounced, even though not all
22879 possible IP addresses have been tried.
22880 .ecindex IIDsmttra1
22881 .ecindex IIDsmttra2
22882
22883
22884
22885
22886
22887 . ////////////////////////////////////////////////////////////////////////////
22888 . ////////////////////////////////////////////////////////////////////////////
22889
22890 .chapter "Address rewriting" "CHAPrewrite"
22891 .scindex IIDaddrew "rewriting" "addresses"
22892 There are some circumstances in which Exim automatically rewrites domains in
22893 addresses. The two most common are when an address is given without a domain
22894 (referred to as an &"unqualified address"&) or when an address contains an
22895 abbreviated domain that is expanded by DNS lookup.
22896
22897 Unqualified envelope addresses are accepted only for locally submitted
22898 messages, or for messages that are received from hosts matching
22899 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
22900 appropriate. Unqualified addresses in header lines are qualified if they are in
22901 locally submitted messages, or messages from hosts that are permitted to send
22902 unqualified envelope addresses. Otherwise, unqualified addresses in header
22903 lines are neither qualified nor rewritten.
22904
22905 One situation in which Exim does &'not'& automatically rewrite a domain is
22906 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
22907 such a domain should be rewritten using the &"canonical"& name, and some MTAs
22908 do this. The new RFCs do not contain this suggestion.
22909
22910
22911 .section "Explicitly configured address rewriting" "SECID147"
22912 This chapter describes the rewriting rules that can be used in the
22913 main rewrite section of the configuration file, and also in the generic
22914 &%headers_rewrite%& option that can be set on any transport.
22915
22916 Some people believe that configured address rewriting is a Mortal Sin.
22917 Others believe that life is not possible without it. Exim provides the
22918 facility; you do not have to use it.
22919
22920 The main rewriting rules that appear in the &"rewrite"& section of the
22921 configuration file are applied to addresses in incoming messages, both envelope
22922 addresses and addresses in header lines. Each rule specifies the types of
22923 address to which it applies.
22924
22925 Whether or not addresses in header lines are rewritten depends on the origin of
22926 the headers and the type of rewriting. Global rewriting, that is, rewriting
22927 rules from the rewrite section of the configuration file, is applied only to
22928 those headers that were received with the message. Header lines that are added
22929 by ACLs or by a system filter or by individual routers or transports (which
22930 are specific to individual recipient addresses) are not rewritten by the global
22931 rules.
22932
22933 Rewriting at transport time, by means of the &%headers_rewrite%& option,
22934 applies all headers except those added by routers and transports. That is, as
22935 well as the headers that were received with the message, it also applies to
22936 headers that were added by an ACL or a system filter.
22937
22938
22939 In general, rewriting addresses from your own system or domain has some
22940 legitimacy. Rewriting other addresses should be done only with great care and
22941 in special circumstances. The author of Exim believes that rewriting should be
22942 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
22943 Although it can sometimes be used as a routing tool, this is very strongly
22944 discouraged.
22945
22946 There are two commonly encountered circumstances where rewriting is used, as
22947 illustrated by these examples:
22948
22949 .ilist
22950 The company whose domain is &'hitch.fict.example'& has a number of hosts that
22951 exchange mail with each other behind a firewall, but there is only a single
22952 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
22953 &'hitch.fict.example'& when sending mail off-site.
22954 .next
22955 A host rewrites the local parts of its own users so that, for example,
22956 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
22957 .endlist
22958
22959
22960
22961 .section "When does rewriting happen?" "SECID148"
22962 .cindex "rewriting" "timing of"
22963 .cindex "&ACL;" "rewriting addresses in"
22964 Configured address rewriting can take place at several different stages of a
22965 message's processing.
22966
22967 .vindex "&$sender_address$&"
22968 At the start of an ACL for MAIL, the sender address may have been rewritten
22969 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
22970 ordinary rewrite rules have yet been applied. If, however, the sender address
22971 is verified in the ACL, it is rewritten before verification, and remains
22972 rewritten thereafter. The subsequent value of &$sender_address$& is the
22973 rewritten address. This also applies if sender verification happens in a
22974 RCPT ACL. Otherwise, when the sender address is not verified, it is
22975 rewritten as soon as a message's header lines have been received.
22976
22977 .vindex "&$domain$&"
22978 .vindex "&$local_part$&"
22979 Similarly, at the start of an ACL for RCPT, the current recipient's address
22980 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
22981 rewrite rules have yet been applied to it. However, the behaviour is different
22982 from the sender address when a recipient is verified. The address is rewritten
22983 for the verification, but the rewriting is not remembered at this stage. The
22984 value of &$local_part$& and &$domain$& after verification are always the same
22985 as they were before (that is, they contain the unrewritten &-- except for
22986 SMTP-time rewriting &-- address).
22987
22988 As soon as a message's header lines have been received, all the envelope
22989 recipient addresses are permanently rewritten, and rewriting is also applied to
22990 the addresses in the header lines (if configured). This happens before adding
22991 any header lines that were specified in MAIL or RCPT ACLs, and
22992 .cindex "&[local_scan()]& function" "address rewriting; timing of"
22993 before the DATA ACL and &[local_scan()]& functions are run.
22994
22995 When an address is being routed, either for delivery or for verification,
22996 rewriting is applied immediately to child addresses that are generated by
22997 redirection, unless &%no_rewrite%& is set on the router.
22998
22999 .cindex "envelope sender" "rewriting at transport time"
23000 .cindex "rewriting" "at transport time"
23001 .cindex "header lines" "rewriting at transport time"
23002 At transport time, additional rewriting of addresses in header lines can be
23003 specified by setting the generic &%headers_rewrite%& option on a transport.
23004 This option contains rules that are identical in form to those in the rewrite
23005 section of the configuration file. They are applied to the original message
23006 header lines and any that were added by ACLs or a system filter. They are not
23007 applied to header lines that are added by routers or the transport.
23008
23009 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23010 transport option. However, it is not possible to rewrite envelope recipients at
23011 transport time.
23012
23013
23014
23015
23016 .section "Testing the rewriting rules that apply on input" "SECID149"
23017 .cindex "rewriting" "testing"
23018 .cindex "testing" "rewriting"
23019 Exim's input rewriting configuration appears in a part of the run time
23020 configuration file headed by &"begin rewrite"&. It can be tested by the
23021 &%-brw%& command line option. This takes an address (which can be a full RFC
23022 2822 address) as its argument. The output is a list of how the address would be
23023 transformed by the rewriting rules for each of the different places it might
23024 appear in an incoming message, that is, for each different header and for the
23025 envelope sender and recipient fields. For example,
23026 .code
23027 exim -brw ph10@exim.workshop.example
23028 .endd
23029 might produce the output
23030 .code
23031 sender: Philip.Hazel@exim.workshop.example
23032 from: Philip.Hazel@exim.workshop.example
23033 to: ph10@exim.workshop.example
23034 cc: ph10@exim.workshop.example
23035 bcc: ph10@exim.workshop.example
23036 reply-to: Philip.Hazel@exim.workshop.example
23037 env-from: Philip.Hazel@exim.workshop.example
23038 env-to: ph10@exim.workshop.example
23039 .endd
23040 which shows that rewriting has been set up for that address when used in any of
23041 the source fields, but not when it appears as a recipient address. At the
23042 present time, there is no equivalent way of testing rewriting rules that are
23043 set for a particular transport.
23044
23045
23046 .section "Rewriting rules" "SECID150"
23047 .cindex "rewriting" "rules"
23048 The rewrite section of the configuration file consists of lines of rewriting
23049 rules in the form
23050 .display
23051 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23052 .endd
23053 Rewriting rules that are specified for the &%headers_rewrite%& generic
23054 transport option are given as a colon-separated list. Each item in the list
23055 takes the same form as a line in the main rewriting configuration (except that
23056 any colons must be doubled, of course).
23057
23058 The formats of source patterns and replacement strings are described below.
23059 Each is terminated by white space, unless enclosed in double quotes, in which
23060 case normal quoting conventions apply inside the quotes. The flags are single
23061 characters which may appear in any order. Spaces and tabs between them are
23062 ignored.
23063
23064 For each address that could potentially be rewritten, the rules are scanned in
23065 order, and replacements for the address from earlier rules can themselves be
23066 replaced by later rules (but see the &"q"& and &"R"& flags).
23067
23068 The order in which addresses are rewritten is undefined, may change between
23069 releases, and must not be relied on, with one exception: when a message is
23070 received, the envelope sender is always rewritten first, before any header
23071 lines are rewritten. For example, the replacement string for a rewrite of an
23072 address in &'To:'& must not assume that the message's address in &'From:'& has
23073 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23074 that the envelope sender has already been rewritten.
23075
23076 .vindex "&$domain$&"
23077 .vindex "&$local_part$&"
23078 The variables &$local_part$& and &$domain$& can be used in the replacement
23079 string to refer to the address that is being rewritten. Note that lookup-driven
23080 rewriting can be done by a rule of the form
23081 .code
23082 *@*   ${lookup ...
23083 .endd
23084 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23085 refer to the address that is being rewritten.
23086
23087
23088 .section "Rewriting patterns" "SECID151"
23089 .cindex "rewriting" "patterns"
23090 .cindex "address list" "in a rewriting pattern"
23091 The source pattern in a rewriting rule is any item which may appear in an
23092 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23093 single-item address list, which means that it is expanded before being tested
23094 against the address. As always, if you use a regular expression as a pattern,
23095 you must take care to escape dollar and backslash characters, or use the &`\N`&
23096 facility to suppress string expansion within the regular expression.
23097
23098 Domains in patterns should be given in lower case. Local parts in patterns are
23099 case-sensitive. If you want to do case-insensitive matching of local parts, you
23100 can use a regular expression that starts with &`^(?i)`&.
23101
23102 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
23103 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
23104 depending on the type of match which occurred. These can be used in the
23105 replacement string to insert portions of the incoming address. &$0$& always
23106 refers to the complete incoming address. When a regular expression is used, the
23107 numerical variables are set from its capturing subexpressions. For other types
23108 of pattern they are set as follows:
23109
23110 .ilist
23111 If a local part or domain starts with an asterisk, the numerical variables
23112 refer to the character strings matched by asterisks, with &$1$& associated with
23113 the first asterisk, and &$2$& with the second, if present. For example, if the
23114 pattern
23115 .code
23116 *queen@*.fict.example
23117 .endd
23118 is matched against the address &'hearts-queen@wonderland.fict.example'& then
23119 .code
23120 $0 = hearts-queen@wonderland.fict.example
23121 $1 = hearts-
23122 $2 = wonderland
23123 .endd
23124 Note that if the local part does not start with an asterisk, but the domain
23125 does, it is &$1$& that contains the wild part of the domain.
23126
23127 .next
23128 If the domain part of the pattern is a partial lookup, the wild and fixed parts
23129 of the domain are placed in the next available numerical variables. Suppose,
23130 for example, that the address &'foo@bar.baz.example'& is processed by a
23131 rewriting rule of the form
23132 .display
23133 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
23134 .endd
23135 and the key in the file that matches the domain is &`*.baz.example`&. Then
23136 .code
23137 $1 = foo
23138 $2 = bar
23139 $3 = baz.example
23140 .endd
23141 If the address &'foo@baz.example'& is looked up, this matches the same
23142 wildcard file entry, and in this case &$2$& is set to the empty string, but
23143 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
23144 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
23145 whole domain. For non-partial domain lookups, no numerical variables are set.
23146 .endlist
23147
23148
23149 .section "Rewriting replacements" "SECID152"
23150 .cindex "rewriting" "replacements"
23151 If the replacement string for a rule is a single asterisk, addresses that
23152 match the pattern and the flags are &'not'& rewritten, and no subsequent
23153 rewriting rules are scanned. For example,
23154 .code
23155 hatta@lookingglass.fict.example  *  f
23156 .endd
23157 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
23158 &'From:'& headers.
23159
23160 .vindex "&$domain$&"
23161 .vindex "&$local_part$&"
23162 If the replacement string is not a single asterisk, it is expanded, and must
23163 yield a fully qualified address. Within the expansion, the variables
23164 &$local_part$& and &$domain$& refer to the address that is being rewritten.
23165 Any letters they contain retain their original case &-- they are not lower
23166 cased. The numerical variables are set up according to the type of pattern that
23167 matched the address, as described above. If the expansion is forced to fail by
23168 the presence of &"fail"& in a conditional or lookup item, rewriting by the
23169 current rule is abandoned, but subsequent rules may take effect. Any other
23170 expansion failure causes the entire rewriting operation to be abandoned, and an
23171 entry written to the panic log.
23172
23173
23174
23175 .section "Rewriting flags" "SECID153"
23176 There are three different kinds of flag that may appear on rewriting rules:
23177
23178 .ilist
23179 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
23180 c, f, h, r, s, t.
23181 .next
23182 A flag that specifies rewriting at SMTP time: S.
23183 .next
23184 Flags that control the rewriting process: Q, q, R, w.
23185 .endlist
23186
23187 For rules that are part of the &%headers_rewrite%& generic transport option,
23188 E, F, T, and S are not permitted.
23189
23190
23191
23192 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
23193          "SECID154"
23194 .cindex "rewriting" "flags"
23195 If none of the following flag letters, nor the &"S"& flag (see section
23196 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
23197 and to both the sender and recipient fields of the envelope, whereas a
23198 transport-time rewriting rule just applies to all headers. Otherwise, the
23199 rewriting rule is skipped unless the relevant addresses are being processed.
23200 .display
23201 &`E`&       rewrite all envelope fields
23202 &`F`&       rewrite the envelope From field
23203 &`T`&       rewrite the envelope To field
23204 &`b`&       rewrite the &'Bcc:'& header
23205 &`c`&       rewrite the &'Cc:'& header
23206 &`f`&       rewrite the &'From:'& header
23207 &`h`&       rewrite all headers
23208 &`r`&       rewrite the &'Reply-To:'& header
23209 &`s`&       rewrite the &'Sender:'& header
23210 &`t`&       rewrite the &'To:'& header
23211 .endd
23212 "All headers" means all of the headers listed above that can be selected
23213 individually, plus their &'Resent-'& versions. It does not include
23214 other headers such as &'Subject:'& etc.
23215
23216 You should be particularly careful about rewriting &'Sender:'& headers, and
23217 restrict this to special known cases in your own domains.
23218
23219
23220 .section "The SMTP-time rewriting flag" "SECTrewriteS"
23221 .cindex "SMTP" "rewriting malformed addresses"
23222 .cindex "RCPT" "rewriting argument of"
23223 .cindex "MAIL" "rewriting argument of"
23224 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
23225 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
23226 before any other processing; even before syntax checking. The pattern is
23227 required to be a regular expression, and it is matched against the whole of the
23228 data for the command, including any surrounding angle brackets.
23229
23230 .vindex "&$domain$&"
23231 .vindex "&$local_part$&"
23232 This form of rewrite rule allows for the handling of addresses that are not
23233 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
23234 input). Because the input is not required to be a syntactically valid address,
23235 the variables &$local_part$& and &$domain$& are not available during the
23236 expansion of the replacement string. The result of rewriting replaces the
23237 original address in the MAIL or RCPT command.
23238
23239
23240 .section "Flags controlling the rewriting process" "SECID155"
23241 There are four flags which control the way the rewriting process works. These
23242 take effect only when a rule is invoked, that is, when the address is of the
23243 correct type (matches the flags) and matches the pattern:
23244
23245 .ilist
23246 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
23247 unqualified local part. It is qualified with &%qualify_recipient%&. In the
23248 absence of &"Q"& the rewritten address must always include a domain.
23249 .next
23250 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
23251 even if no rewriting actually takes place because of a &"fail"& in the
23252 expansion. The &"q"& flag is not effective if the address is of the wrong type
23253 (does not match the flags) or does not match the pattern.
23254 .next
23255 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
23256 address, up to ten times. It can be combined with the &"q"& flag, to stop
23257 rewriting once it fails to match (after at least one successful rewrite).
23258 .next
23259 .cindex "rewriting" "whole addresses"
23260 When an address in a header is rewritten, the rewriting normally applies only
23261 to the working part of the address, with any comments and RFC 2822 &"phrase"&
23262 left unchanged. For example, rewriting might change
23263 .code
23264 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
23265 .endd
23266 into
23267 .code
23268 From: Ford Prefect <prefectf@hitch.fict.example>
23269 .endd
23270 .cindex "RFC 2047"
23271 Sometimes there is a need to replace the whole address item, and this can be
23272 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
23273 causes an address in a header line to be rewritten, the entire address is
23274 replaced, not just the working part. The replacement must be a complete RFC
23275 2822 address, including the angle brackets if necessary. If text outside angle
23276 brackets contains a character whose value is greater than 126 or less than 32
23277 (except for tab), the text is encoded according to RFC 2047. The character set
23278 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
23279
23280 When the &"w"& flag is set on a rule that causes an envelope address to be
23281 rewritten, all but the working part of the replacement address is discarded.
23282 .endlist
23283
23284
23285 .section "Rewriting examples" "SECID156"
23286 Here is an example of the two common rewriting paradigms:
23287 .code
23288 *@*.hitch.fict.example  $1@hitch.fict.example
23289 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
23290                      {$value}fail}@hitch.fict.example bctfrF
23291 .endd
23292 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
23293 the string expansion to fail if the lookup does not succeed. In this context it
23294 has the effect of leaving the original address unchanged, but Exim goes on to
23295 consider subsequent rewriting rules, if any, because the &"q"& flag is not
23296 present in that rule. An alternative to &"fail"& would be to supply &$1$&
23297 explicitly, which would cause the rewritten address to be the same as before,
23298 at the cost of a small bit of processing. Not supplying either of these is an
23299 error, since the rewritten address would then contain no local part.
23300
23301 The first example above replaces the domain with a superior, more general
23302 domain. This may not be desirable for certain local parts. If the rule
23303 .code
23304 root@*.hitch.fict.example  *
23305 .endd
23306 were inserted before the first rule, rewriting would be suppressed for the
23307 local part &'root'& at any domain ending in &'hitch.fict.example'&.
23308
23309 Rewriting can be made conditional on a number of tests, by making use of
23310 &${if$& in the expansion item. For example, to apply a rewriting rule only to
23311 messages that originate outside the local host:
23312 .code
23313 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
23314                          {$1@hitch.fict.example}fail}"
23315 .endd
23316 The replacement string is quoted in this example because it contains white
23317 space.
23318
23319 .cindex "rewriting" "bang paths"
23320 .cindex "bang paths" "rewriting"
23321 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
23322 an address it treats it as an unqualified local part which it qualifies with
23323 the local qualification domain (if the source of the message is local or if the
23324 remote host is permitted to send unqualified addresses). Rewriting can
23325 sometimes be used to handle simple bang paths with a fixed number of
23326 components. For example, the rule
23327 .code
23328 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
23329 .endd
23330 rewrites a two-component bang path &'host.name!user'& as the domain address
23331 &'user@host.name'&. However, there is a security implication in using this as
23332 a global rewriting rule for envelope addresses. It can provide a backdoor
23333 method for using your system as a relay, because the incoming addresses appear
23334 to be local. If the bang path addresses are received via SMTP, it is safer to
23335 use the &"S"& flag to rewrite them as they are received, so that relay checking
23336 can be done on the rewritten addresses.
23337 .ecindex IIDaddrew
23338
23339
23340
23341
23342
23343 . ////////////////////////////////////////////////////////////////////////////
23344 . ////////////////////////////////////////////////////////////////////////////
23345
23346 .chapter "Retry configuration" "CHAPretry"
23347 .scindex IIDretconf1 "retry" "configuration, description of"
23348 .scindex IIDregconf2 "configuration file" "retry section"
23349 The &"retry"& section of the runtime configuration file contains a list of
23350 retry rules that control how often Exim tries to deliver messages that cannot
23351 be delivered at the first attempt. If there are no retry rules (the section is
23352 empty or not present), there are no retries. In this situation, temporary
23353 errors are treated as permanent. The default configuration contains a single,
23354 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
23355 line option can be used to test which retry rule will be used for a given
23356 address, domain and error.
23357
23358 The most common cause of retries is temporary failure to deliver to a remote
23359 host because the host is down, or inaccessible because of a network problem.
23360 Exim's retry processing in this case is applied on a per-host (strictly, per IP
23361 address) basis, not on a per-message basis. Thus, if one message has recently
23362 been delayed, delivery of a new message to the same host is not immediately
23363 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
23364 log selector is set, the message
23365 .cindex "retry" "time not reached"
23366 &"retry time not reached"& is written to the main log whenever a delivery is
23367 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
23368 the handling of errors during remote deliveries.
23369
23370 Retry processing applies to routing as well as to delivering, except as covered
23371 in the next paragraph. The retry rules do not distinguish between these
23372 actions. It is not possible, for example, to specify different behaviour for
23373 failures to route the domain &'snark.fict.example'& and failures to deliver to
23374 the host &'snark.fict.example'&. I didn't think anyone would ever need this
23375 added complication, so did not implement it. However, although they share the
23376 same retry rule, the actual retry times for routing and transporting a given
23377 domain are maintained independently.
23378
23379 When a delivery is not part of a queue run (typically an immediate delivery on
23380 receipt of a message), the routers are always run, and local deliveries are
23381 always attempted, even if retry times are set for them. This makes for better
23382 behaviour if one particular message is causing problems (for example, causing
23383 quota overflow, or provoking an error in a filter file). If such a delivery
23384 suffers a temporary failure, the retry data is updated as normal, and
23385 subsequent delivery attempts from queue runs occur only when the retry time for
23386 the local address is reached.
23387
23388 .section "Changing retry rules" "SECID157"
23389 If you change the retry rules in your configuration, you should consider
23390 whether or not to delete the retry data that is stored in Exim's spool area in
23391 files with names like &_db/retry_&. Deleting any of Exim's hints files is
23392 always safe; that is why they are called &"hints"&.
23393
23394 The hints retry data contains suggested retry times based on the previous
23395 rules. In the case of a long-running problem with a remote host, it might
23396 record the fact that the host has timed out. If your new rules increase the
23397 timeout time for such a host, you should definitely remove the old retry data
23398 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
23399 messages that it should now be retaining.
23400
23401
23402
23403 .section "Format of retry rules" "SECID158"
23404 .cindex "retry" "rules"
23405 Each retry rule occupies one line and consists of three or four parts,
23406 separated by white space: a pattern, an error name, an optional list of sender
23407 addresses, and a list of retry parameters. The pattern and sender lists must be
23408 enclosed in double quotes if they contain white space. The rules are searched
23409 in order until one is found where the pattern, error name, and sender list (if
23410 present) match the failing host or address, the error that occurred, and the
23411 message's sender, respectively.
23412
23413
23414 The pattern is any single item that may appear in an address list (see section
23415 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
23416 which means that it is expanded before being tested against the address that
23417 has been delayed. A negated address list item is permitted. Address
23418 list processing treats a plain domain name as if it were preceded by &"*@"&,
23419 which makes it possible for many retry rules to start with just a domain. For
23420 example,
23421 .code
23422 lookingglass.fict.example        *  F,24h,30m;
23423 .endd
23424 provides a rule for any address in the &'lookingglass.fict.example'& domain,
23425 whereas
23426 .code
23427 alice@lookingglass.fict.example  *  F,24h,30m;
23428 .endd
23429 applies only to temporary failures involving the local part &%alice%&.
23430 In practice, almost all rules start with a domain name pattern without a local
23431 part.
23432
23433 .cindex "regular expressions" "in retry rules"
23434 &*Warning*&: If you use a regular expression in a routing rule pattern, it
23435 must match a complete address, not just a domain, because that is how regular
23436 expressions work in address lists.
23437 .display
23438 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
23439 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
23440 .endd
23441
23442
23443 .section "Choosing which retry rule to use for address errors" "SECID159"
23444 When Exim is looking for a retry rule after a routing attempt has failed (for
23445 example, after a DNS timeout), each line in the retry configuration is tested
23446 against the complete address only if &%retry_use_local_part%& is set for the
23447 router. Otherwise, only the domain is used, except when matching against a
23448 regular expression, when the local part of the address is replaced with &"*"&.
23449 A domain on its own can match a domain pattern, or a pattern that starts with
23450 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
23451 &%check_local_user%& is true, and false for other routers.
23452
23453 Similarly, when Exim is looking for a retry rule after a local delivery has
23454 failed (for example, after a mailbox full error), each line in the retry
23455 configuration is tested against the complete address only if
23456 &%retry_use_local_part%& is set for the transport (it defaults true for all
23457 local transports).
23458
23459 .cindex "4&'xx'& responses" "retry rules for"
23460 However, when Exim is looking for a retry rule after a remote delivery attempt
23461 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
23462 whole address is always used as the key when searching the retry rules. The
23463 rule that is found is used to create a retry time for the combination of the
23464 failing address and the message's sender. It is the combination of sender and
23465 recipient that is delayed in subsequent queue runs until its retry time is
23466 reached. You can delay the recipient without regard to the sender by setting
23467 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
23468 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
23469 commands.
23470
23471
23472
23473 .section "Choosing which retry rule to use for host and message errors" &&&
23474          "SECID160"
23475 For a temporary error that is not related to an individual address (for
23476 example, a connection timeout), each line in the retry configuration is checked
23477 twice. First, the name of the remote host is used as a domain name (preceded by
23478 &"*@"& when matching a regular expression). If this does not match the line,
23479 the domain from the email address is tried in a similar fashion. For example,
23480 suppose the MX records for &'a.b.c.example'& are
23481 .code
23482 a.b.c.example  MX  5  x.y.z.example
23483                MX  6  p.q.r.example
23484                MX  7  m.n.o.example
23485 .endd
23486 and the retry rules are
23487 .code
23488 p.q.r.example    *      F,24h,30m;
23489 a.b.c.example    *      F,4d,45m;
23490 .endd
23491 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
23492 first rule matches neither the host nor the domain, so Exim looks at the second
23493 rule. This does not match the host, but it does match the domain, so it is used
23494 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
23495 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
23496 first retry rule is used, because it matches the host.
23497
23498 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
23499 first rule to determine retry times, but for all the other hosts for the domain
23500 &'a.b.c.example'&, the second rule is used. The second rule is also used if
23501 routing to &'a.b.c.example'& suffers a temporary failure.
23502
23503 &*Note*&: The host name is used when matching the patterns, not its IP address.
23504 However, if a message is routed directly to an IP address without the use of a
23505 host name, for example, if a &(manualroute)& router contains a setting such as:
23506 .code
23507 route_list = *.a.example  192.168.34.23
23508 .endd
23509 then the &"host name"& that is used when searching for a retry rule is the
23510 textual form of the IP address.
23511
23512 .section "Retry rules for specific errors" "SECID161"
23513 .cindex "retry" "specific errors; specifying"
23514 The second field in a retry rule is the name of a particular error, or an
23515 asterisk, which matches any error. The errors that can be tested for are:
23516
23517 .vlist
23518 .vitem &%auth_failed%&
23519 Authentication failed when trying to send to a host in the
23520 &%hosts_require_auth%& list in an &(smtp)& transport.
23521
23522 .vitem &%data_4xx%&
23523 A 4&'xx'& error was received for an outgoing DATA command, either immediately
23524 after the command, or after sending the message's data.
23525
23526 .vitem &%mail_4xx%&
23527 A 4&'xx'& error was received for an outgoing MAIL command.
23528
23529 .vitem &%rcpt_4xx%&
23530 A 4&'xx'& error was received for an outgoing RCPT command.
23531 .endlist
23532
23533 For the three 4&'xx'& errors, either the first or both of the x's can be given
23534 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
23535 recognize 452 errors given to RCPT commands for addresses in a certain domain,
23536 and have retries every ten minutes with a one-hour timeout, you could set up a
23537 retry rule of this form:
23538 .code
23539 the.domain.name  rcpt_452   F,1h,10m
23540 .endd
23541 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
23542 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
23543
23544 .vlist
23545 .vitem &%lost_connection%&
23546 A server unexpectedly closed the SMTP connection. There may, of course,
23547 legitimate reasons for this (host died, network died), but if it repeats a lot
23548 for the same host, it indicates something odd.
23549
23550 .vitem &%refused_MX%&
23551 A connection to a host obtained from an MX record was refused.
23552
23553 .vitem &%refused_A%&
23554 A connection to a host not obtained from an MX record was refused.
23555
23556 .vitem &%refused%&
23557 A connection was refused.
23558
23559 .vitem &%timeout_connect_MX%&
23560 A connection attempt to a host obtained from an MX record timed out.
23561
23562 .vitem &%timeout_connect_A%&
23563 A connection attempt to a host not obtained from an MX record timed out.
23564
23565 .vitem &%timeout_connect%&
23566 A connection attempt timed out.
23567
23568 .vitem &%timeout_MX%&
23569 There was a timeout while connecting or during an SMTP session with a host
23570 obtained from an MX record.
23571
23572 .vitem &%timeout_A%&
23573 There was a timeout while connecting or during an SMTP session with a host not
23574 obtained from an MX record.
23575
23576 .vitem &%timeout%&
23577 There was a timeout while connecting or during an SMTP session.
23578
23579 .vitem &%tls_required%&
23580 The server was required to use TLS (it matched &%hosts_require_tls%& in the
23581 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
23582 to STARTTLS, or there was a problem setting up the TLS connection.
23583
23584 .vitem &%quota%&
23585 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23586 transport.
23587
23588 .vitem &%quota_%&<&'time'&>
23589 .cindex "quota" "error testing in retry rule"
23590 .cindex "retry" "quota error testing"
23591 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23592 transport, and the mailbox has not been accessed for <&'time'&>. For example,
23593 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
23594 for four days.
23595 .endlist
23596
23597 .cindex "mailbox" "time of last read"
23598 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
23599 timeouts when the mailbox is full and is not being read by its owner. Ideally,
23600 it should be based on the last time that the user accessed the mailbox.
23601 However, it is not always possible to determine this. Exim uses the following
23602 heuristic rules:
23603
23604 .ilist
23605 If the mailbox is a single file, the time of last access (the &"atime"&) is
23606 used. As no new messages are being delivered (because the mailbox is over
23607 quota), Exim does not access the file, so this is the time of last user access.
23608 .next
23609 .cindex "maildir format" "time of last read"
23610 For a maildir delivery, the time of last modification of the &_new_&
23611 subdirectory is used. As the mailbox is over quota, no new files are created in
23612 the &_new_& subdirectory, because no new messages are being delivered. Any
23613 change to the &_new_& subdirectory is therefore assumed to be the result of an
23614 MUA moving a new message to the &_cur_& directory when it is first read. The
23615 time that is used is therefore the last time that the user read a new message.
23616 .next
23617 For other kinds of multi-file mailbox, the time of last access cannot be
23618 obtained, so a retry rule that uses this type of error field is never matched.
23619 .endlist
23620
23621 The quota errors apply both to system-enforced quotas and to Exim's own quota
23622 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
23623 when a local delivery is deferred because a partition is full (the ENOSPC
23624 error).
23625
23626
23627
23628 .section "Retry rules for specified senders" "SECID162"
23629 .cindex "retry" "rules; sender-specific"
23630 You can specify retry rules that apply only when the failing message has a
23631 specific sender. In particular, this can be used to define retry rules that
23632 apply only to bounce messages. The third item in a retry rule can be of this
23633 form:
23634 .display
23635 &`senders=`&<&'address list'&>
23636 .endd
23637 The retry timings themselves are then the fourth item. For example:
23638 .code
23639 *   rcpt_4xx   senders=:   F,1h,30m
23640 .endd
23641 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
23642 host. If the address list contains white space, it must be enclosed in quotes.
23643 For example:
23644 .code
23645 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
23646 .endd
23647 &*Warning*&: This facility can be unhelpful if it is used for host errors
23648 (which do not depend on the recipient). The reason is that the sender is used
23649 only to match the retry rule. Once the rule has been found for a host error,
23650 its contents are used to set a retry time for the host, and this will apply to
23651 all messages, not just those with specific senders.
23652
23653 When testing retry rules using &%-brt%&, you can supply a sender using the
23654 &%-f%& command line option, like this:
23655 .code
23656 exim -f "" -brt user@dom.ain
23657 .endd
23658 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
23659 list is never matched.
23660
23661
23662
23663
23664
23665 .section "Retry parameters" "SECID163"
23666 .cindex "retry" "parameters in rules"
23667 The third (or fourth, if a senders list is present) field in a retry rule is a
23668 sequence of retry parameter sets, separated by semicolons. Each set consists of
23669 .display
23670 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
23671 .endd
23672 The letter identifies the algorithm for computing a new retry time; the cutoff
23673 time is the time beyond which this algorithm no longer applies, and the
23674 arguments vary the algorithm's action. The cutoff time is measured from the
23675 time that the first failure for the domain (combined with the local part if
23676 relevant) was detected, not from the time the message was received.
23677
23678 .cindex "retry" "algorithms"
23679 .cindex "retry" "fixed intervals"
23680 .cindex "retry" "increasing intervals"
23681 .cindex "retry" "random intervals"
23682 The available algorithms are:
23683
23684 .ilist
23685 &'F'&: retry at fixed intervals. There is a single time parameter specifying
23686 the interval.
23687 .next
23688 &'G'&: retry at geometrically increasing intervals. The first argument
23689 specifies a starting value for the interval, and the second a multiplier, which
23690 is used to increase the size of the interval at each retry.
23691 .next
23692 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
23693 retry, the previous interval is multiplied by the factor in order to get a
23694 maximum for the next interval. The minimum interval is the first argument of
23695 the parameter, and an actual interval is chosen randomly between them. Such a
23696 rule has been found to be helpful in cluster configurations when all the
23697 members of the cluster restart at once, and may therefore synchronize their
23698 queue processing times.
23699 .endlist
23700
23701 When computing the next retry time, the algorithm definitions are scanned in
23702 order until one whose cutoff time has not yet passed is reached. This is then
23703 used to compute a new retry time that is later than the current time. In the
23704 case of fixed interval retries, this simply means adding the interval to the
23705 current time. For geometrically increasing intervals, retry intervals are
23706 computed from the rule's parameters until one that is greater than the previous
23707 interval is found. The main configuration variable
23708 .cindex "limit" "retry interval"
23709 .cindex "retry" "interval, maximum"
23710 .oindex "&%retry_interval_max%&"
23711 &%retry_interval_max%& limits the maximum interval between retries. It
23712 cannot be set greater than &`24h`&, which is its default value.
23713
23714 A single remote domain may have a number of hosts associated with it, and each
23715 host may have more than one IP address. Retry algorithms are selected on the
23716 basis of the domain name, but are applied to each IP address independently. If,
23717 for example, a host has two IP addresses and one is unusable, Exim will
23718 generate retry times for it and will not try to use it until its next retry
23719 time comes. Thus the good IP address is likely to be tried first most of the
23720 time.
23721
23722 .cindex "hints database" "use for retrying"
23723 Retry times are hints rather than promises. Exim does not make any attempt to
23724 run deliveries exactly at the computed times. Instead, a queue runner process
23725 starts delivery processes for delayed messages periodically, and these attempt
23726 new deliveries only for those addresses that have passed their next retry time.
23727 If a new message arrives for a deferred address, an immediate delivery attempt
23728 occurs only if the address has passed its retry time. In the absence of new
23729 messages, the minimum time between retries is the interval between queue runner
23730 processes. There is not much point in setting retry times of five minutes if
23731 your queue runners happen only once an hour, unless there are a significant
23732 number of incoming messages (which might be the case on a system that is
23733 sending everything to a smart host, for example).
23734
23735 The data in the retry hints database can be inspected by using the
23736 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
23737 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
23738 &'exinext'& utility script can be used to find out what the next retry times
23739 are for the hosts associated with a particular mail domain, and also for local
23740 deliveries that have been deferred.
23741
23742
23743 .section "Retry rule examples" "SECID164"
23744 Here are some example retry rules:
23745 .code
23746 alice@wonderland.fict.example quota_5d  F,7d,3h
23747 wonderland.fict.example       quota_5d
23748 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
23749 lookingglass.fict.example     *         F,24h,30m;
23750 *                 refused_A   F,2h,20m;
23751 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
23752 .endd
23753 The first rule sets up special handling for mail to
23754 &'alice@wonderland.fict.example'& when there is an over-quota error and the
23755 mailbox has not been read for at least 5 days. Retries continue every three
23756 hours for 7 days. The second rule handles over-quota errors for all other local
23757 parts at &'wonderland.fict.example'&; the absence of a local part has the same
23758 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
23759 fail are bounced immediately if the mailbox has not been read for at least 5
23760 days.
23761
23762 The third rule handles all other errors at &'wonderland.fict.example'&; retries
23763 happen every 15 minutes for an hour, then with geometrically increasing
23764 intervals until two days have passed since a delivery first failed. After the
23765 first hour there is a delay of one hour, then two hours, then four hours, and
23766 so on (this is a rather extreme example).
23767
23768 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
23769 They happen every 30 minutes for 24 hours only. The remaining two rules handle
23770 all other domains, with special action for connection refusal from hosts that
23771 were not obtained from an MX record.
23772
23773 The final rule in a retry configuration should always have asterisks in the
23774 first two fields so as to provide a general catch-all for any addresses that do
23775 not have their own special handling. This example tries every 15 minutes for 2
23776 hours, then with intervals starting at one hour and increasing by a factor of
23777 1.5 up to 16 hours, then every 8 hours up to 5 days.
23778
23779
23780
23781 .section "Timeout of retry data" "SECID165"
23782 .cindex "timeout" "of retry data"
23783 .oindex "&%retry_data_expire%&"
23784 .cindex "hints database" "data expiry"
23785 .cindex "retry" "timeout of data"
23786 Exim timestamps the data that it writes to its retry hints database. When it
23787 consults the data during a delivery it ignores any that is older than the value
23788 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
23789 been tried for 7 days, Exim will try to deliver to it immediately a message
23790 arrives, and if that fails, it will calculate a retry time as if it were
23791 failing for the first time.
23792
23793 This improves the behaviour for messages routed to rarely-used hosts such as MX
23794 backups. If such a host was down at one time, and happens to be down again when
23795 Exim tries a month later, using the old retry data would imply that it had been
23796 down all the time, which is not a justified assumption.
23797
23798 If a host really is permanently dead, this behaviour causes a burst of retries
23799 every now and again, but only if messages routed to it are rare. If there is a
23800 message at least once every 7 days the retry data never expires.
23801
23802
23803
23804
23805 .section "Long-term failures" "SECID166"
23806 .cindex "delivery failure, long-term"
23807 .cindex "retry" "after long-term failure"
23808 Special processing happens when an email address has been failing for so long
23809 that the cutoff time for the last algorithm is reached. For example, using the
23810 default retry rule:
23811 .code
23812 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
23813 .endd
23814 the cutoff time is four days. Reaching the retry cutoff is independent of how
23815 long any specific message has been failing; it is the length of continuous
23816 failure for the recipient address that counts.
23817
23818 When the cutoff time is reached for a local delivery, or for all the IP
23819 addresses associated with a remote delivery, a subsequent delivery failure
23820 causes Exim to give up on the address, and a bounce message is generated.
23821 In order to cater for new messages that use the failing address, a next retry
23822 time is still computed from the final algorithm, and is used as follows:
23823
23824 For local deliveries, one delivery attempt is always made for any subsequent
23825 messages. If this delivery fails, the address fails immediately. The
23826 post-cutoff retry time is not used.
23827
23828 If the delivery is remote, there are two possibilities, controlled by the
23829 .oindex "&%delay_after_cutoff%&"
23830 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
23831 default. Until the post-cutoff retry time for one of the IP addresses is
23832 reached, the failing email address is bounced immediately, without a delivery
23833 attempt taking place. After that time, one new delivery attempt is made to
23834 those IP addresses that are past their retry times, and if that still fails,
23835 the address is bounced and new retry times are computed.
23836
23837 In other words, when all the hosts for a given email address have been failing
23838 for a long time, Exim bounces rather then defers until one of the hosts' retry
23839 times is reached. Then it tries once, and bounces if that attempt fails. This
23840 behaviour ensures that few resources are wasted in repeatedly trying to deliver
23841 to a broken destination, but if the host does recover, Exim will eventually
23842 notice.
23843
23844 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23845 addresses are past their final cutoff time, Exim tries to deliver to those IP
23846 addresses that have not been tried since the message arrived. If there are
23847 no suitable IP addresses, or if they all fail, the address is bounced. In other
23848 words, it does not delay when a new message arrives, but tries the expired
23849 addresses immediately, unless they have been tried since the message arrived.
23850 If there is a continuous stream of messages for the failing domains, setting
23851 &%delay_after_cutoff%& false means that there will be many more attempts to
23852 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
23853 true.
23854
23855 .section "Deliveries that work intermittently" "SECID167"
23856 .cindex "retry" "intermittently working deliveries"
23857 Some additional logic is needed to cope with cases where a host is
23858 intermittently available, or when a message has some attribute that prevents
23859 its delivery when others to the same address get through. In this situation,
23860 because some messages are successfully delivered, the &"retry clock"& for the
23861 host or address keeps getting reset by the successful deliveries, and so
23862 failing messages remain on the queue for ever because the cutoff time is never
23863 reached.
23864
23865 Two exceptional actions are applied to prevent this happening. The first
23866 applies to errors that are related to a message rather than a remote host.
23867 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
23868 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
23869 commands, and quota failures. For this type of error, if a message's arrival
23870 time is earlier than the &"first failed"& time for the error, the earlier time
23871 is used when scanning the retry rules to decide when to try next and when to
23872 time out the address.
23873
23874 The exceptional second action applies in all cases. If a message has been on
23875 the queue for longer than the cutoff time of any applicable retry rule for a
23876 given address, a delivery is attempted for that address, even if it is not yet
23877 time, and if this delivery fails, the address is timed out. A new retry time is
23878 not computed in this case, so that other messages for the same address are
23879 considered immediately.
23880 .ecindex IIDretconf1
23881 .ecindex IIDregconf2
23882
23883
23884
23885
23886
23887
23888 . ////////////////////////////////////////////////////////////////////////////
23889 . ////////////////////////////////////////////////////////////////////////////
23890
23891 .chapter "SMTP authentication" "CHAPSMTPAUTH"
23892 .scindex IIDauthconf1 "SMTP" "authentication configuration"
23893 .scindex IIDauthconf2 "authentication"
23894 The &"authenticators"& section of Exim's run time configuration is concerned
23895 with SMTP authentication. This facility is an extension to the SMTP protocol,
23896 described in RFC 2554, which allows a client SMTP host to authenticate itself
23897 to a server. This is a common way for a server to recognize clients that are
23898 permitted to use it as a relay. SMTP authentication is not of relevance to the
23899 transfer of mail between servers that have no managerial connection with each
23900 other.
23901
23902 .cindex "AUTH" "description of"
23903 Very briefly, the way SMTP authentication works is as follows:
23904
23905 .ilist
23906 The server advertises a number of authentication &'mechanisms'& in response to
23907 the client's EHLO command.
23908 .next
23909 The client issues an AUTH command, naming a specific mechanism. The command
23910 may, optionally, contain some authentication data.
23911 .next
23912 The server may issue one or more &'challenges'&, to which the client must send
23913 appropriate responses. In simple authentication mechanisms, the challenges are
23914 just prompts for user names and passwords. The server does not have to issue
23915 any challenges &-- in some mechanisms the relevant data may all be transmitted
23916 with the AUTH command.
23917 .next
23918 The server either accepts or denies authentication.
23919 .next
23920 If authentication succeeds, the client may optionally make use of the AUTH
23921 option on the MAIL command to pass an authenticated sender in subsequent
23922 mail transactions. Authentication lasts for the remainder of the SMTP
23923 connection.
23924 .next
23925 If authentication fails, the client may give up, or it may try a different
23926 authentication mechanism, or it may try transferring mail over the
23927 unauthenticated connection.
23928 .endlist
23929
23930 If you are setting up a client, and want to know which authentication
23931 mechanisms the server supports, you can use Telnet to connect to port 25 (the
23932 SMTP port) on the server, and issue an EHLO command. The response to this
23933 includes the list of supported mechanisms. For example:
23934 .display
23935 &`$ `&&*&`telnet server.example 25`&*&
23936 &`Trying 192.168.34.25...`&
23937 &`Connected to server.example.`&
23938 &`Escape character is &#x0027;^]&#x0027;.`&
23939 &`220 server.example ESMTP Exim 4.20 ...`&
23940 &*&`ehlo client.example`&*&
23941 &`250-server.example Hello client.example [10.8.4.5]`&
23942 &`250-SIZE 52428800`&
23943 &`250-PIPELINING`&
23944 &`250-AUTH PLAIN`&
23945 &`250 HELP`&
23946 .endd
23947 The second-last line of this example output shows that the server supports
23948 authentication using the PLAIN mechanism. In Exim, the different authentication
23949 mechanisms are configured by specifying &'authenticator'& drivers. Like the
23950 routers and transports, which authenticators are included in the binary is
23951 controlled by build-time definitions. The following are currently available,
23952 included by setting
23953 .code
23954 AUTH_CRAM_MD5=yes
23955 AUTH_CYRUS_SASL=yes
23956 AUTH_DOVECOT=yes
23957 AUTH_GSASL=yes
23958 AUTH_HEIMDAL_GSSAPI=yes
23959 AUTH_PLAINTEXT=yes
23960 AUTH_SPA=yes
23961 .endd
23962 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
23963 authentication mechanism (RFC 2195), and the second provides an interface to
23964 the Cyrus SASL authentication library.
23965 The third is an interface to Dovecot's authentication system, delegating the
23966 work via a socket interface.
23967 The fourth provides an interface to the GNU SASL authentication library, which
23968 provides mechanisms but typically not data sources.
23969 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
23970 supporting setting a server keytab.
23971 The sixth can be configured to support
23972 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
23973 not formally documented, but used by several MUAs. The seventh authenticator
23974 supports Microsoft's &'Secure Password Authentication'& mechanism.
23975
23976 The authenticators are configured using the same syntax as other drivers (see
23977 section &<<SECTfordricon>>&). If no authenticators are required, no
23978 authentication section need be present in the configuration file. Each
23979 authenticator can in principle have both server and client functions. When Exim
23980 is receiving SMTP mail, it is acting as a server; when it is sending out
23981 messages over SMTP, it is acting as a client. Authenticator configuration
23982 options are provided for use in both these circumstances.
23983
23984 To make it clear which options apply to which situation, the prefixes
23985 &%server_%& and &%client_%& are used on option names that are specific to
23986 either the server or the client function, respectively. Server and client
23987 functions are disabled if none of their options are set. If an authenticator is
23988 to be used for both server and client functions, a single definition, using
23989 both sets of options, is required. For example:
23990 .code
23991 cram:
23992   driver = cram_md5
23993   public_name = CRAM-MD5
23994   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
23995   client_name = ph10
23996   client_secret = secret2
23997 .endd
23998 The &%server_%& option is used when Exim is acting as a server, and the
23999 &%client_%& options when it is acting as a client.
24000
24001 Descriptions of the individual authenticators are given in subsequent chapters.
24002 The remainder of this chapter covers the generic options for the
24003 authenticators, followed by general discussion of the way authentication works
24004 in Exim.
24005
24006 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24007 per-mechanism basis.  Please read carefully to determine which variables hold
24008 account labels such as usercodes and which hold passwords or other
24009 authenticating data.
24010
24011 Note that some mechanisms support two different identifiers for accounts: the
24012 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24013 and &'authz'& are commonly encountered.  The American spelling is standard here.
24014 Conceptually, authentication data such as passwords are tied to the identifier
24015 used to authenticate; servers may have rules to permit one user to act as a
24016 second user, so that after login the session is treated as though that second
24017 user had logged in.  That second user is the &'authorization id'&.  A robust
24018 configuration might confirm that the &'authz'& field is empty or matches the
24019 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24020 as verified data, the &'authz'& as an unverified request which the server might
24021 choose to honour.
24022
24023 A &'realm'& is a text string, typically a domain name, presented by a server
24024 to a client to help it select an account and credentials to use.  In some
24025 mechanisms, the client and server provably agree on the realm, but clients
24026 typically can not treat the realm as secure data to be blindly trusted.
24027
24028
24029
24030 .section "Generic options for authenticators" "SECID168"
24031 .cindex "authentication" "generic options"
24032 .cindex "options" "generic; for authenticators"
24033
24034 .option client_condition authenticators string&!! unset
24035 When Exim is authenticating as a client, it skips any authenticator whose
24036 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24037 used, for example, to skip plain text authenticators when the connection is not
24038 encrypted by a setting such as:
24039 .code
24040 client_condition = ${if !eq{$tls_out_cipher}{}}
24041 .endd
24042
24043
24044 .option driver authenticators string unset
24045 This option must always be set. It specifies which of the available
24046 authenticators is to be used.
24047
24048
24049 .option public_name authenticators string unset
24050 This option specifies the name of the authentication mechanism that the driver
24051 implements, and by which it is known to the outside world. These names should
24052 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24053 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24054 defaults to the driver's instance name.
24055
24056
24057 .option server_advertise_condition authenticators string&!! unset
24058 When a server is about to advertise an authentication mechanism, the condition
24059 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24060 mechanism is not advertised.
24061 If the expansion fails, the mechanism is not advertised. If the failure was not
24062 forced, and was not caused by a lookup defer, the incident is logged.
24063 See section &<<SECTauthexiser>>& below for further discussion.
24064
24065
24066 .option server_condition authenticators string&!! unset
24067 This option must be set for a &%plaintext%& server authenticator, where it
24068 is used directly to control authentication. See section &<<SECTplainserver>>&
24069 for details.
24070
24071 For the &(gsasl)& authenticator, this option is required for various
24072 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24073
24074 For the other authenticators, &%server_condition%& can be used as an additional
24075 authentication or authorization mechanism that is applied after the other
24076 authenticator conditions succeed. If it is set, it is expanded when the
24077 authenticator would otherwise return a success code. If the expansion is forced
24078 to fail, authentication fails. Any other expansion failure causes a temporary
24079 error code to be returned. If the result of a successful expansion is an empty
24080 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24081 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24082 other result, a temporary error code is returned, with the expanded string as
24083 the error text.
24084
24085
24086 .option server_debug_print authenticators string&!! unset
24087 If this option is set and authentication debugging is enabled (see the &%-d%&
24088 command line option), the string is expanded and included in the debugging
24089 output when the authenticator is run as a server. This can help with checking
24090 out the values of variables.
24091 If expansion of the string fails, the error message is written to the debugging
24092 output, and Exim carries on processing.
24093
24094
24095 .option server_set_id authenticators string&!! unset
24096 .vindex "&$authenticated_id$&"
24097 When an Exim server successfully authenticates a client, this string is
24098 expanded using data from the authentication, and preserved for any incoming
24099 messages in the variable &$authenticated_id$&. It is also included in the log
24100 lines for incoming messages. For example, a user/password authenticator
24101 configuration might preserve the user name that was used to authenticate, and
24102 refer to it subsequently during delivery of the message.
24103 If expansion fails, the option is ignored.
24104
24105
24106 .option server_mail_auth_condition authenticators string&!! unset
24107 This option allows a server to discard authenticated sender addresses supplied
24108 as part of MAIL commands in SMTP connections that are authenticated by the
24109 driver on which &%server_mail_auth_condition%& is set. The option is not used
24110 as part of the authentication process; instead its (unexpanded) value is
24111 remembered for later use.
24112 How it is used is described in the following section.
24113
24114
24115
24116
24117
24118 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
24119 .cindex "authentication" "sender; authenticated"
24120 .cindex "AUTH" "on MAIL command"
24121 When a client supplied an AUTH= item on a MAIL command, Exim applies
24122 the following checks before accepting it as the authenticated sender of the
24123 message:
24124
24125 .ilist
24126 If the connection is not using extended SMTP (that is, HELO was used rather
24127 than EHLO), the use of AUTH= is a syntax error.
24128 .next
24129 If the value of the AUTH= parameter is &"<>"&, it is ignored.
24130 .next
24131 .vindex "&$authenticated_sender$&"
24132 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
24133 running, the value of &$authenticated_sender$& is set to the value obtained
24134 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
24135 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
24136 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
24137 given for the MAIL command.
24138 .next
24139 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
24140 is accepted and placed in &$authenticated_sender$& only if the client has
24141 authenticated.
24142 .next
24143 If the AUTH= value was accepted by either of the two previous rules, and
24144 the client has authenticated, and the authenticator has a setting for the
24145 &%server_mail_auth_condition%&, the condition is checked at this point. The
24146 valued that was saved from the authenticator is expanded. If the expansion
24147 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
24148 &$authenticated_sender$& is deleted. If the expansion yields any other value,
24149 the value of &$authenticated_sender$& is retained and passed on with the
24150 message.
24151 .endlist
24152
24153
24154 When &$authenticated_sender$& is set for a message, it is passed on to other
24155 hosts to which Exim authenticates as a client. Do not confuse this value with
24156 &$authenticated_id$&, which is a string obtained from the authentication
24157 process, and which is not usually a complete email address.
24158
24159 .vindex "&$sender_address$&"
24160 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
24161 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
24162 therefore make use of &$authenticated_sender$&. The converse is not true: the
24163 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
24164 ACL is run.
24165
24166
24167
24168 .section "Authentication on an Exim server" "SECTauthexiser"
24169 .cindex "authentication" "on an Exim server"
24170 When Exim receives an EHLO command, it advertises the public names of those
24171 authenticators that are configured as servers, subject to the following
24172 conditions:
24173
24174 .ilist
24175 The client host must match &%auth_advertise_hosts%& (default *).
24176 .next
24177 It the &%server_advertise_condition%& option is set, its expansion must not
24178 yield the empty string, &"0"&, &"no"&, or &"false"&.
24179 .endlist
24180
24181 The order in which the authenticators are defined controls the order in which
24182 the mechanisms are advertised.
24183
24184 Some mail clients (for example, some versions of Netscape) require the user to
24185 provide a name and password for authentication whenever AUTH is advertised,
24186 even though authentication may not in fact be needed (for example, Exim may be
24187 set up to allow unconditional relaying from the client by an IP address check).
24188 You can make such clients more friendly by not advertising AUTH to them.
24189 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
24190 that runs for RCPT) to relay without authentication, you should set
24191 .code
24192 auth_advertise_hosts = ! 10.9.8.0/24
24193 .endd
24194 so that no authentication mechanisms are advertised to them.
24195
24196 The &%server_advertise_condition%& controls the advertisement of individual
24197 authentication mechanisms. For example, it can be used to restrict the
24198 advertisement of a particular mechanism to encrypted connections, by a setting
24199 such as:
24200 .code
24201 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
24202 .endd
24203 .vindex "&$tls_in_cipher$&"
24204 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
24205 yields &"yes"&, which allows the advertisement to happen.
24206
24207 When an Exim server receives an AUTH command from a client, it rejects it
24208 immediately if AUTH was not advertised in response to an earlier EHLO
24209 command. This is the case if
24210
24211 .ilist
24212 The client host does not match &%auth_advertise_hosts%&; or
24213 .next
24214 No authenticators are configured with server options; or
24215 .next
24216 Expansion of &%server_advertise_condition%& blocked the advertising of all the
24217 server authenticators.
24218 .endlist
24219
24220
24221 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
24222 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
24223 AUTH is accepted from any client host.
24224
24225 If AUTH is not rejected by the ACL, Exim searches its configuration for a
24226 server authentication mechanism that was advertised in response to EHLO and
24227 that matches the one named in the AUTH command. If it finds one, it runs
24228 the appropriate authentication protocol, and authentication either succeeds or
24229 fails. If there is no matching advertised mechanism, the AUTH command is
24230 rejected with a 504 error.
24231
24232 .vindex "&$received_protocol$&"
24233 .vindex "&$sender_host_authenticated$&"
24234 When a message is received from an authenticated host, the value of
24235 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
24236 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
24237 public name) of the authenticator driver that successfully authenticated the
24238 client from which the message was received. This variable is empty if there was
24239 no successful authentication.
24240
24241
24242
24243
24244 .section "Testing server authentication" "SECID169"
24245 .cindex "authentication" "testing a server"
24246 .cindex "AUTH" "testing a server"
24247 .cindex "base64 encoding" "creating authentication test data"
24248 Exim's &%-bh%& option can be useful for testing server authentication
24249 configurations. The data for the AUTH command has to be sent using base64
24250 encoding. A quick way to produce such data for testing is the following Perl
24251 script:
24252 .code
24253 use MIME::Base64;
24254 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
24255 .endd
24256 .cindex "binary zero" "in authentication data"
24257 This interprets its argument as a Perl string, and then encodes it. The
24258 interpretation as a Perl string allows binary zeros, which are required for
24259 some kinds of authentication, to be included in the data. For example, a
24260 command line to run this script on such data might be
24261 .code
24262 encode '\0user\0password'
24263 .endd
24264 Note the use of single quotes to prevent the shell interpreting the
24265 backslashes, so that they can be interpreted by Perl to specify characters
24266 whose code value is zero.
24267
24268 &*Warning 1*&: If either of the user or password strings starts with an octal
24269 digit, you must use three zeros instead of one after the leading backslash. If
24270 you do not, the octal digit that starts your string will be incorrectly
24271 interpreted as part of the code for the first character.
24272
24273 &*Warning 2*&: If there are characters in the strings that Perl interprets
24274 specially, you must use a Perl escape to prevent them being misinterpreted. For
24275 example, a command such as
24276 .code
24277 encode '\0user@domain.com\0pas$$word'
24278 .endd
24279 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
24280
24281 If you have the &%mimencode%& command installed, another way to do produce
24282 base64-encoded strings is to run the command
24283 .code
24284 echo -e -n `\0user\0password' | mimencode
24285 .endd
24286 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
24287 in the argument, and the &%-n%& option specifies no newline at the end of its
24288 output. However, not all versions of &%echo%& recognize these options, so you
24289 should check your version before relying on this suggestion.
24290
24291
24292
24293 .section "Authentication by an Exim client" "SECID170"
24294 .cindex "authentication" "on an Exim client"
24295 The &(smtp)& transport has two options called &%hosts_require_auth%& and
24296 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
24297 announces support for authentication, and the host matches an entry in either
24298 of these options, Exim (as a client) tries to authenticate as follows:
24299
24300 .ilist
24301 For each authenticator that is configured as a client, in the order in which
24302 they are defined in the configuration, it searches the authentication
24303 mechanisms announced by the server for one whose name matches the public name
24304 of the authenticator.
24305 .next
24306 .vindex "&$host$&"
24307 .vindex "&$host_address$&"
24308 When it finds one that matches, it runs the authenticator's client code. The
24309 variables &$host$& and &$host_address$& are available for any string expansions
24310 that the client might do. They are set to the server's name and IP address. If
24311 any expansion is forced to fail, the authentication attempt is abandoned, and
24312 Exim moves on to the next authenticator. Otherwise an expansion failure causes
24313 delivery to be deferred.
24314 .next
24315 If the result of the authentication attempt is a temporary error or a timeout,
24316 Exim abandons trying to send the message to the host for the moment. It will
24317 try again later. If there are any backup hosts available, they are tried in the
24318 usual way.
24319 .next
24320 If the response to authentication is a permanent error (5&'xx'& code), Exim
24321 carries on searching the list of authenticators and tries another one if
24322 possible. If all authentication attempts give permanent errors, or if there are
24323 no attempts because no mechanisms match (or option expansions force failure),
24324 what happens depends on whether the host matches &%hosts_require_auth%& or
24325 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
24326 delivery is deferred. The error can be detected in the retry rules, and thereby
24327 turned into a permanent error if you wish. In the second case, Exim tries to
24328 deliver the message unauthenticated.
24329 .endlist
24330
24331 .cindex "AUTH" "on MAIL command"
24332 When Exim has authenticated itself to a remote server, it adds the AUTH
24333 parameter to the MAIL commands it sends, if it has an authenticated sender for
24334 the message. If the message came from a remote host, the authenticated sender
24335 is the one that was receiving on an incoming MAIL command, provided that the
24336 incoming connection was authenticated and the &%server_mail_auth%& condition
24337 allowed the authenticated sender to be retained. If a local process calls Exim
24338 to send a message, the sender address that is built from the login name and
24339 &%qualify_domain%& is treated as authenticated. However, if the
24340 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
24341 the authenticated sender that was received with the message.
24342 .ecindex IIDauthconf1
24343 .ecindex IIDauthconf2
24344
24345
24346
24347
24348
24349
24350 . ////////////////////////////////////////////////////////////////////////////
24351 . ////////////////////////////////////////////////////////////////////////////
24352
24353 .chapter "The plaintext authenticator" "CHAPplaintext"
24354 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
24355 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
24356 The &(plaintext)& authenticator can be configured to support the PLAIN and
24357 LOGIN authentication mechanisms, both of which transfer authentication data as
24358 plain (unencrypted) text (though base64 encoded). The use of plain text is a
24359 security risk; you are strongly advised to insist on the use of SMTP encryption
24360 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
24361 use unencrypted plain text, you should not use the same passwords for SMTP
24362 connections as you do for login accounts.
24363
24364 .section "Plaintext options" "SECID171"
24365 .cindex "options" "&(plaintext)& authenticator (server)"
24366 When configured as a server, &(plaintext)& uses the following options:
24367
24368 .option server_condition authenticators string&!! unset
24369 This is actually a global authentication option, but it must be set in order to
24370 configure the &(plaintext)& driver as a server. Its use is described below.
24371
24372 .option server_prompts plaintext string&!! unset
24373 The contents of this option, after expansion, must be a colon-separated list of
24374 prompt strings. If expansion fails, a temporary authentication rejection is
24375 given.
24376
24377 .section "Using plaintext in a server" "SECTplainserver"
24378 .cindex "AUTH" "in &(plaintext)& authenticator"
24379 .cindex "binary zero" "in &(plaintext)& authenticator"
24380 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
24381         "in &(plaintext)& authenticator"
24382 .vindex "&$auth1$&, &$auth2$&, etc"
24383 .cindex "base64 encoding" "in &(plaintext)& authenticator"
24384
24385 When running as a server, &(plaintext)& performs the authentication test by
24386 expanding a string. The data sent by the client with the AUTH command, or in
24387 response to subsequent prompts, is base64 encoded, and so may contain any byte
24388 values when decoded. If any data is supplied with the command, it is treated as
24389 a list of strings, separated by NULs (binary zeros), the first three of which
24390 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
24391 (neither LOGIN nor PLAIN uses more than three strings).
24392
24393 For compatibility with previous releases of Exim, the values are also placed in
24394 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
24395 variables for this purpose is now deprecated, as it can lead to confusion in
24396 string expansions that also use them for other things.
24397
24398 If there are more strings in &%server_prompts%& than the number of strings
24399 supplied with the AUTH command, the remaining prompts are used to obtain more
24400 data. Each response from the client may be a list of NUL-separated strings.
24401
24402 .vindex "&$authenticated_id$&"
24403 Once a sufficient number of data strings have been received,
24404 &%server_condition%& is expanded. If the expansion is forced to fail,
24405 authentication fails. Any other expansion failure causes a temporary error code
24406 to be returned. If the result of a successful expansion is an empty string,
24407 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24408 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
24409 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
24410 For any other result, a temporary error code is returned, with the expanded
24411 string as the error text.
24412
24413 &*Warning*&: If you use a lookup in the expansion to find the user's
24414 password, be sure to make the authentication fail if the user is unknown.
24415 There are good and bad examples at the end of the next section.
24416
24417
24418
24419 .section "The PLAIN authentication mechanism" "SECID172"
24420 .cindex "PLAIN authentication mechanism"
24421 .cindex "authentication" "PLAIN mechanism"
24422 .cindex "binary zero" "in &(plaintext)& authenticator"
24423 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
24424 sent as one item of data (that is, one combined string containing two NUL
24425 separators). The data is sent either as part of the AUTH command, or
24426 subsequently in response to an empty prompt from the server.
24427
24428 The second and third strings are a user name and a corresponding password.
24429 Using a single fixed user name and password as an example, this could be
24430 configured as follows:
24431 .code
24432 fixed_plain:
24433   driver = plaintext
24434   public_name = PLAIN
24435   server_prompts = :
24436   server_condition = \
24437     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
24438   server_set_id = $auth2
24439 .endd
24440 Note that the default result strings from &%if%& (&"true"& or an empty string)
24441 are exactly what we want here, so they need not be specified. Obviously, if the
24442 password contains expansion-significant characters such as dollar, backslash,
24443 or closing brace, they have to be escaped.
24444
24445 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
24446 the end of a string list are ignored). If all the data comes as part of the
24447 AUTH command, as is commonly the case, the prompt is not used. This
24448 authenticator is advertised in the response to EHLO as
24449 .code
24450 250-AUTH PLAIN
24451 .endd
24452 and a client host can authenticate itself by sending the command
24453 .code
24454 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
24455 .endd
24456 As this contains three strings (more than the number of prompts), no further
24457 data is required from the client. Alternatively, the client may just send
24458 .code
24459 AUTH PLAIN
24460 .endd
24461 to initiate authentication, in which case the server replies with an empty
24462 prompt. The client must respond with the combined data string.
24463
24464 The data string is base64 encoded, as required by the RFC. This example,
24465 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
24466 represents a zero byte. This is split up into three strings, the first of which
24467 is empty. The &%server_condition%& option in the authenticator checks that the
24468 second two are &`username`& and &`mysecret`& respectively.
24469
24470 Having just one fixed user name and password, as in this example, is not very
24471 realistic, though for a small organization with only a handful of
24472 authenticating clients it could make sense.
24473
24474 A more sophisticated instance of this authenticator could use the user name in
24475 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
24476 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
24477 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
24478 This is an incorrect example:
24479 .code
24480 server_condition = \
24481   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
24482 .endd
24483 The expansion uses the user name (&$auth2$&) as the key to look up a password,
24484 which it then compares to the supplied password (&$auth3$&). Why is this example
24485 incorrect? It works fine for existing users, but consider what happens if a
24486 non-existent user name is given. The lookup fails, but as no success/failure
24487 strings are given for the lookup, it yields an empty string. Thus, to defeat
24488 the authentication, all a client has to do is to supply a non-existent user
24489 name and an empty password. The correct way of writing this test is:
24490 .code
24491 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
24492   {${if eq{$value}{$auth3}}} {false}}
24493 .endd
24494 In this case, if the lookup succeeds, the result is checked; if the lookup
24495 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
24496 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
24497 always fails if its second argument is empty. However, the second way of
24498 writing the test makes the logic clearer.
24499
24500
24501 .section "The LOGIN authentication mechanism" "SECID173"
24502 .cindex "LOGIN authentication mechanism"
24503 .cindex "authentication" "LOGIN mechanism"
24504 The LOGIN authentication mechanism is not documented in any RFC, but is in use
24505 in a number of programs. No data is sent with the AUTH command. Instead, a
24506 user name and password are supplied separately, in response to prompts. The
24507 plaintext authenticator can be configured to support this as in this example:
24508 .code
24509 fixed_login:
24510   driver = plaintext
24511   public_name = LOGIN
24512   server_prompts = User Name : Password
24513   server_condition = \
24514     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
24515   server_set_id = $auth1
24516 .endd
24517 Because of the way plaintext operates, this authenticator accepts data supplied
24518 with the AUTH command (in contravention of the specification of LOGIN), but
24519 if the client does not supply it (as is the case for LOGIN clients), the prompt
24520 strings are used to obtain two data items.
24521
24522 Some clients are very particular about the precise text of the prompts. For
24523 example, Outlook Express is reported to recognize only &"Username:"& and
24524 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
24525 strings. It uses the &%ldapauth%& expansion condition to check the user
24526 name and password by binding to an LDAP server:
24527 .code
24528 login:
24529   driver = plaintext
24530   public_name = LOGIN
24531   server_prompts = Username:: : Password::
24532   server_condition = ${if and{{ \
24533     !eq{}{$auth1} }{ \
24534     ldapauth{\
24535       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
24536       pass=${quote:$auth2} \
24537       ldap://ldap.example.org/} }} }
24538   server_set_id = uid=$auth1,ou=people,o=example.org
24539 .endd
24540 We have to check that the username is not empty before using it, because LDAP
24541 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
24542 operator to correctly quote the DN for authentication. However, the basic
24543 &%quote%& operator, rather than any of the LDAP quoting operators, is the
24544 correct one to use for the password, because quoting is needed only to make
24545 the password conform to the Exim syntax. At the LDAP level, the password is an
24546 uninterpreted string.
24547
24548
24549 .section "Support for different kinds of authentication" "SECID174"
24550 A number of string expansion features are provided for the purpose of
24551 interfacing to different ways of user authentication. These include checking
24552 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
24553 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
24554 &<<SECTexpcond>>&.
24555
24556
24557
24558
24559 .section "Using plaintext in a client" "SECID175"
24560 .cindex "options" "&(plaintext)& authenticator (client)"
24561 The &(plaintext)& authenticator has two client options:
24562
24563 .option client_ignore_invalid_base64 plaintext boolean false
24564 If the client receives a server prompt that is not a valid base64 string,
24565 authentication is abandoned by default. However, if this option is set true,
24566 the error in the challenge is ignored and the client sends the response as
24567 usual.
24568
24569 .option client_send plaintext string&!! unset
24570 The string is a colon-separated list of authentication data strings. Each
24571 string is independently expanded before being sent to the server. The first
24572 string is sent with the AUTH command; any more strings are sent in response
24573 to prompts from the server. Before each string is expanded, the value of the
24574 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
24575 with &$auth1$& for the first prompt. Up to three prompts are stored in this
24576 way. Thus, the prompt that is received in response to sending the first string
24577 (with the AUTH command) can be used in the expansion of the second string, and
24578 so on. If an invalid base64 string is received when
24579 &%client_ignore_invalid_base64%& is set, an empty string is put in the
24580 &$auth$&<&'n'&> variable.
24581
24582 &*Note*&: You cannot use expansion to create multiple strings, because
24583 splitting takes priority and happens first.
24584
24585 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
24586 the data, further processing is applied to each string before it is sent. If
24587 there are any single circumflex characters in the string, they are converted to
24588 NULs. Should an actual circumflex be required as data, it must be doubled in
24589 the string.
24590
24591 This is an example of a client configuration that implements the PLAIN
24592 authentication mechanism with a fixed user name and password:
24593 .code
24594 fixed_plain:
24595   driver = plaintext
24596   public_name = PLAIN
24597   client_send = ^username^mysecret
24598 .endd
24599 The lack of colons means that the entire text is sent with the AUTH
24600 command, with the circumflex characters converted to NULs. A similar example
24601 that uses the LOGIN mechanism is:
24602 .code
24603 fixed_login:
24604   driver = plaintext
24605   public_name = LOGIN
24606   client_send = : username : mysecret
24607 .endd
24608 The initial colon means that the first string is empty, so no data is sent with
24609 the AUTH command itself. The remaining strings are sent in response to
24610 prompts.
24611 .ecindex IIDplaiauth1
24612 .ecindex IIDplaiauth2
24613
24614
24615
24616
24617 . ////////////////////////////////////////////////////////////////////////////
24618 . ////////////////////////////////////////////////////////////////////////////
24619
24620 .chapter "The cram_md5 authenticator" "CHID9"
24621 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
24622 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
24623 .cindex "CRAM-MD5 authentication mechanism"
24624 .cindex "authentication" "CRAM-MD5 mechanism"
24625 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
24626 sends a challenge string to the client, and the response consists of a user
24627 name and the CRAM-MD5 digest of the challenge string combined with a secret
24628 string (password) which is known to both server and client. Thus, the secret
24629 is not sent over the network as plain text, which makes this authenticator more
24630 secure than &(plaintext)&. However, the downside is that the secret has to be
24631 available in plain text at either end.
24632
24633
24634 .section "Using cram_md5 as a server" "SECID176"
24635 .cindex "options" "&(cram_md5)& authenticator (server)"
24636 This authenticator has one server option, which must be set to configure the
24637 authenticator as a server:
24638
24639 .option server_secret cram_md5 string&!! unset
24640 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
24641 When the server receives the client's response, the user name is placed in
24642 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
24643 obtain the password for that user. The server then computes the CRAM-MD5 digest
24644 that the client should have sent, and checks that it received the correct
24645 string. If the expansion of &%server_secret%& is forced to fail, authentication
24646 fails. If the expansion fails for some other reason, a temporary error code is
24647 returned to the client.
24648
24649 For compatibility with previous releases of Exim, the user name is also placed
24650 in &$1$&. However, the use of this variables for this purpose is now
24651 deprecated, as it can lead to confusion in string expansions that also use
24652 numeric variables for other things.
24653
24654 For example, the following authenticator checks that the user name given by the
24655 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
24656 user name, authentication fails.
24657 .code
24658 fixed_cram:
24659   driver = cram_md5
24660   public_name = CRAM-MD5
24661   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
24662   server_set_id = $auth1
24663 .endd
24664 .vindex "&$authenticated_id$&"
24665 If authentication succeeds, the setting of &%server_set_id%& preserves the user
24666 name in &$authenticated_id$&. A more typical configuration might look up the
24667 secret string in a file, using the user name as the key. For example:
24668 .code
24669 lookup_cram:
24670   driver = cram_md5
24671   public_name = CRAM-MD5
24672   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
24673                   {$value}fail}
24674   server_set_id = $auth1
24675 .endd
24676 Note that this expansion explicitly forces failure if the lookup fails
24677 because &$auth1$& contains an unknown user name.
24678
24679 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
24680 using the relevant libraries, you need to know the realm to specify in the
24681 lookup and then ask for the &"userPassword"& attribute for that user in that
24682 realm, with:
24683 .code
24684 cyrusless_crammd5:
24685   driver = cram_md5
24686   public_name = CRAM-MD5
24687   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
24688                   dbmjz{/etc/sasldb2}}
24689   server_set_id = $auth1
24690 .endd
24691
24692 .section "Using cram_md5 as a client" "SECID177"
24693 .cindex "options" "&(cram_md5)& authenticator (client)"
24694 When used as a client, the &(cram_md5)& authenticator has two options:
24695
24696
24697
24698 .option client_name cram_md5 string&!! "the primary host name"
24699 This string is expanded, and the result used as the user name data when
24700 computing the response to the server's challenge.
24701
24702
24703 .option client_secret cram_md5 string&!! unset
24704 This option must be set for the authenticator to work as a client. Its value is
24705 expanded and the result used as the secret string when computing the response.
24706
24707
24708 .vindex "&$host$&"
24709 .vindex "&$host_address$&"
24710 Different user names and secrets can be used for different servers by referring
24711 to &$host$& or &$host_address$& in the options. Forced failure of either
24712 expansion string is treated as an indication that this authenticator is not
24713 prepared to handle this case. Exim moves on to the next configured client
24714 authenticator. Any other expansion failure causes Exim to give up trying to
24715 send the message to the current server.
24716
24717 A simple example configuration of a &(cram_md5)& authenticator, using fixed
24718 strings, is:
24719 .code
24720 fixed_cram:
24721   driver = cram_md5
24722   public_name = CRAM-MD5
24723   client_name = ph10
24724   client_secret = secret
24725 .endd
24726 .ecindex IIDcramauth1
24727 .ecindex IIDcramauth2
24728
24729
24730
24731 . ////////////////////////////////////////////////////////////////////////////
24732 . ////////////////////////////////////////////////////////////////////////////
24733
24734 .chapter "The cyrus_sasl authenticator" "CHID10"
24735 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
24736 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
24737 .cindex "Cyrus" "SASL library"
24738 .cindex "Kerberos"
24739 The code for this authenticator was provided by Matthew Byng-Maddick of A L
24740 Digital Ltd (&url(http://www.aldigital.co.uk)).
24741
24742 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
24743 library implementation of the RFC 2222 (&"Simple Authentication and Security
24744 Layer"&). This library supports a number of authentication mechanisms,
24745 including PLAIN and LOGIN, but also several others that Exim does not support
24746 directly. In particular, there is support for Kerberos authentication.
24747
24748 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
24749 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
24750 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
24751 name of the driver to determine which mechanism to support.
24752
24753 Where access to some kind of secret file is required, for example in GSSAPI
24754 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
24755 user, and that the Cyrus SASL library has no way of escalating privileges
24756 by default. You may also find you need to set environment variables,
24757 depending on the driver you are using.
24758
24759 The application name provided by Exim is &"exim"&, so various SASL options may
24760 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
24761 Kerberos, note that because of limitations in the GSSAPI interface,
24762 changing the server keytab might need to be communicated down to the Kerberos
24763 layer independently. The mechanism for doing so is dependent upon the Kerberos
24764 implementation.
24765
24766 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
24767 may be set to point to an alternative keytab file. Exim will pass this
24768 variable through from its own inherited environment when started as root or the
24769 Exim user. The keytab file needs to be readable by the Exim user.
24770 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
24771 environment variable.  In practice, for those releases, the Cyrus authenticator
24772 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
24773 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
24774
24775
24776 .section "Using cyrus_sasl as a server" "SECID178"
24777 The &(cyrus_sasl)& authenticator has four private options. It puts the username
24778 (on a successful authentication) into &$auth1$&. For compatibility with
24779 previous releases of Exim, the username is also placed in &$1$&. However, the
24780 use of this variable for this purpose is now deprecated, as it can lead to
24781 confusion in string expansions that also use numeric variables for other
24782 things.
24783
24784
24785 .option server_hostname cyrus_sasl string&!! "see below"
24786 This option selects the hostname that is used when communicating with the
24787 library. The default value is &`$primary_hostname`&. It is up to the underlying
24788 SASL plug-in what it does with this data.
24789
24790
24791 .option server_mech cyrus_sasl string "see below"
24792 This option selects the authentication mechanism this driver should use. The
24793 default is the value of the generic &%public_name%& option. This option allows
24794 you to use a different underlying mechanism from the advertised name. For
24795 example:
24796 .code
24797 sasl:
24798   driver = cyrus_sasl
24799   public_name = X-ANYTHING
24800   server_mech = CRAM-MD5
24801   server_set_id = $auth1
24802 .endd
24803
24804 .option server_realm cyrus_sasl string&!! unset
24805 This specifies the SASL realm that the server claims to be in.
24806
24807
24808 .option server_service cyrus_sasl string &`smtp`&
24809 This is the SASL service that the server claims to implement.
24810
24811
24812 For straightforward cases, you do not need to set any of the authenticator's
24813 private options. All you need to do is to specify an appropriate mechanism as
24814 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
24815 PLAIN, you could have two authenticators as follows:
24816 .code
24817 sasl_cram_md5:
24818   driver = cyrus_sasl
24819   public_name = CRAM-MD5
24820   server_set_id = $auth1
24821
24822 sasl_plain:
24823   driver = cyrus_sasl
24824   public_name = PLAIN
24825   server_set_id = $auth2
24826 .endd
24827 Cyrus SASL does implement the LOGIN authentication method, even though it is
24828 not a standard method. It is disabled by default in the source distribution,
24829 but it is present in many binary distributions.
24830 .ecindex IIDcyrauth1
24831 .ecindex IIDcyrauth2
24832
24833
24834
24835
24836 . ////////////////////////////////////////////////////////////////////////////
24837 . ////////////////////////////////////////////////////////////////////////////
24838 .chapter "The dovecot authenticator" "CHAPdovecot"
24839 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
24840 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
24841 This authenticator is an interface to the authentication facility of the
24842 Dovecot POP/IMAP server, which can support a number of authentication methods.
24843 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
24844 to use the same mechanisms for SMTP authentication. This is a server
24845 authenticator only. There is only one option:
24846
24847 .option server_socket dovecot string unset
24848
24849 This option must specify the socket that is the interface to Dovecot
24850 authentication. The &%public_name%& option must specify an authentication
24851 mechanism that Dovecot is configured to support. You can have several
24852 authenticators for different mechanisms. For example:
24853 .code
24854 dovecot_plain:
24855   driver = dovecot
24856   public_name = PLAIN
24857   server_socket = /var/run/dovecot/auth-client
24858   server_set_id = $auth2
24859
24860 dovecot_ntlm:
24861   driver = dovecot
24862   public_name = NTLM
24863   server_socket = /var/run/dovecot/auth-client
24864   server_set_id = $auth1
24865 .endd
24866 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
24867 &$received_ip_address$& (that is, the connection is local), the &"secured"&
24868 option is passed in the Dovecot authentication command. If, for a TLS
24869 connection, a client certificate has been verified, the &"valid-client-cert"&
24870 option is passed. When authentication succeeds, the identity of the user
24871 who authenticated is placed in &$auth1$&.
24872 .ecindex IIDdcotauth1
24873 .ecindex IIDdcotauth2
24874
24875
24876 . ////////////////////////////////////////////////////////////////////////////
24877 . ////////////////////////////////////////////////////////////////////////////
24878 .chapter "The gsasl authenticator" "CHAPgsasl"
24879 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
24880 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
24881 .cindex "authentication" "GNU SASL"
24882 .cindex "authentication" "SASL"
24883 .cindex "authentication" "EXTERNAL"
24884 .cindex "authentication" "ANONYMOUS"
24885 .cindex "authentication" "PLAIN"
24886 .cindex "authentication" "LOGIN"
24887 .cindex "authentication" "DIGEST-MD5"
24888 .cindex "authentication" "CRAM-MD5"
24889 .cindex "authentication" "SCRAM-SHA-1"
24890 The &(gsasl)& authenticator provides server integration for the GNU SASL
24891 library and the mechanisms it provides.  This is new as of the 4.80 release
24892 and there are a few areas where the library does not let Exim smoothly
24893 scale to handle future authentication mechanisms, so no guarantee can be
24894 made that any particular new authentication mechanism will be supported
24895 without code changes in Exim.
24896
24897
24898 .option server_channelbinding gsasl boolean false
24899 Some authentication mechanisms are able to use external context at both ends
24900 of the session to bind the authentication to that context, and fail the
24901 authentication process if that context differs.  Specifically, some TLS
24902 ciphersuites can provide identifying information about the cryptographic
24903 context.
24904
24905 This means that certificate identity and verification becomes a non-issue,
24906 as a man-in-the-middle attack will cause the correct client and server to
24907 see different identifiers and authentication will fail.
24908
24909 This is currently only supported when using the GnuTLS library.  This is
24910 only usable by mechanisms which support "channel binding"; at time of
24911 writing, that's the SCRAM family.
24912
24913 This defaults off to ensure smooth upgrade across Exim releases, in case
24914 this option causes some clients to start failing.  Some future release
24915 of Exim may switch the default to be true.
24916
24917
24918 .option server_hostname gsasl string&!! "see below"
24919 This option selects the hostname that is used when communicating with the
24920 library. The default value is &`$primary_hostname`&.
24921 Some mechanisms will use this data.
24922
24923
24924 .option server_mech gsasl string "see below"
24925 This option selects the authentication mechanism this driver should use. The
24926 default is the value of the generic &%public_name%& option. This option allows
24927 you to use a different underlying mechanism from the advertised name. For
24928 example:
24929 .code
24930 sasl:
24931   driver = gsasl
24932   public_name = X-ANYTHING
24933   server_mech = CRAM-MD5
24934   server_set_id = $auth1
24935 .endd
24936
24937
24938 .option server_password gsasl string&!! unset
24939 Various mechanisms need access to the cleartext password on the server, so
24940 that proof-of-possession can be demonstrated on the wire, without sending
24941 the password itself.
24942
24943 The data available for lookup varies per mechanism.
24944 In all cases, &$auth1$& is set to the &'authentication id'&.
24945 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
24946 if available, else the empty string.
24947 The &$auth3$& variable will always be the &'realm'& if available,
24948 else the empty string.
24949
24950 A forced failure will cause authentication to defer.
24951
24952 If using this option, it may make sense to set the &%server_condition%&
24953 option to be simply "true".
24954
24955
24956 .option server_realm gsasl string&!! unset
24957 This specifies the SASL realm that the server claims to be in.
24958 Some mechanisms will use this data.
24959
24960
24961 .option server_scram_iter gsasl string&!! unset
24962 This option provides data for the SCRAM family of mechanisms.
24963 &$auth1$& is not available at evaluation time.
24964 (This may change, as we receive feedback on use)
24965
24966
24967 .option server_scram_salt gsasl string&!! unset
24968 This option provides data for the SCRAM family of mechanisms.
24969 &$auth1$& is not available at evaluation time.
24970 (This may change, as we receive feedback on use)
24971
24972
24973 .option server_service gsasl string &`smtp`&
24974 This is the SASL service that the server claims to implement.
24975 Some mechanisms will use this data.
24976
24977
24978 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
24979 .vindex "&$auth1$&, &$auth2$&, etc"
24980 These may be set when evaluating specific options, as detailed above.
24981 They will also be set when evaluating &%server_condition%&.
24982
24983 Unless otherwise stated below, the &(gsasl)& integration will use the following
24984 meanings for these variables:
24985
24986 .ilist
24987 .vindex "&$auth1$&"
24988 &$auth1$&: the &'authentication id'&
24989 .next
24990 .vindex "&$auth2$&"
24991 &$auth2$&: the &'authorization id'&
24992 .next
24993 .vindex "&$auth3$&"
24994 &$auth3$&: the &'realm'&
24995 .endlist
24996
24997 On a per-mechanism basis:
24998
24999 .ilist
25000 .cindex "authentication" "EXTERNAL"
25001 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
25002 the &%server_condition%& option must be present.
25003 .next
25004 .cindex "authentication" "ANONYMOUS"
25005 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25006 the &%server_condition%& option must be present.
25007 .next
25008 .cindex "authentication" "GSSAPI"
25009 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25010 &$auth2$& will be set to the &'authorization id'&,
25011 the &%server_condition%& option must be present.
25012 .endlist
25013
25014 An &'anonymous token'& is something passed along as an unauthenticated
25015 identifier; this is analogous to FTP anonymous authentication passing an
25016 email address, or software-identifier@, as the "password".
25017
25018
25019 An example showing the password having the realm specified in the callback
25020 and demonstrating a Cyrus SASL to GSASL migration approach is:
25021 .code
25022 gsasl_cyrusless_crammd5:
25023   driver = gsasl
25024   public_name = CRAM-MD5
25025   server_realm = imap.example.org
25026   server_password = ${lookup{$auth1:$auth3:userPassword}\
25027                     dbmjz{/etc/sasldb2}{$value}fail}
25028   server_set_id = ${quote:$auth1}
25029   server_condition = yes
25030 .endd
25031
25032
25033 . ////////////////////////////////////////////////////////////////////////////
25034 . ////////////////////////////////////////////////////////////////////////////
25035
25036 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25037 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25038 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
25039 .cindex "authentication" "GSSAPI"
25040 .cindex "authentication" "Kerberos"
25041 The &(heimdal_gssapi)& authenticator provides server integration for the
25042 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
25043 reliably.
25044
25045 .option server_hostname heimdal_gssapi string&!! "see below"
25046 This option selects the hostname that is used, with &%server_service%&,
25047 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25048 identifier.  The default value is &`$primary_hostname`&.
25049
25050 .option server_keytab heimdal_gssapi string&!! unset
25051 If set, then Heimdal will not use the system default keytab (typically
25052 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25053 The value should be a pathname, with no &"file:"& prefix.
25054
25055 .option server_service heimdal_gssapi string&!! "smtp"
25056 This option specifies the service identifier used, in conjunction with
25057 &%server_hostname%&, for building the identifer for finding credentials
25058 from the keytab.
25059
25060
25061 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25062 Beware that these variables will typically include a realm, thus will appear
25063 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25064 not verified, so a malicious client can set it to anything.
25065
25066 The &$auth1$& field should be safely trustable as a value from the Key
25067 Distribution Center.  Note that these are not quite email addresses.
25068 Each identifier is for a role, and so the left-hand-side may include a
25069 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25070
25071 .vindex "&$auth1$&, &$auth2$&, etc"
25072 .ilist
25073 .vindex "&$auth1$&"
25074 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25075 .next
25076 .vindex "&$auth2$&"
25077 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25078 authentication.  If that was empty, this will also be set to the
25079 GSS Display Name.
25080 .endlist
25081
25082
25083 . ////////////////////////////////////////////////////////////////////////////
25084 . ////////////////////////////////////////////////////////////////////////////
25085
25086 .chapter "The spa authenticator" "CHAPspa"
25087 .scindex IIDspaauth1 "&(spa)& authenticator"
25088 .scindex IIDspaauth2 "authenticators" "&(spa)&"
25089 .cindex "authentication" "Microsoft Secure Password"
25090 .cindex "authentication" "NTLM"
25091 .cindex "Microsoft Secure Password Authentication"
25092 .cindex "NTLM authentication"
25093 The &(spa)& authenticator provides client support for Microsoft's &'Secure
25094 Password Authentication'& mechanism,
25095 which is also sometimes known as NTLM (NT LanMan). The code for client side of
25096 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
25097 taken from the Samba project (&url(http://www.samba.org)). The code for the
25098 server side was subsequently contributed by Tom Kistner. The mechanism works as
25099 follows:
25100
25101 .ilist
25102 After the AUTH command has been accepted, the client sends an SPA
25103 authentication request based on the user name and optional domain.
25104 .next
25105 The server sends back a challenge.
25106 .next
25107 The client builds a challenge response which makes use of the user's password
25108 and sends it to the server, which then accepts or rejects it.
25109 .endlist
25110
25111 Encryption is used to protect the password in transit.
25112
25113
25114
25115 .section "Using spa as a server" "SECID179"
25116 .cindex "options" "&(spa)& authenticator (server)"
25117 The &(spa)& authenticator has just one server option:
25118
25119 .option server_password spa string&!! unset
25120 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
25121 This option is expanded, and the result must be the cleartext password for the
25122 authenticating user, whose name is at this point in &$auth1$&. For
25123 compatibility with previous releases of Exim, the user name is also placed in
25124 &$1$&. However, the use of this variable for this purpose is now deprecated, as
25125 it can lead to confusion in string expansions that also use numeric variables
25126 for other things. For example:
25127 .code
25128 spa:
25129   driver = spa
25130   public_name = NTLM
25131   server_password = \
25132     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
25133 .endd
25134 If the expansion is forced to fail, authentication fails. Any other expansion
25135 failure causes a temporary error code to be returned.
25136
25137
25138
25139
25140
25141 .section "Using spa as a client" "SECID180"
25142 .cindex "options" "&(spa)& authenticator (client)"
25143 The &(spa)& authenticator has the following client options:
25144
25145
25146
25147 .option client_domain spa string&!! unset
25148 This option specifies an optional domain for the authentication.
25149
25150
25151 .option client_password spa string&!! unset
25152 This option specifies the user's password, and must be set.
25153
25154
25155 .option client_username spa string&!! unset
25156 This option specifies the user name, and must be set. Here is an example of a
25157 configuration of this authenticator for use with the mail servers at
25158 &'msn.com'&:
25159 .code
25160 msn:
25161   driver = spa
25162   public_name = MSN
25163   client_username = msn/msn_username
25164   client_password = msn_plaintext_password
25165   client_domain = DOMAIN_OR_UNSET
25166 .endd
25167 .ecindex IIDspaauth1
25168 .ecindex IIDspaauth2
25169
25170
25171
25172
25173
25174 . ////////////////////////////////////////////////////////////////////////////
25175 . ////////////////////////////////////////////////////////////////////////////
25176
25177 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
25178          "Encrypted SMTP connections"
25179 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
25180 .scindex IIDencsmtp2 "SMTP" "encryption"
25181 .cindex "TLS" "on SMTP connection"
25182 .cindex "OpenSSL"
25183 .cindex "GnuTLS"
25184 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
25185 Sockets Layer), is implemented by making use of the OpenSSL library or the
25186 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
25187 cryptographic code in the Exim distribution itself for implementing TLS. In
25188 order to use this feature you must install OpenSSL or GnuTLS, and then build a
25189 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
25190 You also need to understand the basic concepts of encryption at a managerial
25191 level, and in particular, the way that public keys, private keys, and
25192 certificates are used.
25193
25194 RFC 3207 defines how SMTP connections can make use of encryption. Once a
25195 connection is established, the client issues a STARTTLS command. If the
25196 server accepts this, the client and the server negotiate an encryption
25197 mechanism. If the negotiation succeeds, the data that subsequently passes
25198 between them is encrypted.
25199
25200 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
25201 and if so, what cipher suite is in use, whether the client supplied a
25202 certificate, and whether or not that certificate was verified. This makes it
25203 possible for an Exim server to deny or accept certain commands based on the
25204 encryption state.
25205
25206 &*Warning*&: Certain types of firewall and certain anti-virus products can
25207 disrupt TLS connections. You need to turn off SMTP scanning for these products
25208 in order to get TLS to work.
25209
25210
25211
25212 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
25213          "SECID284"
25214 .cindex "ssmtp protocol"
25215 .cindex "smtps protocol"
25216 .cindex "SMTP" "ssmtp protocol"
25217 .cindex "SMTP" "smtps protocol"
25218 Early implementations of encrypted SMTP used a different TCP port from normal
25219 SMTP, and expected an encryption negotiation to start immediately, instead of
25220 waiting for a STARTTLS command from the client using the standard SMTP
25221 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
25222 allocated for this purpose.
25223
25224 This approach was abandoned when encrypted SMTP was standardized, but there are
25225 still some legacy clients that use it. Exim supports these clients by means of
25226 the &%tls_on_connect_ports%& global option. Its value must be a list of port
25227 numbers; the most common use is expected to be:
25228 .code
25229 tls_on_connect_ports = 465
25230 .endd
25231 The port numbers specified by this option apply to all SMTP connections, both
25232 via the daemon and via &'inetd'&. You still need to specify all the ports that
25233 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
25234 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
25235 an extra port &-- rather, it specifies different behaviour on a port that is
25236 defined elsewhere.
25237
25238 There is also a &%-tls-on-connect%& command line option. This overrides
25239 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
25240
25241
25242
25243
25244
25245
25246 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
25247 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
25248 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
25249 followed later, when the first versions of GnuTLS were released. To build Exim
25250 to use GnuTLS, you need to set
25251 .code
25252 USE_GNUTLS=yes
25253 .endd
25254 in Local/Makefile, in addition to
25255 .code
25256 SUPPORT_TLS=yes
25257 .endd
25258 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
25259 include files and libraries for GnuTLS can be found.
25260
25261 There are some differences in usage when using GnuTLS instead of OpenSSL:
25262
25263 .ilist
25264 The &%tls_verify_certificates%& option must contain the name of a file, not the
25265 name of a directory (for OpenSSL it can be either).
25266 .next
25267 The default value for &%tls_dhparam%& differs for historical reasons.
25268 .next
25269 .vindex "&$tls_in_peerdn$&"
25270 .vindex "&$tls_out_peerdn$&"
25271 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
25272 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
25273 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
25274 .next
25275 OpenSSL identifies cipher suites using hyphens as separators, for example:
25276 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
25277 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
25278 in a cipher list. To make life simpler, Exim changes underscores to hyphens
25279 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
25280 to handle its own older variants) when processing lists of cipher suites in the
25281 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
25282 option).
25283 .next
25284 The &%tls_require_ciphers%& options operate differently, as described in the
25285 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
25286 .next
25287 .new
25288 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
25289 When using OpenSSL, this option is ignored.
25290 (If an API is found to let OpenSSL be configured in this way,
25291 let the Exim Maintainers know and we'll likely use it).
25292 .wen
25293 .next
25294 Some other recently added features may only be available in one or the other.
25295 This should be documented with the feature.  If the documentation does not
25296 explicitly state that the feature is infeasible in the other TLS
25297 implementation, then patches are welcome.
25298 .endlist
25299
25300
25301 .section "GnuTLS parameter computation" "SECTgnutlsparam"
25302 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
25303 an explicit path; if the latter, then the text about generation still applies,
25304 but not the chosen filename.
25305 By default, as of Exim 4.80 a hard-coded D-H prime is used.
25306 See the documentation of &%tls_dhparam%& for more information.
25307
25308 GnuTLS uses D-H parameters that may take a substantial amount of time
25309 to compute. It is unreasonable to re-compute them for every TLS session.
25310 Therefore, Exim keeps this data in a file in its spool directory, called
25311 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
25312 of bits requested.
25313 The file is owned by the Exim user and is readable only by
25314 its owner. Every Exim process that start up GnuTLS reads the D-H
25315 parameters from this file. If the file does not exist, the first Exim process
25316 that needs it computes the data and writes it to a temporary file which is
25317 renamed once it is complete. It does not matter if several Exim processes do
25318 this simultaneously (apart from wasting a few resources). Once a file is in
25319 place, new Exim processes immediately start using it.
25320
25321 For maximum security, the parameters that are stored in this file should be
25322 recalculated periodically, the frequency depending on your paranoia level.
25323 If you are avoiding using the fixed D-H primes published in RFCs, then you
25324 are concerned about some advanced attacks and will wish to do this; if you do
25325 not regenerate then you might as well stick to the standard primes.
25326
25327 Arranging this is easy in principle; just delete the file when you want new
25328 values to be computed. However, there may be a problem. The calculation of new
25329 parameters needs random numbers, and these are obtained from &_/dev/random_&.
25330 If the system is not very active, &_/dev/random_& may delay returning data
25331 until enough randomness (entropy) is available. This may cause Exim to hang for
25332 a substantial amount of time, causing timeouts on incoming connections.
25333
25334 The solution is to generate the parameters externally to Exim. They are stored
25335 in &_gnutls-params-N_& in PEM format, which means that they can be
25336 generated externally using the &(certtool)& command that is part of GnuTLS.
25337
25338 To replace the parameters with new ones, instead of deleting the file
25339 and letting Exim re-create it, you can generate new parameters using
25340 &(certtool)& and, when this has been done, replace Exim's cache file by
25341 renaming. The relevant commands are something like this:
25342 .code
25343 # ls
25344 [ look for file; assume gnutls-params-2236 is the most recent ]
25345 # rm -f new-params
25346 # touch new-params
25347 # chown exim:exim new-params
25348 # chmod 0600 new-params
25349 # certtool --generate-dh-params --bits 2236 >>new-params
25350 # openssl dhparam -noout -text -in new-params | head
25351 [ check the first line, make sure it's not more than 2236;
25352   if it is, then go back to the start ("rm") and repeat
25353   until the size generated is at most the size requested ]
25354 # chmod 0400 new-params
25355 # mv new-params gnutls-params-2236
25356 .endd
25357 If Exim never has to generate the parameters itself, the possibility of
25358 stalling is removed.
25359
25360 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
25361 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
25362 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
25363 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
25364 and Exim does so.  This attempt to remove Exim from TLS policy decisions
25365 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
25366 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
25367 which applies to all D-H usage, client or server.  If the value returned by
25368 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
25369 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
25370 limit, which is still much higher than Exim historically used.
25371
25372 The filename and bits used will change as the GnuTLS maintainers change the
25373 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
25374 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
25375 2432 bits, while NSS is limited to 2236 bits.
25376
25377 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
25378 increase the chance of the generated prime actually being within acceptable
25379 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
25380 procedure above.  There is no sane procedure available to Exim to double-check
25381 the size of the generated prime, so it might still be too large.
25382
25383
25384 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
25385 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
25386 .oindex "&%tls_require_ciphers%&" "OpenSSL"
25387 There is a function in the OpenSSL library that can be passed a list of cipher
25388 suites before the cipher negotiation takes place. This specifies which ciphers
25389 are acceptable. The list is colon separated and may contain names like
25390 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
25391 directly to this function call.
25392 Many systems will install the OpenSSL manual-pages, so you may have
25393 &'ciphers(1)'& available to you.
25394 The following quotation from the OpenSSL
25395 documentation specifies what forms of item are allowed in the cipher string:
25396
25397 .ilist
25398 It can consist of a single cipher suite such as RC4-SHA.
25399 .next
25400 It can represent a list of cipher suites containing a certain algorithm,
25401 or cipher suites of a certain type. For example SHA1 represents all
25402 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
25403 SSL v3 algorithms.
25404 .next
25405 Lists of cipher suites can be combined in a single cipher string using
25406 the + character. This is used as a logical and operation. For example
25407 SHA1+DES represents all cipher suites containing the SHA1 and the DES
25408 algorithms.
25409 .endlist
25410
25411 Each cipher string can be optionally preceded by one of the characters &`!`&,
25412 &`-`& or &`+`&.
25413 .ilist
25414 If &`!`& is used, the ciphers are permanently deleted from the list. The
25415 ciphers deleted can never reappear in the list even if they are explicitly
25416 stated.
25417 .next
25418 If &`-`& is used, the ciphers are deleted from the list, but some or all
25419 of the ciphers can be added again by later options.
25420 .next
25421 If &`+`& is used, the ciphers are moved to the end of the list. This
25422 option does not add any new ciphers; it just moves matching existing ones.
25423 .endlist
25424
25425 If none of these characters is present, the string is interpreted as
25426 a list of ciphers to be appended to the current preference list. If the list
25427 includes any ciphers already present they will be ignored: that is, they will
25428 not be moved to the end of the list.
25429 .endlist
25430
25431 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
25432 string:
25433 .code
25434 # note single-quotes to get ! past any shell history expansion
25435 $ openssl ciphers 'HIGH:!MD5:!SHA1'
25436 .endd
25437
25438 This example will let the library defaults be permitted on the MX port, where
25439 there's probably no identity verification anyway, but ups the ante on the
25440 submission ports where the administrator might have some influence on the
25441 choice of clients used:
25442 .code
25443 # OpenSSL variant; see man ciphers(1)
25444 tls_require_ciphers = ${if =={$received_port}{25}\
25445                            {DEFAULT}\
25446                            {HIGH:!MD5:!SHA1}}
25447 .endd
25448
25449
25450
25451 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
25452          "SECTreqciphgnu"
25453 .cindex "GnuTLS" "specifying parameters for"
25454 .cindex "TLS" "specifying ciphers (GnuTLS)"
25455 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
25456 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
25457 .cindex "TLS" "specifying protocols (GnuTLS)"
25458 .cindex "TLS" "specifying priority string (GnuTLS)"
25459 .oindex "&%tls_require_ciphers%&" "GnuTLS"
25460 The GnuTLS library allows the caller to provide a "priority string", documented
25461 as part of the &[gnutls_priority_init]& function.  This is very similar to the
25462 ciphersuite specification in OpenSSL.
25463
25464 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string.
25465
25466 The &%tls_require_ciphers%& option is available both as an global option,
25467 controlling how Exim behaves as a server, and also as an option of the
25468 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
25469 the value is string expanded.  The resulting string is not an Exim list and
25470 the string is given to the GnuTLS library, so that Exim does not need to be
25471 aware of future feature enhancements of GnuTLS.
25472
25473 Documentation of the strings accepted may be found in the GnuTLS manual, under
25474 "Priority strings".  This is online as
25475 &url(http://www.gnu.org/software/gnutls/manual/html_node/Priority-Strings.html),
25476 but beware that this relates to GnuTLS 3, which may be newer than the version
25477 installed on your system.  If you are using GnuTLS 3,
25478 &url(http://www.gnu.org/software/gnutls/manual/html_node/Listing-the-ciphersuites-in-a-priority-string.html, then the example code)
25479 on that site can be used to test a given string.
25480
25481 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
25482 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
25483 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
25484
25485 This example will let the library defaults be permitted on the MX port, where
25486 there's probably no identity verification anyway, and lowers security further
25487 by increasing compatibility; but this ups the ante on the submission ports
25488 where the administrator might have some influence on the choice of clients
25489 used:
25490 .code
25491 # GnuTLS variant
25492 tls_require_ciphers = ${if =={$received_port}{25}\
25493                            {NORMAL:%COMPAT}\
25494                            {SECURE128}}
25495 .endd
25496
25497
25498 .section "Configuring an Exim server to use TLS" "SECID182"
25499 .cindex "TLS" "configuring an Exim server"
25500 When Exim has been built with TLS support, it advertises the availability of
25501 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
25502 but not to any others. The default value of this option is unset, which means
25503 that STARTTLS is not advertised at all. This default is chosen because you
25504 need to set some other options in order to make TLS available, and also it is
25505 sensible for systems that want to use TLS only as a client.
25506
25507 If a client issues a STARTTLS command and there is some configuration
25508 problem in the server, the command is rejected with a 454 error. If the client
25509 persists in trying to issue SMTP commands, all except QUIT are rejected
25510 with the error
25511 .code
25512 554 Security failure
25513 .endd
25514 If a STARTTLS command is issued within an existing TLS session, it is
25515 rejected with a 554 error code.
25516
25517 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
25518 match some hosts. You can, of course, set it to * to match all hosts.
25519 However, this is not all you need to do. TLS sessions to a server won't work
25520 without some further configuration at the server end.
25521
25522 It is rumoured that all existing clients that support TLS/SSL use RSA
25523 encryption. To make this work you need to set, in the server,
25524 .code
25525 tls_certificate = /some/file/name
25526 tls_privatekey = /some/file/name
25527 .endd
25528 These options are, in fact, expanded strings, so you can make them depend on
25529 the identity of the client that is connected if you wish. The first file
25530 contains the server's X509 certificate, and the second contains the private key
25531 that goes with it. These files need to be readable by the Exim user, and must
25532 always be given as full path names. They can be the same file if both the
25533 certificate and the key are contained within it. If &%tls_privatekey%& is not
25534 set, or if its expansion is forced to fail or results in an empty string, this
25535 is assumed to be the case. The certificate file may also contain intermediate
25536 certificates that need to be sent to the client to enable it to authenticate
25537 the server's certificate.
25538
25539 If you do not understand about certificates and keys, please try to find a
25540 source of this background information, which is not Exim-specific. (There are a
25541 few comments below in section &<<SECTcerandall>>&.)
25542
25543 &*Note*&: These options do not apply when Exim is operating as a client &--
25544 they apply only in the case of a server. If you need to use a certificate in an
25545 Exim client, you must set the options of the same names in an &(smtp)&
25546 transport.
25547
25548 With just these options, an Exim server will be able to use TLS. It does not
25549 require the client to have a certificate (but see below for how to insist on
25550 this). There is one other option that may be needed in other situations. If
25551 .code
25552 tls_dhparam = /some/file/name
25553 .endd
25554 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
25555 with the parameters contained in the file.
25556 Set this to &`none`& to disable use of DH entirely, by making no prime
25557 available:
25558 .code
25559 tls_dhparam = none
25560 .endd
25561 This may also be set to a string identifying a standard prime to be used for
25562 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
25563 used is &`ike23`&.  There are a few standard primes available, see the
25564 documetnation for &%tls_dhparam%& for the complete list.
25565
25566 See the command
25567 .code
25568 openssl dhparam
25569 .endd
25570 for a way of generating file data.
25571
25572 The strings supplied for these three options are expanded every time a client
25573 host connects. It is therefore possible to use different certificates and keys
25574 for different hosts, if you so wish, by making use of the client's IP address
25575 in &$sender_host_address$& to control the expansion. If a string expansion is
25576 forced to fail, Exim behaves as if the option is not set.
25577
25578 .cindex "cipher" "logging"
25579 .cindex "log" "TLS cipher"
25580 .vindex "&$tls_in_cipher$&"
25581 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
25582 an incoming TLS connection. It is included in the &'Received:'& header of an
25583 incoming message (by default &-- you can, of course, change this), and it is
25584 also included in the log line that records a message's arrival, keyed by
25585 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
25586 condition can be used to test for specific cipher suites in ACLs.
25587
25588 Once TLS has been established, the ACLs that run for subsequent SMTP commands
25589 can check the name of the cipher suite and vary their actions accordingly. The
25590 cipher suite names vary, depending on which TLS library is being used. For
25591 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
25592 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
25593 documentation for more details.
25594
25595 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
25596 (again depending on the &%tls_cipher%& log selector).
25597
25598
25599 .section "Requesting and verifying client certificates" "SECID183"
25600 .cindex "certificate" "verification of client"
25601 .cindex "TLS" "client certificate verification"
25602 If you want an Exim server to request a certificate when negotiating a TLS
25603 session with a client, you must set either &%tls_verify_hosts%& or
25604 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
25605 apply to all TLS connections. For any host that matches one of these options,
25606 Exim requests a certificate as part of the setup of the TLS session. The
25607 contents of the certificate are verified by comparing it with a list of
25608 expected certificates. These must be available in a file or,
25609 for OpenSSL only (not GnuTLS), a directory, identified by
25610 &%tls_verify_certificates%&.
25611
25612 A file can contain multiple certificates, concatenated end to end. If a
25613 directory is used
25614 (OpenSSL only),
25615 each certificate must be in a separate file, with a name (or a symbolic link)
25616 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
25617 certificate. You can compute the relevant hash by running the command
25618 .code
25619 openssl x509 -hash -noout -in /cert/file
25620 .endd
25621 where &_/cert/file_& contains a single certificate.
25622
25623 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
25624 what happens if the client does not supply a certificate, or if the certificate
25625 does not match any of the certificates in the collection named by
25626 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
25627 attempt to set up a TLS session is aborted, and the incoming connection is
25628 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
25629 session continues. ACLs that run for subsequent SMTP commands can detect the
25630 fact that no certificate was verified, and vary their actions accordingly. For
25631 example, you can insist on a certificate before accepting a message for
25632 relaying, but not when the message is destined for local delivery.
25633
25634 .vindex "&$tls_in_peerdn$&"
25635 When a client supplies a certificate (whether it verifies or not), the value of
25636 the Distinguished Name of the certificate is made available in the variable
25637 &$tls_in_peerdn$& during subsequent processing of the message.
25638
25639 .cindex "log" "distinguished name"
25640 Because it is often a long text string, it is not included in the log line or
25641 &'Received:'& header by default. You can arrange for it to be logged, keyed by
25642 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
25643 &%received_header_text%& to change the &'Received:'& header. When no
25644 certificate is supplied, &$tls_in_peerdn$& is empty.
25645
25646
25647 .section "Revoked certificates" "SECID184"
25648 .cindex "TLS" "revoked certificates"
25649 .cindex "revocation list"
25650 .cindex "certificate" "revocation list"
25651 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
25652 certificates are revoked. If you have such a list, you can pass it to an Exim
25653 server using the global option called &%tls_crl%& and to an Exim client using
25654 an identically named option for the &(smtp)& transport. In each case, the value
25655 of the option is expanded and must then be the name of a file that contains a
25656 CRL in PEM format.
25657
25658
25659 .section "Configuring an Exim client to use TLS" "SECID185"
25660 .cindex "cipher" "logging"
25661 .cindex "log" "TLS cipher"
25662 .cindex "log" "distinguished name"
25663 .cindex "TLS" "configuring an Exim client"
25664 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
25665 deliveries as well as to incoming, the latter one causing logging of the
25666 server certificate's DN. The remaining client configuration for TLS is all
25667 within the &(smtp)& transport.
25668
25669 It is not necessary to set any options to have TLS work in the &(smtp)&
25670 transport. If Exim is built with TLS support, and TLS is advertised by a
25671 server, the &(smtp)& transport always tries to start a TLS session. However,
25672 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
25673 transport) to a list of server hosts for which TLS should not be used.
25674
25675 If you do not want Exim to attempt to send messages unencrypted when an attempt
25676 to set up an encrypted connection fails in any way, you can set
25677 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
25678 those hosts, delivery is always deferred if an encrypted connection cannot be
25679 set up. If there are any other hosts for the address, they are tried in the
25680 usual way.
25681
25682 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
25683 the message unencrypted. It always does this if the response to STARTTLS is
25684 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
25685 session after a success response code, what happens is controlled by the
25686 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
25687 delivery to this host is deferred, and other hosts (if available) are tried. If
25688 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
25689 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
25690 negotiation fails, Exim closes the current connection (because it is in an
25691 unknown state), opens a new one to the same host, and then tries the delivery
25692 unencrypted.
25693
25694 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
25695 transport provide the client with a certificate, which is passed to the server
25696 if it requests it. If the server is Exim, it will request a certificate only if
25697 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
25698
25699 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
25700 must name a file or,
25701 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
25702 expected server certificates. The client verifies the server's certificate
25703 against this collection, taking into account any revoked certificates that are
25704 in the list defined by &%tls_crl%&.
25705
25706 If
25707 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
25708 list of permitted cipher suites. If either of these checks fails, delivery to
25709 the current host is abandoned, and the &(smtp)& transport tries to deliver to
25710 alternative hosts, if any.
25711
25712  &*Note*&:
25713 These options must be set in the &(smtp)& transport for Exim to use TLS when it
25714 is operating as a client. Exim does not assume that a server certificate (set
25715 by the global options of the same name) should also be used when operating as a
25716 client.
25717
25718 .vindex "&$host$&"
25719 .vindex "&$host_address$&"
25720 All the TLS options in the &(smtp)& transport are expanded before use, with
25721 &$host$& and &$host_address$& containing the name and address of the server to
25722 which the client is connected. Forced failure of an expansion causes Exim to
25723 behave as if the relevant option were unset.
25724
25725 .vindex &$tls_out_bits$&
25726 .vindex &$tls_out_cipher$&
25727 .vindex &$tls_out_peerdn$&
25728 .vindex &$tls_out_sni$&
25729 Before an SMTP connection is established, the
25730 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
25731 variables are emptied. (Until the first connection, they contain the values
25732 that were set when the message was received.) If STARTTLS is subsequently
25733 successfully obeyed, these variables are set to the relevant values for the
25734 outgoing connection.
25735
25736
25737
25738 .section "Use of TLS Server Name Indication" "SECTtlssni"
25739 .cindex "TLS" "Server Name Indication"
25740 .vindex "&$tls_in_sni$&"
25741 .oindex "&%tls_in_sni%&"
25742 With TLS1.0 or above, there is an extension mechanism by which extra
25743 information can be included at various points in the protocol.  One of these
25744 extensions, documented in RFC 6066 (and before that RFC 4366) is
25745 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
25746 client in the initial handshake, so that the server can examine the servername
25747 within and possibly choose to use different certificates and keys (and more)
25748 for this session.
25749
25750 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
25751 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
25752 address.
25753
25754 With SMTP to MX, there are the same problems here as in choosing the identity
25755 against which to validate a certificate: you can't rely on insecure DNS to
25756 provide the identity which you then cryptographically verify.  So this will
25757 be of limited use in that environment.
25758
25759 With SMTP to Submission, there is a well-defined hostname which clients are
25760 connecting to and can validate certificates against.  Thus clients &*can*&
25761 choose to include this information in the TLS negotiation.  If this becomes
25762 wide-spread, then hosters can choose to present different certificates to
25763 different clients.  Or even negotiate different cipher suites.
25764
25765 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
25766 if not empty, will be sent on a TLS session as part of the handshake.  There's
25767 nothing more to it.  Choosing a sensible value not derived insecurely is the
25768 only point of caution.  The &$tls_out_sni$& variable will be set to this string
25769 for the lifetime of the client connection (including during authentication).
25770
25771 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
25772 received from a client.
25773 It can be logged with the &%log_selector%& item &`+tls_sni`&.
25774
25775 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
25776 option (prior to expansion) then the following options will be re-expanded
25777 during TLS session handshake, to permit alternative values to be chosen:
25778
25779 .ilist
25780 .vindex "&%tls_certificate%&"
25781 &%tls_certificate%&
25782 .next
25783 .vindex "&%tls_crl%&"
25784 &%tls_crl%&
25785 .next
25786 .vindex "&%tls_privatekey%&"
25787 &%tls_privatekey%&
25788 .next
25789 .vindex "&%tls_verify_certificates%&"
25790 &%tls_verify_certificates%&
25791 .endlist
25792
25793 Great care should be taken to deal with matters of case, various injection
25794 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
25795 can always be referenced; it is important to remember that &$tls_sni$& is
25796 arbitrary unverified data provided prior to authentication.
25797
25798 The Exim developers are proceeding cautiously and so far no other TLS options
25799 are re-expanded.
25800
25801 When Exim is built againt OpenSSL, OpenSSL must have been built with support
25802 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
25803 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
25804 see &`-servername`& in the output, then OpenSSL has support.
25805
25806 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
25807 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
25808 built, then you have SNI support).
25809
25810
25811
25812 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
25813          "SECTmulmessam"
25814 .cindex "multiple SMTP deliveries with TLS"
25815 .cindex "TLS" "multiple message deliveries"
25816 Exim sends multiple messages down the same TCP/IP connection by starting up
25817 an entirely new delivery process for each message, passing the socket from
25818 one process to the next. This implementation does not fit well with the use
25819 of TLS, because there is quite a lot of state information associated with a TLS
25820 connection, not just a socket identification. Passing all the state information
25821 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
25822 session before passing the socket to a new process. The new process may then
25823 try to start a new TLS session, and if successful, may try to re-authenticate
25824 if AUTH is in use, before sending the next message.
25825
25826 The RFC is not clear as to whether or not an SMTP session continues in clear
25827 after TLS has been shut down, or whether TLS may be restarted again later, as
25828 just described. However, if the server is Exim, this shutdown and
25829 reinitialization works. It is not known which (if any) other servers operate
25830 successfully if the client closes a TLS session and continues with unencrypted
25831 SMTP, but there are certainly some that do not work. For such servers, Exim
25832 should not pass the socket to another process, because the failure of the
25833 subsequent attempt to use it would cause Exim to record a temporary host error,
25834 and delay other deliveries to that host.
25835
25836 To test for this case, Exim sends an EHLO command to the server after
25837 closing down the TLS session. If this fails in any way, the connection is
25838 closed instead of being passed to a new delivery process, but no retry
25839 information is recorded.
25840
25841 There is also a manual override; you can set &%hosts_nopass_tls%& on the
25842 &(smtp)& transport to match those hosts for which Exim should not pass
25843 connections to new processes if TLS has been used.
25844
25845
25846
25847
25848 .section "Certificates and all that" "SECTcerandall"
25849 .cindex "certificate" "references to discussion"
25850 In order to understand fully how TLS works, you need to know about
25851 certificates, certificate signing, and certificate authorities. This is not the
25852 place to give a tutorial, especially as I do not know very much about it
25853 myself. Some helpful introduction can be found in the FAQ for the SSL addition
25854 to Apache, currently at
25855 .display
25856 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
25857 .endd
25858 Other parts of the &'modssl'& documentation are also helpful, and have
25859 links to further files.
25860 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
25861 0-201-61598-3), contains both introductory and more in-depth descriptions.
25862 Some sample programs taken from the book are available from
25863 .display
25864 &url(http://www.rtfm.com/openssl-examples/)
25865 .endd
25866
25867
25868 .section "Certificate chains" "SECID186"
25869 The file named by &%tls_certificate%& may contain more than one
25870 certificate. This is useful in the case where the certificate that is being
25871 sent is validated by an intermediate certificate which the other end does
25872 not have. Multiple certificates must be in the correct order in the file.
25873 First the host's certificate itself, then the first intermediate
25874 certificate to validate the issuer of the host certificate, then the next
25875 intermediate certificate to validate the issuer of the first intermediate
25876 certificate, and so on, until finally (optionally) the root certificate.
25877 The root certificate must already be trusted by the recipient for
25878 validation to succeed, of course, but if it's not preinstalled, sending the
25879 root certificate along with the rest makes it available for the user to
25880 install if the receiving end is a client MUA that can interact with a user.
25881
25882
25883 .section "Self-signed certificates" "SECID187"
25884 .cindex "certificate" "self-signed"
25885 You can create a self-signed certificate using the &'req'& command provided
25886 with OpenSSL, like this:
25887 . ==== Do not shorten the duration here without reading and considering
25888 . ==== the text below.  Please leave it at 9999 days.
25889 .code
25890 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
25891             -days 9999 -nodes
25892 .endd
25893 &_file1_& and &_file2_& can be the same file; the key and the certificate are
25894 delimited and so can be identified independently. The &%-days%& option
25895 specifies a period for which the certificate is valid. The &%-nodes%& option is
25896 important: if you do not set it, the key is encrypted with a passphrase
25897 that you are prompted for, and any use that is made of the key causes more
25898 prompting for the passphrase. This is not helpful if you are going to use
25899 this certificate and key in an MTA, where prompting is not possible.
25900
25901 . ==== I expect to still be working 26 years from now.  The less technical
25902 . ==== debt I create, in terms of storing up trouble for my later years, the
25903 . ==== happier I will be then.  We really have reached the point where we
25904 . ==== should start, at the very least, provoking thought and making folks
25905 . ==== pause before proceeding, instead of leaving all the fixes until two
25906 . ==== years before 2^31 seconds after the 1970 Unix epoch.
25907 . ==== -pdp, 2012
25908 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
25909 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
25910 the above command might produce a date in the past.  Think carefully about
25911 the lifetime of the systems you're deploying, and either reduce the duration
25912 of the certificate or reconsider your platform deployment.  (At time of
25913 writing, reducing the duration is the most likely choice, but the inexorable
25914 progression of time takes us steadily towards an era where this will not
25915 be a sensible resolution).
25916
25917 A self-signed certificate made in this way is sufficient for testing, and
25918 may be adequate for all your requirements if you are mainly interested in
25919 encrypting transfers, and not in secure identification.
25920
25921 However, many clients require that the certificate presented by the server be a
25922 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
25923 certificate. In this situation, the self-signed certificate described above
25924 must be installed on the client host as a trusted root &'certification
25925 authority'& (CA), and the certificate used by Exim must be a user certificate
25926 signed with that self-signed certificate.
25927
25928 For information on creating self-signed CA certificates and using them to sign
25929 user certificates, see the &'General implementation overview'& chapter of the
25930 Open-source PKI book, available online at
25931 &url(http://ospkibook.sourceforge.net/).
25932 .ecindex IIDencsmtp1
25933 .ecindex IIDencsmtp2
25934
25935
25936
25937 . ////////////////////////////////////////////////////////////////////////////
25938 . ////////////////////////////////////////////////////////////////////////////
25939
25940 .chapter "Access control lists" "CHAPACL"
25941 .scindex IIDacl "&ACL;" "description"
25942 .cindex "control of incoming mail"
25943 .cindex "message" "controlling incoming"
25944 .cindex "policy control" "access control lists"
25945 Access Control Lists (ACLs) are defined in a separate section of the run time
25946 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
25947 name, terminated by a colon. Here is a complete ACL section that contains just
25948 one very small ACL:
25949 .code
25950 begin acl
25951 small_acl:
25952   accept   hosts = one.host.only
25953 .endd
25954 You can have as many lists as you like in the ACL section, and the order in
25955 which they appear does not matter. The lists are self-terminating.
25956
25957 The majority of ACLs are used to control Exim's behaviour when it receives
25958 certain SMTP commands. This applies both to incoming TCP/IP connections, and
25959 when a local process submits a message using SMTP by specifying the &%-bs%&
25960 option. The most common use is for controlling which recipients are accepted
25961 in incoming messages. In addition, you can define an ACL that is used to check
25962 local non-SMTP messages. The default configuration file contains an example of
25963 a realistic ACL for checking RCPT commands. This is discussed in chapter
25964 &<<CHAPdefconfil>>&.
25965
25966
25967 .section "Testing ACLs" "SECID188"
25968 The &%-bh%& command line option provides a way of testing your ACL
25969 configuration locally by running a fake SMTP session with which you interact.
25970 The host &'relay-test.mail-abuse.org'& provides a service for checking your
25971 relaying configuration (see section &<<SECTcheralcon>>& for more details).
25972
25973
25974
25975 .section "Specifying when ACLs are used" "SECID189"
25976 .cindex "&ACL;" "options for specifying"
25977 In order to cause an ACL to be used, you have to name it in one of the relevant
25978 options in the main part of the configuration. These options are:
25979 .cindex "AUTH" "ACL for"
25980 .cindex "DATA" "ACLs for"
25981 .cindex "ETRN" "ACL for"
25982 .cindex "EXPN" "ACL for"
25983 .cindex "HELO" "ACL for"
25984 .cindex "EHLO" "ACL for"
25985 .cindex "MAIL" "ACL for"
25986 .cindex "QUIT, ACL for"
25987 .cindex "RCPT" "ACL for"
25988 .cindex "STARTTLS, ACL for"
25989 .cindex "VRFY" "ACL for"
25990 .cindex "SMTP" "connection, ACL for"
25991 .cindex "non-SMTP messages" "ACLs for"
25992 .cindex "MIME content scanning" "ACL for"
25993
25994 .table2 140pt
25995 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
25996 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
25997 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
25998 .irow &%acl_smtp_auth%&        "ACL for AUTH"
25999 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
26000 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
26001 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
26002 .irow &%acl_smtp_expn%&        "ACL for EXPN"
26003 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
26004 .irow &%acl_smtp_mail%&        "ACL for MAIL"
26005 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
26006 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
26007 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
26008 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
26009 .irow &%acl_smtp_quit%&        "ACL for QUIT"
26010 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
26011 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
26012 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
26013 .endtable
26014
26015 For example, if you set
26016 .code
26017 acl_smtp_rcpt = small_acl
26018 .endd
26019 the little ACL defined above is used whenever Exim receives a RCPT command
26020 in an SMTP dialogue. The majority of policy tests on incoming messages can be
26021 done when RCPT commands arrive. A rejection of RCPT should cause the
26022 sending MTA to give up on the recipient address contained in the RCPT
26023 command, whereas rejection at other times may cause the client MTA to keep on
26024 trying to deliver the message. It is therefore recommended that you do as much
26025 testing as possible at RCPT time.
26026
26027
26028 .section "The non-SMTP ACLs" "SECID190"
26029 .cindex "non-SMTP messages" "ACLs for"
26030 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
26031 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
26032 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
26033 the state of the SMTP connection such as encryption and authentication) are not
26034 relevant and are forbidden in these ACLs. However, the sender and recipients
26035 are known, so the &%senders%& and &%sender_domains%& conditions and the
26036 &$sender_address$& and &$recipients$& variables can be used. Variables such as
26037 &$authenticated_sender$& are also available. You can specify added header lines
26038 in any of these ACLs.
26039
26040 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
26041 non-SMTP message, before any of the message has been read. (This is the
26042 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
26043 batched SMTP input, it runs after the DATA command has been reached. The
26044 result of this ACL is ignored; it cannot be used to reject a message. If you
26045 really need to, you could set a value in an ACL variable here and reject based
26046 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
26047 controls, and in particular, it can be used to set
26048 .code
26049 control = suppress_local_fixups
26050 .endd
26051 This cannot be used in the other non-SMTP ACLs because by the time they are
26052 run, it is too late.
26053
26054 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
26055 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26056
26057 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
26058 kind of rejection is treated as permanent, because there is no way of sending a
26059 temporary error for these kinds of message.
26060
26061
26062 .section "The SMTP connect ACL" "SECID191"
26063 .cindex "SMTP" "connection, ACL for"
26064 .oindex &%smtp_banner%&
26065 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
26066 session, after the test specified by &%host_reject_connection%& (which is now
26067 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
26068 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
26069 the message override the banner message that is otherwise specified by the
26070 &%smtp_banner%& option.
26071
26072
26073 .section "The EHLO/HELO ACL" "SECID192"
26074 .cindex "EHLO" "ACL for"
26075 .cindex "HELO" "ACL for"
26076 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
26077 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
26078 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
26079 Note that a client may issue more than one EHLO or HELO command in an SMTP
26080 session, and indeed is required to issue a new EHLO or HELO after successfully
26081 setting up encryption following a STARTTLS command.
26082
26083 If the command is accepted by an &%accept%& verb that has a &%message%&
26084 modifier, the message may not contain more than one line (it will be truncated
26085 at the first newline and a panic logged if it does). Such a message cannot
26086 affect the EHLO options that are listed on the second and subsequent lines of
26087 an EHLO response.
26088
26089
26090 .section "The DATA ACLs" "SECID193"
26091 .cindex "DATA" "ACLs for"
26092 Two ACLs are associated with the DATA command, because it is two-stage
26093 command, with two responses being sent to the client.
26094 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
26095 is obeyed. This gives you control after all the RCPT commands, but before
26096 the message itself is received. It offers the opportunity to give a negative
26097 response to the DATA command before the data is transmitted. Header lines
26098 added by MAIL or RCPT ACLs are not visible at this time, but any that
26099 are defined here are visible when the &%acl_smtp_data%& ACL is run.
26100
26101 You cannot test the contents of the message, for example, to verify addresses
26102 in the headers, at RCPT time or when the DATA command is received. Such
26103 tests have to appear in the ACL that is run after the message itself has been
26104 received, before the final response to the DATA command is sent. This is
26105 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
26106 associated with the DATA command.
26107
26108 For both of these ACLs, it is not possible to reject individual recipients. An
26109 error response rejects the entire message. Unfortunately, it is known that some
26110 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
26111 before or after the data) correctly &-- they keep the message on their queues
26112 and try again later, but that is their problem, though it does waste some of
26113 your resources.
26114
26115
26116 .section "The SMTP DKIM ACL" "SECTDKIMACL"
26117 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
26118 enabled (which is the default).
26119
26120 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
26121 received, and is executed for each DKIM signature found in a message.  If not
26122 otherwise specified, the default action is to accept.
26123
26124 For details on the operation of DKIM, see chapter &<<CHID12>>&.
26125
26126
26127 .section "The SMTP MIME ACL" "SECID194"
26128 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
26129 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26130
26131
26132 .section "The QUIT ACL" "SECTQUITACL"
26133 .cindex "QUIT, ACL for"
26134 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
26135 does not affect the response code to QUIT, which is always 221. Thus, the ACL
26136 does not in fact control any access. For this reason, the only verbs that are
26137 permitted are &%accept%& and &%warn%&.
26138
26139 This ACL can be used for tasks such as custom logging at the end of an SMTP
26140 session. For example, you can use ACL variables in other ACLs to count
26141 messages, recipients, etc., and log the totals at QUIT time using one or
26142 more &%logwrite%& modifiers on a &%warn%& verb.
26143
26144 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
26145 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
26146
26147 You do not need to have a final &%accept%&, but if you do, you can use a
26148 &%message%& modifier to specify custom text that is sent as part of the 221
26149 response to QUIT.
26150
26151 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
26152 failure (for example, failure to open a log file, or when Exim is bombing out
26153 because it has detected an unrecoverable error), all SMTP commands from the
26154 client are given temporary error responses until QUIT is received or the
26155 connection is closed. In these special cases, the QUIT ACL does not run.
26156
26157
26158 .section "The not-QUIT ACL" "SECTNOTQUITACL"
26159 .vindex &$acl_smtp_notquit$&
26160 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
26161 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
26162 trouble, such as being unable to write to its log files, this ACL is not run,
26163 because it might try to do things (such as write to log files) that make the
26164 situation even worse.
26165
26166 Like the QUIT ACL, this ACL is provided to make it possible to do customized
26167 logging or to gather statistics, and its outcome is ignored. The &%delay%&
26168 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
26169 and &%warn%&.
26170
26171 .vindex &$smtp_notquit_reason$&
26172 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
26173 to a string that indicates the reason for the termination of the SMTP
26174 connection. The possible values are:
26175 .table2
26176 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
26177 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
26178 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
26179 .irow &`connection-lost`&          "The SMTP connection has been lost"
26180 .irow &`data-timeout`&             "Timeout while reading message data"
26181 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
26182 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
26183 .irow &`signal-exit`&              "SIGTERM or SIGINT"
26184 .irow &`synchronization-error`&    "SMTP synchronization error"
26185 .irow &`tls-failed`&               "TLS failed to start"
26186 .endtable
26187 In most cases when an SMTP connection is closed without having received QUIT,
26188 Exim sends an SMTP response message before actually closing the connection.
26189 With the exception of the &`acl-drop`& case, the default message can be
26190 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
26191 &%drop%& verb in another ACL, it is the message from the other ACL that is
26192 used.
26193
26194
26195 .section "Finding an ACL to use" "SECID195"
26196 .cindex "&ACL;" "finding which to use"
26197 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
26198 you can use different ACLs in different circumstances. For example,
26199 .code
26200 acl_smtp_rcpt = ${if ={25}{$interface_port} \
26201                      {acl_check_rcpt} {acl_check_rcpt_submit} }
26202 .endd
26203 In the default configuration file there are some example settings for
26204 providing an RFC 4409 message submission service on port 587 and a
26205 non-standard &"smtps"& service on port 465. You can use a string
26206 expansion like this to choose an ACL for MUAs on these ports which is
26207 more appropriate for this purpose than the default ACL on port 25.
26208
26209 The expanded string does not have to be the name of an ACL in the
26210 configuration file; there are other possibilities. Having expanded the
26211 string, Exim searches for an ACL as follows:
26212
26213 .ilist
26214 If the string begins with a slash, Exim uses it as a file name, and reads its
26215 contents as an ACL. The lines are processed in the same way as lines in the
26216 Exim configuration file. In particular, continuation lines are supported, blank
26217 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
26218 If the file does not exist or cannot be read, an error occurs (typically
26219 causing a temporary failure of whatever caused the ACL to be run). For example:
26220 .code
26221 acl_smtp_data = /etc/acls/\
26222   ${lookup{$sender_host_address}lsearch\
26223   {/etc/acllist}{$value}{default}}
26224 .endd
26225 This looks up an ACL file to use on the basis of the host's IP address, falling
26226 back to a default if the lookup fails. If an ACL is successfully read from a
26227 file, it is retained in memory for the duration of the Exim process, so that it
26228 can be re-used without having to re-read the file.
26229 .next
26230 If the string does not start with a slash, and does not contain any spaces,
26231 Exim searches the ACL section of the configuration for an ACL whose name
26232 matches the string.
26233 .next
26234 If no named ACL is found, or if the string contains spaces, Exim parses
26235 the string as an inline ACL. This can save typing in cases where you just
26236 want to have something like
26237 .code
26238 acl_smtp_vrfy = accept
26239 .endd
26240 in order to allow free use of the VRFY command. Such a string may contain
26241 newlines; it is processed in the same way as an ACL that is read from a file.
26242 .endlist
26243
26244
26245
26246
26247 .section "ACL return codes" "SECID196"
26248 .cindex "&ACL;" "return codes"
26249 Except for the QUIT ACL, which does not affect the SMTP return code (see
26250 section &<<SECTQUITACL>>& above), the result of running an ACL is either
26251 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
26252 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
26253 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
26254 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
26255 This also causes a 4&'xx'& return code.
26256
26257 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
26258 &"deny"&, because there is no mechanism for passing temporary errors to the
26259 submitters of non-SMTP messages.
26260
26261
26262 ACLs that are relevant to message reception may also return &"discard"&. This
26263 has the effect of &"accept"&, but causes either the entire message or an
26264 individual recipient address to be discarded. In other words, it is a
26265 blackholing facility. Use it with care.
26266
26267 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
26268 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
26269 RCPT ACL is to discard just the one recipient address. If there are no
26270 recipients left when the message's data is received, the DATA ACL is not
26271 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
26272 remaining recipients. The &"discard"& return is not permitted for the
26273 &%acl_smtp_predata%& ACL.
26274
26275
26276 .cindex "&[local_scan()]& function" "when all recipients discarded"
26277 The &[local_scan()]& function is always run, even if there are no remaining
26278 recipients; it may create new recipients.
26279
26280
26281
26282 .section "Unset ACL options" "SECID197"
26283 .cindex "&ACL;" "unset options"
26284 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
26285 all the same. &*Note*&: These defaults apply only when the relevant ACL is
26286 not defined at all. For any defined ACL, the default action when control
26287 reaches the end of the ACL statements is &"deny"&.
26288
26289 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
26290 these two are ACLs that are used only for their side effects. They cannot be
26291 used to accept or reject anything.
26292
26293 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
26294 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
26295 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
26296 when the ACL is not defined is &"accept"&.
26297
26298 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
26299 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
26300 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
26301 messages over an SMTP connection. For an example, see the ACL in the default
26302 configuration file.
26303
26304
26305
26306
26307 .section "Data for message ACLs" "SECID198"
26308 .cindex "&ACL;" "data for message ACL"
26309 .vindex &$domain$&
26310 .vindex &$local_part$&
26311 .vindex &$sender_address$&
26312 .vindex &$sender_host_address$&
26313 .vindex &$smtp_command$&
26314 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
26315 that contain information about the host and the message's sender (for example,
26316 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
26317 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
26318 &$local_part$& are set from the argument address. The entire SMTP command
26319 is available in &$smtp_command$&.
26320
26321 When an ACL for the AUTH parameter of MAIL is running, the variables that
26322 contain information about the host are set, but &$sender_address$& is not yet
26323 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
26324 how it is used.
26325
26326 .vindex "&$message_size$&"
26327 The &$message_size$& variable is set to the value of the SIZE parameter on
26328 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
26329 that parameter is not given. The value is updated to the true message size by
26330 the time the final DATA ACL is run (after the message data has been
26331 received).
26332
26333 .vindex "&$rcpt_count$&"
26334 .vindex "&$recipients_count$&"
26335 The &$rcpt_count$& variable increases by one for each RCPT command received.
26336 The &$recipients_count$& variable increases by one each time a RCPT command is
26337 accepted, so while an ACL for RCPT is being processed, it contains the number
26338 of previously accepted recipients. At DATA time (for both the DATA ACLs),
26339 &$rcpt_count$& contains the total number of RCPT commands, and
26340 &$recipients_count$& contains the total number of accepted recipients.
26341
26342
26343
26344
26345
26346 .section "Data for non-message ACLs" "SECTdatfornon"
26347 .cindex "&ACL;" "data for non-message ACL"
26348 .vindex &$smtp_command_argument$&
26349 .vindex &$smtp_command$&
26350 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
26351 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
26352 and the entire SMTP command is available in &$smtp_command$&.
26353 These variables can be tested using a &%condition%& condition. For example,
26354 here is an ACL for use with AUTH, which insists that either the session is
26355 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
26356 does not permit authentication methods that use cleartext passwords on
26357 unencrypted connections.
26358 .code
26359 acl_check_auth:
26360   accept encrypted = *
26361   accept condition = ${if eq{${uc:$smtp_command_argument}}\
26362                      {CRAM-MD5}}
26363   deny   message   = TLS encryption or CRAM-MD5 required
26364 .endd
26365 (Another way of applying this restriction is to arrange for the authenticators
26366 that use cleartext passwords not to be advertised when the connection is not
26367 encrypted. You can use the generic &%server_advertise_condition%& authenticator
26368 option to do this.)
26369
26370
26371
26372 .section "Format of an ACL" "SECID199"
26373 .cindex "&ACL;" "format of"
26374 .cindex "&ACL;" "verbs, definition of"
26375 An individual ACL consists of a number of statements. Each statement starts
26376 with a verb, optionally followed by a number of conditions and &"modifiers"&.
26377 Modifiers can change the way the verb operates, define error and log messages,
26378 set variables, insert delays, and vary the processing of accepted messages.
26379
26380 If all the conditions are met, the verb is obeyed. The same condition may be
26381 used (with different arguments) more than once in the same statement. This
26382 provides a means of specifying an &"and"& conjunction between conditions. For
26383 example:
26384 .code
26385 deny  dnslists = list1.example
26386 dnslists = list2.example
26387 .endd
26388 If there are no conditions, the verb is always obeyed. Exim stops evaluating
26389 the conditions and modifiers when it reaches a condition that fails. What
26390 happens then depends on the verb (and in one case, on a special modifier). Not
26391 all the conditions make sense at every testing point. For example, you cannot
26392 test a sender address in the ACL that is run for a VRFY command.
26393
26394
26395 .section "ACL verbs" "SECID200"
26396 The ACL verbs are as follows:
26397
26398 .ilist
26399 .cindex "&%accept%& ACL verb"
26400 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
26401 of the conditions are not met, what happens depends on whether &%endpass%&
26402 appears among the conditions (for syntax see below). If the failing condition
26403 is before &%endpass%&, control is passed to the next ACL statement; if it is
26404 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
26405 check a RCPT command:
26406 .code
26407 accept domains = +local_domains
26408 endpass
26409 verify = recipient
26410 .endd
26411 If the recipient domain does not match the &%domains%& condition, control
26412 passes to the next statement. If it does match, the recipient is verified, and
26413 the command is accepted if verification succeeds. However, if verification
26414 fails, the ACL yields &"deny"&, because the failing condition is after
26415 &%endpass%&.
26416
26417 The &%endpass%& feature has turned out to be confusing to many people, so its
26418 use is not recommended nowadays. It is always possible to rewrite an ACL so
26419 that &%endpass%& is not needed, and it is no longer used in the default
26420 configuration.
26421
26422 .cindex "&%message%& ACL modifier" "with &%accept%&"
26423 If a &%message%& modifier appears on an &%accept%& statement, its action
26424 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
26425 (when an &%accept%& verb either accepts or passes control to the next
26426 statement), &%message%& can be used to vary the message that is sent when an
26427 SMTP command is accepted. For example, in a RCPT ACL you could have:
26428 .display
26429 &`accept  `&<&'some conditions'&>
26430 &`        message = OK, I will allow you through today`&
26431 .endd
26432 You can specify an SMTP response code, optionally followed by an &"extended
26433 response code"& at the start of the message, but the first digit must be the
26434 same as would be sent by default, which is 2 for an &%accept%& verb.
26435
26436 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
26437 an error message that is used when access is denied. This behaviour is retained
26438 for backward compatibility, but current &"best practice"& is to avoid the use
26439 of &%endpass%&.
26440
26441
26442 .next
26443 .cindex "&%defer%& ACL verb"
26444 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
26445 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
26446 &%defer%& is the same as &%deny%&, because there is no way of sending a
26447 temporary error. For a RCPT command, &%defer%& is much the same as using a
26448 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
26449 be used in any ACL, and even for a recipient it might be a simpler approach.
26450
26451
26452 .next
26453 .cindex "&%deny%& ACL verb"
26454 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
26455 the conditions are not met, control is passed to the next ACL statement. For
26456 example,
26457 .code
26458 deny dnslists = blackholes.mail-abuse.org
26459 .endd
26460 rejects commands from hosts that are on a DNS black list.
26461
26462
26463 .next
26464 .cindex "&%discard%& ACL verb"
26465 &%discard%&: This verb behaves like &%accept%&, except that it returns
26466 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
26467 that are concerned with receiving messages. When all the conditions are true,
26468 the sending entity receives a &"success"& response. However, &%discard%& causes
26469 recipients to be discarded. If it is used in an ACL for RCPT, just the one
26470 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
26471 message's recipients are discarded. Recipients that are discarded before DATA
26472 do not appear in the log line when the &%received_recipients%& log selector is set.
26473
26474 If the &%log_message%& modifier is set when &%discard%& operates,
26475 its contents are added to the line that is automatically written to the log.
26476 The &%message%& modifier operates exactly as it does for &%accept%&.
26477
26478
26479 .next
26480 .cindex "&%drop%& ACL verb"
26481 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
26482 forcibly closed after the 5&'xx'& error message has been sent. For example:
26483 .code
26484 drop   message   = I don't take more than 20 RCPTs
26485        condition = ${if > {$rcpt_count}{20}}
26486 .endd
26487 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
26488 The connection is always dropped after sending a 550 response.
26489
26490 .next
26491 .cindex "&%require%& ACL verb"
26492 &%require%&: If all the conditions are met, control is passed to the next ACL
26493 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
26494 example, when checking a RCPT command,
26495 .code
26496 require message = Sender did not verify
26497         verify  = sender
26498 .endd
26499 passes control to subsequent statements only if the message's sender can be
26500 verified. Otherwise, it rejects the command. Note the positioning of the
26501 &%message%& modifier, before the &%verify%& condition. The reason for this is
26502 discussed in section &<<SECTcondmodproc>>&.
26503
26504 .next
26505 .cindex "&%warn%& ACL verb"
26506 &%warn%&: If all the conditions are true, a line specified by the
26507 &%log_message%& modifier is written to Exim's main log. Control always passes
26508 to the next ACL statement. If any condition is false, the log line is not
26509 written. If an identical log line is requested several times in the same
26510 message, only one copy is actually written to the log. If you want to force
26511 duplicates to be written, use the &%logwrite%& modifier instead.
26512
26513 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
26514 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
26515 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
26516 first failing condition. There is more about adding header lines in section
26517 &<<SECTaddheadacl>>&.
26518
26519 If any condition on a &%warn%& statement cannot be completed (that is, there is
26520 some sort of defer), the log line specified by &%log_message%& is not written.
26521 This does not include the case of a forced failure from a lookup, which
26522 is considered to be a successful completion. After a defer, no further
26523 conditions or modifiers in the &%warn%& statement are processed. The incident
26524 is logged, and the ACL continues to be processed, from the next statement
26525 onwards.
26526
26527
26528 .vindex "&$acl_verify_message$&"
26529 When one of the &%warn%& conditions is an address verification that fails, the
26530 text of the verification failure message is in &$acl_verify_message$&. If you
26531 want this logged, you must set it up explicitly. For example:
26532 .code
26533 warn   !verify = sender
26534        log_message = sender verify failed: $acl_verify_message
26535 .endd
26536 .endlist
26537
26538 At the end of each ACL there is an implicit unconditional &%deny%&.
26539
26540 As you can see from the examples above, the conditions and modifiers are
26541 written one to a line, with the first one on the same line as the verb, and
26542 subsequent ones on following lines. If you have a very long condition, you can
26543 continue it onto several physical lines by the usual backslash continuation
26544 mechanism. It is conventional to align the conditions vertically.
26545
26546
26547
26548 .section "ACL variables" "SECTaclvariables"
26549 .cindex "&ACL;" "variables"
26550 There are some special variables that can be set during ACL processing. They
26551 can be used to pass information between different ACLs, different invocations
26552 of the same ACL in the same SMTP connection, and between ACLs and the routers,
26553 transports, and filters that are used to deliver a message. The names of these
26554 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
26555 an underscore, but the remainder of the name can be any sequence of
26556 alphanumeric characters and underscores that you choose. There is no limit on
26557 the number of ACL variables. The two sets act as follows:
26558 .ilist
26559 The values of those variables whose names begin with &$acl_c$& persist
26560 throughout an SMTP connection. They are never reset. Thus, a value that is set
26561 while receiving one message is still available when receiving the next message
26562 on the same SMTP connection.
26563 .next
26564 The values of those variables whose names begin with &$acl_m$& persist only
26565 while a message is being received. They are reset afterwards. They are also
26566 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
26567 .endlist
26568
26569 When a message is accepted, the current values of all the ACL variables are
26570 preserved with the message and are subsequently made available at delivery
26571 time. The ACL variables are set by a modifier called &%set%&. For example:
26572 .code
26573 accept hosts = whatever
26574        set acl_m4 = some value
26575 accept authenticated = *
26576        set acl_c_auth = yes
26577 .endd
26578 &*Note*&: A leading dollar sign is not used when naming a variable that is to
26579 be set. If you want to set a variable without taking any action, you can use a
26580 &%warn%& verb without any other modifiers or conditions.
26581
26582 .oindex &%strict_acl_vars%&
26583 What happens if a syntactically valid but undefined ACL variable is
26584 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
26585 false (the default), an empty string is substituted; if it is true, an
26586 error is generated.
26587
26588 Versions of Exim before 4.64 have a limited set of numbered variables, but
26589 their names are compatible, so there is no problem with upgrading.
26590
26591
26592 .section "Condition and modifier processing" "SECTcondmodproc"
26593 .cindex "&ACL;" "conditions; processing"
26594 .cindex "&ACL;" "modifiers; processing"
26595 An exclamation mark preceding a condition negates its result. For example:
26596 .code
26597 deny   domains = *.dom.example
26598       !verify  = recipient
26599 .endd
26600 causes the ACL to return &"deny"& if the recipient domain ends in
26601 &'dom.example'& and the recipient address cannot be verified. Sometimes
26602 negation can be used on the right-hand side of a condition. For example, these
26603 two statements are equivalent:
26604 .code
26605 deny  hosts = !192.168.3.4
26606 deny !hosts =  192.168.3.4
26607 .endd
26608 However, for many conditions (&%verify%& being a good example), only left-hand
26609 side negation of the whole condition is possible.
26610
26611 The arguments of conditions and modifiers are expanded. A forced failure
26612 of an expansion causes a condition to be ignored, that is, it behaves as if the
26613 condition is true. Consider these two statements:
26614 .code
26615 accept  senders = ${lookup{$host_name}lsearch\
26616                   {/some/file}{$value}fail}
26617 accept  senders = ${lookup{$host_name}lsearch\
26618                   {/some/file}{$value}{}}
26619 .endd
26620 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
26621 the returned list is searched, but if the lookup fails the behaviour is
26622 different in the two cases. The &%fail%& in the first statement causes the
26623 condition to be ignored, leaving no further conditions. The &%accept%& verb
26624 therefore succeeds. The second statement, however, generates an empty list when
26625 the lookup fails. No sender can match an empty list, so the condition fails,
26626 and therefore the &%accept%& also fails.
26627
26628 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
26629 specify actions that are taken as the conditions for a statement are checked;
26630 others specify text for messages that are used when access is denied or a
26631 warning is generated. The &%control%& modifier affects the way an incoming
26632 message is handled.
26633
26634 The positioning of the modifiers in an ACL statement is important, because the
26635 processing of a verb ceases as soon as its outcome is known. Only those
26636 modifiers that have already been encountered will take effect. For example,
26637 consider this use of the &%message%& modifier:
26638 .code
26639 require message = Can't verify sender
26640         verify  = sender
26641         message = Can't verify recipient
26642         verify  = recipient
26643         message = This message cannot be used
26644 .endd
26645 If sender verification fails, Exim knows that the result of the statement is
26646 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
26647 so its text is used as the error message. If sender verification succeeds, but
26648 recipient verification fails, the second message is used. If recipient
26649 verification succeeds, the third message becomes &"current"&, but is never used
26650 because there are no more conditions to cause failure.
26651
26652 For the &%deny%& verb, on the other hand, it is always the last &%message%&
26653 modifier that is used, because all the conditions must be true for rejection to
26654 happen. Specifying more than one &%message%& modifier does not make sense, and
26655 the message can even be specified after all the conditions. For example:
26656 .code
26657 deny   hosts = ...
26658       !senders = *@my.domain.example
26659        message = Invalid sender from client host
26660 .endd
26661 The &"deny"& result does not happen until the end of the statement is reached,
26662 by which time Exim has set up the message.
26663
26664
26665
26666 .section "ACL modifiers" "SECTACLmodi"
26667 .cindex "&ACL;" "modifiers; list of"
26668 The ACL modifiers are as follows:
26669
26670 .vlist
26671 .vitem &*add_header*&&~=&~<&'text'&>
26672 This modifier specifies one or more header lines that are to be added to an
26673 incoming message, assuming, of course, that the message is ultimately
26674 accepted. For details, see section &<<SECTaddheadacl>>&.
26675
26676 .vitem &*continue*&&~=&~<&'text'&>
26677 .cindex "&%continue%& ACL modifier"
26678 .cindex "database" "updating in ACL"
26679 This modifier does nothing of itself, and processing of the ACL always
26680 continues with the next condition or modifier. The value of &%continue%& is in
26681 the side effects of expanding its argument. Typically this could be used to
26682 update a database. It is really just a syntactic tidiness, to avoid having to
26683 write rather ugly lines like this:
26684 .display
26685 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
26686 .endd
26687 Instead, all you need is
26688 .display
26689 &`continue = `&<&'some expansion'&>
26690 .endd
26691
26692 .vitem &*control*&&~=&~<&'text'&>
26693 .cindex "&%control%& ACL modifier"
26694 This modifier affects the subsequent processing of the SMTP connection or of an
26695 incoming message that is accepted. The effect of the first type of control
26696 lasts for the duration of the connection, whereas the effect of the second type
26697 lasts only until the current message has been received. The message-specific
26698 controls always apply to the whole message, not to individual recipients,
26699 even if the &%control%& modifier appears in a RCPT ACL.
26700
26701 As there are now quite a few controls that can be applied, they are described
26702 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
26703 in several different ways. For example:
26704
26705 . ==== As this is a nested list, any displays it contains must be indented
26706 . ==== as otherwise they are too far to the left. That comment applies only
26707 . ==== when xmlto and fop are used; formatting with sdop gets it right either
26708 . ==== way.
26709
26710 .ilist
26711 It can be at the end of an &%accept%& statement:
26712 .code
26713     accept  ...some conditions
26714             control = queue_only
26715 .endd
26716 In this case, the control is applied when this statement yields &"accept"&, in
26717 other words, when the conditions are all true.
26718
26719 .next
26720 It can be in the middle of an &%accept%& statement:
26721 .code
26722     accept  ...some conditions...
26723             control = queue_only
26724             ...some more conditions...
26725 .endd
26726 If the first set of conditions are true, the control is applied, even if the
26727 statement does not accept because one of the second set of conditions is false.
26728 In this case, some subsequent statement must yield &"accept"& for the control
26729 to be relevant.
26730
26731 .next
26732 It can be used with &%warn%& to apply the control, leaving the
26733 decision about accepting or denying to a subsequent verb. For
26734 example:
26735 .code
26736     warn    ...some conditions...
26737             control = freeze
26738     accept  ...
26739 .endd
26740 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
26741 &%logwrite%&, so it does not add anything to the message and does not write a
26742 log entry.
26743
26744 .next
26745 If you want to apply a control unconditionally, you can use it with a
26746 &%require%& verb. For example:
26747 .code
26748     require  control = no_multiline_responses
26749 .endd
26750 .endlist
26751
26752 .vitem &*delay*&&~=&~<&'time'&>
26753 .cindex "&%delay%& ACL modifier"
26754 .oindex "&%-bh%&"
26755 This modifier may appear in any ACL except notquit. It causes Exim to wait for
26756 the time interval before proceeding. However, when testing Exim using the
26757 &%-bh%& option, the delay is not actually imposed (an appropriate message is
26758 output instead). The time is given in the usual Exim notation, and the delay
26759 happens as soon as the modifier is processed. In an SMTP session, pending
26760 output is flushed before the delay is imposed.
26761
26762 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
26763 example:
26764 .code
26765 deny    ...some conditions...
26766         delay = 30s
26767 .endd
26768 The delay happens if all the conditions are true, before the statement returns
26769 &"deny"&. Compare this with:
26770 .code
26771 deny    delay = 30s
26772         ...some conditions...
26773 .endd
26774 which waits for 30s before processing the conditions. The &%delay%& modifier
26775 can also be used with &%warn%& and together with &%control%&:
26776 .code
26777 warn    ...some conditions...
26778         delay = 2m
26779         control = freeze
26780 accept  ...
26781 .endd
26782
26783 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
26784 responses to several commands are no longer buffered and sent in one packet (as
26785 they would normally be) because all output is flushed before imposing the
26786 delay. This optimization is disabled so that a number of small delays do not
26787 appear to the client as one large aggregated delay that might provoke an
26788 unwanted timeout. You can, however, disable output flushing for &%delay%& by
26789 using a &%control%& modifier to set &%no_delay_flush%&.
26790
26791
26792 .vitem &*endpass*&
26793 .cindex "&%endpass%& ACL modifier"
26794 This modifier, which has no argument, is recognized only in &%accept%& and
26795 &%discard%& statements. It marks the boundary between the conditions whose
26796 failure causes control to pass to the next statement, and the conditions whose
26797 failure causes the ACL to return &"deny"&. This concept has proved to be
26798 confusing to some people, so the use of &%endpass%& is no longer recommended as
26799 &"best practice"&. See the description of &%accept%& above for more details.
26800
26801
26802 .vitem &*log_message*&&~=&~<&'text'&>
26803 .cindex "&%log_message%& ACL modifier"
26804 This modifier sets up a message that is used as part of the log message if the
26805 ACL denies access or a &%warn%& statement's conditions are true. For example:
26806 .code
26807 require log_message = wrong cipher suite $tls_in_cipher
26808         encrypted   = DES-CBC3-SHA
26809 .endd
26810 &%log_message%& is also used when recipients are discarded by &%discard%&. For
26811 example:
26812 .display
26813 &`discard `&<&'some conditions'&>
26814 &`        log_message = Discarded $local_part@$domain because...`&
26815 .endd
26816 When access is denied, &%log_message%& adds to any underlying error message
26817 that may exist because of a condition failure. For example, while verifying a
26818 recipient address, a &':fail:'& redirection might have already set up a
26819 message.
26820
26821 The message may be defined before the conditions to which it applies, because
26822 the string expansion does not happen until Exim decides that access is to be
26823 denied. This means that any variables that are set by the condition are
26824 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
26825 variables are set after a DNS black list lookup succeeds. If the expansion of
26826 &%log_message%& fails, or if the result is an empty string, the modifier is
26827 ignored.
26828
26829 .vindex "&$acl_verify_message$&"
26830 If you want to use a &%warn%& statement to log the result of an address
26831 verification, you can use &$acl_verify_message$& to include the verification
26832 error message.
26833
26834 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
26835 the start of the logged message. If the same warning log message is requested
26836 more than once while receiving  a single email message, only one copy is
26837 actually logged. If you want to log multiple copies, use &%logwrite%& instead
26838 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
26839 is logged for a successful &%warn%& statement.
26840
26841 If &%log_message%& is not present and there is no underlying error message (for
26842 example, from the failure of address verification), but &%message%& is present,
26843 the &%message%& text is used for logging rejections. However, if any text for
26844 logging contains newlines, only the first line is logged. In the absence of
26845 both &%log_message%& and &%message%&, a default built-in message is used for
26846 logging rejections.
26847
26848
26849 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
26850 .cindex "&%log_reject_target%& ACL modifier"
26851 .cindex "logging in ACL" "specifying which log"
26852 This modifier makes it possible to specify which logs are used for messages
26853 about ACL rejections. Its argument is a colon-separated list of words that can
26854 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
26855 may be empty, in which case a rejection is not logged at all. For example, this
26856 ACL fragment writes no logging information when access is denied:
26857 .display
26858 &`deny `&<&'some conditions'&>
26859 &`     log_reject_target =`&
26860 .endd
26861 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
26862 permanent and temporary rejections. Its effect lasts for the rest of the
26863 current ACL.
26864
26865
26866 .vitem &*logwrite*&&~=&~<&'text'&>
26867 .cindex "&%logwrite%& ACL modifier"
26868 .cindex "logging in ACL" "immediate"
26869 This modifier writes a message to a log file as soon as it is encountered when
26870 processing an ACL. (Compare &%log_message%&, which, except in the case of
26871 &%warn%& and &%discard%&, is used only if the ACL statement denies
26872 access.) The &%logwrite%& modifier can be used to log special incidents in
26873 ACLs. For example:
26874 .display
26875 &`accept `&<&'some special conditions'&>
26876 &`       control  = freeze`&
26877 &`       logwrite = froze message because ...`&
26878 .endd
26879 By default, the message is written to the main log. However, it may begin
26880 with a colon, followed by a comma-separated list of log names, and then
26881 another colon, to specify exactly which logs are to be written. For
26882 example:
26883 .code
26884 logwrite = :main,reject: text for main and reject logs
26885 logwrite = :panic: text for panic log only
26886 .endd
26887
26888
26889 .vitem &*message*&&~=&~<&'text'&>
26890 .cindex "&%message%& ACL modifier"
26891 This modifier sets up a text string that is expanded and used as a response
26892 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
26893 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
26894 there is some complication if &%endpass%& is involved; see the description of
26895 &%accept%& for details.)
26896
26897 The expansion of the message happens at the time Exim decides that the ACL is
26898 to end, not at the time it processes &%message%&. If the expansion fails, or
26899 generates an empty string, the modifier is ignored. Here is an example where
26900 &%message%& must be specified first, because the ACL ends with a rejection if
26901 the &%hosts%& condition fails:
26902 .code
26903 require  message = Host not recognized
26904          hosts = 10.0.0.0/8
26905 .endd
26906 (Once a condition has failed, no further conditions or modifiers are
26907 processed.)
26908
26909 .cindex "SMTP" "error codes"
26910 .oindex "&%smtp_banner%&
26911 For ACLs that are triggered by SMTP commands, the message is returned as part
26912 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
26913 is meaningful only for SMTP, as no message is returned when a non-SMTP message
26914 is accepted. In the case of the connect ACL, accepting with a message modifier
26915 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
26916 accept message may not contain more than one line (otherwise it will be
26917 truncated at the first newline and a panic logged), and it cannot affect the
26918 EHLO options.
26919
26920 When SMTP is involved, the message may begin with an overriding response code,
26921 consisting of three digits optionally followed by an &"extended response code"&
26922 of the form &'n.n.n'&, each code being followed by a space. For example:
26923 .code
26924 deny  message = 599 1.2.3 Host not welcome
26925       hosts = 192.168.34.0/24
26926 .endd
26927 The first digit of the supplied response code must be the same as would be sent
26928 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
26929 access, but for the predata ACL, note that the default success code is 354, not
26930 2&'xx'&.
26931
26932 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
26933 the message modifier cannot override the 221 response code.
26934
26935 The text in a &%message%& modifier is literal; any quotes are taken as
26936 literals, but because the string is expanded, backslash escapes are processed
26937 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
26938 response.
26939
26940 .vindex "&$acl_verify_message$&"
26941 If &%message%& is used on a statement that verifies an address, the message
26942 specified overrides any message that is generated by the verification process.
26943 However, the original message is available in the variable
26944 &$acl_verify_message$&, so you can incorporate it into your message if you
26945 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
26946 routers to be passed back as part of the SMTP response, you should either not
26947 use a &%message%& modifier, or make use of &$acl_verify_message$&.
26948
26949 For compatibility with previous releases of Exim, a &%message%& modifier that
26950 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
26951 modifier, but this usage is now deprecated. However, &%message%& acts only when
26952 all the conditions are true, wherever it appears in an ACL command, whereas
26953 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
26954 &%warn%& in an ACL that is not concerned with receiving a message, it has no
26955 effect.
26956
26957
26958 .vitem &*remove_header*&&~=&~<&'text'&>
26959 This modifier specifies one or more header names in a colon-separated list
26960  that are to be removed from an incoming message, assuming, of course, that
26961 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
26962
26963
26964 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
26965 .cindex "&%set%& ACL modifier"
26966 This modifier puts a value into one of the ACL variables (see section
26967 &<<SECTaclvariables>>&).
26968 .endlist
26969
26970
26971
26972
26973
26974 .section "Use of the control modifier" "SECTcontrols"
26975 .cindex "&%control%& ACL modifier"
26976 The &%control%& modifier supports the following settings:
26977
26978 .vlist
26979 .vitem &*control&~=&~allow_auth_unadvertised*&
26980 This modifier allows a client host to use the SMTP AUTH command even when it
26981 has not been advertised in response to EHLO. Furthermore, because there are
26982 apparently some really broken clients that do this, Exim will accept AUTH after
26983 HELO (rather than EHLO) when this control is set. It should be used only if you
26984 really need it, and you should limit its use to those broken clients that do
26985 not work without it. For example:
26986 .code
26987 warn hosts   = 192.168.34.25
26988      control = allow_auth_unadvertised
26989 .endd
26990 Normally, when an Exim server receives an AUTH command, it checks the name of
26991 the authentication mechanism that is given in the command to ensure that it
26992 matches an advertised mechanism. When this control is set, the check that a
26993 mechanism has been advertised is bypassed. Any configured mechanism can be used
26994 by the client. This control is permitted only in the connection and HELO ACLs.
26995
26996
26997 .vitem &*control&~=&~caseful_local_part*& &&&
26998        &*control&~=&~caselower_local_part*&
26999 .cindex "&ACL;" "case of local part in"
27000 .cindex "case of local parts"
27001 .vindex "&$local_part$&"
27002 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
27003 (that is, during RCPT processing). By default, the contents of &$local_part$&
27004 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
27005 any uppercase letters in the original local part are restored in &$local_part$&
27006 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
27007 is encountered.
27008
27009 These controls affect only the current recipient. Moreover, they apply only to
27010 local part handling that takes place directly in the ACL (for example, as a key
27011 in lookups). If a test to verify the recipient is obeyed, the case-related
27012 handling of the local part during the verification is controlled by the router
27013 configuration (see the &%caseful_local_part%& generic router option).
27014
27015 This facility could be used, for example, to add a spam score to local parts
27016 containing upper case letters. For example, using &$acl_m4$& to accumulate the
27017 spam score:
27018 .code
27019 warn  control = caseful_local_part
27020       set acl_m4 = ${eval:\
27021                      $acl_m4 + \
27022                      ${if match{$local_part}{[A-Z]}{1}{0}}\
27023                     }
27024       control = caselower_local_part
27025 .endd
27026 Notice that we put back the lower cased version afterwards, assuming that
27027 is what is wanted for subsequent tests.
27028
27029
27030 .new
27031 .vitem &*control&~=&~cutthrough_delivery*&
27032 .cindex "&ACL;" "cutthrough routing"
27033 This option requests delivery be attempted while the item is being received.
27034 It is usable in the RCPT ACL and valid only for single-recipient mails forwarded
27035 from one SMTP connection to another.  If a recipient-verify callout connection is
27036 requested in the same ACL it is held open and used for the data, otherwise one is made
27037 after the ACL completes.
27038
27039 Should the ultimate destination system positively accept or reject the mail,
27040 a corresponding indication is given to the source system and nothing is queued.
27041 If there is a temporary error the item is queued for later delivery in the
27042 usual fashion. If the item is successfully delivered in cutthrough mode the log line
27043 is tagged with ">>" rather than "=>" and appears before the acceptance "<="
27044 line.
27045
27046 Delivery in this mode avoids the generation of a bounce mail to a (possibly faked)
27047 sender when the destination system is doing content-scan based rejection.
27048 .wen
27049
27050
27051 .new
27052 .vitem &*control&~=&~debug/*&<&'options'&>
27053 .cindex "&ACL;" "enabling debug logging"
27054 .cindex "debugging" "enabling from an ACL"
27055 This control turns on debug logging, almost as though Exim had been invoked
27056 with &`-d`&, with the output going to a new logfile, by default called
27057 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
27058 may access any variables already defined.  The logging may be adjusted with
27059 the &'opts'& option, which takes the same values as the &`-d`& command-line
27060 option.  Some examples (which depend on variables that don't exist in all
27061 contexts):
27062 .code
27063       control = debug
27064       control = debug/tag=.$sender_host_address
27065       control = debug/opts=+expand+acl
27066       control = debug/tag=.$message_exim_id/opts=+expand
27067 .endd
27068 .wen
27069
27070
27071 .new
27072 .vitem &*control&~=&~dkim_disable_verify*&
27073 .cindex "disable DKIM verify"
27074 .cindex "DKIM" "disable verify"
27075 This control turns off DKIM verification processing entirely.  For details on
27076 the operation and configuration of DKIM, see chapter &<<CHID12>>&.
27077 .wen
27078
27079
27080 .new
27081 .vitem &*control&~=&~dscp/*&<&'value'&>
27082 .cindex "&ACL;" "setting DSCP value"
27083 .cindex "DSCP" "inbound"
27084 This option causes the DSCP value associated with the socket for the inbound
27085 connection to be adjusted to a given value, given as one of a number of fixed
27086 strings or to numeric value.
27087 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
27088 Common values include &`throughput`&, &`mincost`&, and on newer systems
27089 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
27090
27091 The outbound packets from Exim will be marked with this value in the header
27092 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
27093 that these values will have any effect, not be stripped by networking
27094 equipment, or do much of anything without cooperation with your Network
27095 Engineer and those of all network operators between the source and destination.
27096 .wen
27097
27098
27099 .vitem &*control&~=&~enforce_sync*& &&&
27100        &*control&~=&~no_enforce_sync*&
27101 .cindex "SMTP" "synchronization checking"
27102 .cindex "synchronization checking in SMTP"
27103 These controls make it possible to be selective about when SMTP synchronization
27104 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
27105 state of the switch (it is true by default). See the description of this option
27106 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
27107
27108 The effect of these two controls lasts for the remainder of the SMTP
27109 connection. They can appear in any ACL except the one for the non-SMTP
27110 messages. The most straightforward place to put them is in the ACL defined by
27111 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
27112 before the first synchronization check. The expected use is to turn off the
27113 synchronization checks for badly-behaved hosts that you nevertheless need to
27114 work with.
27115
27116
27117 .vitem &*control&~=&~fakedefer/*&<&'message'&>
27118 .cindex "fake defer"
27119 .cindex "defer, fake"
27120 This control works in exactly the same way as &%fakereject%& (described below)
27121 except that it causes an SMTP 450 response after the message data instead of a
27122 550 response. You must take care when using &%fakedefer%& because it causes the
27123 messages to be duplicated when the sender retries. Therefore, you should not
27124 use &%fakedefer%& if the message is to be delivered normally.
27125
27126 .vitem &*control&~=&~fakereject/*&<&'message'&>
27127 .cindex "fake rejection"
27128 .cindex "rejection, fake"
27129 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
27130 words, only when an SMTP message is being received. If Exim accepts the
27131 message, instead the final 250 response, a 550 rejection message is sent.
27132 However, Exim proceeds to deliver the message as normal. The control applies
27133 only to the current message, not to any subsequent ones that may be received in
27134 the same SMTP connection.
27135
27136 The text for the 550 response is taken from the &%control%& modifier. If no
27137 message is supplied, the following is used:
27138 .code
27139 550-Your message has been rejected but is being
27140 550-kept for evaluation.
27141 550-If it was a legitimate message, it may still be
27142 550 delivered to the target recipient(s).
27143 .endd
27144 This facility should be used with extreme caution.
27145
27146 .vitem &*control&~=&~freeze*&
27147 .cindex "frozen messages" "forcing in ACL"
27148 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27149 other words, only when a message is being received. If the message is accepted,
27150 it is placed on Exim's queue and frozen. The control applies only to the
27151 current message, not to any subsequent ones that may be received in the same
27152 SMTP connection.
27153
27154 This modifier can optionally be followed by &`/no_tell`&. If the global option
27155 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
27156 is told about the freezing), provided all the &*control=freeze*& modifiers that
27157 are obeyed for the current message have the &`/no_tell`& option.
27158
27159 .vitem &*control&~=&~no_delay_flush*&
27160 .cindex "SMTP" "output flushing, disabling for delay"
27161 Exim normally flushes SMTP output before implementing a delay in an ACL, to
27162 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27163 use. This control, as long as it is encountered before the &%delay%& modifier,
27164 disables such output flushing.
27165
27166 .vitem &*control&~=&~no_callout_flush*&
27167 .cindex "SMTP" "output flushing, disabling for callout"
27168 Exim normally flushes SMTP output before performing a callout in an ACL, to
27169 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27170 use. This control, as long as it is encountered before the &%verify%& condition
27171 that causes the callout, disables such output flushing.
27172
27173 .vitem &*control&~=&~no_mbox_unspool*&
27174 This control is available when Exim is compiled with the content scanning
27175 extension. Content scanning may require a copy of the current message, or parts
27176 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
27177 or spam scanner. Normally, such copies are deleted when they are no longer
27178 needed. If this control is set, the copies are not deleted. The control applies
27179 only to the current message, not to any subsequent ones that may be received in
27180 the same SMTP connection. It is provided for debugging purposes and is unlikely
27181 to be useful in production.
27182
27183 .vitem &*control&~=&~no_multiline_responses*&
27184 .cindex "multiline responses, suppressing"
27185 This control is permitted for any ACL except the one for non-SMTP messages.
27186 It seems that there are broken clients in use that cannot handle multiline
27187 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
27188
27189 If this control is set, multiline SMTP responses from ACL rejections are
27190 suppressed. One way of doing this would have been to put out these responses as
27191 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
27192 (&"use multiline responses for more"& it says &-- ha!), and some of the
27193 responses might get close to that. So this facility, which is after all only a
27194 sop to broken clients, is implemented by doing two very easy things:
27195
27196 .ilist
27197 Extra information that is normally output as part of a rejection caused by
27198 sender verification failure is omitted. Only the final line (typically &"sender
27199 verification failed"&) is sent.
27200 .next
27201 If a &%message%& modifier supplies a multiline response, only the first
27202 line is output.
27203 .endlist
27204
27205 The setting of the switch can, of course, be made conditional on the
27206 calling host. Its effect lasts until the end of the SMTP connection.
27207
27208 .vitem &*control&~=&~no_pipelining*&
27209 .cindex "PIPELINING" "suppressing advertising"
27210 This control turns off the advertising of the PIPELINING extension to SMTP in
27211 the current session. To be useful, it must be obeyed before Exim sends its
27212 response to an EHLO command. Therefore, it should normally appear in an ACL
27213 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
27214 &%pipelining_advertise_hosts%&.
27215
27216 .vitem &*control&~=&~queue_only*&
27217 .oindex "&%queue_only%&"
27218 .cindex "queueing incoming messages"
27219 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27220 other words, only when a message is being received. If the message is accepted,
27221 it is placed on Exim's queue and left there for delivery by a subsequent queue
27222 runner. No immediate delivery process is started. In other words, it has the
27223 effect as the &%queue_only%& global option. However, the control applies only
27224 to the current message, not to any subsequent ones that may be received in the
27225 same SMTP connection.
27226
27227 .vitem &*control&~=&~submission/*&<&'options'&>
27228 .cindex "message" "submission"
27229 .cindex "submission mode"
27230 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
27231 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
27232 the current message is a submission from a local MUA. In this case, Exim
27233 operates in &"submission mode"&, and applies certain fixups to the message if
27234 necessary. For example, it adds a &'Date:'& header line if one is not present.
27235 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
27236 late (the message has already been created).
27237
27238 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
27239 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
27240 submission mode; the available options for this control are described there.
27241 The control applies only to the current message, not to any subsequent ones
27242 that may be received in the same SMTP connection.
27243
27244 .vitem &*control&~=&~suppress_local_fixups*&
27245 .cindex "submission fixups, suppressing"
27246 This control applies to locally submitted (non TCP/IP) messages, and is the
27247 complement of &`control = submission`&. It disables the fixups that are
27248 normally applied to locally-submitted messages. Specifically:
27249
27250 .ilist
27251 Any &'Sender:'& header line is left alone (in this respect, it is a
27252 dynamic version of &%local_sender_retain%&).
27253 .next
27254 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
27255 .next
27256 There is no check that &'From:'& corresponds to the actual sender.
27257 .endlist ilist
27258
27259 This control may be useful when a remotely-originated message is accepted,
27260 passed to some scanning program, and then re-submitted for delivery. It can be
27261 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
27262 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
27263 data is read.
27264
27265 &*Note:*& This control applies only to the current message, not to any others
27266 that are being submitted at the same time using &%-bs%& or &%-bS%&.
27267 .endlist vlist
27268
27269
27270 .section "Summary of message fixup control" "SECTsummesfix"
27271 All four possibilities for message fixups can be specified:
27272
27273 .ilist
27274 Locally submitted, fixups applied: the default.
27275 .next
27276 Locally submitted, no fixups applied: use
27277 &`control = suppress_local_fixups`&.
27278 .next
27279 Remotely submitted, no fixups applied: the default.
27280 .next
27281 Remotely submitted, fixups applied: use &`control = submission`&.
27282 .endlist
27283
27284
27285
27286 .section "Adding header lines in ACLs" "SECTaddheadacl"
27287 .cindex "header lines" "adding in an ACL"
27288 .cindex "header lines" "position of added lines"
27289 .cindex "&%add_header%& ACL modifier"
27290 The &%add_header%& modifier can be used to add one or more extra header lines
27291 to an incoming message, as in this example:
27292 .code
27293 warn dnslists = sbl.spamhaus.org : \
27294                 dialup.mail-abuse.org
27295      add_header = X-blacklisted-at: $dnslist_domain
27296 .endd
27297 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
27298 MIME, and non-SMTP ACLs (in other words, those that are concerned with
27299 receiving a message). The message must ultimately be accepted for
27300 &%add_header%& to have any significant effect. You can use &%add_header%& with
27301 any ACL verb, including &%deny%& (though this is potentially useful only in a
27302 RCPT ACL).
27303
27304 If the data for the &%add_header%& modifier contains one or more newlines that
27305 are not followed by a space or a tab, it is assumed to contain multiple header
27306 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
27307 front of any line that is not a valid header line.
27308
27309 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
27310 They are added to the message before processing the DATA and MIME ACLs.
27311 However, if an identical header line is requested more than once, only one copy
27312 is actually added to the message. Further header lines may be accumulated
27313 during the DATA and MIME ACLs, after which they are added to the message, again
27314 with duplicates suppressed. Thus, it is possible to add two identical header
27315 lines to an SMTP message, but only if one is added before DATA and one after.
27316 In the case of non-SMTP messages, new headers are accumulated during the
27317 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
27318 message is rejected after DATA or by the non-SMTP ACL, all added header lines
27319 are included in the entry that is written to the reject log.
27320
27321 .cindex "header lines" "added; visibility of"
27322 Header lines are not visible in string expansions until they are added to the
27323 message. It follows that header lines defined in the MAIL, RCPT, and predata
27324 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
27325 header lines that are added by the DATA or MIME ACLs are not visible in those
27326 ACLs. Because of this restriction, you cannot use header lines as a way of
27327 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
27328 this, you can use ACL variables, as described in section
27329 &<<SECTaclvariables>>&.
27330
27331 The &%add_header%& modifier acts immediately as it is encountered during the
27332 processing of an ACL. Notice the difference between these two cases:
27333 .display
27334 &`accept add_header = ADDED: some text`&
27335 &`       `&<&'some condition'&>
27336
27337 &`accept `&<&'some condition'&>
27338 &`       add_header = ADDED: some text`&
27339 .endd
27340 In the first case, the header line is always added, whether or not the
27341 condition is true. In the second case, the header line is added only if the
27342 condition is true. Multiple occurrences of &%add_header%& may occur in the same
27343 ACL statement. All those that are encountered before a condition fails are
27344 honoured.
27345
27346 .cindex "&%warn%& ACL verb"
27347 For compatibility with previous versions of Exim, a &%message%& modifier for a
27348 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
27349 effect only if all the conditions are true, even if it appears before some of
27350 them. Furthermore, only the last occurrence of &%message%& is honoured. This
27351 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
27352 are present on a &%warn%& verb, both are processed according to their
27353 specifications.
27354
27355 By default, new header lines are added to a message at the end of the existing
27356 header lines. However, you can specify that any particular header line should
27357 be added right at the start (before all the &'Received:'& lines), immediately
27358 after the first block of &'Received:'& lines, or immediately before any line
27359 that is not a &'Received:'& or &'Resent-something:'& header.
27360
27361 This is done by specifying &":at_start:"&, &":after_received:"&, or
27362 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
27363 header line, respectively. (Header text cannot start with a colon, as there has
27364 to be a header name first.) For example:
27365 .code
27366 warn add_header = \
27367        :after_received:X-My-Header: something or other...
27368 .endd
27369 If more than one header line is supplied in a single &%add_header%& modifier,
27370 each one is treated independently and can therefore be placed differently. If
27371 you add more than one line at the start, or after the Received: block, they end
27372 up in reverse order.
27373
27374 &*Warning*&: This facility currently applies only to header lines that are
27375 added in an ACL. It does NOT work for header lines that are added in a
27376 system filter or in a router or transport.
27377
27378
27379
27380 .section "Removing header lines in ACLs" "SECTremoveheadacl"
27381 .cindex "header lines" "removing in an ACL"
27382 .cindex "header lines" "position of removed lines"
27383 .cindex "&%remove_header%& ACL modifier"
27384 The &%remove_header%& modifier can be used to remove one or more header lines
27385 from an incoming message, as in this example:
27386 .code
27387 warn   message        = Remove internal headers
27388        remove_header  = x-route-mail1 : x-route-mail2
27389 .endd
27390 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
27391 MIME, and non-SMTP ACLs (in other words, those that are concerned with
27392 receiving a message). The message must ultimately be accepted for
27393 &%remove_header%& to have any significant effect. You can use &%remove_header%&
27394 with any ACL verb, including &%deny%&, though this is really not useful for
27395 any verb that doesn't result in a delivered message.
27396
27397 More than one header can be removed at the same time by using a colon separated
27398 list of header names. The header matching is case insensitive. Wildcards are
27399 not permitted, nor is list expansion performed, so you cannot use hostlists to
27400 create a list of headers, however both connection and message variable expansion
27401 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
27402 .code
27403 warn   hosts           = +internal_hosts
27404        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
27405 warn   message         = Remove internal headers
27406        remove_header   = $acl_c_ihdrs
27407 .endd
27408 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
27409 They are removed from the message before processing the DATA and MIME ACLs.
27410 There is no harm in attempting to remove the same header twice nor is removing
27411 a non-existent header. Further header lines to be removed may be accumulated
27412 during the DATA and MIME ACLs, after which they are removed from the message,
27413 if present. In the case of non-SMTP messages, headers to be removed are
27414 accumulated during the non-SMTP ACLs, and are removed from the message after
27415 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
27416 ACL, there really is no effect because there is no logging of what headers
27417 would have been removed.
27418
27419 .cindex "header lines" "removed; visibility of"
27420 Header lines are not visible in string expansions until the DATA phase when it
27421 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
27422 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
27423 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
27424 this restriction, you cannot use header lines as a way of controlling data
27425 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
27426 you should instead use ACL variables, as described in section
27427 &<<SECTaclvariables>>&.
27428
27429 The &%remove_header%& modifier acts immediately as it is encountered during the
27430 processing of an ACL. Notice the difference between these two cases:
27431 .display
27432 &`accept remove_header = X-Internal`&
27433 &`       `&<&'some condition'&>
27434
27435 &`accept `&<&'some condition'&>
27436 &`       remove_header = X-Internal`&
27437 .endd
27438 In the first case, the header line is always removed, whether or not the
27439 condition is true. In the second case, the header line is removed only if the
27440 condition is true. Multiple occurrences of &%remove_header%& may occur in the
27441 same ACL statement. All those that are encountered before a condition fails
27442 are honoured.
27443
27444 &*Warning*&: This facility currently applies only to header lines that are
27445 present during ACL processing. It does NOT remove header lines that are added
27446 in a system filter or in a router or transport.
27447
27448
27449
27450
27451
27452 .section "ACL conditions" "SECTaclconditions"
27453 .cindex "&ACL;" "conditions; list of"
27454 Some of the conditions listed in this section are available only when Exim is
27455 compiled with the content-scanning extension. They are included here briefly
27456 for completeness. More detailed descriptions can be found in the discussion on
27457 content scanning in chapter &<<CHAPexiscan>>&.
27458
27459 Not all conditions are relevant in all circumstances. For example, testing
27460 senders and recipients does not make sense in an ACL that is being run as the
27461 result of the arrival of an ETRN command, and checks on message headers can be
27462 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
27463 can use the same condition (with different parameters) more than once in the
27464 same ACL statement. This provides a way of specifying an &"and"& conjunction.
27465 The conditions are as follows:
27466
27467
27468 .vlist
27469 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
27470 .cindex "&ACL;" "nested"
27471 .cindex "&ACL;" "indirect"
27472 .cindex "&ACL;" "arguments"
27473 .cindex "&%acl%& ACL condition"
27474 The possible values of the argument are the same as for the
27475 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
27476 &"accept"& the condition is true; if it returns &"deny"& the condition is
27477 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
27478 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
27479 condition false. This means that further processing of the &%warn%& verb
27480 ceases, but processing of the ACL continues.
27481
27482 If the argument is a named ACL, up to nine space-separated optional values
27483 can be appended; they appear in $acl_arg1 to $acl_arg9, and $acl_narg is set
27484 to the count of values.  The name and values are expanded separately.
27485
27486 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
27487 the connection is dropped. If it returns &"discard"&, the verb must be
27488 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
27489 conditions are tested.
27490
27491 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
27492 loops. This condition allows you to use different ACLs in different
27493 circumstances. For example, different ACLs can be used to handle RCPT commands
27494 for different local users or different local domains.
27495
27496 .vitem &*authenticated&~=&~*&<&'string&~list'&>
27497 .cindex "&%authenticated%& ACL condition"
27498 .cindex "authentication" "ACL checking"
27499 .cindex "&ACL;" "testing for authentication"
27500 If the SMTP connection is not authenticated, the condition is false. Otherwise,
27501 the name of the authenticator is tested against the list. To test for
27502 authentication by any authenticator, you can set
27503 .code
27504 authenticated = *
27505 .endd
27506
27507 .vitem &*condition&~=&~*&<&'string'&>
27508 .cindex "&%condition%& ACL condition"
27509 .cindex "customizing" "ACL condition"
27510 .cindex "&ACL;" "customized test"
27511 .cindex "&ACL;" "testing, customized"
27512 This feature allows you to make up custom conditions. If the result of
27513 expanding the string is an empty string, the number zero, or one of the strings
27514 &"no"& or &"false"&, the condition is false. If the result is any non-zero
27515 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
27516 any other value, some error is assumed to have occurred, and the ACL returns
27517 &"defer"&. However, if the expansion is forced to fail, the condition is
27518 ignored. The effect is to treat it as true, whether it is positive or
27519 negative.
27520
27521 .vitem &*decode&~=&~*&<&'location'&>
27522 .cindex "&%decode%& ACL condition"
27523 This condition is available only when Exim is compiled with the
27524 content-scanning extension, and it is allowed only in the ACL defined by
27525 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
27526 If all goes well, the condition is true. It is false only if there are
27527 problems such as a syntax error or a memory shortage. For more details, see
27528 chapter &<<CHAPexiscan>>&.
27529
27530 .vitem &*demime&~=&~*&<&'extension&~list'&>
27531 .cindex "&%demime%& ACL condition"
27532 This condition is available only when Exim is compiled with the
27533 content-scanning extension. Its use is described in section
27534 &<<SECTdemimecond>>&.
27535
27536 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
27537 .cindex "&%dnslists%& ACL condition"
27538 .cindex "DNS list" "in ACL"
27539 .cindex "black list (DNS)"
27540 .cindex "&ACL;" "testing a DNS list"
27541 This condition checks for entries in DNS black lists. These are also known as
27542 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
27543 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
27544 different variants of this condition to describe briefly here. See sections
27545 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
27546
27547 .vitem &*domains&~=&~*&<&'domain&~list'&>
27548 .cindex "&%domains%& ACL condition"
27549 .cindex "domain" "ACL checking"
27550 .cindex "&ACL;" "testing a recipient domain"
27551 .vindex "&$domain_data$&"
27552 This condition is relevant only after a RCPT command. It checks that the domain
27553 of the recipient address is in the domain list. If percent-hack processing is
27554 enabled, it is done before this test is done. If the check succeeds with a
27555 lookup, the result of the lookup is placed in &$domain_data$& until the next
27556 &%domains%& test.
27557
27558 &*Note carefully*& (because many people seem to fall foul of this): you cannot
27559 use &%domains%& in a DATA ACL.
27560
27561
27562 .vitem &*encrypted&~=&~*&<&'string&~list'&>
27563 .cindex "&%encrypted%& ACL condition"
27564 .cindex "encryption" "checking in an ACL"
27565 .cindex "&ACL;" "testing for encryption"
27566 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
27567 name of the cipher suite in use is tested against the list. To test for
27568 encryption without testing for any specific cipher suite(s), set
27569 .code
27570 encrypted = *
27571 .endd
27572
27573
27574 .vitem &*hosts&~=&~*&<&'host&~list'&>
27575 .cindex "&%hosts%& ACL condition"
27576 .cindex "host" "ACL checking"
27577 .cindex "&ACL;" "testing the client host"
27578 This condition tests that the calling host matches the host list. If you have
27579 name lookups or wildcarded host names and IP addresses in the same host list,
27580 you should normally put the IP addresses first. For example, you could have:
27581 .code
27582 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
27583 .endd
27584 The lookup in this example uses the host name for its key. This is implied by
27585 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
27586 and it wouldn't matter which way round you had these two items.)
27587
27588 The reason for the problem with host names lies in the left-to-right way that
27589 Exim processes lists. It can test IP addresses without doing any DNS lookups,
27590 but when it reaches an item that requires a host name, it fails if it cannot
27591 find a host name to compare with the pattern. If the above list is given in the
27592 opposite order, the &%accept%& statement fails for a host whose name cannot be
27593 found, even if its IP address is 10.9.8.7.
27594
27595 If you really do want to do the name check first, and still recognize the IP
27596 address even if the name lookup fails, you can rewrite the ACL like this:
27597 .code
27598 accept hosts = dbm;/etc/friendly/hosts
27599 accept hosts = 10.9.8.7
27600 .endd
27601 The default action on failing to find the host name is to assume that the host
27602 is not in the list, so the first &%accept%& statement fails. The second
27603 statement can then check the IP address.
27604
27605 .vindex "&$host_data$&"
27606 If a &%hosts%& condition is satisfied by means of a lookup, the result
27607 of the lookup is made available in the &$host_data$& variable. This
27608 allows you, for example, to set up a statement like this:
27609 .code
27610 deny  hosts = net-lsearch;/some/file
27611 message = $host_data
27612 .endd
27613 which gives a custom error message for each denied host.
27614
27615 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
27616 .cindex "&%local_parts%& ACL condition"
27617 .cindex "local part" "ACL checking"
27618 .cindex "&ACL;" "testing a local part"
27619 .vindex "&$local_part_data$&"
27620 This condition is relevant only after a RCPT command. It checks that the local
27621 part of the recipient address is in the list. If percent-hack processing is
27622 enabled, it is done before this test. If the check succeeds with a lookup, the
27623 result of the lookup is placed in &$local_part_data$&, which remains set until
27624 the next &%local_parts%& test.
27625
27626 .vitem &*malware&~=&~*&<&'option'&>
27627 .cindex "&%malware%& ACL condition"
27628 .cindex "&ACL;" "virus scanning"
27629 .cindex "&ACL;" "scanning for viruses"
27630 This condition is available only when Exim is compiled with the
27631 content-scanning extension. It causes the incoming message to be scanned for
27632 viruses. For details, see chapter &<<CHAPexiscan>>&.
27633
27634 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27635 .cindex "&%mime_regex%& ACL condition"
27636 .cindex "&ACL;" "testing by regex matching"
27637 This condition is available only when Exim is compiled with the
27638 content-scanning extension, and it is allowed only in the ACL defined by
27639 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
27640 with any of the regular expressions. For details, see chapter
27641 &<<CHAPexiscan>>&.
27642
27643 .vitem &*ratelimit&~=&~*&<&'parameters'&>
27644 .cindex "rate limiting"
27645 This condition can be used to limit the rate at which a user or host submits
27646 messages. Details are given in section &<<SECTratelimiting>>&.
27647
27648 .vitem &*recipients&~=&~*&<&'address&~list'&>
27649 .cindex "&%recipients%& ACL condition"
27650 .cindex "recipient" "ACL checking"
27651 .cindex "&ACL;" "testing a recipient"
27652 This condition is relevant only after a RCPT command. It checks the entire
27653 recipient address against a list of recipients.
27654
27655 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27656 .cindex "&%regex%& ACL condition"
27657 .cindex "&ACL;" "testing by regex matching"
27658 This condition is available only when Exim is compiled with the
27659 content-scanning extension, and is available only in the DATA, MIME, and
27660 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
27661 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
27662
27663 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
27664 .cindex "&%sender_domains%& ACL condition"
27665 .cindex "sender" "ACL checking"
27666 .cindex "&ACL;" "testing a sender domain"
27667 .vindex "&$domain$&"
27668 .vindex "&$sender_address_domain$&"
27669 This condition tests the domain of the sender of the message against the given
27670 domain list. &*Note*&: The domain of the sender address is in
27671 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
27672 of this condition. This is an exception to the general rule for testing domain
27673 lists. It is done this way so that, if this condition is used in an ACL for a
27674 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
27675 influence the sender checking.
27676
27677 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27678 relaying, because sender addresses are easily, and commonly, forged.
27679
27680 .vitem &*senders&~=&~*&<&'address&~list'&>
27681 .cindex "&%senders%& ACL condition"
27682 .cindex "sender" "ACL checking"
27683 .cindex "&ACL;" "testing a sender"
27684 This condition tests the sender of the message against the given list. To test
27685 for a bounce message, which has an empty sender, set
27686 .code
27687 senders = :
27688 .endd
27689 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27690 relaying, because sender addresses are easily, and commonly, forged.
27691
27692 .vitem &*spam&~=&~*&<&'username'&>
27693 .cindex "&%spam%& ACL condition"
27694 .cindex "&ACL;" "scanning for spam"
27695 This condition is available only when Exim is compiled with the
27696 content-scanning extension. It causes the incoming message to be scanned by
27697 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
27698
27699 .vitem &*verify&~=&~certificate*&
27700 .cindex "&%verify%& ACL condition"
27701 .cindex "TLS" "client certificate verification"
27702 .cindex "certificate" "verification of client"
27703 .cindex "&ACL;" "certificate verification"
27704 .cindex "&ACL;" "testing a TLS certificate"
27705 This condition is true in an SMTP session if the session is encrypted, and a
27706 certificate was received from the client, and the certificate was verified. The
27707 server requests a certificate only if the client matches &%tls_verify_hosts%&
27708 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
27709
27710 .vitem &*verify&~=&~csa*&
27711 .cindex "CSA verification"
27712 This condition checks whether the sending host (the client) is authorized to
27713 send email. Details of how this works are given in section
27714 &<<SECTverifyCSA>>&.
27715
27716 .vitem &*verify&~=&~header_sender/*&<&'options'&>
27717 .cindex "&%verify%& ACL condition"
27718 .cindex "&ACL;" "verifying sender in the header"
27719 .cindex "header lines" "verifying the sender in"
27720 .cindex "sender" "verifying in header"
27721 .cindex "verifying" "sender in header"
27722 This condition is relevant only in an ACL that is run after a message has been
27723 received, that is, in an ACL specified by &%acl_smtp_data%& or
27724 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
27725 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
27726 is loosely thought of as a &"sender"& address (hence the name of the test).
27727 However, an address that appears in one of these headers need not be an address
27728 that accepts bounce messages; only sender addresses in envelopes are required
27729 to accept bounces. Therefore, if you use the callout option on this check, you
27730 might want to arrange for a non-empty address in the MAIL command.
27731
27732 Details of address verification and the options are given later, starting at
27733 section &<<SECTaddressverification>>& (callouts are described in section
27734 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
27735 condition to restrict it to bounce messages only:
27736 .code
27737 deny    senders = :
27738         message = A valid sender header is required for bounces
27739        !verify  = header_sender
27740 .endd
27741
27742 .vitem &*verify&~=&~header_syntax*&
27743 .cindex "&%verify%& ACL condition"
27744 .cindex "&ACL;" "verifying header syntax"
27745 .cindex "header lines" "verifying syntax"
27746 .cindex "verifying" "header syntax"
27747 This condition is relevant only in an ACL that is run after a message has been
27748 received, that is, in an ACL specified by &%acl_smtp_data%& or
27749 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
27750 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
27751 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
27752 permitted only in locally generated messages and from hosts that match
27753 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
27754 appropriate.
27755
27756 Note that this condition is a syntax check only. However, a common spamming
27757 ploy used to be to send syntactically invalid headers such as
27758 .code
27759 To: @
27760 .endd
27761 and this condition can be used to reject such messages, though they are not as
27762 common as they used to be.
27763
27764 .vitem &*verify&~=&~helo*&
27765 .cindex "&%verify%& ACL condition"
27766 .cindex "&ACL;" "verifying HELO/EHLO"
27767 .cindex "HELO" "verifying"
27768 .cindex "EHLO" "verifying"
27769 .cindex "verifying" "EHLO"
27770 .cindex "verifying" "HELO"
27771 This condition is true if a HELO or EHLO command has been received from the
27772 client host, and its contents have been verified. If there has been no previous
27773 attempt to verify the HELO/EHLO contents, it is carried out when this
27774 condition is encountered. See the description of the &%helo_verify_hosts%& and
27775 &%helo_try_verify_hosts%& options for details of how to request verification
27776 independently of this condition.
27777
27778 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
27779 option), this condition is always true.
27780
27781
27782 .vitem &*verify&~=&~not_blind*&
27783 .cindex "verifying" "not blind"
27784 .cindex "bcc recipients, verifying none"
27785 This condition checks that there are no blind (bcc) recipients in the message.
27786 Every envelope recipient must appear either in a &'To:'& header line or in a
27787 &'Cc:'& header line for this condition to be true. Local parts are checked
27788 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
27789 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
27790 used only in a DATA or non-SMTP ACL.
27791
27792 There are, of course, many legitimate messages that make use of blind (bcc)
27793 recipients. This check should not be used on its own for blocking messages.
27794
27795
27796 .vitem &*verify&~=&~recipient/*&<&'options'&>
27797 .cindex "&%verify%& ACL condition"
27798 .cindex "&ACL;" "verifying recipient"
27799 .cindex "recipient" "verifying"
27800 .cindex "verifying" "recipient"
27801 .vindex "&$address_data$&"
27802 This condition is relevant only after a RCPT command. It verifies the current
27803 recipient. Details of address verification are given later, starting at section
27804 &<<SECTaddressverification>>&. After a recipient has been verified, the value
27805 of &$address_data$& is the last value that was set while routing the address.
27806 This applies even if the verification fails. When an address that is being
27807 verified is redirected to a single address, verification continues with the new
27808 address, and in that case, the subsequent value of &$address_data$& is the
27809 value for the child address.
27810
27811 .vitem &*verify&~=&~reverse_host_lookup*&
27812 .cindex "&%verify%& ACL condition"
27813 .cindex "&ACL;" "verifying host reverse lookup"
27814 .cindex "host" "verifying reverse lookup"
27815 This condition ensures that a verified host name has been looked up from the IP
27816 address of the client host. (This may have happened already if the host name
27817 was needed for checking a host list, or if the host matched &%host_lookup%&.)
27818 Verification ensures that the host name obtained from a reverse DNS lookup, or
27819 one of its aliases, does, when it is itself looked up in the DNS, yield the
27820 original IP address.
27821
27822 If this condition is used for a locally generated message (that is, when there
27823 is no client host involved), it always succeeds.
27824
27825 .vitem &*verify&~=&~sender/*&<&'options'&>
27826 .cindex "&%verify%& ACL condition"
27827 .cindex "&ACL;" "verifying sender"
27828 .cindex "sender" "verifying"
27829 .cindex "verifying" "sender"
27830 This condition is relevant only after a MAIL or RCPT command, or after a
27831 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
27832 the message's sender is empty (that is, this is a bounce message), the
27833 condition is true. Otherwise, the sender address is verified.
27834
27835 .vindex "&$address_data$&"
27836 .vindex "&$sender_address_data$&"
27837 If there is data in the &$address_data$& variable at the end of routing, its
27838 value is placed in &$sender_address_data$& at the end of verification. This
27839 value can be used in subsequent conditions and modifiers in the same ACL
27840 statement. It does not persist after the end of the current statement. If you
27841 want to preserve the value for longer, you can save it in an ACL variable.
27842
27843 Details of verification are given later, starting at section
27844 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
27845 to avoid doing it more than once per message.
27846
27847 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
27848 .cindex "&%verify%& ACL condition"
27849 This is a variation of the previous option, in which a modified address is
27850 verified as a sender.
27851 .endlist
27852
27853
27854
27855 .section "Using DNS lists" "SECTmorednslists"
27856 .cindex "DNS list" "in ACL"
27857 .cindex "black list (DNS)"
27858 .cindex "&ACL;" "testing a DNS list"
27859 In its simplest form, the &%dnslists%& condition tests whether the calling host
27860 is on at least one of a number of DNS lists by looking up the inverted IP
27861 address in one or more DNS domains. (Note that DNS list domains are not mail
27862 domains, so the &`+`& syntax for named lists doesn't work - it is used for
27863 special options instead.) For example, if the calling host's IP
27864 address is 192.168.62.43, and the ACL statement is
27865 .code
27866 deny dnslists = blackholes.mail-abuse.org : \
27867                 dialups.mail-abuse.org
27868 .endd
27869 the following records are looked up:
27870 .code
27871 43.62.168.192.blackholes.mail-abuse.org
27872 43.62.168.192.dialups.mail-abuse.org
27873 .endd
27874 As soon as Exim finds an existing DNS record, processing of the list stops.
27875 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
27876 to test that a host is on more than one list (an &"and"& conjunction), you can
27877 use two separate conditions:
27878 .code
27879 deny dnslists = blackholes.mail-abuse.org
27880      dnslists = dialups.mail-abuse.org
27881 .endd
27882 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
27883 behaves as if the host does not match the list item, that is, as if the DNS
27884 record does not exist. If there are further items in the DNS list, they are
27885 processed.
27886
27887 This is usually the required action when &%dnslists%& is used with &%deny%&
27888 (which is the most common usage), because it prevents a DNS failure from
27889 blocking mail. However, you can change this behaviour by putting one of the
27890 following special items in the list:
27891 .display
27892 &`+include_unknown `&   behave as if the item is on the list
27893 &`+exclude_unknown `&   behave as if the item is not on the list (default)
27894 &`+defer_unknown   `&   give a temporary error
27895 .endd
27896 .cindex "&`+include_unknown`&"
27897 .cindex "&`+exclude_unknown`&"
27898 .cindex "&`+defer_unknown`&"
27899 Each of these applies to any subsequent items on the list. For example:
27900 .code
27901 deny dnslists = +defer_unknown : foo.bar.example
27902 .endd
27903 Testing the list of domains stops as soon as a match is found. If you want to
27904 warn for one list and block for another, you can use two different statements:
27905 .code
27906 deny  dnslists = blackholes.mail-abuse.org
27907 warn  message  = X-Warn: sending host is on dialups list
27908       dnslists = dialups.mail-abuse.org
27909 .endd
27910 DNS list lookups are cached by Exim for the duration of the SMTP session,
27911 so a lookup based on the IP address is done at most once for any incoming
27912 connection. Exim does not share information between multiple incoming
27913 connections (but your local name server cache should be active).
27914
27915
27916
27917 .section "Specifying the IP address for a DNS list lookup" "SECID201"
27918 .cindex "DNS list" "keyed by explicit IP address"
27919 By default, the IP address that is used in a DNS list lookup is the IP address
27920 of the calling host. However, you can specify another IP address by listing it
27921 after the domain name, introduced by a slash. For example:
27922 .code
27923 deny dnslists = black.list.tld/192.168.1.2
27924 .endd
27925 This feature is not very helpful with explicit IP addresses; it is intended for
27926 use with IP addresses that are looked up, for example, the IP addresses of the
27927 MX hosts or nameservers of an email sender address. For an example, see section
27928 &<<SECTmulkeyfor>>& below.
27929
27930
27931
27932
27933 .section "DNS lists keyed on domain names" "SECID202"
27934 .cindex "DNS list" "keyed by domain name"
27935 There are some lists that are keyed on domain names rather than inverted IP
27936 addresses (see for example the &'domain based zones'& link at
27937 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
27938 with these lists. You can change the name that is looked up in a DNS list by
27939 listing it after the domain name, introduced by a slash. For example,
27940 .code
27941 deny  message  = Sender's domain is listed at $dnslist_domain
27942       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
27943 .endd
27944 This particular example is useful only in ACLs that are obeyed after the
27945 RCPT or DATA commands, when a sender address is available. If (for
27946 example) the message's sender is &'user@tld.example'& the name that is looked
27947 up by this example is
27948 .code
27949 tld.example.dsn.rfc-ignorant.org
27950 .endd
27951 A single &%dnslists%& condition can contain entries for both names and IP
27952 addresses. For example:
27953 .code
27954 deny dnslists = sbl.spamhaus.org : \
27955                 dsn.rfc-ignorant.org/$sender_address_domain
27956 .endd
27957 The first item checks the sending host's IP address; the second checks a domain
27958 name. The whole condition is true if either of the DNS lookups succeeds.
27959
27960
27961
27962
27963 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
27964 .cindex "DNS list" "multiple keys for"
27965 The syntax described above for looking up explicitly-defined values (either
27966 names or IP addresses) in a DNS blacklist is a simplification. After the domain
27967 name for the DNS list, what follows the slash can in fact be a list of items.
27968 As with all lists in Exim, the default separator is a colon. However, because
27969 this is a sublist within the list of DNS blacklist domains, it is necessary
27970 either to double the separators like this:
27971 .code
27972 dnslists = black.list.tld/name.1::name.2
27973 .endd
27974 or to change the separator character, like this:
27975 .code
27976 dnslists = black.list.tld/<;name.1;name.2
27977 .endd
27978 If an item in the list is an IP address, it is inverted before the DNS
27979 blacklist domain is appended. If it is not an IP address, no inversion
27980 occurs. Consider this condition:
27981 .code
27982 dnslists = black.list.tld/<;192.168.1.2;a.domain
27983 .endd
27984 The DNS lookups that occur are:
27985 .code
27986 2.1.168.192.black.list.tld
27987 a.domain.black.list.tld
27988 .endd
27989 Once a DNS record has been found (that matches a specific IP return
27990 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
27991 are done. If there is a temporary DNS error, the rest of the sublist of domains
27992 or IP addresses is tried. A temporary error for the whole dnslists item occurs
27993 only if no other DNS lookup in this sublist succeeds. In other words, a
27994 successful lookup for any of the items in the sublist overrides a temporary
27995 error for a previous item.
27996
27997 The ability to supply a list of items after the slash is in some sense just a
27998 syntactic convenience. These two examples have the same effect:
27999 .code
28000 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
28001 dnslists = black.list.tld/a.domain::b.domain
28002 .endd
28003 However, when the data for the list is obtained from a lookup, the second form
28004 is usually much more convenient. Consider this example:
28005 .code
28006 deny message  = The mail servers for the domain \
28007                 $sender_address_domain \
28008                 are listed at $dnslist_domain ($dnslist_value); \
28009                 see $dnslist_text.
28010      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
28011                                    ${lookup dnsdb {>|mxh=\
28012                                    $sender_address_domain} }} }
28013 .endd
28014 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
28015 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
28016 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
28017 of expanding the condition might be something like this:
28018 .code
28019 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
28020 .endd
28021 Thus, this example checks whether or not the IP addresses of the sender
28022 domain's mail servers are on the Spamhaus black list.
28023
28024 The key that was used for a successful DNS list lookup is put into the variable
28025 &$dnslist_matched$& (see section &<<SECID204>>&).
28026
28027
28028
28029
28030 .section "Data returned by DNS lists" "SECID203"
28031 .cindex "DNS list" "data returned from"
28032 DNS lists are constructed using address records in the DNS. The original RBL
28033 just used the address 127.0.0.1 on the right hand side of each record, but the
28034 RBL+ list and some other lists use a number of values with different meanings.
28035 The values used on the RBL+ list are:
28036 .display
28037 127.1.0.1  RBL
28038 127.1.0.2  DUL
28039 127.1.0.3  DUL and RBL
28040 127.1.0.4  RSS
28041 127.1.0.5  RSS and RBL
28042 127.1.0.6  RSS and DUL
28043 127.1.0.7  RSS and DUL and RBL
28044 .endd
28045 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
28046 different values. Some DNS lists may return more than one address record;
28047 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
28048
28049
28050 .section "Variables set from DNS lists" "SECID204"
28051 .cindex "expansion" "variables, set from DNS list"
28052 .cindex "DNS list" "variables set from"
28053 .vindex "&$dnslist_domain$&"
28054 .vindex "&$dnslist_matched$&"
28055 .vindex "&$dnslist_text$&"
28056 .vindex "&$dnslist_value$&"
28057 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
28058 the name of the overall domain that matched (for example,
28059 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
28060 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
28061 the DNS record. When the key is an IP address, it is not reversed in
28062 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
28063 cases, for example:
28064 .code
28065 deny dnslists = spamhaus.example
28066 .endd
28067 the key is also available in another variable (in this case,
28068 &$sender_host_address$&). In more complicated cases, however, this is not true.
28069 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
28070 might generate a dnslists lookup like this:
28071 .code
28072 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
28073 .endd
28074 If this condition succeeds, the value in &$dnslist_matched$& might be
28075 &`192.168.6.7`& (for example).
28076
28077 If more than one address record is returned by the DNS lookup, all the IP
28078 addresses are included in &$dnslist_value$&, separated by commas and spaces.
28079 The variable &$dnslist_text$& contains the contents of any associated TXT
28080 record. For lists such as RBL+ the TXT record for a merged entry is often not
28081 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
28082 information.
28083
28084 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
28085 &-- although these appear before the condition in the ACL, they are not
28086 expanded until after it has failed. For example:
28087 .code
28088 deny    hosts = !+local_networks
28089         message = $sender_host_address is listed \
28090                   at $dnslist_domain
28091         dnslists = rbl-plus.mail-abuse.example
28092 .endd
28093
28094
28095
28096 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
28097 .cindex "DNS list" "matching specific returned data"
28098 You can add an equals sign and an IP address after a &%dnslists%& domain name
28099 in order to restrict its action to DNS records with a matching right hand side.
28100 For example,
28101 .code
28102 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
28103 .endd
28104 rejects only those hosts that yield 127.0.0.2. Without this additional data,
28105 any address record is considered to be a match. For the moment, we assume
28106 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
28107 describes how multiple records are handled.
28108
28109 More than one IP address may be given for checking, using a comma as a
28110 separator. These are alternatives &-- if any one of them matches, the
28111 &%dnslists%& condition is true. For example:
28112 .code
28113 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28114 .endd
28115 If you want to specify a constraining address list and also specify names or IP
28116 addresses to be looked up, the constraining address list must be specified
28117 first. For example:
28118 .code
28119 deny dnslists = dsn.rfc-ignorant.org\
28120                 =127.0.0.2/$sender_address_domain
28121 .endd
28122
28123 If the character &`&&`& is used instead of &`=`&, the comparison for each
28124 listed IP address is done by a bitwise &"and"& instead of by an equality test.
28125 In other words, the listed addresses are used as bit masks. The comparison is
28126 true if all the bits in the mask are present in the address that is being
28127 tested. For example:
28128 .code
28129 dnslists = a.b.c&0.0.0.3
28130 .endd
28131 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
28132 want to test whether one bit or another bit is present (as opposed to both
28133 being present), you must use multiple values. For example:
28134 .code
28135 dnslists = a.b.c&0.0.0.1,0.0.0.2
28136 .endd
28137 matches if the final component of the address is an odd number or two times
28138 an odd number.
28139
28140
28141
28142 .section "Negated DNS matching conditions" "SECID205"
28143 You can supply a negative list of IP addresses as part of a &%dnslists%&
28144 condition. Whereas
28145 .code
28146 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28147 .endd
28148 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28149 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
28150 .code
28151 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
28152 .endd
28153 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28154 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
28155 words, the result of the test is inverted if an exclamation mark appears before
28156 the &`=`& (or the &`&&`&) sign.
28157
28158 &*Note*&: This kind of negation is not the same as negation in a domain,
28159 host, or address list (which is why the syntax is different).
28160
28161 If you are using just one list, the negation syntax does not gain you much. The
28162 previous example is precisely equivalent to
28163 .code
28164 deny  dnslists = a.b.c
28165      !dnslists = a.b.c=127.0.0.2,127.0.0.3
28166 .endd
28167 However, if you are using multiple lists, the negation syntax is clearer.
28168 Consider this example:
28169 .code
28170 deny  dnslists = sbl.spamhaus.org : \
28171                  list.dsbl.org : \
28172                  dnsbl.njabl.org!=127.0.0.3 : \
28173                  relays.ordb.org
28174 .endd
28175 Using only positive lists, this would have to be:
28176 .code
28177 deny  dnslists = sbl.spamhaus.org : \
28178                  list.dsbl.org
28179 deny  dnslists = dnsbl.njabl.org
28180      !dnslists = dnsbl.njabl.org=127.0.0.3
28181 deny  dnslists = relays.ordb.org
28182 .endd
28183 which is less clear, and harder to maintain.
28184
28185
28186
28187
28188 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
28189 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
28190 thereby providing more than one IP address. When an item in a &%dnslists%& list
28191 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
28192 the match to specific results from the DNS lookup, there are two ways in which
28193 the checking can be handled. For example, consider the condition:
28194 .code
28195 dnslists = a.b.c=127.0.0.1
28196 .endd
28197 What happens if the DNS lookup for the incoming IP address yields both
28198 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
28199 condition true because at least one given value was found, or is it false
28200 because at least one of the found values was not listed? And how does this
28201 affect negated conditions? Both possibilities are provided for with the help of
28202 additional separators &`==`& and &`=&&`&.
28203
28204 .ilist
28205 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
28206 IP addresses matches one of the listed addresses. For the example above, the
28207 condition is true because 127.0.0.1 matches.
28208 .next
28209 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
28210 looked up IP addresses matches one of the listed addresses. If the condition is
28211 changed to:
28212 .code
28213 dnslists = a.b.c==127.0.0.1
28214 .endd
28215 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28216 false because 127.0.0.2 is not listed. You would need to have:
28217 .code
28218 dnslists = a.b.c==127.0.0.1,127.0.0.2
28219 .endd
28220 for the condition to be true.
28221 .endlist
28222
28223 When &`!`& is used to negate IP address matching, it inverts the result, giving
28224 the precise opposite of the behaviour above. Thus:
28225 .ilist
28226 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
28227 addresses matches one of the listed addresses. Consider:
28228 .code
28229 dnslists = a.b.c!&0.0.0.1
28230 .endd
28231 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28232 false because 127.0.0.1 matches.
28233 .next
28234 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
28235 looked up IP address that does not match. Consider:
28236 .code
28237 dnslists = a.b.c!=&0.0.0.1
28238 .endd
28239 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28240 true, because 127.0.0.2 does not match. You would need to have:
28241 .code
28242 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
28243 .endd
28244 for the condition to be false.
28245 .endlist
28246 When the DNS lookup yields only a single IP address, there is no difference
28247 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
28248
28249
28250
28251
28252 .section "Detailed information from merged DNS lists" "SECTmordetinf"
28253 .cindex "DNS list" "information from merged"
28254 When the facility for restricting the matching IP values in a DNS list is used,
28255 the text from the TXT record that is set in &$dnslist_text$& may not reflect
28256 the true reason for rejection. This happens when lists are merged and the IP
28257 address in the A record is used to distinguish them; unfortunately there is
28258 only one TXT record. One way round this is not to use merged lists, but that
28259 can be inefficient because it requires multiple DNS lookups where one would do
28260 in the vast majority of cases when the host of interest is not on any of the
28261 lists.
28262
28263 A less inefficient way of solving this problem is available. If
28264 two domain names, comma-separated, are given, the second is used first to
28265 do an initial check, making use of any IP value restrictions that are set.
28266 If there is a match, the first domain is used, without any IP value
28267 restrictions, to get the TXT record. As a byproduct of this, there is also
28268 a check that the IP being tested is indeed on the first list. The first
28269 domain is the one that is put in &$dnslist_domain$&. For example:
28270 .code
28271 reject message  = \
28272          rejected because $sender_host_address is blacklisted \
28273          at $dnslist_domain\n$dnslist_text
28274        dnslists = \
28275          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
28276          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
28277 .endd
28278 For the first blacklist item, this starts by doing a lookup in
28279 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
28280 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
28281 value, and as long as something is found, it looks for the corresponding TXT
28282 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
28283 The second blacklist item is processed similarly.
28284
28285 If you are interested in more than one merged list, the same list must be
28286 given several times, but because the results of the DNS lookups are cached,
28287 the DNS calls themselves are not repeated. For example:
28288 .code
28289 reject dnslists = \
28290          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
28291          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
28292          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
28293          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
28294 .endd
28295 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
28296 values matches (or if no record is found), this is the only lookup that is
28297 done. Only if there is a match is one of the more specific lists consulted.
28298
28299
28300
28301 .section "DNS lists and IPv6" "SECTmorednslistslast"
28302 .cindex "IPv6" "DNS black lists"
28303 .cindex "DNS list" "IPv6 usage"
28304 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
28305 nibble by nibble. For example, if the calling host's IP address is
28306 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
28307 .code
28308 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
28309   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
28310 .endd
28311 (split over two lines here to fit on the page). Unfortunately, some of the DNS
28312 lists contain wildcard records, intended for IPv4, that interact badly with
28313 IPv6. For example, the DNS entry
28314 .code
28315 *.3.some.list.example.    A    127.0.0.1
28316 .endd
28317 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
28318 Unfortunately, it also matches the entire 3::/4 IPv6 network.
28319
28320 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
28321 &%condition%& condition, as in this example:
28322 .code
28323 deny   condition = ${if isip4{$sender_host_address}}
28324        dnslists  = some.list.example
28325 .endd
28326
28327 .section "Rate limiting incoming messages" "SECTratelimiting"
28328 .cindex "rate limiting" "client sending"
28329 .cindex "limiting client sending rates"
28330 .oindex "&%smtp_ratelimit_*%&"
28331 The &%ratelimit%& ACL condition can be used to measure and control the rate at
28332 which clients can send email. This is more powerful than the
28333 &%smtp_ratelimit_*%& options, because those options control the rate of
28334 commands in a single SMTP session only, whereas the &%ratelimit%& condition
28335 works across all connections (concurrent and sequential) from the same client
28336 host. The syntax of the &%ratelimit%& condition is:
28337 .display
28338 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
28339 .endd
28340 If the average client sending rate is less than &'m'& messages per time
28341 period &'p'& then the condition is false; otherwise it is true.
28342
28343 As a side-effect, the &%ratelimit%& condition sets the expansion variable
28344 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
28345 configured value of &'m'&, and &$sender_rate_period$& to the configured value
28346 of &'p'&.
28347
28348 The parameter &'p'& is the smoothing time constant, in the form of an Exim
28349 time interval, for example, &`8h`& for eight hours. A larger time constant
28350 means that it takes Exim longer to forget a client's past behaviour. The
28351 parameter &'m'& is the maximum number of messages that a client is permitted to
28352 send in each time interval. It also specifies the number of messages permitted
28353 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
28354 constant, you can allow a client to send more messages in a burst without
28355 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
28356 both small, messages must be sent at an even rate.
28357
28358 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
28359 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
28360 when deploying the &%ratelimit%& ACL condition. The script prints usage
28361 instructions when it is run with no arguments.
28362
28363 The key is used to look up the data for calculating the client's average
28364 sending rate. This data is stored in Exim's spool directory, alongside the
28365 retry and other hints databases. The default key is &$sender_host_address$&,
28366 which means Exim computes the sending rate of each client host IP address.
28367 By changing the key you can change how Exim identifies clients for the purpose
28368 of ratelimiting. For example, to limit the sending rate of each authenticated
28369 user, independent of the computer they are sending from, set the key to
28370 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
28371 example, &$authenticated_id$& is only meaningful if the client has
28372 authenticated (which you can check with the &%authenticated%& ACL condition).
28373
28374 The lookup key does not have to identify clients: If you want to limit the
28375 rate at which a recipient receives messages, you can use the key
28376 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
28377 ACL.
28378
28379 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
28380 specifies what Exim measures the rate of, for example messages or recipients
28381 or bytes. You can adjust the measurement using the &%unique=%& and/or
28382 &%count=%& options. You can also control when Exim updates the recorded rate
28383 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
28384 separated by a slash, like the other parameters. They may appear in any order.
28385
28386 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
28387 any options that alter the meaning of the stored data. The limit &'m'& is not
28388 stored, so you can alter the configured maximum rate and Exim will still
28389 remember clients' past behaviour. If you change the &%per_*%& mode or add or
28390 remove the &%unique=%& option, the lookup key changes so Exim will forget past
28391 behaviour. The lookup key is not affected by changes to the update mode and
28392 the &%count=%& option.
28393
28394
28395 .section "Ratelimit options for what is being measured" "ratoptmea"
28396 .cindex "rate limiting" "per_* options"
28397 The &%per_conn%& option limits the client's connection rate. It is not
28398 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
28399 &%acl_not_smtp_start%& ACLs.
28400
28401 The &%per_mail%& option limits the client's rate of sending messages. This is
28402 the default if none of the &%per_*%& options is specified. It can be used in
28403 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
28404 &%acl_smtp_data%&, or &%acl_not_smtp%&.
28405
28406 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
28407 the same ACLs as the &%per_mail%& option, though it is best to use this option
28408 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
28409 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
28410 in its MAIL command, which may be inaccurate or completely missing. You can
28411 follow the limit &'m'& in the configuration with K, M, or G to specify limits
28412 in kilobytes, megabytes, or gigabytes, respectively.
28413
28414 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
28415 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28416 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
28417 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
28418 ACLs the rate is updated with the total recipient count in one go. Note that
28419 in either case the rate limiting engine will see a message with many
28420 recipients as a large high-speed burst.
28421
28422 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
28423 number of different recipients that the client has sent messages to in the
28424 last time period. That is, if the client repeatedly sends messages to the same
28425 recipient, its measured rate is not increased. This option can only be used in
28426 &%acl_smtp_rcpt%&.
28427
28428 The &%per_cmd%& option causes Exim to recompute the rate every time the
28429 condition is processed. This can be used to limit the rate of any SMTP
28430 command. If it is used in multiple ACLs it can limit the aggregate rate of
28431 multiple different commands.
28432
28433 The &%count=%& option can be used to alter how much Exim adds to the client's
28434 measured rate. For example, the &%per_byte%& option is equivalent to
28435 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
28436 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
28437 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
28438
28439 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
28440
28441
28442 .section "Ratelimit update modes" "ratoptupd"
28443 .cindex "rate limiting" "reading data without updating"
28444 You can specify one of three options with the &%ratelimit%& condition to
28445 control when its database is updated. This section describes the &%readonly%&
28446 mode, and the next section describes the &%strict%& and &%leaky%& modes.
28447
28448 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
28449 previously-computed rate to check against the limit.
28450
28451 For example, you can test the client's sending rate and deny it access (when
28452 it is too fast) in the connect ACL. If the client passes this check then it
28453 can go on to send a message, in which case its recorded rate will be updated
28454 in the MAIL ACL. Subsequent connections from the same client will check this
28455 new rate.
28456 .code
28457 acl_check_connect:
28458  deny ratelimit = 100 / 5m / readonly
28459     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
28460                   (max $sender_rate_limit)
28461 # ...
28462 acl_check_mail:
28463  warn ratelimit = 100 / 5m / strict
28464     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
28465                   (max $sender_rate_limit)
28466 .endd
28467
28468 If Exim encounters multiple &%ratelimit%& conditions with the same key when
28469 processing a message then it may increase the client's measured rate more than
28470 it should. For example, this will happen if you check the &%per_rcpt%& option
28471 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
28472 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
28473 multiple update problems by using the &%readonly%& option on later ratelimit
28474 checks.
28475
28476 The &%per_*%& options described above do not make sense in some ACLs. If you
28477 use a &%per_*%& option in an ACL where it is not normally permitted then the
28478 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
28479 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
28480 next section) so you must specify the &%readonly%& option explicitly.
28481
28482
28483 .section "Ratelimit options for handling fast clients" "ratoptfast"
28484 .cindex "rate limiting" "strict and leaky modes"
28485 If a client's average rate is greater than the maximum, the rate limiting
28486 engine can react in two possible ways, depending on the presence of the
28487 &%strict%& or &%leaky%& update modes. This is independent of the other
28488 counter-measures (such as rejecting the message) that may be specified by the
28489 rest of the ACL.
28490
28491 The &%leaky%& (default) option means that the client's recorded rate is not
28492 updated if it is above the limit. The effect of this is that Exim measures the
28493 client's average rate of successfully sent email, which cannot be greater than
28494 the maximum allowed. If the client is over the limit it may suffer some
28495 counter-measures (as specified in the ACL), but it will still be able to send
28496 email at the configured maximum rate, whatever the rate of its attempts. This
28497 is generally the better choice if you have clients that retry automatically.
28498 For example, it does not prevent a sender with an over-aggressive retry rate
28499 from getting any email through.
28500
28501 The &%strict%& option means that the client's recorded rate is always
28502 updated. The effect of this is that Exim measures the client's average rate
28503 of attempts to send email, which can be much higher than the maximum it is
28504 actually allowed. If the client is over the limit it may be subjected to
28505 counter-measures by the ACL. It must slow down and allow sufficient time to
28506 pass that its computed rate falls below the maximum before it can send email
28507 again. The time (the number of smoothing periods) it must wait and not
28508 attempt to send mail can be calculated with this formula:
28509 .code
28510         ln(peakrate/maxrate)
28511 .endd
28512
28513
28514 .section "Limiting the rate of different events" "ratoptuniq"
28515 .cindex "rate limiting" "counting unique events"
28516 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
28517 rate of different events. For example, the &%per_addr%& option uses this
28518 mechanism to count the number of different recipients that the client has
28519 sent messages to in the last time period; it is equivalent to
28520 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
28521 measure the rate that a client uses different sender addresses with the
28522 options &`per_mail/unique=$sender_address`&.
28523
28524 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
28525 has seen for that key. The whole set is thrown away when it is older than the
28526 rate smoothing period &'p'&, so each different event is counted at most once
28527 per period. In the &%leaky%& update mode, an event that causes the client to
28528 go over the limit is not added to the set, in the same way that the client's
28529 recorded rate is not updated in the same situation.
28530
28531 When you combine the &%unique=%& and &%readonly%& options, the specific
28532 &%unique=%& value is ignored, and Exim just retrieves the client's stored
28533 rate.
28534
28535 The &%unique=%& mechanism needs more space in the ratelimit database than the
28536 other &%ratelimit%& options in order to store the event set. The number of
28537 unique values is potentially as large as the rate limit, so the extra space
28538 required increases with larger limits.
28539
28540 The uniqueification is not perfect: there is a small probability that Exim
28541 will think a new event has happened before. If the sender's rate is less than
28542 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
28543 the measured rate can go above the limit, in which case Exim may under-count
28544 events by a significant margin. Fortunately, if the rate is high enough (2.7
28545 times the limit) that the false positive rate goes above 9%, then Exim will
28546 throw away the over-full event set before the measured rate falls below the
28547 limit. Therefore the only harm should be that exceptionally high sending rates
28548 are logged incorrectly; any countermeasures you configure will be as effective
28549 as intended.
28550
28551
28552 .section "Using rate limiting" "useratlim"
28553 Exim's other ACL facilities are used to define what counter-measures are taken
28554 when the rate limit is exceeded. This might be anything from logging a warning
28555 (for example, while measuring existing sending rates in order to define
28556 policy), through time delays to slow down fast senders, up to rejecting the
28557 message. For example:
28558 .code
28559 # Log all senders' rates
28560 warn ratelimit = 0 / 1h / strict
28561      log_message = Sender rate $sender_rate / $sender_rate_period
28562
28563 # Slow down fast senders; note the need to truncate $sender_rate
28564 # at the decimal point.
28565 warn ratelimit = 100 / 1h / per_rcpt / strict
28566      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
28567                    $sender_rate_limit }s
28568
28569 # Keep authenticated users under control
28570 deny authenticated = *
28571      ratelimit = 100 / 1d / strict / $authenticated_id
28572
28573 # System-wide rate limit
28574 defer message = Sorry, too busy. Try again later.
28575      ratelimit = 10 / 1s / $primary_hostname
28576
28577 # Restrict incoming rate from each host, with a default
28578 # set using a macro and special cases looked up in a table.
28579 defer message = Sender rate exceeds $sender_rate_limit \
28580                messages per $sender_rate_period
28581      ratelimit = ${lookup {$sender_host_address} \
28582                    cdb {DB/ratelimits.cdb} \
28583                    {$value} {RATELIMIT} }
28584 .endd
28585 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
28586 especially with the &%per_rcpt%& option, you may suffer from a performance
28587 bottleneck caused by locking on the ratelimit hints database. Apart from
28588 making your ACLs less complicated, you can reduce the problem by using a
28589 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
28590 this means that Exim will lose its hints data after a reboot (including retry
28591 hints, the callout cache, and ratelimit data).
28592
28593
28594
28595 .section "Address verification" "SECTaddressverification"
28596 .cindex "verifying address" "options for"
28597 .cindex "policy control" "address verification"
28598 Several of the &%verify%& conditions described in section
28599 &<<SECTaclconditions>>& cause addresses to be verified. Section
28600 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
28601 The verification conditions can be followed by options that modify the
28602 verification process. The options are separated from the keyword and from each
28603 other by slashes, and some of them contain parameters. For example:
28604 .code
28605 verify = sender/callout
28606 verify = recipient/defer_ok/callout=10s,defer_ok
28607 .endd
28608 The first stage of address verification, which always happens, is to run the
28609 address through the routers, in &"verify mode"&. Routers can detect the
28610 difference between verification and routing for delivery, and their actions can
28611 be varied by a number of generic options such as &%verify%& and &%verify_only%&
28612 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
28613 The available options are as follows:
28614
28615 .ilist
28616 If the &%callout%& option is specified, successful routing to one or more
28617 remote hosts is followed by a &"callout"& to those hosts as an additional
28618 check. Callouts and their sub-options are discussed in the next section.
28619 .next
28620 If there is a defer error while doing verification routing, the ACL
28621 normally returns &"defer"&. However, if you include &%defer_ok%& in the
28622 options, the condition is forced to be true instead. Note that this is a main
28623 verification option as well as a suboption for callouts.
28624 .next
28625 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
28626 discusses the reporting of sender address verification failures.
28627 .next
28628 The &%success_on_redirect%& option causes verification always to succeed
28629 immediately after a successful redirection. By default, if a redirection
28630 generates just one address, that address is also verified. See further
28631 discussion in section &<<SECTredirwhilveri>>&.
28632 .endlist
28633
28634 .cindex "verifying address" "differentiating failures"
28635 .vindex "&$recipient_verify_failure$&"
28636 .vindex "&$sender_verify_failure$&"
28637 .vindex "&$acl_verify_message$&"
28638 After an address verification failure, &$acl_verify_message$& contains the
28639 error message that is associated with the failure. It can be preserved by
28640 coding like this:
28641 .code
28642 warn  !verify = sender
28643        set acl_m0 = $acl_verify_message
28644 .endd
28645 If you are writing your own custom rejection message or log message when
28646 denying access, you can use this variable to include information about the
28647 verification failure.
28648
28649 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
28650 appropriate) contains one of the following words:
28651
28652 .ilist
28653 &%qualify%&: The address was unqualified (no domain), and the message
28654 was neither local nor came from an exempted host.
28655 .next
28656 &%route%&: Routing failed.
28657 .next
28658 &%mail%&: Routing succeeded, and a callout was attempted; rejection
28659 occurred at or before the MAIL command (that is, on initial
28660 connection, HELO, or MAIL).
28661 .next
28662 &%recipient%&: The RCPT command in a callout was rejected.
28663 .next
28664 &%postmaster%&: The postmaster check in a callout was rejected.
28665 .endlist
28666
28667 The main use of these variables is expected to be to distinguish between
28668 rejections of MAIL and rejections of RCPT in callouts.
28669
28670
28671
28672
28673 .section "Callout verification" "SECTcallver"
28674 .cindex "verifying address" "by callout"
28675 .cindex "callout" "verification"
28676 .cindex "SMTP" "callout verification"
28677 For non-local addresses, routing verifies the domain, but is unable to do any
28678 checking of the local part. There are situations where some means of verifying
28679 the local part is desirable. One way this can be done is to make an SMTP
28680 &'callback'& to a delivery host for the sender address or a &'callforward'& to
28681 a subsequent host for a recipient address, to see if the host accepts the
28682 address. We use the term &'callout'& to cover both cases. Note that for a
28683 sender address, the callback is not to the client host that is trying to
28684 deliver the message, but to one of the hosts that accepts incoming mail for the
28685 sender's domain.
28686
28687 Exim does not do callouts by default. If you want them to happen, you must
28688 request them by setting appropriate options on the &%verify%& condition, as
28689 described below. This facility should be used with care, because it can add a
28690 lot of resource usage to the cost of verifying an address. However, Exim does
28691 cache the results of callouts, which helps to reduce the cost. Details of
28692 caching are in section &<<SECTcallvercache>>&.
28693
28694 Recipient callouts are usually used only between hosts that are controlled by
28695 the same administration. For example, a corporate gateway host could use
28696 callouts to check for valid recipients on an internal mailserver. A successful
28697 callout does not guarantee that a real delivery to the address would succeed;
28698 on the other hand, a failing callout does guarantee that a delivery would fail.
28699
28700 If the &%callout%& option is present on a condition that verifies an address, a
28701 second stage of verification occurs if the address is successfully routed to
28702 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
28703 &(manualroute)& router, where the router specifies the hosts. However, if a
28704 router that does not set up hosts routes to an &(smtp)& transport with a
28705 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
28706 &%hosts_override%& set, its hosts are always used, whether or not the router
28707 supplies a host list.
28708
28709 The port that is used is taken from the transport, if it is specified and is a
28710 remote transport. (For routers that do verification only, no transport need be
28711 specified.) Otherwise, the default SMTP port is used. If a remote transport
28712 specifies an outgoing interface, this is used; otherwise the interface is not
28713 specified. Likewise, the text that is used for the HELO command is taken from
28714 the transport's &%helo_data%& option; if there is no transport, the value of
28715 &$smtp_active_hostname$& is used.
28716
28717 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
28718 test whether a bounce message could be delivered to the sender address. The
28719 following SMTP commands are sent:
28720 .display
28721 &`HELO `&<&'local host name'&>
28722 &`MAIL FROM:<>`&
28723 &`RCPT TO:`&<&'the address to be tested'&>
28724 &`QUIT`&
28725 .endd
28726 LHLO is used instead of HELO if the transport's &%protocol%& option is
28727 set to &"lmtp"&.
28728
28729 A recipient callout check is similar. By default, it also uses an empty address
28730 for the sender. This default is chosen because most hosts do not make use of
28731 the sender address when verifying a recipient. Using the same address means
28732 that a single cache entry can be used for each recipient. Some sites, however,
28733 do make use of the sender address when verifying. These are catered for by the
28734 &%use_sender%& and &%use_postmaster%& options, described in the next section.
28735
28736 If the response to the RCPT command is a 2&'xx'& code, the verification
28737 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
28738 Exim tries the next host, if any. If there is a problem with all the remote
28739 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
28740 &%callout%& option is given, in which case the condition is forced to succeed.
28741
28742 .cindex "SMTP" "output flushing, disabling for callout"
28743 A callout may take a little time. For this reason, Exim normally flushes SMTP
28744 output before performing a callout in an ACL, to avoid unexpected timeouts in
28745 clients when the SMTP PIPELINING extension is in use. The flushing can be
28746 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
28747
28748
28749
28750
28751 .section "Additional parameters for callouts" "CALLaddparcall"
28752 .cindex "callout" "additional parameters for"
28753 The &%callout%& option can be followed by an equals sign and a number of
28754 optional parameters, separated by commas. For example:
28755 .code
28756 verify = recipient/callout=10s,defer_ok
28757 .endd
28758 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
28759 separate verify options, is retained for backwards compatibility, but is now
28760 deprecated. The additional parameters for &%callout%& are as follows:
28761
28762
28763 .vlist
28764 .vitem <&'a&~time&~interval'&>
28765 .cindex "callout" "timeout, specifying"
28766 This specifies the timeout that applies for the callout attempt to each host.
28767 For example:
28768 .code
28769 verify = sender/callout=5s
28770 .endd
28771 The default is 30 seconds. The timeout is used for each response from the
28772 remote host. It is also used for the initial connection, unless overridden by
28773 the &%connect%& parameter.
28774
28775
28776 .vitem &*connect&~=&~*&<&'time&~interval'&>
28777 .cindex "callout" "connection timeout, specifying"
28778 This parameter makes it possible to set a different (usually smaller) timeout
28779 for making the SMTP connection. For example:
28780 .code
28781 verify = sender/callout=5s,connect=1s
28782 .endd
28783 If not specified, this timeout defaults to the general timeout value.
28784
28785 .vitem &*defer_ok*&
28786 .cindex "callout" "defer, action on"
28787 When this parameter is present, failure to contact any host, or any other kind
28788 of temporary error, is treated as success by the ACL. However, the cache is not
28789 updated in this circumstance.
28790
28791 .vitem &*fullpostmaster*&
28792 .cindex "callout" "full postmaster check"
28793 This operates like the &%postmaster%& option (see below), but if the check for
28794 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
28795 accordance with the specification in RFC 2821. The RFC states that the
28796 unqualified address &'postmaster'& should be accepted.
28797
28798
28799 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
28800 .cindex "callout" "sender when verifying header"
28801 When verifying addresses in header lines using the &%header_sender%&
28802 verification option, Exim behaves by default as if the addresses are envelope
28803 sender addresses from a message. Callout verification therefore tests to see
28804 whether a bounce message could be delivered, by using an empty address in the
28805 MAIL command. However, it is arguable that these addresses might never be used
28806 as envelope senders, and could therefore justifiably reject bounce messages
28807 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
28808 address to use in the MAIL command. For example:
28809 .code
28810 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
28811 .endd
28812 This parameter is available only for the &%header_sender%& verification option.
28813
28814
28815 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
28816 .cindex "callout" "overall timeout, specifying"
28817 This parameter sets an overall timeout for performing a callout verification.
28818 For example:
28819 .code
28820 verify = sender/callout=5s,maxwait=30s
28821 .endd
28822 This timeout defaults to four times the callout timeout for individual SMTP
28823 commands. The overall timeout applies when there is more than one host that can
28824 be tried. The timeout is checked before trying the next host. This prevents
28825 very long delays if there are a large number of hosts and all are timing out
28826 (for example, when network connections are timing out).
28827
28828
28829 .vitem &*no_cache*&
28830 .cindex "callout" "cache, suppressing"
28831 .cindex "caching callout, suppressing"
28832 When this parameter is given, the callout cache is neither read nor updated.
28833
28834 .vitem &*postmaster*&
28835 .cindex "callout" "postmaster; checking"
28836 When this parameter is set, a successful callout check is followed by a similar
28837 check for the local part &'postmaster'& at the same domain. If this address is
28838 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
28839 the postmaster check is recorded in a cache record; if it is a failure, this is
28840 used to fail subsequent callouts for the domain without a connection being
28841 made, until the cache record expires.
28842
28843 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
28844 The postmaster check uses an empty sender in the MAIL command by default.
28845 You can use this parameter to do a postmaster check using a different address.
28846 For example:
28847 .code
28848 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
28849 .endd
28850 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
28851 one overrides. The &%postmaster%& parameter is equivalent to this example:
28852 .code
28853 require  verify = sender/callout=postmaster_mailfrom=
28854 .endd
28855 &*Warning*&: The caching arrangements for postmaster checking do not take
28856 account of the sender address. It is assumed that either the empty address or
28857 a fixed non-empty address will be used. All that Exim remembers is that the
28858 postmaster check for the domain succeeded or failed.
28859
28860
28861 .vitem &*random*&
28862 .cindex "callout" "&""random""& check"
28863 When this parameter is set, before doing the normal callout check, Exim does a
28864 check for a &"random"& local part at the same domain. The local part is not
28865 really random &-- it is defined by the expansion of the option
28866 &%callout_random_local_part%&, which defaults to
28867 .code
28868 $primary_hostname-$tod_epoch-testing
28869 .endd
28870 The idea here is to try to determine whether the remote host accepts all local
28871 parts without checking. If it does, there is no point in doing callouts for
28872 specific local parts. If the &"random"& check succeeds, the result is saved in
28873 a cache record, and used to force the current and subsequent callout checks to
28874 succeed without a connection being made, until the cache record expires.
28875
28876 .vitem &*use_postmaster*&
28877 .cindex "callout" "sender for recipient check"
28878 This parameter applies to recipient callouts only. For example:
28879 .code
28880 deny  !verify = recipient/callout=use_postmaster
28881 .endd
28882 .vindex "&$qualify_domain$&"
28883 It causes a non-empty postmaster address to be used in the MAIL command when
28884 performing the callout for the recipient, and also for a &"random"& check if
28885 that is configured. The local part of the address is &`postmaster`& and the
28886 domain is the contents of &$qualify_domain$&.
28887
28888 .vitem &*use_sender*&
28889 This option applies to recipient callouts only. For example:
28890 .code
28891 require  verify = recipient/callout=use_sender
28892 .endd
28893 It causes the message's actual sender address to be used in the MAIL
28894 command when performing the callout, instead of an empty address. There is no
28895 need to use this option unless you know that the called hosts make use of the
28896 sender when checking recipients. If used indiscriminately, it reduces the
28897 usefulness of callout caching.
28898 .endlist
28899
28900 If you use any of the parameters that set a non-empty sender for the MAIL
28901 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
28902 &%use_sender%&), you should think about possible loops. Recipient checking is
28903 usually done between two hosts that are under the same management, and the host
28904 that receives the callouts is not normally configured to do callouts itself.
28905 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
28906 these circumstances.
28907
28908 However, if you use a non-empty sender address for a callout to an arbitrary
28909 host, there is the likelihood that the remote host will itself initiate a
28910 callout check back to your host. As it is checking what appears to be a message
28911 sender, it is likely to use an empty address in MAIL, thus avoiding a
28912 callout loop. However, to be on the safe side it would be best to set up your
28913 own ACLs so that they do not do sender verification checks when the recipient
28914 is the address you use for header sender or postmaster callout checking.
28915
28916 Another issue to think about when using non-empty senders for callouts is
28917 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
28918 by the sender/recipient combination; thus, for any given recipient, many more
28919 actual callouts are performed than when an empty sender or postmaster is used.
28920
28921
28922
28923
28924 .section "Callout caching" "SECTcallvercache"
28925 .cindex "hints database" "callout cache"
28926 .cindex "callout" "cache, description of"
28927 .cindex "caching" "callout"
28928 Exim caches the results of callouts in order to reduce the amount of resources
28929 used, unless you specify the &%no_cache%& parameter with the &%callout%&
28930 option. A hints database called &"callout"& is used for the cache. Two
28931 different record types are used: one records the result of a callout check for
28932 a specific address, and the other records information that applies to the
28933 entire domain (for example, that it accepts the local part &'postmaster'&).
28934
28935 When an original callout fails, a detailed SMTP error message is given about
28936 the failure. However, for subsequent failures use the cache data, this message
28937 is not available.
28938
28939 The expiry times for negative and positive address cache records are
28940 independent, and can be set by the global options &%callout_negative_expire%&
28941 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
28942
28943 If a host gives a negative response to an SMTP connection, or rejects any
28944 commands up to and including
28945 .code
28946 MAIL FROM:<>
28947 .endd
28948 (but not including the MAIL command with a non-empty address),
28949 any callout attempt is bound to fail. Exim remembers such failures in a
28950 domain cache record, which it uses to fail callouts for the domain without
28951 making new connections, until the domain record times out. There are two
28952 separate expiry times for domain cache records:
28953 &%callout_domain_negative_expire%& (default 3h) and
28954 &%callout_domain_positive_expire%& (default 7d).
28955
28956 Domain records expire when the negative expiry time is reached if callouts
28957 cannot be made for the domain, or if the postmaster check failed.
28958 Otherwise, they expire when the positive expiry time is reached. This
28959 ensures that, for example, a host that stops accepting &"random"& local parts
28960 will eventually be noticed.
28961
28962 The callout caching mechanism is based on the domain of the address that is
28963 being tested. If the domain routes to several hosts, it is assumed that their
28964 behaviour will be the same.
28965
28966
28967
28968 .section "Sender address verification reporting" "SECTsenaddver"
28969 .cindex "verifying" "suppressing error details"
28970 See section &<<SECTaddressverification>>& for a general discussion of
28971 verification. When sender verification fails in an ACL, the details of the
28972 failure are given as additional output lines before the 550 response to the
28973 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
28974 you might see:
28975 .code
28976 MAIL FROM:<xyz@abc.example>
28977 250 OK
28978 RCPT TO:<pqr@def.example>
28979 550-Verification failed for <xyz@abc.example>
28980 550-Called:   192.168.34.43
28981 550-Sent:     RCPT TO:<xyz@abc.example>
28982 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
28983 550 Sender verification failed
28984 .endd
28985 If more than one RCPT command fails in the same way, the details are given
28986 only for the first of them. However, some administrators do not want to send
28987 out this much information. You can suppress the details by adding
28988 &`/no_details`& to the ACL statement that requests sender verification. For
28989 example:
28990 .code
28991 verify = sender/no_details
28992 .endd
28993
28994 .section "Redirection while verifying" "SECTredirwhilveri"
28995 .cindex "verifying" "redirection while"
28996 .cindex "address redirection" "while verifying"
28997 A dilemma arises when a local address is redirected by aliasing or forwarding
28998 during verification: should the generated addresses themselves be verified,
28999 or should the successful expansion of the original address be enough to verify
29000 it? By default, Exim takes the following pragmatic approach:
29001
29002 .ilist
29003 When an incoming address is redirected to just one child address, verification
29004 continues with the child address, and if that fails to verify, the original
29005 verification also fails.
29006 .next
29007 When an incoming address is redirected to more than one child address,
29008 verification does not continue. A success result is returned.
29009 .endlist
29010
29011 This seems the most reasonable behaviour for the common use of aliasing as a
29012 way of redirecting different local parts to the same mailbox. It means, for
29013 example, that a pair of alias entries of the form
29014 .code
29015 A.Wol:   aw123
29016 aw123:   :fail: Gone away, no forwarding address
29017 .endd
29018 work as expected, with both local parts causing verification failure. When a
29019 redirection generates more than one address, the behaviour is more like a
29020 mailing list, where the existence of the alias itself is sufficient for
29021 verification to succeed.
29022
29023 It is possible, however, to change the default behaviour so that all successful
29024 redirections count as successful verifications, however many new addresses are
29025 generated. This is specified by the &%success_on_redirect%& verification
29026 option. For example:
29027 .code
29028 require verify = recipient/success_on_redirect/callout=10s
29029 .endd
29030 In this example, verification succeeds if a router generates a new address, and
29031 the callout does not occur, because no address was routed to a remote host.
29032
29033 When verification is being tested via the &%-bv%& option, the treatment of
29034 redirections is as just described, unless the &%-v%& or any debugging option is
29035 also specified. In that case, full verification is done for every generated
29036 address and a report is output for each of them.
29037
29038
29039
29040 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
29041 .cindex "CSA" "verifying"
29042 Client SMTP Authorization is a system that allows a site to advertise
29043 which machines are and are not permitted to send email. This is done by placing
29044 special SRV records in the DNS; these are looked up using the client's HELO
29045 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
29046 Authorization checks in Exim are performed by the ACL condition:
29047 .code
29048 verify = csa
29049 .endd
29050 This fails if the client is not authorized. If there is a DNS problem, or if no
29051 valid CSA SRV record is found, or if the client is authorized, the condition
29052 succeeds. These three cases can be distinguished using the expansion variable
29053 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
29054 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
29055 be likely to cause problems for legitimate email.
29056
29057 The error messages produced by the CSA code include slightly more
29058 detail. If &$csa_status$& is &"defer"&, this may be because of problems
29059 looking up the CSA SRV record, or problems looking up the CSA target
29060 address record. There are four reasons for &$csa_status$& being &"fail"&:
29061
29062 .ilist
29063 The client's host name is explicitly not authorized.
29064 .next
29065 The client's IP address does not match any of the CSA target IP addresses.
29066 .next
29067 The client's host name is authorized but it has no valid target IP addresses
29068 (for example, the target's addresses are IPv6 and the client is using IPv4).
29069 .next
29070 The client's host name has no CSA SRV record but a parent domain has asserted
29071 that all subdomains must be explicitly authorized.
29072 .endlist
29073
29074 The &%csa%& verification condition can take an argument which is the domain to
29075 use for the DNS query. The default is:
29076 .code
29077 verify = csa/$sender_helo_name
29078 .endd
29079 This implementation includes an extension to CSA. If the query domain
29080 is an address literal such as [192.0.2.95], or if it is a bare IP
29081 address, Exim searches for CSA SRV records in the reverse DNS as if
29082 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
29083 meaningful to say:
29084 .code
29085 verify = csa/$sender_host_address
29086 .endd
29087 In fact, this is the check that Exim performs if the client does not say HELO.
29088 This extension can be turned off by setting the main configuration option
29089 &%dns_csa_use_reverse%& to be false.
29090
29091 If a CSA SRV record is not found for the domain itself, a search
29092 is performed through its parent domains for a record which might be
29093 making assertions about subdomains. The maximum depth of this search is limited
29094 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
29095 default. Exim does not look for CSA SRV records in a top level domain, so the
29096 default settings handle HELO domains as long as seven
29097 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
29098 of legitimate HELO domains.
29099
29100 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
29101 direct SRV lookups, this is not sufficient because of the extra parent domain
29102 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
29103 addresses into lookups in the reverse DNS space. The result of a successful
29104 lookup such as:
29105 .code
29106 ${lookup dnsdb {csa=$sender_helo_name}}
29107 .endd
29108 has two space-separated fields: an authorization code and a target host name.
29109 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
29110 authorization required but absent, or &"?"& for unknown.
29111
29112
29113
29114
29115 .section "Bounce address tag validation" "SECTverifyPRVS"
29116 .cindex "BATV, verifying"
29117 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
29118 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
29119 Genuine incoming bounce messages should therefore always be addressed to
29120 recipients that have a valid tag. This scheme is a way of detecting unwanted
29121 bounce messages caused by sender address forgeries (often called &"collateral
29122 spam"&), because the recipients of such messages do not include valid tags.
29123
29124 There are two expansion items to help with the implementation of the BATV
29125 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
29126 the original envelope sender address by using a simple key to add a hash of the
29127 address and some time-based randomizing information. The &%prvs%& expansion
29128 item creates a signed address, and the &%prvscheck%& expansion item checks one.
29129 The syntax of these expansion items is described in section
29130 &<<SECTexpansionitems>>&.
29131
29132 As an example, suppose the secret per-address keys are stored in an MySQL
29133 database. A query to look up the key for an address could be defined as a macro
29134 like this:
29135 .code
29136 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
29137                 WHERE sender='${quote_mysql:$prvscheck_address}'\
29138                 }{$value}}
29139 .endd
29140 Suppose also that the senders who make use of BATV are defined by an address
29141 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
29142 use this:
29143 .code
29144 # Bounces: drop unsigned addresses for BATV senders
29145 deny message = This address does not send an unsigned reverse path
29146      senders = :
29147      recipients = +batv_senders
29148
29149 # Bounces: In case of prvs-signed address, check signature.
29150 deny message = Invalid reverse path signature.
29151      senders = :
29152      condition  = ${prvscheck {$local_part@$domain}\
29153                   {PRVSCHECK_SQL}{1}}
29154      !condition = $prvscheck_result
29155 .endd
29156 The first statement rejects recipients for bounce messages that are addressed
29157 to plain BATV sender addresses, because it is known that BATV senders do not
29158 send out messages with plain sender addresses. The second statement rejects
29159 recipients that are prvs-signed, but with invalid signatures (either because
29160 the key is wrong, or the signature has timed out).
29161
29162 A non-prvs-signed address is not rejected by the second statement, because the
29163 &%prvscheck%& expansion yields an empty string if its first argument is not a
29164 prvs-signed address, thus causing the &%condition%& condition to be false. If
29165 the first argument is a syntactically valid prvs-signed address, the yield is
29166 the third string (in this case &"1"&), whether or not the cryptographic and
29167 timeout checks succeed. The &$prvscheck_result$& variable contains the result
29168 of the checks (empty for failure, &"1"& for success).
29169
29170 There is one more issue you must consider when implementing prvs-signing:
29171 you have to ensure that the routers accept prvs-signed addresses and
29172 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
29173 router to remove the signature with a configuration along these lines:
29174 .code
29175 batv_redirect:
29176   driver = redirect
29177   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
29178 .endd
29179 This works because, if the third argument of &%prvscheck%& is empty, the result
29180 of the expansion of a prvs-signed address is the decoded value of the original
29181 address. This router should probably be the first of your routers that handles
29182 local addresses.
29183
29184 To create BATV-signed addresses in the first place, a transport of this form
29185 can be used:
29186 .code
29187 external_smtp_batv:
29188   driver = smtp
29189   return_path = ${prvs {$return_path} \
29190                        {${lookup mysql{SELECT \
29191                        secret FROM batv_prvs WHERE \
29192                        sender='${quote_mysql:$sender_address}'} \
29193                        {$value}fail}}}
29194 .endd
29195 If no key can be found for the existing return path, no signing takes place.
29196
29197
29198
29199 .section "Using an ACL to control relaying" "SECTrelaycontrol"
29200 .cindex "&ACL;" "relay control"
29201 .cindex "relaying" "control by ACL"
29202 .cindex "policy control" "relay control"
29203 An MTA is said to &'relay'& a message if it receives it from some host and
29204 delivers it directly to another host as a result of a remote address contained
29205 within it. Redirecting a local address via an alias or forward file and then
29206 passing the message on to another host is not relaying,
29207 .cindex "&""percent hack""&"
29208 but a redirection as a result of the &"percent hack"& is.
29209
29210 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
29211 A host which is acting as a gateway or an MX backup is concerned with incoming
29212 relaying from arbitrary hosts to a specific set of domains. On the other hand,
29213 a host which is acting as a smart host for a number of clients is concerned
29214 with outgoing relaying from those clients to the Internet at large. Often the
29215 same host is fulfilling both functions,
29216 . ///
29217 . as illustrated in the diagram below,
29218 . ///
29219 but in principle these two kinds of relaying are entirely independent. What is
29220 not wanted is the transmission of mail from arbitrary remote hosts through your
29221 system to arbitrary domains.
29222
29223
29224 You can implement relay control by means of suitable statements in the ACL that
29225 runs for each RCPT command. For convenience, it is often easiest to use
29226 Exim's named list facility to define the domains and hosts involved. For
29227 example, suppose you want to do the following:
29228
29229 .ilist
29230 Deliver a number of domains to mailboxes on the local host (or process them
29231 locally in some other way). Let's say these are &'my.dom1.example'& and
29232 &'my.dom2.example'&.
29233 .next
29234 Relay mail for a number of other domains for which you are the secondary MX.
29235 These might be &'friend1.example'& and &'friend2.example'&.
29236 .next
29237 Relay mail from the hosts on your local LAN, to whatever domains are involved.
29238 Suppose your LAN is 192.168.45.0/24.
29239 .endlist
29240
29241
29242 In the main part of the configuration, you put the following definitions:
29243 .code
29244 domainlist local_domains    = my.dom1.example : my.dom2.example
29245 domainlist relay_to_domains = friend1.example : friend2.example
29246 hostlist   relay_from_hosts = 192.168.45.0/24
29247 .endd
29248 Now you can use these definitions in the ACL that is run for every RCPT
29249 command:
29250 .code
29251 acl_check_rcpt:
29252   accept domains = +local_domains : +relay_to_domains
29253   accept hosts   = +relay_from_hosts
29254 .endd
29255 The first statement accepts any RCPT command that contains an address in
29256 the local or relay domains. For any other domain, control passes to the second
29257 statement, which accepts the command only if it comes from one of the relay
29258 hosts. In practice, you will probably want to make your ACL more sophisticated
29259 than this, for example, by including sender and recipient verification. The
29260 default configuration includes a more comprehensive example, which is described
29261 in chapter &<<CHAPdefconfil>>&.
29262
29263
29264
29265 .section "Checking a relay configuration" "SECTcheralcon"
29266 .cindex "relaying" "checking control of"
29267 You can check the relay characteristics of your configuration in the same way
29268 that you can test any ACL behaviour for an incoming SMTP connection, by using
29269 the &%-bh%& option to run a fake SMTP session with which you interact.
29270
29271 For specifically testing for unwanted relaying, the host
29272 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
29273 host from the host on which Exim is running, using the normal telnet port, you
29274 will see a normal telnet connection message and then quite a long delay. Be
29275 patient. The remote host is making an SMTP connection back to your host, and
29276 trying a number of common probes to test for open relay vulnerability. The
29277 results of the tests will eventually appear on your terminal.
29278 .ecindex IIDacl
29279
29280
29281
29282 . ////////////////////////////////////////////////////////////////////////////
29283 . ////////////////////////////////////////////////////////////////////////////
29284
29285 .chapter "Content scanning at ACL time" "CHAPexiscan"
29286 .scindex IIDcosca "content scanning" "at ACL time"
29287 The extension of Exim to include content scanning at ACL time, formerly known
29288 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
29289 was integrated into the main source for Exim release 4.50, and Tom continues to
29290 maintain it. Most of the wording of this chapter is taken from Tom's
29291 specification.
29292
29293 It is also possible to scan the content of messages at other times. The
29294 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
29295 scanning after all the ACLs have run. A transport filter can be used to scan
29296 messages at delivery time (see the &%transport_filter%& option, described in
29297 chapter &<<CHAPtransportgeneric>>&).
29298
29299 If you want to include the ACL-time content-scanning features when you compile
29300 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
29301 &_Local/Makefile_&. When you do that, the Exim binary is built with:
29302
29303 .ilist
29304 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
29305 for all MIME parts for SMTP and non-SMTP messages, respectively.
29306 .next
29307 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
29308 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
29309 run at the end of message reception (the &%acl_smtp_data%& ACL).
29310 .next
29311 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
29312 of messages, or parts of messages, for debugging purposes.
29313 .next
29314 Additional expansion variables that are set in the new ACL and by the new
29315 conditions.
29316 .next
29317 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
29318 .endlist
29319
29320 There is another content-scanning configuration option for &_Local/Makefile_&,
29321 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
29322 condition is compiled, in addition to all the other content-scanning features.
29323
29324 Content-scanning is continually evolving, and new features are still being
29325 added. While such features are still unstable and liable to incompatible
29326 changes, they are made available in Exim by setting options whose names begin
29327 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
29328 this manual. You can find out about them by reading the file called
29329 &_doc/experimental.txt_&.
29330
29331 All the content-scanning facilities work on a MBOX copy of the message that is
29332 temporarily created in a file called:
29333 .display
29334 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
29335 .endd
29336 The &_.eml_& extension is a friendly hint to virus scanners that they can
29337 expect an MBOX-like structure inside that file. The file is created when the
29338 first content scanning facility is called. Subsequent calls to content
29339 scanning conditions open the same file again. The directory is recursively
29340 removed when the &%acl_smtp_data%& ACL has finished running, unless
29341 .code
29342 control = no_mbox_unspool
29343 .endd
29344 has been encountered. When the MIME ACL decodes files, they are put into the
29345 same directory by default.
29346
29347
29348
29349 .section "Scanning for viruses" "SECTscanvirus"
29350 .cindex "virus scanning"
29351 .cindex "content scanning" "for viruses"
29352 .cindex "content scanning" "the &%malware%& condition"
29353 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
29354 It supports a &"generic"& interface to scanners called via the shell, and
29355 specialized interfaces for &"daemon"& type virus scanners, which are resident
29356 in memory and thus are much faster.
29357
29358
29359 .oindex "&%av_scanner%&"
29360 You can set the &%av_scanner%& option in first part of the Exim configuration
29361 file to specify which scanner to use, together with any additional options that
29362 are needed. The basic syntax is as follows:
29363 .display
29364 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
29365 .endd
29366 If you do not set &%av_scanner%&, it defaults to
29367 .code
29368 av_scanner = sophie:/var/run/sophie
29369 .endd
29370 If the value of &%av_scanner%& starts with a dollar character, it is expanded
29371 before use. The following scanner types are supported in this release:
29372
29373 .vlist
29374 .vitem &%aveserver%&
29375 .cindex "virus scanners" "Kaspersky"
29376 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
29377 at &url(http://www.kaspersky.com). This scanner type takes one option,
29378 which is the path to the daemon's UNIX socket. The default is shown in this
29379 example:
29380 .code
29381 av_scanner = aveserver:/var/run/aveserver
29382 .endd
29383
29384
29385 .vitem &%clamd%&
29386 .cindex "virus scanners" "clamd"
29387 This daemon-type scanner is GPL and free. You can get it at
29388 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
29389 unpack MIME containers, so it used to be recommended to unpack MIME attachments
29390 in the MIME ACL. This no longer believed to be necessary. One option is
29391 required: either the path and name of a UNIX socket file, or a hostname or IP
29392 number, and a port, separated by space, as in the second of these examples:
29393 .code
29394 av_scanner = clamd:/opt/clamd/socket
29395 av_scanner = clamd:192.0.2.3 1234
29396 av_scanner = clamd:192.0.2.3 1234:local
29397 .endd
29398 If the value of av_scanner points to a UNIX socket file or contains the local
29399 keyword, then the ClamAV interface will pass a filename containing the data
29400 to be scanned, which will should normally result in less I/O happening and be
29401 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
29402 Exim does not assume that there is a common filesystem with the remote host.
29403 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
29404 you be running a version of ClamAV prior to 0.95.
29405 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
29406 contributing the code for this scanner.
29407
29408 .vitem &%cmdline%&
29409 .cindex "virus scanners" "command line interface"
29410 This is the keyword for the generic command line scanner interface. It can be
29411 used to attach virus scanners that are invoked from the shell. This scanner
29412 type takes 3 mandatory options:
29413
29414 .olist
29415 The full path and name of the scanner binary, with all command line options,
29416 and a placeholder (&`%s`&) for the directory to scan.
29417
29418 .next
29419 A regular expression to match against the STDOUT and STDERR output of the
29420 virus scanner. If the expression matches, a virus was found. You must make
29421 absolutely sure that this expression matches on &"virus found"&. This is called
29422 the &"trigger"& expression.
29423
29424 .next
29425 Another regular expression, containing exactly one pair of parentheses, to
29426 match the name of the virus found in the scanners output. This is called the
29427 &"name"& expression.
29428 .endlist olist
29429
29430 For example, Sophos Sweep reports a virus on a line like this:
29431 .code
29432 Virus 'W32/Magistr-B' found in file ./those.bat
29433 .endd
29434 For the trigger expression, we can match the phrase &"found in file"&. For the
29435 name expression, we want to extract the W32/Magistr-B string, so we can match
29436 for the single quotes left and right of it. Altogether, this makes the
29437 configuration setting:
29438 .code
29439 av_scanner = cmdline:\
29440              /path/to/sweep -ss -all -rec -archive %s:\
29441              found in file:'(.+)'
29442 .endd
29443 .vitem &%drweb%&
29444 .cindex "virus scanners" "DrWeb"
29445 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
29446 argument, either a full path to a UNIX socket, or an IP address and port
29447 separated by white space, as in these examples:
29448 .code
29449 av_scanner = drweb:/var/run/drwebd.sock
29450 av_scanner = drweb:192.168.2.20 31337
29451 .endd
29452 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
29453 is used. Thanks to Alex Miller for contributing the code for this scanner.
29454
29455 .vitem &%fsecure%&
29456 .cindex "virus scanners" "F-Secure"
29457 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
29458 argument which is the path to a UNIX socket. For example:
29459 .code
29460 av_scanner = fsecure:/path/to/.fsav
29461 .endd
29462 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
29463 Thelmen for contributing the code for this scanner.
29464
29465 .vitem &%kavdaemon%&
29466 .cindex "virus scanners" "Kaspersky"
29467 This is the scanner daemon of Kaspersky Version 4. This version of the
29468 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
29469 scanner type takes one option, which is the path to the daemon's UNIX socket.
29470 For example:
29471 .code
29472 av_scanner = kavdaemon:/opt/AVP/AvpCtl
29473 .endd
29474 The default path is &_/var/run/AvpCtl_&.
29475
29476 .vitem &%mksd%&
29477 .cindex "virus scanners" "mksd"
29478 This is a daemon type scanner that is aimed mainly at Polish users, though some
29479 parts of documentation are now available in English. You can get it at
29480 &url(http://linux.mks.com.pl/). The only option for this scanner type is
29481 the maximum number of processes used simultaneously to scan the attachments,
29482 provided that the demime facility is employed and also provided that mksd has
29483 been run with at least the same number of child processes. For example:
29484 .code
29485 av_scanner = mksd:2
29486 .endd
29487 You can safely omit this option (the default value is 1).
29488
29489 .vitem &%sophie%&
29490 .cindex "virus scanners" "Sophos and Sophie"
29491 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
29492 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
29493 for this scanner type is the path to the UNIX socket that Sophie uses for
29494 client communication. For example:
29495 .code
29496 av_scanner = sophie:/tmp/sophie
29497 .endd
29498 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
29499 the option.
29500 .endlist
29501
29502 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
29503 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
29504 ACL.
29505
29506 The &%av_scanner%& option is expanded each time &%malware%& is called. This
29507 makes it possible to use different scanners. See further below for an example.
29508 The &%malware%& condition caches its results, so when you use it multiple times
29509 for the same message, the actual scanning process is only carried out once.
29510 However, using expandable items in &%av_scanner%& disables this caching, in
29511 which case each use of the &%malware%& condition causes a new scan of the
29512 message.
29513
29514 The &%malware%& condition takes a right-hand argument that is expanded before
29515 use. It can then be one of
29516
29517 .ilist
29518 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
29519 The condition succeeds if a virus was found, and fail otherwise. This is the
29520 recommended usage.
29521 .next
29522 &"false"& or &"0"& or an empty string, in which case no scanning is done and
29523 the condition fails immediately.
29524 .next
29525 A regular expression, in which case the message is scanned for viruses. The
29526 condition succeeds if a virus is found and its name matches the regular
29527 expression. This allows you to take special actions on certain types of virus.
29528 .endlist
29529
29530 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
29531 even if there is a problem with the virus scanner. Otherwise, such a problem
29532 causes the ACL to defer.
29533
29534 .vindex "&$malware_name$&"
29535 When a virus is found, the condition sets up an expansion variable called
29536 &$malware_name$& that contains the name of the virus. You can use it in a
29537 &%message%& modifier that specifies the error returned to the sender, and/or in
29538 logging data.
29539
29540 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
29541 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
29542 &%malware%& condition.
29543
29544 Beware the interaction of Exim's &%message_size_limit%& with any size limits
29545 imposed by your anti-virus scanner.
29546
29547 Here is a very simple scanning example:
29548 .code
29549 deny message = This message contains malware ($malware_name)
29550      demime = *
29551      malware = *
29552 .endd
29553 The next example accepts messages when there is a problem with the scanner:
29554 .code
29555 deny message = This message contains malware ($malware_name)
29556      demime = *
29557      malware = */defer_ok
29558 .endd
29559 The next example shows how to use an ACL variable to scan with both sophie and
29560 aveserver. It assumes you have set:
29561 .code
29562 av_scanner = $acl_m0
29563 .endd
29564 in the main Exim configuration.
29565 .code
29566 deny message = This message contains malware ($malware_name)
29567      set acl_m0 = sophie
29568      malware = *
29569
29570 deny message = This message contains malware ($malware_name)
29571      set acl_m0 = aveserver
29572      malware = *
29573 .endd
29574
29575
29576 .section "Scanning with SpamAssassin" "SECTscanspamass"
29577 .cindex "content scanning" "for spam"
29578 .cindex "spam scanning"
29579 .cindex "SpamAssassin"
29580 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
29581 score and a report for the message. You can get SpamAssassin at
29582 &url(http://www.spamassassin.org), or, if you have a working Perl
29583 installation, you can use CPAN by running:
29584 .code
29585 perl -MCPAN -e 'install Mail::SpamAssassin'
29586 .endd
29587 SpamAssassin has its own set of configuration files. Please review its
29588 documentation to see how you can tweak it. The default installation should work
29589 nicely, however.
29590
29591 .oindex "&%spamd_address%&"
29592 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
29593 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
29594 port for &%spamd%&, you must set the &%spamd_address%& option in the global
29595 part of the Exim configuration as follows (example):
29596 .code
29597 spamd_address = 192.168.99.45 387
29598 .endd
29599 You do not need to set this option if you use the default. As of version 2.60,
29600 &%spamd%& also supports communication over UNIX sockets. If you want to use
29601 these, supply &%spamd_address%& with an absolute file name instead of a
29602 address/port pair:
29603 .code
29604 spamd_address = /var/run/spamd_socket
29605 .endd
29606 You can have multiple &%spamd%& servers to improve scalability. These can
29607 reside on other hardware reachable over the network. To specify multiple
29608 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
29609 option, separated with colons:
29610 .code
29611 spamd_address = 192.168.2.10 783 : \
29612                 192.168.2.11 783 : \
29613                 192.168.2.12 783
29614 .endd
29615 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
29616 fashion. When a server fails to respond to the connection attempt, all other
29617 servers are tried until one succeeds. If no server responds, the &%spam%&
29618 condition defers.
29619
29620 &*Warning*&: It is not possible to use the UNIX socket connection method with
29621 multiple &%spamd%& servers.
29622
29623 The &%spamd_address%& variable is expanded before use if it starts with
29624 a dollar sign. In this case, the expansion may return a string that is
29625 used as the list so that multiple spamd servers can be the result of an
29626 expansion.
29627
29628 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
29629 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
29630 .code
29631 deny message = This message was classified as SPAM
29632      spam = joe
29633 .endd
29634 The right-hand side of the &%spam%& condition specifies a name. This is
29635 relevant if you have set up multiple SpamAssassin profiles. If you do not want
29636 to scan using a specific profile, but rather use the SpamAssassin system-wide
29637 default profile, you can scan for an unknown name, or simply use &"nobody"&.
29638 However, you must put something on the right-hand side.
29639
29640 The name allows you to use per-domain or per-user antispam profiles in
29641 principle, but this is not straightforward in practice, because a message may
29642 have multiple recipients, not necessarily all in the same domain. Because the
29643 &%spam%& condition has to be called from a DATA ACL in order to be able to
29644 read the contents of the message, the variables &$local_part$& and &$domain$&
29645 are not set.
29646
29647 The right-hand side of the &%spam%& condition is expanded before being used, so
29648 you can put lookups or conditions there. When the right-hand side evaluates to
29649 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
29650
29651
29652 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
29653 large ones may cause significant performance degradation. As most spam messages
29654 are quite small, it is recommended that you do not scan the big ones. For
29655 example:
29656 .code
29657 deny message = This message was classified as SPAM
29658      condition = ${if < {$message_size}{10K}}
29659      spam = nobody
29660 .endd
29661
29662 The &%spam%& condition returns true if the threshold specified in the user's
29663 SpamAssassin profile has been matched or exceeded. If you want to use the
29664 &%spam%& condition for its side effects (see the variables below), you can make
29665 it always return &"true"& by appending &`:true`& to the username.
29666
29667 .cindex "spam scanning" "returned variables"
29668 When the &%spam%& condition is run, it sets up a number of expansion
29669 variables. These variables are saved with the received message, thus they are
29670 available for use at delivery time.
29671
29672 .vlist
29673 .vitem &$spam_score$&
29674 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
29675 for inclusion in log or reject messages.
29676
29677 .vitem &$spam_score_int$&
29678 The spam score of the message, multiplied by ten, as an integer value. For
29679 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
29680 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
29681 The integer value is useful for numeric comparisons in conditions.
29682
29683 .vitem &$spam_bar$&
29684 A string consisting of a number of &"+"& or &"-"& characters, representing the
29685 integer part of the spam score value. A spam score of 4.4 would have a
29686 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
29687 headers, since MUAs can match on such strings.
29688
29689 .vitem &$spam_report$&
29690 A multiline text table, containing the full SpamAssassin report for the
29691 message. Useful for inclusion in headers or reject messages.
29692 .endlist
29693
29694 The &%spam%& condition caches its results unless expansion in
29695 spamd_address was used. If you call it again with the same user name, it
29696 does not scan again, but rather returns the same values as before.
29697
29698 The &%spam%& condition returns DEFER if there is any error while running
29699 the message through SpamAssassin or if the expansion of spamd_address
29700 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
29701 statement block), append &`/defer_ok`& to the right-hand side of the
29702 spam condition, like this:
29703 .code
29704 deny message = This message was classified as SPAM
29705      spam    = joe/defer_ok
29706 .endd
29707 This causes messages to be accepted even if there is a problem with &%spamd%&.
29708
29709 Here is a longer, commented example of the use of the &%spam%&
29710 condition:
29711 .code
29712 # put headers in all messages (no matter if spam or not)
29713 warn  spam = nobody:true
29714       add_header = X-Spam-Score: $spam_score ($spam_bar)
29715       add_header = X-Spam-Report: $spam_report
29716
29717 # add second subject line with *SPAM* marker when message
29718 # is over threshold
29719 warn  spam = nobody
29720       add_header = Subject: *SPAM* $h_Subject:
29721
29722 # reject spam at high scores (> 12)
29723 deny  message = This message scored $spam_score spam points.
29724       spam = nobody:true
29725       condition = ${if >{$spam_score_int}{120}{1}{0}}
29726 .endd
29727
29728
29729
29730 .section "Scanning MIME parts" "SECTscanmimepart"
29731 .cindex "content scanning" "MIME parts"
29732 .cindex "MIME content scanning"
29733 .oindex "&%acl_smtp_mime%&"
29734 .oindex "&%acl_not_smtp_mime%&"
29735 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
29736 each MIME part of an SMTP message, including multipart types, in the sequence
29737 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
29738 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
29739 options may both refer to the same ACL if you want the same processing in both
29740 cases.
29741
29742 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
29743 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
29744 the case of a non-SMTP message. However, a MIME ACL is called only if the
29745 message contains a &'Content-Type:'& header line. When a call to a MIME
29746 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
29747 result code is sent to the client. In the case of an SMTP message, the
29748 &%acl_smtp_data%& ACL is not called when this happens.
29749
29750 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
29751 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
29752 condition to match against the raw MIME part. You can also use the
29753 &%mime_regex%& condition to match against the decoded MIME part (see section
29754 &<<SECTscanregex>>&).
29755
29756 At the start of a MIME ACL, a number of variables are set from the header
29757 information for the relevant MIME part. These are described below. The contents
29758 of the MIME part are not by default decoded into a disk file except for MIME
29759 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
29760 part into a disk file, you can use the &%decode%& condition. The general
29761 syntax is:
29762 .display
29763 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
29764 .endd
29765 The right hand side is expanded before use. After expansion,
29766 the value can be:
29767
29768 .olist
29769 &"0"& or &"false"&, in which case no decoding is done.
29770 .next
29771 The string &"default"&. In that case, the file is put in the temporary
29772 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
29773 a sequential file name consisting of the message id and a sequence number. The
29774 full path and name is available in &$mime_decoded_filename$& after decoding.
29775 .next
29776 A full path name starting with a slash. If the full name is an existing
29777 directory, it is used as a replacement for the default directory. The filename
29778 is then sequentially assigned. If the path does not exist, it is used as
29779 the full path and file name.
29780 .next
29781 If the string does not start with a slash, it is used as the
29782 filename, and the default path is then used.
29783 .endlist
29784 The &%decode%& condition normally succeeds. It is only false for syntax
29785 errors or unusual circumstances such as memory shortages. You can easily decode
29786 a file with its original, proposed filename using
29787 .code
29788 decode = $mime_filename
29789 .endd
29790 However, you should keep in mind that &$mime_filename$& might contain
29791 anything. If you place files outside of the default path, they are not
29792 automatically unlinked.
29793
29794 For RFC822 attachments (these are messages attached to messages, with a
29795 content-type of &"message/rfc822"&), the ACL is called again in the same manner
29796 as for the primary message, only that the &$mime_is_rfc822$& expansion
29797 variable is set (see below). Attached messages are always decoded to disk
29798 before being checked, and the files are unlinked once the check is done.
29799
29800 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
29801 used to match regular expressions against raw and decoded MIME parts,
29802 respectively. They are described in section &<<SECTscanregex>>&.
29803
29804 .cindex "MIME content scanning" "returned variables"
29805 The following list describes all expansion variables that are
29806 available in the MIME ACL:
29807
29808 .vlist
29809 .vitem &$mime_boundary$&
29810 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
29811 have a boundary string, which is stored in this variable. If the current part
29812 has no boundary parameter in the &'Content-Type:'& header, this variable
29813 contains the empty string.
29814
29815 .vitem &$mime_charset$&
29816 This variable contains the character set identifier, if one was found in the
29817 &'Content-Type:'& header. Examples for charset identifiers are:
29818 .code
29819 us-ascii
29820 gb2312 (Chinese)
29821 iso-8859-1
29822 .endd
29823 Please note that this value is not normalized, so you should do matches
29824 case-insensitively.
29825
29826 .vitem &$mime_content_description$&
29827 This variable contains the normalized content of the &'Content-Description:'&
29828 header. It can contain a human-readable description of the parts content. Some
29829 implementations repeat the filename for attachments here, but they are usually
29830 only used for display purposes.
29831
29832 .vitem &$mime_content_disposition$&
29833 This variable contains the normalized content of the &'Content-Disposition:'&
29834 header. You can expect strings like &"attachment"& or &"inline"& here.
29835
29836 .vitem &$mime_content_id$&
29837 This variable contains the normalized content of the &'Content-ID:'& header.
29838 This is a unique ID that can be used to reference a part from another part.
29839
29840 .vitem &$mime_content_size$&
29841 This variable is set only after the &%decode%& modifier (see above) has been
29842 successfully run. It contains the size of the decoded part in kilobytes. The
29843 size is always rounded up to full kilobytes, so only a completely empty part
29844 has a &$mime_content_size$& of zero.
29845
29846 .vitem &$mime_content_transfer_encoding$&
29847 This variable contains the normalized content of the
29848 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
29849 type. Typical values are &"base64"& and &"quoted-printable"&.
29850
29851 .vitem &$mime_content_type$&
29852 If the MIME part has a &'Content-Type:'& header, this variable contains its
29853 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
29854 are some examples of popular MIME types, as they may appear in this variable:
29855 .code
29856 text/plain
29857 text/html
29858 application/octet-stream
29859 image/jpeg
29860 audio/midi
29861 .endd
29862 If the MIME part has no &'Content-Type:'& header, this variable contains the
29863 empty string.
29864
29865 .vitem &$mime_decoded_filename$&
29866 This variable is set only after the &%decode%& modifier (see above) has been
29867 successfully run. It contains the full path and file name of the file
29868 containing the decoded data.
29869 .endlist
29870
29871 .cindex "RFC 2047"
29872 .vlist
29873 .vitem &$mime_filename$&
29874 This is perhaps the most important of the MIME variables. It contains a
29875 proposed filename for an attachment, if one was found in either the
29876 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
29877 RFC2047 decoded, but no additional sanity checks are done. If no filename was
29878 found, this variable contains the empty string.
29879
29880 .vitem &$mime_is_coverletter$&
29881 This variable attempts to differentiate the &"cover letter"& of an e-mail from
29882 attached data. It can be used to clamp down on flashy or unnecessarily encoded
29883 content in the cover letter, while not restricting attachments at all.
29884
29885 The variable contains 1 (true) for a MIME part believed to be part of the
29886 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
29887 follows:
29888
29889 .olist
29890 The outermost MIME part of a message is always a cover letter.
29891
29892 .next
29893 If a multipart/alternative or multipart/related MIME part is a cover letter,
29894 so are all MIME subparts within that multipart.
29895
29896 .next
29897 If any other multipart is a cover letter, the first subpart is a cover letter,
29898 and the rest are attachments.
29899
29900 .next
29901 All parts contained within an attachment multipart are attachments.
29902 .endlist olist
29903
29904 As an example, the following will ban &"HTML mail"& (including that sent with
29905 alternative plain text), while allowing HTML files to be attached. HTML
29906 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
29907 .code
29908 deny message = HTML mail is not accepted here
29909 !condition = $mime_is_rfc822
29910 condition = $mime_is_coverletter
29911 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
29912 .endd
29913 .vitem &$mime_is_multipart$&
29914 This variable has the value 1 (true) when the current part has the main type
29915 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
29916 Since multipart entities only serve as containers for other parts, you may not
29917 want to carry out specific actions on them.
29918
29919 .vitem &$mime_is_rfc822$&
29920 This variable has the value 1 (true) if the current part is not a part of the
29921 checked message itself, but part of an attached message. Attached message
29922 decoding is fully recursive.
29923
29924 .vitem &$mime_part_count$&
29925 This variable is a counter that is raised for each processed MIME part. It
29926 starts at zero for the very first part (which is usually a multipart). The
29927 counter is per-message, so it is reset when processing RFC822 attachments (see
29928 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
29929 complete, so you can use it in the DATA ACL to determine the number of MIME
29930 parts of a message. For non-MIME messages, this variable contains the value -1.
29931 .endlist
29932
29933
29934
29935 .section "Scanning with regular expressions" "SECTscanregex"
29936 .cindex "content scanning" "with regular expressions"
29937 .cindex "regular expressions" "content scanning with"
29938 You can specify your own custom regular expression matches on the full body of
29939 the message, or on individual MIME parts.
29940
29941 The &%regex%& condition takes one or more regular expressions as arguments and
29942 matches them against the full message (when called in the DATA ACL) or a raw
29943 MIME part (when called in the MIME ACL). The &%regex%& condition matches
29944 linewise, with a maximum line length of 32K characters. That means you cannot
29945 have multiline matches with the &%regex%& condition.
29946
29947 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
29948 to 32K of decoded content (the whole content at once, not linewise). If the
29949 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
29950 is decoded automatically when &%mime_regex%& is executed (using default path
29951 and filename values). If the decoded data is larger than  32K, only the first
29952 32K characters are checked.
29953
29954 The regular expressions are passed as a colon-separated list. To include a
29955 literal colon, you must double it. Since the whole right-hand side string is
29956 expanded before being used, you must also escape dollar signs and backslashes
29957 with more backslashes, or use the &`\N`& facility to disable expansion.
29958 Here is a simple example that contains two regular expressions:
29959 .code
29960 deny message = contains blacklisted regex ($regex_match_string)
29961      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
29962 .endd
29963 The conditions returns true if any one of the regular expressions matches. The
29964 &$regex_match_string$& expansion variable is then set up and contains the
29965 matching regular expression.
29966
29967 &*Warning*&: With large messages, these conditions can be fairly
29968 CPU-intensive.
29969
29970
29971
29972
29973 .section "The demime condition" "SECTdemimecond"
29974 .cindex "content scanning" "MIME checking"
29975 .cindex "MIME content scanning"
29976 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
29977 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
29978 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
29979 ACL functionality, but provides no additional facilities. Please note that this
29980 condition is deprecated and kept only for backward compatibility. You must set
29981 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
29982 use the &%demime%& condition.
29983
29984 The &%demime%& condition unpacks MIME containers in the message. It detects
29985 errors in MIME containers and can match file extensions found in the message
29986 against a list. Using this facility produces files containing the unpacked MIME
29987 parts of the message in the temporary scan directory. If you do antivirus
29988 scanning, it is recommended that you use the &%demime%& condition before the
29989 antivirus (&%malware%&) condition.
29990
29991 On the right-hand side of the &%demime%& condition you can pass a
29992 colon-separated list of file extensions that it should match against. For
29993 example:
29994 .code
29995 deny message = Found blacklisted file attachment
29996      demime  = vbs:com:bat:pif:prf:lnk
29997 .endd
29998 If one of the file extensions is found, the condition is true, otherwise it is
29999 false. If there is a temporary error while demimeing (for example, &"disk
30000 full"&), the condition defers, and the message is temporarily rejected (unless
30001 the condition is on a &%warn%& verb).
30002
30003 The right-hand side is expanded before being treated as a list, so you can have
30004 conditions and lookups there. If it expands to an empty string, &"false"&, or
30005 zero (&"0"&), no demimeing is done and the condition is false.
30006
30007 The &%demime%& condition set the following variables:
30008
30009 .vlist
30010 .vitem &$demime_errorlevel$&
30011 .vindex "&$demime_errorlevel$&"
30012 When an error is detected in a MIME container, this variable contains the
30013 severity of the error, as an integer number. The higher the value, the more
30014 severe the error (the current maximum value is 3). If this variable is unset or
30015 zero, no error occurred.
30016
30017 .vitem &$demime_reason$&
30018 .vindex "&$demime_reason$&"
30019 When &$demime_errorlevel$& is greater than zero, this variable contains a
30020 human-readable text string describing the MIME error that occurred.
30021 .endlist
30022
30023 .vlist
30024 .vitem &$found_extension$&
30025 .vindex "&$found_extension$&"
30026 When the &%demime%& condition is true, this variable contains the file
30027 extension it found.
30028 .endlist
30029
30030 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
30031 the &%demime%& condition, and are not changed on subsequent calls.
30032
30033 If you do not want to check for file extensions, but rather use the &%demime%&
30034 condition for unpacking or error checking purposes, pass &"*"& as the
30035 right-hand side value. Here is a more elaborate example of how to use this
30036 facility:
30037 .code
30038 # Reject messages with serious MIME container errors
30039 deny  message = Found MIME error ($demime_reason).
30040       demime = *
30041       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
30042
30043 # Reject known virus spreading file extensions.
30044 # Accepting these is pretty much braindead.
30045 deny  message = contains $found_extension file (blacklisted).
30046       demime  = com:vbs:bat:pif:scr
30047
30048 # Freeze .exe and .doc files. Postmaster can
30049 # examine them and eventually thaw them.
30050 deny  log_message = Another $found_extension file.
30051       demime = exe:doc
30052       control = freeze
30053 .endd
30054 .ecindex IIDcosca
30055
30056
30057
30058
30059 . ////////////////////////////////////////////////////////////////////////////
30060 . ////////////////////////////////////////////////////////////////////////////
30061
30062 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
30063          "Local scan function"
30064 .scindex IIDlosca "&[local_scan()]& function" "description of"
30065 .cindex "customizing" "input scan using C function"
30066 .cindex "policy control" "by local scan function"
30067 In these days of email worms, viruses, and ever-increasing spam, some sites
30068 want to apply a lot of checking to messages before accepting them.
30069
30070 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
30071 passing messages to external virus and spam scanning software. You can also do
30072 a certain amount in Exim itself through string expansions and the &%condition%&
30073 condition in the ACL that runs after the SMTP DATA command or the ACL for
30074 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
30075
30076 To allow for further customization to a site's own requirements, there is the
30077 possibility of linking Exim with a private message scanning function, written
30078 in C. If you want to run code that is written in something other than C, you
30079 can of course use a little C stub to call it.
30080
30081 The local scan function is run once for every incoming message, at the point
30082 when Exim is just about to accept the message.
30083 It can therefore be used to control non-SMTP messages from local processes as
30084 well as messages arriving via SMTP.
30085
30086 Exim applies a timeout to calls of the local scan function, and there is an
30087 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
30088 Zero means &"no timeout"&.
30089 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
30090 before calling the local scan function, so that the most common types of crash
30091 are caught. If the timeout is exceeded or one of those signals is caught, the
30092 incoming message is rejected with a temporary error if it is an SMTP message.
30093 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
30094 code. The incident is logged on the main and reject logs.
30095
30096
30097
30098 .section "Building Exim to use a local scan function" "SECID207"
30099 .cindex "&[local_scan()]& function" "building Exim to use"
30100 To make use of the local scan function feature, you must tell Exim where your
30101 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
30102 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
30103 directory, so you might set
30104 .code
30105 LOCAL_SCAN_SOURCE=Local/local_scan.c
30106 .endd
30107 for example. The function must be called &[local_scan()]&. It is called by
30108 Exim after it has received a message, when the success return code is about to
30109 be sent. This is after all the ACLs have been run. The return code from your
30110 function controls whether the message is actually accepted or not. There is a
30111 commented template function (that just accepts the message) in the file
30112 _src/local_scan.c_.
30113
30114 If you want to make use of Exim's run time configuration file to set options
30115 for your &[local_scan()]& function, you must also set
30116 .code
30117 LOCAL_SCAN_HAS_OPTIONS=yes
30118 .endd
30119 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
30120
30121
30122
30123
30124 .section "API for local_scan()" "SECTapiforloc"
30125 .cindex "&[local_scan()]& function" "API description"
30126 You must include this line near the start of your code:
30127 .code
30128 #include "local_scan.h"
30129 .endd
30130 This header file defines a number of variables and other values, and the
30131 prototype for the function itself. Exim is coded to use unsigned char values
30132 almost exclusively, and one of the things this header defines is a shorthand
30133 for &`unsigned char`& called &`uschar`&.
30134 It also contains the following macro definitions, to simplify casting character
30135 strings and pointers to character strings:
30136 .code
30137 #define CS   (char *)
30138 #define CCS  (const char *)
30139 #define CSS  (char **)
30140 #define US   (unsigned char *)
30141 #define CUS  (const unsigned char *)
30142 #define USS  (unsigned char **)
30143 .endd
30144 The function prototype for &[local_scan()]& is:
30145 .code
30146 extern int local_scan(int fd, uschar **return_text);
30147 .endd
30148 The arguments are as follows:
30149
30150 .ilist
30151 &%fd%& is a file descriptor for the file that contains the body of the message
30152 (the -D file). The file is open for reading and writing, but updating it is not
30153 recommended. &*Warning*&: You must &'not'& close this file descriptor.
30154
30155 The descriptor is positioned at character 19 of the file, which is the first
30156 character of the body itself, because the first 19 characters are the message
30157 id followed by &`-D`& and a newline. If you rewind the file, you should use the
30158 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
30159 case this changes in some future version.
30160 .next
30161 &%return_text%& is an address which you can use to return a pointer to a text
30162 string at the end of the function. The value it points to on entry is NULL.
30163 .endlist
30164
30165 The function must return an &%int%& value which is one of the following macros:
30166
30167 .vlist
30168 .vitem &`LOCAL_SCAN_ACCEPT`&
30169 .vindex "&$local_scan_data$&"
30170 The message is accepted. If you pass back a string of text, it is saved with
30171 the message, and made available in the variable &$local_scan_data$&. No
30172 newlines are permitted (if there are any, they are turned into spaces) and the
30173 maximum length of text is 1000 characters.
30174
30175 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
30176 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
30177 queued without immediate delivery, and is frozen.
30178
30179 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
30180 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
30181 queued without immediate delivery.
30182
30183 .vitem &`LOCAL_SCAN_REJECT`&
30184 The message is rejected; the returned text is used as an error message which is
30185 passed back to the sender and which is also logged. Newlines are permitted &--
30186 they cause a multiline response for SMTP rejections, but are converted to
30187 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
30188 used.
30189
30190 .vitem &`LOCAL_SCAN_TEMPREJECT`&
30191 The message is temporarily rejected; the returned text is used as an error
30192 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
30193 problem"& is used.
30194
30195 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
30196 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
30197 message is not written to the reject log. It has the effect of unsetting the
30198 &%rejected_header%& log selector for just this rejection. If
30199 &%rejected_header%& is already unset (see the discussion of the
30200 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
30201 same as LOCAL_SCAN_REJECT.
30202
30203 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
30204 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
30205 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
30206 .endlist
30207
30208 If the message is not being received by interactive SMTP, rejections are
30209 reported by writing to &%stderr%& or by sending an email, as configured by the
30210 &%-oe%& command line options.
30211
30212
30213
30214 .section "Configuration options for local_scan()" "SECTconoptloc"
30215 .cindex "&[local_scan()]& function" "configuration options"
30216 It is possible to have option settings in the main configuration file
30217 that set values in static variables in the &[local_scan()]& module. If you
30218 want to do this, you must have the line
30219 .code
30220 LOCAL_SCAN_HAS_OPTIONS=yes
30221 .endd
30222 in your &_Local/Makefile_& when you build Exim. (This line is in
30223 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
30224 file, you must define static variables to hold the option values, and a table
30225 to define them.
30226
30227 The table must be a vector called &%local_scan_options%&, of type
30228 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
30229 and a pointer to the variable that holds the value. The entries must appear in
30230 alphabetical order. Following &%local_scan_options%& you must also define a
30231 variable called &%local_scan_options_count%& that contains the number of
30232 entries in the table. Here is a short example, showing two kinds of option:
30233 .code
30234 static int my_integer_option = 42;
30235 static uschar *my_string_option = US"a default string";
30236
30237 optionlist local_scan_options[] = {
30238   { "my_integer", opt_int,       &my_integer_option },
30239   { "my_string",  opt_stringptr, &my_string_option }
30240 };
30241
30242 int local_scan_options_count =
30243   sizeof(local_scan_options)/sizeof(optionlist);
30244 .endd
30245 The values of the variables can now be changed from Exim's runtime
30246 configuration file by including a local scan section as in this example:
30247 .code
30248 begin local_scan
30249 my_integer = 99
30250 my_string = some string of text...
30251 .endd
30252 The available types of option data are as follows:
30253
30254 .vlist
30255 .vitem &*opt_bool*&
30256 This specifies a boolean (true/false) option. The address should point to a
30257 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
30258 that are defined as &"1"& and &"0"&, respectively. If you want to detect
30259 whether such a variable has been set at all, you can initialize it to
30260 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
30261 values.)
30262
30263 .vitem &*opt_fixed*&
30264 This specifies a fixed point number, such as is used for load averages.
30265 The address should point to a variable of type &`int`&. The value is stored
30266 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
30267
30268 .vitem &*opt_int*&
30269 This specifies an integer; the address should point to a variable of type
30270 &`int`&. The value may be specified in any of the integer formats accepted by
30271 Exim.
30272
30273 .vitem &*opt_mkint*&
30274 This is the same as &%opt_int%&, except that when such a value is output in a
30275 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
30276 printed with the suffix K or M.
30277
30278 .vitem &*opt_octint*&
30279 This also specifies an integer, but the value is always interpreted as an
30280 octal integer, whether or not it starts with the digit zero, and it is
30281 always output in octal.
30282
30283 .vitem &*opt_stringptr*&
30284 This specifies a string value; the address must be a pointer to a
30285 variable that points to a string (for example, of type &`uschar *`&).
30286
30287 .vitem &*opt_time*&
30288 This specifies a time interval value. The address must point to a variable of
30289 type &`int`&. The value that is placed there is a number of seconds.
30290 .endlist
30291
30292 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
30293 out the values of all the &[local_scan()]& options.
30294
30295
30296
30297 .section "Available Exim variables" "SECID208"
30298 .cindex "&[local_scan()]& function" "available Exim variables"
30299 The header &_local_scan.h_& gives you access to a number of C variables. These
30300 are the only ones that are guaranteed to be maintained from release to release.
30301 Note, however, that you can obtain the value of any Exim expansion variable,
30302 including &$recipients$&, by calling &'expand_string()'&. The exported
30303 C variables are as follows:
30304
30305 .vlist
30306 .vitem &*int&~body_linecount*&
30307 This variable contains the number of lines in the message's body.
30308
30309 .vitem &*int&~body_zerocount*&
30310 This variable contains the number of binary zero bytes in the message's body.
30311
30312 .vitem &*unsigned&~int&~debug_selector*&
30313 This variable is set to zero when no debugging is taking place. Otherwise, it
30314 is a bitmap of debugging selectors. Two bits are identified for use in
30315 &[local_scan()]&; they are defined as macros:
30316
30317 .ilist
30318 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
30319 testing option that is not privileged &-- any caller may set it. All the
30320 other selector bits can be set only by admin users.
30321
30322 .next
30323 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
30324 by the &`+local_scan`& debug selector. It is not included in the default set
30325 of debugging bits.
30326 .endlist ilist
30327
30328 Thus, to write to the debugging output only when &`+local_scan`& has been
30329 selected, you should use code like this:
30330 .code
30331 if ((debug_selector & D_local_scan) != 0)
30332   debug_printf("xxx", ...);
30333 .endd
30334 .vitem &*uschar&~*expand_string_message*&
30335 After a failing call to &'expand_string()'& (returned value NULL), the
30336 variable &%expand_string_message%& contains the error message, zero-terminated.
30337
30338 .vitem &*header_line&~*header_list*&
30339 A pointer to a chain of header lines. The &%header_line%& structure is
30340 discussed below.
30341
30342 .vitem &*header_line&~*header_last*&
30343 A pointer to the last of the header lines.
30344
30345 .vitem &*uschar&~*headers_charset*&
30346 The value of the &%headers_charset%& configuration option.
30347
30348 .vitem &*BOOL&~host_checking*&
30349 This variable is TRUE during a host checking session that is initiated by the
30350 &%-bh%& command line option.
30351
30352 .vitem &*uschar&~*interface_address*&
30353 The IP address of the interface that received the message, as a string. This
30354 is NULL for locally submitted messages.
30355
30356 .vitem &*int&~interface_port*&
30357 The port on which this message was received. When testing with the &%-bh%&
30358 command line option, the value of this variable is -1 unless a port has been
30359 specified via the &%-oMi%& option.
30360
30361 .vitem &*uschar&~*message_id*&
30362 This variable contains Exim's message id for the incoming message (the value of
30363 &$message_exim_id$&) as a zero-terminated string.
30364
30365 .vitem &*uschar&~*received_protocol*&
30366 The name of the protocol by which the message was received.
30367
30368 .vitem &*int&~recipients_count*&
30369 The number of accepted recipients.
30370
30371 .vitem &*recipient_item&~*recipients_list*&
30372 .cindex "recipient" "adding in local scan"
30373 .cindex "recipient" "removing in local scan"
30374 The list of accepted recipients, held in a vector of length
30375 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
30376 can add additional recipients by calling &'receive_add_recipient()'& (see
30377 below). You can delete recipients by removing them from the vector and
30378 adjusting the value in &%recipients_count%&. In particular, by setting
30379 &%recipients_count%& to zero you remove all recipients. If you then return the
30380 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
30381 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
30382 and then call &'receive_add_recipient()'& as often as needed.
30383
30384 .vitem &*uschar&~*sender_address*&
30385 The envelope sender address. For bounce messages this is the empty string.
30386
30387 .vitem &*uschar&~*sender_host_address*&
30388 The IP address of the sending host, as a string. This is NULL for
30389 locally-submitted messages.
30390
30391 .vitem &*uschar&~*sender_host_authenticated*&
30392 The name of the authentication mechanism that was used, or NULL if the message
30393 was not received over an authenticated SMTP connection.
30394
30395 .vitem &*uschar&~*sender_host_name*&
30396 The name of the sending host, if known.
30397
30398 .vitem &*int&~sender_host_port*&
30399 The port on the sending host.
30400
30401 .vitem &*BOOL&~smtp_input*&
30402 This variable is TRUE for all SMTP input, including BSMTP.
30403
30404 .vitem &*BOOL&~smtp_batched_input*&
30405 This variable is TRUE for BSMTP input.
30406
30407 .vitem &*int&~store_pool*&
30408 The contents of this variable control which pool of memory is used for new
30409 requests. See section &<<SECTmemhanloc>>& for details.
30410 .endlist
30411
30412
30413 .section "Structure of header lines" "SECID209"
30414 The &%header_line%& structure contains the members listed below.
30415 You can add additional header lines by calling the &'header_add()'& function
30416 (see below). You can cause header lines to be ignored (deleted) by setting
30417 their type to *.
30418
30419
30420 .vlist
30421 .vitem &*struct&~header_line&~*next*&
30422 A pointer to the next header line, or NULL for the last line.
30423
30424 .vitem &*int&~type*&
30425 A code identifying certain headers that Exim recognizes. The codes are printing
30426 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
30427 Notice in particular that any header line whose type is * is not transmitted
30428 with the message. This flagging is used for header lines that have been
30429 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
30430 lines.) Effectively, * means &"deleted"&.
30431
30432 .vitem &*int&~slen*&
30433 The number of characters in the header line, including the terminating and any
30434 internal newlines.
30435
30436 .vitem &*uschar&~*text*&
30437 A pointer to the text of the header. It always ends with a newline, followed by
30438 a zero byte. Internal newlines are preserved.
30439 .endlist
30440
30441
30442
30443 .section "Structure of recipient items" "SECID210"
30444 The &%recipient_item%& structure contains these members:
30445
30446 .vlist
30447 .vitem &*uschar&~*address*&
30448 This is a pointer to the recipient address as it was received.
30449
30450 .vitem &*int&~pno*&
30451 This is used in later Exim processing when top level addresses are created by
30452 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
30453 and must always contain -1 at this stage.
30454
30455 .vitem &*uschar&~*errors_to*&
30456 If this value is not NULL, bounce messages caused by failing to deliver to the
30457 recipient are sent to the address it contains. In other words, it overrides the
30458 envelope sender for this one recipient. (Compare the &%errors_to%& generic
30459 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
30460 an unqualified address, Exim qualifies it using the domain from
30461 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
30462 is NULL for all recipients.
30463 .endlist
30464
30465
30466
30467 .section "Available Exim functions" "SECID211"
30468 .cindex "&[local_scan()]& function" "available Exim functions"
30469 The header &_local_scan.h_& gives you access to a number of Exim functions.
30470 These are the only ones that are guaranteed to be maintained from release to
30471 release:
30472
30473 .vlist
30474 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
30475        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
30476
30477 This function creates a child process that runs the command specified by
30478 &%argv%&. The environment for the process is specified by &%envp%&, which can
30479 be NULL if no environment variables are to be passed. A new umask is supplied
30480 for the process in &%newumask%&.
30481
30482 Pipes to the standard input and output of the new process are set up
30483 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
30484 standard error is cloned to the standard output. If there are any file
30485 descriptors &"in the way"& in the new process, they are closed. If the final
30486 argument is TRUE, the new process is made into a process group leader.
30487
30488 The function returns the pid of the new process, or -1 if things go wrong.
30489
30490 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
30491 This function waits for a child process to terminate, or for a timeout (in
30492 seconds) to expire. A timeout value of zero means wait as long as it takes. The
30493 return value is as follows:
30494
30495 .ilist
30496 >= 0
30497
30498 The process terminated by a normal exit and the value is the process
30499 ending status.
30500
30501 .next
30502 < 0 and > &--256
30503
30504 The process was terminated by a signal and the value is the negation of the
30505 signal number.
30506
30507 .next
30508 &--256
30509
30510 The process timed out.
30511 .next
30512 &--257
30513
30514 The was some other error in wait(); &%errno%& is still set.
30515 .endlist
30516
30517 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
30518 This function provide you with a means of submitting a new message to
30519 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
30520 want, but this packages it all up for you.) The function creates a pipe,
30521 forks a subprocess that is running
30522 .code
30523 exim -t -oem -oi -f <>
30524 .endd
30525 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
30526 that is connected to the standard input. The yield of the function is the PID
30527 of the subprocess. You can then write a message to the file descriptor, with
30528 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
30529
30530 When you have finished, call &'child_close()'& to wait for the process to
30531 finish and to collect its ending status. A timeout value of zero is usually
30532 fine in this circumstance. Unless you have made a mistake with the recipient
30533 addresses, you should get a return code of zero.
30534
30535
30536 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
30537        *sender_authentication)*&
30538 This function is a more sophisticated version of &'child_open()'&. The command
30539 that it runs is:
30540 .display
30541 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
30542 .endd
30543 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
30544
30545
30546 .vitem &*void&~debug_printf(char&~*,&~...)*&
30547 This is Exim's debugging function, with arguments as for &'(printf()'&. The
30548 output is written to the standard error stream. If no debugging is selected,
30549 calls to &'debug_printf()'& have no effect. Normally, you should make calls
30550 conditional on the &`local_scan`& debug selector by coding like this:
30551 .code
30552 if ((debug_selector & D_local_scan) != 0)
30553   debug_printf("xxx", ...);
30554 .endd
30555
30556 .vitem &*uschar&~*expand_string(uschar&~*string)*&
30557 This is an interface to Exim's string expansion code. The return value is the
30558 expanded string, or NULL if there was an expansion failure.
30559 The C variable &%expand_string_message%& contains an error message after an
30560 expansion failure. If expansion does not change the string, the return value is
30561 the pointer to the input string. Otherwise, the return value points to a new
30562 block of memory that was obtained by a call to &'store_get()'&. See section
30563 &<<SECTmemhanloc>>& below for a discussion of memory handling.
30564
30565 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
30566 This function allows you to an add additional header line at the end of the
30567 existing ones. The first argument is the type, and should normally be a space
30568 character. The second argument is a format string and any number of
30569 substitution arguments as for &[sprintf()]&. You may include internal newlines
30570 if you want, and you must ensure that the string ends with a newline.
30571
30572 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
30573         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
30574 This function adds a new header line at a specified point in the header
30575 chain. The header itself is specified as for &'header_add()'&.
30576
30577 If &%name%& is NULL, the new header is added at the end of the chain if
30578 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
30579 NULL, the header lines are searched for the first non-deleted header that
30580 matches the name. If one is found, the new header is added before it if
30581 &%after%& is false. If &%after%& is true, the new header is added after the
30582 found header and any adjacent subsequent ones with the same name (even if
30583 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
30584 option controls where the header is added. If it is true, addition is at the
30585 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
30586 headers, or at the top if there are no &'Received:'& headers, you could use
30587 .code
30588 header_add_at_position(TRUE, US"Received", TRUE,
30589   ' ', "X-xxx: ...");
30590 .endd
30591 Normally, there is always at least one non-deleted &'Received:'& header, but
30592 there may not be if &%received_header_text%& expands to an empty string.
30593
30594
30595 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
30596 This function removes header lines. If &%occurrence%& is zero or negative, all
30597 occurrences of the header are removed. If occurrence is greater than zero, that
30598 particular instance of the header is removed. If no header(s) can be found that
30599 match the specification, the function does nothing.
30600
30601
30602 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
30603         int&~length,&~BOOL&~notdel)*&"
30604 This function tests whether the given header has the given name. It is not just
30605 a string comparison, because white space is permitted between the name and the
30606 colon. If the &%notdel%& argument is true, a false return is forced for all
30607 &"deleted"& headers; otherwise they are not treated specially. For example:
30608 .code
30609 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
30610 .endd
30611 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
30612 .cindex "base64 encoding" "functions for &[local_scan()]& use"
30613 This function base64-encodes a string, which is passed by address and length.
30614 The text may contain bytes of any value, including zero. The result is passed
30615 back in dynamic memory that is obtained by calling &'store_get()'&. It is
30616 zero-terminated.
30617
30618 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
30619 This function decodes a base64-encoded string. Its arguments are a
30620 zero-terminated base64-encoded string and the address of a variable that is set
30621 to point to the result, which is in dynamic memory. The length of the decoded
30622 string is the yield of the function. If the input is invalid base64 data, the
30623 yield is -1. A zero byte is added to the end of the output string to make it
30624 easy to interpret as a C string (assuming it contains no zeros of its own). The
30625 added zero byte is not included in the returned count.
30626
30627 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
30628 This function checks for a match in a domain list. Domains are always
30629 matched caselessly. The return value is one of the following:
30630 .display
30631 &`OK     `& match succeeded
30632 &`FAIL   `& match failed
30633 &`DEFER  `& match deferred
30634 .endd
30635 DEFER is usually caused by some kind of lookup defer, such as the
30636 inability to contact a database.
30637
30638 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
30639         BOOL&~caseless)*&"
30640 This function checks for a match in a local part list. The third argument
30641 controls case-sensitivity. The return values are as for
30642 &'lss_match_domain()'&.
30643
30644 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
30645         BOOL&~caseless)*&"
30646 This function checks for a match in an address list. The third argument
30647 controls the case-sensitivity of the local part match. The domain is always
30648 matched caselessly. The return values are as for &'lss_match_domain()'&.
30649
30650 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
30651         uschar&~*list)*&"
30652 This function checks for a match in a host list. The most common usage is
30653 expected to be
30654 .code
30655 lss_match_host(sender_host_name, sender_host_address, ...)
30656 .endd
30657 .vindex "&$sender_host_address$&"
30658 An empty address field matches an empty item in the host list. If the host name
30659 is NULL, the name corresponding to &$sender_host_address$& is automatically
30660 looked up if a host name is required to match an item in the list. The return
30661 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
30662 returns ERROR in the case when it had to look up a host name, but the lookup
30663 failed.
30664
30665 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
30666         *format,&~...)*&"
30667 This function writes to Exim's log files. The first argument should be zero (it
30668 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
30669 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
30670 them. It specifies to which log or logs the message is written. The remaining
30671 arguments are a format and relevant insertion arguments. The string should not
30672 contain any newlines, not even at the end.
30673
30674
30675 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
30676 This function adds an additional recipient to the message. The first argument
30677 is the recipient address. If it is unqualified (has no domain), it is qualified
30678 with the &%qualify_recipient%& domain. The second argument must always be -1.
30679
30680 This function does not allow you to specify a private &%errors_to%& address (as
30681 described with the structure of &%recipient_item%& above), because it pre-dates
30682 the addition of that field to the structure. However, it is easy to add such a
30683 value afterwards. For example:
30684 .code
30685  receive_add_recipient(US"monitor@mydom.example", -1);
30686  recipients_list[recipients_count-1].errors_to =
30687    US"postmaster@mydom.example";
30688 .endd
30689
30690 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
30691 This is a convenience function to remove a named recipient from the list of
30692 recipients. It returns true if a recipient was removed, and false if no
30693 matching recipient could be found. The argument must be a complete email
30694 address.
30695 .endlist
30696
30697
30698 .cindex "RFC 2047"
30699 .vlist
30700 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
30701   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
30702 This function decodes strings that are encoded according to RFC 2047. Typically
30703 these are the contents of header lines. First, each &"encoded word"& is decoded
30704 from the Q or B encoding into a byte-string. Then, if provided with the name of
30705 a charset encoding, and if the &[iconv()]& function is available, an attempt is
30706 made  to translate the result to the named character set. If this fails, the
30707 binary string is returned with an error message.
30708
30709 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
30710 maximum MIME word length is enforced. The third argument is the target
30711 encoding, or NULL if no translation is wanted.
30712
30713 .cindex "binary zero" "in RFC 2047 decoding"
30714 .cindex "RFC 2047" "binary zero in"
30715 If a binary zero is encountered in the decoded string, it is replaced by the
30716 contents of the &%zeroval%& argument. For use with Exim headers, the value must
30717 not be 0 because header lines are handled as zero-terminated strings.
30718
30719 The function returns the result of processing the string, zero-terminated; if
30720 &%lenptr%& is not NULL, the length of the result is set in the variable to
30721 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
30722
30723 If an error is encountered, the function returns NULL and uses the &%error%&
30724 argument to return an error message. The variable pointed to by &%error%& is
30725 set to NULL if there is no error; it may be set non-NULL even when the function
30726 returns a non-NULL value if decoding was successful, but there was a problem
30727 with translation.
30728
30729
30730 .vitem &*int&~smtp_fflush(void)*&
30731 This function is used in conjunction with &'smtp_printf()'&, as described
30732 below.
30733
30734 .vitem &*void&~smtp_printf(char&~*,&~...)*&
30735 The arguments of this function are like &[printf()]&; it writes to the SMTP
30736 output stream. You should use this function only when there is an SMTP output
30737 stream, that is, when the incoming message is being received via interactive
30738 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
30739 is FALSE. If you want to test for an incoming message from another host (as
30740 opposed to a local process that used the &%-bs%& command line option), you can
30741 test the value of &%sender_host_address%&, which is non-NULL when a remote host
30742 is involved.
30743
30744 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
30745 output function, so it can be used for all forms of SMTP connection.
30746
30747 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
30748 must start with an appropriate response code: 550 if you are going to return
30749 LOCAL_SCAN_REJECT, 451 if you are going to return
30750 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
30751 initial lines of a multi-line response, the code must be followed by a hyphen
30752 to indicate that the line is not the final response line. You must also ensure
30753 that the lines you write terminate with CRLF. For example:
30754 .code
30755 smtp_printf("550-this is some extra info\r\n");
30756 return LOCAL_SCAN_REJECT;
30757 .endd
30758 Note that you can also create multi-line responses by including newlines in
30759 the data returned via the &%return_text%& argument. The added value of using
30760 &'smtp_printf()'& is that, for instance, you could introduce delays between
30761 multiple output lines.
30762
30763 The &'smtp_printf()'& function does not return any error indication, because it
30764 does not automatically flush pending output, and therefore does not test
30765 the state of the stream. (In the main code of Exim, flushing and error
30766 detection is done when Exim is ready for the next SMTP input command.) If
30767 you want to flush the output and check for an error (for example, the
30768 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
30769 arguments. It flushes the output stream, and returns a non-zero value if there
30770 is an error.
30771
30772 .vitem &*void&~*store_get(int)*&
30773 This function accesses Exim's internal store (memory) manager. It gets a new
30774 chunk of memory whose size is given by the argument. Exim bombs out if it ever
30775 runs out of memory. See the next section for a discussion of memory handling.
30776
30777 .vitem &*void&~*store_get_perm(int)*&
30778 This function is like &'store_get()'&, but it always gets memory from the
30779 permanent pool. See the next section for a discussion of memory handling.
30780
30781 .vitem &*uschar&~*string_copy(uschar&~*string)*&
30782 See below.
30783
30784 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
30785 See below.
30786
30787 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
30788 These three functions create strings using Exim's dynamic memory facilities.
30789 The first makes a copy of an entire string. The second copies up to a maximum
30790 number of characters, indicated by the second argument. The third uses a format
30791 and insertion arguments to create a new string. In each case, the result is a
30792 pointer to a new string in the current memory pool. See the next section for
30793 more discussion.
30794 .endlist
30795
30796
30797
30798 .section "More about Exim's memory handling" "SECTmemhanloc"
30799 .cindex "&[local_scan()]& function" "memory handling"
30800 No function is provided for freeing memory, because that is never needed.
30801 The dynamic memory that Exim uses when receiving a message is automatically
30802 recycled if another message is received by the same process (this applies only
30803 to incoming SMTP connections &-- other input methods can supply only one
30804 message at a time). After receiving the last message, a reception process
30805 terminates.
30806
30807 Because it is recycled, the normal dynamic memory cannot be used for holding
30808 data that must be preserved over a number of incoming messages on the same SMTP
30809 connection. However, Exim in fact uses two pools of dynamic memory; the second
30810 one is not recycled, and can be used for this purpose.
30811
30812 If you want to allocate memory that remains available for subsequent messages
30813 in the same SMTP connection, you should set
30814 .code
30815 store_pool = POOL_PERM
30816 .endd
30817 before calling the function that does the allocation. There is no need to
30818 restore the value if you do not need to; however, if you do want to revert to
30819 the normal pool, you can either restore the previous value of &%store_pool%& or
30820 set it explicitly to POOL_MAIN.
30821
30822 The pool setting applies to all functions that get dynamic memory, including
30823 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
30824 There is also a convenience function called &'store_get_perm()'& that gets a
30825 block of memory from the permanent pool while preserving the value of
30826 &%store_pool%&.
30827 .ecindex IIDlosca
30828
30829
30830
30831
30832 . ////////////////////////////////////////////////////////////////////////////
30833 . ////////////////////////////////////////////////////////////////////////////
30834
30835 .chapter "System-wide message filtering" "CHAPsystemfilter"
30836 .scindex IIDsysfil1 "filter" "system filter"
30837 .scindex IIDsysfil2 "filtering all mail"
30838 .scindex IIDsysfil3 "system filter"
30839 The previous chapters (on ACLs and the local scan function) describe checks
30840 that can be applied to messages before they are accepted by a host. There is
30841 also a mechanism for checking messages once they have been received, but before
30842 they are delivered. This is called the &'system filter'&.
30843
30844 The system filter operates in a similar manner to users' filter files, but it
30845 is run just once per message (however many recipients the message has).
30846 It should not normally be used as a substitute for routing, because &%deliver%&
30847 commands in a system router provide new envelope recipient addresses.
30848 The system filter must be an Exim filter. It cannot be a Sieve filter.
30849
30850 The system filter is run at the start of a delivery attempt, before any routing
30851 is done. If a message fails to be completely delivered at the first attempt,
30852 the system filter is run again at the start of every retry.
30853 If you want your filter to do something only once per message, you can make use
30854 of the &%first_delivery%& condition in an &%if%& command in the filter to
30855 prevent it happening on retries.
30856
30857 .vindex "&$domain$&"
30858 .vindex "&$local_part$&"
30859 &*Warning*&: Because the system filter runs just once, variables that are
30860 specific to individual recipient addresses, such as &$local_part$& and
30861 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
30862 you want to run a centrally-specified filter for each recipient address
30863 independently, you can do so by setting up a suitable &(redirect)& router, as
30864 described in section &<<SECTperaddfil>>& below.
30865
30866
30867 .section "Specifying a system filter" "SECID212"
30868 .cindex "uid (user id)" "system filter"
30869 .cindex "gid (group id)" "system filter"
30870 The name of the file that contains the system filter must be specified by
30871 setting &%system_filter%&. If you want the filter to run under a uid and gid
30872 other than root, you must also set &%system_filter_user%& and
30873 &%system_filter_group%& as appropriate. For example:
30874 .code
30875 system_filter = /etc/mail/exim.filter
30876 system_filter_user = exim
30877 .endd
30878 If a system filter generates any deliveries directly to files or pipes (via the
30879 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
30880 specified by setting &%system_filter_file_transport%& and
30881 &%system_filter_pipe_transport%&, respectively. Similarly,
30882 &%system_filter_reply_transport%& must be set to handle any messages generated
30883 by the &%reply%& command.
30884
30885
30886 .section "Testing a system filter" "SECID213"
30887 You can run simple tests of a system filter in the same way as for a user
30888 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
30889 are permitted only in system filters are recognized.
30890
30891 If you want to test the combined effect of a system filter and a user filter,
30892 you can use both &%-bF%& and &%-bf%& on the same command line.
30893
30894
30895
30896 .section "Contents of a system filter" "SECID214"
30897 The language used to specify system filters is the same as for users' filter
30898 files. It is described in the separate end-user document &'Exim's interface to
30899 mail filtering'&. However, there are some additional features that are
30900 available only in system filters; these are described in subsequent sections.
30901 If they are encountered in a user's filter file or when testing with &%-bf%&,
30902 they cause errors.
30903
30904 .cindex "frozen messages" "manual thaw; testing in filter"
30905 There are two special conditions which, though available in users' filter
30906 files, are designed for use in system filters. The condition &%first_delivery%&
30907 is true only for the first attempt at delivering a message, and
30908 &%manually_thawed%& is true only if the message has been frozen, and
30909 subsequently thawed by an admin user. An explicit forced delivery counts as a
30910 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
30911
30912 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
30913 specify an &"unseen"& (non-significant) delivery, and that delivery does not
30914 succeed, it will not be tried again.
30915 If you want Exim to retry an unseen delivery until it succeeds, you should
30916 arrange to set it up every time the filter runs.
30917
30918 When a system filter finishes running, the values of the variables &$n0$& &--
30919 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
30920 users' filter files. Thus a system filter can, for example, set up &"scores"&
30921 to which users' filter files can refer.
30922
30923
30924
30925 .section "Additional variable for system filters" "SECID215"
30926 .vindex "&$recipients$&"
30927 The expansion variable &$recipients$&, containing a list of all the recipients
30928 of the message (separated by commas and white space), is available in system
30929 filters. It is not available in users' filters for privacy reasons.
30930
30931
30932
30933 .section "Defer, freeze, and fail commands for system filters" "SECID216"
30934 .cindex "freezing messages"
30935 .cindex "message" "freezing"
30936 .cindex "message" "forced failure"
30937 .cindex "&%fail%&" "in system filter"
30938 .cindex "&%freeze%& in system filter"
30939 .cindex "&%defer%& in system filter"
30940 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
30941 always available in system filters, but are not normally enabled in users'
30942 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
30943 for the &(redirect)& router.) These commands can optionally be followed by the
30944 word &%text%& and a string containing an error message, for example:
30945 .code
30946 fail text "this message looks like spam to me"
30947 .endd
30948 The keyword &%text%& is optional if the next character is a double quote.
30949
30950 The &%defer%& command defers delivery of the original recipients of the
30951 message. The &%fail%& command causes all the original recipients to be failed,
30952 and a bounce message to be created. The &%freeze%& command suspends all
30953 delivery attempts for the original recipients. In all cases, any new deliveries
30954 that are specified by the filter are attempted as normal after the filter has
30955 run.
30956
30957 The &%freeze%& command is ignored if the message has been manually unfrozen and
30958 not manually frozen since. This means that automatic freezing by a system
30959 filter can be used as a way of checking out suspicious messages. If a message
30960 is found to be all right, manually unfreezing it allows it to be delivered.
30961
30962 .cindex "log" "&%fail%& command log line"
30963 .cindex "&%fail%&" "log line; reducing"
30964 The text given with a fail command is used as part of the bounce message as
30965 well as being written to the log. If the message is quite long, this can fill
30966 up a lot of log space when such failures are common. To reduce the size of the
30967 log message, Exim interprets the text in a special way if it starts with the
30968 two characters &`<<`& and contains &`>>`& later. The text between these two
30969 strings is written to the log, and the rest of the text is used in the bounce
30970 message. For example:
30971 .code
30972 fail "<<filter test 1>>Your message is rejected \
30973      because it contains attachments that we are \
30974      not prepared to receive."
30975 .endd
30976
30977 .cindex "loop" "caused by &%fail%&"
30978 Take great care with the &%fail%& command when basing the decision to fail on
30979 the contents of the message, because the bounce message will of course include
30980 the contents of the original message and will therefore trigger the &%fail%&
30981 command again (causing a mail loop) unless steps are taken to prevent this.
30982 Testing the &%error_message%& condition is one way to prevent this. You could
30983 use, for example
30984 .code
30985 if $message_body contains "this is spam" and not error_message
30986 then fail text "spam is not wanted here" endif
30987 .endd
30988 though of course that might let through unwanted bounce messages. The
30989 alternative is clever checking of the body and/or headers to detect bounces
30990 generated by the filter.
30991
30992 The interpretation of a system filter file ceases after a
30993 &%defer%&,
30994 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
30995 set up earlier in the filter file are honoured, so you can use a sequence such
30996 as
30997 .code
30998 mail ...
30999 freeze
31000 .endd
31001 to send a specified message when the system filter is freezing (or deferring or
31002 failing) a message. The normal deliveries for the message do not, of course,
31003 take place.
31004
31005
31006
31007 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
31008 .cindex "header lines" "adding; in system filter"
31009 .cindex "header lines" "removing; in system filter"
31010 .cindex "filter" "header lines; adding/removing"
31011 Two filter commands that are available only in system filters are:
31012 .code
31013 headers add <string>
31014 headers remove <string>
31015 .endd
31016 The argument for the &%headers add%& is a string that is expanded and then
31017 added to the end of the message's headers. It is the responsibility of the
31018 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
31019 space is ignored, and if the string is otherwise empty, or if the expansion is
31020 forced to fail, the command has no effect.
31021
31022 You can use &"\n"& within the string, followed by white space, to specify
31023 continued header lines. More than one header may be added in one command by
31024 including &"\n"& within the string without any following white space. For
31025 example:
31026 .code
31027 headers add "X-header-1: ....\n  \
31028              continuation of X-header-1 ...\n\
31029              X-header-2: ...."
31030 .endd
31031 Note that the header line continuation white space after the first newline must
31032 be placed before the backslash that continues the input string, because white
31033 space after input continuations is ignored.
31034
31035 The argument for &%headers remove%& is a colon-separated list of header names.
31036 This command applies only to those headers that are stored with the message;
31037 those that are added at delivery time (such as &'Envelope-To:'& and
31038 &'Return-Path:'&) cannot be removed by this means. If there is more than one
31039 header with the same name, they are all removed.
31040
31041 The &%headers%& command in a system filter makes an immediate change to the set
31042 of header lines that was received with the message (with possible additions
31043 from ACL processing). Subsequent commands in the system filter operate on the
31044 modified set, which also forms the basis for subsequent message delivery.
31045 Unless further modified during routing or transporting, this set of headers is
31046 used for all recipients of the message.
31047
31048 During routing and transporting, the variables that refer to the contents of
31049 header lines refer only to those lines that are in this set. Thus, header lines
31050 that are added by a system filter are visible to users' filter files and to all
31051 routers and transports. This contrasts with the manipulation of header lines by
31052 routers and transports, which is not immediate, but which instead is saved up
31053 until the message is actually being written (see section
31054 &<<SECTheadersaddrem>>&).
31055
31056 If the message is not delivered at the first attempt, header lines that were
31057 added by the system filter are stored with the message, and so are still
31058 present at the next delivery attempt. Header lines that were removed are still
31059 present, but marked &"deleted"& so that they are not transported with the
31060 message. For this reason, it is usual to make the &%headers%& command
31061 conditional on &%first_delivery%& so that the set of header lines is not
31062 modified more than once.
31063
31064 Because header modification in a system filter acts immediately, you have to
31065 use an indirect approach if you want to modify the contents of a header line.
31066 For example:
31067 .code
31068 headers add "Old-Subject: $h_subject:"
31069 headers remove "Subject"
31070 headers add "Subject: new subject (was: $h_old-subject:)"
31071 headers remove "Old-Subject"
31072 .endd
31073
31074
31075
31076 .section "Setting an errors address in a system filter" "SECID217"
31077 .cindex "envelope sender"
31078 In a system filter, if a &%deliver%& command is followed by
31079 .code
31080 errors_to <some address>
31081 .endd
31082 in order to change the envelope sender (and hence the error reporting) for that
31083 delivery, any address may be specified. (In a user filter, only the current
31084 user's address can be set.) For example, if some mail is being monitored, you
31085 might use
31086 .code
31087 unseen deliver monitor@spying.example errors_to root@local.example
31088 .endd
31089 to take a copy which would not be sent back to the normal error reporting
31090 address if its delivery failed.
31091
31092
31093
31094 .section "Per-address filtering" "SECTperaddfil"
31095 .vindex "&$domain$&"
31096 .vindex "&$local_part$&"
31097 In contrast to the system filter, which is run just once per message for each
31098 delivery attempt, it is also possible to set up a system-wide filtering
31099 operation that runs once for each recipient address. In this case, variables
31100 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
31101 filter file could be made dependent on them. This is an example of a router
31102 which implements such a filter:
31103 .code
31104 central_filter:
31105   check_local_user
31106   driver = redirect
31107   domains = +local_domains
31108   file = /central/filters/$local_part
31109   no_verify
31110   allow_filter
31111   allow_freeze
31112 .endd
31113 The filter is run in a separate process under its own uid. Therefore, either
31114 &%check_local_user%& must be set (as above), in which case the filter is run as
31115 the local user, or the &%user%& option must be used to specify which user to
31116 use. If both are set, &%user%& overrides.
31117
31118 Care should be taken to ensure that none of the commands in the filter file
31119 specify a significant delivery if the message is to go on to be delivered to
31120 its intended recipient. The router will not then claim to have dealt with the
31121 address, so it will be passed on to subsequent routers to be delivered in the
31122 normal way.
31123 .ecindex IIDsysfil1
31124 .ecindex IIDsysfil2
31125 .ecindex IIDsysfil3
31126
31127
31128
31129
31130
31131
31132 . ////////////////////////////////////////////////////////////////////////////
31133 . ////////////////////////////////////////////////////////////////////////////
31134
31135 .chapter "Message processing" "CHAPmsgproc"
31136 .scindex IIDmesproc "message" "general processing"
31137 Exim performs various transformations on the sender and recipient addresses of
31138 all messages that it handles, and also on the messages' header lines. Some of
31139 these are optional and configurable, while others always take place. All of
31140 this processing, except rewriting as a result of routing, and the addition or
31141 removal of header lines while delivering, happens when a message is received,
31142 before it is placed on Exim's queue.
31143
31144 Some of the automatic processing takes place by default only for
31145 &"locally-originated"& messages. This adjective is used to describe messages
31146 that are not received over TCP/IP, but instead are passed to an Exim process on
31147 its standard input. This includes the interactive &"local SMTP"& case that is
31148 set up by the &%-bs%& command line option.
31149
31150 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
31151 or ::1) are not considered to be locally-originated. Exim does not treat the
31152 loopback interface specially in any way.
31153
31154 If you want the loopback interface to be treated specially, you must ensure
31155 that there are appropriate entries in your ACLs.
31156
31157
31158
31159
31160 .section "Submission mode for non-local messages" "SECTsubmodnon"
31161 .cindex "message" "submission"
31162 .cindex "submission mode"
31163 Processing that happens automatically for locally-originated messages (unless
31164 &%suppress_local_fixups%& is set) can also be requested for messages that are
31165 received over TCP/IP. The term &"submission mode"& is used to describe this
31166 state. Submission mode is set by the modifier
31167 .code
31168 control = submission
31169 .endd
31170 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
31171 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
31172 a local submission, and is normally used when the source of the message is
31173 known to be an MUA running on a client host (as opposed to an MTA). For
31174 example, to set submission mode for messages originating on the IPv4 loopback
31175 interface, you could include the following in the MAIL ACL:
31176 .code
31177 warn  hosts = 127.0.0.1
31178       control = submission
31179 .endd
31180 .cindex "&%sender_retain%& submission option"
31181 There are some options that can be used when setting submission mode. A slash
31182 is used to separate options. For example:
31183 .code
31184 control = submission/sender_retain
31185 .endd
31186 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
31187 true and &%local_from_check%& false for the current incoming message. The first
31188 of these allows an existing &'Sender:'& header in the message to remain, and
31189 the second suppresses the check to ensure that &'From:'& matches the
31190 authenticated sender. With this setting, Exim still fixes up messages by adding
31191 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
31192 attempt to check sender authenticity in header lines.
31193
31194 When &%sender_retain%& is not set, a submission mode setting may specify a
31195 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
31196 example:
31197 .code
31198 control = submission/domain=some.domain
31199 .endd
31200 The domain may be empty. How this value is used is described in sections
31201 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
31202 that allows you to specify the user's full name for inclusion in a created
31203 &'Sender:'& or &'From:'& header line. For example:
31204 .code
31205 accept authenticated = *
31206        control = submission/domain=wonderland.example/\
31207                             name=${lookup {$authenticated_id} \
31208                                    lsearch {/etc/exim/namelist}}
31209 .endd
31210 Because the name may contain any characters, including slashes, the &%name%&
31211 option must be given last. The remainder of the string is used as the name. For
31212 the example above, if &_/etc/exim/namelist_& contains:
31213 .code
31214 bigegg:  Humpty Dumpty
31215 .endd
31216 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
31217 line would be:
31218 .code
31219 Sender: Humpty Dumpty <bigegg@wonderland.example>
31220 .endd
31221 .cindex "return path" "in submission mode"
31222 By default, submission mode forces the return path to the same address as is
31223 used to create the &'Sender:'& header. However, if &%sender_retain%& is
31224 specified, the return path is also left unchanged.
31225
31226 &*Note*&: The changes caused by submission mode take effect after the predata
31227 ACL. This means that any sender checks performed before the fix-ups use the
31228 untrusted sender address specified by the user, not the trusted sender address
31229 specified by submission mode. Although this might be slightly unexpected, it
31230 does mean that you can configure ACL checks to spot that a user is trying to
31231 spoof another's address.
31232
31233 .section "Line endings" "SECTlineendings"
31234 .cindex "line endings"
31235 .cindex "carriage return"
31236 .cindex "linefeed"
31237 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
31238 linefeed) is the line ending for messages transmitted over the Internet using
31239 SMTP over TCP/IP. However, within individual operating systems, different
31240 conventions are used. For example, Unix-like systems use just LF, but others
31241 use CRLF or just CR.
31242
31243 Exim was designed for Unix-like systems, and internally, it stores messages
31244 using the system's convention of a single LF as a line terminator. When
31245 receiving a message, all line endings are translated to this standard format.
31246 Originally, it was thought that programs that passed messages directly to an
31247 MTA within an operating system would use that system's convention. Experience
31248 has shown that this is not the case; for example, there are Unix applications
31249 that use CRLF in this circumstance. For this reason, and for compatibility with
31250 other MTAs, the way Exim handles line endings for all messages is now as
31251 follows:
31252
31253 .ilist
31254 LF not preceded by CR is treated as a line ending.
31255 .next
31256 CR is treated as a line ending; if it is immediately followed by LF, the LF
31257 is ignored.
31258 .next
31259 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
31260 nor a local message in the state where a line containing only a dot is a
31261 terminator.
31262 .next
31263 If a bare CR is encountered within a header line, an extra space is added after
31264 the line terminator so as not to end the header line. The reasoning behind this
31265 is that bare CRs in header lines are most likely either to be mistakes, or
31266 people trying to play silly games.
31267 .next
31268 If the first header line received in a message ends with CRLF, a subsequent
31269 bare LF in a header line is treated in the same way as a bare CR in a header
31270 line.
31271 .endlist
31272
31273
31274
31275
31276
31277 .section "Unqualified addresses" "SECID218"
31278 .cindex "unqualified addresses"
31279 .cindex "address" "qualification"
31280 By default, Exim expects every envelope address it receives from an external
31281 host to be fully qualified. Unqualified addresses cause negative responses to
31282 SMTP commands. However, because SMTP is used as a means of transporting
31283 messages from MUAs running on personal workstations, there is sometimes a
31284 requirement to accept unqualified addresses from specific hosts or IP networks.
31285
31286 Exim has two options that separately control which hosts may send unqualified
31287 sender or recipient addresses in SMTP commands, namely
31288 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
31289 cases, if an unqualified address is accepted, it is qualified by adding the
31290 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
31291
31292 .oindex "&%qualify_domain%&"
31293 .oindex "&%qualify_recipient%&"
31294 Unqualified addresses in header lines are automatically qualified for messages
31295 that are locally originated, unless the &%-bnq%& option is given on the command
31296 line. For messages received over SMTP, unqualified addresses in header lines
31297 are qualified only if unqualified addresses are permitted in SMTP commands. In
31298 other words, such qualification is also controlled by
31299 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
31300
31301
31302
31303
31304 .section "The UUCP From line" "SECID219"
31305 .cindex "&""From""& line"
31306 .cindex "UUCP" "&""From""& line"
31307 .cindex "sender" "address"
31308 .oindex "&%uucp_from_pattern%&"
31309 .oindex "&%uucp_from_sender%&"
31310 .cindex "envelope sender"
31311 .cindex "Sendmail compatibility" "&""From""& line"
31312 Messages that have come from UUCP (and some other applications) often begin
31313 with a line containing the envelope sender and a timestamp, following the word
31314 &"From"&. Examples of two common formats are:
31315 .code
31316 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
31317 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
31318 .endd
31319 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
31320 Exim recognizes such lines at the start of messages that are submitted to it
31321 via the command line (that is, on the standard input). It does not recognize
31322 such lines in incoming SMTP messages, unless the sending host matches
31323 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
31324 and &%ignore_fromline_local%& is set. The recognition is controlled by a
31325 regular expression that is defined by the &%uucp_from_pattern%& option, whose
31326 default value matches the two common cases shown above and puts the address
31327 that follows &"From"& into &$1$&.
31328
31329 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
31330 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
31331 a trusted user, the message's sender address is constructed by expanding the
31332 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
31333 then parsed as an RFC 2822 address. If there is no domain, the local part is
31334 qualified with &%qualify_domain%& unless it is the empty string. However, if
31335 the command line &%-f%& option is used, it overrides the &"From"& line.
31336
31337 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
31338 sender address is not changed. This is also the case for incoming SMTP messages
31339 that are permitted to contain &"From"& lines.
31340
31341 Only one &"From"& line is recognized. If there is more than one, the second is
31342 treated as a data line that starts the body of the message, as it is not valid
31343 as a header line. This also happens if a &"From"& line is present in an
31344 incoming SMTP message from a source that is not permitted to send them.
31345
31346
31347
31348 .section "Resent- header lines" "SECID220"
31349 .cindex "&%Resent-%& header lines"
31350 RFC 2822 makes provision for sets of header lines starting with the string
31351 &`Resent-`& to be added to a message when it is resent by the original
31352 recipient to somebody else. These headers are &'Resent-Date:'&,
31353 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
31354 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
31355
31356 .blockquote
31357 &'Resent fields are strictly informational. They MUST NOT be used in the normal
31358 processing of replies or other such automatic actions on messages.'&
31359 .endblockquote
31360
31361 This leaves things a bit vague as far as other processing actions such as
31362 address rewriting are concerned. Exim treats &%Resent-%& header lines as
31363 follows:
31364
31365 .ilist
31366 A &'Resent-From:'& line that just contains the login id of the submitting user
31367 is automatically rewritten in the same way as &'From:'& (see below).
31368 .next
31369 If there's a rewriting rule for a particular header line, it is also applied to
31370 &%Resent-%& header lines of the same type. For example, a rule that rewrites
31371 &'From:'& also rewrites &'Resent-From:'&.
31372 .next
31373 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
31374 also removed.
31375 .next
31376 For a locally-submitted message,
31377 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
31378 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
31379 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
31380 included in log lines in this case.
31381 .next
31382 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
31383 &%Resent-%& header lines are present.
31384 .endlist
31385
31386
31387
31388
31389 .section "The Auto-Submitted: header line" "SECID221"
31390 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
31391 includes the header line:
31392 .code
31393 Auto-Submitted: auto-replied
31394 .endd
31395
31396 .section "The Bcc: header line" "SECID222"
31397 .cindex "&'Bcc:'& header line"
31398 If Exim is called with the &%-t%& option, to take recipient addresses from a
31399 message's header, it removes any &'Bcc:'& header line that may exist (after
31400 extracting its addresses). If &%-t%& is not present on the command line, any
31401 existing &'Bcc:'& is not removed.
31402
31403
31404 .section "The Date: header line" "SECID223"
31405 .cindex "&'Date:'& header line"
31406 If a locally-generated or submission-mode message has no &'Date:'& header line,
31407 Exim adds one, using the current date and time, unless the
31408 &%suppress_local_fixups%& control has been specified.
31409
31410 .section "The Delivery-date: header line" "SECID224"
31411 .cindex "&'Delivery-date:'& header line"
31412 .oindex "&%delivery_date_remove%&"
31413 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
31414 set. Exim can be configured to add them to the final delivery of messages. (See
31415 the generic &%delivery_date_add%& transport option.) They should not be present
31416 in messages in transit. If the &%delivery_date_remove%& configuration option is
31417 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
31418 messages.
31419
31420
31421 .section "The Envelope-to: header line" "SECID225"
31422 .cindex "&'Envelope-to:'& header line"
31423 .oindex "&%envelope_to_remove%&"
31424 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
31425 Exim can be configured to add them to the final delivery of messages. (See the
31426 generic &%envelope_to_add%& transport option.) They should not be present in
31427 messages in transit. If the &%envelope_to_remove%& configuration option is set
31428 (the default), Exim removes &'Envelope-to:'& header lines from incoming
31429 messages.
31430
31431
31432 .section "The From: header line" "SECTthefrohea"
31433 .cindex "&'From:'& header line"
31434 .cindex "Sendmail compatibility" "&""From""& line"
31435 .cindex "message" "submission"
31436 .cindex "submission mode"
31437 If a submission-mode message does not contain a &'From:'& header line, Exim
31438 adds one if either of the following conditions is true:
31439
31440 .ilist
31441 The envelope sender address is not empty (that is, this is not a bounce
31442 message). The added header line copies the envelope sender address.
31443 .next
31444 .vindex "&$authenticated_id$&"
31445 The SMTP session is authenticated and &$authenticated_id$& is not empty.
31446 .olist
31447 .vindex "&$qualify_domain$&"
31448 If no domain is specified by the submission control, the local part is
31449 &$authenticated_id$& and the domain is &$qualify_domain$&.
31450 .next
31451 If a non-empty domain is specified by the submission control, the local
31452 part is &$authenticated_id$&, and the domain is the specified domain.
31453 .next
31454 If an empty domain is specified by the submission control,
31455 &$authenticated_id$& is assumed to be the complete address.
31456 .endlist
31457 .endlist
31458
31459 A non-empty envelope sender takes precedence.
31460
31461 If a locally-generated incoming message does not contain a &'From:'& header
31462 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
31463 containing the sender's address. The calling user's login name and full name
31464 are used to construct the address, as described in section &<<SECTconstr>>&.
31465 They are obtained from the password data by calling &[getpwuid()]& (but see the
31466 &%unknown_login%& configuration option). The address is qualified with
31467 &%qualify_domain%&.
31468
31469 For compatibility with Sendmail, if an incoming, non-SMTP message has a
31470 &'From:'& header line containing just the unqualified login name of the calling
31471 user, this is replaced by an address containing the user's login name and full
31472 name as described in section &<<SECTconstr>>&.
31473
31474
31475 .section "The Message-ID: header line" "SECID226"
31476 .cindex "&'Message-ID:'& header line"
31477 .cindex "message" "submission"
31478 .oindex "&%message_id_header_text%&"
31479 If a locally-generated or submission-mode incoming message does not contain a
31480 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
31481 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
31482 to the message. If there are any &'Resent-:'& headers in the message, it
31483 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
31484 message id, preceded by the letter E to ensure it starts with a letter, and
31485 followed by @ and the primary host name. Additional information can be included
31486 in this header line by setting the &%message_id_header_text%& and/or
31487 &%message_id_header_domain%& options.
31488
31489
31490 .section "The Received: header line" "SECID227"
31491 .cindex "&'Received:'& header line"
31492 A &'Received:'& header line is added at the start of every message. The
31493 contents are defined by the &%received_header_text%& configuration option, and
31494 Exim automatically adds a semicolon and a timestamp to the configured string.
31495
31496 The &'Received:'& header is generated as soon as the message's header lines
31497 have been received. At this stage, the timestamp in the &'Received:'& header
31498 line is the time that the message started to be received. This is the value
31499 that is seen by the DATA ACL and by the &[local_scan()]& function.
31500
31501 Once a message is accepted, the timestamp in the &'Received:'& header line is
31502 changed to the time of acceptance, which is (apart from a small delay while the
31503 -H spool file is written) the earliest time at which delivery could start.
31504
31505
31506 .section "The References: header line" "SECID228"
31507 .cindex "&'References:'& header line"
31508 Messages created by the &(autoreply)& transport include a &'References:'&
31509 header line. This is constructed according to the rules that are described in
31510 section 3.64 of RFC 2822 (which states that replies should contain such a
31511 header line), and section 3.14 of RFC 3834 (which states that automatic
31512 responses are not different in this respect). However, because some mail
31513 processing software does not cope well with very long header lines, no more
31514 than 12 message IDs are copied from the &'References:'& header line in the
31515 incoming message. If there are more than 12, the first one and then the final
31516 11 are copied, before adding the message ID of the incoming message.
31517
31518
31519
31520 .section "The Return-path: header line" "SECID229"
31521 .cindex "&'Return-path:'& header line"
31522 .oindex "&%return_path_remove%&"
31523 &'Return-path:'& header lines are defined as something an MTA may insert when
31524 it does the final delivery of messages. (See the generic &%return_path_add%&
31525 transport option.) Therefore, they should not be present in messages in
31526 transit. If the &%return_path_remove%& configuration option is set (the
31527 default), Exim removes &'Return-path:'& header lines from incoming messages.
31528
31529
31530
31531 .section "The Sender: header line" "SECTthesenhea"
31532 .cindex "&'Sender:'& header line"
31533 .cindex "message" "submission"
31534 For a locally-originated message from an untrusted user, Exim may remove an
31535 existing &'Sender:'& header line, and it may add a new one. You can modify
31536 these actions by setting the &%local_sender_retain%& option true, the
31537 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
31538 control setting.
31539
31540 When a local message is received from an untrusted user and
31541 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
31542 control has not been set, a check is made to see if the address given in the
31543 &'From:'& header line is the correct (local) sender of the message. The address
31544 that is expected has the login name as the local part and the value of
31545 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
31546 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
31547 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
31548 line is added to the message.
31549
31550 If you set &%local_from_check%& false, this checking does not occur. However,
31551 the removal of an existing &'Sender:'& line still happens, unless you also set
31552 &%local_sender_retain%& to be true. It is not possible to set both of these
31553 options true at the same time.
31554
31555 .cindex "submission mode"
31556 By default, no processing of &'Sender:'& header lines is done for messages
31557 received over TCP/IP or for messages submitted by trusted users. However, when
31558 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
31559 not specified on the submission control, the following processing takes place:
31560
31561 .vindex "&$authenticated_id$&"
31562 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
31563 authenticated, and &$authenticated_id$& is not empty, a sender address is
31564 created as follows:
31565
31566 .ilist
31567 .vindex "&$qualify_domain$&"
31568 If no domain is specified by the submission control, the local part is
31569 &$authenticated_id$& and the domain is &$qualify_domain$&.
31570 .next
31571 If a non-empty domain is specified by the submission control, the local part
31572 is &$authenticated_id$&, and the domain is the specified domain.
31573 .next
31574 If an empty domain is specified by the submission control,
31575 &$authenticated_id$& is assumed to be the complete address.
31576 .endlist
31577
31578 This address is compared with the address in the &'From:'& header line. If they
31579 are different, a &'Sender:'& header line containing the created address is
31580 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
31581 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
31582
31583 .cindex "return path" "created from &'Sender:'&"
31584 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
31585 the message (the envelope sender address) is changed to be the same address,
31586 except in the case of submission mode when &%sender_retain%& is specified.
31587
31588
31589
31590 .section "Adding and removing header lines in routers and transports" &&&
31591          "SECTheadersaddrem"
31592 .cindex "header lines" "adding; in router or transport"
31593 .cindex "header lines" "removing; in router or transport"
31594 When a message is delivered, the addition and removal of header lines can be
31595 specified in a system filter, or on any of the routers and transports that
31596 process the message. Section &<<SECTaddremheasys>>& contains details about
31597 modifying headers in a system filter. Header lines can also be added in an ACL
31598 as a message is received (see section &<<SECTaddheadacl>>&).
31599
31600 In contrast to what happens in a system filter, header modifications that are
31601 specified on routers and transports apply only to the particular recipient
31602 addresses that are being processed by those routers and transports. These
31603 changes do not actually take place until a copy of the message is being
31604 transported. Therefore, they do not affect the basic set of header lines, and
31605 they do not affect the values of the variables that refer to header lines.
31606
31607 &*Note*&: In particular, this means that any expansions in the configuration of
31608 the transport cannot refer to the modified header lines, because such
31609 expansions all occur before the message is actually transported.
31610
31611 For both routers and transports, the result of expanding a &%headers_add%&
31612 option must be in the form of one or more RFC 2822 header lines, separated by
31613 newlines (coded as &"\n"&). For example:
31614 .code
31615 headers_add = X-added-header: added by $primary_hostname\n\
31616               X-added-second: another added header line
31617 .endd
31618 Exim does not check the syntax of these added header lines.
31619
31620 Multiple &%headers_add%& options for a single router or transport can be
31621 specified; the values will be concatenated (with a separating newline
31622 added) before expansion.
31623
31624 The result of expanding &%headers_remove%& must consist of a colon-separated
31625 list of header names. This is confusing, because header names themselves are
31626 often terminated by colons. In this case, the colons are the list separators,
31627 not part of the names. For example:
31628 .code
31629 headers_remove = return-receipt-to:acknowledge-to
31630 .endd
31631
31632 Multiple &%headers_remove%& options for a single router or transport can be
31633 specified; the values will be concatenated (with a separating colon
31634 added) before expansion.
31635
31636 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
31637 is expanded at routing time, and then associated with all addresses that are
31638 accepted by that router, and also with any new addresses that it generates. If
31639 an address passes through several routers as a result of aliasing or
31640 forwarding, the changes are cumulative.
31641
31642 .oindex "&%unseen%&"
31643 However, this does not apply to multiple routers that result from the use of
31644 the &%unseen%& option. Any header modifications that were specified by the
31645 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
31646
31647 Addresses that end up with different &%headers_add%& or &%headers_remove%&
31648 settings cannot be delivered together in a batch, so a transport is always
31649 dealing with a set of addresses that have the same header-processing
31650 requirements.
31651
31652 The transport starts by writing the original set of header lines that arrived
31653 with the message, possibly modified by the system filter. As it writes out
31654 these lines, it consults the list of header names that were attached to the
31655 recipient address(es) by &%headers_remove%& options in routers, and it also
31656 consults the transport's own &%headers_remove%& option. Header lines whose
31657 names are on either of these lists are not written out. If there are multiple
31658 instances of any listed header, they are all skipped.
31659
31660 After the remaining original header lines have been written, new header
31661 lines that were specified by routers' &%headers_add%& options are written, in
31662 the order in which they were attached to the address. These are followed by any
31663 header lines specified by the transport's &%headers_add%& option.
31664
31665 This way of handling header line modifications in routers and transports has
31666 the following consequences:
31667
31668 .ilist
31669 The original set of header lines, possibly modified by the system filter,
31670 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
31671 to it, at all times.
31672 .next
31673 Header lines that are added by a router's
31674 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
31675 expansion syntax in subsequent routers or the transport.
31676 .next
31677 Conversely, header lines that are specified for removal by &%headers_remove%&
31678 in a router remain visible to subsequent routers and the transport.
31679 .next
31680 Headers added to an address by &%headers_add%& in a router cannot be removed by
31681 a later router or by a transport.
31682 .next
31683 An added header can refer to the contents of an original header that is to be
31684 removed, even it has the same name as the added header. For example:
31685 .code
31686 headers_remove = subject
31687 headers_add = Subject: new subject (was: $h_subject:)
31688 .endd
31689 .endlist
31690
31691 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
31692 for a &(redirect)& router that has the &%one_time%& option set.
31693
31694
31695
31696
31697
31698 .section "Constructed addresses" "SECTconstr"
31699 .cindex "address" "constructed"
31700 .cindex "constructed address"
31701 When Exim constructs a sender address for a locally-generated message, it uses
31702 the form
31703 .display
31704 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
31705 .endd
31706 For example:
31707 .code
31708 Zaphod Beeblebrox <zaphod@end.univ.example>
31709 .endd
31710 The user name is obtained from the &%-F%& command line option if set, or
31711 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
31712 &"gecos"& field from the password entry. If the &"gecos"& field contains an
31713 ampersand character, this is replaced by the login name with the first letter
31714 upper cased, as is conventional in a number of operating systems. See the
31715 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
31716 The &%unknown_username%& option can be used to specify user names in cases when
31717 there is no password file entry.
31718
31719 .cindex "RFC 2047"
31720 In all cases, the user name is made to conform to RFC 2822 by quoting all or
31721 parts of it if necessary. In addition, if it contains any non-printing
31722 characters, it is encoded as described in RFC 2047, which defines a way of
31723 including non-ASCII characters in header lines. The value of the
31724 &%headers_charset%& option specifies the name of the encoding that is used (the
31725 characters are assumed to be in this encoding). The setting of
31726 &%print_topbitchars%& controls whether characters with the top bit set (that
31727 is, with codes greater than 127) count as printing characters or not.
31728
31729
31730
31731 .section "Case of local parts" "SECID230"
31732 .cindex "case of local parts"
31733 .cindex "local part" "case of"
31734 RFC 2822 states that the case of letters in the local parts of addresses cannot
31735 be assumed to be non-significant. Exim preserves the case of local parts of
31736 addresses, but by default it uses a lower-cased form when it is routing,
31737 because on most Unix systems, usernames are in lower case and case-insensitive
31738 routing is required. However, any particular router can be made to use the
31739 original case for local parts by setting the &%caseful_local_part%& generic
31740 router option.
31741
31742 .cindex "mixed-case login names"
31743 If you must have mixed-case user names on your system, the best way to proceed,
31744 assuming you want case-independent handling of incoming email, is to set up
31745 your first router to convert incoming local parts in your domains to the
31746 correct case by means of a file lookup. For example:
31747 .code
31748 correct_case:
31749   driver = redirect
31750   domains = +local_domains
31751   data = ${lookup{$local_part}cdb\
31752               {/etc/usercased.cdb}{$value}fail}\
31753               @$domain
31754 .endd
31755 For this router, the local part is forced to lower case by the default action
31756 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
31757 up a new local part in the correct case. If you then set &%caseful_local_part%&
31758 on any subsequent routers which process your domains, they will operate on
31759 local parts with the correct case in a case-sensitive manner.
31760
31761
31762
31763 .section "Dots in local parts" "SECID231"
31764 .cindex "dot" "in local part"
31765 .cindex "local part" "dots in"
31766 RFC 2822 forbids empty components in local parts. That is, an unquoted local
31767 part may not begin or end with a dot, nor have two consecutive dots in the
31768 middle. However, it seems that many MTAs do not enforce this, so Exim permits
31769 empty components for compatibility.
31770
31771
31772
31773 .section "Rewriting addresses" "SECID232"
31774 .cindex "rewriting" "addresses"
31775 Rewriting of sender and recipient addresses, and addresses in headers, can
31776 happen automatically, or as the result of configuration options, as described
31777 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
31778 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
31779
31780 Automatic rewriting includes qualification, as mentioned above. The other case
31781 in which it can happen is when an incomplete non-local domain is given. The
31782 routing process may cause this to be expanded into the full domain name. For
31783 example, a header such as
31784 .code
31785 To: hare@teaparty
31786 .endd
31787 might get rewritten as
31788 .code
31789 To: hare@teaparty.wonderland.fict.example
31790 .endd
31791 Rewriting as a result of routing is the one kind of message processing that
31792 does not happen at input time, as it cannot be done until the address has
31793 been routed.
31794
31795 Strictly, one should not do &'any'& deliveries of a message until all its
31796 addresses have been routed, in case any of the headers get changed as a
31797 result of routing. However, doing this in practice would hold up many
31798 deliveries for unreasonable amounts of time, just because one address could not
31799 immediately be routed. Exim therefore does not delay other deliveries when
31800 routing of one or more addresses is deferred.
31801 .ecindex IIDmesproc
31802
31803
31804
31805 . ////////////////////////////////////////////////////////////////////////////
31806 . ////////////////////////////////////////////////////////////////////////////
31807
31808 .chapter "SMTP processing" "CHAPSMTP"
31809 .scindex IIDsmtpproc1 "SMTP" "processing details"
31810 .scindex IIDsmtpproc2 "LMTP" "processing details"
31811 Exim supports a number of different ways of using the SMTP protocol, and its
31812 LMTP variant, which is an interactive protocol for transferring messages into a
31813 closed mail store application. This chapter contains details of how SMTP is
31814 processed. For incoming mail, the following are available:
31815
31816 .ilist
31817 SMTP over TCP/IP (Exim daemon or &'inetd'&);
31818 .next
31819 SMTP over the standard input and output (the &%-bs%& option);
31820 .next
31821 Batched SMTP on the standard input (the &%-bS%& option).
31822 .endlist
31823
31824 For mail delivery, the following are available:
31825
31826 .ilist
31827 SMTP over TCP/IP (the &(smtp)& transport);
31828 .next
31829 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
31830 &"lmtp"&);
31831 .next
31832 LMTP over a pipe to a process running in the local host (the &(lmtp)&
31833 transport);
31834 .next
31835 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
31836 the &%use_bsmtp%& option set).
31837 .endlist
31838
31839 &'Batched SMTP'& is the name for a process in which batches of messages are
31840 stored in or read from files (or pipes), in a format in which SMTP commands are
31841 used to contain the envelope information.
31842
31843
31844
31845 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
31846 .cindex "SMTP" "outgoing over TCP/IP"
31847 .cindex "outgoing SMTP over TCP/IP"
31848 .cindex "LMTP" "over TCP/IP"
31849 .cindex "outgoing LMTP over TCP/IP"
31850 .cindex "EHLO"
31851 .cindex "HELO"
31852 .cindex "SIZE option on MAIL command"
31853 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
31854 The &%protocol%& option selects which protocol is to be used, but the actual
31855 processing is the same in both cases.
31856
31857 If, in response to its EHLO command, Exim is told that the SIZE
31858 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
31859 command. The value of <&'n'&> is the message size plus the value of the
31860 &%size_addition%& option (default 1024) to allow for additions to the message
31861 such as per-transport header lines, or changes made in a
31862 .cindex "transport" "filter"
31863 .cindex "filter" "transport filter"
31864 transport filter. If &%size_addition%& is set negative, the use of SIZE is
31865 suppressed.
31866
31867 If the remote server advertises support for PIPELINING, Exim uses the
31868 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
31869 required for the transaction.
31870
31871 If the remote server advertises support for the STARTTLS command, and Exim
31872 was built to support TLS encryption, it tries to start a TLS session unless the
31873 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
31874 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
31875 is called for verification.
31876
31877 If the remote server advertises support for the AUTH command, Exim scans
31878 the authenticators configuration for any suitable client settings, as described
31879 in chapter &<<CHAPSMTPAUTH>>&.
31880
31881 .cindex "carriage return"
31882 .cindex "linefeed"
31883 Responses from the remote host are supposed to be terminated by CR followed by
31884 LF. However, there are known to be hosts that do not send CR characters, so in
31885 order to be able to interwork with such hosts, Exim treats LF on its own as a
31886 line terminator.
31887
31888 If a message contains a number of different addresses, all those with the same
31889 characteristics (for example, the same envelope sender) that resolve to the
31890 same set of hosts, in the same order, are sent in a single SMTP transaction,
31891 even if they are for different domains, unless there are more than the setting
31892 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
31893 they are split into groups containing no more than &%max_rcpt%&s addresses
31894 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
31895 in parallel sessions. The order of hosts with identical MX values is not
31896 significant when checking whether addresses can be batched in this way.
31897
31898 When the &(smtp)& transport suffers a temporary failure that is not
31899 message-related, Exim updates its transport-specific database, which contains
31900 records indexed by host name that remember which messages are waiting for each
31901 particular host. It also updates the retry database with new retry times.
31902
31903 .cindex "hints database" "retry keys"
31904 Exim's retry hints are based on host name plus IP address, so if one address of
31905 a multi-homed host is broken, it will soon be skipped most of the time.
31906 See the next section for more detail about error handling.
31907
31908 .cindex "SMTP" "passed connection"
31909 .cindex "SMTP" "batching over TCP/IP"
31910 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
31911 looks in the hints database for the transport to see if there are any queued
31912 messages waiting for the host to which it is connected. If it finds one, it
31913 creates a new Exim process using the &%-MC%& option (which can only be used by
31914 a process running as root or the Exim user) and passes the TCP/IP socket to it
31915 so that it can deliver another message using the same socket. The new process
31916 does only those deliveries that are routed to the connected host, and may in
31917 turn pass the socket on to a third process, and so on.
31918
31919 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
31920 limit the number of messages sent down a single TCP/IP connection.
31921
31922 .cindex "asterisk" "after IP address"
31923 The second and subsequent messages delivered down an existing connection are
31924 identified in the main log by the addition of an asterisk after the closing
31925 square bracket of the IP address.
31926
31927
31928
31929
31930 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
31931 .cindex "error" "in outgoing SMTP"
31932 .cindex "SMTP" "errors in outgoing"
31933 .cindex "host" "error"
31934 Three different kinds of error are recognized for outgoing SMTP: host errors,
31935 message errors, and recipient errors.
31936
31937 .vlist
31938 .vitem "&*Host errors*&"
31939 A host error is not associated with a particular message or with a
31940 particular recipient of a message. The host errors are:
31941
31942 .ilist
31943 Connection refused or timed out,
31944 .next
31945 Any error response code on connection,
31946 .next
31947 Any error response code to EHLO or HELO,
31948 .next
31949 Loss of connection at any time, except after &"."&,
31950 .next
31951 I/O errors at any time,
31952 .next
31953 Timeouts during the session, other than in response to MAIL, RCPT or
31954 the &"."& at the end of the data.
31955 .endlist ilist
31956
31957 For a host error, a permanent error response on connection, or in response to
31958 EHLO, causes all addresses routed to the host to be failed. Any other host
31959 error causes all addresses to be deferred, and retry data to be created for the
31960 host. It is not tried again, for any message, until its retry time arrives. If
31961 the current set of addresses are not all delivered in this run (to some
31962 alternative host), the message is added to the list of those waiting for this
31963 host, so if it is still undelivered when a subsequent successful delivery is
31964 made to the host, it will be sent down the same SMTP connection.
31965
31966 .vitem "&*Message errors*&"
31967 .cindex "message" "error"
31968 A message error is associated with a particular message when sent to a
31969 particular host, but not with a particular recipient of the message. The
31970 message errors are:
31971
31972 .ilist
31973 Any error response code to MAIL, DATA, or the &"."& that terminates
31974 the data,
31975 .next
31976 Timeout after MAIL,
31977 .next
31978 Timeout or loss of connection after the &"."& that terminates the data. A
31979 timeout after the DATA command itself is treated as a host error, as is loss of
31980 connection at any other time.
31981 .endlist ilist
31982
31983 For a message error, a permanent error response (5&'xx'&) causes all addresses
31984 to be failed, and a delivery error report to be returned to the sender. A
31985 temporary error response (4&'xx'&), or one of the timeouts, causes all
31986 addresses to be deferred. Retry data is not created for the host, but instead,
31987 a retry record for the combination of host plus message id is created. The
31988 message is not added to the list of those waiting for this host. This ensures
31989 that the failing message will not be sent to this host again until the retry
31990 time arrives. However, other messages that are routed to the host are not
31991 affected, so if it is some property of the message that is causing the error,
31992 it will not stop the delivery of other mail.
31993
31994 If the remote host specified support for the SIZE parameter in its response
31995 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
31996 over-large message will cause a message error because the error arrives as a
31997 response to MAIL.
31998
31999 .vitem "&*Recipient errors*&"
32000 .cindex "recipient" "error"
32001 A recipient error is associated with a particular recipient of a message. The
32002 recipient errors are:
32003
32004 .ilist
32005 Any error response to RCPT,
32006 .next
32007 Timeout after RCPT.
32008 .endlist
32009
32010 For a recipient error, a permanent error response (5&'xx'&) causes the
32011 recipient address to be failed, and a bounce message to be returned to the
32012 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
32013 address to be deferred, and routing retry data to be created for it. This is
32014 used to delay processing of the address in subsequent queue runs, until its
32015 routing retry time arrives. This applies to all messages, but because it
32016 operates only in queue runs, one attempt will be made to deliver a new message
32017 to the failing address before the delay starts to operate. This ensures that,
32018 if the failure is really related to the message rather than the recipient
32019 (&"message too big for this recipient"& is a possible example), other messages
32020 have a chance of getting delivered. If a delivery to the address does succeed,
32021 the retry information gets cleared, so all stuck messages get tried again, and
32022 the retry clock is reset.
32023
32024 The message is not added to the list of those waiting for this host. Use of the
32025 host for other messages is unaffected, and except in the case of a timeout,
32026 other recipients are processed independently, and may be successfully delivered
32027 in the current SMTP session. After a timeout it is of course impossible to
32028 proceed with the session, so all addresses get deferred. However, those other
32029 than the one that failed do not suffer any subsequent retry delays. Therefore,
32030 if one recipient is causing trouble, the others have a chance of getting
32031 through when a subsequent delivery attempt occurs before the failing
32032 recipient's retry time.
32033 .endlist
32034
32035 In all cases, if there are other hosts (or IP addresses) available for the
32036 current set of addresses (for example, from multiple MX records), they are
32037 tried in this run for any undelivered addresses, subject of course to their
32038 own retry data. In other words, recipient error retry data does not take effect
32039 until the next delivery attempt.
32040
32041 Some hosts have been observed to give temporary error responses to every
32042 MAIL command at certain times (&"insufficient space"& has been seen). It
32043 would be nice if such circumstances could be recognized, and defer data for the
32044 host itself created, but this is not possible within the current Exim design.
32045 What actually happens is that retry data for every (host, message) combination
32046 is created.
32047
32048 The reason that timeouts after MAIL and RCPT are treated specially is that
32049 these can sometimes arise as a result of the remote host's verification
32050 procedures. Exim makes this assumption, and treats them as if a temporary error
32051 response had been received. A timeout after &"."& is treated specially because
32052 it is known that some broken implementations fail to recognize the end of the
32053 message if the last character of the last line is a binary zero. Thus, it is
32054 helpful to treat this case as a message error.
32055
32056 Timeouts at other times are treated as host errors, assuming a problem with the
32057 host, or the connection to it. If a timeout after MAIL, RCPT,
32058 or &"."& is really a connection problem, the assumption is that at the next try
32059 the timeout is likely to occur at some other point in the dialogue, causing it
32060 then to be treated as a host error.
32061
32062 There is experimental evidence that some MTAs drop the connection after the
32063 terminating &"."& if they do not like the contents of the message for some
32064 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
32065 should be given. That is why Exim treats this case as a message rather than a
32066 host error, in order not to delay other messages to the same host.
32067
32068
32069
32070
32071 .section "Incoming SMTP messages over TCP/IP" "SECID233"
32072 .cindex "SMTP" "incoming over TCP/IP"
32073 .cindex "incoming SMTP over TCP/IP"
32074 .cindex "inetd"
32075 .cindex "daemon"
32076 Incoming SMTP messages can be accepted in one of two ways: by running a
32077 listening daemon, or by using &'inetd'&. In the latter case, the entry in
32078 &_/etc/inetd.conf_& should be like this:
32079 .code
32080 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
32081 .endd
32082 Exim distinguishes between this case and the case of a locally running user
32083 agent using the &%-bs%& option by checking whether or not the standard input is
32084 a socket. When it is, either the port must be privileged (less than 1024), or
32085 the caller must be root or the Exim user. If any other user passes a socket
32086 with an unprivileged port number, Exim prints a message on the standard error
32087 stream and exits with an error code.
32088
32089 By default, Exim does not make a log entry when a remote host connects or
32090 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
32091 unexpected. It can be made to write such log entries by setting the
32092 &%smtp_connection%& log selector.
32093
32094 .cindex "carriage return"
32095 .cindex "linefeed"
32096 Commands from the remote host are supposed to be terminated by CR followed by
32097 LF. However, there are known to be hosts that do not send CR characters. In
32098 order to be able to interwork with such hosts, Exim treats LF on its own as a
32099 line terminator.
32100 Furthermore, because common code is used for receiving messages from all
32101 sources, a CR on its own is also interpreted as a line terminator. However, the
32102 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
32103
32104 .cindex "EHLO" "invalid data"
32105 .cindex "HELO" "invalid data"
32106 One area that sometimes gives rise to problems concerns the EHLO or
32107 HELO commands. Some clients send syntactically invalid versions of these
32108 commands, which Exim rejects by default. (This is nothing to do with verifying
32109 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
32110 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
32111 match the broken hosts that send invalid commands.
32112
32113 .cindex "SIZE option on MAIL command"
32114 .cindex "MAIL" "SIZE option"
32115 The amount of disk space available is checked whenever SIZE is received on
32116 a MAIL command, independently of whether &%message_size_limit%& or
32117 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
32118 false. A temporary error is given if there is not enough space. If
32119 &%check_spool_space%& is set, the check is for that amount of space plus the
32120 value given with SIZE, that is, it checks that the addition of the incoming
32121 message will not reduce the space below the threshold.
32122
32123 When a message is successfully received, Exim includes the local message id in
32124 its response to the final &"."& that terminates the data. If the remote host
32125 logs this text it can help with tracing what has happened to a message.
32126
32127 The Exim daemon can limit the number of simultaneous incoming connections it is
32128 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
32129 number of simultaneous incoming connections from a single remote host (see the
32130 &%smtp_accept_max_per_host%& option). Additional connection attempts are
32131 rejected using the SMTP temporary error code 421.
32132
32133 The Exim daemon does not rely on the SIGCHLD signal to detect when a
32134 subprocess has finished, as this can get lost at busy times. Instead, it looks
32135 for completed subprocesses every time it wakes up. Provided there are other
32136 things happening (new incoming calls, starts of queue runs), completed
32137 processes will be noticed and tidied away. On very quiet systems you may
32138 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
32139 it will be noticed when the daemon next wakes up.
32140
32141 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
32142 and can also be set up to reject SMTP calls from non-reserved hosts at times of
32143 high system load &-- for details see the &%smtp_accept_reserve%&,
32144 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
32145 applies in both the daemon and &'inetd'& cases.
32146
32147 Exim normally starts a delivery process for each message received, though this
32148 can be varied by means of the &%-odq%& command line option and the
32149 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
32150 number of simultaneously running delivery processes started in this way from
32151 SMTP input can be limited by the &%smtp_accept_queue%& and
32152 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
32153 subsequently received messages are just put on the input queue without starting
32154 a delivery process.
32155
32156 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
32157 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
32158 started up from the &'inetd'& daemon, because in that case each connection is
32159 handled by an entirely independent Exim process. Control by load average is,
32160 however, available with &'inetd'&.
32161
32162 Exim can be configured to verify addresses in incoming SMTP commands as they
32163 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
32164 to rewrite addresses at this time &-- before any syntax checking is done. See
32165 section &<<SECTrewriteS>>&.
32166
32167 Exim can also be configured to limit the rate at which a client host submits
32168 MAIL and RCPT commands in a single SMTP session. See the
32169 &%smtp_ratelimit_hosts%& option.
32170
32171
32172
32173 .section "Unrecognized SMTP commands" "SECID234"
32174 .cindex "SMTP" "unrecognized commands"
32175 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
32176 commands during a single SMTP connection, it drops the connection after sending
32177 the error response to the last command. The default value for
32178 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
32179 abuse that subvert web servers into making connections to SMTP ports; in these
32180 circumstances, a number of non-SMTP lines are sent first.
32181
32182
32183 .section "Syntax and protocol errors in SMTP commands" "SECID235"
32184 .cindex "SMTP" "syntax errors"
32185 .cindex "SMTP" "protocol errors"
32186 A syntax error is detected if an SMTP command is recognized, but there is
32187 something syntactically wrong with its data, for example, a malformed email
32188 address in a RCPT command. Protocol errors include invalid command
32189 sequencing such as RCPT before MAIL. If Exim receives more than
32190 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
32191 drops the connection after sending the error response to the last command. The
32192 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
32193 broken clients that loop sending bad commands (yes, it has been seen).
32194
32195
32196
32197 .section "Use of non-mail SMTP commands" "SECID236"
32198 .cindex "SMTP" "non-mail commands"
32199 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
32200 DATA. Exim counts such commands, and drops the connection if there are too
32201 many of them in a single SMTP session. This action catches some
32202 denial-of-service attempts and things like repeated failing AUTHs, or a mad
32203 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
32204 defines what &"too many"& means. Its default value is 10.
32205
32206 When a new message is expected, one occurrence of RSET is not counted. This
32207 allows a client to send one RSET between messages (this is not necessary,
32208 but some clients do it). Exim also allows one uncounted occurrence of HELO
32209 or EHLO, and one occurrence of STARTTLS between messages. After
32210 starting up a TLS session, another EHLO is expected, and so it too is not
32211 counted.
32212
32213 The first occurrence of AUTH in a connection, or immediately following
32214 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
32215 RCPT, DATA, and QUIT are counted.
32216
32217 You can control which hosts are subject to the limit set by
32218 &%smtp_accept_max_nonmail%& by setting
32219 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
32220 the limit apply to all hosts. This option means that you can exclude any
32221 specific badly-behaved hosts that you have to live with.
32222
32223
32224
32225
32226 .section "The VRFY and EXPN commands" "SECID237"
32227 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
32228 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
32229 appropriate) in order to decide whether the command should be accepted or not.
32230 If no ACL is defined, the command is rejected.
32231
32232 .cindex "VRFY" "processing"
32233 When VRFY is accepted, it runs exactly the same code as when Exim is
32234 called with the &%-bv%& option.
32235
32236 .cindex "EXPN" "processing"
32237 When EXPN is accepted, a single-level expansion of the address is done.
32238 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
32239 than a verification (the &%-bv%& option). If an unqualified local part is given
32240 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
32241 of VRFY and EXPN commands are logged on the main and reject logs, and
32242 VRFY verification failures are logged on the main log for consistency with
32243 RCPT failures.
32244
32245
32246
32247 .section "The ETRN command" "SECTETRN"
32248 .cindex "ETRN" "processing"
32249 RFC 1985 describes an SMTP command called ETRN that is designed to
32250 overcome the security problems of the TURN command (which has fallen into
32251 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
32252 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
32253 should be accepted or not. If no ACL is defined, the command is rejected.
32254
32255 The ETRN command is concerned with &"releasing"& messages that are awaiting
32256 delivery to certain hosts. As Exim does not organize its message queue by host,
32257 the only form of ETRN that is supported by default is the one where the
32258 text starts with the &"#"& prefix, in which case the remainder of the text is
32259 specific to the SMTP server. A valid ETRN command causes a run of Exim with
32260 the &%-R%& option to happen, with the remainder of the ETRN text as its
32261 argument. For example,
32262 .code
32263 ETRN #brigadoon
32264 .endd
32265 runs the command
32266 .code
32267 exim -R brigadoon
32268 .endd
32269 which causes a delivery attempt on all messages with undelivered addresses
32270 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
32271 default), Exim prevents the simultaneous execution of more than one queue run
32272 for the same argument string as a result of an ETRN command. This stops
32273 a misbehaving client from starting more than one queue runner at once.
32274
32275 .cindex "hints database" "ETRN serialization"
32276 Exim implements the serialization by means of a hints database in which a
32277 record is written whenever a process is started by ETRN, and deleted when
32278 the process completes. However, Exim does not keep the SMTP session waiting for
32279 the ETRN process to complete. Once ETRN is accepted, the client is sent
32280 a &"success"& return code. Obviously there is scope for hints records to get
32281 left lying around if there is a system or program crash. To guard against this,
32282 Exim ignores any records that are more than six hours old.
32283
32284 .oindex "&%smtp_etrn_command%&"
32285 For more control over what ETRN does, the &%smtp_etrn_command%& option can
32286 used. This specifies a command that is run whenever ETRN is received,
32287 whatever the form of its argument. For
32288 example:
32289 .code
32290 smtp_etrn_command = /etc/etrn_command $domain \
32291                     $sender_host_address
32292 .endd
32293 .vindex "&$domain$&"
32294 The string is split up into arguments which are independently expanded. The
32295 expansion variable &$domain$& is set to the argument of the ETRN command,
32296 and no syntax checking is done on the contents of this argument. Exim does not
32297 wait for the command to complete, so its status code is not checked. Exim runs
32298 under its own uid and gid when receiving incoming SMTP, so it is not possible
32299 for it to change them before running the command.
32300
32301
32302
32303 .section "Incoming local SMTP" "SECID238"
32304 .cindex "SMTP" "local incoming"
32305 Some user agents use SMTP to pass messages to their local MTA using the
32306 standard input and output, as opposed to passing the envelope on the command
32307 line and writing the message to the standard input. This is supported by the
32308 &%-bs%& option. This form of SMTP is handled in the same way as incoming
32309 messages over TCP/IP (including the use of ACLs), except that the envelope
32310 sender given in a MAIL command is ignored unless the caller is trusted. In
32311 an ACL you can detect this form of SMTP input by testing for an empty host
32312 identification. It is common to have this as the first line in the ACL that
32313 runs for RCPT commands:
32314 .code
32315 accept hosts = :
32316 .endd
32317 This accepts SMTP messages from local processes without doing any other tests.
32318
32319
32320
32321 .section "Outgoing batched SMTP" "SECTbatchSMTP"
32322 .cindex "SMTP" "batched outgoing"
32323 .cindex "batched SMTP output"
32324 Both the &(appendfile)& and &(pipe)& transports can be used for handling
32325 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
32326 be output in BSMTP format. No SMTP responses are possible for this form of
32327 delivery. All it is doing is using SMTP commands as a way of transmitting the
32328 envelope along with the message.
32329
32330 The message is written to the file or pipe preceded by the SMTP commands
32331 MAIL and RCPT, and followed by a line containing a single dot. Lines in
32332 the message that start with a dot have an extra dot added. The SMTP command
32333 HELO is not normally used. If it is required, the &%message_prefix%& option
32334 can be used to specify it.
32335
32336 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
32337 one recipient address at a time by default. However, you can arrange for them
32338 to handle several addresses at once by setting the &%batch_max%& option. When
32339 this is done for BSMTP, messages may contain multiple RCPT commands. See
32340 chapter &<<CHAPbatching>>& for more details.
32341
32342 .vindex "&$host$&"
32343 When one or more addresses are routed to a BSMTP transport by a router that
32344 sets up a host list, the name of the first host on the list is available to the
32345 transport in the variable &$host$&. Here is an example of such a transport and
32346 router:
32347 .code
32348 begin routers
32349 route_append:
32350   driver = manualroute
32351   transport = smtp_appendfile
32352   route_list = domain.example  batch.host.example
32353
32354 begin transports
32355 smtp_appendfile:
32356   driver = appendfile
32357   directory = /var/bsmtp/$host
32358   batch_max = 1000
32359   use_bsmtp
32360   user = exim
32361 .endd
32362 This causes messages addressed to &'domain.example'& to be written in BSMTP
32363 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
32364 message (unless there are more than 1000 recipients).
32365
32366
32367
32368 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
32369 .cindex "SMTP" "batched incoming"
32370 .cindex "batched SMTP input"
32371 The &%-bS%& command line option causes Exim to accept one or more messages by
32372 reading SMTP on the standard input, but to generate no responses. If the caller
32373 is trusted, the senders in the MAIL commands are believed; otherwise the
32374 sender is always the caller of Exim. Unqualified senders and receivers are not
32375 rejected (there seems little point) but instead just get qualified. HELO
32376 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
32377 as NOOP; QUIT quits.
32378
32379 Minimal policy checking is done for BSMTP input. Only the non-SMTP
32380 ACL is run in the same way as for non-SMTP local input.
32381
32382 If an error is detected while reading a message, including a missing &"."& at
32383 the end, Exim gives up immediately. It writes details of the error to the
32384 standard output in a stylized way that the calling program should be able to
32385 make some use of automatically, for example:
32386 .code
32387 554 Unexpected end of file
32388 Transaction started in line 10
32389 Error detected in line 14
32390 .endd
32391 It writes a more verbose version, for human consumption, to the standard error
32392 file, for example:
32393 .code
32394 An error was detected while processing a file of BSMTP input.
32395 The error message was:
32396
32397 501 '>' missing at end of address
32398
32399 The SMTP transaction started in line 10.
32400 The error was detected in line 12.
32401 The SMTP command at fault was:
32402
32403 rcpt to:<malformed@in.com.plete
32404
32405 1 previous message was successfully processed.
32406 The rest of the batch was abandoned.
32407 .endd
32408 The return code from Exim is zero only if there were no errors. It is 1 if some
32409 messages were accepted before an error was detected, and 2 if no messages were
32410 accepted.
32411 .ecindex IIDsmtpproc1
32412 .ecindex IIDsmtpproc2
32413
32414
32415
32416 . ////////////////////////////////////////////////////////////////////////////
32417 . ////////////////////////////////////////////////////////////////////////////
32418
32419 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
32420          "Customizing messages"
32421 When a message fails to be delivered, or remains on the queue for more than a
32422 configured amount of time, Exim sends a message to the original sender, or
32423 to an alternative configured address. The text of these messages is built into
32424 the code of Exim, but it is possible to change it, either by adding a single
32425 string, or by replacing each of the paragraphs by text supplied in a file.
32426
32427 The &'From:'& and &'To:'& header lines are automatically generated; you can
32428 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
32429 option. Exim also adds the line
32430 .code
32431 Auto-Submitted: auto-generated
32432 .endd
32433 to all warning and bounce messages,
32434
32435
32436 .section "Customizing bounce messages" "SECID239"
32437 .cindex "customizing" "bounce message"
32438 .cindex "bounce message" "customizing"
32439 If &%bounce_message_text%& is set, its contents are included in the default
32440 message immediately after &"This message was created automatically by mail
32441 delivery software."& The string is not expanded. It is not used if
32442 &%bounce_message_file%& is set.
32443
32444 When &%bounce_message_file%& is set, it must point to a template file for
32445 constructing error messages. The file consists of a series of text items,
32446 separated by lines consisting of exactly four asterisks. If the file cannot be
32447 opened, default text is used and a message is written to the main and panic
32448 logs. If any text item in the file is empty, default text is used for that
32449 item.
32450
32451 .vindex "&$bounce_recipient$&"
32452 .vindex "&$bounce_return_size_limit$&"
32453 Each item of text that is read from the file is expanded, and there are two
32454 expansion variables which can be of use here: &$bounce_recipient$& is set to
32455 the recipient of an error message while it is being created, and
32456 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
32457 option, rounded to a whole number.
32458
32459 The items must appear in the file in the following order:
32460
32461 .ilist
32462 The first item is included in the headers, and should include at least a
32463 &'Subject:'& header. Exim does not check the syntax of these headers.
32464 .next
32465 The second item forms the start of the error message. After it, Exim lists the
32466 failing addresses with their error messages.
32467 .next
32468 The third item is used to introduce any text from pipe transports that is to be
32469 returned to the sender. It is omitted if there is no such text.
32470 .next
32471 The fourth item is used to introduce the copy of the message that is returned
32472 as part of the error report.
32473 .next
32474 The fifth item is added after the fourth one if the returned message is
32475 truncated because it is bigger than &%return_size_limit%&.
32476 .next
32477 The sixth item is added after the copy of the original message.
32478 .endlist
32479
32480 The default state (&%bounce_message_file%& unset) is equivalent to the
32481 following file, in which the sixth item is empty. The &'Subject:'& and some
32482 other lines have been split in order to fit them on the page:
32483 .code
32484 Subject: Mail delivery failed
32485   ${if eq{$sender_address}{$bounce_recipient}
32486   {: returning message to sender}}
32487 ****
32488 This message was created automatically by mail delivery software.
32489
32490 A message ${if eq{$sender_address}{$bounce_recipient}
32491   {that you sent }{sent by
32492
32493 <$sender_address>
32494
32495 }}could not be delivered to all of its recipients.
32496 This is a permanent error. The following address(es) failed:
32497 ****
32498 The following text was generated during the delivery attempt(s):
32499 ****
32500 ------ This is a copy of the message, including all the headers.
32501   ------
32502 ****
32503 ------ The body of the message is $message_size characters long;
32504   only the first
32505 ------ $bounce_return_size_limit or so are included here.
32506 ****
32507 .endd
32508 .section "Customizing warning messages" "SECTcustwarn"
32509 .cindex "customizing" "warning message"
32510 .cindex "warning of delay" "customizing the message"
32511 The option &%warn_message_file%& can be pointed at a template file for use when
32512 warnings about message delays are created. In this case there are only three
32513 text sections:
32514
32515 .ilist
32516 The first item is included in the headers, and should include at least a
32517 &'Subject:'& header. Exim does not check the syntax of these headers.
32518 .next
32519 The second item forms the start of the warning message. After it, Exim lists
32520 the delayed addresses.
32521 .next
32522 The third item then ends the message.
32523 .endlist
32524
32525 The default state is equivalent to the following file, except that some lines
32526 have been split here, in order to fit them on the page:
32527 .code
32528 Subject: Warning: message $message_exim_id delayed
32529   $warn_message_delay
32530 ****
32531 This message was created automatically by mail delivery software.
32532
32533 A message ${if eq{$sender_address}{$warn_message_recipients}
32534 {that you sent }{sent by
32535
32536 <$sender_address>
32537
32538 }}has not been delivered to all of its recipients after
32539 more than $warn_message_delay on the queue on $primary_hostname.
32540
32541 The message identifier is:     $message_exim_id
32542 The subject of the message is: $h_subject
32543 The date of the message is:    $h_date
32544
32545 The following address(es) have not yet been delivered:
32546 ****
32547 No action is required on your part. Delivery attempts will
32548 continue for some time, and this warning may be repeated at
32549 intervals if the message remains undelivered. Eventually the
32550 mail delivery software will give up, and when that happens,
32551 the message will be returned to you.
32552 .endd
32553 .vindex "&$warn_message_delay$&"
32554 .vindex "&$warn_message_recipients$&"
32555 However, in the default state the subject and date lines are omitted if no
32556 appropriate headers exist. During the expansion of this file,
32557 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
32558 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
32559 of recipients for the warning message. There may be more than one if there are
32560 multiple addresses with different &%errors_to%& settings on the routers that
32561 handled them.
32562
32563
32564
32565
32566 . ////////////////////////////////////////////////////////////////////////////
32567 . ////////////////////////////////////////////////////////////////////////////
32568
32569 .chapter "Some common configuration settings" "CHAPcomconreq"
32570 This chapter discusses some configuration settings that seem to be fairly
32571 common. More examples and discussion can be found in the Exim book.
32572
32573
32574
32575 .section "Sending mail to a smart host" "SECID240"
32576 .cindex "smart host" "example router"
32577 If you want to send all mail for non-local domains to a &"smart host"&, you
32578 should replace the default &(dnslookup)& router with a router which does the
32579 routing explicitly:
32580 .code
32581 send_to_smart_host:
32582   driver = manualroute
32583   route_list = !+local_domains smart.host.name
32584   transport = remote_smtp
32585 .endd
32586 You can use the smart host's IP address instead of the name if you wish.
32587 If you are using Exim only to submit messages to a smart host, and not for
32588 receiving incoming messages, you can arrange for it to do the submission
32589 synchronously by setting the &%mua_wrapper%& option (see chapter
32590 &<<CHAPnonqueueing>>&).
32591
32592
32593
32594
32595 .section "Using Exim to handle mailing lists" "SECTmailinglists"
32596 .cindex "mailing lists"
32597 Exim can be used to run simple mailing lists, but for large and/or complicated
32598 requirements, the use of additional specialized mailing list software such as
32599 Majordomo or Mailman is recommended.
32600
32601 The &(redirect)& router can be used to handle mailing lists where each list
32602 is maintained in a separate file, which can therefore be managed by an
32603 independent manager. The &%domains%& router option can be used to run these
32604 lists in a separate domain from normal mail. For example:
32605 .code
32606 lists:
32607   driver = redirect
32608   domains = lists.example
32609   file = /usr/lists/$local_part
32610   forbid_pipe
32611   forbid_file
32612   errors_to = $local_part-request@lists.example
32613   no_more
32614 .endd
32615 This router is skipped for domains other than &'lists.example'&. For addresses
32616 in that domain, it looks for a file that matches the local part. If there is no
32617 such file, the router declines, but because &%no_more%& is set, no subsequent
32618 routers are tried, and so the whole delivery fails.
32619
32620 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
32621 expanded into a file name or a pipe delivery, which is usually inappropriate in
32622 a mailing list.
32623
32624 .oindex "&%errors_to%&"
32625 The &%errors_to%& option specifies that any delivery errors caused by addresses
32626 taken from a mailing list are to be sent to the given address rather than the
32627 original sender of the message. However, before acting on this, Exim verifies
32628 the error address, and ignores it if verification fails.
32629
32630 For example, using the configuration above, mail sent to
32631 &'dicts@lists.example'& is passed on to those addresses contained in
32632 &_/usr/lists/dicts_&, with error reports directed to
32633 &'dicts-request@lists.example'&, provided that this address can be verified.
32634 There could be a file called &_/usr/lists/dicts-request_& containing
32635 the address(es) of this particular list's manager(s), but other approaches,
32636 such as setting up an earlier router (possibly using the &%local_part_prefix%&
32637 or &%local_part_suffix%& options) to handle addresses of the form
32638 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
32639
32640
32641
32642 .section "Syntax errors in mailing lists" "SECID241"
32643 .cindex "mailing lists" "syntax errors in"
32644 If an entry in redirection data contains a syntax error, Exim normally defers
32645 delivery of the original address. That means that a syntax error in a mailing
32646 list holds up all deliveries to the list. This may not be appropriate when a
32647 list is being maintained automatically from data supplied by users, and the
32648 addresses are not rigorously checked.
32649
32650 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
32651 entries that fail to parse, noting the incident in the log. If in addition
32652 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
32653 whenever a broken address is skipped. It is usually appropriate to set
32654 &%syntax_errors_to%& to the same address as &%errors_to%&.
32655
32656
32657
32658 .section "Re-expansion of mailing lists" "SECID242"
32659 .cindex "mailing lists" "re-expansion of"
32660 Exim remembers every individual address to which a message has been delivered,
32661 in order to avoid duplication, but it normally stores only the original
32662 recipient addresses with a message. If all the deliveries to a mailing list
32663 cannot be done at the first attempt, the mailing list is re-expanded when the
32664 delivery is next tried. This means that alterations to the list are taken into
32665 account at each delivery attempt, so addresses that have been added to
32666 the list since the message arrived will therefore receive a copy of the
32667 message, even though it pre-dates their subscription.
32668
32669 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
32670 on the &(redirect)& router. If this is done, any addresses generated by the
32671 router that fail to deliver at the first attempt are added to the message as
32672 &"top level"& addresses, and the parent address that generated them is marked
32673 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
32674 subsequent delivery attempts. The disadvantage of this is that if any of the
32675 failing addresses are incorrect, correcting them in the file has no effect on
32676 pre-existing messages.
32677
32678 The original top-level address is remembered with each of the generated
32679 addresses, and is output in any log messages. However, any intermediate parent
32680 addresses are not recorded. This makes a difference to the log only if the
32681 &%all_parents%& selector is set, but for mailing lists there is normally only
32682 one level of expansion anyway.
32683
32684
32685
32686 .section "Closed mailing lists" "SECID243"
32687 .cindex "mailing lists" "closed"
32688 The examples so far have assumed open mailing lists, to which anybody may
32689 send mail. It is also possible to set up closed lists, where mail is accepted
32690 from specified senders only. This is done by making use of the generic
32691 &%senders%& option to restrict the router that handles the list.
32692
32693 The following example uses the same file as a list of recipients and as a list
32694 of permitted senders. It requires three routers:
32695 .code
32696 lists_request:
32697   driver = redirect
32698   domains = lists.example
32699   local_part_suffix = -request
32700   file = /usr/lists/$local_part$local_part_suffix
32701   no_more
32702
32703 lists_post:
32704   driver = redirect
32705   domains = lists.example
32706   senders = ${if exists {/usr/lists/$local_part}\
32707              {lsearch;/usr/lists/$local_part}{*}}
32708   file = /usr/lists/$local_part
32709   forbid_pipe
32710   forbid_file
32711   errors_to = $local_part-request@lists.example
32712   no_more
32713
32714 lists_closed:
32715   driver = redirect
32716   domains = lists.example
32717   allow_fail
32718   data = :fail: $local_part@lists.example is a closed mailing list
32719 .endd
32720 All three routers have the same &%domains%& setting, so for any other domains,
32721 they are all skipped. The first router runs only if the local part ends in
32722 &%-request%&. It handles messages to the list manager(s) by means of an open
32723 mailing list.
32724
32725 The second router runs only if the &%senders%& precondition is satisfied. It
32726 checks for the existence of a list that corresponds to the local part, and then
32727 checks that the sender is on the list by means of a linear search. It is
32728 necessary to check for the existence of the file before trying to search it,
32729 because otherwise Exim thinks there is a configuration error. If the file does
32730 not exist, the expansion of &%senders%& is *, which matches all senders. This
32731 means that the router runs, but because there is no list, declines, and
32732 &%no_more%& ensures that no further routers are run. The address fails with an
32733 &"unrouteable address"& error.
32734
32735 The third router runs only if the second router is skipped, which happens when
32736 a mailing list exists, but the sender is not on it. This router forcibly fails
32737 the address, giving a suitable error message.
32738
32739
32740
32741
32742 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
32743 .cindex "VERP"
32744 .cindex "Variable Envelope Return Paths"
32745 .cindex "envelope sender"
32746 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
32747 are a way of helping mailing list administrators discover which subscription
32748 address is the cause of a particular delivery failure. The idea is to encode
32749 the original recipient address in the outgoing envelope sender address, so that
32750 if the message is forwarded by another host and then subsequently bounces, the
32751 original recipient can be extracted from the recipient address of the bounce.
32752
32753 .oindex &%errors_to%&
32754 .oindex &%return_path%&
32755 Envelope sender addresses can be modified by Exim using two different
32756 facilities: the &%errors_to%& option on a router (as shown in previous mailing
32757 list examples), or the &%return_path%& option on a transport. The second of
32758 these is effective only if the message is successfully delivered to another
32759 host; it is not used for errors detected on the local host (see the description
32760 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
32761 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
32762 .code
32763 verp_smtp:
32764   driver = smtp
32765   max_rcpt = 1
32766   return_path = \
32767     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32768       {$1-request+$local_part=$domain@your.dom.example}fail}
32769 .endd
32770 This has the effect of rewriting the return path (envelope sender) on outgoing
32771 SMTP messages, if the local part of the original return path ends in
32772 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
32773 local part and domain of the recipient into the return path. Suppose, for
32774 example, that a message whose return path has been set to
32775 &'somelist-request@your.dom.example'& is sent to
32776 &'subscriber@other.dom.example'&. In the transport, the return path is
32777 rewritten as
32778 .code
32779 somelist-request+subscriber=other.dom.example@your.dom.example
32780 .endd
32781 .vindex "&$local_part$&"
32782 For this to work, you must tell Exim to send multiple copies of messages that
32783 have more than one recipient, so that each copy has just one recipient. This is
32784 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
32785 might be sent to several different recipients in the same domain, in which case
32786 &$local_part$& is not available in the transport, because it is not unique.
32787
32788 Unless your host is doing nothing but mailing list deliveries, you should
32789 probably use a separate transport for the VERP deliveries, so as not to use
32790 extra resources in making one-per-recipient copies for other deliveries. This
32791 can easily be done by expanding the &%transport%& option in the router:
32792 .code
32793 dnslookup:
32794   driver = dnslookup
32795   domains = ! +local_domains
32796   transport = \
32797     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32798       {verp_smtp}{remote_smtp}}
32799   no_more
32800 .endd
32801 If you want to change the return path using &%errors_to%& in a router instead
32802 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
32803 routers that handle mailing list addresses. This will ensure that all delivery
32804 errors, including those detected on the local host, are sent to the VERP
32805 address.
32806
32807 On a host that does no local deliveries and has no manual routing, only the
32808 &(dnslookup)& router needs to be changed. A special transport is not needed for
32809 SMTP deliveries. Every mailing list recipient has its own return path value,
32810 and so Exim must hand them to the transport one at a time. Here is an example
32811 of a &(dnslookup)& router that implements VERP:
32812 .code
32813 verp_dnslookup:
32814   driver = dnslookup
32815   domains = ! +local_domains
32816   transport = remote_smtp
32817   errors_to = \
32818     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
32819      {$1-request+$local_part=$domain@your.dom.example}fail}
32820   no_more
32821 .endd
32822 Before you start sending out messages with VERPed return paths, you must also
32823 configure Exim to accept the bounce messages that come back to those paths.
32824 Typically this is done by setting a &%local_part_suffix%& option for a
32825 router, and using this to route the messages to wherever you want to handle
32826 them.
32827
32828 The overhead incurred in using VERP depends very much on the size of the
32829 message, the number of recipient addresses that resolve to the same remote
32830 host, and the speed of the connection over which the message is being sent. If
32831 a lot of addresses resolve to the same host and the connection is slow, sending
32832 a separate copy of the message for each address may take substantially longer
32833 than sending a single copy with many recipients (for which VERP cannot be
32834 used).
32835
32836
32837
32838
32839
32840
32841 .section "Virtual domains" "SECTvirtualdomains"
32842 .cindex "virtual domains"
32843 .cindex "domain" "virtual"
32844 The phrase &'virtual domain'& is unfortunately used with two rather different
32845 meanings:
32846
32847 .ilist
32848 A domain for which there are no real mailboxes; all valid local parts are
32849 aliases for other email addresses. Common examples are organizational
32850 top-level domains and &"vanity"& domains.
32851 .next
32852 One of a number of independent domains that are all handled by the same host,
32853 with mailboxes on that host, but where the mailbox owners do not necessarily
32854 have login accounts on that host.
32855 .endlist
32856
32857 The first usage is probably more common, and does seem more &"virtual"& than
32858 the second. This kind of domain can be handled in Exim with a straightforward
32859 aliasing router. One approach is to create a separate alias file for each
32860 virtual domain. Exim can test for the existence of the alias file to determine
32861 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
32862 to a router of this form:
32863 .code
32864 virtual:
32865   driver = redirect
32866   domains = dsearch;/etc/mail/virtual
32867   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
32868   no_more
32869 .endd
32870 The &%domains%& option specifies that the router is to be skipped, unless there
32871 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
32872 domain that is being processed. When the router runs, it looks up the local
32873 part in the file to find a new address (or list of addresses). The &%no_more%&
32874 setting ensures that if the lookup fails (leading to &%data%& being an empty
32875 string), Exim gives up on the address without trying any subsequent routers.
32876
32877 This one router can handle all the virtual domains because the alias file names
32878 follow a fixed pattern. Permissions can be arranged so that appropriate people
32879 can edit the different alias files. A successful aliasing operation results in
32880 a new envelope recipient address, which is then routed from scratch.
32881
32882 The other kind of &"virtual"& domain can also be handled in a straightforward
32883 way. One approach is to create a file for each domain containing a list of
32884 valid local parts, and use it in a router like this:
32885 .code
32886 my_domains:
32887   driver = accept
32888   domains = dsearch;/etc/mail/domains
32889   local_parts = lsearch;/etc/mail/domains/$domain
32890   transport = my_mailboxes
32891 .endd
32892 The address is accepted if there is a file for the domain, and the local part
32893 can be found in the file. The &%domains%& option is used to check for the
32894 file's existence because &%domains%& is tested before the &%local_parts%&
32895 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
32896 because that option is tested after &%local_parts%&. The transport is as
32897 follows:
32898 .code
32899 my_mailboxes:
32900   driver = appendfile
32901   file = /var/mail/$domain/$local_part
32902   user = mail
32903 .endd
32904 This uses a directory of mailboxes for each domain. The &%user%& setting is
32905 required, to specify which uid is to be used for writing to the mailboxes.
32906
32907 The configuration shown here is just one example of how you might support this
32908 requirement. There are many other ways this kind of configuration can be set
32909 up, for example, by using a database instead of separate files to hold all the
32910 information about the domains.
32911
32912
32913
32914 .section "Multiple user mailboxes" "SECTmulbox"
32915 .cindex "multiple mailboxes"
32916 .cindex "mailbox" "multiple"
32917 .cindex "local part" "prefix"
32918 .cindex "local part" "suffix"
32919 Heavy email users often want to operate with multiple mailboxes, into which
32920 incoming mail is automatically sorted. A popular way of handling this is to
32921 allow users to use multiple sender addresses, so that replies can easily be
32922 identified. Users are permitted to add prefixes or suffixes to their local
32923 parts for this purpose. The wildcard facility of the generic router options
32924 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
32925 example, consider this router:
32926 .code
32927 userforward:
32928   driver = redirect
32929   check_local_user
32930   file = $home/.forward
32931   local_part_suffix = -*
32932   local_part_suffix_optional
32933   allow_filter
32934 .endd
32935 .vindex "&$local_part_suffix$&"
32936 It runs a user's &_.forward_& file for all local parts of the form
32937 &'username-*'&. Within the filter file the user can distinguish different
32938 cases by testing the variable &$local_part_suffix$&. For example:
32939 .code
32940 if $local_part_suffix contains -special then
32941 save /home/$local_part/Mail/special
32942 endif
32943 .endd
32944 If the filter file does not exist, or does not deal with such addresses, they
32945 fall through to subsequent routers, and, assuming no subsequent use of the
32946 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
32947 control over which suffixes are valid.
32948
32949 Alternatively, a suffix can be used to trigger the use of a different
32950 &_.forward_& file &-- which is the way a similar facility is implemented in
32951 another MTA:
32952 .code
32953 userforward:
32954   driver = redirect
32955   check_local_user
32956   file = $home/.forward$local_part_suffix
32957   local_part_suffix = -*
32958   local_part_suffix_optional
32959   allow_filter
32960 .endd
32961 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
32962 example, &_.forward-special_& is used. Once again, if the appropriate file
32963 does not exist, or does not deal with the address, it is passed on to
32964 subsequent routers, which could, if required, look for an unqualified
32965 &_.forward_& file to use as a default.
32966
32967
32968
32969 .section "Simplified vacation processing" "SECID244"
32970 .cindex "vacation processing"
32971 The traditional way of running the &'vacation'& program is for a user to set up
32972 a pipe command in a &_.forward_& file
32973 (see section &<<SECTspecitredli>>& for syntax details).
32974 This is prone to error by inexperienced users. There are two features of Exim
32975 that can be used to make this process simpler for users:
32976
32977 .ilist
32978 A local part prefix such as &"vacation-"& can be specified on a router which
32979 can cause the message to be delivered directly to the &'vacation'& program, or
32980 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
32981 &_.forward_& file are then much simpler. For example:
32982 .code
32983 spqr, vacation-spqr
32984 .endd
32985 .next
32986 The &%require_files%& generic router option can be used to trigger a
32987 vacation delivery by checking for the existence of a certain file in the
32988 user's home directory. The &%unseen%& generic option should also be used, to
32989 ensure that the original delivery also proceeds. In this case, all the user has
32990 to do is to create a file called, say, &_.vacation_&, containing a vacation
32991 message.
32992 .endlist
32993
32994 Another advantage of both these methods is that they both work even when the
32995 use of arbitrary pipes by users is locked out.
32996
32997
32998
32999 .section "Taking copies of mail" "SECID245"
33000 .cindex "message" "copying every"
33001 Some installations have policies that require archive copies of all messages to
33002 be made. A single copy of each message can easily be taken by an appropriate
33003 command in a system filter, which could, for example, use a different file for
33004 each day's messages.
33005
33006 There is also a shadow transport mechanism that can be used to take copies of
33007 messages that are successfully delivered by local transports, one copy per
33008 delivery. This could be used, &'inter alia'&, to implement automatic
33009 notification of delivery by sites that insist on doing such things.
33010
33011
33012
33013 .section "Intermittently connected hosts" "SECID246"
33014 .cindex "intermittently connected hosts"
33015 It has become quite common (because it is cheaper) for hosts to connect to the
33016 Internet periodically rather than remain connected all the time. The normal
33017 arrangement is that mail for such hosts accumulates on a system that is
33018 permanently connected.
33019
33020 Exim was designed for use on permanently connected hosts, and so it is not
33021 particularly well-suited to use in an intermittently connected environment.
33022 Nevertheless there are some features that can be used.
33023
33024
33025 .section "Exim on the upstream server host" "SECID247"
33026 It is tempting to arrange for incoming mail for the intermittently connected
33027 host to remain on Exim's queue until the client connects. However, this
33028 approach does not scale very well. Two different kinds of waiting message are
33029 being mixed up in the same queue &-- those that cannot be delivered because of
33030 some temporary problem, and those that are waiting for their destination host
33031 to connect. This makes it hard to manage the queue, as well as wasting
33032 resources, because each queue runner scans the entire queue.
33033
33034 A better approach is to separate off those messages that are waiting for an
33035 intermittently connected host. This can be done by delivering these messages
33036 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
33037 format, from where they are transmitted by other software when their
33038 destination connects. This makes it easy to collect all the mail for one host
33039 in a single directory, and to apply local timeout rules on a per-message basis
33040 if required.
33041
33042 On a very small scale, leaving the mail on Exim's queue can be made to work. If
33043 you are doing this, you should configure Exim with a long retry period for the
33044 intermittent host. For example:
33045 .code
33046 cheshire.wonderland.fict.example    *   F,5d,24h
33047 .endd
33048 This stops a lot of failed delivery attempts from occurring, but Exim remembers
33049 which messages it has queued up for that host. Once the intermittent host comes
33050 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
33051 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
33052 causes all the queued up messages to be delivered, often down a single SMTP
33053 connection. While the host remains connected, any new messages get delivered
33054 immediately.
33055
33056 If the connecting hosts do not have fixed IP addresses, that is, if a host is
33057 issued with a different IP address each time it connects, Exim's retry
33058 mechanisms on the holding host get confused, because the IP address is normally
33059 used as part of the key string for holding retry information. This can be
33060 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
33061 Since this has disadvantages for permanently connected hosts, it is best to
33062 arrange a separate transport for the intermittently connected ones.
33063
33064
33065
33066 .section "Exim on the intermittently connected client host" "SECID248"
33067 The value of &%smtp_accept_queue_per_connection%& should probably be
33068 increased, or even set to zero (that is, disabled) on the intermittently
33069 connected host, so that all incoming messages down a single connection get
33070 delivered immediately.
33071
33072 .cindex "SMTP" "passed connection"
33073 .cindex "SMTP" "multiple deliveries"
33074 .cindex "multiple SMTP deliveries"
33075 Mail waiting to be sent from an intermittently connected host will probably
33076 not have been routed, because without a connection DNS lookups are not
33077 possible. This means that if a normal queue run is done at connection time,
33078 each message is likely to be sent in a separate SMTP session. This can be
33079 avoided by starting the queue run with a command line option beginning with
33080 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
33081 first pass, routing is done but no deliveries take place. The second pass is a
33082 normal queue run; since all the messages have been previously routed, those
33083 destined for the same host are likely to get sent as multiple deliveries in a
33084 single SMTP connection.
33085
33086
33087
33088 . ////////////////////////////////////////////////////////////////////////////
33089 . ////////////////////////////////////////////////////////////////////////////
33090
33091 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
33092          "Exim as a non-queueing client"
33093 .cindex "client, non-queueing"
33094 .cindex "smart host" "suppressing queueing"
33095 On a personal computer, it is a common requirement for all
33096 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
33097 configured to operate that way, for all the popular operating systems.
33098 However, there are some MUAs for Unix-like systems that cannot be so
33099 configured: they submit messages using the command line interface of
33100 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
33101 messages this way.
33102
33103 If the personal computer runs continuously, there is no problem, because it can
33104 run a conventional MTA that handles delivery to the smart host, and deal with
33105 any delays via its queueing mechanism. However, if the computer does not run
33106 continuously or runs different operating systems at different times, queueing
33107 email is not desirable.
33108
33109 There is therefore a requirement for something that can provide the
33110 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
33111 any queueing or retrying facilities. Furthermore, the delivery to the smart
33112 host should be synchronous, so that if it fails, the sending MUA is immediately
33113 informed. In other words, we want something that extends an MUA that submits
33114 to a local MTA via the command line so that it behaves like one that submits
33115 to a remote smart host using TCP/SMTP.
33116
33117 There are a number of applications (for example, there is one called &'ssmtp'&)
33118 that do this job. However, people have found them to be lacking in various
33119 ways. For instance, you might want to allow aliasing and forwarding to be done
33120 before sending a message to the smart host.
33121
33122 Exim already had the necessary infrastructure for doing this job. Just a few
33123 tweaks were needed to make it behave as required, though it is somewhat of an
33124 overkill to use a fully-featured MTA for this purpose.
33125
33126 .oindex "&%mua_wrapper%&"
33127 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
33128 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
33129 assumes that it is being used to &"wrap"& a command-line MUA in the manner
33130 just described. As well as setting &%mua_wrapper%&, you also need to provide a
33131 compatible router and transport configuration. Typically there will be just one
33132 router and one transport, sending everything to a smart host.
33133
33134 When run in MUA wrapping mode, the behaviour of Exim changes in the
33135 following ways:
33136
33137 .ilist
33138 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
33139 In other words, the only way to submit messages is via the command line.
33140 .next
33141 Each message is synchronously delivered as soon as it is received (&%-odi%& is
33142 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
33143 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
33144 does not finish until the delivery attempt is complete. If the delivery is
33145 successful, a zero return code is given.
33146 .next
33147 Address redirection is permitted, but the final routing for all addresses must
33148 be to the same remote transport, and to the same list of hosts. Furthermore,
33149 the return address (envelope sender) must be the same for all recipients, as
33150 must any added or deleted header lines. In other words, it must be possible to
33151 deliver the message in a single SMTP transaction, however many recipients there
33152 are.
33153 .next
33154 If these conditions are not met, or if routing any address results in a
33155 failure or defer status, or if Exim is unable to deliver all the recipients
33156 successfully to one of the smart hosts, delivery of the entire message fails.
33157 .next
33158 Because no queueing is allowed, all failures are treated as permanent; there
33159 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
33160 smart host. Furthermore, because only a single yes/no response can be given to
33161 the caller, it is not possible to deliver to some recipients and not others. If
33162 there is an error (temporary or permanent) for any recipient, all are failed.
33163 .next
33164 If more than one smart host is listed, Exim will try another host after a
33165 connection failure or a timeout, in the normal way. However, if this kind of
33166 failure happens for all the hosts, the delivery fails.
33167 .next
33168 When delivery fails, an error message is written to the standard error stream
33169 (as well as to Exim's log), and Exim exits to the caller with a return code
33170 value 1. The message is expunged from Exim's spool files. No bounce messages
33171 are ever generated.
33172 .next
33173 No retry data is maintained, and any retry rules are ignored.
33174 .next
33175 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
33176 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
33177 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
33178 .endlist
33179
33180 The overall effect is that Exim makes a single synchronous attempt to deliver
33181 the message, failing if there is any kind of problem. Because no local
33182 deliveries are done and no daemon can be run, Exim does not need root
33183 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
33184 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
33185 the advantages and disadvantages of running without root privilege.
33186
33187
33188
33189
33190 . ////////////////////////////////////////////////////////////////////////////
33191 . ////////////////////////////////////////////////////////////////////////////
33192
33193 .chapter "Log files" "CHAPlog"
33194 .scindex IIDloggen "log" "general description"
33195 .cindex "log" "types of"
33196 Exim writes three different logs, referred to as the main log, the reject log,
33197 and the panic log:
33198
33199 .ilist
33200 .cindex "main log"
33201 The main log records the arrival of each message and each delivery in a single
33202 line in each case. The format is as compact as possible, in an attempt to keep
33203 down the size of log files. Two-character flag sequences make it easy to pick
33204 out these lines. A number of other events are recorded in the main log. Some of
33205 them are optional, in which case the &%log_selector%& option controls whether
33206 they are included or not. A Perl script called &'eximstats'&, which does simple
33207 analysis of main log files, is provided in the Exim distribution (see section
33208 &<<SECTmailstat>>&).
33209 .next
33210 .cindex "reject log"
33211 The reject log records information from messages that are rejected as a result
33212 of a configuration option (that is, for policy reasons).
33213 The first line of each rejection is a copy of the line that is also written to
33214 the main log. Then, if the message's header has been read at the time the log
33215 is written, its contents are written to this log. Only the original header
33216 lines are available; header lines added by ACLs are not logged. You can use the
33217 reject log to check that your policy controls are working correctly; on a busy
33218 host this may be easier than scanning the main log for rejection messages. You
33219 can suppress the writing of the reject log by setting &%write_rejectlog%&
33220 false.
33221 .next
33222 .cindex "panic log"
33223 .cindex "system log"
33224 When certain serious errors occur, Exim writes entries to its panic log. If the
33225 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
33226 are usually written to the main log as well, but can get lost amid the mass of
33227 other entries. The panic log should be empty under normal circumstances. It is
33228 therefore a good idea to check it (or to have a &'cron'& script check it)
33229 regularly, in order to become aware of any problems. When Exim cannot open its
33230 panic log, it tries as a last resort to write to the system log (syslog). This
33231 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
33232 message itself is written at priority LOG_CRIT.
33233 .endlist
33234
33235 Every log line starts with a timestamp, in the format shown in the following
33236 example. Note that many of the examples shown in this chapter are line-wrapped.
33237 In the log file, this would be all on one line:
33238 .code
33239 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
33240   by QUIT
33241 .endd
33242 By default, the timestamps are in the local timezone. There are two
33243 ways of changing this:
33244
33245 .ilist
33246 You can set the &%timezone%& option to a different time zone; in particular, if
33247 you set
33248 .code
33249 timezone = UTC
33250 .endd
33251 the timestamps will be in UTC (aka GMT).
33252 .next
33253 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
33254 example:
33255 .code
33256 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
33257 .endd
33258 .endlist
33259
33260 .cindex "log" "process ids in"
33261 .cindex "pid (process id)" "in log lines"
33262 Exim does not include its process id in log lines by default, but you can
33263 request that it does so by specifying the &`pid`& log selector (see section
33264 &<<SECTlogselector>>&). When this is set, the process id is output, in square
33265 brackets, immediately after the time and date.
33266
33267
33268
33269
33270 .section "Where the logs are written" "SECTwhelogwri"
33271 .cindex "log" "destination"
33272 .cindex "log" "to file"
33273 .cindex "log" "to syslog"
33274 .cindex "syslog"
33275 The logs may be written to local files, or to syslog, or both. However, it
33276 should be noted that many syslog implementations use UDP as a transport, and
33277 are therefore unreliable in the sense that messages are not guaranteed to
33278 arrive at the loghost, nor is the ordering of messages necessarily maintained.
33279 It has also been reported that on large log files (tens of megabytes) you may
33280 need to tweak syslog to prevent it syncing the file with each write &-- on
33281 Linux this has been seen to make syslog take 90% plus of CPU time.
33282
33283 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
33284 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
33285 configuration. This latter string is expanded, so it can contain, for example,
33286 references to the host name:
33287 .code
33288 log_file_path = /var/log/$primary_hostname/exim_%slog
33289 .endd
33290 It is generally advisable, however, to set the string in &_Local/Makefile_&
33291 rather than at run time, because then the setting is available right from the
33292 start of Exim's execution. Otherwise, if there's something it wants to log
33293 before it has read the configuration file (for example, an error in the
33294 configuration file) it will not use the path you want, and may not be able to
33295 log at all.
33296
33297 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
33298 list, currently limited to at most two items. This is one option where the
33299 facility for changing a list separator may not be used. The list must always be
33300 colon-separated. If an item in the list is &"syslog"& then syslog is used;
33301 otherwise the item must either be an absolute path, containing &`%s`& at the
33302 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
33303 implying the use of a default path.
33304
33305 When Exim encounters an empty item in the list, it searches the list defined by
33306 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
33307 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
33308 mean &"use the path specified at build time"&. It no such item exists, log
33309 files are written in the &_log_& subdirectory of the spool directory. This is
33310 equivalent to the setting:
33311 .code
33312 log_file_path = $spool_directory/log/%slog
33313 .endd
33314 If you do not specify anything at build time or run time, that is where the
33315 logs are written.
33316
33317 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
33318 are in use &-- see section &<<SECTdatlogfil>>& below.
33319
33320 Here are some examples of possible settings:
33321 .display
33322 &`LOG_FILE_PATH=syslog                    `& syslog only
33323 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
33324 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
33325 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
33326 .endd
33327 If there are more than two paths in the list, the first is used and a panic
33328 error is logged.
33329
33330
33331
33332 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
33333 .cindex "log" "cycling local files"
33334 .cindex "cycling logs"
33335 .cindex "&'exicyclog'&"
33336 .cindex "log" "local files; writing to"
33337 Some operating systems provide centralized and standardized methods for cycling
33338 log files. For those that do not, a utility script called &'exicyclog'& is
33339 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
33340 main and reject logs each time it is called. The maximum number of old logs to
33341 keep can be set. It is suggested this script is run as a daily &'cron'& job.
33342
33343 An Exim delivery process opens the main log when it first needs to write to it,
33344 and it keeps the file open in case subsequent entries are required &-- for
33345 example, if a number of different deliveries are being done for the same
33346 message. However, remote SMTP deliveries can take a long time, and this means
33347 that the file may be kept open long after it is renamed if &'exicyclog'& or
33348 something similar is being used to rename log files on a regular basis. To
33349 ensure that a switch of log files is noticed as soon as possible, Exim calls
33350 &[stat()]& on the main log's name before reusing an open file, and if the file
33351 does not exist, or its inode has changed, the old file is closed and Exim
33352 tries to open the main log from scratch. Thus, an old log file may remain open
33353 for quite some time, but no Exim processes should write to it once it has been
33354 renamed.
33355
33356
33357
33358 .section "Datestamped log files" "SECTdatlogfil"
33359 .cindex "log" "datestamped files"
33360 Instead of cycling the main and reject log files by renaming them
33361 periodically, some sites like to use files whose names contain a datestamp,
33362 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
33363 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
33364 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
33365 point where the datestamp is required. For example:
33366 .code
33367 log_file_path = /var/spool/exim/log/%slog-%D
33368 log_file_path = /var/log/exim-%s-%D.log
33369 log_file_path = /var/spool/exim/log/%D-%slog
33370 log_file_path = /var/log/exim/%s.%M
33371 .endd
33372 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
33373 examples of names generated by the above examples:
33374 .code
33375 /var/spool/exim/log/mainlog-20021225
33376 /var/log/exim-reject-20021225.log
33377 /var/spool/exim/log/20021225-mainlog
33378 /var/log/exim/main.200212
33379 .endd
33380 When this form of log file is specified, Exim automatically switches to new
33381 files at midnight. It does not make any attempt to compress old logs; you
33382 will need to write your own script if you require this. You should not
33383 run &'exicyclog'& with this form of logging.
33384
33385 The location of the panic log is also determined by &%log_file_path%&, but it
33386 is not datestamped, because rotation of the panic log does not make sense.
33387 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
33388 the string. In addition, if it immediately follows a slash, a following
33389 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
33390 character is removed. Thus, the four examples above would give these panic
33391 log names:
33392 .code
33393 /var/spool/exim/log/paniclog
33394 /var/log/exim-panic.log
33395 /var/spool/exim/log/paniclog
33396 /var/log/exim/panic
33397 .endd
33398
33399
33400 .section "Logging to syslog" "SECID249"
33401 .cindex "log" "syslog; writing to"
33402 The use of syslog does not change what Exim logs or the format of its messages,
33403 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
33404 Exim's log lines are omitted when these lines are sent to syslog. Apart from
33405 that, the same strings are written to syslog as to log files. The syslog
33406 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
33407 by default, but you can change these by setting the &%syslog_facility%& and
33408 &%syslog_processname%& options, respectively. If Exim was compiled with
33409 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
33410 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
33411 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
33412 the time and host name to each line.
33413 The three log streams are mapped onto syslog priorities as follows:
33414
33415 .ilist
33416 &'mainlog'& is mapped to LOG_INFO
33417 .next
33418 &'rejectlog'& is mapped to LOG_NOTICE
33419 .next
33420 &'paniclog'& is mapped to LOG_ALERT
33421 .endlist
33422
33423 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
33424 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
33425 these are routed by syslog to the same place. You can suppress this duplication
33426 by setting &%syslog_duplication%& false.
33427
33428 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
33429 entries contain multiple lines when headers are included. To cope with both
33430 these cases, entries written to syslog are split into separate &[syslog()]&
33431 calls at each internal newline, and also after a maximum of
33432 870 data characters. (This allows for a total syslog line length of 1024, when
33433 additions such as timestamps are added.) If you are running a syslog
33434 replacement that can handle lines longer than the 1024 characters allowed by
33435 RFC 3164, you should set
33436 .code
33437 SYSLOG_LONG_LINES=yes
33438 .endd
33439 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
33440 lines, but it still splits at internal newlines in &'reject'& log entries.
33441
33442 To make it easy to re-assemble split lines later, each component of a split
33443 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
33444 where <&'n'&> is the component number and <&'m'&> is the total number of
33445 components in the entry. The / delimiter is used when the line was split
33446 because it was too long; if it was split because of an internal newline, the \
33447 delimiter is used. For example, supposing the length limit to be 50 instead of
33448 870, the following would be the result of a typical rejection message to
33449 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
33450 name, and pid as added by syslog:
33451 .code
33452 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
33453 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
33454 [3/5]  when scanning for sender: missing or malformed lo
33455 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
33456 [5/5] mple>)
33457 .endd
33458 The same error might cause the following lines to be written to &"rejectlog"&
33459 (LOG_NOTICE):
33460 .code
33461 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
33462 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
33463 [3/18] er when scanning for sender: missing or malformed
33464 [4/18]  local part in "<>" (envelope sender is <ph10@cam
33465 [5\18] .example>)
33466 [6\18] Recipients: ph10@some.domain.cam.example
33467 [7\18] P Received: from [127.0.0.1] (ident=ph10)
33468 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
33469 [9\18]        id 16RdAL-0006pc-00
33470 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
33471 [11\18] 09:43 +0100
33472 [12\18] F From: <>
33473 [13\18]   Subject: this is a test header
33474 [18\18]   X-something: this is another header
33475 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
33476 [16\18] le>
33477 [17\18] B Bcc:
33478 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
33479 .endd
33480 Log lines that are neither too long nor contain newlines are written to syslog
33481 without modification.
33482
33483 If only syslog is being used, the Exim monitor is unable to provide a log tail
33484 display, unless syslog is routing &'mainlog'& to a file on the local host and
33485 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
33486 where it is.
33487
33488
33489
33490 .section "Log line flags" "SECID250"
33491 One line is written to the main log for each message received, and for each
33492 successful, unsuccessful, and delayed delivery. These lines can readily be
33493 picked out by the distinctive two-character flags that immediately follow the
33494 timestamp. The flags are:
33495 .display
33496 &`<=`&     message arrival
33497 &`=>`&     normal message delivery
33498 &`->`&     additional address in same delivery
33499 &`*>`&     delivery suppressed by &%-N%&
33500 &`**`&     delivery failed; address bounced
33501 &`==`&     delivery deferred; temporary problem
33502 .endd
33503
33504
33505 .section "Logging message reception" "SECID251"
33506 .cindex "log" "reception line"
33507 The format of the single-line entry in the main log that is written for every
33508 message received is shown in the basic example below, which is split over
33509 several lines in order to fit it on the page:
33510 .code
33511 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
33512   H=mailer.fict.example [192.168.123.123] U=exim
33513   P=smtp S=5678 id=<incoming message id>
33514 .endd
33515 The address immediately following &"<="& is the envelope sender address. A
33516 bounce message is shown with the sender address &"<>"&, and if it is locally
33517 generated, this is followed by an item of the form
33518 .code
33519 R=<message id>
33520 .endd
33521 which is a reference to the message that caused the bounce to be sent.
33522
33523 .cindex "HELO"
33524 .cindex "EHLO"
33525 For messages from other hosts, the H and U fields identify the remote host and
33526 record the RFC 1413 identity of the user that sent the message, if one was
33527 received. The number given in square brackets is the IP address of the sending
33528 host. If there is a single, unparenthesized  host name in the H field, as
33529 above, it has been verified to correspond to the IP address (see the
33530 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
33531 by the remote host in the SMTP HELO or EHLO command, and has not been
33532 verified. If verification yields a different name to that given for HELO or
33533 EHLO, the verified name appears first, followed by the HELO or EHLO
33534 name in parentheses.
33535
33536 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
33537 without brackets, in the HELO or EHLO command, leading to entries in
33538 the log containing text like these examples:
33539 .code
33540 H=(10.21.32.43) [192.168.8.34]
33541 H=([10.21.32.43]) [192.168.8.34]
33542 .endd
33543 This can be confusing. Only the final address in square brackets can be relied
33544 on.
33545
33546 For locally generated messages (that is, messages not received over TCP/IP),
33547 the H field is omitted, and the U field contains the login name of the caller
33548 of Exim.
33549
33550 .cindex "authentication" "logging"
33551 .cindex "AUTH" "logging"
33552 For all messages, the P field specifies the protocol used to receive the
33553 message. This is the value that is stored in &$received_protocol$&. In the case
33554 of incoming SMTP messages, the value indicates whether or not any SMTP
33555 extensions (ESMTP), encryption, or authentication were used. If the SMTP
33556 session was encrypted, there is an additional X field that records the cipher
33557 suite that was used.
33558
33559 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
33560 hosts that have authenticated themselves using the SMTP AUTH command. The first
33561 value is used when the SMTP connection was encrypted (&"secure"&). In this case
33562 there is an additional item A= followed by the name of the authenticator that
33563 was used. If an authenticated identification was set up by the authenticator's
33564 &%server_set_id%& option, this is logged too, separated by a colon from the
33565 authenticator name.
33566
33567 .cindex "size" "of message"
33568 The id field records the existing message id, if present. The size of the
33569 received message is given by the S field. When the message is delivered,
33570 headers may be removed or added, so that the size of delivered copies of the
33571 message may not correspond with this value (and indeed may be different to each
33572 other).
33573
33574 The &%log_selector%& option can be used to request the logging of additional
33575 data when a message is received. See section &<<SECTlogselector>>& below.
33576
33577
33578
33579 .section "Logging deliveries" "SECID252"
33580 .cindex "log" "delivery line"
33581 The format of the single-line entry in the main log that is written for every
33582 delivery is shown in one of the examples below, for local and remote
33583 deliveries, respectively. Each example has been split into two lines in order
33584 to fit it on the page:
33585 .code
33586 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
33587   <marv@hitch.fict.example> R=localuser T=local_delivery
33588 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
33589   monk@holistic.fict.example R=dnslookup T=remote_smtp
33590   H=holistic.fict.example [192.168.234.234]
33591 .endd
33592 For ordinary local deliveries, the original address is given in angle brackets
33593 after the final delivery address, which might be a pipe or a file. If
33594 intermediate address(es) exist between the original and the final address, the
33595 last of these is given in parentheses after the final address. The R and T
33596 fields record the router and transport that were used to process the address.
33597
33598 If a shadow transport was run after a successful local delivery, the log line
33599 for the successful delivery has an item added on the end, of the form
33600 .display
33601 &`ST=<`&&'shadow transport name'&&`>`&
33602 .endd
33603 If the shadow transport did not succeed, the error message is put in
33604 parentheses afterwards.
33605
33606 .cindex "asterisk" "after IP address"
33607 When more than one address is included in a single delivery (for example, two
33608 SMTP RCPT commands in one transaction) the second and subsequent addresses are
33609 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
33610 down a single SMTP connection, an asterisk follows the IP address in the log
33611 lines for the second and subsequent messages.
33612
33613 The generation of a reply message by a filter file gets logged as a
33614 &"delivery"& to the addressee, preceded by &">"&.
33615
33616 The &%log_selector%& option can be used to request the logging of additional
33617 data when a message is delivered. See section &<<SECTlogselector>>& below.
33618
33619
33620 .section "Discarded deliveries" "SECID253"
33621 .cindex "discarded messages"
33622 .cindex "message" "discarded"
33623 .cindex "delivery" "discarded; logging"
33624 When a message is discarded as a result of the command &"seen finish"& being
33625 obeyed in a filter file which generates no deliveries, a log entry of the form
33626 .code
33627 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
33628   <low.club@bridge.example> R=userforward
33629 .endd
33630 is written, to record why no deliveries are logged. When a message is discarded
33631 because it is aliased to &":blackhole:"& the log line is like this:
33632 .code
33633 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
33634   <hole@nowhere.example> R=blackhole_router
33635 .endd
33636
33637
33638 .section "Deferred deliveries" "SECID254"
33639 When a delivery is deferred, a line of the following form is logged:
33640 .code
33641 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
33642   R=dnslookup T=smtp defer (146): Connection refused
33643 .endd
33644 In the case of remote deliveries, the error is the one that was given for the
33645 last IP address that was tried. Details of individual SMTP failures are also
33646 written to the log, so the above line would be preceded by something like
33647 .code
33648 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
33649   mail1.endrest.example [192.168.239.239]: Connection refused
33650 .endd
33651 When a deferred address is skipped because its retry time has not been reached,
33652 a message is written to the log, but this can be suppressed by setting an
33653 appropriate value in &%log_selector%&.
33654
33655
33656
33657 .section "Delivery failures" "SECID255"
33658 .cindex "delivery" "failure; logging"
33659 If a delivery fails because an address cannot be routed, a line of the
33660 following form is logged:
33661 .code
33662 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
33663   <jim@trek99.example>: unknown mail domain
33664 .endd
33665 If a delivery fails at transport time, the router and transport are shown, and
33666 the response from the remote host is included, as in this example:
33667 .code
33668 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
33669   R=dnslookup T=remote_smtp: SMTP error from remote mailer
33670   after pipelined RCPT TO:<ace400@pb.example>: host
33671   pbmail3.py.example [192.168.63.111]: 553 5.3.0
33672   <ace400@pb.example>...Addressee unknown
33673 .endd
33674 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
33675 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
33676 disabling PIPELINING. The log lines for all forms of delivery failure are
33677 flagged with &`**`&.
33678
33679
33680
33681 .section "Fake deliveries" "SECID256"
33682 .cindex "delivery" "fake; logging"
33683 If a delivery does not actually take place because the &%-N%& option has been
33684 used to suppress it, a normal delivery line is written to the log, except that
33685 &"=>"& is replaced by &"*>"&.
33686
33687
33688
33689 .section "Completion" "SECID257"
33690 A line of the form
33691 .code
33692 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
33693 .endd
33694 is written to the main log when a message is about to be removed from the spool
33695 at the end of its processing.
33696
33697
33698
33699
33700 .section "Summary of Fields in Log Lines" "SECID258"
33701 .cindex "log" "summary of fields"
33702 A summary of the field identifiers that are used in log lines is shown in
33703 the following table:
33704 .display
33705 &`A   `&        authenticator name (and optional id)
33706 &`C   `&        SMTP confirmation on delivery
33707 &`    `&        command list for &"no mail in SMTP session"&
33708 &`CV  `&        certificate verification status
33709 &`D   `&        duration of &"no mail in SMTP session"&
33710 &`DN  `&        distinguished name from peer certificate
33711 &`DT  `&        on &`=>`& lines: time taken for a delivery
33712 &`F   `&        sender address (on delivery lines)
33713 &`H   `&        host name and IP address
33714 &`I   `&        local interface used
33715 &`id  `&        message id for incoming message
33716 &`P   `&        on &`<=`& lines: protocol used
33717 &`    `&        on &`=>`& and &`**`& lines: return path
33718 &`QT  `&        on &`=>`& lines: time spent on queue so far
33719 &`    `&        on &"Completed"& lines: time spent on queue
33720 &`R   `&        on &`<=`& lines: reference for local bounce
33721 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
33722 &`S   `&        size of message
33723 &`ST  `&        shadow transport name
33724 &`T   `&        on &`<=`& lines: message subject (topic)
33725 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
33726 &`U   `&        local user or RFC 1413 identity
33727 &`X   `&        TLS cipher suite
33728 .endd
33729
33730
33731 .section "Other log entries" "SECID259"
33732 Various other types of log entry are written from time to time. Most should be
33733 self-explanatory. Among the more common are:
33734
33735 .ilist
33736 .cindex "retry" "time not reached"
33737 &'retry time not reached'&&~&~An address previously suffered a temporary error
33738 during routing or local delivery, and the time to retry has not yet arrived.
33739 This message is not written to an individual message log file unless it happens
33740 during the first delivery attempt.
33741 .next
33742 &'retry time not reached for any host'&&~&~An address previously suffered
33743 temporary errors during remote delivery, and the retry time has not yet arrived
33744 for any of the hosts to which it is routed.
33745 .next
33746 .cindex "spool directory" "file locked"
33747 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
33748 some other Exim process is already working on the message. This can be quite
33749 common if queue running processes are started at frequent intervals. The
33750 &'exiwhat'& utility script can be used to find out what Exim processes are
33751 doing.
33752 .next
33753 .cindex "error" "ignored"
33754 &'error ignored'&&~&~There are several circumstances that give rise to this
33755 message:
33756 .olist
33757 Exim failed to deliver a bounce message whose age was greater than
33758 &%ignore_bounce_errors_after%&. The bounce was discarded.
33759 .next
33760 A filter file set up a delivery using the &"noerror"& option, and the delivery
33761 failed. The delivery was discarded.
33762 .next
33763 A delivery set up by a router configured with
33764 . ==== As this is a nested list, any displays it contains must be indented
33765 . ==== as otherwise they are too far to the left.
33766 .code
33767     errors_to = <>
33768 .endd
33769 failed. The delivery was discarded.
33770 .endlist olist
33771 .endlist ilist
33772
33773
33774
33775
33776
33777 .section "Reducing or increasing what is logged" "SECTlogselector"
33778 .cindex "log" "selectors"
33779 By setting the &%log_selector%& global option, you can disable some of Exim's
33780 default logging, or you can request additional logging. The value of
33781 &%log_selector%& is made up of names preceded by plus or minus characters. For
33782 example:
33783 .code
33784 log_selector = +arguments -retry_defer
33785 .endd
33786 The list of optional log items is in the following table, with the default
33787 selection marked by asterisks:
33788 .display
33789 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
33790 &` address_rewrite            `&  address rewriting
33791 &` all_parents                `&  all parents in => lines
33792 &` arguments                  `&  command line arguments
33793 &`*connection_reject          `&  connection rejections
33794 &`*delay_delivery             `&  immediate delivery delayed
33795 &` deliver_time               `&  time taken to perform delivery
33796 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
33797 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
33798 &`*etrn                       `&  ETRN commands
33799 &`*host_lookup_failed         `&  as it says
33800 &` ident_timeout              `&  timeout for ident connection
33801 &` incoming_interface         `&  incoming interface on <= lines
33802 &` incoming_port              `&  incoming port on <= lines
33803 &`*lost_incoming_connection   `&  as it says (includes timeouts)
33804 &` outgoing_port              `&  add remote port to => lines
33805 &`*queue_run                  `&  start and end queue runs
33806 &` queue_time                 `&  time on queue for one recipient
33807 &` queue_time_overall         `&  time on queue for whole message
33808 &` pid                        `&  Exim process id
33809 &` received_recipients        `&  recipients on <= lines
33810 &` received_sender            `&  sender on <= lines
33811 &`*rejected_header            `&  header contents on reject log
33812 &`*retry_defer                `&  &"retry time not reached"&
33813 &` return_path_on_delivery    `&  put return path on => and ** lines
33814 &` sender_on_delivery         `&  add sender to => lines
33815 &`*sender_verify_fail         `&  sender verification failures
33816 &`*size_reject                `&  rejection because too big
33817 &`*skip_delivery              `&  delivery skipped in a queue run
33818 &`*smtp_confirmation          `&  SMTP confirmation on => lines
33819 &` smtp_connection            `&  SMTP connections
33820 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
33821 &` smtp_no_mail               `&  session with no MAIL commands
33822 &` smtp_protocol_error        `&  SMTP protocol errors
33823 &` smtp_syntax_error          `&  SMTP syntax errors
33824 &` subject                    `&  contents of &'Subject:'& on <= lines
33825 &` tls_certificate_verified   `&  certificate verification status
33826 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
33827 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
33828 &` tls_sni                    `&  TLS SNI on <= lines
33829 &` unknown_in_list            `&  DNS lookup failed in list match
33830
33831 &` all                        `&  all of the above
33832 .endd
33833 More details on each of these items follows:
33834
33835 .ilist
33836 .cindex "&%warn%& ACL verb" "log when skipping"
33837 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
33838 its conditions cannot be evaluated, a log line to this effect is written if
33839 this log selector is set.
33840 .next
33841 .cindex "log" "rewriting"
33842 .cindex "rewriting" "logging"
33843 &%address_rewrite%&: This applies both to global rewrites and per-transport
33844 rewrites, but not to rewrites in filters run as an unprivileged user (because
33845 such users cannot access the log).
33846 .next
33847 .cindex "log" "full parentage"
33848 &%all_parents%&: Normally only the original and final addresses are logged on
33849 delivery lines; with this selector, intermediate parents are given in
33850 parentheses between them.
33851 .next
33852 .cindex "log" "Exim arguments"
33853 .cindex "Exim arguments, logging"
33854 &%arguments%&: This causes Exim to write the arguments with which it was called
33855 to the main log, preceded by the current working directory. This is a debugging
33856 feature, added to make it easier to find out how certain MUAs call
33857 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
33858 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
33859 that are empty or that contain white space are quoted. Non-printing characters
33860 are shown as escape sequences. This facility cannot log unrecognized arguments,
33861 because the arguments are checked before the configuration file is read. The
33862 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
33863 between the caller and Exim.
33864 .next
33865 .cindex "log" "connection rejections"
33866 &%connection_reject%&: A log entry is written whenever an incoming SMTP
33867 connection is rejected, for whatever reason.
33868 .next
33869 .cindex "log" "delayed delivery"
33870 .cindex "delayed delivery, logging"
33871 &%delay_delivery%&: A log entry is written whenever a delivery process is not
33872 started for an incoming message because the load is too high or too many
33873 messages were received on one connection. Logging does not occur if no delivery
33874 process is started because &%queue_only%& is set or &%-odq%& was used.
33875 .next
33876 .cindex "log" "delivery duration"
33877 &%deliver_time%&: For each delivery, the amount of real time it has taken to
33878 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
33879 .next
33880 .cindex "log" "message size on delivery"
33881 .cindex "size" "of message"
33882 &%delivery_size%&: For each delivery, the size of message delivered is added to
33883 the &"=>"& line, tagged with S=.
33884 .next
33885 .cindex "log" "dnslist defer"
33886 .cindex "DNS list" "logging defer"
33887 .cindex "black list (DNS)"
33888 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
33889 DNS black list suffers a temporary error.
33890 .next
33891 .cindex "log" "ETRN commands"
33892 .cindex "ETRN" "logging"
33893 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
33894 is run to determine whether or not it is actually accepted. An invalid ETRN
33895 command, or one received within a message transaction is not logged by this
33896 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
33897 .next
33898 .cindex "log" "host lookup failure"
33899 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
33900 any addresses, or when a lookup of an IP address fails to find a host name, a
33901 log line is written. This logging does not apply to direct DNS lookups when
33902 routing email addresses, but it does apply to &"byname"& lookups.
33903 .next
33904 .cindex "log" "ident timeout"
33905 .cindex "RFC 1413" "logging timeout"
33906 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
33907 client's ident port times out.
33908 .next
33909 .cindex "log" "incoming interface"
33910 .cindex "interface" "logging"
33911 &%incoming_interface%&: The interface on which a message was received is added
33912 to the &"<="& line as an IP address in square brackets, tagged by I= and
33913 followed by a colon and the port number. The local interface and port are also
33914 added to other SMTP log lines, for example &"SMTP connection from"&, and to
33915 rejection lines.
33916 .next
33917 .cindex "log" "incoming remote port"
33918 .cindex "port" "logging remote"
33919 .cindex "TCP/IP" "logging incoming remote port"
33920 .vindex "&$sender_fullhost$&"
33921 .vindex "&$sender_rcvhost$&"
33922 &%incoming_port%&: The remote port number from which a message was received is
33923 added to log entries and &'Received:'& header lines, following the IP address
33924 in square brackets, and separated from it by a colon. This is implemented by
33925 changing the value that is put in the &$sender_fullhost$& and
33926 &$sender_rcvhost$& variables. Recording the remote port number has become more
33927 important with the widening use of NAT (see RFC 2505).
33928 .next
33929 .cindex "log" "dropped connection"
33930 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
33931 connection is unexpectedly dropped.
33932 .next
33933 .cindex "log" "outgoing remote port"
33934 .cindex "port" "logging outgoint remote"
33935 .cindex "TCP/IP" "logging ougtoing remote port"
33936 &%outgoing_port%&: The remote port number is added to delivery log lines (those
33937 containing => tags) following the IP address. This option is not included in
33938 the default setting, because for most ordinary configurations, the remote port
33939 number is always 25 (the SMTP port).
33940 .next
33941 .cindex "log" "process ids in"
33942 .cindex "pid (process id)" "in log lines"
33943 &%pid%&: The current process id is added to every log line, in square brackets,
33944 immediately after the time and date.
33945 .next
33946 .cindex "log" "queue run"
33947 .cindex "queue runner" "logging"
33948 &%queue_run%&: The start and end of every queue run are logged.
33949 .next
33950 .cindex "log" "queue time"
33951 &%queue_time%&: The amount of time the message has been in the queue on the
33952 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
33953 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
33954 includes reception time as well as the delivery time for the current address.
33955 This means that it may be longer than the difference between the arrival and
33956 delivery log line times, because the arrival log line is not written until the
33957 message has been successfully received.
33958 .next
33959 &%queue_time_overall%&: The amount of time the message has been in the queue on
33960 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
33961 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
33962 message, so it includes reception time as well as the total delivery time.
33963 .next
33964 .cindex "log" "recipients"
33965 &%received_recipients%&: The recipients of a message are listed in the main log
33966 as soon as the message is received. The list appears at the end of the log line
33967 that is written when a message is received, preceded by the word &"for"&. The
33968 addresses are listed after they have been qualified, but before any rewriting
33969 has taken place.
33970 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
33971 in the list.
33972 .next
33973 .cindex "log" "sender reception"
33974 &%received_sender%&: The unrewritten original sender of a message is added to
33975 the end of the log line that records the message's arrival, after the word
33976 &"from"& (before the recipients if &%received_recipients%& is also set).
33977 .next
33978 .cindex "log" "header lines for rejection"
33979 &%rejected_header%&: If a message's header has been received at the time a
33980 rejection is written to the reject log, the complete header is added to the
33981 log. Header logging can be turned off individually for messages that are
33982 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
33983 .next
33984 .cindex "log" "retry defer"
33985 &%retry_defer%&: A log line is written if a delivery is deferred because a
33986 retry time has not yet been reached. However, this &"retry time not reached"&
33987 message is always omitted from individual message logs after the first delivery
33988 attempt.
33989 .next
33990 .cindex "log" "return path"
33991 &%return_path_on_delivery%&: The return path that is being transmitted with
33992 the message is included in delivery and bounce lines, using the tag P=.
33993 This is omitted if no delivery actually happens, for example, if routing fails,
33994 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
33995 .next
33996 .cindex "log" "sender on delivery"
33997 &%sender_on_delivery%&: The message's sender address is added to every delivery
33998 and bounce line, tagged by F= (for &"from"&).
33999 This is the original sender that was received with the message; it is not
34000 necessarily the same as the outgoing return path.
34001 .next
34002 .cindex "log" "sender verify failure"
34003 &%sender_verify_fail%&: If this selector is unset, the separate log line that
34004 gives details of a sender verification failure is not written. Log lines for
34005 the rejection of SMTP commands contain just &"sender verify failed"&, so some
34006 detail is lost.
34007 .next
34008 .cindex "log" "size rejection"
34009 &%size_reject%&: A log line is written whenever a message is rejected because
34010 it is too big.
34011 .next
34012 .cindex "log" "frozen messages; skipped"
34013 .cindex "frozen messages" "logging skipping"
34014 &%skip_delivery%&: A log line is written whenever a message is skipped during a
34015 queue run because it is frozen or because another process is already delivering
34016 it.
34017 .cindex "&""spool file is locked""&"
34018 The message that is written is &"spool file is locked"&.
34019 .next
34020 .cindex "log" "smtp confirmation"
34021 .cindex "SMTP" "logging confirmation"
34022 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
34023 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
34024 A number of MTAs (including Exim) return an identifying string in this
34025 response.
34026 .next
34027 .cindex "log" "SMTP connections"
34028 .cindex "SMTP" "logging connections"
34029 &%smtp_connection%&: A log line is written whenever an SMTP connection is
34030 established or closed, unless the connection is from a host that matches
34031 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
34032 only when the closure is unexpected.) This applies to connections from local
34033 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
34034 dropped in the middle of a message, a log line is always written, whether or
34035 not this selector is set, but otherwise nothing is written at the start and end
34036 of connections unless this selector is enabled.
34037
34038 For TCP/IP connections to an Exim daemon, the current number of connections is
34039 included in the log message for each new connection, but note that the count is
34040 reset if the daemon is restarted.
34041 Also, because connections are closed (and the closure is logged) in
34042 subprocesses, the count may not include connections that have been closed but
34043 whose termination the daemon has not yet noticed. Thus, while it is possible to
34044 match up the opening and closing of connections in the log, the value of the
34045 logged counts may not be entirely accurate.
34046 .next
34047 .cindex "log" "SMTP transaction; incomplete"
34048 .cindex "SMTP" "logging incomplete transactions"
34049 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
34050 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
34051 and the message sender plus any accepted recipients are included in the log
34052 line. This can provide evidence of dictionary attacks.
34053 .next
34054 .cindex "log" "non-MAIL SMTP sessions"
34055 .cindex "MAIL" "logging session without"
34056 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
34057 connection terminates without having issued a MAIL command. This includes both
34058 the case when the connection is dropped, and the case when QUIT is used. It
34059 does not include cases where the connection is rejected right at the start (by
34060 an ACL, or because there are too many connections, or whatever). These cases
34061 already have their own log lines.
34062
34063 The log line that is written contains the identity of the client in the usual
34064 way, followed by D= and a time, which records the duration of the connection.
34065 If the connection was authenticated, this fact is logged exactly as it is for
34066 an incoming message, with an A= item. If the connection was encrypted, CV=,
34067 DN=, and X= items may appear as they do for an incoming message, controlled by
34068 the same logging options.
34069
34070 Finally, if any SMTP commands were issued during the connection, a C= item
34071 is added to the line, listing the commands that were used. For example,
34072 .code
34073 C=EHLO,QUIT
34074 .endd
34075 shows that the client issued QUIT straight after EHLO. If there were fewer
34076 than 20 commands, they are all listed. If there were more than 20 commands,
34077 the last 20 are listed, preceded by &"..."&. However, with the default
34078 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
34079 have been aborted before 20 non-mail commands are processed.
34080 .next
34081 .cindex "log" "SMTP protocol error"
34082 .cindex "SMTP" "logging protocol error"
34083 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
34084 encountered. Exim does not have perfect detection of all protocol errors
34085 because of transmission delays and the use of pipelining. If PIPELINING has
34086 been advertised to a client, an Exim server assumes that the client will use
34087 it, and therefore it does not count &"expected"& errors (for example, RCPT
34088 received after rejecting MAIL) as protocol errors.
34089 .next
34090 .cindex "SMTP" "logging syntax errors"
34091 .cindex "SMTP" "syntax errors; logging"
34092 .cindex "SMTP" "unknown command; logging"
34093 .cindex "log" "unknown SMTP command"
34094 .cindex "log" "SMTP syntax error"
34095 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
34096 encountered. An unrecognized command is treated as a syntax error. For an
34097 external connection, the host identity is given; for an internal connection
34098 using &%-bs%& the sender identification (normally the calling user) is given.
34099 .next
34100 .cindex "log" "subject"
34101 .cindex "subject, logging"
34102 &%subject%&: The subject of the message is added to the arrival log line,
34103 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
34104 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
34105 specifies whether characters with values greater than 127 should be logged
34106 unchanged, or whether they should be rendered as escape sequences.
34107 .next
34108 .cindex "log" "certificate verification"
34109 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
34110 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
34111 verified, and &`CV=no`& if not.
34112 .next
34113 .cindex "log" "TLS cipher"
34114 .cindex "TLS" "logging cipher"
34115 &%tls_cipher%&: When a message is sent or received over an encrypted
34116 connection, the cipher suite used is added to the log line, preceded by X=.
34117 .next
34118 .cindex "log" "TLS peer DN"
34119 .cindex "TLS" "logging peer DN"
34120 &%tls_peerdn%&: When a message is sent or received over an encrypted
34121 connection, and a certificate is supplied by the remote host, the peer DN is
34122 added to the log line, preceded by DN=.
34123 .next
34124 .cindex "log" "TLS SNI"
34125 .cindex "TLS" "logging SNI"
34126 &%tls_sni%&: When a message is received over an encrypted connection, and
34127 the remote host provided the Server Name Indication extension, the SNI is
34128 added to the log line, preceded by SNI=.
34129 .next
34130 .cindex "log" "DNS failure in list"
34131 &%unknown_in_list%&: This setting causes a log entry to be written when the
34132 result of a list match is failure because a DNS lookup failed.
34133 .endlist
34134
34135
34136 .section "Message log" "SECID260"
34137 .cindex "message" "log file for"
34138 .cindex "log" "message log; description of"
34139 .cindex "&_msglog_& directory"
34140 .oindex "&%preserve_message_logs%&"
34141 In addition to the general log files, Exim writes a log file for each message
34142 that it handles. The names of these per-message logs are the message ids, and
34143 they are kept in the &_msglog_& sub-directory of the spool directory. Each
34144 message log contains copies of the log lines that apply to the message. This
34145 makes it easier to inspect the status of an individual message without having
34146 to search the main log. A message log is deleted when processing of the message
34147 is complete, unless &%preserve_message_logs%& is set, but this should be used
34148 only with great care because they can fill up your disk very quickly.
34149
34150 On a heavily loaded system, it may be desirable to disable the use of
34151 per-message logs, in order to reduce disk I/O. This can be done by setting the
34152 &%message_logs%& option false.
34153 .ecindex IIDloggen
34154
34155
34156
34157
34158 . ////////////////////////////////////////////////////////////////////////////
34159 . ////////////////////////////////////////////////////////////////////////////
34160
34161 .chapter "Exim utilities" "CHAPutils"
34162 .scindex IIDutils "utilities"
34163 A number of utility scripts and programs are supplied with Exim and are
34164 described in this chapter. There is also the Exim Monitor, which is covered in
34165 the next chapter. The utilities described here are:
34166
34167 .itable none 0 0 3  7* left  15* left  40* left
34168 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
34169   "list what Exim processes are doing"
34170 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
34171 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
34172 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
34173 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
34174                                                 various criteria"
34175 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
34176 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
34177   "extract statistics from the log"
34178 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
34179   "check address acceptance from given IP"
34180 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
34181 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
34182 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
34183 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
34184 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
34185 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
34186 .endtable
34187
34188 Another utility that might be of use to sites with many MTAs is Tom Kistner's
34189 &'exilog'&. It provides log visualizations across multiple Exim servers. See
34190 &url(http://duncanthrax.net/exilog/) for details.
34191
34192
34193
34194
34195 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
34196 .cindex "&'exiwhat'&"
34197 .cindex "process, querying"
34198 .cindex "SIGUSR1"
34199 On operating systems that can restart a system call after receiving a signal
34200 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
34201 a line describing what it is doing to the file &_exim-process.info_& in the
34202 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
34203 processes it can find, having first emptied the file. It then waits for one
34204 second to allow the Exim processes to react before displaying the results. In
34205 order to run &'exiwhat'& successfully you have to have sufficient privilege to
34206 send the signal to the Exim processes, so it is normally run as root.
34207
34208 &*Warning*&: This is not an efficient process. It is intended for occasional
34209 use by system administrators. It is not sensible, for example, to set up a
34210 script that sends SIGUSR1 signals to Exim processes at short intervals.
34211
34212
34213 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
34214 varies in different operating systems. Not only are different options used,
34215 but the format of the output is different. For this reason, there are some
34216 system configuration options that configure exactly how &'exiwhat'& works. If
34217 it doesn't seem to be working for you, check the following compile-time
34218 options:
34219 .display
34220 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
34221 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
34222 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
34223 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
34224 .endd
34225 An example of typical output from &'exiwhat'& is
34226 .code
34227 164 daemon: -q1h, listening on port 25
34228 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
34229 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
34230   [10.19.42.42] (editor@ref.example)
34231 10592 handling incoming call from [192.168.243.242]
34232 10628 accepting a local non-SMTP message
34233 .endd
34234 The first number in the output line is the process number. The third line has
34235 been split here, in order to fit it on the page.
34236
34237
34238
34239 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
34240 .cindex "&'exiqgrep'&"
34241 .cindex "queue" "grepping"
34242 This utility is a Perl script contributed by Matt Hubbard. It runs
34243 .code
34244 exim -bpu
34245 .endd
34246 to obtain a queue listing with undelivered recipients only, and then greps the
34247 output to select messages that match given criteria. The following selection
34248 options are available:
34249
34250 .vlist
34251 .vitem &*-f*&&~<&'regex'&>
34252 Match the sender address. The field that is tested is enclosed in angle
34253 brackets, so you can test for bounce messages with
34254 .code
34255 exiqgrep -f '^<>$'
34256 .endd
34257 .vitem &*-r*&&~<&'regex'&>
34258 Match a recipient address. The field that is tested is not enclosed in angle
34259 brackets.
34260
34261 .vitem &*-s*&&~<&'regex'&>
34262 Match against the size field.
34263
34264 .vitem &*-y*&&~<&'seconds'&>
34265 Match messages that are younger than the given time.
34266
34267 .vitem &*-o*&&~<&'seconds'&>
34268 Match messages that are older than the given time.
34269
34270 .vitem &*-z*&
34271 Match only frozen messages.
34272
34273 .vitem &*-x*&
34274 Match only non-frozen messages.
34275 .endlist
34276
34277 The following options control the format of the output:
34278
34279 .vlist
34280 .vitem &*-c*&
34281 Display only the count of matching messages.
34282
34283 .vitem &*-l*&
34284 Long format &-- display the full message information as output by Exim. This is
34285 the default.
34286
34287 .vitem &*-i*&
34288 Display message ids only.
34289
34290 .vitem &*-b*&
34291 Brief format &-- one line per message.
34292
34293 .vitem &*-R*&
34294 Display messages in reverse order.
34295 .endlist
34296
34297 There is one more option, &%-h%&, which outputs a list of options.
34298
34299
34300
34301 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
34302 .cindex "&'exiqsumm'&"
34303 .cindex "queue" "summary"
34304 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
34305 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
34306 running a command such as
34307 .code
34308 exim -bp | exiqsumm
34309 .endd
34310 The output consists of one line for each domain that has messages waiting for
34311 it, as in the following example:
34312 .code
34313 3   2322   74m   66m  msn.com.example
34314 .endd
34315 Each line lists the number of pending deliveries for a domain, their total
34316 volume, and the length of time that the oldest and the newest messages have
34317 been waiting. Note that the number of pending deliveries is greater than the
34318 number of messages when messages have more than one recipient.
34319
34320 A summary line is output at the end. By default the output is sorted on the
34321 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
34322 the output to be sorted by oldest message and by count of messages,
34323 respectively. There are also three options that split the messages for each
34324 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
34325 separates frozen messages, and &%-s%& separates messages according to their
34326 sender.
34327
34328 The output of &'exim -bp'& contains the original addresses in the message, so
34329 this also applies to the output from &'exiqsumm'&. No domains from addresses
34330 generated by aliasing or forwarding are included (unless the &%one_time%&
34331 option of the &(redirect)& router has been used to convert them into &"top
34332 level"& addresses).
34333
34334
34335
34336
34337 .section "Extracting specific information from the log (exigrep)" &&&
34338          "SECTextspeinf"
34339 .cindex "&'exigrep'&"
34340 .cindex "log" "extracts; grepping for"
34341 The &'exigrep'& utility is a Perl script that searches one or more main log
34342 files for entries that match a given pattern. When it finds a match, it
34343 extracts all the log entries for the relevant message, not just those that
34344 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
34345 given message, or all mail for a given user, or for a given host, for example.
34346 The input files can be in Exim log format or syslog format.
34347 If a matching log line is not associated with a specific message, it is
34348 included in &'exigrep'&'s output without any additional lines. The usage is:
34349 .display
34350 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
34351 .endd
34352 If no log file names are given on the command line, the standard input is read.
34353
34354 The &%-t%& argument specifies a number of seconds. It adds an additional
34355 condition for message selection. Messages that are complete are shown only if
34356 they spent more than <&'n'&> seconds on the queue.
34357
34358 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
34359 makes it case-sensitive. This may give a performance improvement when searching
34360 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
34361 option; with &%-I%& they do not. In both cases it is possible to change the
34362 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
34363
34364 The &%-l%& option means &"literal"&, that is, treat all characters in the
34365 pattern as standing for themselves. Otherwise the pattern must be a Perl
34366 regular expression.
34367
34368 The &%-v%& option inverts the matching condition. That is, a line is selected
34369 if it does &'not'& match the pattern.
34370
34371 If the location of a &'zcat'& command is known from the definition of
34372 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
34373 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
34374
34375
34376 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
34377 .cindex "&'exipick'&"
34378 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
34379 lists messages from the queue according to a variety of criteria. For details
34380 of &'exipick'&'s facilities, visit the web page at
34381 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
34382 the &%--help%& option.
34383
34384
34385 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
34386 .cindex "log" "cycling local files"
34387 .cindex "cycling logs"
34388 .cindex "&'exicyclog'&"
34389 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
34390 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
34391 you are using log files with datestamps in their names (see section
34392 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
34393 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
34394 There are two command line options for &'exicyclog'&:
34395 .ilist
34396 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
34397 default that is set when Exim is built. The default default is 10.
34398 .next
34399 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
34400 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
34401 overriding the script's default, which is to find the setting from Exim's
34402 configuration.
34403 .endlist
34404
34405 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
34406 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
34407 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
34408 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
34409 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
34410 logs are handled similarly.
34411
34412 If the limit is greater than 99, the script uses 3-digit numbers such as
34413 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
34414 to one that is greater, or &'vice versa'&, you will have to fix the names of
34415 any existing log files.
34416
34417 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
34418 the end are deleted. All files with numbers greater than 01 are compressed,
34419 using a compression command which is configured by the COMPRESS_COMMAND
34420 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
34421 root &%crontab%& entry of the form
34422 .code
34423 1 0 * * * su exim -c /usr/exim/bin/exicyclog
34424 .endd
34425 assuming you have used the name &"exim"& for the Exim user. You can run
34426 &'exicyclog'& as root if you wish, but there is no need.
34427
34428
34429
34430 .section "Mail statistics (eximstats)" "SECTmailstat"
34431 .cindex "statistics"
34432 .cindex "&'eximstats'&"
34433 A Perl script called &'eximstats'& is provided for extracting statistical
34434 information from log files. The output is either plain text, or HTML.
34435 Exim log files are also supported by the &'Lire'& system produced by the
34436 LogReport Foundation &url(http://www.logreport.org).
34437
34438 The &'eximstats'& script has been hacked about quite a bit over time. The
34439 latest version is the result of some extensive revision by Steve Campbell. A
34440 lot of information is given by default, but there are options for suppressing
34441 various parts of it. Following any options, the arguments to the script are a
34442 list of files, which should be main log files. For example:
34443 .code
34444 eximstats -nr /var/spool/exim/log/mainlog.01
34445 .endd
34446 By default, &'eximstats'& extracts information about the number and volume of
34447 messages received from or delivered to various hosts. The information is sorted
34448 both by message count and by volume, and the top fifty hosts in each category
34449 are listed on the standard output. Similar information, based on email
34450 addresses or domains instead of hosts can be requested by means of various
34451 options. For messages delivered and received locally, similar statistics are
34452 also produced per user.
34453
34454 The output also includes total counts and statistics about delivery errors, and
34455 histograms showing the number of messages received and deliveries made in each
34456 hour of the day. A delivery with more than one address in its envelope (for
34457 example, an SMTP transaction with more than one RCPT command) is counted
34458 as a single delivery by &'eximstats'&.
34459
34460 Though normally more deliveries than receipts are reported (as messages may
34461 have multiple recipients), it is possible for &'eximstats'& to report more
34462 messages received than delivered, even though the queue is empty at the start
34463 and end of the period in question. If an incoming message contains no valid
34464 recipients, no deliveries are recorded for it. A bounce message is handled as
34465 an entirely separate message.
34466
34467 &'eximstats'& always outputs a grand total summary giving the volume and number
34468 of messages received and deliveries made, and the number of hosts involved in
34469 each case. It also outputs the number of messages that were delayed (that is,
34470 not completely delivered at the first attempt), and the number that had at
34471 least one address that failed.
34472
34473 The remainder of the output is in sections that can be independently disabled
34474 or modified by various options. It consists of a summary of deliveries by
34475 transport, histograms of messages received and delivered per time interval
34476 (default per hour), information about the time messages spent on the queue,
34477 a list of relayed messages, lists of the top fifty sending hosts, local
34478 senders, destination hosts, and destination local users by count and by volume,
34479 and a list of delivery errors that occurred.
34480
34481 The relay information lists messages that were actually relayed, that is, they
34482 came from a remote host and were directly delivered to some other remote host,
34483 without being processed (for example, for aliasing or forwarding) locally.
34484
34485 There are quite a few options for &'eximstats'& to control exactly what it
34486 outputs. These are documented in the Perl script itself, and can be extracted
34487 by running the command &(perldoc)& on the script. For example:
34488 .code
34489 perldoc /usr/exim/bin/eximstats
34490 .endd
34491
34492 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
34493 .cindex "&'exim_checkaccess'&"
34494 .cindex "policy control" "checking access"
34495 .cindex "checking access"
34496 The &%-bh%& command line argument allows you to run a fake SMTP session with
34497 debugging output, in order to check what Exim is doing when it is applying
34498 policy controls to incoming SMTP mail. However, not everybody is sufficiently
34499 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
34500 sometimes you just want to answer the question &"Does this address have
34501 access?"& without bothering with any further details.
34502
34503 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
34504 two arguments, an IP address and an email address:
34505 .code
34506 exim_checkaccess 10.9.8.7 A.User@a.domain.example
34507 .endd
34508 The utility runs a call to Exim with the &%-bh%& option, to test whether the
34509 given email address would be accepted in a RCPT command in a TCP/IP
34510 connection from the host with the given IP address. The output of the utility
34511 is either the word &"accepted"&, or the SMTP error response, for example:
34512 .code
34513 Rejected:
34514 550 Relay not permitted
34515 .endd
34516 When running this test, the utility uses &`<>`& as the envelope sender address
34517 for the MAIL command, but you can change this by providing additional
34518 options. These are passed directly to the Exim command. For example, to specify
34519 that the test is to be run with the sender address &'himself@there.example'&
34520 you can use:
34521 .code
34522 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
34523                  -f himself@there.example
34524 .endd
34525 Note that these additional Exim command line items must be given after the two
34526 mandatory arguments.
34527
34528 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
34529 while running its checks. You can run checks that include callouts by using
34530 &%-bhc%&, but this is not yet available in a &"packaged"& form.
34531
34532
34533
34534 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
34535 .cindex "DBM" "building dbm files"
34536 .cindex "building DBM files"
34537 .cindex "&'exim_dbmbuild'&"
34538 .cindex "lower casing"
34539 .cindex "binary zero" "in lookup key"
34540 The &'exim_dbmbuild'& program reads an input file containing keys and data in
34541 the format used by the &(lsearch)& lookup (see section
34542 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
34543 names as keys and the remainder of the information as data. The lower-casing
34544 can be prevented by calling the program with the &%-nolc%& option.
34545
34546 A terminating zero is included as part of the key string. This is expected by
34547 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
34548 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
34549 strings or the data strings. The &(dbmnz)& lookup type can be used with such
34550 files.
34551
34552 The program requires two arguments: the name of the input file (which can be a
34553 single hyphen to indicate the standard input), and the name of the output file.
34554 It creates the output under a temporary name, and then renames it if all went
34555 well.
34556
34557 .cindex "USE_DB"
34558 If the native DB interface is in use (USE_DB is set in a compile-time
34559 configuration file &-- this is common in free versions of Unix) the two file
34560 names must be different, because in this mode the Berkeley DB functions create
34561 a single output file using exactly the name given. For example,
34562 .code
34563 exim_dbmbuild /etc/aliases /etc/aliases.db
34564 .endd
34565 reads the system alias file and creates a DBM version of it in
34566 &_/etc/aliases.db_&.
34567
34568 In systems that use the &'ndbm'& routines (mostly proprietary versions of
34569 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
34570 environment, the suffixes are added to the second argument of
34571 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
34572 when the Berkeley functions are used in compatibility mode (though this is not
34573 recommended), because in that case it adds a &_.db_& suffix to the file name.
34574
34575 If a duplicate key is encountered, the program outputs a warning, and when it
34576 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
34577 option is used. By default, only the first of a set of duplicates is used &--
34578 this makes it compatible with &(lsearch)& lookups. There is an option
34579 &%-lastdup%& which causes it to use the data for the last duplicate instead.
34580 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
34581 &%stderr%&. For other errors, where it doesn't actually make a new file, the
34582 return code is 2.
34583
34584
34585
34586
34587 .section "Finding individual retry times (exinext)" "SECTfinindret"
34588 .cindex "retry" "times"
34589 .cindex "&'exinext'&"
34590 A utility called &'exinext'& (mostly a Perl script) provides the ability to
34591 fish specific information out of the retry database. Given a mail domain (or a
34592 complete address), it looks up the hosts for that domain, and outputs any retry
34593 information for the hosts or for the domain. At present, the retry information
34594 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
34595 output. For example:
34596 .code
34597 $ exinext piglet@milne.fict.example
34598 kanga.milne.example:192.168.8.1 error 146: Connection refused
34599   first failed: 21-Feb-1996 14:57:34
34600   last tried:   21-Feb-1996 14:57:34
34601   next try at:  21-Feb-1996 15:02:34
34602 roo.milne.example:192.168.8.3 error 146: Connection refused
34603   first failed: 20-Jan-1996 13:12:08
34604   last tried:   21-Feb-1996 11:42:03
34605   next try at:  21-Feb-1996 19:42:03
34606   past final cutoff time
34607 .endd
34608 You can also give &'exinext'& a local part, without a domain, and it
34609 will give any retry information for that local part in your default domain.
34610 A message id can be used to obtain retry information pertaining to a specific
34611 message. This exists only when an attempt to deliver a message to a remote host
34612 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
34613 &'exinext'& is not particularly efficient, but then it is not expected to be
34614 run very often.
34615
34616 The &'exinext'& utility calls Exim to find out information such as the location
34617 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
34618 passed on to the &'exim'& commands. The first specifies an alternate Exim
34619 configuration file, and the second sets macros for use within the configuration
34620 file. These features are mainly to help in testing, but might also be useful in
34621 environments where more than one configuration file is in use.
34622
34623
34624
34625 .section "Hints database maintenance" "SECThindatmai"
34626 .cindex "hints database" "maintenance"
34627 .cindex "maintaining Exim's hints database"
34628 Three utility programs are provided for maintaining the DBM files that Exim
34629 uses to contain its delivery hint information. Each program requires two
34630 arguments. The first specifies the name of Exim's spool directory, and the
34631 second is the name of the database it is to operate on. These are as follows:
34632
34633 .ilist
34634 &'retry'&: the database of retry information
34635 .next
34636 &'wait-'&<&'transport name'&>: databases of information about messages waiting
34637 for remote hosts
34638 .next
34639 &'callout'&: the callout cache
34640 .next
34641 &'ratelimit'&: the data for implementing the ratelimit ACL condition
34642 .next
34643 &'misc'&: other hints data
34644 .endlist
34645
34646 The &'misc'& database is used for
34647
34648 .ilist
34649 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
34650 .next
34651 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
34652 &(smtp)& transport)
34653 .endlist
34654
34655
34656
34657 .section "exim_dumpdb" "SECID261"
34658 .cindex "&'exim_dumpdb'&"
34659 The entire contents of a database are written to the standard output by the
34660 &'exim_dumpdb'& program, which has no options or arguments other than the
34661 spool and database names. For example, to dump the retry database:
34662 .code
34663 exim_dumpdb /var/spool/exim retry
34664 .endd
34665 Two lines of output are produced for each entry:
34666 .code
34667 T:mail.ref.example:192.168.242.242 146 77 Connection refused
34668 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
34669 .endd
34670 The first item on the first line is the key of the record. It starts with one
34671 of the letters R, or T, depending on whether it refers to a routing or
34672 transport retry. For a local delivery, the next part is the local address; for
34673 a remote delivery it is the name of the remote host, followed by its failing IP
34674 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
34675 transport). If the remote port is not the standard one (port 25), it is added
34676 to the IP address. Then there follows an error code, an additional error code,
34677 and a textual description of the error.
34678
34679 The three times on the second line are the time of first failure, the time of
34680 the last delivery attempt, and the computed time for the next attempt. The line
34681 ends with an asterisk if the cutoff time for the last retry rule has been
34682 exceeded.
34683
34684 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
34685 consists of a host name followed by a list of ids for messages that are or were
34686 waiting to be delivered to that host. If there are a very large number for any
34687 one host, continuation records, with a sequence number added to the host name,
34688 may be seen. The data in these records is often out of date, because a message
34689 may be routed to several alternative hosts, and Exim makes no effort to keep
34690 cross-references.
34691
34692
34693
34694 .section "exim_tidydb" "SECID262"
34695 .cindex "&'exim_tidydb'&"
34696 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
34697 database. If run with no options, it removes all records that are more than 30
34698 days old. The age is calculated from the date and time that the record was last
34699 updated. Note that, in the case of the retry database, it is &'not'& the time
34700 since the first delivery failure. Information about a host that has been down
34701 for more than 30 days will remain in the database, provided that the record is
34702 updated sufficiently often.
34703
34704 The cutoff date can be altered by means of the &%-t%& option, which must be
34705 followed by a time. For example, to remove all records older than a week from
34706 the retry database:
34707 .code
34708 exim_tidydb -t 7d /var/spool/exim retry
34709 .endd
34710 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
34711 message ids. In the former these appear as data in records keyed by host &--
34712 they were messages that were waiting for that host &-- and in the latter they
34713 are the keys for retry information for messages that have suffered certain
34714 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
34715 message ids in database records are those of messages that are still on the
34716 queue. Message ids for messages that no longer exist are removed from
34717 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
34718 For the &'retry'& database, records whose keys are non-existent message ids are
34719 removed. The &'exim_tidydb'& utility outputs comments on the standard output
34720 whenever it removes information from the database.
34721
34722 Certain records are automatically removed by Exim when they are no longer
34723 needed, but others are not. For example, if all the MX hosts for a domain are
34724 down, a retry record is created for each one. If the primary MX host comes back
34725 first, its record is removed when Exim successfully delivers to it, but the
34726 records for the others remain because Exim has not tried to use those hosts.
34727
34728 It is important, therefore, to run &'exim_tidydb'& periodically on all the
34729 hints databases. You should do this at a quiet time of day, because it requires
34730 a database to be locked (and therefore inaccessible to Exim) while it does its
34731 work. Removing records from a DBM file does not normally make the file smaller,
34732 but all the common DBM libraries are able to re-use the space that is released.
34733 After an initial phase of increasing in size, the databases normally reach a
34734 point at which they no longer get any bigger, as long as they are regularly
34735 tidied.
34736
34737 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
34738 databases is likely to keep on increasing.
34739
34740
34741
34742
34743 .section "exim_fixdb" "SECID263"
34744 .cindex "&'exim_fixdb'&"
34745 The &'exim_fixdb'& program is a utility for interactively modifying databases.
34746 Its main use is for testing Exim, but it might also be occasionally useful for
34747 getting round problems in a live system. It has no options, and its interface
34748 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
34749 key of a database record can then be entered, and the data for that record is
34750 displayed.
34751
34752 If &"d"& is typed at the next prompt, the entire record is deleted. For all
34753 except the &'retry'& database, that is the only operation that can be carried
34754 out. For the &'retry'& database, each field is output preceded by a number, and
34755 data for individual fields can be changed by typing the field number followed
34756 by new data, for example:
34757 .code
34758 > 4 951102:1000
34759 .endd
34760 resets the time of the next delivery attempt. Time values are given as a
34761 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
34762 used as optional separators.
34763
34764
34765
34766
34767 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
34768 .cindex "mailbox" "maintenance"
34769 .cindex "&'exim_lock'&"
34770 .cindex "locking mailboxes"
34771 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
34772 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
34773 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
34774 a user agent while investigating a problem. The utility requires the name of
34775 the file as its first argument. If the locking is successful, the second
34776 argument is run as a command (using C's &[system()]& function); if there is no
34777 second argument, the value of the SHELL environment variable is used; if this
34778 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
34779 is unlocked and the utility ends. The following options are available:
34780
34781 .vlist
34782 .vitem &%-fcntl%&
34783 Use &[fcntl()]& locking on the open mailbox.
34784
34785 .vitem &%-flock%&
34786 Use &[flock()]& locking on the open mailbox, provided the operating system
34787 supports it.
34788
34789 .vitem &%-interval%&
34790 This must be followed by a number, which is a number of seconds; it sets the
34791 interval to sleep between retries (default 3).
34792
34793 .vitem &%-lockfile%&
34794 Create a lock file before opening the mailbox.
34795
34796 .vitem &%-mbx%&
34797 Lock the mailbox using MBX rules.
34798
34799 .vitem &%-q%&
34800 Suppress verification output.
34801
34802 .vitem &%-retries%&
34803 This must be followed by a number; it sets the number of times to try to get
34804 the lock (default 10).
34805
34806 .vitem &%-restore_time%&
34807 This option causes &%exim_lock%& to restore the modified and read times to the
34808 locked file before exiting. This allows you to access a locked mailbox (for
34809 example, to take a backup copy) without disturbing the times that the user
34810 subsequently sees.
34811
34812 .vitem &%-timeout%&
34813 This must be followed by a number, which is a number of seconds; it sets a
34814 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
34815 default), a non-blocking call is used.
34816
34817 .vitem &%-v%&
34818 Generate verbose output.
34819 .endlist
34820
34821 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
34822 default is to create a lock file and also to use &[fcntl()]& locking on the
34823 mailbox, which is the same as Exim's default. The use of &%-flock%& or
34824 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
34825 requires that the directory containing the file be writeable. Locking by lock
34826 file does not last for ever; Exim assumes that a lock file is expired if it is
34827 more than 30 minutes old.
34828
34829 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
34830 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
34831 to be taken out on the open mailbox, and an exclusive lock on the file
34832 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
34833 number of the mailbox file. When the locking is released, if an exclusive lock
34834 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
34835
34836 The default output contains verification of the locking that takes place. The
34837 &%-v%& option causes some additional information to be given. The &%-q%& option
34838 suppresses all output except error messages.
34839
34840 A command such as
34841 .code
34842 exim_lock /var/spool/mail/spqr
34843 .endd
34844 runs an interactive shell while the file is locked, whereas
34845 .display
34846 &`exim_lock -q /var/spool/mail/spqr <<End`&
34847 <&'some commands'&>
34848 &`End`&
34849 .endd
34850 runs a specific non-interactive sequence of commands while the file is locked,
34851 suppressing all verification output. A single command can be run by a command
34852 such as
34853 .code
34854 exim_lock -q /var/spool/mail/spqr \
34855   "cp /var/spool/mail/spqr /some/where"
34856 .endd
34857 Note that if a command is supplied, it must be entirely contained within the
34858 second argument &-- hence the quotes.
34859 .ecindex IIDutils
34860
34861
34862 . ////////////////////////////////////////////////////////////////////////////
34863 . ////////////////////////////////////////////////////////////////////////////
34864
34865 .chapter "The Exim monitor" "CHAPeximon"
34866 .scindex IIDeximon "Exim monitor" "description"
34867 .cindex "X-windows"
34868 .cindex "&'eximon'&"
34869 .cindex "Local/eximon.conf"
34870 .cindex "&_exim_monitor/EDITME_&"
34871 The Exim monitor is an application which displays in an X window information
34872 about the state of Exim's queue and what Exim is doing. An admin user can
34873 perform certain operations on messages from this GUI interface; however all
34874 such facilities are also available from the command line, and indeed, the
34875 monitor itself makes use of the command line to perform any actions requested.
34876
34877
34878
34879 .section "Running the monitor" "SECID264"
34880 The monitor is started by running the script called &'eximon'&. This is a shell
34881 script that sets up a number of environment variables, and then runs the
34882 binary called &_eximon.bin_&. The default appearance of the monitor window can
34883 be changed by editing the &_Local/eximon.conf_& file created by editing
34884 &_exim_monitor/EDITME_&. Comments in that file describe what the various
34885 parameters are for.
34886
34887 The parameters that get built into the &'eximon'& script can be overridden for
34888 a particular invocation by setting up environment variables of the same names,
34889 preceded by &`EXIMON_`&. For example, a shell command such as
34890 .code
34891 EXIMON_LOG_DEPTH=400 eximon
34892 .endd
34893 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
34894 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
34895 overrides the Exim log file configuration. This makes it possible to have
34896 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
34897 syslog messages are routed to a file on the local host.
34898
34899 X resources can be used to change the appearance of the window in the normal
34900 way. For example, a resource setting of the form
34901 .code
34902 Eximon*background: gray94
34903 .endd
34904 changes the colour of the background to light grey rather than white. The
34905 stripcharts are drawn with both the data lines and the reference lines in
34906 black. This means that the reference lines are not visible when on top of the
34907 data. However, their colour can be changed by setting a resource called
34908 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
34909 For example, if your X server is running Unix, you could set up lighter
34910 reference lines in the stripcharts by obeying
34911 .code
34912 xrdb -merge <<End
34913 Eximon*highlight: gray
34914 End
34915 .endd
34916 .cindex "admin user"
34917 In order to see the contents of messages on the queue, and to operate on them,
34918 &'eximon'& must either be run as root or by an admin user.
34919
34920 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
34921 contain X11 resource parameters interpreted by the X11 library.  In addition,
34922 if the first parameter starts with the string "gdb" then it is removed and the
34923 binary is invoked under gdb (the parameter is used as the gdb command-name, so
34924 versioned variants of gdb can be invoked).
34925
34926 The monitor's window is divided into three parts. The first contains one or
34927 more stripcharts and two action buttons, the second contains a &"tail"& of the
34928 main log file, and the third is a display of the queue of messages awaiting
34929 delivery, with two more action buttons. The following sections describe these
34930 different parts of the display.
34931
34932
34933
34934
34935 .section "The stripcharts" "SECID265"
34936 .cindex "stripchart"
34937 The first stripchart is always a count of messages on the queue. Its name can
34938 be configured by setting QUEUE_STRIPCHART_NAME in the
34939 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
34940 configuration script by regular expression matches on log file entries, making
34941 it possible to display, for example, counts of messages delivered to certain
34942 hosts or using certain transports. The supplied defaults display counts of
34943 received and delivered messages, and of local and SMTP deliveries. The default
34944 period between stripchart updates is one minute; this can be adjusted by a
34945 parameter in the &_Local/eximon.conf_& file.
34946
34947 The stripchart displays rescale themselves automatically as the value they are
34948 displaying changes. There are always 10 horizontal lines in each chart; the
34949 title string indicates the value of each division when it is greater than one.
34950 For example, &"x2"& means that each division represents a value of 2.
34951
34952 It is also possible to have a stripchart which shows the percentage fullness of
34953 a particular disk partition, which is useful when local deliveries are confined
34954 to a single partition.
34955
34956 .cindex "&%statvfs%& function"
34957 This relies on the availability of the &[statvfs()]& function or equivalent in
34958 the operating system. Most, but not all versions of Unix that support Exim have
34959 this. For this particular stripchart, the top of the chart always represents
34960 100%, and the scale is given as &"x10%"&. This chart is configured by setting
34961 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
34962 &_Local/eximon.conf_& file.
34963
34964
34965
34966
34967 .section "Main action buttons" "SECID266"
34968 .cindex "size" "of monitor window"
34969 .cindex "Exim monitor" "window size"
34970 .cindex "window size"
34971 Below the stripcharts there is an action button for quitting the monitor. Next
34972 to this is another button marked &"Size"&. They are placed here so that
34973 shrinking the window to its default minimum size leaves just the queue count
34974 stripchart and these two buttons visible. Pressing the &"Size"& button causes
34975 the window to expand to its maximum size, unless it is already at the maximum,
34976 in which case it is reduced to its minimum.
34977
34978 When expanding to the maximum, if the window cannot be fully seen where it
34979 currently is, it is moved back to where it was the last time it was at full
34980 size. When it is expanding from its minimum size, the old position is
34981 remembered, and next time it is reduced to the minimum it is moved back there.
34982
34983 The idea is that you can keep a reduced window just showing one or two
34984 stripcharts at a convenient place on your screen, easily expand it to show
34985 the full window when required, and just as easily put it back to what it was.
34986 The idea is copied from what the &'twm'& window manager does for its
34987 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
34988 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
34989
34990 Normally, the monitor starts up with the window at its full size, but it can be
34991 built so that it starts up with the window at its smallest size, by setting
34992 START_SMALL=yes in &_Local/eximon.conf_&.
34993
34994
34995
34996 .section "The log display" "SECID267"
34997 .cindex "log" "tail of; in monitor"
34998 The second section of the window is an area in which a display of the tail of
34999 the main log is maintained.
35000 To save space on the screen, the timestamp on each log line is shortened by
35001 removing the date and, if &%log_timezone%& is set, the timezone.
35002 The log tail is not available when the only destination for logging data is
35003 syslog, unless the syslog lines are routed to a local file whose name is passed
35004 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
35005
35006 The log sub-window has a scroll bar at its lefthand side which can be used to
35007 move back to look at earlier text, and the up and down arrow keys also have a
35008 scrolling effect. The amount of log that is kept depends on the setting of
35009 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
35010 to use. When this is full, the earlier 50% of data is discarded &-- this is
35011 much more efficient than throwing it away line by line. The sub-window also has
35012 a horizontal scroll bar for accessing the ends of long log lines. This is the
35013 only means of horizontal scrolling; the right and left arrow keys are not
35014 available. Text can be cut from this part of the window using the mouse in the
35015 normal way. The size of this subwindow is controlled by parameters in the
35016 configuration file &_Local/eximon.conf_&.
35017
35018 Searches of the text in the log window can be carried out by means of the ^R
35019 and ^S keystrokes, which default to a reverse and a forward search,
35020 respectively. The search covers only the text that is displayed in the window.
35021 It cannot go further back up the log.
35022
35023 The point from which the search starts is indicated by a caret marker. This is
35024 normally at the end of the text in the window, but can be positioned explicitly
35025 by pointing and clicking with the left mouse button, and is moved automatically
35026 by a successful search. If new text arrives in the window when it is scrolled
35027 back, the caret remains where it is, but if the window is not scrolled back,
35028 the caret is moved to the end of the new text.
35029
35030 Pressing ^R or ^S pops up a window into which the search text can be typed.
35031 There are buttons for selecting forward or reverse searching, for carrying out
35032 the search, and for cancelling. If the &"Search"& button is pressed, the search
35033 happens and the window remains so that further searches can be done. If the
35034 &"Return"& key is pressed, a single search is done and the window is closed. If
35035 ^C is typed the search is cancelled.
35036
35037 The searching facility is implemented using the facilities of the Athena text
35038 widget. By default this pops up a window containing both &"search"& and
35039 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
35040 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
35041 However, the linkers in BSDI and HP-UX seem unable to handle an externally
35042 provided version of &%TextPop%& when the remaining parts of the text widget
35043 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
35044 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
35045 on these systems, at the expense of having unwanted items in the search popup
35046 window.
35047
35048
35049
35050 .section "The queue display" "SECID268"
35051 .cindex "queue" "display in monitor"
35052 The bottom section of the monitor window contains a list of all messages that
35053 are on the queue, which includes those currently being received or delivered,
35054 as well as those awaiting delivery. The size of this subwindow is controlled by
35055 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
35056 at which it is updated is controlled by another parameter in the same file &--
35057 the default is 5 minutes, since queue scans can be quite expensive. However,
35058 there is an &"Update"& action button just above the display which can be used
35059 to force an update of the queue display at any time.
35060
35061 When a host is down for some time, a lot of pending mail can build up for it,
35062 and this can make it hard to deal with other messages on the queue. To help
35063 with this situation there is a button next to &"Update"& called &"Hide"&. If
35064 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
35065 type anything in here and press &"Return"&, the text is added to a chain of
35066 such texts, and if every undelivered address in a message matches at least one
35067 of the texts, the message is not displayed.
35068
35069 If there is an address that does not match any of the texts, all the addresses
35070 are displayed as normal. The matching happens on the ends of addresses so, for
35071 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
35072 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
35073 has been set up, a button called &"Unhide"& is displayed. If pressed, it
35074 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
35075 a hide request is automatically cancelled after one hour.
35076
35077 While the dialogue box is displayed, you can't press any buttons or do anything
35078 else to the monitor window. For this reason, if you want to cut text from the
35079 queue display to use in the dialogue box, you have to do the cutting before
35080 pressing the &"Hide"& button.
35081
35082 The queue display contains, for each unhidden queued message, the length of
35083 time it has been on the queue, the size of the message, the message id, the
35084 message sender, and the first undelivered recipient, all on one line. If it is
35085 a bounce message, the sender is shown as &"<>"&. If there is more than one
35086 recipient to which the message has not yet been delivered, subsequent ones are
35087 listed on additional lines, up to a maximum configured number, following which
35088 an ellipsis is displayed. Recipients that have already received the message are
35089 not shown.
35090
35091 .cindex "frozen messages" "display"
35092 If a message is frozen, an asterisk is displayed at the left-hand side.
35093
35094 The queue display has a vertical scroll bar, and can also be scrolled by means
35095 of the arrow keys. Text can be cut from it using the mouse in the normal way.
35096 The text searching facilities, as described above for the log window, are also
35097 available, but the caret is always moved to the end of the text when the queue
35098 display is updated.
35099
35100
35101
35102 .section "The queue menu" "SECID269"
35103 .cindex "queue" "menu in monitor"
35104 If the &%shift%& key is held down and the left button is clicked when the mouse
35105 pointer is over the text for any message, an action menu pops up, and the first
35106 line of the queue display for the message is highlighted. This does not affect
35107 any selected text.
35108
35109 If you want to use some other event for popping up the menu, you can set the
35110 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
35111 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
35112 value set in this parameter is a standard X event description. For example, to
35113 run eximon using &%ctrl%& rather than &%shift%& you could use
35114 .code
35115 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
35116 .endd
35117 The title of the menu is the message id, and it contains entries which act as
35118 follows:
35119
35120 .ilist
35121 &'message log'&: The contents of the message log for the message are displayed
35122 in a new text window.
35123 .next
35124 &'headers'&: Information from the spool file that contains the envelope
35125 information and headers is displayed in a new text window. See chapter
35126 &<<CHAPspool>>& for a description of the format of spool files.
35127 .next
35128 &'body'&: The contents of the spool file containing the body of the message are
35129 displayed in a new text window. There is a default limit of 20,000 bytes to the
35130 amount of data displayed. This can be changed by setting the BODY_MAX
35131 option at compile time, or the EXIMON_BODY_MAX option at run time.
35132 .next
35133 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
35134 delivery of the message. This causes an automatic thaw if the message is
35135 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
35136 a new text window. The delivery is run in a separate process, to avoid holding
35137 up the monitor while the delivery proceeds.
35138 .next
35139 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
35140 that the message be frozen.
35141 .next
35142 .cindex "thawing messages"
35143 .cindex "unfreezing messages"
35144 .cindex "frozen messages" "thawing"
35145 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
35146 that the message be thawed.
35147 .next
35148 .cindex "delivery" "forcing failure"
35149 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
35150 that Exim gives up trying to deliver the message. A bounce message is generated
35151 for any remaining undelivered addresses.
35152 .next
35153 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
35154 that the message be deleted from the system without generating a bounce
35155 message.
35156 .next
35157 &'add recipient'&: A dialog box is displayed into which a recipient address can
35158 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
35159 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
35160 Otherwise it must be entered as a fully qualified address. Pressing RETURN
35161 causes a call to Exim to be made using the &%-Mar%& option to request that an
35162 additional recipient be added to the message, unless the entry box is empty, in
35163 which case no action is taken.
35164 .next
35165 &'mark delivered'&: A dialog box is displayed into which a recipient address
35166 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
35167 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
35168 Otherwise it must be entered as a fully qualified address. Pressing RETURN
35169 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
35170 recipient address as already delivered, unless the entry box is empty, in which
35171 case no action is taken.
35172 .next
35173 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
35174 mark all recipient addresses as already delivered.
35175 .next
35176 &'edit sender'&: A dialog box is displayed initialized with the current
35177 sender's address. Pressing RETURN causes a call to Exim to be made using the
35178 &%-Mes%& option to replace the sender address, unless the entry box is empty,
35179 in which case no action is taken. If you want to set an empty sender (as in
35180 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
35181 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
35182 the address is qualified with that domain.
35183 .endlist
35184
35185 When a delivery is forced, a window showing the &%-v%& output is displayed. In
35186 other cases when a call to Exim is made, if there is any output from Exim (in
35187 particular, if the command fails) a window containing the command and the
35188 output is displayed. Otherwise, the results of the action are normally apparent
35189 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
35190 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
35191 if no output is generated.
35192
35193 The queue display is automatically updated for actions such as freezing and
35194 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
35195 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
35196 force an update of the display after one of these actions.
35197
35198 In any text window that is displayed as result of a menu action, the normal
35199 cut-and-paste facility is available, and searching can be carried out using ^R
35200 and ^S, as described above for the log tail window.
35201 .ecindex IIDeximon
35202
35203
35204
35205
35206
35207 . ////////////////////////////////////////////////////////////////////////////
35208 . ////////////////////////////////////////////////////////////////////////////
35209
35210 .chapter "Security considerations" "CHAPsecurity"
35211 .scindex IIDsecurcon "security" "discussion of"
35212 This chapter discusses a number of issues concerned with security, some of
35213 which are also covered in other parts of this manual.
35214
35215 For reasons that this author does not understand, some people have promoted
35216 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
35217 existence of this chapter in the documentation. However, the intent of the
35218 chapter is simply to describe the way Exim works in relation to certain
35219 security concerns, not to make any specific claims about the effectiveness of
35220 its security as compared with other MTAs.
35221
35222 What follows is a description of the way Exim is supposed to be. Best efforts
35223 have been made to try to ensure that the code agrees with the theory, but an
35224 absence of bugs can never be guaranteed. Any that are reported will get fixed
35225 as soon as possible.
35226
35227
35228 .section "Building a more &""hardened""& Exim" "SECID286"
35229 .cindex "security" "build-time features"
35230 There are a number of build-time options that can be set in &_Local/Makefile_&
35231 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
35232 Exim administrator who does not have the root password, or by someone who has
35233 penetrated the Exim (but not the root) account. These options are as follows:
35234
35235 .ilist
35236 ALT_CONFIG_PREFIX can be set to a string that is required to match the
35237 start of any file names used with the &%-C%& option. When it is set, these file
35238 names are also not allowed to contain the sequence &"/../"&. (However, if the
35239 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
35240 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
35241 default setting for &%ALT_CONFIG_PREFIX%&.
35242
35243 If the permitted configuration files are confined to a directory to
35244 which only root has access, this guards against someone who has broken
35245 into the Exim account from running a privileged Exim with an arbitrary
35246 configuration file, and using it to break into other accounts.
35247 .next
35248
35249 If a non-trusted configuration file (i.e. not the default configuration file
35250 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
35251 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
35252 the next item), then root privilege is retained only if the caller of Exim is
35253 root. This locks out the possibility of testing a configuration using &%-C%&
35254 right through message reception and delivery, even if the caller is root. The
35255 reception works, but by that time, Exim is running as the Exim user, so when
35256 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
35257 privilege to be lost. However, root can test reception and delivery using two
35258 separate commands.
35259
35260 .next
35261 The WHITELIST_D_MACROS build option declares some macros to be safe to override
35262 with &%-D%& if the real uid is one of root, the Exim run-time user or the
35263 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
35264 requiring the run-time value supplied to &%-D%& to match a regex that errs on
35265 the restrictive side.  Requiring build-time selection of safe macros is onerous
35266 but this option is intended solely as a transition mechanism to permit
35267 previously-working configurations to continue to work after release 4.73.
35268 .next
35269 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
35270 is disabled.
35271 .next
35272 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
35273 never to be used for any deliveries. This is like the &%never_users%& runtime
35274 option, but it cannot be overridden; the runtime option adds additional users
35275 to the list. The default setting is &"root"&; this prevents a non-root user who
35276 is permitted to modify the runtime file from using Exim as a way to get root.
35277 .endlist
35278
35279
35280
35281 .section "Root privilege" "SECID270"
35282 .cindex "setuid"
35283 .cindex "root privilege"
35284 The Exim binary is normally setuid to root, which means that it gains root
35285 privilege (runs as root) when it starts execution. In some special cases (for
35286 example, when the daemon is not in use and there are no local deliveries), it
35287 may be possible to run Exim setuid to some user other than root. This is
35288 discussed in the next section. However, in most installations, root privilege
35289 is required for two things:
35290
35291 .ilist
35292 To set up a socket connected to the standard SMTP port (25) when initialising
35293 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
35294 not required.
35295 .next
35296 To be able to change uid and gid in order to read users' &_.forward_& files and
35297 perform local deliveries as the receiving user or as specified in the
35298 configuration.
35299 .endlist
35300
35301 It is not necessary to be root to do any of the other things Exim does, such as
35302 receiving messages and delivering them externally over SMTP, and it is
35303 obviously more secure if Exim does not run as root except when necessary.
35304 For this reason, a user and group for Exim to use must be defined in
35305 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
35306 group"&. Their values can be changed by the run time configuration, though this
35307 is not recommended. Often a user called &'exim'& is used, but some sites use
35308 &'mail'& or another user name altogether.
35309
35310 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
35311 abdication; the process cannot regain root afterwards. Prior to release 4.00,
35312 &[seteuid()]& was used in some circumstances, but this is no longer the case.
35313
35314 After a new Exim process has interpreted its command line options, it changes
35315 uid and gid in the following cases:
35316
35317 .ilist
35318 .oindex "&%-C%&"
35319 .oindex "&%-D%&"
35320 If the &%-C%& option is used to specify an alternate configuration file, or if
35321 the &%-D%& option is used to define macro values for the configuration, and the
35322 calling process is not running as root, the uid and gid are changed to those of
35323 the calling process.
35324 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
35325 option may not be used at all.
35326 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
35327 can be supplied if the calling process is running as root, the Exim run-time
35328 user or CONFIGURE_OWNER, if defined.
35329 .next
35330 .oindex "&%-be%&"
35331 .oindex "&%-bf%&"
35332 .oindex "&%-bF%&"
35333 If the expansion test option (&%-be%&) or one of the filter testing options
35334 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
35335 calling process.
35336 .next
35337 If the process is not a daemon process or a queue runner process or a delivery
35338 process or a process for testing address routing (started with &%-bt%&), the
35339 uid and gid are changed to the Exim user and group. This means that Exim always
35340 runs under its own uid and gid when receiving messages. This also applies when
35341 testing address verification
35342 .oindex "&%-bv%&"
35343 .oindex "&%-bh%&"
35344 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
35345 option).
35346 .next
35347 For a daemon, queue runner, delivery, or address testing process, the uid
35348 remains as root at this stage, but the gid is changed to the Exim group.
35349 .endlist
35350
35351 The processes that initially retain root privilege behave as follows:
35352
35353 .ilist
35354 A daemon process changes the gid to the Exim group and the uid to the Exim
35355 user after setting up one or more listening sockets. The &[initgroups()]&
35356 function is called, so that if the Exim user is in any additional groups, they
35357 will be used during message reception.
35358 .next
35359 A queue runner process retains root privilege throughout its execution. Its
35360 job is to fork a controlled sequence of delivery processes.
35361 .next
35362 A delivery process retains root privilege throughout most of its execution,
35363 but any actual deliveries (that is, the transports themselves) are run in
35364 subprocesses which always change to a non-root uid and gid. For local
35365 deliveries this is typically the uid and gid of the owner of the mailbox; for
35366 remote deliveries, the Exim uid and gid are used. Once all the delivery
35367 subprocesses have been run, a delivery process changes to the Exim uid and gid
35368 while doing post-delivery tidying up such as updating the retry database and
35369 generating bounce and warning messages.
35370
35371 While the recipient addresses in a message are being routed, the delivery
35372 process runs as root. However, if a user's filter file has to be processed,
35373 this is done in a subprocess that runs under the individual user's uid and
35374 gid. A system filter is run as root unless &%system_filter_user%& is set.
35375 .next
35376 A process that is testing addresses (the &%-bt%& option) runs as root so that
35377 the routing is done in the same environment as a message delivery.
35378 .endlist
35379
35380
35381
35382
35383 .section "Running Exim without privilege" "SECTrunexiwitpri"
35384 .cindex "privilege, running without"
35385 .cindex "unprivileged running"
35386 .cindex "root privilege" "running without"
35387 Some installations like to run Exim in an unprivileged state for more of its
35388 operation, for added security. Support for this mode of operation is provided
35389 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
35390 gid are changed to the Exim user and group at the start of a delivery process
35391 (and also queue runner and address testing processes). This means that address
35392 routing is no longer run as root, and the deliveries themselves cannot change
35393 to any other uid.
35394
35395 .cindex SIGHUP
35396 .cindex "daemon" "restarting"
35397 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
35398 that the daemon can still be started in the usual way, and it can respond
35399 correctly to SIGHUP because the re-invocation regains root privilege.
35400
35401 An alternative approach is to make Exim setuid to the Exim user and also setgid
35402 to the Exim group. If you do this, the daemon must be started from a root
35403 process. (Calling Exim from a root process makes it behave in the way it does
35404 when it is setuid root.) However, the daemon cannot restart itself after a
35405 SIGHUP signal because it cannot regain privilege.
35406
35407 It is still useful to set &%deliver_drop_privilege%& in this case, because it
35408 stops Exim from trying to re-invoke itself to do a delivery after a message has
35409 been received. Such a re-invocation is a waste of resources because it has no
35410 effect.
35411
35412 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
35413 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
35414 to the Exim user seems a clean approach, but there is one complication:
35415
35416 In this style of operation, Exim is running with the real uid and gid set to
35417 those of the calling process, and the effective uid/gid set to Exim's values.
35418 Ideally, any association with the calling process' uid/gid should be dropped,
35419 that is, the real uid/gid should be reset to the effective values so as to
35420 discard any privileges that the caller may have. While some operating systems
35421 have a function that permits this action for a non-root effective uid, quite a
35422 number of them do not. Because of this lack of standardization, Exim does not
35423 address this problem at this time.
35424
35425 For this reason, the recommended approach for &"mostly unprivileged"& running
35426 is to keep the Exim binary setuid to root, and to set
35427 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
35428 be used in the most straightforward way.
35429
35430 If you configure Exim not to run delivery processes as root, there are a
35431 number of restrictions on what you can do:
35432
35433 .ilist
35434 You can deliver only as the Exim user/group. You should  explicitly use the
35435 &%user%& and &%group%& options to override routers or local transports that
35436 normally deliver as the recipient. This makes sure that configurations that
35437 work in this mode function the same way in normal mode. Any implicit or
35438 explicit specification of another user causes an error.
35439 .next
35440 Use of &_.forward_& files is severely restricted, such that it is usually
35441 not worthwhile to include them in the configuration.
35442 .next
35443 Users who wish to use &_.forward_& would have to make their home directory and
35444 the file itself accessible to the Exim user. Pipe and append-to-file entries,
35445 and their equivalents in Exim filters, cannot be used. While they could be
35446 enabled in the Exim user's name, that would be insecure and not very useful.
35447 .next
35448 Unless the local user mailboxes are all owned by the Exim user (possible in
35449 some POP3 or IMAP-only environments):
35450
35451 .olist
35452 They must be owned by the Exim group and be writeable by that group. This
35453 implies you must set &%mode%& in the appendfile configuration, as well as the
35454 mode of the mailbox files themselves.
35455 .next
35456 You must set &%no_check_owner%&, since most or all of the files will not be
35457 owned by the Exim user.
35458 .next
35459 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
35460 on a newly created mailbox when unprivileged. This also implies that new
35461 mailboxes need to be created manually.
35462 .endlist olist
35463 .endlist ilist
35464
35465
35466 These restrictions severely restrict what can be done in local deliveries.
35467 However, there are no restrictions on remote deliveries. If you are running a
35468 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
35469 gives more security at essentially no cost.
35470
35471 If you are using the &%mua_wrapper%& facility (see chapter
35472 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
35473
35474
35475
35476
35477 .section "Delivering to local files" "SECID271"
35478 Full details of the checks applied by &(appendfile)& before it writes to a file
35479 are given in chapter &<<CHAPappendfile>>&.
35480
35481
35482
35483 .section "IPv4 source routing" "SECID272"
35484 .cindex "source routing" "in IP packets"
35485 .cindex "IP source routing"
35486 Many operating systems suppress IP source-routed packets in the kernel, but
35487 some cannot be made to do this, so Exim does its own check. It logs incoming
35488 IPv4 source-routed TCP calls, and then drops them. Things are all different in
35489 IPv6. No special checking is currently done.
35490
35491
35492
35493 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
35494 Support for these SMTP commands is disabled by default. If required, they can
35495 be enabled by defining suitable ACLs.
35496
35497
35498
35499
35500 .section "Privileged users" "SECID274"
35501 .cindex "trusted users"
35502 .cindex "admin user"
35503 .cindex "privileged user"
35504 .cindex "user" "trusted"
35505 .cindex "user" "admin"
35506 Exim recognizes two sets of users with special privileges. Trusted users are
35507 able to submit new messages to Exim locally, but supply their own sender
35508 addresses and information about a sending host. For other users submitting
35509 local messages, Exim sets up the sender address from the uid, and doesn't
35510 permit a remote host to be specified.
35511
35512 .oindex "&%-f%&"
35513 However, an untrusted user is permitted to use the &%-f%& command line option
35514 in the special form &%-f <>%& to indicate that a delivery failure for the
35515 message should not cause an error report. This affects the message's envelope,
35516 but it does not affect the &'Sender:'& header. Untrusted users may also be
35517 permitted to use specific forms of address with the &%-f%& option by setting
35518 the &%untrusted_set_sender%& option.
35519
35520 Trusted users are used to run processes that receive mail messages from some
35521 other mail domain and pass them on to Exim for delivery either locally, or over
35522 the Internet. Exim trusts a caller that is running as root, as the Exim user,
35523 as any user listed in the &%trusted_users%& configuration option, or under any
35524 group listed in the &%trusted_groups%& option.
35525
35526 Admin users are permitted to do things to the messages on Exim's queue. They
35527 can freeze or thaw messages, cause them to be returned to their senders, remove
35528 them entirely, or modify them in various ways. In addition, admin users can run
35529 the Exim monitor and see all the information it is capable of providing, which
35530 includes the contents of files on the spool.
35531
35532 .oindex "&%-M%&"
35533 .oindex "&%-q%&"
35534 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
35535 delivery of messages on its queue is restricted to admin users. This
35536 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
35537 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
35538 queue is also restricted to admin users. This restriction can be relaxed by
35539 setting &%no_queue_list_requires_admin%&.
35540
35541 Exim recognizes an admin user if the calling process is running as root or as
35542 the Exim user or if any of the groups associated with the calling process is
35543 the Exim group. It is not necessary actually to be running under the Exim
35544 group. However, if admin users who are not root or the Exim user are to access
35545 the contents of files on the spool via the Exim monitor (which runs
35546 unprivileged), Exim must be built to allow group read access to its spool
35547 files.
35548
35549
35550
35551 .section "Spool files" "SECID275"
35552 .cindex "spool directory" "files"
35553 Exim's spool directory and everything it contains is owned by the Exim user and
35554 set to the Exim group. The mode for spool files is defined in the
35555 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
35556 any user who is a member of the Exim group can access these files.
35557
35558
35559
35560 .section "Use of argv[0]" "SECID276"
35561 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
35562 of specific strings, Exim assumes certain options. For example, calling Exim
35563 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
35564 to calling it with the option &%-bS%&. There are no security implications in
35565 this.
35566
35567
35568
35569 .section "Use of %f formatting" "SECID277"
35570 The only use made of &"%f"& by Exim is in formatting load average values. These
35571 are actually stored in integer variables as 1000 times the load average.
35572 Consequently, their range is limited and so therefore is the length of the
35573 converted output.
35574
35575
35576
35577 .section "Embedded Exim path" "SECID278"
35578 Exim uses its own path name, which is embedded in the code, only when it needs
35579 to re-exec in order to regain root privilege. Therefore, it is not root when it
35580 does so. If some bug allowed the path to get overwritten, it would lead to an
35581 arbitrary program's being run as exim, not as root.
35582
35583
35584
35585 .section "Dynamic module directory" "SECTdynmoddir"
35586 Any dynamically loadable modules must be installed into the directory
35587 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
35588 loading it.
35589
35590
35591 .section "Use of sprintf()" "SECID279"
35592 .cindex "&[sprintf()]&"
35593 A large number of occurrences of &"sprintf"& in the code are actually calls to
35594 &'string_sprintf()'&, a function that returns the result in malloc'd store.
35595 The intermediate formatting is done into a large fixed buffer by a function
35596 that runs through the format string itself, and checks the length of each
35597 conversion before performing it, thus preventing buffer overruns.
35598
35599 The remaining uses of &[sprintf()]& happen in controlled circumstances where
35600 the output buffer is known to be sufficiently long to contain the converted
35601 string.
35602
35603
35604
35605 .section "Use of debug_printf() and log_write()" "SECID280"
35606 Arbitrary strings are passed to both these functions, but they do their
35607 formatting by calling the function &'string_vformat()'&, which runs through
35608 the format string itself, and checks the length of each conversion.
35609
35610
35611
35612 .section "Use of strcat() and strcpy()" "SECID281"
35613 These are used only in cases where the output buffer is known to be large
35614 enough to hold the result.
35615 .ecindex IIDsecurcon
35616
35617
35618
35619
35620 . ////////////////////////////////////////////////////////////////////////////
35621 . ////////////////////////////////////////////////////////////////////////////
35622
35623 .chapter "Format of spool files" "CHAPspool"
35624 .scindex IIDforspo1 "format" "spool files"
35625 .scindex IIDforspo2 "spool directory" "format of files"
35626 .scindex IIDforspo3 "spool files" "format of"
35627 .cindex "spool files" "editing"
35628 A message on Exim's queue consists of two files, whose names are the message id
35629 followed by -D and -H, respectively. The data portion of the message is kept in
35630 the -D file on its own. The message's envelope, status, and headers are all
35631 kept in the -H file, whose format is described in this chapter. Each of these
35632 two files contains the final component of its own name as its first line. This
35633 is insurance against disk crashes where the directory is lost but the files
35634 themselves are recoverable.
35635
35636 Some people are tempted into editing -D files in order to modify messages. You
35637 need to be extremely careful if you do this; it is not recommended and you are
35638 on your own if you do it. Here are some of the pitfalls:
35639
35640 .ilist
35641 You must ensure that Exim does not try to deliver the message while you are
35642 fiddling with it. The safest way is to take out a write lock on the -D file,
35643 which is what Exim itself does, using &[fcntl()]&. If you update the file in
35644 place, the lock will be retained. If you write a new file and rename it, the
35645 lock will be lost at the instant of rename.
35646 .next
35647 .vindex "&$body_linecount$&"
35648 If you change the number of lines in the file, the value of
35649 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
35650 present, this value is not used by Exim, but there is no guarantee that this
35651 will always be the case.
35652 .next
35653 If the message is in MIME format, you must take care not to break it.
35654 .next
35655 If the message is cryptographically signed, any change will invalidate the
35656 signature.
35657 .endlist
35658 All in all, modifying -D files is fraught with danger.
35659
35660 Files whose names end with -J may also be seen in the &_input_& directory (or
35661 its subdirectories when &%split_spool_directory%& is set). These are journal
35662 files, used to record addresses to which the message has been delivered during
35663 the course of a delivery attempt. If there are still undelivered recipients at
35664 the end, the -H file is updated, and the -J file is deleted. If, however, there
35665 is some kind of crash (for example, a power outage) before this happens, the -J
35666 file remains in existence. When Exim next processes the message, it notices the
35667 -J file and uses it to update the -H file before starting the next delivery
35668 attempt.
35669
35670 .section "Format of the -H file" "SECID282"
35671 .cindex "uid (user id)" "in spool file"
35672 .cindex "gid (group id)" "in spool file"
35673 The second line of the -H file contains the login name for the uid of the
35674 process that called Exim to read the message, followed by the numerical uid and
35675 gid. For a locally generated message, this is normally the user who sent the
35676 message. For a message received over TCP/IP via the daemon, it is
35677 normally the Exim user.
35678
35679 The third line of the file contains the address of the message's sender as
35680 transmitted in the envelope, contained in angle brackets. The sender address is
35681 empty for bounce messages. For incoming SMTP mail, the sender address is given
35682 in the MAIL command. For locally generated mail, the sender address is
35683 created by Exim from the login name of the current user and the configured
35684 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
35685 leading &"From&~"& line if the caller is trusted, or if the supplied address is
35686 &"<>"& or an address that matches &%untrusted_set_senders%&.
35687
35688 The fourth line contains two numbers. The first is the time that the message
35689 was received, in the conventional Unix form &-- the number of seconds since the
35690 start of the epoch. The second number is a count of the number of messages
35691 warning of delayed delivery that have been sent to the sender.
35692
35693 There follow a number of lines starting with a hyphen. These can appear in any
35694 order, and are omitted when not relevant:
35695
35696 .vlist
35697 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
35698 This item is obsolete, and is not generated from Exim release 4.61 onwards;
35699 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
35700 recognized, to provide backward compatibility. In the old format, a line of
35701 this form is present for every ACL variable that is not empty. The number
35702 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
35703 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
35704 the data string for the variable. The string itself starts at the beginning of
35705 the next line, and is followed by a newline character. It may contain internal
35706 newlines.
35707
35708 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
35709 A line of this form is present for every ACL connection variable that is
35710 defined. Note that there is a space between &%-aclc%& and the rest of the name.
35711 The length is the length of the data string for the variable. The string itself
35712 starts at the beginning of the next line, and is followed by a newline
35713 character. It may contain internal newlines.
35714
35715 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
35716 A line of this form is present for every ACL message variable that is defined.
35717 Note that there is a space between &%-aclm%& and the rest of the name. The
35718 length is the length of the data string for the variable. The string itself
35719 starts at the beginning of the next line, and is followed by a newline
35720 character. It may contain internal newlines.
35721
35722 .vitem "&%-active_hostname%&&~<&'hostname'&>"
35723 This is present if, when the message was received over SMTP, the value of
35724 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
35725
35726 .vitem &%-allow_unqualified_recipient%&
35727 This is present if unqualified recipient addresses are permitted in header
35728 lines (to stop such addresses from being qualified if rewriting occurs at
35729 transport time). Local messages that were input using &%-bnq%& and remote
35730 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
35731
35732 .vitem &%-allow_unqualified_sender%&
35733 This is present if unqualified sender addresses are permitted in header lines
35734 (to stop such addresses from being qualified if rewriting occurs at transport
35735 time). Local messages that were input using &%-bnq%& and remote messages from
35736 hosts that match &%sender_unqualified_hosts%& set this flag.
35737
35738 .vitem "&%-auth_id%&&~<&'text'&>"
35739 The id information for a message received on an authenticated SMTP connection
35740 &-- the value of the &$authenticated_id$& variable.
35741
35742 .vitem "&%-auth_sender%&&~<&'address'&>"
35743 The address of an authenticated sender &-- the value of the
35744 &$authenticated_sender$& variable.
35745
35746 .vitem "&%-body_linecount%&&~<&'number'&>"
35747 This records the number of lines in the body of the message, and is always
35748 present.
35749
35750 .vitem "&%-body_zerocount%&&~<&'number'&>"
35751 This records the number of binary zero bytes in the body of the message, and is
35752 present if the number is greater than zero.
35753
35754 .vitem &%-deliver_firsttime%&
35755 This is written when a new message is first added to the spool. When the spool
35756 file is updated after a deferral, it is omitted.
35757
35758 .vitem "&%-frozen%&&~<&'time'&>"
35759 .cindex "frozen messages" "spool data"
35760 The message is frozen, and the freezing happened at <&'time'&>.
35761
35762 .vitem "&%-helo_name%&&~<&'text'&>"
35763 This records the host name as specified by a remote host in a HELO or EHLO
35764 command.
35765
35766 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
35767 This records the IP address of the host from which the message was received and
35768 the remote port number that was used. It is omitted for locally generated
35769 messages.
35770
35771 .vitem "&%-host_auth%&&~<&'text'&>"
35772 If the message was received on an authenticated SMTP connection, this records
35773 the name of the authenticator &-- the value of the
35774 &$sender_host_authenticated$& variable.
35775
35776 .vitem &%-host_lookup_failed%&
35777 This is present if an attempt to look up the sending host's name from its IP
35778 address failed. It corresponds to the &$host_lookup_failed$& variable.
35779
35780 .vitem "&%-host_name%&&~<&'text'&>"
35781 .cindex "reverse DNS lookup"
35782 .cindex "DNS" "reverse lookup"
35783 This records the name of the remote host from which the message was received,
35784 if the host name was looked up from the IP address when the message was being
35785 received. It is not present if no reverse lookup was done.
35786
35787 .vitem "&%-ident%&&~<&'text'&>"
35788 For locally submitted messages, this records the login of the originating user,
35789 unless it was a trusted user and the &%-oMt%& option was used to specify an
35790 ident value. For messages received over TCP/IP, this records the ident string
35791 supplied by the remote host, if any.
35792
35793 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
35794 This records the IP address of the local interface and the port number through
35795 which a message was received from a remote host. It is omitted for locally
35796 generated messages.
35797
35798 .vitem &%-local%&
35799 The message is from a local sender.
35800
35801 .vitem &%-localerror%&
35802 The message is a locally-generated bounce message.
35803
35804 .vitem "&%-local_scan%&&~<&'string'&>"
35805 This records the data string that was returned by the &[local_scan()]& function
35806 when the message was received &-- the value of the &$local_scan_data$&
35807 variable. It is omitted if no data was returned.
35808
35809 .vitem &%-manual_thaw%&
35810 The message was frozen but has been thawed manually, that is, by an explicit
35811 Exim command rather than via the auto-thaw process.
35812
35813 .vitem &%-N%&
35814 A testing delivery process was started using the &%-N%& option to suppress any
35815 actual deliveries, but delivery was deferred. At any further delivery attempts,
35816 &%-N%& is assumed.
35817
35818 .vitem &%-received_protocol%&
35819 This records the value of the &$received_protocol$& variable, which contains
35820 the name of the protocol by which the message was received.
35821
35822 .vitem &%-sender_set_untrusted%&
35823 The envelope sender of this message was set by an untrusted local caller (used
35824 to ensure that the caller is displayed in queue listings).
35825
35826 .vitem "&%-spam_score_int%&&~<&'number'&>"
35827 If a message was scanned by SpamAssassin, this is present. It records the value
35828 of &$spam_score_int$&.
35829
35830 .vitem &%-tls_certificate_verified%&
35831 A TLS certificate was received from the client that sent this message, and the
35832 certificate was verified by the server.
35833
35834 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
35835 When the message was received over an encrypted connection, this records the
35836 name of the cipher suite that was used.
35837
35838 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
35839 When the message was received over an encrypted connection, and a certificate
35840 was received from the client, this records the Distinguished Name from that
35841 certificate.
35842 .endlist
35843
35844 Following the options there is a list of those addresses to which the message
35845 is not to be delivered. This set of addresses is initialized from the command
35846 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
35847 is set; otherwise it starts out empty. Whenever a successful delivery is made,
35848 the address is added to this set. The addresses are kept internally as a
35849 balanced binary tree, and it is a representation of that tree which is written
35850 to the spool file. If an address is expanded via an alias or forward file, the
35851 original address is added to the tree when deliveries to all its child
35852 addresses are complete.
35853
35854 If the tree is empty, there is a single line in the spool file containing just
35855 the text &"XX"&. Otherwise, each line consists of two letters, which are either
35856 Y or N, followed by an address. The address is the value for the node of the
35857 tree, and the letters indicate whether the node has a left branch and/or a
35858 right branch attached to it, respectively. If branches exist, they immediately
35859 follow. Here is an example of a three-node tree:
35860 .code
35861 YY darcy@austen.fict.example
35862 NN alice@wonderland.fict.example
35863 NN editor@thesaurus.ref.example
35864 .endd
35865 After the non-recipients tree, there is a list of the message's recipients.
35866 This is a simple list, preceded by a count. It includes all the original
35867 recipients of the message, including those to whom the message has already been
35868 delivered. In the simplest case, the list contains one address per line. For
35869 example:
35870 .code
35871 4
35872 editor@thesaurus.ref.example
35873 darcy@austen.fict.example
35874 rdo@foundation
35875 alice@wonderland.fict.example
35876 .endd
35877 However, when a child address has been added to the top-level addresses as a
35878 result of the use of the &%one_time%& option on a &(redirect)& router, each
35879 line is of the following form:
35880 .display
35881 <&'top-level address'&> <&'errors_to address'&> &&&
35882   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
35883 .endd
35884 The 01 flag bit indicates the presence of the three other fields that follow
35885 the top-level address. Other bits may be used in future to support additional
35886 fields. The <&'parent number'&> is the offset in the recipients list of the
35887 original parent of the &"one time"& address. The first two fields are the
35888 envelope sender that is associated with this address and its length. If the
35889 length is zero, there is no special envelope sender (there are then two space
35890 characters in the line). A non-empty field can arise from a &(redirect)& router
35891 that has an &%errors_to%& setting.
35892
35893
35894 A blank line separates the envelope and status information from the headers
35895 which follow. A header may occupy several lines of the file, and to save effort
35896 when reading it in, each header is preceded by a number and an identifying
35897 character. The number is the number of characters in the header, including any
35898 embedded newlines and the terminating newline. The character is one of the
35899 following:
35900
35901 .table2 50pt
35902 .row <&'blank'&>         "header in which Exim has no special interest"
35903 .row &`B`&               "&'Bcc:'& header"
35904 .row &`C`&               "&'Cc:'& header"
35905 .row &`F`&               "&'From:'& header"
35906 .row &`I`&               "&'Message-id:'& header"
35907 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
35908 .row &`R`&               "&'Reply-To:'& header"
35909 .row &`S`&               "&'Sender:'& header"
35910 .row &`T`&               "&'To:'& header"
35911 .row &`*`&               "replaced or deleted header"
35912 .endtable
35913
35914 Deleted or replaced (rewritten) headers remain in the spool file for debugging
35915 purposes. They are not transmitted when the message is delivered. Here is a
35916 typical set of headers:
35917 .code
35918 111P Received: by hobbit.fict.example with local (Exim 4.00)
35919 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
35920 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
35921 038* X-rewrote-sender: bb@hobbit.fict.example
35922 042* From: Bilbo Baggins <bb@hobbit.fict.example>
35923 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
35924 099* To: alice@wonderland.fict.example, rdo@foundation,
35925 darcy@austen.fict.example, editor@thesaurus.ref.example
35926 104T To: alice@wonderland.fict.example, rdo@foundation.example,
35927 darcy@austen.fict.example, editor@thesaurus.ref.example
35928 038  Date: Fri, 11 May 2001 10:28:59 +0100
35929 .endd
35930 The asterisked headers indicate that the envelope sender, &'From:'& header, and
35931 &'To:'& header have been rewritten, the last one because routing expanded the
35932 unqualified domain &'foundation'&.
35933 .ecindex IIDforspo1
35934 .ecindex IIDforspo2
35935 .ecindex IIDforspo3
35936
35937 . ////////////////////////////////////////////////////////////////////////////
35938 . ////////////////////////////////////////////////////////////////////////////
35939
35940 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHID12" &&&
35941          "DKIM Support"
35942 .cindex "DKIM"
35943
35944 DKIM is a mechanism by which messages sent by some entity can be provably
35945 linked to a domain which that entity controls.  It permits reputation to
35946 be tracked on a per-domain basis, rather than merely upon source IP address.
35947 DKIM is documented in RFC 4871.
35948
35949 Since version 4.70, DKIM support is compiled into Exim by default. It can be
35950 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
35951
35952 Exim's DKIM implementation allows to
35953 .olist
35954 Sign outgoing messages: This function is implemented in the SMTP transport.
35955 It can co-exist with all other Exim features, including transport filters.
35956 .next
35957 Verify signatures in incoming messages: This is implemented by an additional
35958 ACL (acl_smtp_dkim), which can be called several times per message, with
35959 different signature contexts.
35960 .endlist
35961
35962 In typical Exim style, the verification implementation does not include any
35963 default "policy". Instead it enables you to build your own policy using
35964 Exim's standard controls.
35965
35966 Please note that verification of DKIM signatures in incoming mail is turned
35967 on by default for logging purposes. For each signature in incoming email,
35968 exim will log a line displaying the most important signature details, and the
35969 signature status. Here is an example (with line-breaks added for clarity):
35970 .code
35971 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
35972     d=facebookmail.com s=q1-2009b
35973     c=relaxed/relaxed a=rsa-sha1
35974     i=@facebookmail.com t=1252484542 [verification succeeded]
35975 .endd
35976 You might want to turn off DKIM verification processing entirely for internal
35977 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
35978 control modifier. This should typically be done in the RCPT ACL, at points
35979 where you accept mail from relay sources (internal hosts or authenticated
35980 senders).
35981
35982
35983 .section "Signing outgoing messages" "SECID513"
35984 .cindex "DKIM" "signing"
35985
35986 Signing is implemented by setting private options on the SMTP transport.
35987 These options take (expandable) strings as arguments.
35988
35989 .option dkim_domain smtp string&!! unset
35990 MANDATORY:
35991 The domain you want to sign with. The result of this expanded
35992 option is put into the &%$dkim_domain%& expansion variable.
35993
35994 .option dkim_selector smtp string&!! unset
35995 MANDATORY:
35996 This sets the key selector string. You can use the &%$dkim_domain%& expansion
35997 variable to look up a matching selector. The result is put in the expansion
35998 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
35999 option along with &%$dkim_domain%&.
36000
36001 .option dkim_private_key smtp string&!! unset
36002 MANDATORY:
36003 This sets the private key to use. You can use the &%$dkim_domain%& and
36004 &%$dkim_selector%& expansion variables to determine the private key to use.
36005 The result can either
36006 .ilist
36007 be a valid RSA private key in ASCII armor, including line breaks.
36008 .next
36009 start with a slash, in which case it is treated as a file that contains
36010 the private key.
36011 .next
36012 be "0", "false" or the empty string, in which case the message will not
36013 be signed. This case will not result in an error, even if &%dkim_strict%&
36014 is set.
36015 .endlist
36016
36017 .option dkim_canon smtp string&!! unset
36018 OPTIONAL:
36019 This option sets the canonicalization method used when signing a message.
36020 The DKIM RFC currently supports two methods: "simple" and "relaxed".
36021 The option defaults to "relaxed" when unset. Note: the current implementation
36022 only supports using the same canonicalization method for both headers and body.
36023
36024 .option dkim_strict smtp string&!! unset
36025 OPTIONAL:
36026 This  option  defines  how  Exim  behaves  when  signing a message that
36027 should be signed fails for some reason.  When the expansion evaluates to
36028 either "1" or "true", Exim will defer. Otherwise Exim will send the message
36029 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
36030 variables here.
36031
36032 .option dkim_sign_headers smtp string&!! unset
36033 OPTIONAL:
36034 When set, this option must expand to (or be specified as) a colon-separated
36035 list of header names. Headers with these names will be included in the message
36036 signature. When unspecified, the header names recommended in RFC4871 will be
36037 used.
36038
36039
36040 .section "Verifying DKIM signatures in incoming mail" "SECID514"
36041 .cindex "DKIM" "verification"
36042
36043 Verification of DKIM signatures in incoming email is implemented via the
36044 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
36045 syntactically(!) correct signature in the incoming message.
36046
36047 To evaluate the signature in the ACL a large number of expansion variables
36048 containing the signature status and its details are set up during the
36049 runtime of the ACL.
36050
36051 Calling the ACL only for existing signatures is not sufficient to build
36052 more advanced policies. For that reason, the global option
36053 &%dkim_verify_signers%&, and a global expansion variable
36054 &%$dkim_signers%& exist.
36055
36056 The global option &%dkim_verify_signers%& can be set to a colon-separated
36057 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
36058 called. It is expanded when the message has been received. At this point,
36059 the expansion variable &%$dkim_signers%& already contains a colon-separated
36060 list of signer domains and identities for the message. When
36061 &%dkim_verify_signers%& is not specified in the main configuration,
36062 it defaults as:
36063 .code
36064 dkim_verify_signers = $dkim_signers
36065 .endd
36066 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
36067 DKIM signature in the message. Current DKIM verifiers may want to explicitly
36068 call the ACL for known domains or identities. This would be achieved as follows:
36069 .code
36070 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
36071 .endd
36072 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
36073 and "ebay.com", plus all domains and identities that have signatures in the message.
36074 You can also be more creative in constructing your policy. For example:
36075 .code
36076 dkim_verify_signers = $sender_address_domain:$dkim_signers
36077 .endd
36078
36079 If a domain or identity is listed several times in the (expanded) value of
36080 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
36081
36082
36083 Inside the &%acl_smtp_dkim%&, the following expansion variables are
36084 available (from most to least important):
36085
36086
36087 .vlist
36088 .vitem &%$dkim_cur_signer%&
36089 The signer that is being evaluated in this ACL run. This can be a domain or
36090 an identity. This is one of the list items from the expanded main option
36091 &%dkim_verify_signers%& (see above).
36092 .vitem &%$dkim_verify_status%&
36093 A string describing the general status of the signature. One of
36094 .ilist
36095 &%none%&: There is no signature in the message for the current domain or
36096 identity (as reflected by &%$dkim_cur_signer%&).
36097 .next
36098 &%invalid%&: The signature could not be verified due to a processing error.
36099 More detail is available in &%$dkim_verify_reason%&.
36100 .next
36101 &%fail%&: Verification of the signature failed.  More detail is
36102 available in &%$dkim_verify_reason%&.
36103 .next
36104 &%pass%&: The signature passed verification. It is valid.
36105 .endlist
36106 .vitem &%$dkim_verify_reason%&
36107 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
36108 "fail" or "invalid". One of
36109 .ilist
36110 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
36111 key for the domain could not be retrieved. This may be a temporary problem.
36112 .next
36113 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
36114 record for the domain is syntactically invalid.
36115 .next
36116 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
36117 body hash does not match the one specified in the signature header. This
36118 means that the message body was modified in transit.
36119 .next
36120 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
36121 could not be verified. This may mean that headers were modified,
36122 re-written or otherwise changed in a way which is incompatible with
36123 DKIM verification. It may of course also mean that the signature is forged.
36124 .endlist
36125 .vitem &%$dkim_domain%&
36126 The signing domain. IMPORTANT: This variable is only populated if there is
36127 an actual signature in the message for the current domain or identity (as
36128 reflected by &%$dkim_cur_signer%&).
36129 .vitem &%$dkim_identity%&
36130 The signing identity, if present. IMPORTANT: This variable is only populated
36131 if there is an actual signature in the message for the current domain or
36132 identity (as reflected by &%$dkim_cur_signer%&).
36133 .vitem &%$dkim_selector%&
36134 The key record selector string.
36135 .vitem &%$dkim_algo%&
36136 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
36137 .vitem &%$dkim_canon_body%&
36138 The body canonicalization method. One of 'relaxed' or 'simple'.
36139 .vitem &%dkim_canon_headers%&
36140 The header canonicalization method. One of 'relaxed' or 'simple'.
36141 .vitem &%$dkim_copiedheaders%&
36142 A transcript of headers and their values which are included in the signature
36143 (copied from the 'z=' tag of the signature).
36144 .vitem &%$dkim_bodylength%&
36145 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
36146 limit was set by the signer, "9999999999999" is returned. This makes sure
36147 that this variable always expands to an integer value.
36148 .vitem &%$dkim_created%&
36149 UNIX timestamp reflecting the date and time when the signature was created.
36150 When this was not specified by the signer, "0" is returned.
36151 .vitem &%$dkim_expires%&
36152 UNIX timestamp reflecting the date and time when the signer wants the
36153 signature to be treated as "expired". When this was not specified by the
36154 signer, "9999999999999" is returned. This makes it possible to do useful
36155 integer size comparisons against this value.
36156 .vitem &%$dkim_headernames%&
36157 A colon-separated list of names of headers included in the signature.
36158 .vitem &%$dkim_key_testing%&
36159 "1" if the key record has the "testing" flag set, "0" if not.
36160 .vitem &%$nosubdomains%&
36161 "1" if the key record forbids subdomaining, "0" otherwise.
36162 .vitem &%$dkim_key_srvtype%&
36163 Service type (tag s=) from the key record. Defaults to "*" if not specified
36164 in the key record.
36165 .vitem &%$dkim_key_granularity%&
36166 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
36167 in the key record.
36168 .vitem &%$dkim_key_notes%&
36169 Notes from the key record (tag n=).
36170 .endlist
36171
36172 In addition, two ACL conditions are provided:
36173
36174 .vlist
36175 .vitem &%dkim_signers%&
36176 ACL condition that checks a colon-separated list of domains or identities
36177 for a match against the domain or identity that the ACL is currently verifying
36178 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
36179 verb to a group of domains or identities. For example:
36180
36181 .code
36182 # Warn when Mail purportedly from GMail has no signature at all
36183 warn log_message = GMail sender without DKIM signature
36184      sender_domains = gmail.com
36185      dkim_signers = gmail.com
36186      dkim_status = none
36187 .endd
36188
36189 .vitem &%dkim_status%&
36190 ACL condition that checks a colon-separated list of possible DKIM verification
36191 results against the actual result of verification. This is typically used
36192 to restrict an ACL verb to a list of verification outcomes, for example:
36193
36194 .code
36195 deny message = Mail from Paypal with invalid/missing signature
36196      sender_domains = paypal.com:paypal.de
36197      dkim_signers = paypal.com:paypal.de
36198      dkim_status = none:invalid:fail
36199 .endd
36200
36201 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
36202 see the documentation of the &%$dkim_verify_status%& expansion variable above
36203 for more information of what they mean.
36204 .endlist
36205
36206 . ////////////////////////////////////////////////////////////////////////////
36207 . ////////////////////////////////////////////////////////////////////////////
36208
36209 .chapter "Adding new drivers or lookup types" "CHID13" &&&
36210          "Adding drivers or lookups"
36211 .cindex "adding drivers"
36212 .cindex "new drivers, adding"
36213 .cindex "drivers" "adding new"
36214 The following actions have to be taken in order to add a new router, transport,
36215 authenticator, or lookup type to Exim:
36216
36217 .olist
36218 Choose a name for the driver or lookup type that does not conflict with any
36219 existing name; I will use &"newdriver"& in what follows.
36220 .next
36221 Add to &_src/EDITME_& the line:
36222 .display
36223 <&'type'&>&`_NEWDRIVER=yes`&
36224 .endd
36225 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
36226 code is not to be included in the binary by default, comment this line out. You
36227 should also add any relevant comments about the driver or lookup type.
36228 .next
36229 Add to &_src/config.h.defaults_& the line:
36230 .code
36231 #define <type>_NEWDRIVER
36232 .endd
36233 .next
36234 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
36235 and create a table entry as is done for all the other drivers and lookup types.
36236 .next
36237 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
36238 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
36239 driver or lookup type and add it to the definition of OBJ.
36240 .next
36241 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
36242 &_src_&.
36243 .next
36244 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
36245 as for other drivers and lookups.
36246 .endlist
36247
36248 Then all you need to do is write the code! A good way to start is to make a
36249 proforma by copying an existing module of the same type, globally changing all
36250 occurrences of the name, and cutting out most of the code. Note that any
36251 options you create must be listed in alphabetical order, because the tables are
36252 searched using a binary chop procedure.
36253
36254 There is a &_README_& file in each of the sub-directories of &_src_& describing
36255 the interface that is expected.
36256
36257
36258
36259
36260 . ////////////////////////////////////////////////////////////////////////////
36261 . ////////////////////////////////////////////////////////////////////////////
36262
36263 . /////////////////////////////////////////////////////////////////////////////
36264 . These lines are processing instructions for the Simple DocBook Processor that
36265 . Philip Hazel has developed as a less cumbersome way of making PostScript and
36266 . PDFs than using xmlto and fop. They will be ignored by all other XML
36267 . processors.
36268 . /////////////////////////////////////////////////////////////////////////////
36269
36270 .literal xml
36271 <?sdop
36272   format="newpage"
36273   foot_right_recto="&chaptertitle;"
36274   foot_right_verso="&chaptertitle;"
36275 ?>
36276 .literal off
36277
36278 .makeindex "Options index"   "option"
36279 .makeindex "Variables index" "variable"
36280 .makeindex "Concept index"   "concept"
36281
36282
36283 . /////////////////////////////////////////////////////////////////////////////
36284 . /////////////////////////////////////////////////////////////////////////////